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

package/docs/MetricCostsPerYearApi.md

@@ -0,0 +1,307 @@
+# MetricCostsPerYearApi
+
+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|
+|[**deleteMetricCostForFramework**](#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework|
+|[**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|
+|[**patchMetricCostForFramework**](#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework|
+
+# **createMetricCostForFramework**
+> MetricCostsPerYearResponse createMetricCostForFramework(metricCostsPerYearCreate)
+
+Create a yearly cost override for a metric within this framework.
+
+### Example
+
+```typescript
+import {
+    MetricCostsPerYearApi,
+    Configuration,
+    MetricCostsPerYearCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new MetricCostsPerYearApi(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)
+
+# **deleteMetricCostForFramework**
+> deleteMetricCostForFramework()
+
+Delete a metric cost entry for a specific year within this framework.
+
+### Example
+
+```typescript
+import {
+    MetricCostsPerYearApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new MetricCostsPerYearApi(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)
+
+# **getMetricCostForFramework**
+> MetricCostsPerYearResponse getMetricCostForFramework()
+
+Retrieve cost data for a specific metric within this framework for a given year.
+
+### Example
+
+```typescript
+import {
+    MetricCostsPerYearApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new MetricCostsPerYearApi(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 {
+    MetricCostsPerYearApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new MetricCostsPerYearApi(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)
+
+# **patchMetricCostForFramework**
+> MetricCostsPerYearResponse patchMetricCostForFramework(metricCostsPerYearUpdate)
+
+Update the perceived and/or direct cost of a metric for a specific year within this framework.
+
+### Example
+
+```typescript
+import {
+    MetricCostsPerYearApi,
+    Configuration,
+    MetricCostsPerYearUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new MetricCostsPerYearApi(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)
+

package/docs/MetricCostsPerYearCreate.md

@@ -0,0 +1,27 @@
+# MetricCostsPerYearCreate
+
+Schema for creating a new MetricCostsPerYear
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**directCost** | **number** | Direct cost for the year | [default to undefined]
+**metricId** | **string** | ID of the metric | [default to undefined]
+**perceivedCost** | **number** | Perceived cost for the year | [default to undefined]
+**year** | **number** | Year for the cost data | [default to undefined]
+
+## Example
+
+```typescript
+import { MetricCostsPerYearCreate } from '@cosmotech/aip-client';
+
+const instance: MetricCostsPerYearCreate = {
+    directCost,
+    metricId,
+    perceivedCost,
+    year,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricCostsPerYearResponse.md

@@ -0,0 +1,31 @@
+# MetricCostsPerYearResponse
+
+Schema for MetricCostsPerYear responses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**directCost** | **number** | Direct cost for the year | [default to undefined]
+**frameworkId** | **string** | ID of the value framework | [default to undefined]
+**metricId** | **string** | ID of the metric | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**perceivedCost** | **number** | Perceived cost for the year | [default to undefined]
+**year** | **number** | Year for the cost data | [default to undefined]
+
+## Example
+
+```typescript
+import { MetricCostsPerYearResponse } from '@cosmotech/aip-client';
+
+const instance: MetricCostsPerYearResponse = {
+    directCost,
+    frameworkId,
+    metricId,
+    ownerName,
+    perceivedCost,
+    year,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricCostsPerYearUpdate.md

@@ -0,0 +1,23 @@
+# MetricCostsPerYearUpdate
+
+Schema for partially updating Metric Costs Per Year. Only cost fields can be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**directCost** | **number** |  | [optional] [default to undefined]
+**perceivedCost** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MetricCostsPerYearUpdate } from '@cosmotech/aip-client';
+
+const instance: MetricCostsPerYearUpdate = {
+    directCost,
+    perceivedCost,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricCreate.md

@@ -0,0 +1,33 @@
+# MetricCreate
+
+Schema for creating a new Metric (excludes auto-generated fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**defaultDirectCost** | **number** | Default direct cost value for new metric costs per year records | [optional] [default to 0.0]
+**defaultPerceivedCost** | **number** | Default perceived cost value for new metric costs per year records | [optional] [default to 0.0]
+**description** | **string** |  | [optional] [default to undefined]
+**measurementType** | [**MeasurementType**](MeasurementType.md) | Measurement approach | [default to undefined]
+**measurementUnit** | **string** | Unit of measurement | [default to undefined]
+**metricType** | [**MetricType**](MetricType.md) | Type of metric | [default to undefined]
+**name** | **string** | Name of the metric | [default to undefined]
+
+## Example
+
+```typescript
+import { MetricCreate } from '@cosmotech/aip-client';
+
+const instance: MetricCreate = {
+    defaultDirectCost,
+    defaultPerceivedCost,
+    description,
+    measurementType,
+    measurementUnit,
+    metricType,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricResponse.md

@@ -0,0 +1,43 @@
+# MetricResponse
+
+Schema for Metric responses (includes all fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**defaultDirectCost** | **number** |  | [default to undefined]
+**defaultPerceivedCost** | **number** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**measurementType** | [**MeasurementType**](MeasurementType.md) | Measurement approach | [default to undefined]
+**measurementUnit** | **string** | Unit of measurement | [default to undefined]
+**metricType** | [**MetricType**](MetricType.md) | Type of metric | [default to undefined]
+**name** | **string** | Name of the metric | [default to undefined]
+**objectiveId** | **string** | ID of the associated objective | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MetricResponse } from '@cosmotech/aip-client';
+
+const instance: MetricResponse = {
+    createdAt,
+    defaultDirectCost,
+    defaultPerceivedCost,
+    description,
+    id,
+    measurementType,
+    measurementUnit,
+    metricType,
+    name,
+    objectiveId,
+    ownerName,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricType.md

@@ -0,0 +1,12 @@
+# MetricType
+
+
+## Enum
+
+* `MONETIZED` (value: `'monetized'`)
+
+* `TRACKED` (value: `'tracked'`)
+
+* `BOUNDED` (value: `'bounded'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MetricUpdate.md

@@ -0,0 +1,31 @@
+# MetricUpdate
+
+Schema for partially updating a Metric. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**measurementType** | [**MeasurementType**](MeasurementType.md) |  | [optional] [default to undefined]
+**measurementUnit** | **string** |  | [optional] [default to undefined]
+**metricType** | [**MetricType**](MetricType.md) |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**objectiveId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MetricUpdate } from '@cosmotech/aip-client';
+
+const instance: MetricUpdate = {
+    description,
+    measurementType,
+    measurementUnit,
+    metricType,
+    name,
+    objectiveId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)