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

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-dev2
+ * 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;
 }

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

@@ -4,7 +4,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).
@@ -16,44 +16,27 @@
 
 /**
  * Schema for MetricCostsPerYear responses
- * @export
- * @interface MetricCostsPerYearResponse
  */
 export interface MetricCostsPerYearResponse {
     /**
      * Direct cost for the year
-     * @type {number}
-     * @memberof MetricCostsPerYearResponse
      */
     'direct_cost': number;
     /**
      * ID of the value framework
-     * @type {string}
-     * @memberof MetricCostsPerYearResponse
      */
     'framework_id': string;
     /**
      * ID of the metric
-     * @type {string}
-     * @memberof MetricCostsPerYearResponse
      */
     'metric_id': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricCostsPerYearResponse
-     */
     'owner_name'?: string | null;
     /**
      * Perceived cost for the year
-     * @type {number}
-     * @memberof MetricCostsPerYearResponse
      */
     'perceived_cost': number;
     /**
      * Year for the cost data
-     * @type {number}
-     * @memberof MetricCostsPerYearResponse
      */
     'year': number;
 }

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

@@ -4,7 +4,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).
@@ -16,21 +16,9 @@
 
 /**
  * Schema for partially updating Metric Costs Per Year. Only cost fields can be updated.
- * @export
- * @interface MetricCostsPerYearUpdate
  */
 export interface MetricCostsPerYearUpdate {
-    /**
-     * 
-     * @type {number}
-     * @memberof MetricCostsPerYearUpdate
-     */
     'direct_cost'?: number | null;
-    /**
-     * 
-     * @type {number}
-     * @memberof MetricCostsPerYearUpdate
-     */
     'perceived_cost'?: number | null;
 }
 

package/models/metric-create.ts

@@ -4,7 +4,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).
@@ -15,65 +15,40 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import { MeasurementType } from './measurement-type';
+import type { MeasurementType } from './measurement-type';
 // May contain unused imports in some cases
 // @ts-ignore
-import { MetricType } from './metric-type';
+import type { MetricType } from './metric-type';
 
 /**
  * Schema for creating a new Metric (excludes auto-generated fields)
- * @export
- * @interface MetricCreate
  */
 export interface MetricCreate {
     /**
      * Default direct cost value for new metric costs per year records
-     * @type {number}
-     * @memberof MetricCreate
      */
     'default_direct_cost'?: number;
     /**
      * Default perceived cost value for new metric costs per year records
-     * @type {number}
-     * @memberof MetricCreate
      */
     'default_perceived_cost'?: number;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricCreate
-     */
     'description'?: string | null;
     /**
      * Measurement approach
-     * @type {MeasurementType}
-     * @memberof MetricCreate
      */
     'measurement_type': MeasurementType;
     /**
      * Unit of measurement
-     * @type {string}
-     * @memberof MetricCreate
      */
     'measurement_unit': string;
     /**
      * Type of metric
-     * @type {MetricType}
-     * @memberof MetricCreate
      */
     'metric_type': MetricType;
     /**
      * Name of the metric
-     * @type {string}
-     * @memberof MetricCreate
      */
     'name': string;
-    /**
-     * ID of the associated objective
-     * @type {string}
-     * @memberof MetricCreate
-     */
-    'objective_id': string;
 }
 
 

package/models/metric-response.ts

@@ -4,7 +4,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).
@@ -15,88 +15,41 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import { MeasurementType } from './measurement-type';
+import type { MeasurementType } from './measurement-type';
 // May contain unused imports in some cases
 // @ts-ignore
-import { MetricType } from './metric-type';
+import type { MetricType } from './metric-type';
 
 /**
  * Schema for Metric responses (includes all fields)
- * @export
- * @interface MetricResponse
  */
 export interface MetricResponse {
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricResponse
-     */
     'created_at': string;
-    /**
-     * 
-     * @type {number}
-     * @memberof MetricResponse
-     */
     'default_direct_cost': number;
-    /**
-     * 
-     * @type {number}
-     * @memberof MetricResponse
-     */
     'default_perceived_cost': number;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricResponse
-     */
     'description'?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricResponse
-     */
     'id': string;
     /**
      * Measurement approach
-     * @type {MeasurementType}
-     * @memberof MetricResponse
      */
     'measurement_type': MeasurementType;
     /**
      * Unit of measurement
-     * @type {string}
-     * @memberof MetricResponse
      */
     'measurement_unit': string;
     /**
      * Type of metric
-     * @type {MetricType}
-     * @memberof MetricResponse
      */
     'metric_type': MetricType;
     /**
      * Name of the metric
-     * @type {string}
-     * @memberof MetricResponse
      */
     'name': string;
     /**
      * ID of the associated objective
-     * @type {string}
-     * @memberof MetricResponse
      */
     'objective_id': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricResponse
-     */
     'owner_name'?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricResponse
-     */
     'updated_at': string;
 }
 

package/models/metric-type.ts

@@ -4,7 +4,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).
@@ -14,11 +14,6 @@
 
 
 
-/**
- * 
- * @export
- * @enum {string}
- */
 
 export const MetricType = {
     MONETIZED: 'monetized',

package/models/metric-update.ts

@@ -4,7 +4,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).
@@ -15,52 +15,20 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import { MeasurementType } from './measurement-type';
+import type { MeasurementType } from './measurement-type';
 // May contain unused imports in some cases
 // @ts-ignore
-import { MetricType } from './metric-type';
+import type { MetricType } from './metric-type';
 
 /**
  * Schema for partially updating a Metric. Only provided fields will be updated.
- * @export
- * @interface MetricUpdate
  */
 export interface MetricUpdate {
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricUpdate
-     */
     'description'?: string | null;
-    /**
-     * 
-     * @type {MeasurementType}
-     * @memberof MetricUpdate
-     */
     'measurement_type'?: MeasurementType | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricUpdate
-     */
     'measurement_unit'?: string | null;
-    /**
-     * 
-     * @type {MetricType}
-     * @memberof MetricUpdate
-     */
     'metric_type'?: MetricType | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricUpdate
-     */
     'name'?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof MetricUpdate
-     */
     'objective_id'?: string | null;
 }
 

package/models/objective-create.ts

@@ -4,7 +4,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).
@@ -16,20 +16,11 @@
 
 /**
  * Schema for creating a new Objective (excludes auto-generated fields)
- * @export
- * @interface ObjectiveCreate
  */
 export interface ObjectiveCreate {
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveCreate
-     */
     'description'?: string | null;
     /**
      * Name of the objective
-     * @type {string}
-     * @memberof ObjectiveCreate
      */
     'name': string;
 }

package/models/objective-response.ts

@@ -4,7 +4,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).
@@ -16,45 +16,16 @@
 
 /**
  * Schema for Objective responses (includes all fields)
- * @export
- * @interface ObjectiveResponse
  */
 export interface ObjectiveResponse {
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveResponse
-     */
     'created_at': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveResponse
-     */
     'description'?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveResponse
-     */
     'id': string;
     /**
      * Name of the objective
-     * @type {string}
-     * @memberof ObjectiveResponse
      */
     'name': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveResponse
-     */
     'owner_name'?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveResponse
-     */
     'updated_at': string;
 }
 

package/models/objective-update.ts

@@ -4,7 +4,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).
@@ -16,21 +16,9 @@
 
 /**
  * Schema for partially updating an Objective. Only provided fields will be updated.
- * @export
- * @interface ObjectiveUpdate
  */
 export interface ObjectiveUpdate {
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveUpdate
-     */
     'description'?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveUpdate
-     */
     'name'?: string | null;
 }
 

package/models/objective-weight-create.ts

@@ -4,7 +4,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).
@@ -16,26 +16,18 @@
 
 /**
  * Schema for creating a new ObjectiveWeight
- * @export
- * @interface ObjectiveWeightCreate
  */
 export interface ObjectiveWeightCreate {
     /**
      * ID of the value framework
-     * @type {string}
-     * @memberof ObjectiveWeightCreate
      */
     'framework_id': string;
     /**
      * ID of the objective
-     * @type {string}
-     * @memberof ObjectiveWeightCreate
      */
     'objective_id': string;
     /**
      * Weight for this objective in the framework
-     * @type {number}
-     * @memberof ObjectiveWeightCreate
      */
     'weight'?: number;
 }

package/models/objective-weight-response.ts

@@ -4,7 +4,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).
@@ -16,32 +16,19 @@
 
 /**
  * Schema for ObjectiveWeight responses
- * @export
- * @interface ObjectiveWeightResponse
  */
 export interface ObjectiveWeightResponse {
     /**
      * ID of the value framework
-     * @type {string}
-     * @memberof ObjectiveWeightResponse
      */
     'framework_id': string;
     /**
      * ID of the objective
-     * @type {string}
-     * @memberof ObjectiveWeightResponse
      */
     'objective_id': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObjectiveWeightResponse
-     */
     'owner_name'?: string | null;
     /**
      * Weight for this objective in the framework
-     * @type {number}
-     * @memberof ObjectiveWeightResponse
      */
     'weight'?: number;
 }

package/models/objective-weight-update.ts

@@ -4,7 +4,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).
@@ -16,15 +16,8 @@
 
 /**
  * Schema for partially updating an Objective Weight. Only the weight field can be updated.
- * @export
- * @interface ObjectiveWeightUpdate
  */
 export interface ObjectiveWeightUpdate {
-    /**
-     * 
-     * @type {number}
-     * @memberof ObjectiveWeightUpdate
-     */
     'weight'?: number | null;
 }
 

package/models/option-create.ts

@@ -0,0 +1,39 @@
+/* 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 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/models/option-response.ts

@@ -0,0 +1,38 @@
+/* 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 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;
+}
+