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

package/dist/api/metric-costs-api.js

@@ -0,0 +1,146 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricCostsApi = exports.MetricCostsApiFactory = exports.MetricCostsApiFp = exports.MetricCostsApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * MetricCostsApi - axios parameter creator
+ */
+const MetricCostsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+         * @summary List all metric costs for a metric
+         * @param {string} metricId UUID of the metric
+         * @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}
+         */
+        getCostsForMetric: (metricId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [metricId_1, offset_1, limit_1, ...args_1], void 0, function* (metricId, offset, limit, options = {}) {
+            // verify required parameter 'metricId' is not null or undefined
+            (0, common_1.assertParamExists)('getCostsForMetric', 'metricId', metricId);
+            const localVarPath = `/metric/{metric_id}/costs/`
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.MetricCostsApiAxiosParamCreator = MetricCostsApiAxiosParamCreator;
+/**
+ * MetricCostsApi - functional programming interface
+ */
+const MetricCostsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.MetricCostsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+         * @summary List all metric costs for a metric
+         * @param {string} metricId UUID of the metric
+         * @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}
+         */
+        getCostsForMetric(metricId, offset, limit, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getCostsForMetric(metricId, 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 = base_1.operationServerMap['MetricCostsApi.getCostsForMetric']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+exports.MetricCostsApiFp = MetricCostsApiFp;
+/**
+ * MetricCostsApi - factory interface
+ */
+const MetricCostsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.MetricCostsApiFp)(configuration);
+    return {
+        /**
+         * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+         * @summary List all metric costs for a metric
+         * @param {string} metricId UUID of the metric
+         * @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}
+         */
+        getCostsForMetric(metricId, offset, limit, options) {
+            return localVarFp.getCostsForMetric(metricId, offset, limit, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.MetricCostsApiFactory = MetricCostsApiFactory;
+/**
+ * MetricCostsApi - object-oriented interface
+ */
+class MetricCostsApi extends base_1.BaseAPI {
+    /**
+     * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
+     * @summary List all metric costs for a metric
+     * @param {string} metricId UUID of the metric
+     * @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}
+     */
+    getCostsForMetric(metricId, offset, limit, options) {
+        return (0, exports.MetricCostsApiFp)(this.configuration).getCostsForMetric(metricId, offset, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.MetricCostsApi = MetricCostsApi;

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

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