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

package/dist/esm/models/option-chart-kpi.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

package/dist/esm/models/option-chart-kpis-yearly.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+import type { OptionChartKPI } from './option-chart-kpi';
+/**
+ * Schema of a combined list of KPI values for a given time step, contain both the monetary and objective value
+ */
+export interface OptionChartKPIsYearly {
+    /**
+     * List of KPI values for this time step
+     */
+    'kpis'?: Array<OptionChartKPI>;
+    /**
+     * Net perceived value for the KPI
+     */
+    'net_perceived_value'?: number;
+    /**
+     * Year used for the KPIs
+     */
+    'year'?: number;
+}

package/dist/esm/models/option-chart-kpis-yearly.js

@@ -0,0 +1,14 @@
+/* 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.
+ */
+export {};

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

@@ -19,7 +19,7 @@ export interface OptionCreate {
     'cost'?: number;
     'description'?: string | null;
     /**
-     * Duration of the option in years
+     * Duration of the option in weeks
      */
     'duration'?: number;
     /**

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

@@ -13,8 +13,10 @@
  * 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;
     /**
@@ -26,6 +28,5 @@ export interface OptionResponse {
      */
     'name': string;
     'owner_name'?: string | null;
-    'preferred': boolean;
     'updated_at': string;
 }

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

@@ -13,7 +13,9 @@
  * 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/favored-option-request.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * Request body for setting the preferred option.
+ */
+export interface FavoredOptionRequest {
+    /**
+     * ID of the option to set as preferred
+     */
+    'option_id': string;
+}

package/dist/models/favored-option-request.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/favored-option-response.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * Response for favored option endpoints.
+ */
+export interface FavoredOptionResponse {
+    /**
+     * ID of the preferred option
+     */
+    'option_id': string;
+}

package/dist/models/favored-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/index.d.ts

@@ -1,4 +1,6 @@
 export * from './evolution-type';
+export * from './favored-option-request';
+export * from './favored-option-response';
 export * from './httpvalidation-error';
 export * from './impact-apiresponse';
 export * from './impact-create';
@@ -21,6 +23,8 @@ export * from './objective-update';
 export * from './objective-weight-create';
 export * from './objective-weight-response';
 export * from './objective-weight-update';
+export * from './option-chart-kpi';
+export * from './option-chart-kpis-yearly';
 export * from './option-create';
 export * from './option-response';
 export * from './option-update';

package/dist/models/index.js

@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./evolution-type"), exports);
+__exportStar(require("./favored-option-request"), exports);
+__exportStar(require("./favored-option-response"), exports);
 __exportStar(require("./httpvalidation-error"), exports);
 __exportStar(require("./impact-apiresponse"), exports);
 __exportStar(require("./impact-create"), exports);
@@ -37,6 +39,8 @@ __exportStar(require("./objective-update"), exports);
 __exportStar(require("./objective-weight-create"), exports);
 __exportStar(require("./objective-weight-response"), exports);
 __exportStar(require("./objective-weight-update"), exports);
+__exportStar(require("./option-chart-kpi"), exports);
+__exportStar(require("./option-chart-kpis-yearly"), exports);
 __exportStar(require("./option-create"), exports);
 __exportStar(require("./option-response"), exports);
 __exportStar(require("./option-update"), exports);

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

@@ -21,5 +21,6 @@ export interface InvestmentResponse {
      */
     'name': string;
     'owner_name'?: string | null;
+    'preferred_option_id'?: string | null;
     'updated_at': string;
 }

package/dist/models/option-chart-kpi.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 of a KPI value for a given time step, contain both the monetary and objective value
+ */
+export interface OptionChartKPI {
+    /**
+     * Metric value of the KPI
+     */
+    'metric_value'?: number;
+    /**
+     * Monetary value of the KPI
+     */
+    'monetary_value'?: number;
+    'name'?: string | null;
+    /**
+     * Symbol of the KPI
+     */
+    'symbol'?: string;
+}

package/dist/models/option-chart-kpi.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-chart-kpis-yearly.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+import type { OptionChartKPI } from './option-chart-kpi';
+/**
+ * Schema of a combined list of KPI values for a given time step, contain both the monetary and objective value
+ */
+export interface OptionChartKPIsYearly {
+    /**
+     * List of KPI values for this time step
+     */
+    'kpis'?: Array<OptionChartKPI>;
+    /**
+     * Net perceived value for the KPI
+     */
+    'net_perceived_value'?: number;
+    /**
+     * Year used for the KPIs
+     */
+    'year'?: number;
+}

package/dist/models/option-chart-kpis-yearly.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-create.d.ts

@@ -19,7 +19,7 @@ export interface OptionCreate {
     'cost'?: number;
     'description'?: string | null;
     /**
-     * Duration of the option in years
+     * Duration of the option in weeks
      */
     'duration'?: number;
     /**

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

@@ -13,8 +13,10 @@
  * 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;
     /**
@@ -26,6 +28,5 @@ export interface OptionResponse {
      */
     'name': string;
     'owner_name'?: string | null;
-    'preferred': boolean;
     'updated_at': string;
 }

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

@@ -13,7 +13,9 @@
  * 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/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)