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

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

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,30 +28,67 @@ import { DUMMY_BASE_URL, assertParamExists, setOAuthToObject, setSearchParams, s
 import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
 /**
  * MetricCostsPerYearApi - axios parameter creator
- * @export
  */
 export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
-         * @summary Delete metric costs for a year
+         * 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 {string} frameworkId UUID of the value framework
          * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        deleteMetricCost: (metricId, frameworkId, year, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        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('deleteMetricCost', 'metricId', metricId);
-            // verify required parameter 'frameworkId' is not null or undefined
-            assertParamExists('deleteMetricCost', 'frameworkId', frameworkId);
+            assertParamExists('deleteMetricCostForFramework', 'metricId', metricId);
             // verify required parameter 'year' is not null or undefined
-            assertParamExists('deleteMetricCost', 'year', year);
-            const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
+            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(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
-                .replace(`{${"year"}}`, encodeURIComponent(String(year)));
+                .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;
@@ -73,25 +110,25 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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
+         * 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 {string} frameworkId UUID of the value framework
          * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getMetricCostByKeys: (metricId, frameworkId, year, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        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('getMetricCostByKeys', 'metricId', metricId);
-            // verify required parameter 'frameworkId' is not null or undefined
-            assertParamExists('getMetricCostByKeys', 'frameworkId', frameworkId);
+            assertParamExists('getMetricCostForFramework', 'metricId', metricId);
             // verify required parameter 'year' is not null or undefined
-            assertParamExists('getMetricCostByKeys', 'year', year);
-            const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
+            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(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
-                .replace(`{${"year"}}`, encodeURIComponent(String(year)));
+                .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;
@@ -104,6 +141,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
             // 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);
@@ -113,15 +151,19 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Retrieve a paginated list of all yearly metric cost overrides.
-         * @summary List yearly metric costs
+         * 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}
          */
-        getMetricCosts: (offset, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = `/metric_costs_per_year/`;
+        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;
@@ -140,6 +182,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
             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);
@@ -149,28 +192,28 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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
+         * 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 {string} frameworkId UUID of the value framework
          * @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}
          */
-        patchMetricCost: (metricId, frameworkId, year, metricCostsPerYearUpdate, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        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('patchMetricCost', 'metricId', metricId);
-            // verify required parameter 'frameworkId' is not null or undefined
-            assertParamExists('patchMetricCost', 'frameworkId', frameworkId);
+            assertParamExists('patchMetricCostForFramework', 'metricId', metricId);
             // verify required parameter 'year' is not null or undefined
-            assertParamExists('patchMetricCost', 'year', year);
+            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('patchMetricCost', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate);
-            const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
+            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(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
-                .replace(`{${"year"}}`, encodeURIComponent(String(year)));
+                .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;
@@ -184,6 +227,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
             // 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);
@@ -193,273 +237,236 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
-        /**
-         * 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'metricCostsPerYearCreate' is not null or undefined
-            assertParamExists('postMetricCost', 'metricCostsPerYearCreate', metricCostsPerYearCreate);
-            const localVarPath = `/metric_costs_per_year/`;
-            // 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';
-            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,
-            };
-        }),
     };
 };
 /**
  * MetricCostsPerYearApi - functional programming interface
- * @export
  */
 export const MetricCostsPerYearApiFp = function (configuration) {
     const localVarAxiosParamCreator = MetricCostsPerYearApiAxiosParamCreator(configuration);
     return {
         /**
-         * 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)
+         * 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}
          */
-        deleteMetricCost(metricId, frameworkId, year, options) {
-            var _a, _b, _c;
+        createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteMetricCost(metricId, frameworkId, year, options);
-                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const operationBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.deleteMetricCost']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
-                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+                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);
             });
         },
         /**
-         * 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
+         * 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 {string} frameworkId UUID of the value framework
          * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getMetricCostByKeys(metricId, frameworkId, year, options) {
-            var _a, _b, _c;
+        deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricCostByKeys(metricId, frameworkId, year, options);
-                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const operationBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.getMetricCostByKeys']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
-                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+                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 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
+         * 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}
          */
-        getMetricCosts(offset, limit, options) {
-            var _a, _b, _c;
+        getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricCosts(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 = operationServerMap['MetricCostsPerYearApi.getMetricCosts']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
-                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+                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);
             });
         },
         /**
-         * 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
+         * 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}
          */
-        patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options) {
-            var _a, _b, _c;
+        getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options);
-                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const operationBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.patchMetricCost']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
-                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+                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);
             });
         },
         /**
-         * 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
+         * 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}
          */
-        postMetricCost(metricCostsPerYearCreate, options) {
-            var _a, _b, _c;
+        patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.postMetricCost(metricCostsPerYearCreate, options);
-                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const operationBasePath = (_c = (_b = operationServerMap['MetricCostsPerYearApi.postMetricCost']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
-                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+                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
  */
 export const MetricCostsPerYearApiFactory = function (configuration, basePath, axios) {
     const localVarFp = MetricCostsPerYearApiFp(configuration);
     return {
         /**
-         * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
-         * @summary Delete metric costs for a year
+         * 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 {string} frameworkId UUID of the value framework
          * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        deleteMetricCost(metricId, frameworkId, year, options) {
-            return localVarFp.deleteMetricCost(metricId, frameworkId, year, options).then((request) => request(axios, basePath));
+        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 a framework for a given year.
-         * @summary Get a yearly metric cost by metric, framework, and year
+         * 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 {string} frameworkId UUID of the value framework
          * @param {number} year Year (1600-3000)
+         * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getMetricCostByKeys(metricId, frameworkId, year, options) {
-            return localVarFp.getMetricCostByKeys(metricId, frameworkId, year, options).then((request) => request(axios, basePath));
+        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 cost overrides.
-         * @summary List yearly metric costs
+         * 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}
          */
-        getMetricCosts(offset, limit, options) {
-            return localVarFp.getMetricCosts(offset, limit, options).then((request) => request(axios, basePath));
+        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 and framework. Identified by the composite key (metric_id, framework_id, year).
-         * @summary Partially update metric costs for a year
+         * 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 {string} frameworkId UUID of the value framework
          * @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}
          */
-        patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options) {
-            return localVarFp.patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
-        },
-        /**
-         * 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, options) {
-            return localVarFp.postMetricCost(metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
+        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}
  */
 export 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
+     * 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 {string} frameworkId UUID of the value framework
      * @param {number} year Year (1600-3000)
+     * @param {string} valueFrameworkId UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof MetricCostsPerYearApi
      */
-    deleteMetricCost(metricId, frameworkId, year, options) {
-        return MetricCostsPerYearApiFp(this.configuration).deleteMetricCost(metricId, frameworkId, year, options).then((request) => request(this.axios, this.basePath));
+    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 a framework for a given year.
-     * @summary Get a yearly metric cost by metric, framework, and year
+     * 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 {string} frameworkId UUID of the value framework
      * @param {number} year Year (1600-3000)
+     * @param {string} valueFrameworkId UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof MetricCostsPerYearApi
      */
-    getMetricCostByKeys(metricId, frameworkId, year, options) {
-        return MetricCostsPerYearApiFp(this.configuration).getMetricCostByKeys(metricId, frameworkId, year, options).then((request) => request(this.axios, this.basePath));
+    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 cost overrides.
-     * @summary List yearly metric costs
+     * 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}
-     * @memberof MetricCostsPerYearApi
      */
-    getMetricCosts(offset, limit, options) {
-        return MetricCostsPerYearApiFp(this.configuration).getMetricCosts(offset, limit, options).then((request) => request(this.axios, this.basePath));
+    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 and framework. Identified by the composite key (metric_id, framework_id, year).
-     * @summary Partially update metric costs for a year
+     * 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 {string} frameworkId UUID of the value framework
      * @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}
-     * @memberof MetricCostsPerYearApi
-     */
-    patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options) {
-        return MetricCostsPerYearApiFp(this.configuration).patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
-    }
-    /**
-     * 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, options) {
-        return MetricCostsPerYearApiFp(this.configuration).postMetricCost(metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
+    patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
+        return MetricCostsPerYearApiFp(this.configuration).patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
     }
 }