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

package/dist/api/value-framework-api.d.ts

@@ -0,0 +1,723 @@
+/**
+ * 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';
+import type { ObjectiveWeightCreate } from '../models';
+import type { ObjectiveWeightResponse } from '../models';
+import type { ObjectiveWeightUpdate } from '../models';
+import type { ValueFrameworkCreate } from '../models';
+import type { ValueFrameworkResponse } from '../models';
+import type { ValueFrameworkUpdate } from '../models';
+/**
+ * ValueFrameworkApi - axios parameter creator
+ */
+export declare const ValueFrameworkApiAxiosParamCreator: (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>;
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework: (valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, 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>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all metric costs for a specific value framework.
+     * @summary List all metric costs for a value 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}
+     */
+    getCostsForValueFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of metric costs for a specific metric within a value framework.
+     * @summary List metric costs for a value framework filtered by metric
+     * @param {string} metricId UUID of the metric
+     * @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}
+     */
+    getCostsForValueFrameworkByMetric: (metricId: string, valueFrameworkId: string, offset?: number, limit?: number, 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>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights 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}
+     */
+    getObjectiveWeightsForFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific value framework.
+     * @summary List all objective weights for a value 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}
+     */
+    getWeightsForValueFramework: (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>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework: (valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework: (valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ValueFrameworkApi - functional programming interface
+ */
+export declare const ValueFrameworkApiFp: (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>>;
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    /**
+     * 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>>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a paginated list of all metric costs for a specific value framework.
+     * @summary List all metric costs for a value 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}
+     */
+    getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
+    /**
+     * Retrieve a paginated list of metric costs for a specific metric within a value framework.
+     * @summary List metric costs for a value framework filtered by metric
+     * @param {string} metricId UUID of the metric
+     * @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}
+     */
+    getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
+    /**
+     * 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>>>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights 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}
+     */
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ValueFrameworkResponse>>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific value framework.
+     * @summary List all objective weights for a value 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}
+     */
+    getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
+    /**
+     * 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>>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>>;
+};
+/**
+ * ValueFrameworkApi - factory interface
+ */
+export declare const ValueFrameworkApiFactory: (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>;
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
+    /**
+     * 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>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve a paginated list of all metric costs for a specific value framework.
+     * @summary List all metric costs for a value 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}
+     */
+    getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>>;
+    /**
+     * Retrieve a paginated list of metric costs for a specific metric within a value framework.
+     * @summary List metric costs for a value framework filtered by metric
+     * @param {string} metricId UUID of the metric
+     * @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}
+     */
+    getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>>;
+    /**
+     * 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>>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights 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}
+     */
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ValueFrameworkResponse>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific value framework.
+     * @summary List all objective weights for a value 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}
+     */
+    getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>>;
+    /**
+     * 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>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse>;
+};
+/**
+ * ValueFrameworkApi - object-oriented interface
+ */
+export declare class ValueFrameworkApi 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, {}>>;
+    /**
+     * Assign a weight to an objective within this framework.
+     * @summary Create an objective weight for this framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightCreate} objectiveWeightCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, 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, {}>>;
+    /**
+     * Remove an objective weight from this framework.
+     * @summary Delete an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * @summary Delete a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve a paginated list of all metric costs for a specific value framework.
+     * @summary List all metric costs for a value 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}
+     */
+    getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], any, {}>>;
+    /**
+     * Retrieve a paginated list of metric costs for a specific metric within a value framework.
+     * @summary List metric costs for a value framework filtered by metric
+     * @param {string} metricId UUID of the metric
+     * @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}
+     */
+    getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], 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, {}>>;
+    /**
+     * Retrieve the weight for a specific objective within this framework.
+     * @summary Get an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific framework.
+     * @summary List objective weights 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}
+     */
+    getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], any, {}>>;
+    /**
+     * Retrieve a single value framework by its ID.
+     * @summary Get a value framework by ID
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * @summary List value frameworks
+     * @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}
+     */
+    getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse[], any, {}>>;
+    /**
+     * Retrieve a paginated list of all objective weights for a specific value framework.
+     * @summary List all objective weights for a value 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}
+     */
+    getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], 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, {}>>;
+    /**
+     * Update the weight of an objective within this value framework.
+     * @summary Partially update an objective weight for this framework
+     * @param {string} objectiveId UUID of the objective
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * @summary Partially update a value framework
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {ValueFrameworkUpdate} valueFrameworkUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * @summary Create a value framework
+     * @param {ValueFrameworkCreate} valueFrameworkCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
+}