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

package/docs/ObjectiveApi.md

@@ -4,131 +4,12 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createMetricForObjective**](#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective|
-|[**deleteMetricForObjective**](#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective|
 |[**deleteObjective**](#deleteobjective) | **DELETE** /objective/{objective_id} | Delete an objective|
-|[**getMetricForObjective**](#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective|
-|[**getMetricsForObjective**](#getmetricsforobjective) | **GET** /objective/{objective_id}/metric/ | List metrics for this objective|
 |[**getObjectiveById**](#getobjectivebyid) | **GET** /objective/{objective_id} | Get an objective by ID|
 |[**getObjectives**](#getobjectives) | **GET** /objective/ | List objectives|
-|[**getWeightsForObjective**](#getweightsforobjective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective|
-|[**patchMetricForObjective**](#patchmetricforobjective) | **PATCH** /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective|
 |[**patchObjective**](#patchobjective) | **PATCH** /objective/{objective_id} | Partially update an objective|
 |[**postObjective**](#postobjective) | **POST** /objective/ | Create an objective|
 
-# **createMetricForObjective**
-> MetricResponse createMetricForObjective(metricCreate)
-
-Create a new metric under this objective.
-
-### Example
-
-```typescript
-import {
-    ObjectiveApi,
-    Configuration,
-    MetricCreate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new ObjectiveApi(configuration);
-
-let objectiveId: string; //UUID of the objective (default to undefined)
-let metricCreate: MetricCreate; //
-
-const { status, data } = await apiInstance.createMetricForObjective(
-    objectiveId,
-    metricCreate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **metricCreate** | **MetricCreate**|  | |
-| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
-
-
-### Return type
-
-**MetricResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Metric created successfully |  -  |
-|**400** | Invalid input or constraint violation |  -  |
-|**404** | Objective not found |  -  |
-|**409** | Duplicate metric |  -  |
-
-[[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)
-
-# **deleteMetricForObjective**
-> deleteMetricForObjective()
-
-Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
-
-### Example
-
-```typescript
-import {
-    ObjectiveApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new ObjectiveApi(configuration);
-
-let metricId: string; //UUID of the metric (default to undefined)
-let objectiveId: string; //UUID of the objective (default to undefined)
-
-const { status, data } = await apiInstance.deleteMetricForObjective(
-    metricId,
-    objectiveId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
-| **objectiveId** | [**string**] | UUID of the objective | 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 successfully deleted |  -  |
-|**404** | Objective 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)
-
 # **deleteObjective**
 > deleteObjective()
 
@@ -181,119 +62,6 @@ void (empty response body)
 
 [[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)
 
-# **getMetricForObjective**
-> MetricResponse getMetricForObjective()
-
-Retrieve a specific metric for the objective.
-
-### Example
-
-```typescript
-import {
-    ObjectiveApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new ObjectiveApi(configuration);
-
-let metricId: string; //UUID of the metric (default to undefined)
-let objectiveId: string; //UUID of the objective (default to undefined)
-
-const { status, data } = await apiInstance.getMetricForObjective(
-    metricId,
-    objectiveId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
-| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
-
-
-### Return type
-
-**MetricResponse**
-
-### 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 metric |  -  |
-|**404** | Objective 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)
-
-# **getMetricsForObjective**
-> Array<MetricResponse> getMetricsForObjective()
-
-Retrieve a paginated list of all metrics for a specific objective.
-
-### Example
-
-```typescript
-import {
-    ObjectiveApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new ObjectiveApi(configuration);
-
-let objectiveId: string; //UUID of the objective (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.getMetricsForObjective(
-    objectiveId,
-    offset,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **objectiveId** | [**string**] | UUID of the objective | 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<MetricResponse>**
-
-### 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 metrics for the objective |  -  |
-|**404** | Objective 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)
-
 # **getObjectiveById**
 > ObjectiveResponse getObjectiveById()
 
@@ -400,125 +168,6 @@ const { status, data } = await apiInstance.getObjectives(
 
 [[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)
 
-# **getWeightsForObjective**
-> Array<ObjectiveWeightResponse> getWeightsForObjective()
-
-Retrieve a paginated list of all objective weights for a specific objective.
-
-### Example
-
-```typescript
-import {
-    ObjectiveApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new ObjectiveApi(configuration);
-
-let objectiveId: string; //UUID of the objective (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.getWeightsForObjective(
-    objectiveId,
-    offset,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **objectiveId** | [**string**] | UUID of the objective | 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 objective |  -  |
-|**404** | Objective 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)
-
-# **patchMetricForObjective**
-> MetricResponse patchMetricForObjective(metricUpdate)
-
-Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-
-### Example
-
-```typescript
-import {
-    ObjectiveApi,
-    Configuration,
-    MetricUpdate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new ObjectiveApi(configuration);
-
-let metricId: string; //UUID of the metric (default to undefined)
-let objectiveId: string; //UUID of the objective (default to undefined)
-let metricUpdate: MetricUpdate; //
-
-const { status, data } = await apiInstance.patchMetricForObjective(
-    metricId,
-    objectiveId,
-    metricUpdate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **metricUpdate** | **MetricUpdate**|  | |
-| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
-| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
-
-
-### Return type
-
-**MetricResponse**
-
-### 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 updated successfully |  -  |
-|**400** | Validation or constraint error |  -  |
-|**404** | Objective or metric not found |  -  |
-|**409** | Unique constraint violation |  -  |
-
-[[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)
-
 # **patchObjective**
 > ObjectiveResponse patchObjective(objectiveUpdate)