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

package/docs/ValueFrameworkCostsApi.md

@@ -0,0 +1,128 @@
+# ValueFrameworkCostsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCostsForValueFramework**](#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework|
+|[**getCostsForValueFrameworkByMetric**](#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric|
+
+# **getCostsForValueFramework**
+> Array<MetricCostsPerYearResponse> getCostsForValueFramework()
+
+Retrieve a paginated list of all metric costs for a specific value framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkCostsApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkCostsApi(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.getCostsForValueFramework(
+    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<MetricCostsPerYearResponse>**
+
+### 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 metric cost entries 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)
+
+# **getCostsForValueFrameworkByMetric**
+> Array<MetricCostsPerYearResponse> getCostsForValueFrameworkByMetric()
+
+Retrieve a paginated list of metric costs for a specific metric within a value framework.
+
+### Example
+
+```typescript
+import {
+    ValueFrameworkCostsApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new ValueFrameworkCostsApi(configuration);
+
+let metricId: string; //UUID of the metric (default to undefined)
+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.getCostsForValueFrameworkByMetric(
+    metricId,
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
+| **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<MetricCostsPerYearResponse>**
+
+### 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 metric cost entries for the framework and metric |  -  |
+|**404** | Value framework or metric 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/ValueFrameworkCreate.md

@@ -0,0 +1,23 @@
+# ValueFrameworkCreate
+
+Schema for creating a new ValueFramework (excludes auto-generated fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** | Name of the value framework | [default to undefined]
+
+## Example
+
+```typescript
+import { ValueFrameworkCreate } from '@cosmotech/aip-client';
+
+const instance: ValueFrameworkCreate = {
+    description,
+    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/ValueFrameworkResponse.md

@@ -0,0 +1,31 @@
+# ValueFrameworkResponse
+
+Schema for ValueFramework responses (includes all fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** | Name of the value framework | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ValueFrameworkResponse } from '@cosmotech/aip-client';
+
+const instance: ValueFrameworkResponse = {
+    createdAt,
+    description,
+    id,
+    name,
+    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)

package/docs/ValueFrameworkUpdate.md

@@ -0,0 +1,23 @@
+# ValueFrameworkUpdate
+
+Schema for partially updating a Value Framework. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ValueFrameworkUpdate } from '@cosmotech/aip-client';
+
+const instance: ValueFrameworkUpdate = {
+    description,
+    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/ValueFrameworkWeightsApi.md

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

package/index.ts

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

package/models/evolution-type.ts

@@ -0,0 +1,26 @@
+/* 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 const EvolutionType = {
+    LINEAR: 'linear',
+    EXPONENTIAL: 'exponential'
+} as const;
+
+export type EvolutionType = typeof EvolutionType[keyof typeof EvolutionType];
+
+
+

package/models/httpvalidation-error.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,19 +15,9 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import { ValidationError } from './validation-error';
+import type { ValidationError } from './validation-error';
 
-/**
- * 
- * @export
- * @interface HTTPValidationError
- */
 export interface HTTPValidationError {
-    /**
-     * 
-     * @type {Array<ValidationError>}
-     * @memberof HTTPValidationError
-     */
     'detail'?: Array<ValidationError>;
 }
 

package/models/impact-apiresponse.ts

@@ -0,0 +1,43 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { EvolutionType } from './evolution-type';
+
+/**
+ * API response model for Impact — exposes option_id instead of phase_id.
+ */
+export interface ImpactAPIResponse {
+    'created_at': string;
+    'direct_post_value': number;
+    'evolution_rate': number;
+    'evolution_type': EvolutionType;
+    'id': string;
+    /**
+     * ID of the associated metric
+     */
+    'metric_id': string;
+    'name': string;
+    /**
+     * ID of the associated option
+     */
+    'option_id': string;
+    'owner_name'?: string | null;
+    'updated_at': string;
+}
+
+
+

package/models/impact-create.ts

@@ -0,0 +1,47 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { EvolutionType } from './evolution-type';
+
+/**
+ * Schema for creating a new Impact (excludes auto-generated fields)
+ */
+export interface ImpactCreate {
+    /**
+     * Direct post value of the impact
+     */
+    'direct_post_value'?: number;
+    /**
+     * Rate of evolution over time
+     */
+    'evolution_rate'?: number;
+    /**
+     * Type of evolution
+     */
+    'evolution_type'?: EvolutionType;
+    /**
+     * ID of the associated metric
+     */
+    'metric_id': string;
+    /**
+     * Name of the impact
+     */
+    'name': string;
+}
+
+
+

package/models/impact-update.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { EvolutionType } from './evolution-type';
+
+/**
+ * Schema for partially updating an Impact. Only provided fields will be updated.
+ */
+export interface ImpactUpdate {
+    'direct_post_value'?: number | null;
+    'evolution_rate'?: number | null;
+    'evolution_type'?: EvolutionType | null;
+    'metric_id'?: string | null;
+    'name'?: string | null;
+}
+
+
+

package/models/index.ts

@@ -1,4 +1,12 @@
+export * from './evolution-type';
 export * from './httpvalidation-error';
+export * from './impact-apiresponse';
+export * from './impact-create';
+export * from './impact-update';
+export * from './investment-create';
+export * from './investment-response';
+export * from './investment-update';
+export * from './location-inner';
 export * from './measurement-type';
 export * from './metric-costs-per-year-create';
 export * from './metric-costs-per-year-response';
@@ -13,8 +21,10 @@ export * from './objective-update';
 export * from './objective-weight-create';
 export * from './objective-weight-response';
 export * from './objective-weight-update';
+export * from './option-create';
+export * from './option-response';
+export * from './option-update';
 export * from './validation-error';
-export * from './validation-error-loc-inner';
 export * from './value-framework-create';
 export * from './value-framework-response';
 export * from './value-framework-update';

package/models/investment-create.ts

@@ -0,0 +1,27 @@
+/* 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.
+ */
+
+
+
+/**
+ * Schema for creating a new Investment (excludes auto-generated fields)
+ */
+export interface InvestmentCreate {
+    'description'?: string | null;
+    /**
+     * Name of the investment
+     */
+    'name': string;
+}
+

package/models/investment-response.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+
+/**
+ * Schema for Investment responses (includes all fields)
+ */
+export interface InvestmentResponse {
+    'created_at': string;
+    'description'?: string | null;
+    'id': string;
+    /**
+     * Name of the investment
+     */
+    'name': string;
+    'owner_name'?: string | null;
+    'updated_at': string;
+}
+

package/models/investment-update.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+
+/**
+ * Schema for partially updating an Investment. Only provided fields will be updated.
+ */
+export interface InvestmentUpdate {
+    'description'?: string | null;
+    'name'?: string | null;
+}
+

package/models/{validation-error-loc-inner.ts → location-inner.ts}

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,11 +14,6 @@
 
 
 
-/**
- * 
- * @export
- * @interface ValidationErrorLocInner
- */
-export interface ValidationErrorLocInner {
+export interface LocationInner {
 }
 

package/models/measurement-type.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,11 +14,6 @@
 
 
 
-/**
- * 
- * @export
- * @enum {string}
- */
 
 export const MeasurementType = {
     MAXIMIZATION: 'maximization',

package/models/metric-costs-per-year-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev
+ * The version of the OpenAPI document: 0.2.0-dev3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,38 +16,22 @@
 
 /**
  * Schema for creating a new MetricCostsPerYear
- * @export
- * @interface MetricCostsPerYearCreate
  */
 export interface MetricCostsPerYearCreate {
     /**
      * Direct cost for the year
-     * @type {number}
-     * @memberof MetricCostsPerYearCreate
      */
     'direct_cost': number;
-    /**
-     * ID of the value framework
-     * @type {string}
-     * @memberof MetricCostsPerYearCreate
-     */
-    'framework_id': string;
     /**
      * ID of the metric
-     * @type {string}
-     * @memberof MetricCostsPerYearCreate
      */
     'metric_id': string;
     /**
      * Perceived cost for the year
-     * @type {number}
-     * @memberof MetricCostsPerYearCreate
      */
     'perceived_cost': number;
     /**
      * Year for the cost data
-     * @type {number}
-     * @memberof MetricCostsPerYearCreate
      */
     'year': number;
 }