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

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

@@ -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).
@@ -18,41 +18,35 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import globalAxios from 'axios';
 // Some imports not used depending on template conditions
 // @ts-ignore
-import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
-import { MetricCostsPerYearCreate } from '../models';
+import type { MetricCostsPerYearCreate } from '../models';
 // @ts-ignore
-import { MetricCostsPerYearResponse } from '../models';
+import type { MetricCostsPerYearResponse } from '../models';
 // @ts-ignore
-import { MetricCostsPerYearUpdate } from '../models';
+import type { MetricCostsPerYearUpdate } from '../models';
 /**
  * MetricCostsPerYearApi - axios parameter creator
- * @export
  */
 export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?: 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: async (metricId: string, frameworkId: string, year: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // 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)
-            // verify required parameter 'year' is not null or undefined
-            assertParamExists('deleteMetricCost', 'year', year)
-            const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
-                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
-                .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
-                .replace(`{${"year"}}`, encodeURIComponent(String(year)));
+        createMetricCostForFramework: async (valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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;
@@ -60,7 +54,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -68,11 +62,13 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             // oauth required
             await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearCreate, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -80,25 +76,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
+         * 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: async (metricId: string, frameworkId: string, year: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        deleteMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // 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('deleteMetricCostForFramework', '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('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;
@@ -106,7 +102,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -115,7 +111,6 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
 
-    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -126,15 +121,25 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             };
         },
         /**
-         * 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: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/metric_costs_per_year/`;
+        getMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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;
@@ -150,16 +155,8 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             // oauth required
             await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -170,28 +167,19 @@ 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
-         * @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: async (metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // 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)
-            // verify required parameter 'year' is not null or undefined
-            assertParamExists('patchMetricCost', 'year', year)
-            // verify required parameter 'metricCostsPerYearUpdate' is not null or undefined
-            assertParamExists('patchMetricCost', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate)
-            const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
-                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
-                .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
-                .replace(`{${"year"}}`, encodeURIComponent(String(year)));
+        getMetricCostsForFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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;
@@ -199,7 +187,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -207,14 +195,19 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
 
-    
-            localVarHeaderParameter['Content-Type'] = 'application/json';
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearUpdate, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -222,16 +215,28 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             };
         },
         /**
-         * 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: async (metricCostsPerYearCreate: MetricCostsPerYearCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'metricCostsPerYearCreate' is not null or undefined
-            assertParamExists('postMetricCost', 'metricCostsPerYearCreate', metricCostsPerYearCreate)
-            const localVarPath = `/metric_costs_per_year/`;
+        patchMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // 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;
@@ -239,7 +244,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -247,14 +252,13 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
             // oauth required
             await 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 = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearCreate, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearUpdate, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -266,228 +270,224 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
 
 /**
  * MetricCostsPerYearApi - functional programming interface
- * @export
  */
 export const MetricCostsPerYearApiFp = function(configuration?: 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
+         * 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}
+         */
+        async createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetricCostsPerYearApi.createMetricCostForFramework']?.[localVarOperationServerIndex]?.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 {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}
          */
-        async deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetricCost(metricId, frameworkId, year, options);
-            const index = configuration?.serverIndex ?? 0;
-            const operationBasePath = operationServerMap['MetricCostsPerYearApi.deleteMetricCost']?.[index]?.url;
-            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        async deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetricCostsPerYearApi.deleteMetricCostForFramework']?.[localVarOperationServerIndex]?.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
+         * 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}
          */
-        async getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostByKeys(metricId, frameworkId, year, options);
-            const index = configuration?.serverIndex ?? 0;
-            const operationBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCostByKeys']?.[index]?.url;
-            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        async getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostForFramework(metricId, year, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCostForFramework']?.[localVarOperationServerIndex]?.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
+         * 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}
          */
-        async getMetricCosts(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCosts(offset, limit, options);
-            const index = configuration?.serverIndex ?? 0;
-            const operationBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCosts']?.[index]?.url;
-            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        async getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostsForFramework(valueFrameworkId, offset, limit, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCostsForFramework']?.[localVarOperationServerIndex]?.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
+         * 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}
          */
-        async patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options);
-            const index = configuration?.serverIndex ?? 0;
-            const operationBasePath = operationServerMap['MetricCostsPerYearApi.patchMetricCost']?.[index]?.url;
-            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || 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}
-         */
-        async postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.postMetricCost(metricCostsPerYearCreate, options);
-            const index = configuration?.serverIndex ?? 0;
-            const operationBasePath = operationServerMap['MetricCostsPerYearApi.postMetricCost']?.[index]?.url;
-            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        async patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetricCostsPerYearApi.patchMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     }
 };
 
 /**
  * MetricCostsPerYearApi - factory interface
- * @export
  */
 export const MetricCostsPerYearApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     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: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
+            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: string, frameworkId: string, year: number, options?: any): AxiosPromise<void> {
-            return localVarFp.deleteMetricCost(metricId, frameworkId, year, options).then((request) => request(axios, basePath));
+        deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            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: string, frameworkId: string, year: number, options?: any): AxiosPromise<MetricCostsPerYearResponse> {
-            return localVarFp.getMetricCostByKeys(metricId, frameworkId, year, options).then((request) => request(axios, basePath));
+        getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
+            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?: number, limit?: number, options?: any): AxiosPromise<Array<MetricCostsPerYearResponse>> {
-            return localVarFp.getMetricCosts(offset, limit, options).then((request) => request(axios, basePath));
+        getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
+            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: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: any): AxiosPromise<MetricCostsPerYearResponse> {
-            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: MetricCostsPerYearCreate, options?: any): AxiosPromise<MetricCostsPerYearResponse> {
-            return localVarFp.postMetricCost(metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
+        patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
+            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}
+     */
+    public createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) {
+        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
      */
-    public deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig) {
-        return MetricCostsPerYearApiFp(this.configuration).deleteMetricCost(metricId, frameworkId, year, options).then((request) => request(this.axios, this.basePath));
+    public deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        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
      */
-    public getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig) {
-        return MetricCostsPerYearApiFp(this.configuration).getMetricCostByKeys(metricId, frameworkId, year, options).then((request) => request(this.axios, this.basePath));
+    public getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        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
      */
-    public getMetricCosts(offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
-        return MetricCostsPerYearApiFp(this.configuration).getMetricCosts(offset, limit, options).then((request) => request(this.axios, this.basePath));
+    public getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
+        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
-     */
-    public patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) {
-        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
      */
-    public postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) {
-        return MetricCostsPerYearApiFp(this.configuration).postMetricCost(metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
+    public patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) {
+        return MetricCostsPerYearApiFp(this.configuration).patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
     }
 }