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

package/dist/models/option-create.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for creating a new Option (excludes auto-generated fields)
+ */
+export interface OptionCreate {
+    /**
+     * Cost of the option
+     */
+    'cost'?: number;
+    'description'?: string | null;
+    /**
+     * Duration of the option in years
+     */
+    'duration'?: number;
+    /**
+     * Expected start date of the option
+     */
+    'expected_start_date'?: string;
+    /**
+     * Name of the option
+     */
+    'name': string;
+}

package/dist/models/option-create.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/option-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for Option responses (includes all fields)
+ */
+export interface OptionResponse {
+    'cost': number;
+    'created_at': string;
+    'description'?: string | null;
+    'duration': number;
+    'expected_start_date': string;
+    'id': string;
+    /**
+     * ID of the associated investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the option
+     */
+    'name': string;
+    'owner_name'?: string | null;
+    'updated_at': string;
+}

package/dist/models/option-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/option-update.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for partially updating an Option. Only provided fields will be updated.
+ */
+export interface OptionUpdate {
+    'cost'?: number | null;
+    'description'?: string | null;
+    'duration'?: number | null;
+    'expected_start_date'?: string | null;
+    'name'?: string | null;
+}

package/dist/models/option-update.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/validation-error.d.ts

@@ -2,48 +2,18 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ValidationErrorLocInner } from './validation-error-loc-inner';
-/**
- *
- * @export
- * @interface ValidationError
- */
+import type { LocationInner } from './location-inner';
 export interface ValidationError {
-    /**
-     *
-     * @type {object}
-     * @memberof ValidationError
-     */
     'ctx'?: object;
-    /**
-     *
-     * @type {any}
-     * @memberof ValidationError
-     */
     'input'?: any;
-    /**
-     *
-     * @type {Array<ValidationErrorLocInner>}
-     * @memberof ValidationError
-     */
-    'loc': Array<ValidationErrorLocInner>;
-    /**
-     *
-     * @type {string}
-     * @memberof ValidationError
-     */
+    'loc': Array<LocationInner>;
     'msg': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ValidationError
-     */
     'type': string;
 }

package/dist/models/validation-error.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/value-framework-create.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,20 +11,11 @@
  */
 /**
  * Schema for creating a new ValueFramework (excludes auto-generated fields)
- * @export
- * @interface ValueFrameworkCreate
  */
 export interface ValueFrameworkCreate {
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkCreate
-     */
     'description'?: string | null;
     /**
      * Name of the value framework
-     * @type {string}
-     * @memberof ValueFrameworkCreate
      */
     'name': string;
 }

package/dist/models/value-framework-create.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/value-framework-response.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,44 +11,15 @@
  */
 /**
  * Schema for ValueFramework responses (includes all fields)
- * @export
- * @interface ValueFrameworkResponse
  */
 export interface ValueFrameworkResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkResponse
-     */
     'created_at': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkResponse
-     */
     'description'?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkResponse
-     */
     'id': string;
     /**
      * Name of the value framework
-     * @type {string}
-     * @memberof ValueFrameworkResponse
      */
     'name': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkResponse
-     */
     'owner_name'?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkResponse
-     */
     'updated_at': string;
 }

package/dist/models/value-framework-response.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/value-framework-update.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,20 +11,8 @@
  */
 /**
  * Schema for partially updating a Value Framework. Only provided fields will be updated.
- * @export
- * @interface ValueFrameworkUpdate
  */
 export interface ValueFrameworkUpdate {
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkUpdate
-     */
     'description'?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof ValueFrameworkUpdate
-     */
     'name'?: string | null;
 }

package/dist/models/value-framework-update.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev2
+ * The version of the OpenAPI document: 0.2.0-dev3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/DefaultApi.md

@@ -0,0 +1,51 @@
+# DefaultApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**root**](#root) | **GET** /about | Root|
+
+# **root**
+> any root()
+
+
+### Example
+
+```typescript
+import {
+    DefaultApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new DefaultApi(configuration);
+
+const { status, data } = await apiInstance.root();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+
+[[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/EvolutionType.md

@@ -0,0 +1,10 @@
+# EvolutionType
+
+
+## Enum
+
+* `LINEAR` (value: `'linear'`)
+
+* `EXPONENTIAL` (value: `'exponential'`)
+
+[[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/FavoredOptionApi.md

@@ -0,0 +1,119 @@
+# FavoredOptionApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFavoredOption**](#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment|
+|[**setFavoredOption**](#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment|
+
+# **getFavoredOption**
+> FavoredOptionResponse getFavoredOption()
+
+Get the preferred option for an investment.
+
+### Example
+
+```typescript
+import {
+    FavoredOptionApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new FavoredOptionApi(configuration);
+
+let investmentId: string; //UUID of the investment (default to undefined)
+
+const { status, data } = await apiInstance.getFavoredOption(
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**FavoredOptionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Preferred option exists |  -  |
+|**204** | Investment exists but no options are associated |  -  |
+|**404** | Investment 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)
+
+# **setFavoredOption**
+> FavoredOptionResponse setFavoredOption(favoredOptionRequest)
+
+Set the preferred option for an investment.
+
+### Example
+
+```typescript
+import {
+    FavoredOptionApi,
+    Configuration,
+    FavoredOptionRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new FavoredOptionApi(configuration);
+
+let investmentId: string; //UUID of the investment (default to undefined)
+let favoredOptionRequest: FavoredOptionRequest; //
+
+const { status, data } = await apiInstance.setFavoredOption(
+    investmentId,
+    favoredOptionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **favoredOptionRequest** | **FavoredOptionRequest**|  | |
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**FavoredOptionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Preferred option updated successfully |  -  |
+|**400** | Option does not belong to this investment |  -  |
+|**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)
+

package/docs/FavoredOptionRequest.md

@@ -0,0 +1,21 @@
+# FavoredOptionRequest
+
+Request body for setting the preferred option.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**optionId** | **string** | ID of the option to set as preferred | [default to undefined]
+
+## Example
+
+```typescript
+import { FavoredOptionRequest } from '@cosmotech/aip-client';
+
+const instance: FavoredOptionRequest = {
+    optionId,
+};
+```
+
+[[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/FavoredOptionResponse.md

@@ -0,0 +1,21 @@
+# FavoredOptionResponse
+
+Response for favored option endpoints.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**optionId** | **string** | ID of the preferred option | [default to undefined]
+
+## Example
+
+```typescript
+import { FavoredOptionResponse } from '@cosmotech/aip-client';
+
+const instance: FavoredOptionResponse = {
+    optionId,
+};
+```
+
+[[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/HTTPValidationError.md

@@ -0,0 +1,20 @@
+# HTTPValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | [**Array<ValidationError>**](ValidationError.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { HTTPValidationError } from '@cosmotech/aip-client';
+
+const instance: HTTPValidationError = {
+    detail,
+};
+```
+
+[[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/ImpactAPIResponse.md

@@ -0,0 +1,39 @@
+# ImpactAPIResponse
+
+API response model for Impact — exposes option_id instead of phase_id.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**directPostValue** | **number** |  | [default to undefined]
+**evolutionRate** | **number** |  | [default to undefined]
+**evolutionType** | [**EvolutionType**](EvolutionType.md) |  | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**metricId** | **string** | ID of the associated metric | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**optionId** | **string** | ID of the associated option | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ImpactAPIResponse } from '@cosmotech/aip-client';
+
+const instance: ImpactAPIResponse = {
+    createdAt,
+    directPostValue,
+    evolutionRate,
+    evolutionType,
+    id,
+    metricId,
+    name,
+    optionId,
+    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)