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

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

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