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

package/docs/ObjectiveApi.md

@@ -0,0 +1,633 @@
+# ObjectiveApi
+
+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()
+
+Delete an existing objective by its ID. Associated metrics and objective weights are also deleted via cascade.
+
+### 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)
+
+const { status, data } = await apiInstance.deleteObjective(
+    objectiveId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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** | Objective successfully deleted |  -  |
+|**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)
+
+# **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()
+
+Retrieve a single objective by its ID.
+
+### 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)
+
+const { status, data } = await apiInstance.getObjectiveById(
+    objectiveId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
+
+
+### Return type
+
+**ObjectiveResponse**
+
+### 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 |  -  |
+|**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)
+
+# **getObjectives**
+> Array<ObjectiveResponse> getObjectives()
+
+Retrieve a paginated list of all objectives.
+
+### Example
+
+```typescript
+import {
+    ObjectiveApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveApi(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.getObjectives(
+    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<ObjectiveResponse>**
+
+### 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 objectives |  -  |
+
+[[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)
+
+Update one or more fields of an existing objective. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+
+### Example
+
+```typescript
+import {
+    ObjectiveApi,
+    Configuration,
+    ObjectiveUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveApi(configuration);
+
+let objectiveId: string; //UUID of the objective (default to undefined)
+let objectiveUpdate: ObjectiveUpdate; //
+
+const { status, data } = await apiInstance.patchObjective(
+    objectiveId,
+    objectiveUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveUpdate** | **ObjectiveUpdate**|  | |
+| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
+
+
+### Return type
+
+**ObjectiveResponse**
+
+### 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 updated successfully |  -  |
+|**400** | Validation or constraint error (e.g. empty name) |  -  |
+|**404** | Objective 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)
+
+# **postObjective**
+> ObjectiveResponse postObjective(objectiveCreate)
+
+Create a new objective. Name must be unique and non-empty.
+
+### Example
+
+```typescript
+import {
+    ObjectiveApi,
+    Configuration,
+    ObjectiveCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveApi(configuration);
+
+let objectiveCreate: ObjectiveCreate; //
+
+const { status, data } = await apiInstance.postObjective(
+    objectiveCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectiveCreate** | **ObjectiveCreate**|  | |
+
+
+### Return type
+
+**ObjectiveResponse**
+
+### 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 created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+|**409** | Objective 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)
+

package/docs/ObjectiveCreate.md

@@ -0,0 +1,23 @@
+# ObjectiveCreate
+
+Schema for creating a new Objective (excludes auto-generated fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** | Name of the objective | [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectiveCreate } from '@cosmotech/aip-client';
+
+const instance: ObjectiveCreate = {
+    description,
+    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/ObjectiveResponse.md

@@ -0,0 +1,31 @@
+# ObjectiveResponse
+
+Schema for Objective responses (includes all fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** | Name of the objective | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectiveResponse } from '@cosmotech/aip-client';
+
+const instance: ObjectiveResponse = {
+    createdAt,
+    description,
+    id,
+    name,
+    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/ObjectiveUpdate.md

@@ -0,0 +1,23 @@
+# ObjectiveUpdate
+
+Schema for partially updating an Objective. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectiveUpdate } from '@cosmotech/aip-client';
+
+const instance: ObjectiveUpdate = {
+    description,
+    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)