@cosmotech/aip-client 0.2.0-dev → 0.2.0-dev3

package/dist/esm/api/metric-costs-per-year-api.js

@@ -0,0 +1,472 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * MetricCostsPerYearApi - axios parameter creator
+ */
+export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Create a yearly cost override for a metric within this framework.
+         * @summary Create a yearly metric cost for this framework
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMetricCostForFramework: (valueFrameworkId_1, metricCostsPerYearCreate_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, metricCostsPerYearCreate_1, ...args_1], void 0, function* (valueFrameworkId, metricCostsPerYearCreate, options = {}) {
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('createMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
+            // verify required parameter 'metricCostsPerYearCreate' is not null or undefined
+            assertParamExists('createMetricCostForFramework', 'metricCostsPerYearCreate', metricCostsPerYearCreate);
+            const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearCreate, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Delete a metric cost entry for a specific year within this framework.
+         * @summary Delete metric costs for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteMetricCostForFramework: (metricId_1, year_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [metricId_1, year_1, valueFrameworkId_1, ...args_1], void 0, function* (metricId, year, valueFrameworkId, options = {}) {
+            // verify required parameter 'metricId' is not null or undefined
+            assertParamExists('deleteMetricCostForFramework', 'metricId', metricId);
+            // verify required parameter 'year' is not null or undefined
+            assertParamExists('deleteMetricCostForFramework', 'year', year);
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('deleteMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
+                .replace(`{${"year"}}`, encodeURIComponent(String(year)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Retrieve cost data for a specific metric within this framework for a given year.
+         * @summary Get a yearly metric cost for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricCostForFramework: (metricId_1, year_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [metricId_1, year_1, valueFrameworkId_1, ...args_1], void 0, function* (metricId, year, valueFrameworkId, options = {}) {
+            // verify required parameter 'metricId' is not null or undefined
+            assertParamExists('getMetricCostForFramework', 'metricId', metricId);
+            // verify required parameter 'year' is not null or undefined
+            assertParamExists('getMetricCostForFramework', 'year', year);
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
+                .replace(`{${"year"}}`, encodeURIComponent(String(year)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Retrieve a paginated list of all yearly metric costs for a specific framework.
+         * @summary List yearly metric costs for this framework
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {number} [offset] Number of records to skip
+         * @param {number} [limit] Max number of records to return
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricCostsForFramework: (valueFrameworkId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (valueFrameworkId, offset, limit, options = {}) {
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getMetricCostsForFramework', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Update the perceived and/or direct cost of a metric for a specific year within this framework.
+         * @summary Partially update metric costs for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchMetricCostForFramework: (metricId_1, year_1, valueFrameworkId_1, metricCostsPerYearUpdate_1, ...args_1) => __awaiter(this, [metricId_1, year_1, valueFrameworkId_1, metricCostsPerYearUpdate_1, ...args_1], void 0, function* (metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options = {}) {
+            // verify required parameter 'metricId' is not null or undefined
+            assertParamExists('patchMetricCostForFramework', 'metricId', metricId);
+            // verify required parameter 'year' is not null or undefined
+            assertParamExists('patchMetricCostForFramework', 'year', year);
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('patchMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
+            // verify required parameter 'metricCostsPerYearUpdate' is not null or undefined
+            assertParamExists('patchMetricCostForFramework', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate);
+            const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
+                .replace(`{${"year"}}`, encodeURIComponent(String(year)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearUpdate, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * MetricCostsPerYearApi - functional programming interface
+ */
+export const MetricCostsPerYearApiFp = function (configuration) {
+    const localVarAxiosParamCreator = MetricCostsPerYearApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Create a yearly cost override for a metric within this framework.
+         * @summary Create a yearly metric cost for this framework
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.createMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Delete a metric cost entry for a specific year within this framework.
+         * @summary Delete metric costs for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.deleteMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Retrieve cost data for a specific metric within this framework for a given year.
+         * @summary Get a yearly metric cost for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricCostForFramework(metricId, year, valueFrameworkId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.getMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Retrieve a paginated list of all yearly metric costs for a specific framework.
+         * @summary List yearly metric costs for this framework
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {number} [offset] Number of records to skip
+         * @param {number} [limit] Max number of records to return
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricCostsForFramework(valueFrameworkId, offset, limit, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.getMetricCostsForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Update the perceived and/or direct cost of a metric for a specific year within this framework.
+         * @summary Partially update metric costs for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.patchMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * MetricCostsPerYearApi - factory interface
+ */
+export const MetricCostsPerYearApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = MetricCostsPerYearApiFp(configuration);
+    return {
+        /**
+         * Create a yearly cost override for a metric within this framework.
+         * @summary Create a yearly metric cost for this framework
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
+            return localVarFp.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Delete a metric cost entry for a specific year within this framework.
+         * @summary Delete metric costs for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
+            return localVarFp.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve cost data for a specific metric within this framework for a given year.
+         * @summary Get a yearly metric cost for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
+            return localVarFp.getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve a paginated list of all yearly metric costs for a specific framework.
+         * @summary List yearly metric costs for this framework
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {number} [offset] Number of records to skip
+         * @param {number} [limit] Max number of records to return
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
+            return localVarFp.getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Update the perceived and/or direct cost of a metric for a specific year within this framework.
+         * @summary Partially update metric costs for this framework
+         * @param {string} metricId UUID of the metric
+         * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
+            return localVarFp.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * MetricCostsPerYearApi - object-oriented interface
+ */
+export class MetricCostsPerYearApi extends BaseAPI {
+    /**
+     * Create a yearly cost override for a metric within this framework.
+     * @summary Create a yearly metric cost for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
+        return MetricCostsPerYearApiFp(this.configuration).createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Delete a metric cost entry for a specific year within this framework.
+     * @summary Delete metric costs for this framework
+     * @param {string} metricId UUID of the metric
+     * @param {number} year Year (1600-3000)
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
+        return MetricCostsPerYearApiFp(this.configuration).deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve cost data for a specific metric within this framework for a given year.
+     * @summary Get a yearly metric cost for this framework
+     * @param {string} metricId UUID of the metric
+     * @param {number} year Year (1600-3000)
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
+        return MetricCostsPerYearApiFp(this.configuration).getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve a paginated list of all yearly metric costs for a specific framework.
+     * @summary List yearly metric costs for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {number} [offset] Number of records to skip
+     * @param {number} [limit] Max number of records to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
+        return MetricCostsPerYearApiFp(this.configuration).getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Update the perceived and/or direct cost of a metric for a specific year within this framework.
+     * @summary Partially update metric costs for this framework
+     * @param {string} metricId UUID of the metric
+     * @param {number} year Year (1600-3000)
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
+        return MetricCostsPerYearApiFp(this.configuration).patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
+}