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

package/dist/api/metric-api.js

@@ -0,0 +1,430 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * 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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricApi = exports.MetricApiFactory = exports.MetricApiFp = exports.MetricApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * MetricApi - axios parameter creator
+ * @export
+ */
+const MetricApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+         * @summary Delete a metric
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteMetric: (metricId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'metricId' is not null or undefined
+            (0, common_1.assertParamExists)('deleteMetric', 'metricId', metricId);
+            const localVarPath = `/metric/{metric_id}`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Retrieve a single metric by its ID.
+         * @summary Get a metric by ID
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricById: (metricId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'metricId' is not null or undefined
+            (0, common_1.assertParamExists)('getMetricById', 'metricId', metricId);
+            const localVarPath = `/metric/{metric_id}`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Retrieve a paginated list of all metrics.
+         * @summary List metrics
+         * @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}
+         */
+        getMetrics: (offset, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/metric/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+         * @summary Partially update a metric
+         * @param {string} metricId UUID of the metric
+         * @param {MetricUpdate} metricUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchMetric: (metricId, metricUpdate, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'metricId' is not null or undefined
+            (0, common_1.assertParamExists)('patchMetric', 'metricId', metricId);
+            // verify required parameter 'metricUpdate' is not null or undefined
+            (0, common_1.assertParamExists)('patchMetric', 'metricUpdate', metricUpdate);
+            const localVarPath = `/metric/{metric_id}`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricUpdate, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+         * @summary Create a metric
+         * @param {MetricCreate} metricCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postMetric: (metricCreate, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'metricCreate' is not null or undefined
+            (0, common_1.assertParamExists)('postMetric', 'metricCreate', metricCreate);
+            const localVarPath = `/metric/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricCreate, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.MetricApiAxiosParamCreator = MetricApiAxiosParamCreator;
+/**
+ * MetricApi - functional programming interface
+ * @export
+ */
+const MetricApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.MetricApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+         * @summary Delete a metric
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteMetric(metricId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteMetric(metricId, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.deleteMetric']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Retrieve a single metric by its ID.
+         * @summary Get a metric by ID
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricById(metricId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricById(metricId, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.getMetricById']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Retrieve a paginated list of all metrics.
+         * @summary List metrics
+         * @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}
+         */
+        getMetrics(offset, limit, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetrics(offset, limit, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.getMetrics']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+         * @summary Partially update a metric
+         * @param {string} metricId UUID of the metric
+         * @param {MetricUpdate} metricUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchMetric(metricId, metricUpdate, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.patchMetric(metricId, metricUpdate, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.patchMetric']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+        /**
+         * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+         * @summary Create a metric
+         * @param {MetricCreate} metricCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postMetric(metricCreate, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.postMetric(metricCreate, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.postMetric']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
+    };
+};
+exports.MetricApiFp = MetricApiFp;
+/**
+ * MetricApi - factory interface
+ * @export
+ */
+const MetricApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.MetricApiFp)(configuration);
+    return {
+        /**
+         * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+         * @summary Delete a metric
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteMetric(metricId, options) {
+            return localVarFp.deleteMetric(metricId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve a single metric by its ID.
+         * @summary Get a metric by ID
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMetricById(metricId, options) {
+            return localVarFp.getMetricById(metricId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve a paginated list of all metrics.
+         * @summary List metrics
+         * @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}
+         */
+        getMetrics(offset, limit, options) {
+            return localVarFp.getMetrics(offset, limit, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+         * @summary Partially update a metric
+         * @param {string} metricId UUID of the metric
+         * @param {MetricUpdate} metricUpdate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchMetric(metricId, metricUpdate, options) {
+            return localVarFp.patchMetric(metricId, metricUpdate, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+         * @summary Create a metric
+         * @param {MetricCreate} metricCreate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postMetric(metricCreate, options) {
+            return localVarFp.postMetric(metricCreate, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.MetricApiFactory = MetricApiFactory;
+/**
+ * MetricApi - object-oriented interface
+ * @export
+ * @class MetricApi
+ * @extends {BaseAPI}
+ */
+class MetricApi extends base_1.BaseAPI {
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * @summary Delete a metric
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    deleteMetric(metricId, options) {
+        return (0, exports.MetricApiFp)(this.configuration).deleteMetric(metricId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve a single metric by its ID.
+     * @summary Get a metric by ID
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    getMetricById(metricId, options) {
+        return (0, exports.MetricApiFp)(this.configuration).getMetricById(metricId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve a paginated list of all metrics.
+     * @summary List metrics
+     * @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}
+     * @memberof MetricApi
+     */
+    getMetrics(offset, limit, options) {
+        return (0, exports.MetricApiFp)(this.configuration).getMetrics(offset, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a metric
+     * @param {string} metricId UUID of the metric
+     * @param {MetricUpdate} metricUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    patchMetric(metricId, metricUpdate, options) {
+        return (0, exports.MetricApiFp)(this.configuration).patchMetric(metricId, metricUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * @summary Create a metric
+     * @param {MetricCreate} metricCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricApi
+     */
+    postMetric(metricCreate, options) {
+        return (0, exports.MetricApiFp)(this.configuration).postMetric(metricCreate, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.MetricApi = MetricApi;

package/dist/api/metric-costs-per-year-api.d.ts

@@ -0,0 +1,240 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { MetricCostsPerYearCreate } from '../models';
+import { MetricCostsPerYearResponse } from '../models';
+import { MetricCostsPerYearUpdate } from '../models';
+/**
+ * MetricCostsPerYearApi - axios parameter creator
+ * @export
+ */
+export declare const MetricCostsPerYearApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
+     * @summary Delete metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetricCost: (metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve cost data for a specific metric within a framework for a given year.
+     * @summary Get a yearly metric cost by metric, framework, and year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricCostByKeys: (metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all yearly metric cost overrides.
+     * @summary List yearly metric costs
+     * @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}
+     */
+    getMetricCosts: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update the perceived and/or direct cost of a metric for a specific year and framework. Identified by the composite key (metric_id, framework_id, year).
+     * @summary Partially update metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetricCost: (metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
+     * @summary Create a yearly metric cost
+     * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postMetricCost: (metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetricCostsPerYearApi - functional programming interface
+ * @export
+ */
+export declare const MetricCostsPerYearApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
+     * @summary Delete metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve cost data for a specific metric within a framework for a given year.
+     * @summary Get a yearly metric cost by metric, framework, and year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>>;
+    /**
+     * Retrieve a paginated list of all yearly metric cost overrides.
+     * @summary List yearly metric costs
+     * @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}
+     */
+    getMetricCosts(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
+    /**
+     * Update the perceived and/or direct cost of a metric for a specific year and framework. Identified by the composite key (metric_id, framework_id, year).
+     * @summary Partially update metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>>;
+    /**
+     * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
+     * @summary Create a yearly metric cost
+     * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>>;
+};
+/**
+ * MetricCostsPerYearApi - factory interface
+ * @export
+ */
+export declare const MetricCostsPerYearApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
+     * @summary Delete metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieve cost data for a specific metric within a framework for a given year.
+     * @summary Get a yearly metric cost by metric, framework, and year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: any): AxiosPromise<MetricCostsPerYearResponse>;
+    /**
+     * Retrieve a paginated list of all yearly metric cost overrides.
+     * @summary List yearly metric costs
+     * @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}
+     */
+    getMetricCosts(offset?: number, limit?: number, options?: any): AxiosPromise<Array<MetricCostsPerYearResponse>>;
+    /**
+     * Update the perceived and/or direct cost of a metric for a specific year and framework. Identified by the composite key (metric_id, framework_id, year).
+     * @summary Partially update metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: any): AxiosPromise<MetricCostsPerYearResponse>;
+    /**
+     * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
+     * @summary Create a yearly metric cost
+     * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: any): AxiosPromise<MetricCostsPerYearResponse>;
+};
+/**
+ * MetricCostsPerYearApi - object-oriented interface
+ * @export
+ * @class MetricCostsPerYearApi
+ * @extends {BaseAPI}
+ */
+export declare class MetricCostsPerYearApi extends BaseAPI {
+    /**
+     * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
+     * @summary Delete metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricCostsPerYearApi
+     */
+    deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve cost data for a specific metric within a framework for a given year.
+     * @summary Get a yearly metric cost by metric, framework, and year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricCostsPerYearApi
+     */
+    getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all yearly metric cost overrides.
+     * @summary List yearly metric costs
+     * @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}
+     * @memberof MetricCostsPerYearApi
+     */
+    getMetricCosts(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], any, {}>>;
+    /**
+     * Update the perceived and/or direct cost of a metric for a specific year and framework. Identified by the composite key (metric_id, framework_id, year).
+     * @summary Partially update metric costs for a year
+     * @param {string} metricId UUID of the metric
+     * @param {string} frameworkId UUID of the value framework
+     * @param {number} year Year (1600-3000)
+     * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricCostsPerYearApi
+     */
+    patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse, any, {}>>;
+    /**
+     * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
+     * @summary Create a yearly metric cost
+     * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricCostsPerYearApi
+     */
+    postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse, any, {}>>;
+}