@cosmotech/aip-client 0.2.0-dev2 → 0.2.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 +141 -4
- package/api/default-api.ts +8 -15
- package/api/impact-api.ts +507 -0
- package/api/investment-api.ts +1308 -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 +8 -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/impact-api.d.ts +245 -0
- package/dist/api/impact-api.js +493 -0
- package/dist/api/investment-api.d.ts +607 -0
- package/dist/api/investment-api.js +1248 -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 +8 -1
- package/dist/api.js +8 -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/impact-api.d.ts +245 -0
- package/dist/esm/api/impact-api.js +486 -0
- package/dist/esm/api/investment-api.d.ts +607 -0
- package/dist/esm/api/investment-api.js +1241 -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 +8 -1
- package/dist/esm/api.js +8 -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/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/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
- 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 +11 -1
- package/dist/esm/models/index.js +11 -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 +25 -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 +31 -0
- package/dist/esm/models/option-response.js +14 -0
- package/dist/esm/models/option-update.d.ts +19 -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/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/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
- 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 +11 -1
- package/dist/models/index.js +11 -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 +25 -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 +31 -0
- package/dist/models/option-response.js +15 -0
- package/dist/models/option-update.d.ts +19 -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/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 +875 -0
- package/docs/InvestmentCreate.md +23 -0
- package/docs/InvestmentResponse.md +31 -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 +37 -0
- package/docs/OptionUpdate.md +25 -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/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 +11 -1
- package/models/investment-create.ts +27 -0
- package/models/investment-response.ts +31 -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 +37 -0
- package/models/option-update.ts +25 -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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Asset Investment Planning
|
|
5
5
|
* API for Asset Investment Planning
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.2.0-
|
|
7
|
+
* The version of the OpenAPI document: 0.2.0-dev3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -18,32 +18,137 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
18
18
|
import globalAxios from 'axios';
|
|
19
19
|
// Some imports not used depending on template conditions
|
|
20
20
|
// @ts-ignore
|
|
21
|
-
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
22
|
// @ts-ignore
|
|
23
|
-
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
24
|
// @ts-ignore
|
|
25
|
-
import {
|
|
25
|
+
import type { MetricCostsPerYearCreate } from '../models';
|
|
26
26
|
// @ts-ignore
|
|
27
|
-
import {
|
|
27
|
+
import type { MetricCostsPerYearResponse } from '../models';
|
|
28
28
|
// @ts-ignore
|
|
29
|
-
import {
|
|
29
|
+
import type { MetricCostsPerYearUpdate } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import type { ObjectiveWeightCreate } from '../models';
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import type { ObjectiveWeightResponse } from '../models';
|
|
34
|
+
// @ts-ignore
|
|
35
|
+
import type { ObjectiveWeightUpdate } from '../models';
|
|
36
|
+
// @ts-ignore
|
|
37
|
+
import type { ValueFrameworkCreate } from '../models';
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import type { ValueFrameworkResponse } from '../models';
|
|
40
|
+
// @ts-ignore
|
|
41
|
+
import type { ValueFrameworkUpdate } from '../models';
|
|
30
42
|
/**
|
|
31
43
|
* ValueFrameworkApi - axios parameter creator
|
|
32
|
-
* @export
|
|
33
44
|
*/
|
|
34
45
|
export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
35
46
|
return {
|
|
36
47
|
/**
|
|
37
|
-
*
|
|
38
|
-
* @summary
|
|
48
|
+
* Create a yearly cost override for a metric within this framework.
|
|
49
|
+
* @summary Create a yearly metric cost for this framework
|
|
39
50
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
51
|
+
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
40
52
|
* @param {*} [options] Override http request option.
|
|
41
53
|
* @throws {RequiredError}
|
|
42
54
|
*/
|
|
43
|
-
|
|
55
|
+
createMetricCostForFramework: async (valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44
56
|
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
45
|
-
assertParamExists('
|
|
46
|
-
|
|
57
|
+
assertParamExists('createMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
58
|
+
// verify required parameter 'metricCostsPerYearCreate' is not null or undefined
|
|
59
|
+
assertParamExists('createMetricCostForFramework', 'metricCostsPerYearCreate', metricCostsPerYearCreate)
|
|
60
|
+
const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
|
|
61
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
62
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
63
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
64
|
+
let baseOptions;
|
|
65
|
+
if (configuration) {
|
|
66
|
+
baseOptions = configuration.baseOptions;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
70
|
+
const localVarHeaderParameter = {} as any;
|
|
71
|
+
const localVarQueryParameter = {} as any;
|
|
72
|
+
|
|
73
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
74
|
+
// oauth required
|
|
75
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
76
|
+
|
|
77
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
78
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
79
|
+
|
|
80
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
81
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
82
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
83
|
+
localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearCreate, localVarRequestOptions, configuration)
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
url: toPathString(localVarUrlObj),
|
|
87
|
+
options: localVarRequestOptions,
|
|
88
|
+
};
|
|
89
|
+
},
|
|
90
|
+
/**
|
|
91
|
+
* Assign a weight to an objective within this framework.
|
|
92
|
+
* @summary Create an objective weight for this framework
|
|
93
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
94
|
+
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
createObjectiveWeightForFramework: async (valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
99
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
100
|
+
assertParamExists('createObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
101
|
+
// verify required parameter 'objectiveWeightCreate' is not null or undefined
|
|
102
|
+
assertParamExists('createObjectiveWeightForFramework', 'objectiveWeightCreate', objectiveWeightCreate)
|
|
103
|
+
const localVarPath = `/value_framework/{value_framework_id}/objective_weight/`
|
|
104
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
105
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107
|
+
let baseOptions;
|
|
108
|
+
if (configuration) {
|
|
109
|
+
baseOptions = configuration.baseOptions;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
113
|
+
const localVarHeaderParameter = {} as any;
|
|
114
|
+
const localVarQueryParameter = {} as any;
|
|
115
|
+
|
|
116
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
117
|
+
// oauth required
|
|
118
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
119
|
+
|
|
120
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
121
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
122
|
+
|
|
123
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
124
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
125
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
126
|
+
localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightCreate, localVarRequestOptions, configuration)
|
|
127
|
+
|
|
128
|
+
return {
|
|
129
|
+
url: toPathString(localVarUrlObj),
|
|
130
|
+
options: localVarRequestOptions,
|
|
131
|
+
};
|
|
132
|
+
},
|
|
133
|
+
/**
|
|
134
|
+
* Delete a metric cost entry for a specific year within this framework.
|
|
135
|
+
* @summary Delete metric costs for this framework
|
|
136
|
+
* @param {string} metricId UUID of the metric
|
|
137
|
+
* @param {number} year Year (1600-3000)
|
|
138
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
deleteMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
143
|
+
// verify required parameter 'metricId' is not null or undefined
|
|
144
|
+
assertParamExists('deleteMetricCostForFramework', 'metricId', metricId)
|
|
145
|
+
// verify required parameter 'year' is not null or undefined
|
|
146
|
+
assertParamExists('deleteMetricCostForFramework', 'year', year)
|
|
147
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
148
|
+
assertParamExists('deleteMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
149
|
+
const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
|
|
150
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
151
|
+
.replace(`{${"year"}}`, encodeURIComponent(String(year)))
|
|
47
152
|
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
48
153
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
154
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -61,7 +166,6 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
61
166
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
62
167
|
|
|
63
168
|
|
|
64
|
-
|
|
65
169
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66
170
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67
171
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -72,15 +176,56 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
72
176
|
};
|
|
73
177
|
},
|
|
74
178
|
/**
|
|
75
|
-
*
|
|
76
|
-
* @summary
|
|
179
|
+
* Remove an objective weight from this framework.
|
|
180
|
+
* @summary Delete an objective weight for this framework
|
|
181
|
+
* @param {string} objectiveId UUID of the objective
|
|
77
182
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
78
183
|
* @param {*} [options] Override http request option.
|
|
79
184
|
* @throws {RequiredError}
|
|
80
185
|
*/
|
|
81
|
-
|
|
186
|
+
deleteObjectiveWeightForFramework: async (objectiveId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
187
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
188
|
+
assertParamExists('deleteObjectiveWeightForFramework', 'objectiveId', objectiveId)
|
|
82
189
|
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
83
|
-
assertParamExists('
|
|
190
|
+
assertParamExists('deleteObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
191
|
+
const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
|
|
192
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
|
|
193
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
194
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
195
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
196
|
+
let baseOptions;
|
|
197
|
+
if (configuration) {
|
|
198
|
+
baseOptions = configuration.baseOptions;
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
202
|
+
const localVarHeaderParameter = {} as any;
|
|
203
|
+
const localVarQueryParameter = {} as any;
|
|
204
|
+
|
|
205
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
206
|
+
// oauth required
|
|
207
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
211
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
212
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
213
|
+
|
|
214
|
+
return {
|
|
215
|
+
url: toPathString(localVarUrlObj),
|
|
216
|
+
options: localVarRequestOptions,
|
|
217
|
+
};
|
|
218
|
+
},
|
|
219
|
+
/**
|
|
220
|
+
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
221
|
+
* @summary Delete a value framework
|
|
222
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
223
|
+
* @param {*} [options] Override http request option.
|
|
224
|
+
* @throws {RequiredError}
|
|
225
|
+
*/
|
|
226
|
+
deleteValueFramework: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
227
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
228
|
+
assertParamExists('deleteValueFramework', 'valueFrameworkId', valueFrameworkId)
|
|
84
229
|
const localVarPath = `/value_framework/{value_framework_id}`
|
|
85
230
|
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
86
231
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -90,7 +235,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
90
235
|
baseOptions = configuration.baseOptions;
|
|
91
236
|
}
|
|
92
237
|
|
|
93
|
-
const localVarRequestOptions = { method: '
|
|
238
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
94
239
|
const localVarHeaderParameter = {} as any;
|
|
95
240
|
const localVarQueryParameter = {} as any;
|
|
96
241
|
|
|
@@ -99,7 +244,6 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
99
244
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
100
245
|
|
|
101
246
|
|
|
102
|
-
|
|
103
247
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
104
248
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
105
249
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -110,15 +254,19 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
110
254
|
};
|
|
111
255
|
},
|
|
112
256
|
/**
|
|
113
|
-
* Retrieve a paginated list of all value
|
|
114
|
-
* @summary List value
|
|
257
|
+
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
258
|
+
* @summary List all metric costs for a value framework
|
|
259
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
115
260
|
* @param {number} [offset] Number of records to skip
|
|
116
261
|
* @param {number} [limit] Max number of records to return
|
|
117
262
|
* @param {*} [options] Override http request option.
|
|
118
263
|
* @throws {RequiredError}
|
|
119
264
|
*/
|
|
120
|
-
|
|
121
|
-
|
|
265
|
+
getCostsForValueFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
266
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
267
|
+
assertParamExists('getCostsForValueFramework', 'valueFrameworkId', valueFrameworkId)
|
|
268
|
+
const localVarPath = `/value_framework/{value_framework_id}/costs/`
|
|
269
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
122
270
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
123
271
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
124
272
|
let baseOptions;
|
|
@@ -142,8 +290,8 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
142
290
|
localVarQueryParameter['limit'] = limit;
|
|
143
291
|
}
|
|
144
292
|
|
|
293
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
145
294
|
|
|
146
|
-
|
|
147
295
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
148
296
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
149
297
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -154,19 +302,22 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
154
302
|
};
|
|
155
303
|
},
|
|
156
304
|
/**
|
|
157
|
-
*
|
|
158
|
-
* @summary
|
|
305
|
+
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
306
|
+
* @summary List metric costs for a value framework filtered by metric
|
|
307
|
+
* @param {string} metricId UUID of the metric
|
|
159
308
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
160
|
-
* @param {
|
|
309
|
+
* @param {number} [offset] Number of records to skip
|
|
310
|
+
* @param {number} [limit] Max number of records to return
|
|
161
311
|
* @param {*} [options] Override http request option.
|
|
162
312
|
* @throws {RequiredError}
|
|
163
313
|
*/
|
|
164
|
-
|
|
314
|
+
getCostsForValueFrameworkByMetric: async (metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
315
|
+
// verify required parameter 'metricId' is not null or undefined
|
|
316
|
+
assertParamExists('getCostsForValueFrameworkByMetric', 'metricId', metricId)
|
|
165
317
|
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
166
|
-
assertParamExists('
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
const localVarPath = `/value_framework/{value_framework_id}`
|
|
318
|
+
assertParamExists('getCostsForValueFrameworkByMetric', 'valueFrameworkId', valueFrameworkId)
|
|
319
|
+
const localVarPath = `/value_framework/{value_framework_id}/costs/{metric_id}`
|
|
320
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
170
321
|
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
171
322
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
172
323
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -175,7 +326,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
175
326
|
baseOptions = configuration.baseOptions;
|
|
176
327
|
}
|
|
177
328
|
|
|
178
|
-
const localVarRequestOptions = { method: '
|
|
329
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
179
330
|
const localVarHeaderParameter = {} as any;
|
|
180
331
|
const localVarQueryParameter = {} as any;
|
|
181
332
|
|
|
@@ -183,14 +334,19 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
183
334
|
// oauth required
|
|
184
335
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
185
336
|
|
|
337
|
+
if (offset !== undefined) {
|
|
338
|
+
localVarQueryParameter['offset'] = offset;
|
|
339
|
+
}
|
|
186
340
|
|
|
187
|
-
|
|
188
|
-
|
|
341
|
+
if (limit !== undefined) {
|
|
342
|
+
localVarQueryParameter['limit'] = limit;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
189
346
|
|
|
190
347
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
191
348
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
192
349
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
193
|
-
localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkUpdate, localVarRequestOptions, configuration)
|
|
194
350
|
|
|
195
351
|
return {
|
|
196
352
|
url: toPathString(localVarUrlObj),
|
|
@@ -198,16 +354,25 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
198
354
|
};
|
|
199
355
|
},
|
|
200
356
|
/**
|
|
201
|
-
*
|
|
202
|
-
* @summary
|
|
203
|
-
* @param {
|
|
357
|
+
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
358
|
+
* @summary Get a yearly metric cost for this framework
|
|
359
|
+
* @param {string} metricId UUID of the metric
|
|
360
|
+
* @param {number} year Year (1600-3000)
|
|
361
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
204
362
|
* @param {*} [options] Override http request option.
|
|
205
363
|
* @throws {RequiredError}
|
|
206
364
|
*/
|
|
207
|
-
|
|
208
|
-
// verify required parameter '
|
|
209
|
-
assertParamExists('
|
|
210
|
-
|
|
365
|
+
getMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
366
|
+
// verify required parameter 'metricId' is not null or undefined
|
|
367
|
+
assertParamExists('getMetricCostForFramework', 'metricId', metricId)
|
|
368
|
+
// verify required parameter 'year' is not null or undefined
|
|
369
|
+
assertParamExists('getMetricCostForFramework', 'year', year)
|
|
370
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
371
|
+
assertParamExists('getMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
372
|
+
const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
|
|
373
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
374
|
+
.replace(`{${"year"}}`, encodeURIComponent(String(year)))
|
|
375
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
211
376
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
212
377
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
213
378
|
let baseOptions;
|
|
@@ -215,7 +380,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
215
380
|
baseOptions = configuration.baseOptions;
|
|
216
381
|
}
|
|
217
382
|
|
|
218
|
-
const localVarRequestOptions = { method: '
|
|
383
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
219
384
|
const localVarHeaderParameter = {} as any;
|
|
220
385
|
const localVarQueryParameter = {} as any;
|
|
221
386
|
|
|
@@ -223,83 +388,720 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
|
|
|
223
388
|
// oauth required
|
|
224
389
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
225
390
|
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
391
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
229
392
|
|
|
230
393
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
231
394
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
232
395
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
233
|
-
localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkCreate, localVarRequestOptions, configuration)
|
|
234
396
|
|
|
235
397
|
return {
|
|
236
398
|
url: toPathString(localVarUrlObj),
|
|
237
399
|
options: localVarRequestOptions,
|
|
238
400
|
};
|
|
239
401
|
},
|
|
240
|
-
}
|
|
241
|
-
};
|
|
242
|
-
|
|
243
|
-
/**
|
|
244
|
-
* ValueFrameworkApi - functional programming interface
|
|
245
|
-
* @export
|
|
246
|
-
*/
|
|
247
|
-
export const ValueFrameworkApiFp = function(configuration?: Configuration) {
|
|
248
|
-
const localVarAxiosParamCreator = ValueFrameworkApiAxiosParamCreator(configuration)
|
|
249
|
-
return {
|
|
250
402
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @summary
|
|
403
|
+
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
404
|
+
* @summary List yearly metric costs for this framework
|
|
253
405
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
406
|
+
* @param {number} [offset] Number of records to skip
|
|
407
|
+
* @param {number} [limit] Max number of records to return
|
|
254
408
|
* @param {*} [options] Override http request option.
|
|
255
409
|
* @throws {RequiredError}
|
|
256
410
|
*/
|
|
257
|
-
async
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
const
|
|
261
|
-
|
|
411
|
+
getMetricCostsForFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
412
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
413
|
+
assertParamExists('getMetricCostsForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
414
|
+
const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
|
|
415
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
416
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
417
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
418
|
+
let baseOptions;
|
|
419
|
+
if (configuration) {
|
|
420
|
+
baseOptions = configuration.baseOptions;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
424
|
+
const localVarHeaderParameter = {} as any;
|
|
425
|
+
const localVarQueryParameter = {} as any;
|
|
426
|
+
|
|
427
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
428
|
+
// oauth required
|
|
429
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
430
|
+
|
|
431
|
+
if (offset !== undefined) {
|
|
432
|
+
localVarQueryParameter['offset'] = offset;
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
if (limit !== undefined) {
|
|
436
|
+
localVarQueryParameter['limit'] = limit;
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
440
|
+
|
|
441
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
442
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
443
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
444
|
+
|
|
445
|
+
return {
|
|
446
|
+
url: toPathString(localVarUrlObj),
|
|
447
|
+
options: localVarRequestOptions,
|
|
448
|
+
};
|
|
262
449
|
},
|
|
263
450
|
/**
|
|
264
|
-
* Retrieve a
|
|
265
|
-
* @summary Get
|
|
451
|
+
* Retrieve the weight for a specific objective within this framework.
|
|
452
|
+
* @summary Get an objective weight for this framework
|
|
453
|
+
* @param {string} objectiveId UUID of the objective
|
|
266
454
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
267
455
|
* @param {*} [options] Override http request option.
|
|
268
456
|
* @throws {RequiredError}
|
|
269
457
|
*/
|
|
270
|
-
async
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
458
|
+
getObjectiveWeightForFramework: async (objectiveId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
459
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
460
|
+
assertParamExists('getObjectiveWeightForFramework', 'objectiveId', objectiveId)
|
|
461
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
462
|
+
assertParamExists('getObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
463
|
+
const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
|
|
464
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
|
|
465
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
466
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
467
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
468
|
+
let baseOptions;
|
|
469
|
+
if (configuration) {
|
|
470
|
+
baseOptions = configuration.baseOptions;
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
474
|
+
const localVarHeaderParameter = {} as any;
|
|
475
|
+
const localVarQueryParameter = {} as any;
|
|
476
|
+
|
|
477
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
478
|
+
// oauth required
|
|
479
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
480
|
+
|
|
481
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
482
|
+
|
|
483
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
484
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
485
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
486
|
+
|
|
487
|
+
return {
|
|
488
|
+
url: toPathString(localVarUrlObj),
|
|
489
|
+
options: localVarRequestOptions,
|
|
490
|
+
};
|
|
275
491
|
},
|
|
276
492
|
/**
|
|
277
|
-
* Retrieve a paginated list of all
|
|
278
|
-
* @summary List
|
|
493
|
+
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
494
|
+
* @summary List objective weights for this framework
|
|
495
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
279
496
|
* @param {number} [offset] Number of records to skip
|
|
280
497
|
* @param {number} [limit] Max number of records to return
|
|
281
498
|
* @param {*} [options] Override http request option.
|
|
282
499
|
* @throws {RequiredError}
|
|
283
500
|
*/
|
|
284
|
-
async
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
const
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
501
|
+
getObjectiveWeightsForFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
502
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
503
|
+
assertParamExists('getObjectiveWeightsForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
504
|
+
const localVarPath = `/value_framework/{value_framework_id}/objective_weight/`
|
|
505
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
506
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
507
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
508
|
+
let baseOptions;
|
|
509
|
+
if (configuration) {
|
|
510
|
+
baseOptions = configuration.baseOptions;
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
514
|
+
const localVarHeaderParameter = {} as any;
|
|
515
|
+
const localVarQueryParameter = {} as any;
|
|
516
|
+
|
|
517
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
518
|
+
// oauth required
|
|
519
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
520
|
+
|
|
521
|
+
if (offset !== undefined) {
|
|
522
|
+
localVarQueryParameter['offset'] = offset;
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
if (limit !== undefined) {
|
|
526
|
+
localVarQueryParameter['limit'] = limit;
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
530
|
+
|
|
531
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
532
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
533
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
534
|
+
|
|
535
|
+
return {
|
|
536
|
+
url: toPathString(localVarUrlObj),
|
|
537
|
+
options: localVarRequestOptions,
|
|
538
|
+
};
|
|
539
|
+
},
|
|
540
|
+
/**
|
|
541
|
+
* Retrieve a single value framework by its ID.
|
|
542
|
+
* @summary Get a value framework by ID
|
|
543
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
544
|
+
* @param {*} [options] Override http request option.
|
|
545
|
+
* @throws {RequiredError}
|
|
546
|
+
*/
|
|
547
|
+
getValueFrameworkById: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
548
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
549
|
+
assertParamExists('getValueFrameworkById', 'valueFrameworkId', valueFrameworkId)
|
|
550
|
+
const localVarPath = `/value_framework/{value_framework_id}`
|
|
551
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
552
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
553
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
554
|
+
let baseOptions;
|
|
555
|
+
if (configuration) {
|
|
556
|
+
baseOptions = configuration.baseOptions;
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
560
|
+
const localVarHeaderParameter = {} as any;
|
|
561
|
+
const localVarQueryParameter = {} as any;
|
|
562
|
+
|
|
563
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
564
|
+
// oauth required
|
|
565
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
566
|
+
|
|
567
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
568
|
+
|
|
569
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
570
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
571
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
572
|
+
|
|
573
|
+
return {
|
|
574
|
+
url: toPathString(localVarUrlObj),
|
|
575
|
+
options: localVarRequestOptions,
|
|
576
|
+
};
|
|
577
|
+
},
|
|
578
|
+
/**
|
|
579
|
+
* Retrieve a paginated list of all value frameworks.
|
|
580
|
+
* @summary List value frameworks
|
|
581
|
+
* @param {number} [offset] Number of records to skip
|
|
582
|
+
* @param {number} [limit] Max number of records to return
|
|
583
|
+
* @param {*} [options] Override http request option.
|
|
584
|
+
* @throws {RequiredError}
|
|
585
|
+
*/
|
|
586
|
+
getValueFrameworks: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
587
|
+
const localVarPath = `/value_framework/`;
|
|
588
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
589
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
590
|
+
let baseOptions;
|
|
591
|
+
if (configuration) {
|
|
592
|
+
baseOptions = configuration.baseOptions;
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
596
|
+
const localVarHeaderParameter = {} as any;
|
|
597
|
+
const localVarQueryParameter = {} as any;
|
|
598
|
+
|
|
599
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
600
|
+
// oauth required
|
|
601
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
602
|
+
|
|
603
|
+
if (offset !== undefined) {
|
|
604
|
+
localVarQueryParameter['offset'] = offset;
|
|
605
|
+
}
|
|
606
|
+
|
|
607
|
+
if (limit !== undefined) {
|
|
608
|
+
localVarQueryParameter['limit'] = limit;
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
612
|
+
|
|
613
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
614
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
615
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
616
|
+
|
|
617
|
+
return {
|
|
618
|
+
url: toPathString(localVarUrlObj),
|
|
619
|
+
options: localVarRequestOptions,
|
|
620
|
+
};
|
|
621
|
+
},
|
|
622
|
+
/**
|
|
623
|
+
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
624
|
+
* @summary List all objective weights for a value framework
|
|
625
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
626
|
+
* @param {number} [offset] Number of records to skip
|
|
627
|
+
* @param {number} [limit] Max number of records to return
|
|
628
|
+
* @param {*} [options] Override http request option.
|
|
629
|
+
* @throws {RequiredError}
|
|
630
|
+
*/
|
|
631
|
+
getWeightsForValueFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
632
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
633
|
+
assertParamExists('getWeightsForValueFramework', 'valueFrameworkId', valueFrameworkId)
|
|
634
|
+
const localVarPath = `/value_framework/{value_framework_id}/weights/`
|
|
635
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
636
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
637
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
638
|
+
let baseOptions;
|
|
639
|
+
if (configuration) {
|
|
640
|
+
baseOptions = configuration.baseOptions;
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
644
|
+
const localVarHeaderParameter = {} as any;
|
|
645
|
+
const localVarQueryParameter = {} as any;
|
|
646
|
+
|
|
647
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
648
|
+
// oauth required
|
|
649
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
650
|
+
|
|
651
|
+
if (offset !== undefined) {
|
|
652
|
+
localVarQueryParameter['offset'] = offset;
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
if (limit !== undefined) {
|
|
656
|
+
localVarQueryParameter['limit'] = limit;
|
|
657
|
+
}
|
|
658
|
+
|
|
659
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
660
|
+
|
|
661
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
662
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
663
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
664
|
+
|
|
665
|
+
return {
|
|
666
|
+
url: toPathString(localVarUrlObj),
|
|
667
|
+
options: localVarRequestOptions,
|
|
668
|
+
};
|
|
669
|
+
},
|
|
670
|
+
/**
|
|
671
|
+
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
672
|
+
* @summary Partially update metric costs for this framework
|
|
673
|
+
* @param {string} metricId UUID of the metric
|
|
674
|
+
* @param {number} year Year (1600-3000)
|
|
675
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
676
|
+
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
677
|
+
* @param {*} [options] Override http request option.
|
|
678
|
+
* @throws {RequiredError}
|
|
679
|
+
*/
|
|
680
|
+
patchMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
681
|
+
// verify required parameter 'metricId' is not null or undefined
|
|
682
|
+
assertParamExists('patchMetricCostForFramework', 'metricId', metricId)
|
|
683
|
+
// verify required parameter 'year' is not null or undefined
|
|
684
|
+
assertParamExists('patchMetricCostForFramework', 'year', year)
|
|
685
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
686
|
+
assertParamExists('patchMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
687
|
+
// verify required parameter 'metricCostsPerYearUpdate' is not null or undefined
|
|
688
|
+
assertParamExists('patchMetricCostForFramework', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate)
|
|
689
|
+
const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
|
|
690
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
691
|
+
.replace(`{${"year"}}`, encodeURIComponent(String(year)))
|
|
692
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
693
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
694
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
695
|
+
let baseOptions;
|
|
696
|
+
if (configuration) {
|
|
697
|
+
baseOptions = configuration.baseOptions;
|
|
698
|
+
}
|
|
699
|
+
|
|
700
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
701
|
+
const localVarHeaderParameter = {} as any;
|
|
702
|
+
const localVarQueryParameter = {} as any;
|
|
703
|
+
|
|
704
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
705
|
+
// oauth required
|
|
706
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
707
|
+
|
|
708
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
709
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
710
|
+
|
|
711
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
712
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
713
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
714
|
+
localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearUpdate, localVarRequestOptions, configuration)
|
|
715
|
+
|
|
716
|
+
return {
|
|
717
|
+
url: toPathString(localVarUrlObj),
|
|
718
|
+
options: localVarRequestOptions,
|
|
719
|
+
};
|
|
720
|
+
},
|
|
721
|
+
/**
|
|
722
|
+
* Update the weight of an objective within this value framework.
|
|
723
|
+
* @summary Partially update an objective weight for this framework
|
|
724
|
+
* @param {string} objectiveId UUID of the objective
|
|
725
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
726
|
+
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
727
|
+
* @param {*} [options] Override http request option.
|
|
728
|
+
* @throws {RequiredError}
|
|
729
|
+
*/
|
|
730
|
+
patchObjectiveWeightForFramework: async (objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
731
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
732
|
+
assertParamExists('patchObjectiveWeightForFramework', 'objectiveId', objectiveId)
|
|
733
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
734
|
+
assertParamExists('patchObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
|
|
735
|
+
// verify required parameter 'objectiveWeightUpdate' is not null or undefined
|
|
736
|
+
assertParamExists('patchObjectiveWeightForFramework', 'objectiveWeightUpdate', objectiveWeightUpdate)
|
|
737
|
+
const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
|
|
738
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
|
|
739
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
740
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
741
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
742
|
+
let baseOptions;
|
|
743
|
+
if (configuration) {
|
|
744
|
+
baseOptions = configuration.baseOptions;
|
|
745
|
+
}
|
|
746
|
+
|
|
747
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
748
|
+
const localVarHeaderParameter = {} as any;
|
|
749
|
+
const localVarQueryParameter = {} as any;
|
|
750
|
+
|
|
751
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
752
|
+
// oauth required
|
|
753
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
754
|
+
|
|
755
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
756
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
757
|
+
|
|
758
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
759
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
760
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
761
|
+
localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightUpdate, localVarRequestOptions, configuration)
|
|
762
|
+
|
|
763
|
+
return {
|
|
764
|
+
url: toPathString(localVarUrlObj),
|
|
765
|
+
options: localVarRequestOptions,
|
|
766
|
+
};
|
|
767
|
+
},
|
|
768
|
+
/**
|
|
769
|
+
* 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.
|
|
770
|
+
* @summary Partially update a value framework
|
|
771
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
772
|
+
* @param {ValueFrameworkUpdate} valueFrameworkUpdate
|
|
773
|
+
* @param {*} [options] Override http request option.
|
|
774
|
+
* @throws {RequiredError}
|
|
775
|
+
*/
|
|
776
|
+
patchValueFramework: async (valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
777
|
+
// verify required parameter 'valueFrameworkId' is not null or undefined
|
|
778
|
+
assertParamExists('patchValueFramework', 'valueFrameworkId', valueFrameworkId)
|
|
779
|
+
// verify required parameter 'valueFrameworkUpdate' is not null or undefined
|
|
780
|
+
assertParamExists('patchValueFramework', 'valueFrameworkUpdate', valueFrameworkUpdate)
|
|
781
|
+
const localVarPath = `/value_framework/{value_framework_id}`
|
|
782
|
+
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
783
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
784
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
785
|
+
let baseOptions;
|
|
786
|
+
if (configuration) {
|
|
787
|
+
baseOptions = configuration.baseOptions;
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
791
|
+
const localVarHeaderParameter = {} as any;
|
|
792
|
+
const localVarQueryParameter = {} as any;
|
|
793
|
+
|
|
794
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
795
|
+
// oauth required
|
|
796
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
797
|
+
|
|
798
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
799
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
800
|
+
|
|
801
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
802
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
803
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
804
|
+
localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkUpdate, localVarRequestOptions, configuration)
|
|
805
|
+
|
|
806
|
+
return {
|
|
807
|
+
url: toPathString(localVarUrlObj),
|
|
808
|
+
options: localVarRequestOptions,
|
|
809
|
+
};
|
|
810
|
+
},
|
|
811
|
+
/**
|
|
812
|
+
* Create a new value framework. Name must be unique and non-empty.
|
|
813
|
+
* @summary Create a value framework
|
|
814
|
+
* @param {ValueFrameworkCreate} valueFrameworkCreate
|
|
815
|
+
* @param {*} [options] Override http request option.
|
|
816
|
+
* @throws {RequiredError}
|
|
817
|
+
*/
|
|
818
|
+
postValueFramework: async (valueFrameworkCreate: ValueFrameworkCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
819
|
+
// verify required parameter 'valueFrameworkCreate' is not null or undefined
|
|
820
|
+
assertParamExists('postValueFramework', 'valueFrameworkCreate', valueFrameworkCreate)
|
|
821
|
+
const localVarPath = `/value_framework/`;
|
|
822
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
823
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
824
|
+
let baseOptions;
|
|
825
|
+
if (configuration) {
|
|
826
|
+
baseOptions = configuration.baseOptions;
|
|
827
|
+
}
|
|
828
|
+
|
|
829
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
830
|
+
const localVarHeaderParameter = {} as any;
|
|
831
|
+
const localVarQueryParameter = {} as any;
|
|
832
|
+
|
|
833
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
834
|
+
// oauth required
|
|
835
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
836
|
+
|
|
837
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
838
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
839
|
+
|
|
840
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
841
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
842
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
843
|
+
localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkCreate, localVarRequestOptions, configuration)
|
|
844
|
+
|
|
845
|
+
return {
|
|
846
|
+
url: toPathString(localVarUrlObj),
|
|
847
|
+
options: localVarRequestOptions,
|
|
848
|
+
};
|
|
849
|
+
},
|
|
850
|
+
}
|
|
851
|
+
};
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* ValueFrameworkApi - functional programming interface
|
|
855
|
+
*/
|
|
856
|
+
export const ValueFrameworkApiFp = function(configuration?: Configuration) {
|
|
857
|
+
const localVarAxiosParamCreator = ValueFrameworkApiAxiosParamCreator(configuration)
|
|
858
|
+
return {
|
|
859
|
+
/**
|
|
860
|
+
* Create a yearly cost override for a metric within this framework.
|
|
861
|
+
* @summary Create a yearly metric cost for this framework
|
|
862
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
863
|
+
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
864
|
+
* @param {*} [options] Override http request option.
|
|
865
|
+
* @throws {RequiredError}
|
|
866
|
+
*/
|
|
867
|
+
async createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
|
|
868
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options);
|
|
869
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
870
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.createMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
|
|
871
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
872
|
+
},
|
|
873
|
+
/**
|
|
874
|
+
* Assign a weight to an objective within this framework.
|
|
875
|
+
* @summary Create an objective weight for this framework
|
|
876
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
877
|
+
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
878
|
+
* @param {*} [options] Override http request option.
|
|
879
|
+
* @throws {RequiredError}
|
|
880
|
+
*/
|
|
881
|
+
async createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>> {
|
|
882
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options);
|
|
883
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
884
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.createObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
|
|
885
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
886
|
+
},
|
|
887
|
+
/**
|
|
888
|
+
* Delete a metric cost entry for a specific year within this framework.
|
|
889
|
+
* @summary Delete metric costs for this framework
|
|
890
|
+
* @param {string} metricId UUID of the metric
|
|
891
|
+
* @param {number} year Year (1600-3000)
|
|
892
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
893
|
+
* @param {*} [options] Override http request option.
|
|
894
|
+
* @throws {RequiredError}
|
|
895
|
+
*/
|
|
896
|
+
async deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
897
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options);
|
|
898
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
899
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
|
|
900
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
901
|
+
},
|
|
902
|
+
/**
|
|
903
|
+
* Remove an objective weight from this framework.
|
|
904
|
+
* @summary Delete an objective weight for this framework
|
|
905
|
+
* @param {string} objectiveId UUID of the objective
|
|
906
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
907
|
+
* @param {*} [options] Override http request option.
|
|
908
|
+
* @throws {RequiredError}
|
|
909
|
+
*/
|
|
910
|
+
async deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
911
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options);
|
|
912
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
913
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
|
|
914
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
915
|
+
},
|
|
916
|
+
/**
|
|
917
|
+
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
918
|
+
* @summary Delete a value framework
|
|
919
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
920
|
+
* @param {*} [options] Override http request option.
|
|
921
|
+
* @throws {RequiredError}
|
|
922
|
+
*/
|
|
923
|
+
async deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
924
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteValueFramework(valueFrameworkId, options);
|
|
925
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
926
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteValueFramework']?.[localVarOperationServerIndex]?.url;
|
|
927
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
928
|
+
},
|
|
929
|
+
/**
|
|
930
|
+
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
931
|
+
* @summary List all metric costs for a value framework
|
|
932
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
933
|
+
* @param {number} [offset] Number of records to skip
|
|
934
|
+
* @param {number} [limit] Max number of records to return
|
|
935
|
+
* @param {*} [options] Override http request option.
|
|
936
|
+
* @throws {RequiredError}
|
|
937
|
+
*/
|
|
938
|
+
async getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
|
|
939
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCostsForValueFramework(valueFrameworkId, offset, limit, options);
|
|
940
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
941
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getCostsForValueFramework']?.[localVarOperationServerIndex]?.url;
|
|
942
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
943
|
+
},
|
|
944
|
+
/**
|
|
945
|
+
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
946
|
+
* @summary List metric costs for a value framework filtered by metric
|
|
947
|
+
* @param {string} metricId UUID of the metric
|
|
948
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
949
|
+
* @param {number} [offset] Number of records to skip
|
|
950
|
+
* @param {number} [limit] Max number of records to return
|
|
951
|
+
* @param {*} [options] Override http request option.
|
|
952
|
+
* @throws {RequiredError}
|
|
953
|
+
*/
|
|
954
|
+
async getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
|
|
955
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options);
|
|
956
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
957
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getCostsForValueFrameworkByMetric']?.[localVarOperationServerIndex]?.url;
|
|
958
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
959
|
+
},
|
|
960
|
+
/**
|
|
961
|
+
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
962
|
+
* @summary Get a yearly metric cost for this framework
|
|
963
|
+
* @param {string} metricId UUID of the metric
|
|
964
|
+
* @param {number} year Year (1600-3000)
|
|
965
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
966
|
+
* @param {*} [options] Override http request option.
|
|
967
|
+
* @throws {RequiredError}
|
|
968
|
+
*/
|
|
969
|
+
async getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
|
|
970
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostForFramework(metricId, year, valueFrameworkId, options);
|
|
971
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
972
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
|
|
973
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
974
|
+
},
|
|
975
|
+
/**
|
|
976
|
+
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
977
|
+
* @summary List yearly metric costs for this framework
|
|
978
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
979
|
+
* @param {number} [offset] Number of records to skip
|
|
980
|
+
* @param {number} [limit] Max number of records to return
|
|
981
|
+
* @param {*} [options] Override http request option.
|
|
982
|
+
* @throws {RequiredError}
|
|
983
|
+
*/
|
|
984
|
+
async getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
|
|
985
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostsForFramework(valueFrameworkId, offset, limit, options);
|
|
986
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
987
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getMetricCostsForFramework']?.[localVarOperationServerIndex]?.url;
|
|
988
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
989
|
+
},
|
|
990
|
+
/**
|
|
991
|
+
* Retrieve the weight for a specific objective within this framework.
|
|
992
|
+
* @summary Get an objective weight for this framework
|
|
993
|
+
* @param {string} objectiveId UUID of the objective
|
|
994
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
995
|
+
* @param {*} [options] Override http request option.
|
|
996
|
+
* @throws {RequiredError}
|
|
997
|
+
*/
|
|
998
|
+
async getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>> {
|
|
999
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options);
|
|
1000
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1001
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
|
|
1002
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1003
|
+
},
|
|
1004
|
+
/**
|
|
1005
|
+
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
1006
|
+
* @summary List objective weights for this framework
|
|
1007
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1008
|
+
* @param {number} [offset] Number of records to skip
|
|
1009
|
+
* @param {number} [limit] Max number of records to return
|
|
1010
|
+
* @param {*} [options] Override http request option.
|
|
1011
|
+
* @throws {RequiredError}
|
|
1012
|
+
*/
|
|
1013
|
+
async getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>> {
|
|
1014
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options);
|
|
1015
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1016
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getObjectiveWeightsForFramework']?.[localVarOperationServerIndex]?.url;
|
|
1017
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1018
|
+
},
|
|
1019
|
+
/**
|
|
1020
|
+
* Retrieve a single value framework by its ID.
|
|
1021
|
+
* @summary Get a value framework by ID
|
|
1022
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1023
|
+
* @param {*} [options] Override http request option.
|
|
1024
|
+
* @throws {RequiredError}
|
|
1025
|
+
*/
|
|
1026
|
+
async getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>> {
|
|
1027
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getValueFrameworkById(valueFrameworkId, options);
|
|
1028
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1029
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getValueFrameworkById']?.[localVarOperationServerIndex]?.url;
|
|
1030
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1031
|
+
},
|
|
1032
|
+
/**
|
|
1033
|
+
* Retrieve a paginated list of all value frameworks.
|
|
1034
|
+
* @summary List value frameworks
|
|
1035
|
+
* @param {number} [offset] Number of records to skip
|
|
1036
|
+
* @param {number} [limit] Max number of records to return
|
|
1037
|
+
* @param {*} [options] Override http request option.
|
|
1038
|
+
* @throws {RequiredError}
|
|
1039
|
+
*/
|
|
1040
|
+
async getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ValueFrameworkResponse>>> {
|
|
1041
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getValueFrameworks(offset, limit, options);
|
|
1042
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1043
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getValueFrameworks']?.[localVarOperationServerIndex]?.url;
|
|
1044
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1045
|
+
},
|
|
1046
|
+
/**
|
|
1047
|
+
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
1048
|
+
* @summary List all objective weights for a value framework
|
|
1049
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1050
|
+
* @param {number} [offset] Number of records to skip
|
|
1051
|
+
* @param {number} [limit] Max number of records to return
|
|
1052
|
+
* @param {*} [options] Override http request option.
|
|
1053
|
+
* @throws {RequiredError}
|
|
1054
|
+
*/
|
|
1055
|
+
async getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>> {
|
|
1056
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getWeightsForValueFramework(valueFrameworkId, offset, limit, options);
|
|
1057
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1058
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getWeightsForValueFramework']?.[localVarOperationServerIndex]?.url;
|
|
1059
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1060
|
+
},
|
|
1061
|
+
/**
|
|
1062
|
+
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
1063
|
+
* @summary Partially update metric costs for this framework
|
|
1064
|
+
* @param {string} metricId UUID of the metric
|
|
1065
|
+
* @param {number} year Year (1600-3000)
|
|
1066
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1067
|
+
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
*/
|
|
1071
|
+
async patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
|
|
1072
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options);
|
|
1073
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1074
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.patchMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
|
|
1075
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1076
|
+
},
|
|
1077
|
+
/**
|
|
1078
|
+
* Update the weight of an objective within this value framework.
|
|
1079
|
+
* @summary Partially update an objective weight for this framework
|
|
1080
|
+
* @param {string} objectiveId UUID of the objective
|
|
1081
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1082
|
+
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
*/
|
|
1086
|
+
async patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>> {
|
|
1087
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options);
|
|
1088
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1089
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.patchObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
|
|
1090
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1091
|
+
},
|
|
1092
|
+
/**
|
|
1093
|
+
* 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.
|
|
1094
|
+
* @summary Partially update a value framework
|
|
1095
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1096
|
+
* @param {ValueFrameworkUpdate} valueFrameworkUpdate
|
|
1097
|
+
* @param {*} [options] Override http request option.
|
|
1098
|
+
* @throws {RequiredError}
|
|
1099
|
+
*/
|
|
1100
|
+
async patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>> {
|
|
299
1101
|
const localVarAxiosArgs = await localVarAxiosParamCreator.patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options);
|
|
300
|
-
const
|
|
301
|
-
const
|
|
302
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios,
|
|
1102
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1103
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.patchValueFramework']?.[localVarOperationServerIndex]?.url;
|
|
1104
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
303
1105
|
},
|
|
304
1106
|
/**
|
|
305
1107
|
* Create a new value framework. Name must be unique and non-empty.
|
|
@@ -310,20 +1112,64 @@ export const ValueFrameworkApiFp = function(configuration?: Configuration) {
|
|
|
310
1112
|
*/
|
|
311
1113
|
async postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>> {
|
|
312
1114
|
const localVarAxiosArgs = await localVarAxiosParamCreator.postValueFramework(valueFrameworkCreate, options);
|
|
313
|
-
const
|
|
314
|
-
const
|
|
315
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios,
|
|
1115
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1116
|
+
const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.postValueFramework']?.[localVarOperationServerIndex]?.url;
|
|
1117
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
316
1118
|
},
|
|
317
1119
|
}
|
|
318
1120
|
};
|
|
319
1121
|
|
|
320
1122
|
/**
|
|
321
1123
|
* ValueFrameworkApi - factory interface
|
|
322
|
-
* @export
|
|
323
1124
|
*/
|
|
324
1125
|
export const ValueFrameworkApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
325
1126
|
const localVarFp = ValueFrameworkApiFp(configuration)
|
|
326
1127
|
return {
|
|
1128
|
+
/**
|
|
1129
|
+
* Create a yearly cost override for a metric within this framework.
|
|
1130
|
+
* @summary Create a yearly metric cost for this framework
|
|
1131
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1132
|
+
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
1133
|
+
* @param {*} [options] Override http request option.
|
|
1134
|
+
* @throws {RequiredError}
|
|
1135
|
+
*/
|
|
1136
|
+
createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
|
|
1137
|
+
return localVarFp.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
|
|
1138
|
+
},
|
|
1139
|
+
/**
|
|
1140
|
+
* Assign a weight to an objective within this framework.
|
|
1141
|
+
* @summary Create an objective weight for this framework
|
|
1142
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1143
|
+
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
*/
|
|
1147
|
+
createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse> {
|
|
1148
|
+
return localVarFp.createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options).then((request) => request(axios, basePath));
|
|
1149
|
+
},
|
|
1150
|
+
/**
|
|
1151
|
+
* Delete a metric cost entry for a specific year within this framework.
|
|
1152
|
+
* @summary Delete metric costs for this framework
|
|
1153
|
+
* @param {string} metricId UUID of the metric
|
|
1154
|
+
* @param {number} year Year (1600-3000)
|
|
1155
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1156
|
+
* @param {*} [options] Override http request option.
|
|
1157
|
+
* @throws {RequiredError}
|
|
1158
|
+
*/
|
|
1159
|
+
deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
1160
|
+
return localVarFp.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
1161
|
+
},
|
|
1162
|
+
/**
|
|
1163
|
+
* Remove an objective weight from this framework.
|
|
1164
|
+
* @summary Delete an objective weight for this framework
|
|
1165
|
+
* @param {string} objectiveId UUID of the objective
|
|
1166
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1167
|
+
* @param {*} [options] Override http request option.
|
|
1168
|
+
* @throws {RequiredError}
|
|
1169
|
+
*/
|
|
1170
|
+
deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
1171
|
+
return localVarFp.deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
1172
|
+
},
|
|
327
1173
|
/**
|
|
328
1174
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
329
1175
|
* @summary Delete a value framework
|
|
@@ -331,9 +1177,81 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
|
|
|
331
1177
|
* @param {*} [options] Override http request option.
|
|
332
1178
|
* @throws {RequiredError}
|
|
333
1179
|
*/
|
|
334
|
-
deleteValueFramework(valueFrameworkId: string, options?:
|
|
1180
|
+
deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
335
1181
|
return localVarFp.deleteValueFramework(valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
336
1182
|
},
|
|
1183
|
+
/**
|
|
1184
|
+
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
1185
|
+
* @summary List all metric costs for a value framework
|
|
1186
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1187
|
+
* @param {number} [offset] Number of records to skip
|
|
1188
|
+
* @param {number} [limit] Max number of records to return
|
|
1189
|
+
* @param {*} [options] Override http request option.
|
|
1190
|
+
* @throws {RequiredError}
|
|
1191
|
+
*/
|
|
1192
|
+
getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
|
|
1193
|
+
return localVarFp.getCostsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
|
|
1194
|
+
},
|
|
1195
|
+
/**
|
|
1196
|
+
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
1197
|
+
* @summary List metric costs for a value framework filtered by metric
|
|
1198
|
+
* @param {string} metricId UUID of the metric
|
|
1199
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1200
|
+
* @param {number} [offset] Number of records to skip
|
|
1201
|
+
* @param {number} [limit] Max number of records to return
|
|
1202
|
+
* @param {*} [options] Override http request option.
|
|
1203
|
+
* @throws {RequiredError}
|
|
1204
|
+
*/
|
|
1205
|
+
getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
|
|
1206
|
+
return localVarFp.getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
|
|
1207
|
+
},
|
|
1208
|
+
/**
|
|
1209
|
+
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
1210
|
+
* @summary Get a yearly metric cost for this framework
|
|
1211
|
+
* @param {string} metricId UUID of the metric
|
|
1212
|
+
* @param {number} year Year (1600-3000)
|
|
1213
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1214
|
+
* @param {*} [options] Override http request option.
|
|
1215
|
+
* @throws {RequiredError}
|
|
1216
|
+
*/
|
|
1217
|
+
getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
|
|
1218
|
+
return localVarFp.getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
1219
|
+
},
|
|
1220
|
+
/**
|
|
1221
|
+
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
1222
|
+
* @summary List yearly metric costs for this framework
|
|
1223
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1224
|
+
* @param {number} [offset] Number of records to skip
|
|
1225
|
+
* @param {number} [limit] Max number of records to return
|
|
1226
|
+
* @param {*} [options] Override http request option.
|
|
1227
|
+
* @throws {RequiredError}
|
|
1228
|
+
*/
|
|
1229
|
+
getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
|
|
1230
|
+
return localVarFp.getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
|
|
1231
|
+
},
|
|
1232
|
+
/**
|
|
1233
|
+
* Retrieve the weight for a specific objective within this framework.
|
|
1234
|
+
* @summary Get an objective weight for this framework
|
|
1235
|
+
* @param {string} objectiveId UUID of the objective
|
|
1236
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1237
|
+
* @param {*} [options] Override http request option.
|
|
1238
|
+
* @throws {RequiredError}
|
|
1239
|
+
*/
|
|
1240
|
+
getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse> {
|
|
1241
|
+
return localVarFp.getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
1242
|
+
},
|
|
1243
|
+
/**
|
|
1244
|
+
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
1245
|
+
* @summary List objective weights for this framework
|
|
1246
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1247
|
+
* @param {number} [offset] Number of records to skip
|
|
1248
|
+
* @param {number} [limit] Max number of records to return
|
|
1249
|
+
* @param {*} [options] Override http request option.
|
|
1250
|
+
* @throws {RequiredError}
|
|
1251
|
+
*/
|
|
1252
|
+
getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>> {
|
|
1253
|
+
return localVarFp.getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
|
|
1254
|
+
},
|
|
337
1255
|
/**
|
|
338
1256
|
* Retrieve a single value framework by its ID.
|
|
339
1257
|
* @summary Get a value framework by ID
|
|
@@ -341,7 +1259,7 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
|
|
|
341
1259
|
* @param {*} [options] Override http request option.
|
|
342
1260
|
* @throws {RequiredError}
|
|
343
1261
|
*/
|
|
344
|
-
getValueFrameworkById(valueFrameworkId: string, options?:
|
|
1262
|
+
getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse> {
|
|
345
1263
|
return localVarFp.getValueFrameworkById(valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
346
1264
|
},
|
|
347
1265
|
/**
|
|
@@ -352,9 +1270,46 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
|
|
|
352
1270
|
* @param {*} [options] Override http request option.
|
|
353
1271
|
* @throws {RequiredError}
|
|
354
1272
|
*/
|
|
355
|
-
getValueFrameworks(offset?: number, limit?: number, options?:
|
|
1273
|
+
getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ValueFrameworkResponse>> {
|
|
356
1274
|
return localVarFp.getValueFrameworks(offset, limit, options).then((request) => request(axios, basePath));
|
|
357
1275
|
},
|
|
1276
|
+
/**
|
|
1277
|
+
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
1278
|
+
* @summary List all objective weights for a value framework
|
|
1279
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1280
|
+
* @param {number} [offset] Number of records to skip
|
|
1281
|
+
* @param {number} [limit] Max number of records to return
|
|
1282
|
+
* @param {*} [options] Override http request option.
|
|
1283
|
+
* @throws {RequiredError}
|
|
1284
|
+
*/
|
|
1285
|
+
getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>> {
|
|
1286
|
+
return localVarFp.getWeightsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
|
|
1287
|
+
},
|
|
1288
|
+
/**
|
|
1289
|
+
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
1290
|
+
* @summary Partially update metric costs for this framework
|
|
1291
|
+
* @param {string} metricId UUID of the metric
|
|
1292
|
+
* @param {number} year Year (1600-3000)
|
|
1293
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1294
|
+
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
*/
|
|
1298
|
+
patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
|
|
1299
|
+
return localVarFp.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
|
|
1300
|
+
},
|
|
1301
|
+
/**
|
|
1302
|
+
* Update the weight of an objective within this value framework.
|
|
1303
|
+
* @summary Partially update an objective weight for this framework
|
|
1304
|
+
* @param {string} objectiveId UUID of the objective
|
|
1305
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1306
|
+
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
1307
|
+
* @param {*} [options] Override http request option.
|
|
1308
|
+
* @throws {RequiredError}
|
|
1309
|
+
*/
|
|
1310
|
+
patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse> {
|
|
1311
|
+
return localVarFp.patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options).then((request) => request(axios, basePath));
|
|
1312
|
+
},
|
|
358
1313
|
/**
|
|
359
1314
|
* 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.
|
|
360
1315
|
* @summary Partially update a value framework
|
|
@@ -363,7 +1318,7 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
|
|
|
363
1318
|
* @param {*} [options] Override http request option.
|
|
364
1319
|
* @throws {RequiredError}
|
|
365
1320
|
*/
|
|
366
|
-
patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?:
|
|
1321
|
+
patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse> {
|
|
367
1322
|
return localVarFp.patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options).then((request) => request(axios, basePath));
|
|
368
1323
|
},
|
|
369
1324
|
/**
|
|
@@ -373,7 +1328,7 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
|
|
|
373
1328
|
* @param {*} [options] Override http request option.
|
|
374
1329
|
* @throws {RequiredError}
|
|
375
1330
|
*/
|
|
376
|
-
postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?:
|
|
1331
|
+
postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse> {
|
|
377
1332
|
return localVarFp.postValueFramework(valueFrameworkCreate, options).then((request) => request(axios, basePath));
|
|
378
1333
|
},
|
|
379
1334
|
};
|
|
@@ -381,30 +1336,152 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
|
|
|
381
1336
|
|
|
382
1337
|
/**
|
|
383
1338
|
* ValueFrameworkApi - object-oriented interface
|
|
384
|
-
* @export
|
|
385
|
-
* @class ValueFrameworkApi
|
|
386
|
-
* @extends {BaseAPI}
|
|
387
1339
|
*/
|
|
388
1340
|
export class ValueFrameworkApi extends BaseAPI {
|
|
1341
|
+
/**
|
|
1342
|
+
* Create a yearly cost override for a metric within this framework.
|
|
1343
|
+
* @summary Create a yearly metric cost for this framework
|
|
1344
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1345
|
+
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
1346
|
+
* @param {*} [options] Override http request option.
|
|
1347
|
+
* @throws {RequiredError}
|
|
1348
|
+
*/
|
|
1349
|
+
public createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) {
|
|
1350
|
+
return ValueFrameworkApiFp(this.configuration).createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* Assign a weight to an objective within this framework.
|
|
1355
|
+
* @summary Create an objective weight for this framework
|
|
1356
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1357
|
+
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
1358
|
+
* @param {*} [options] Override http request option.
|
|
1359
|
+
* @throws {RequiredError}
|
|
1360
|
+
*/
|
|
1361
|
+
public createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig) {
|
|
1362
|
+
return ValueFrameworkApiFp(this.configuration).createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options).then((request) => request(this.axios, this.basePath));
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
/**
|
|
1366
|
+
* Delete a metric cost entry for a specific year within this framework.
|
|
1367
|
+
* @summary Delete metric costs for this framework
|
|
1368
|
+
* @param {string} metricId UUID of the metric
|
|
1369
|
+
* @param {number} year Year (1600-3000)
|
|
1370
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1371
|
+
* @param {*} [options] Override http request option.
|
|
1372
|
+
* @throws {RequiredError}
|
|
1373
|
+
*/
|
|
1374
|
+
public deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
|
|
1375
|
+
return ValueFrameworkApiFp(this.configuration).deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
1376
|
+
}
|
|
1377
|
+
|
|
1378
|
+
/**
|
|
1379
|
+
* Remove an objective weight from this framework.
|
|
1380
|
+
* @summary Delete an objective weight for this framework
|
|
1381
|
+
* @param {string} objectiveId UUID of the objective
|
|
1382
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1383
|
+
* @param {*} [options] Override http request option.
|
|
1384
|
+
* @throws {RequiredError}
|
|
1385
|
+
*/
|
|
1386
|
+
public deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
|
|
1387
|
+
return ValueFrameworkApiFp(this.configuration).deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
1388
|
+
}
|
|
1389
|
+
|
|
389
1390
|
/**
|
|
390
1391
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
391
1392
|
* @summary Delete a value framework
|
|
392
1393
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
393
1394
|
* @param {*} [options] Override http request option.
|
|
394
1395
|
* @throws {RequiredError}
|
|
395
|
-
* @memberof ValueFrameworkApi
|
|
396
1396
|
*/
|
|
397
1397
|
public deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig) {
|
|
398
1398
|
return ValueFrameworkApiFp(this.configuration).deleteValueFramework(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
399
1399
|
}
|
|
400
1400
|
|
|
1401
|
+
/**
|
|
1402
|
+
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
1403
|
+
* @summary List all metric costs for a value framework
|
|
1404
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1405
|
+
* @param {number} [offset] Number of records to skip
|
|
1406
|
+
* @param {number} [limit] Max number of records to return
|
|
1407
|
+
* @param {*} [options] Override http request option.
|
|
1408
|
+
* @throws {RequiredError}
|
|
1409
|
+
*/
|
|
1410
|
+
public getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
1411
|
+
return ValueFrameworkApiFp(this.configuration).getCostsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1412
|
+
}
|
|
1413
|
+
|
|
1414
|
+
/**
|
|
1415
|
+
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
1416
|
+
* @summary List metric costs for a value framework filtered by metric
|
|
1417
|
+
* @param {string} metricId UUID of the metric
|
|
1418
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1419
|
+
* @param {number} [offset] Number of records to skip
|
|
1420
|
+
* @param {number} [limit] Max number of records to return
|
|
1421
|
+
* @param {*} [options] Override http request option.
|
|
1422
|
+
* @throws {RequiredError}
|
|
1423
|
+
*/
|
|
1424
|
+
public getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
1425
|
+
return ValueFrameworkApiFp(this.configuration).getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
/**
|
|
1429
|
+
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
1430
|
+
* @summary Get a yearly metric cost for this framework
|
|
1431
|
+
* @param {string} metricId UUID of the metric
|
|
1432
|
+
* @param {number} year Year (1600-3000)
|
|
1433
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1434
|
+
* @param {*} [options] Override http request option.
|
|
1435
|
+
* @throws {RequiredError}
|
|
1436
|
+
*/
|
|
1437
|
+
public getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
|
|
1438
|
+
return ValueFrameworkApiFp(this.configuration).getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
1439
|
+
}
|
|
1440
|
+
|
|
1441
|
+
/**
|
|
1442
|
+
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
1443
|
+
* @summary List yearly metric costs for this framework
|
|
1444
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1445
|
+
* @param {number} [offset] Number of records to skip
|
|
1446
|
+
* @param {number} [limit] Max number of records to return
|
|
1447
|
+
* @param {*} [options] Override http request option.
|
|
1448
|
+
* @throws {RequiredError}
|
|
1449
|
+
*/
|
|
1450
|
+
public getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
1451
|
+
return ValueFrameworkApiFp(this.configuration).getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1452
|
+
}
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* Retrieve the weight for a specific objective within this framework.
|
|
1456
|
+
* @summary Get an objective weight for this framework
|
|
1457
|
+
* @param {string} objectiveId UUID of the objective
|
|
1458
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1459
|
+
* @param {*} [options] Override http request option.
|
|
1460
|
+
* @throws {RequiredError}
|
|
1461
|
+
*/
|
|
1462
|
+
public getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
|
|
1463
|
+
return ValueFrameworkApiFp(this.configuration).getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
1464
|
+
}
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
1468
|
+
* @summary List objective weights for this framework
|
|
1469
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1470
|
+
* @param {number} [offset] Number of records to skip
|
|
1471
|
+
* @param {number} [limit] Max number of records to return
|
|
1472
|
+
* @param {*} [options] Override http request option.
|
|
1473
|
+
* @throws {RequiredError}
|
|
1474
|
+
*/
|
|
1475
|
+
public getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
1476
|
+
return ValueFrameworkApiFp(this.configuration).getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1477
|
+
}
|
|
1478
|
+
|
|
401
1479
|
/**
|
|
402
1480
|
* Retrieve a single value framework by its ID.
|
|
403
1481
|
* @summary Get a value framework by ID
|
|
404
1482
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
405
1483
|
* @param {*} [options] Override http request option.
|
|
406
1484
|
* @throws {RequiredError}
|
|
407
|
-
* @memberof ValueFrameworkApi
|
|
408
1485
|
*/
|
|
409
1486
|
public getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig) {
|
|
410
1487
|
return ValueFrameworkApiFp(this.configuration).getValueFrameworkById(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -417,12 +1494,51 @@ export class ValueFrameworkApi extends BaseAPI {
|
|
|
417
1494
|
* @param {number} [limit] Max number of records to return
|
|
418
1495
|
* @param {*} [options] Override http request option.
|
|
419
1496
|
* @throws {RequiredError}
|
|
420
|
-
* @memberof ValueFrameworkApi
|
|
421
1497
|
*/
|
|
422
1498
|
public getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
423
1499
|
return ValueFrameworkApiFp(this.configuration).getValueFrameworks(offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
424
1500
|
}
|
|
425
1501
|
|
|
1502
|
+
/**
|
|
1503
|
+
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
1504
|
+
* @summary List all objective weights for a value framework
|
|
1505
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1506
|
+
* @param {number} [offset] Number of records to skip
|
|
1507
|
+
* @param {number} [limit] Max number of records to return
|
|
1508
|
+
* @param {*} [options] Override http request option.
|
|
1509
|
+
* @throws {RequiredError}
|
|
1510
|
+
*/
|
|
1511
|
+
public getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
|
|
1512
|
+
return ValueFrameworkApiFp(this.configuration).getWeightsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1513
|
+
}
|
|
1514
|
+
|
|
1515
|
+
/**
|
|
1516
|
+
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
1517
|
+
* @summary Partially update metric costs for this framework
|
|
1518
|
+
* @param {string} metricId UUID of the metric
|
|
1519
|
+
* @param {number} year Year (1600-3000)
|
|
1520
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1521
|
+
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
1522
|
+
* @param {*} [options] Override http request option.
|
|
1523
|
+
* @throws {RequiredError}
|
|
1524
|
+
*/
|
|
1525
|
+
public patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) {
|
|
1526
|
+
return ValueFrameworkApiFp(this.configuration).patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
|
|
1527
|
+
}
|
|
1528
|
+
|
|
1529
|
+
/**
|
|
1530
|
+
* Update the weight of an objective within this value framework.
|
|
1531
|
+
* @summary Partially update an objective weight for this framework
|
|
1532
|
+
* @param {string} objectiveId UUID of the objective
|
|
1533
|
+
* @param {string} valueFrameworkId UUID of the value framework
|
|
1534
|
+
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
1535
|
+
* @param {*} [options] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
*/
|
|
1538
|
+
public patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) {
|
|
1539
|
+
return ValueFrameworkApiFp(this.configuration).patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options).then((request) => request(this.axios, this.basePath));
|
|
1540
|
+
}
|
|
1541
|
+
|
|
426
1542
|
/**
|
|
427
1543
|
* 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.
|
|
428
1544
|
* @summary Partially update a value framework
|
|
@@ -430,7 +1546,6 @@ export class ValueFrameworkApi extends BaseAPI {
|
|
|
430
1546
|
* @param {ValueFrameworkUpdate} valueFrameworkUpdate
|
|
431
1547
|
* @param {*} [options] Override http request option.
|
|
432
1548
|
* @throws {RequiredError}
|
|
433
|
-
* @memberof ValueFrameworkApi
|
|
434
1549
|
*/
|
|
435
1550
|
public patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig) {
|
|
436
1551
|
return ValueFrameworkApiFp(this.configuration).patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options).then((request) => request(this.axios, this.basePath));
|
|
@@ -442,7 +1557,6 @@ export class ValueFrameworkApi extends BaseAPI {
|
|
|
442
1557
|
* @param {ValueFrameworkCreate} valueFrameworkCreate
|
|
443
1558
|
* @param {*} [options] Override http request option.
|
|
444
1559
|
* @throws {RequiredError}
|
|
445
|
-
* @memberof ValueFrameworkApi
|
|
446
1560
|
*/
|
|
447
1561
|
public postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig) {
|
|
448
1562
|
return ValueFrameworkApiFp(this.configuration).postValueFramework(valueFrameworkCreate, options).then((request) => request(this.axios, this.basePath));
|