@cosmotech/aip-client 0.0.1-rc1

package/README.md

@@ -0,0 +1,45 @@
+## @cosmotech/aip-client@0.0.1-rc1
+
+This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @cosmotech/aip-client@0.0.1-rc1 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@cosmotech/aip-client",
+  "version": "0.0.1-rc1",
+  "description": "OpenAPI client for @cosmotech/aip-client",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "bugs": {
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"
+  },
+  "homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID#readme",
+  "license": "ISC"
+}

package/src/apis/DefaultApi.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+
+/**
+ * 
+ */
+export class DefaultApi extends runtime.BaseAPI {
+
+    /**
+     * Root
+     */
+    async rootAboutGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/about`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<any>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Root
+     */
+    async rootAboutGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any> {
+        const response = await this.rootAboutGetRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/MetricApi.ts

@@ -0,0 +1,256 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  MetricCreate,
+  MetricResponse,
+  MetricUpdate,
+} from '../models/index';
+import {
+    MetricCreateFromJSON,
+    MetricCreateToJSON,
+    MetricResponseFromJSON,
+    MetricResponseToJSON,
+    MetricUpdateFromJSON,
+    MetricUpdateToJSON,
+} from '../models/index';
+
+export interface DeleteMetricMetricMetricIdDeleteRequest {
+    metricId: string;
+}
+
+export interface GetMetricByIdMetricMetricIdGetRequest {
+    metricId: string;
+}
+
+export interface GetMetricsMetricGetRequest {
+    offset?: number;
+    limit?: number;
+}
+
+export interface PatchMetricMetricMetricIdPatchRequest {
+    metricId: string;
+    metricUpdate: MetricUpdate;
+}
+
+export interface PostMetricMetricPostRequest {
+    metricCreate: MetricCreate;
+}
+
+/**
+ * 
+ */
+export class MetricApi extends runtime.BaseAPI {
+
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * Delete a metric
+     */
+    async deleteMetricMetricMetricIdDeleteRaw(requestParameters: DeleteMetricMetricMetricIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.metricId === null || requestParameters.metricId === undefined) {
+            throw new runtime.RequiredError('metricId','Required parameter requestParameters.metricId was null or undefined when calling deleteMetricMetricMetricIdDelete.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric/{metric_id}`.replace(`{${"metric_id"}}`, encodeURIComponent(String(requestParameters.metricId))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
+     * Delete a metric
+     */
+    async deleteMetricMetricMetricIdDelete(requestParameters: DeleteMetricMetricMetricIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteMetricMetricMetricIdDeleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieve a single metric by its ID.
+     * Get a metric by ID
+     */
+    async getMetricByIdMetricMetricIdGetRaw(requestParameters: GetMetricByIdMetricMetricIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricResponse>> {
+        if (requestParameters.metricId === null || requestParameters.metricId === undefined) {
+            throw new runtime.RequiredError('metricId','Required parameter requestParameters.metricId was null or undefined when calling getMetricByIdMetricMetricIdGet.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric/{metric_id}`.replace(`{${"metric_id"}}`, encodeURIComponent(String(requestParameters.metricId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MetricResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a single metric by its ID.
+     * Get a metric by ID
+     */
+    async getMetricByIdMetricMetricIdGet(requestParameters: GetMetricByIdMetricMetricIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricResponse> {
+        const response = await this.getMetricByIdMetricMetricIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a paginated list of all metrics.
+     * List metrics
+     */
+    async getMetricsMetricGetRaw(requestParameters: GetMetricsMetricGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<MetricResponse>>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(MetricResponseFromJSON));
+    }
+
+    /**
+     * Retrieve a paginated list of all metrics.
+     * List metrics
+     */
+    async getMetricsMetricGet(requestParameters: GetMetricsMetricGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricResponse>> {
+        const response = await this.getMetricsMetricGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * Partially update a metric
+     */
+    async patchMetricMetricMetricIdPatchRaw(requestParameters: PatchMetricMetricMetricIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricResponse>> {
+        if (requestParameters.metricId === null || requestParameters.metricId === undefined) {
+            throw new runtime.RequiredError('metricId','Required parameter requestParameters.metricId was null or undefined when calling patchMetricMetricMetricIdPatch.');
+        }
+
+        if (requestParameters.metricUpdate === null || requestParameters.metricUpdate === undefined) {
+            throw new runtime.RequiredError('metricUpdate','Required parameter requestParameters.metricUpdate was null or undefined when calling patchMetricMetricMetricIdPatch.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric/{metric_id}`.replace(`{${"metric_id"}}`, encodeURIComponent(String(requestParameters.metricId))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MetricUpdateToJSON(requestParameters.metricUpdate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MetricResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * Partially update a metric
+     */
+    async patchMetricMetricMetricIdPatch(requestParameters: PatchMetricMetricMetricIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricResponse> {
+        const response = await this.patchMetricMetricMetricIdPatchRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * Create a metric
+     */
+    async postMetricMetricPostRaw(requestParameters: PostMetricMetricPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricResponse>> {
+        if (requestParameters.metricCreate === null || requestParameters.metricCreate === undefined) {
+            throw new runtime.RequiredError('metricCreate','Required parameter requestParameters.metricCreate was null or undefined when calling postMetricMetricPost.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MetricCreateToJSON(requestParameters.metricCreate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MetricResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new metric linked to an objective. Requires metric_type (monetized/tracked/bounded) and measurement_type (maximization/minimization).
+     * Create a metric
+     */
+    async postMetricMetricPost(requestParameters: PostMetricMetricPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricResponse> {
+        const response = await this.postMetricMetricPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/MetricCostsPerYearApi.ts

@@ -0,0 +1,286 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  MetricCostsPerYearCreate,
+  MetricCostsPerYearResponse,
+  MetricCostsPerYearUpdate,
+} from '../models/index';
+import {
+    MetricCostsPerYearCreateFromJSON,
+    MetricCostsPerYearCreateToJSON,
+    MetricCostsPerYearResponseFromJSON,
+    MetricCostsPerYearResponseToJSON,
+    MetricCostsPerYearUpdateFromJSON,
+    MetricCostsPerYearUpdateToJSON,
+} from '../models/index';
+
+export interface DeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest {
+    metricId: string;
+    frameworkId: string;
+    year: number;
+}
+
+export interface GetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest {
+    metricId: string;
+    frameworkId: string;
+    year: number;
+}
+
+export interface GetMetricCostsMetricCostsPerYearGetRequest {
+    offset?: number;
+    limit?: number;
+}
+
+export interface PatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest {
+    metricId: string;
+    frameworkId: string;
+    year: number;
+    metricCostsPerYearUpdate: MetricCostsPerYearUpdate;
+}
+
+export interface PostMetricCostMetricCostsPerYearPostRequest {
+    metricCostsPerYearCreate: MetricCostsPerYearCreate;
+}
+
+/**
+ * 
+ */
+export class MetricCostsPerYearApi extends runtime.BaseAPI {
+
+    /**
+     * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
+     * Delete metric costs for a year
+     */
+    async deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRaw(requestParameters: DeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.metricId === null || requestParameters.metricId === undefined) {
+            throw new runtime.RequiredError('metricId','Required parameter requestParameters.metricId was null or undefined when calling deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete.');
+        }
+
+        if (requestParameters.frameworkId === null || requestParameters.frameworkId === undefined) {
+            throw new runtime.RequiredError('frameworkId','Required parameter requestParameters.frameworkId was null or undefined when calling deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete.');
+        }
+
+        if (requestParameters.year === null || requestParameters.year === undefined) {
+            throw new runtime.RequiredError('year','Required parameter requestParameters.year was null or undefined when calling deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`.replace(`{${"metric_id"}}`, encodeURIComponent(String(requestParameters.metricId))).replace(`{${"framework_id"}}`, encodeURIComponent(String(requestParameters.frameworkId))).replace(`{${"year"}}`, encodeURIComponent(String(requestParameters.year))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
+     * Delete metric costs for a year
+     */
+    async deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(requestParameters: DeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieve cost data for a specific metric within a framework for a given year.
+     * Get a yearly metric cost by metric, framework, and year
+     */
+    async getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRaw(requestParameters: GetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricCostsPerYearResponse>> {
+        if (requestParameters.metricId === null || requestParameters.metricId === undefined) {
+            throw new runtime.RequiredError('metricId','Required parameter requestParameters.metricId was null or undefined when calling getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet.');
+        }
+
+        if (requestParameters.frameworkId === null || requestParameters.frameworkId === undefined) {
+            throw new runtime.RequiredError('frameworkId','Required parameter requestParameters.frameworkId was null or undefined when calling getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet.');
+        }
+
+        if (requestParameters.year === null || requestParameters.year === undefined) {
+            throw new runtime.RequiredError('year','Required parameter requestParameters.year was null or undefined when calling getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`.replace(`{${"metric_id"}}`, encodeURIComponent(String(requestParameters.metricId))).replace(`{${"framework_id"}}`, encodeURIComponent(String(requestParameters.frameworkId))).replace(`{${"year"}}`, encodeURIComponent(String(requestParameters.year))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MetricCostsPerYearResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve cost data for a specific metric within a framework for a given year.
+     * Get a yearly metric cost by metric, framework, and year
+     */
+    async getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(requestParameters: GetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricCostsPerYearResponse> {
+        const response = await this.getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a paginated list of all yearly metric cost overrides.
+     * List yearly metric costs
+     */
+    async getMetricCostsMetricCostsPerYearGetRaw(requestParameters: GetMetricCostsMetricCostsPerYearGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<MetricCostsPerYearResponse>>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric_costs_per_year/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(MetricCostsPerYearResponseFromJSON));
+    }
+
+    /**
+     * Retrieve a paginated list of all yearly metric cost overrides.
+     * List yearly metric costs
+     */
+    async getMetricCostsMetricCostsPerYearGet(requestParameters: GetMetricCostsMetricCostsPerYearGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<MetricCostsPerYearResponse>> {
+        const response = await this.getMetricCostsMetricCostsPerYearGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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).
+     * Partially update metric costs for a year
+     */
+    async patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRaw(requestParameters: PatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricCostsPerYearResponse>> {
+        if (requestParameters.metricId === null || requestParameters.metricId === undefined) {
+            throw new runtime.RequiredError('metricId','Required parameter requestParameters.metricId was null or undefined when calling patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch.');
+        }
+
+        if (requestParameters.frameworkId === null || requestParameters.frameworkId === undefined) {
+            throw new runtime.RequiredError('frameworkId','Required parameter requestParameters.frameworkId was null or undefined when calling patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch.');
+        }
+
+        if (requestParameters.year === null || requestParameters.year === undefined) {
+            throw new runtime.RequiredError('year','Required parameter requestParameters.year was null or undefined when calling patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch.');
+        }
+
+        if (requestParameters.metricCostsPerYearUpdate === null || requestParameters.metricCostsPerYearUpdate === undefined) {
+            throw new runtime.RequiredError('metricCostsPerYearUpdate','Required parameter requestParameters.metricCostsPerYearUpdate was null or undefined when calling patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`.replace(`{${"metric_id"}}`, encodeURIComponent(String(requestParameters.metricId))).replace(`{${"framework_id"}}`, encodeURIComponent(String(requestParameters.frameworkId))).replace(`{${"year"}}`, encodeURIComponent(String(requestParameters.year))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MetricCostsPerYearUpdateToJSON(requestParameters.metricCostsPerYearUpdate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MetricCostsPerYearResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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).
+     * Partially update metric costs for a year
+     */
+    async patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(requestParameters: PatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricCostsPerYearResponse> {
+        const response = await this.patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
+     * Create a yearly metric cost
+     */
+    async postMetricCostMetricCostsPerYearPostRaw(requestParameters: PostMetricCostMetricCostsPerYearPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MetricCostsPerYearResponse>> {
+        if (requestParameters.metricCostsPerYearCreate === null || requestParameters.metricCostsPerYearCreate === undefined) {
+            throw new runtime.RequiredError('metricCostsPerYearCreate','Required parameter requestParameters.metricCostsPerYearCreate was null or undefined when calling postMetricCostMetricCostsPerYearPost.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/metric_costs_per_year/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: MetricCostsPerYearCreateToJSON(requestParameters.metricCostsPerYearCreate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MetricCostsPerYearResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
+     * Create a yearly metric cost
+     */
+    async postMetricCostMetricCostsPerYearPost(requestParameters: PostMetricCostMetricCostsPerYearPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricCostsPerYearResponse> {
+        const response = await this.postMetricCostMetricCostsPerYearPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}