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

package/docs/ValueFrameworkApi.md

@@ -0,0 +1,1053 @@
+# ValueFrameworkApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createMetricCostForFramework**](#createmetriccostforframework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework|
+|[**createObjectiveWeightForFramework**](#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework|
+|[**deleteMetricCostForFramework**](#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework|
+|[**deleteObjectiveWeightForFramework**](#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework|
+|[**deleteValueFramework**](#deletevalueframework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework|
+|[**getCostsForValueFramework**](#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework|
+|[**getCostsForValueFrameworkByMetric**](#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric|
+|[**getMetricCostForFramework**](#getmetriccostforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework|
+|[**getMetricCostsForFramework**](#getmetriccostsforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework|
+|[**getObjectiveWeightForFramework**](#getobjectiveweightforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework|
+|[**getObjectiveWeightsForFramework**](#getobjectiveweightsforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework|
+|[**getValueFrameworkById**](#getvalueframeworkbyid) | **GET** /value_framework/{value_framework_id} | Get a value framework by ID|
+|[**getValueFrameworks**](#getvalueframeworks) | **GET** /value_framework/ | List value frameworks|
+|[**getWeightsForValueFramework**](#getweightsforvalueframework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework|
+|[**patchMetricCostForFramework**](#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework|
+|[**patchObjectiveWeightForFramework**](#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework|
+|[**patchValueFramework**](#patchvalueframework) | **PATCH** /value_framework/{value_framework_id} | Partially update a value framework|
+|[**postValueFramework**](#postvalueframework) | **POST** /value_framework/ | Create a value framework|
+
+# **createMetricCostForFramework**
+> MetricCostsPerYearResponse createMetricCostForFramework(metricCostsPerYearCreate)
+
+Create a yearly cost override for a metric within this framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration,
+    MetricCostsPerYearCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let metricCostsPerYearCreate: MetricCostsPerYearCreate; //
+
+const { status, data } = await apiInstance.createMetricCostForFramework(
+    valueFrameworkId,
+    metricCostsPerYearCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **metricCostsPerYearCreate** | **MetricCostsPerYearCreate**|  | |
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**MetricCostsPerYearResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Yearly metric cost created successfully |  -  |
+|**400** | Invalid input, referenced metric not found, or year out of range |  -  |
+|**404** | Value framework not found |  -  |
+|**409** | Cost entry already exists for this metric/framework/year |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **createObjectiveWeightForFramework**
+> ObjectiveWeightResponse createObjectiveWeightForFramework(objectiveWeightCreate)
+
+Assign a weight to an objective within this framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration,
+    ObjectiveWeightCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let objectiveWeightCreate: ObjectiveWeightCreate; //
+
+const { status, data } = await apiInstance.createObjectiveWeightForFramework(
+    valueFrameworkId,
+    objectiveWeightCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveWeightCreate** | **ObjectiveWeightCreate**|  | |
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**ObjectiveWeightResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Objective weight created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+|**404** | Value framework not found |  -  |
+|**409** | Weight already exists for this framework/objective pair |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteMetricCostForFramework**
+> deleteMetricCostForFramework()
+
+Delete a metric cost entry for a specific year within this framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let metricId: string; //UUID of the metric (default to undefined)
+let year: number; //Year (1600-3000) (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.deleteMetricCostForFramework(
+    metricId,
+    year,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
+| **year** | [**number**] | Year (1600-3000) | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Metric cost successfully deleted |  -  |
+|**404** | Value framework or metric cost not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteObjectiveWeightForFramework**
+> deleteObjectiveWeightForFramework()
+
+Remove an objective weight from this framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let objectiveId: string; //UUID of the objective (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.deleteObjectiveWeightForFramework(
+    objectiveId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Objective weight successfully deleted |  -  |
+|**404** | Value framework or objective weight not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteValueFramework**
+> deleteValueFramework()
+
+Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.deleteValueFramework(
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Value framework successfully deleted |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCostsForValueFramework**
+> Array<MetricCostsPerYearResponse> getCostsForValueFramework()
+
+Retrieve a paginated list of all metric costs for a specific value framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getCostsForValueFramework(
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<MetricCostsPerYearResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of metric cost entries for the framework |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCostsForValueFrameworkByMetric**
+> Array<MetricCostsPerYearResponse> getCostsForValueFrameworkByMetric()
+
+Retrieve a paginated list of metric costs for a specific metric within a value framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let metricId: string; //UUID of the metric (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getCostsForValueFrameworkByMetric(
+    metricId,
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<MetricCostsPerYearResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of metric cost entries for the framework and metric |  -  |
+|**404** | Value framework or metric not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getMetricCostForFramework**
+> MetricCostsPerYearResponse getMetricCostForFramework()
+
+Retrieve cost data for a specific metric within this framework for a given year.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let metricId: string; //UUID of the metric (default to undefined)
+let year: number; //Year (1600-3000) (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getMetricCostForFramework(
+    metricId,
+    year,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
+| **year** | [**number**] | Year (1600-3000) | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**MetricCostsPerYearResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The requested yearly metric cost |  -  |
+|**404** | Value framework or cost entry not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getMetricCostsForFramework**
+> Array<MetricCostsPerYearResponse> getMetricCostsForFramework()
+
+Retrieve a paginated list of all yearly metric costs for a specific framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getMetricCostsForFramework(
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<MetricCostsPerYearResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of yearly metric cost entries for the framework |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getObjectiveWeightForFramework**
+> ObjectiveWeightResponse getObjectiveWeightForFramework()
+
+Retrieve the weight for a specific objective within this framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let objectiveId: string; //UUID of the objective (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getObjectiveWeightForFramework(
+    objectiveId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**ObjectiveWeightResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The requested objective weight |  -  |
+|**404** | Value framework or objective weight not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getObjectiveWeightsForFramework**
+> Array<ObjectiveWeightResponse> getObjectiveWeightsForFramework()
+
+Retrieve a paginated list of all objective weights for a specific framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getObjectiveWeightsForFramework(
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<ObjectiveWeightResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of objective weights for the framework |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getValueFrameworkById**
+> ValueFrameworkResponse getValueFrameworkById()
+
+Retrieve a single value framework by its ID.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getValueFrameworkById(
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**ValueFrameworkResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The requested value framework |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getValueFrameworks**
+> Array<ValueFrameworkResponse> getValueFrameworks()
+
+Retrieve a paginated list of all value frameworks.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getValueFrameworks(
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<ValueFrameworkResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of value frameworks |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getWeightsForValueFramework**
+> Array<ObjectiveWeightResponse> getWeightsForValueFramework()
+
+Retrieve a paginated list of all objective weights for a specific value framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getWeightsForValueFramework(
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<ObjectiveWeightResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of objective weights for the framework |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchMetricCostForFramework**
+> MetricCostsPerYearResponse patchMetricCostForFramework(metricCostsPerYearUpdate)
+
+Update the perceived and/or direct cost of a metric for a specific year within this framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration,
+    MetricCostsPerYearUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let metricId: string; //UUID of the metric (default to undefined)
+let year: number; //Year (1600-3000) (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let metricCostsPerYearUpdate: MetricCostsPerYearUpdate; //
+
+const { status, data } = await apiInstance.patchMetricCostForFramework(
+    metricId,
+    year,
+    valueFrameworkId,
+    metricCostsPerYearUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **metricCostsPerYearUpdate** | **MetricCostsPerYearUpdate**|  | |
+| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
+| **year** | [**number**] | Year (1600-3000) | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**MetricCostsPerYearResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Metric cost updated successfully |  -  |
+|**400** | Validation or constraint error (e.g. negative cost) |  -  |
+|**404** | Value framework or metric cost not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchObjectiveWeightForFramework**
+> ObjectiveWeightResponse patchObjectiveWeightForFramework(objectiveWeightUpdate)
+
+Update the weight of an objective within this value framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration,
+    ObjectiveWeightUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let objectiveId: string; //UUID of the objective (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let objectiveWeightUpdate: ObjectiveWeightUpdate; //
+
+const { status, data } = await apiInstance.patchObjectiveWeightForFramework(
+    objectiveId,
+    valueFrameworkId,
+    objectiveWeightUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveWeightUpdate** | **ObjectiveWeightUpdate**|  | |
+| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**ObjectiveWeightResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Objective weight updated successfully |  -  |
+|**400** | Validation or constraint error (e.g. negative weight) |  -  |
+|**404** | Value framework or objective weight not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchValueFramework**
+> ValueFrameworkResponse patchValueFramework(valueFrameworkUpdate)
+
+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.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration,
+    ValueFrameworkUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkUpdate: ValueFrameworkUpdate; //
+
+const { status, data } = await apiInstance.patchValueFramework(
+    valueFrameworkId,
+    valueFrameworkUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkUpdate** | **ValueFrameworkUpdate**|  | |
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**ValueFrameworkResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Value framework updated successfully |  -  |
+|**400** | Validation or constraint error (e.g. empty name) |  -  |
+|**404** | Value framework not found |  -  |
+|**409** | Unique constraint violation (e.g. duplicate name) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postValueFramework**
+> ValueFrameworkResponse postValueFramework(valueFrameworkCreate)
+
+Create a new value framework. Name must be unique and non-empty.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkApi,
+    Configuration,
+    ValueFrameworkCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkApi(configuration);
+
+let valueFrameworkCreate: ValueFrameworkCreate; //
+
+const { status, data } = await apiInstance.postValueFramework(
+    valueFrameworkCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkCreate** | **ValueFrameworkCreate**|  | |
+
+
+### Return type
+
+**ValueFrameworkResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Value framework created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+|**409** | Value framework with this name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+