@cosmotech/aip-client 0.3.0-dev2 → 0.4.0-dev1

package/docs/OptionApi.md

@@ -4,79 +4,14 @@ 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|
 |[**createOptionForInvestment**](#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment|
-|[**deleteImpactForOption**](#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option|
 |[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
-|[**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|
 |[**getOptionForInvestment**](#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment|
 |[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework|
 |[**getOptionsForInvestment**](#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment|
 |[**getOptionsOverview**](#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment|
-|[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
 |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
 
-# **createImpactForOption**
-> ImpactAPIResponse createImpactForOption(impactCreate)
-
-Create a new impact under this option.
-
-### Example
-
-```typescript
-import {
-    OptionApi,
-    Configuration,
-    ImpactCreate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new OptionApi(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)
-
 # **createOptionForInvestment**
 > OptionResponse createOptionForInvestment(optionCreate)
 
@@ -134,64 +69,6 @@ const { status, data } = await apiInstance.createOptionForInvestment(
 
 [[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 {
-    OptionApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new OptionApi(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)
-
 # **deleteOptionForInvestment**
 > deleteOptionForInvestment()
 
@@ -208,12 +85,12 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OptionApi(configuration);
 
-let optionId: string; //UUID of the option (default to undefined)
 let investmentId: string; //UUID of the investment (default to undefined)
+let optionId: string; //UUID of the option (default to undefined)
 
 const { status, data } = await apiInstance.deleteOptionForInvestment(
-    optionId,
-    investmentId
+    investmentId,
+    optionId
 );
 ```
 
@@ -221,8 +98,8 @@ const { status, data } = await apiInstance.deleteOptionForInvestment(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
 | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
 
 
 ### Return type
@@ -247,125 +124,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)
 
-# **getImpactForOption**
-> ImpactAPIResponse getImpactForOption()
-
-Retrieve a specific impact for the option.
-
-### Example
-
-```typescript
-import {
-    OptionApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new OptionApi(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 {
-    OptionApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new OptionApi(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)
-
 # **getOptionForInvestment**
 > OptionResponse getOptionForInvestment()
 
@@ -437,13 +195,13 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OptionApi(configuration);
 
-let investmentId: string; //UUID of the investment (default to undefined)
 let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (default to undefined)
 let valueFrameworkId: string; //UUID of the value framework (default to undefined)
 
 const { status, data } = await apiInstance.getOptionKpis(
-    investmentId,
     optionId,
+    investmentId,
     valueFrameworkId
 );
 ```
@@ -452,8 +210,8 @@ const { status, data } = await apiInstance.getOptionKpis(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
 | **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
 | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
 
 
@@ -592,69 +350,6 @@ const { status, data } = await apiInstance.getOptionsOverview(
 
 [[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 {
-    OptionApi,
-    Configuration,
-    ImpactUpdate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new OptionApi(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)
-
 # **patchOptionForInvestment**
 > OptionResponse patchOptionForInvestment(optionUpdate)