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

package/docs/ObjectiveWeightApi.md

@@ -0,0 +1,298 @@
+# ObjectiveWeightApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createObjectiveWeightForFramework**](#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework|
+|[**deleteObjectiveWeightForFramework**](#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight 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|
+|[**patchObjectiveWeightForFramework**](#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework|
+
+# **createObjectiveWeightForFramework**
+> ObjectiveWeightResponse createObjectiveWeightForFramework(objectiveWeightCreate)
+
+Assign a weight to an objective within this framework.
+
+### Example
+
+```typescript
+import {
+    ObjectiveWeightApi,
+    Configuration,
+    ObjectiveWeightCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveWeightApi(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)
+
+# **deleteObjectiveWeightForFramework**
+> deleteObjectiveWeightForFramework()
+
+Remove an objective weight from this framework.
+
+### Example
+
+```typescript
+import {
+    ObjectiveWeightApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveWeightApi(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)
+
+# **getObjectiveWeightForFramework**
+> ObjectiveWeightResponse getObjectiveWeightForFramework()
+
+Retrieve the weight for a specific objective within this framework.
+
+### Example
+
+```typescript
+import {
+    ObjectiveWeightApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveWeightApi(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 {
+    ObjectiveWeightApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveWeightApi(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)
+
+# **patchObjectiveWeightForFramework**
+> ObjectiveWeightResponse patchObjectiveWeightForFramework(objectiveWeightUpdate)
+
+Update the weight of an objective within this value framework.
+
+### Example
+
+```typescript
+import {
+    ObjectiveWeightApi,
+    Configuration,
+    ObjectiveWeightUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveWeightApi(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)
+

package/docs/ObjectiveWeightCreate.md

@@ -0,0 +1,25 @@
+# ObjectiveWeightCreate
+
+Schema for creating a new ObjectiveWeight
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**frameworkId** | **string** | ID of the value framework | [default to undefined]
+**objectiveId** | **string** | ID of the objective | [default to undefined]
+**weight** | **number** | Weight for this objective in the framework | [optional] [default to 1.0]
+
+## Example
+
+```typescript
+import { ObjectiveWeightCreate } from '@cosmotech/aip-client';
+
+const instance: ObjectiveWeightCreate = {
+    frameworkId,
+    objectiveId,
+    weight,
+};
+```
+
+[[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/ObjectiveWeightResponse.md

@@ -0,0 +1,27 @@
+# ObjectiveWeightResponse
+
+Schema for ObjectiveWeight responses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**frameworkId** | **string** | ID of the value framework | [default to undefined]
+**objectiveId** | **string** | ID of the objective | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**weight** | **number** | Weight for this objective in the framework | [optional] [default to 1.0]
+
+## Example
+
+```typescript
+import { ObjectiveWeightResponse } from '@cosmotech/aip-client';
+
+const instance: ObjectiveWeightResponse = {
+    frameworkId,
+    objectiveId,
+    ownerName,
+    weight,
+};
+```
+
+[[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/ObjectiveWeightUpdate.md

@@ -0,0 +1,21 @@
+# ObjectiveWeightUpdate
+
+Schema for partially updating an Objective Weight. Only the weight field can be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**weight** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ObjectiveWeightUpdate } from '@cosmotech/aip-client';
+
+const instance: ObjectiveWeightUpdate = {
+    weight,
+};
+```
+
+[[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/ObjectiveWeightsApi.md

@@ -0,0 +1,66 @@
+# ObjectiveWeightsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getWeightsForObjective**](#getweightsforobjective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective|
+
+# **getWeightsForObjective**
+> Array<ObjectiveWeightResponse> getWeightsForObjective()
+
+Retrieve a paginated list of all objective weights for a specific objective.
+
+### Example
+
+```typescript
+import {
+    ObjectiveWeightsApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ObjectiveWeightsApi(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)
+