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

package/docs/ImpactApi.md

@@ -0,0 +1,312 @@
+# ImpactApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createImpactForOption**](#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option|
+|[**deleteImpactForOption**](#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option|
+|[**getImpactForOption**](#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option|
+|[**getImpactsForOption**](#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option|
+|[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
+
+# **createImpactForOption**
+> ImpactAPIResponse createImpactForOption(impactCreate)
+
+Create a new impact under this option.
+
+### Example
+
+```typescript
+import {
+    ImpactApi,
+    Configuration,
+    ImpactCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ImpactApi(configuration);
+
+let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (default to undefined)
+let impactCreate: ImpactCreate; //
+
+const { status, data } = await apiInstance.createImpactForOption(
+    optionId,
+    investmentId,
+    impactCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **impactCreate** | **ImpactCreate**|  | |
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**ImpactAPIResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Impact created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+|**404** | Investment or option 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)
+
+# **deleteImpactForOption**
+> deleteImpactForOption()
+
+Delete an existing impact by its ID.
+
+### Example
+
+```typescript
+import {
+    ImpactApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ImpactApi(configuration);
+
+let impactId: string; //UUID of the impact (default to undefined)
+let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (default to undefined)
+
+const { status, data } = await apiInstance.deleteImpactForOption(
+    impactId,
+    optionId,
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **impactId** | [**string**] | UUID of the impact | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | 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** | Impact successfully deleted |  -  |
+|**404** | Investment, option, or impact 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)
+
+# **getImpactForOption**
+> ImpactAPIResponse getImpactForOption()
+
+Retrieve a specific impact for the option.
+
+### Example
+
+```typescript
+import {
+    ImpactApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ImpactApi(configuration);
+
+let impactId: string; //UUID of the impact (default to undefined)
+let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (default to undefined)
+
+const { status, data } = await apiInstance.getImpactForOption(
+    impactId,
+    optionId,
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **impactId** | [**string**] | UUID of the impact | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**ImpactAPIResponse**
+
+### 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 impact |  -  |
+|**404** | Investment, option, or impact 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)
+
+# **getImpactsForOption**
+> Array<ImpactAPIResponse> getImpactsForOption()
+
+Retrieve a paginated list of all impacts for a specific option.
+
+### Example
+
+```typescript
+import {
+    ImpactApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ImpactApi(configuration);
+
+let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (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.getImpactsForOption(
+    optionId,
+    investmentId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | 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<ImpactAPIResponse>**
+
+### 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 impacts for the option |  -  |
+|**404** | Investment or option 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)
+
+# **patchImpactForOption**
+> ImpactAPIResponse patchImpactForOption(impactUpdate)
+
+Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+
+### Example
+
+```typescript
+import {
+    ImpactApi,
+    Configuration,
+    ImpactUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ImpactApi(configuration);
+
+let impactId: string; //UUID of the impact (default to undefined)
+let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (default to undefined)
+let impactUpdate: ImpactUpdate; //
+
+const { status, data } = await apiInstance.patchImpactForOption(
+    impactId,
+    optionId,
+    investmentId,
+    impactUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **impactUpdate** | **ImpactUpdate**|  | |
+| **impactId** | [**string**] | UUID of the impact | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**ImpactAPIResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Impact updated successfully |  -  |
+|**400** | Validation or constraint error |  -  |
+|**404** | Investment, option, or impact 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/ImpactCreate.md

@@ -0,0 +1,29 @@
+# ImpactCreate
+
+Schema for creating a new Impact (excludes auto-generated fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**directPostValue** | **number** | Direct post value of the impact | [optional] [default to 0.0]
+**evolutionRate** | **number** | Rate of evolution over time | [optional] [default to 0.0]
+**evolutionType** | [**EvolutionType**](EvolutionType.md) | Type of evolution | [optional] [default to undefined]
+**metricId** | **string** | ID of the associated metric | [default to undefined]
+**name** | **string** | Name of the impact | [default to undefined]
+
+## Example
+
+```typescript
+import { ImpactCreate } from '@cosmotech/aip-client';
+
+const instance: ImpactCreate = {
+    directPostValue,
+    evolutionRate,
+    evolutionType,
+    metricId,
+    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/ImpactUpdate.md

@@ -0,0 +1,29 @@
+# ImpactUpdate
+
+Schema for partially updating an Impact. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**directPostValue** | **number** |  | [optional] [default to undefined]
+**evolutionRate** | **number** |  | [optional] [default to undefined]
+**evolutionType** | [**EvolutionType**](EvolutionType.md) |  | [optional] [default to undefined]
+**metricId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ImpactUpdate } from '@cosmotech/aip-client';
+
+const instance: ImpactUpdate = {
+    directPostValue,
+    evolutionRate,
+    evolutionType,
+    metricId,
+    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)