@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
package/dist/api/metric-api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Asset Investment Planning
|
|
6
6
|
* API for Asset Investment Planning
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.2.0-
|
|
8
|
+
* The version of the OpenAPI document: 0.2.0-dev3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -31,61 +31,70 @@ const common_1 = require("../common");
|
|
|
31
31
|
const base_1 = require("../base");
|
|
32
32
|
/**
|
|
33
33
|
* MetricApi - axios parameter creator
|
|
34
|
-
* @export
|
|
35
34
|
*/
|
|
36
35
|
const MetricApiAxiosParamCreator = function (configuration) {
|
|
37
36
|
return {
|
|
38
37
|
/**
|
|
39
|
-
*
|
|
40
|
-
* @summary
|
|
41
|
-
* @param {string}
|
|
38
|
+
* Create a new metric under this objective.
|
|
39
|
+
* @summary Create a metric for this objective
|
|
40
|
+
* @param {string} objectiveId UUID of the objective
|
|
41
|
+
* @param {MetricCreate} metricCreate
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
|
|
46
|
-
// verify required parameter '
|
|
47
|
-
(0, common_1.assertParamExists)('
|
|
48
|
-
|
|
49
|
-
|
|
45
|
+
createMetricForObjective: (objectiveId_1, metricCreate_1, ...args_1) => __awaiter(this, [objectiveId_1, metricCreate_1, ...args_1], void 0, function* (objectiveId, metricCreate, options = {}) {
|
|
46
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
47
|
+
(0, common_1.assertParamExists)('createMetricForObjective', 'objectiveId', objectiveId);
|
|
48
|
+
// verify required parameter 'metricCreate' is not null or undefined
|
|
49
|
+
(0, common_1.assertParamExists)('createMetricForObjective', 'metricCreate', metricCreate);
|
|
50
|
+
const localVarPath = `/objective/{objective_id}/metric/`
|
|
51
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
|
|
50
52
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
53
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
52
54
|
let baseOptions;
|
|
53
55
|
if (configuration) {
|
|
54
56
|
baseOptions = configuration.baseOptions;
|
|
55
57
|
}
|
|
56
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
58
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
57
59
|
const localVarHeaderParameter = {};
|
|
58
60
|
const localVarQueryParameter = {};
|
|
59
61
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
60
62
|
// oauth required
|
|
61
63
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
64
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
62
66
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
63
67
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
64
68
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
69
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricCreate, localVarRequestOptions, configuration);
|
|
65
70
|
return {
|
|
66
71
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
67
72
|
options: localVarRequestOptions,
|
|
68
73
|
};
|
|
69
74
|
}),
|
|
70
75
|
/**
|
|
71
|
-
*
|
|
72
|
-
* @summary
|
|
76
|
+
* Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
|
|
77
|
+
* @summary Delete a metric for this objective
|
|
73
78
|
* @param {string} metricId UUID of the metric
|
|
79
|
+
* @param {string} objectiveId UUID of the objective
|
|
74
80
|
* @param {*} [options] Override http request option.
|
|
75
81
|
* @throws {RequiredError}
|
|
76
82
|
*/
|
|
77
|
-
|
|
83
|
+
deleteMetricForObjective: (metricId_1, objectiveId_1, ...args_1) => __awaiter(this, [metricId_1, objectiveId_1, ...args_1], void 0, function* (metricId, objectiveId, options = {}) {
|
|
78
84
|
// verify required parameter 'metricId' is not null or undefined
|
|
79
|
-
(0, common_1.assertParamExists)('
|
|
80
|
-
|
|
81
|
-
|
|
85
|
+
(0, common_1.assertParamExists)('deleteMetricForObjective', 'metricId', metricId);
|
|
86
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
87
|
+
(0, common_1.assertParamExists)('deleteMetricForObjective', 'objectiveId', objectiveId);
|
|
88
|
+
const localVarPath = `/objective/{objective_id}/metric/{metric_id}`
|
|
89
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
90
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
|
|
82
91
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
83
92
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
84
93
|
let baseOptions;
|
|
85
94
|
if (configuration) {
|
|
86
95
|
baseOptions = configuration.baseOptions;
|
|
87
96
|
}
|
|
88
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
97
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
89
98
|
const localVarHeaderParameter = {};
|
|
90
99
|
const localVarQueryParameter = {};
|
|
91
100
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
@@ -100,15 +109,21 @@ const MetricApiAxiosParamCreator = function (configuration) {
|
|
|
100
109
|
};
|
|
101
110
|
}),
|
|
102
111
|
/**
|
|
103
|
-
* Retrieve a
|
|
104
|
-
* @summary
|
|
105
|
-
* @param {
|
|
106
|
-
* @param {
|
|
112
|
+
* Retrieve a specific metric for the objective.
|
|
113
|
+
* @summary Get a metric for this objective
|
|
114
|
+
* @param {string} metricId UUID of the metric
|
|
115
|
+
* @param {string} objectiveId UUID of the objective
|
|
107
116
|
* @param {*} [options] Override http request option.
|
|
108
117
|
* @throws {RequiredError}
|
|
109
118
|
*/
|
|
110
|
-
|
|
111
|
-
|
|
119
|
+
getMetricForObjective: (metricId_1, objectiveId_1, ...args_1) => __awaiter(this, [metricId_1, objectiveId_1, ...args_1], void 0, function* (metricId, objectiveId, options = {}) {
|
|
120
|
+
// verify required parameter 'metricId' is not null or undefined
|
|
121
|
+
(0, common_1.assertParamExists)('getMetricForObjective', 'metricId', metricId);
|
|
122
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
123
|
+
(0, common_1.assertParamExists)('getMetricForObjective', 'objectiveId', objectiveId);
|
|
124
|
+
const localVarPath = `/objective/{objective_id}/metric/{metric_id}`
|
|
125
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
126
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
|
|
112
127
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
113
128
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
114
129
|
let baseOptions;
|
|
@@ -121,12 +136,7 @@ const MetricApiAxiosParamCreator = function (configuration) {
|
|
|
121
136
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
122
137
|
// oauth required
|
|
123
138
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
124
|
-
|
|
125
|
-
localVarQueryParameter['offset'] = offset;
|
|
126
|
-
}
|
|
127
|
-
if (limit !== undefined) {
|
|
128
|
-
localVarQueryParameter['limit'] = limit;
|
|
129
|
-
}
|
|
139
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
130
140
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
131
141
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
132
142
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -136,70 +146,83 @@ const MetricApiAxiosParamCreator = function (configuration) {
|
|
|
136
146
|
};
|
|
137
147
|
}),
|
|
138
148
|
/**
|
|
139
|
-
*
|
|
140
|
-
* @summary
|
|
141
|
-
* @param {string}
|
|
142
|
-
* @param {
|
|
149
|
+
* Retrieve a paginated list of all metrics for a specific objective.
|
|
150
|
+
* @summary List metrics for this objective
|
|
151
|
+
* @param {string} objectiveId UUID of the objective
|
|
152
|
+
* @param {number} [offset] Number of records to skip
|
|
153
|
+
* @param {number} [limit] Max number of records to return
|
|
143
154
|
* @param {*} [options] Override http request option.
|
|
144
155
|
* @throws {RequiredError}
|
|
145
156
|
*/
|
|
146
|
-
|
|
147
|
-
// verify required parameter '
|
|
148
|
-
(0, common_1.assertParamExists)('
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
const localVarPath = `/metric/{metric_id}`
|
|
152
|
-
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
|
|
157
|
+
getMetricsForObjective: (objectiveId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [objectiveId_1, offset_1, limit_1, ...args_1], void 0, function* (objectiveId, offset, limit, options = {}) {
|
|
158
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
159
|
+
(0, common_1.assertParamExists)('getMetricsForObjective', 'objectiveId', objectiveId);
|
|
160
|
+
const localVarPath = `/objective/{objective_id}/metric/`
|
|
161
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
|
|
153
162
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154
163
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
155
164
|
let baseOptions;
|
|
156
165
|
if (configuration) {
|
|
157
166
|
baseOptions = configuration.baseOptions;
|
|
158
167
|
}
|
|
159
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
168
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
160
169
|
const localVarHeaderParameter = {};
|
|
161
170
|
const localVarQueryParameter = {};
|
|
162
171
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
163
172
|
// oauth required
|
|
164
173
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
165
|
-
|
|
174
|
+
if (offset !== undefined) {
|
|
175
|
+
localVarQueryParameter['offset'] = offset;
|
|
176
|
+
}
|
|
177
|
+
if (limit !== undefined) {
|
|
178
|
+
localVarQueryParameter['limit'] = limit;
|
|
179
|
+
}
|
|
180
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
166
181
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
167
182
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
168
183
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
169
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricUpdate, localVarRequestOptions, configuration);
|
|
170
184
|
return {
|
|
171
185
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
172
186
|
options: localVarRequestOptions,
|
|
173
187
|
};
|
|
174
188
|
}),
|
|
175
189
|
/**
|
|
176
|
-
*
|
|
177
|
-
* @summary
|
|
178
|
-
* @param {
|
|
190
|
+
* Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
191
|
+
* @summary Partially update a metric for this objective
|
|
192
|
+
* @param {string} metricId UUID of the metric
|
|
193
|
+
* @param {string} objectiveId UUID of the objective
|
|
194
|
+
* @param {MetricUpdate} metricUpdate
|
|
179
195
|
* @param {*} [options] Override http request option.
|
|
180
196
|
* @throws {RequiredError}
|
|
181
197
|
*/
|
|
182
|
-
|
|
183
|
-
// verify required parameter '
|
|
184
|
-
(0, common_1.assertParamExists)('
|
|
185
|
-
|
|
198
|
+
patchMetricForObjective: (metricId_1, objectiveId_1, metricUpdate_1, ...args_1) => __awaiter(this, [metricId_1, objectiveId_1, metricUpdate_1, ...args_1], void 0, function* (metricId, objectiveId, metricUpdate, options = {}) {
|
|
199
|
+
// verify required parameter 'metricId' is not null or undefined
|
|
200
|
+
(0, common_1.assertParamExists)('patchMetricForObjective', 'metricId', metricId);
|
|
201
|
+
// verify required parameter 'objectiveId' is not null or undefined
|
|
202
|
+
(0, common_1.assertParamExists)('patchMetricForObjective', 'objectiveId', objectiveId);
|
|
203
|
+
// verify required parameter 'metricUpdate' is not null or undefined
|
|
204
|
+
(0, common_1.assertParamExists)('patchMetricForObjective', 'metricUpdate', metricUpdate);
|
|
205
|
+
const localVarPath = `/objective/{objective_id}/metric/{metric_id}`
|
|
206
|
+
.replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
|
|
207
|
+
.replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
|
|
186
208
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
187
209
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
188
210
|
let baseOptions;
|
|
189
211
|
if (configuration) {
|
|
190
212
|
baseOptions = configuration.baseOptions;
|
|
191
213
|
}
|
|
192
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
214
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
193
215
|
const localVarHeaderParameter = {};
|
|
194
216
|
const localVarQueryParameter = {};
|
|
195
217
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
196
218
|
// oauth required
|
|
197
219
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
198
220
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
221
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
199
222
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
200
223
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
201
224
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
202
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
225
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricUpdate, localVarRequestOptions, configuration);
|
|
203
226
|
return {
|
|
204
227
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
205
228
|
options: localVarRequestOptions,
|
|
@@ -210,91 +233,95 @@ const MetricApiAxiosParamCreator = function (configuration) {
|
|
|
210
233
|
exports.MetricApiAxiosParamCreator = MetricApiAxiosParamCreator;
|
|
211
234
|
/**
|
|
212
235
|
* MetricApi - functional programming interface
|
|
213
|
-
* @export
|
|
214
236
|
*/
|
|
215
237
|
const MetricApiFp = function (configuration) {
|
|
216
238
|
const localVarAxiosParamCreator = (0, exports.MetricApiAxiosParamCreator)(configuration);
|
|
217
239
|
return {
|
|
218
240
|
/**
|
|
219
|
-
*
|
|
220
|
-
* @summary
|
|
221
|
-
* @param {string}
|
|
241
|
+
* Create a new metric under this objective.
|
|
242
|
+
* @summary Create a metric for this objective
|
|
243
|
+
* @param {string} objectiveId UUID of the objective
|
|
244
|
+
* @param {MetricCreate} metricCreate
|
|
222
245
|
* @param {*} [options] Override http request option.
|
|
223
246
|
* @throws {RequiredError}
|
|
224
247
|
*/
|
|
225
|
-
|
|
226
|
-
var _a, _b, _c;
|
|
248
|
+
createMetricForObjective(objectiveId, metricCreate, options) {
|
|
227
249
|
return __awaiter(this, void 0, void 0, function* () {
|
|
228
|
-
|
|
229
|
-
const
|
|
230
|
-
const
|
|
231
|
-
|
|
250
|
+
var _a, _b, _c;
|
|
251
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createMetricForObjective(objectiveId, metricCreate, options);
|
|
252
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
253
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.createMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
254
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
232
255
|
});
|
|
233
256
|
},
|
|
234
257
|
/**
|
|
235
|
-
*
|
|
236
|
-
* @summary
|
|
258
|
+
* Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
|
|
259
|
+
* @summary Delete a metric for this objective
|
|
237
260
|
* @param {string} metricId UUID of the metric
|
|
261
|
+
* @param {string} objectiveId UUID of the objective
|
|
238
262
|
* @param {*} [options] Override http request option.
|
|
239
263
|
* @throws {RequiredError}
|
|
240
264
|
*/
|
|
241
|
-
|
|
242
|
-
var _a, _b, _c;
|
|
265
|
+
deleteMetricForObjective(metricId, objectiveId, options) {
|
|
243
266
|
return __awaiter(this, void 0, void 0, function* () {
|
|
244
|
-
|
|
245
|
-
const
|
|
246
|
-
const
|
|
247
|
-
|
|
267
|
+
var _a, _b, _c;
|
|
268
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteMetricForObjective(metricId, objectiveId, options);
|
|
269
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
270
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.deleteMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
271
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
248
272
|
});
|
|
249
273
|
},
|
|
250
274
|
/**
|
|
251
|
-
* Retrieve a
|
|
252
|
-
* @summary
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
275
|
+
* Retrieve a specific metric for the objective.
|
|
276
|
+
* @summary Get a metric for this objective
|
|
277
|
+
* @param {string} metricId UUID of the metric
|
|
278
|
+
* @param {string} objectiveId UUID of the objective
|
|
255
279
|
* @param {*} [options] Override http request option.
|
|
256
280
|
* @throws {RequiredError}
|
|
257
281
|
*/
|
|
258
|
-
|
|
259
|
-
var _a, _b, _c;
|
|
282
|
+
getMetricForObjective(metricId, objectiveId, options) {
|
|
260
283
|
return __awaiter(this, void 0, void 0, function* () {
|
|
261
|
-
|
|
262
|
-
const
|
|
263
|
-
const
|
|
264
|
-
|
|
284
|
+
var _a, _b, _c;
|
|
285
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricForObjective(metricId, objectiveId, options);
|
|
286
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
287
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.getMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
288
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
265
289
|
});
|
|
266
290
|
},
|
|
267
291
|
/**
|
|
268
|
-
*
|
|
269
|
-
* @summary
|
|
270
|
-
* @param {string}
|
|
271
|
-
* @param {
|
|
292
|
+
* Retrieve a paginated list of all metrics for a specific objective.
|
|
293
|
+
* @summary List metrics for this objective
|
|
294
|
+
* @param {string} objectiveId UUID of the objective
|
|
295
|
+
* @param {number} [offset] Number of records to skip
|
|
296
|
+
* @param {number} [limit] Max number of records to return
|
|
272
297
|
* @param {*} [options] Override http request option.
|
|
273
298
|
* @throws {RequiredError}
|
|
274
299
|
*/
|
|
275
|
-
|
|
276
|
-
var _a, _b, _c;
|
|
300
|
+
getMetricsForObjective(objectiveId, offset, limit, options) {
|
|
277
301
|
return __awaiter(this, void 0, void 0, function* () {
|
|
278
|
-
|
|
279
|
-
const
|
|
280
|
-
const
|
|
281
|
-
|
|
302
|
+
var _a, _b, _c;
|
|
303
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricsForObjective(objectiveId, offset, limit, options);
|
|
304
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
305
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.getMetricsForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
306
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
282
307
|
});
|
|
283
308
|
},
|
|
284
309
|
/**
|
|
285
|
-
*
|
|
286
|
-
* @summary
|
|
287
|
-
* @param {
|
|
310
|
+
* Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
311
|
+
* @summary Partially update a metric for this objective
|
|
312
|
+
* @param {string} metricId UUID of the metric
|
|
313
|
+
* @param {string} objectiveId UUID of the objective
|
|
314
|
+
* @param {MetricUpdate} metricUpdate
|
|
288
315
|
* @param {*} [options] Override http request option.
|
|
289
316
|
* @throws {RequiredError}
|
|
290
317
|
*/
|
|
291
|
-
|
|
292
|
-
var _a, _b, _c;
|
|
318
|
+
patchMetricForObjective(metricId, objectiveId, metricUpdate, options) {
|
|
293
319
|
return __awaiter(this, void 0, void 0, function* () {
|
|
294
|
-
|
|
295
|
-
const
|
|
296
|
-
const
|
|
297
|
-
|
|
320
|
+
var _a, _b, _c;
|
|
321
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchMetricForObjective(metricId, objectiveId, metricUpdate, options);
|
|
322
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
323
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.patchMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
324
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
298
325
|
});
|
|
299
326
|
},
|
|
300
327
|
};
|
|
@@ -302,129 +329,130 @@ const MetricApiFp = function (configuration) {
|
|
|
302
329
|
exports.MetricApiFp = MetricApiFp;
|
|
303
330
|
/**
|
|
304
331
|
* MetricApi - factory interface
|
|
305
|
-
* @export
|
|
306
332
|
*/
|
|
307
333
|
const MetricApiFactory = function (configuration, basePath, axios) {
|
|
308
334
|
const localVarFp = (0, exports.MetricApiFp)(configuration);
|
|
309
335
|
return {
|
|
336
|
+
/**
|
|
337
|
+
* Create a new metric under this objective.
|
|
338
|
+
* @summary Create a metric for this objective
|
|
339
|
+
* @param {string} objectiveId UUID of the objective
|
|
340
|
+
* @param {MetricCreate} metricCreate
|
|
341
|
+
* @param {*} [options] Override http request option.
|
|
342
|
+
* @throws {RequiredError}
|
|
343
|
+
*/
|
|
344
|
+
createMetricForObjective(objectiveId, metricCreate, options) {
|
|
345
|
+
return localVarFp.createMetricForObjective(objectiveId, metricCreate, options).then((request) => request(axios, basePath));
|
|
346
|
+
},
|
|
310
347
|
/**
|
|
311
348
|
* Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
|
|
312
|
-
* @summary Delete a metric
|
|
349
|
+
* @summary Delete a metric for this objective
|
|
313
350
|
* @param {string} metricId UUID of the metric
|
|
351
|
+
* @param {string} objectiveId UUID of the objective
|
|
314
352
|
* @param {*} [options] Override http request option.
|
|
315
353
|
* @throws {RequiredError}
|
|
316
354
|
*/
|
|
317
|
-
|
|
318
|
-
return localVarFp.
|
|
355
|
+
deleteMetricForObjective(metricId, objectiveId, options) {
|
|
356
|
+
return localVarFp.deleteMetricForObjective(metricId, objectiveId, options).then((request) => request(axios, basePath));
|
|
319
357
|
},
|
|
320
358
|
/**
|
|
321
|
-
* Retrieve a
|
|
322
|
-
* @summary Get a metric
|
|
359
|
+
* Retrieve a specific metric for the objective.
|
|
360
|
+
* @summary Get a metric for this objective
|
|
323
361
|
* @param {string} metricId UUID of the metric
|
|
362
|
+
* @param {string} objectiveId UUID of the objective
|
|
324
363
|
* @param {*} [options] Override http request option.
|
|
325
364
|
* @throws {RequiredError}
|
|
326
365
|
*/
|
|
327
|
-
|
|
328
|
-
return localVarFp.
|
|
366
|
+
getMetricForObjective(metricId, objectiveId, options) {
|
|
367
|
+
return localVarFp.getMetricForObjective(metricId, objectiveId, options).then((request) => request(axios, basePath));
|
|
329
368
|
},
|
|
330
369
|
/**
|
|
331
|
-
* Retrieve a paginated list of all metrics.
|
|
332
|
-
* @summary List metrics
|
|
370
|
+
* Retrieve a paginated list of all metrics for a specific objective.
|
|
371
|
+
* @summary List metrics for this objective
|
|
372
|
+
* @param {string} objectiveId UUID of the objective
|
|
333
373
|
* @param {number} [offset] Number of records to skip
|
|
334
374
|
* @param {number} [limit] Max number of records to return
|
|
335
375
|
* @param {*} [options] Override http request option.
|
|
336
376
|
* @throws {RequiredError}
|
|
337
377
|
*/
|
|
338
|
-
|
|
339
|
-
return localVarFp.
|
|
378
|
+
getMetricsForObjective(objectiveId, offset, limit, options) {
|
|
379
|
+
return localVarFp.getMetricsForObjective(objectiveId, offset, limit, options).then((request) => request(axios, basePath));
|
|
340
380
|
},
|
|
341
381
|
/**
|
|
342
382
|
* Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
343
|
-
* @summary Partially update a metric
|
|
383
|
+
* @summary Partially update a metric for this objective
|
|
344
384
|
* @param {string} metricId UUID of the metric
|
|
385
|
+
* @param {string} objectiveId UUID of the objective
|
|
345
386
|
* @param {MetricUpdate} metricUpdate
|
|
346
387
|
* @param {*} [options] Override http request option.
|
|
347
388
|
* @throws {RequiredError}
|
|
348
389
|
*/
|
|
349
|
-
|
|
350
|
-
return localVarFp.
|
|
351
|
-
},
|
|
352
|
-
/**
|
|
353
|
-
* Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
|
|
354
|
-
* @summary Create a metric
|
|
355
|
-
* @param {MetricCreate} metricCreate
|
|
356
|
-
* @param {*} [options] Override http request option.
|
|
357
|
-
* @throws {RequiredError}
|
|
358
|
-
*/
|
|
359
|
-
postMetric(metricCreate, options) {
|
|
360
|
-
return localVarFp.postMetric(metricCreate, options).then((request) => request(axios, basePath));
|
|
390
|
+
patchMetricForObjective(metricId, objectiveId, metricUpdate, options) {
|
|
391
|
+
return localVarFp.patchMetricForObjective(metricId, objectiveId, metricUpdate, options).then((request) => request(axios, basePath));
|
|
361
392
|
},
|
|
362
393
|
};
|
|
363
394
|
};
|
|
364
395
|
exports.MetricApiFactory = MetricApiFactory;
|
|
365
396
|
/**
|
|
366
397
|
* MetricApi - object-oriented interface
|
|
367
|
-
* @export
|
|
368
|
-
* @class MetricApi
|
|
369
|
-
* @extends {BaseAPI}
|
|
370
398
|
*/
|
|
371
399
|
class MetricApi extends base_1.BaseAPI {
|
|
400
|
+
/**
|
|
401
|
+
* Create a new metric under this objective.
|
|
402
|
+
* @summary Create a metric for this objective
|
|
403
|
+
* @param {string} objectiveId UUID of the objective
|
|
404
|
+
* @param {MetricCreate} metricCreate
|
|
405
|
+
* @param {*} [options] Override http request option.
|
|
406
|
+
* @throws {RequiredError}
|
|
407
|
+
*/
|
|
408
|
+
createMetricForObjective(objectiveId, metricCreate, options) {
|
|
409
|
+
return (0, exports.MetricApiFp)(this.configuration).createMetricForObjective(objectiveId, metricCreate, options).then((request) => request(this.axios, this.basePath));
|
|
410
|
+
}
|
|
372
411
|
/**
|
|
373
412
|
* Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
|
|
374
|
-
* @summary Delete a metric
|
|
413
|
+
* @summary Delete a metric for this objective
|
|
375
414
|
* @param {string} metricId UUID of the metric
|
|
415
|
+
* @param {string} objectiveId UUID of the objective
|
|
376
416
|
* @param {*} [options] Override http request option.
|
|
377
417
|
* @throws {RequiredError}
|
|
378
|
-
* @memberof MetricApi
|
|
379
418
|
*/
|
|
380
|
-
|
|
381
|
-
return (0, exports.MetricApiFp)(this.configuration).
|
|
419
|
+
deleteMetricForObjective(metricId, objectiveId, options) {
|
|
420
|
+
return (0, exports.MetricApiFp)(this.configuration).deleteMetricForObjective(metricId, objectiveId, options).then((request) => request(this.axios, this.basePath));
|
|
382
421
|
}
|
|
383
422
|
/**
|
|
384
|
-
* Retrieve a
|
|
385
|
-
* @summary Get a metric
|
|
423
|
+
* Retrieve a specific metric for the objective.
|
|
424
|
+
* @summary Get a metric for this objective
|
|
386
425
|
* @param {string} metricId UUID of the metric
|
|
426
|
+
* @param {string} objectiveId UUID of the objective
|
|
387
427
|
* @param {*} [options] Override http request option.
|
|
388
428
|
* @throws {RequiredError}
|
|
389
|
-
* @memberof MetricApi
|
|
390
429
|
*/
|
|
391
|
-
|
|
392
|
-
return (0, exports.MetricApiFp)(this.configuration).
|
|
430
|
+
getMetricForObjective(metricId, objectiveId, options) {
|
|
431
|
+
return (0, exports.MetricApiFp)(this.configuration).getMetricForObjective(metricId, objectiveId, options).then((request) => request(this.axios, this.basePath));
|
|
393
432
|
}
|
|
394
433
|
/**
|
|
395
|
-
* Retrieve a paginated list of all metrics.
|
|
396
|
-
* @summary List metrics
|
|
434
|
+
* Retrieve a paginated list of all metrics for a specific objective.
|
|
435
|
+
* @summary List metrics for this objective
|
|
436
|
+
* @param {string} objectiveId UUID of the objective
|
|
397
437
|
* @param {number} [offset] Number of records to skip
|
|
398
438
|
* @param {number} [limit] Max number of records to return
|
|
399
439
|
* @param {*} [options] Override http request option.
|
|
400
440
|
* @throws {RequiredError}
|
|
401
|
-
* @memberof MetricApi
|
|
402
441
|
*/
|
|
403
|
-
|
|
404
|
-
return (0, exports.MetricApiFp)(this.configuration).
|
|
442
|
+
getMetricsForObjective(objectiveId, offset, limit, options) {
|
|
443
|
+
return (0, exports.MetricApiFp)(this.configuration).getMetricsForObjective(objectiveId, offset, limit, options).then((request) => request(this.axios, this.basePath));
|
|
405
444
|
}
|
|
406
445
|
/**
|
|
407
446
|
* Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
408
|
-
* @summary Partially update a metric
|
|
447
|
+
* @summary Partially update a metric for this objective
|
|
409
448
|
* @param {string} metricId UUID of the metric
|
|
449
|
+
* @param {string} objectiveId UUID of the objective
|
|
410
450
|
* @param {MetricUpdate} metricUpdate
|
|
411
451
|
* @param {*} [options] Override http request option.
|
|
412
452
|
* @throws {RequiredError}
|
|
413
|
-
* @memberof MetricApi
|
|
414
|
-
*/
|
|
415
|
-
patchMetric(metricId, metricUpdate, options) {
|
|
416
|
-
return (0, exports.MetricApiFp)(this.configuration).patchMetric(metricId, metricUpdate, options).then((request) => request(this.axios, this.basePath));
|
|
417
|
-
}
|
|
418
|
-
/**
|
|
419
|
-
* Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
|
|
420
|
-
* @summary Create a metric
|
|
421
|
-
* @param {MetricCreate} metricCreate
|
|
422
|
-
* @param {*} [options] Override http request option.
|
|
423
|
-
* @throws {RequiredError}
|
|
424
|
-
* @memberof MetricApi
|
|
425
453
|
*/
|
|
426
|
-
|
|
427
|
-
return (0, exports.MetricApiFp)(this.configuration).
|
|
454
|
+
patchMetricForObjective(metricId, objectiveId, metricUpdate, options) {
|
|
455
|
+
return (0, exports.MetricApiFp)(this.configuration).patchMetricForObjective(metricId, objectiveId, metricUpdate, options).then((request) => request(this.axios, this.basePath));
|
|
428
456
|
}
|
|
429
457
|
}
|
|
430
458
|
exports.MetricApi = MetricApi;
|