@cosmotech/aip-client 0.0.1-rc1

package/src/models/MetricCreate.ts

@@ -0,0 +1,139 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { MeasurementType } from './MeasurementType';
+import {
+    MeasurementTypeFromJSON,
+    MeasurementTypeFromJSONTyped,
+    MeasurementTypeToJSON,
+} from './MeasurementType';
+import type { MetricType } from './MetricType';
+import {
+    MetricTypeFromJSON,
+    MetricTypeFromJSONTyped,
+    MetricTypeToJSON,
+} from './MetricType';
+
+/**
+ * Schema for creating a new Metric (excludes auto-generated fields)
+ * @export
+ * @interface MetricCreate
+ */
+export interface MetricCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricCreate
+     */
+    description?: string | null;
+    /**
+     * Direct cost of the metric
+     * @type {number}
+     * @memberof MetricCreate
+     */
+    directCost?: number;
+    /**
+     * Measurement approach
+     * @type {MeasurementType}
+     * @memberof MetricCreate
+     */
+    measurementType: MeasurementType;
+    /**
+     * Unit of measurement
+     * @type {string}
+     * @memberof MetricCreate
+     */
+    measurementUnit: string;
+    /**
+     * Type of metric
+     * @type {MetricType}
+     * @memberof MetricCreate
+     */
+    metricType: MetricType;
+    /**
+     * Name of the metric
+     * @type {string}
+     * @memberof MetricCreate
+     */
+    name: string;
+    /**
+     * ID of the associated objective
+     * @type {string}
+     * @memberof MetricCreate
+     */
+    objectiveId: string;
+    /**
+     * Perceived cost of the metric
+     * @type {number}
+     * @memberof MetricCreate
+     */
+    perceivedCost?: number;
+}
+
+/**
+ * Check if a given object implements the MetricCreate interface.
+ */
+export function instanceOfMetricCreate(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "measurementType" in value;
+    isInstance = isInstance && "measurementUnit" in value;
+    isInstance = isInstance && "metricType" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "objectiveId" in value;
+
+    return isInstance;
+}
+
+export function MetricCreateFromJSON(json: any): MetricCreate {
+    return MetricCreateFromJSONTyped(json, false);
+}
+
+export function MetricCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricCreate {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'directCost': !exists(json, 'direct_cost') ? undefined : json['direct_cost'],
+        'measurementType': MeasurementTypeFromJSON(json['measurement_type']),
+        'measurementUnit': json['measurement_unit'],
+        'metricType': MetricTypeFromJSON(json['metric_type']),
+        'name': json['name'],
+        'objectiveId': json['objective_id'],
+        'perceivedCost': !exists(json, 'perceived_cost') ? undefined : json['perceived_cost'],
+    };
+}
+
+export function MetricCreateToJSON(value?: MetricCreate | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'description': value.description,
+        'direct_cost': value.directCost,
+        'measurement_type': MeasurementTypeToJSON(value.measurementType),
+        'measurement_unit': value.measurementUnit,
+        'metric_type': MetricTypeToJSON(value.metricType),
+        'name': value.name,
+        'objective_id': value.objectiveId,
+        'perceived_cost': value.perceivedCost,
+    };
+}
+

package/src/models/MetricResponse.ts

@@ -0,0 +1,174 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { MeasurementType } from './MeasurementType';
+import {
+    MeasurementTypeFromJSON,
+    MeasurementTypeFromJSONTyped,
+    MeasurementTypeToJSON,
+} from './MeasurementType';
+import type { MetricType } from './MetricType';
+import {
+    MetricTypeFromJSON,
+    MetricTypeFromJSONTyped,
+    MetricTypeToJSON,
+} from './MetricType';
+
+/**
+ * Schema for Metric responses (includes all fields)
+ * @export
+ * @interface MetricResponse
+ */
+export interface MetricResponse {
+    /**
+     * 
+     * @type {Date}
+     * @memberof MetricResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricResponse
+     */
+    description?: string | null;
+    /**
+     * Direct cost of the metric
+     * @type {number}
+     * @memberof MetricResponse
+     */
+    directCost?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricResponse
+     */
+    id: string;
+    /**
+     * Measurement approach
+     * @type {MeasurementType}
+     * @memberof MetricResponse
+     */
+    measurementType: MeasurementType;
+    /**
+     * Unit of measurement
+     * @type {string}
+     * @memberof MetricResponse
+     */
+    measurementUnit: string;
+    /**
+     * Type of metric
+     * @type {MetricType}
+     * @memberof MetricResponse
+     */
+    metricType: MetricType;
+    /**
+     * Name of the metric
+     * @type {string}
+     * @memberof MetricResponse
+     */
+    name: string;
+    /**
+     * ID of the associated objective
+     * @type {string}
+     * @memberof MetricResponse
+     */
+    objectiveId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricResponse
+     */
+    ownerName?: string | null;
+    /**
+     * Perceived cost of the metric
+     * @type {number}
+     * @memberof MetricResponse
+     */
+    perceivedCost?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof MetricResponse
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the MetricResponse interface.
+ */
+export function instanceOfMetricResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "measurementType" in value;
+    isInstance = isInstance && "measurementUnit" in value;
+    isInstance = isInstance && "metricType" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "objectiveId" in value;
+    isInstance = isInstance && "updatedAt" in value;
+
+    return isInstance;
+}
+
+export function MetricResponseFromJSON(json: any): MetricResponse {
+    return MetricResponseFromJSONTyped(json, false);
+}
+
+export function MetricResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'createdAt': (new Date(json['created_at'])),
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'directCost': !exists(json, 'direct_cost') ? undefined : json['direct_cost'],
+        'id': json['id'],
+        'measurementType': MeasurementTypeFromJSON(json['measurement_type']),
+        'measurementUnit': json['measurement_unit'],
+        'metricType': MetricTypeFromJSON(json['metric_type']),
+        'name': json['name'],
+        'objectiveId': json['objective_id'],
+        'ownerName': !exists(json, 'owner_name') ? undefined : json['owner_name'],
+        'perceivedCost': !exists(json, 'perceived_cost') ? undefined : json['perceived_cost'],
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function MetricResponseToJSON(value?: MetricResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'created_at': (value.createdAt.toISOString()),
+        'description': value.description,
+        'direct_cost': value.directCost,
+        'id': value.id,
+        'measurement_type': MeasurementTypeToJSON(value.measurementType),
+        'measurement_unit': value.measurementUnit,
+        'metric_type': MetricTypeToJSON(value.metricType),
+        'name': value.name,
+        'objective_id': value.objectiveId,
+        'owner_name': value.ownerName,
+        'perceived_cost': value.perceivedCost,
+        'updated_at': (value.updatedAt.toISOString()),
+    };
+}
+

package/src/models/MetricType.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const MetricType = {
+    MONETIZED: 'monetized',
+    TRACKED: 'tracked',
+    BOUNDED: 'bounded'
+} as const;
+export type MetricType = typeof MetricType[keyof typeof MetricType];
+
+
+export function MetricTypeFromJSON(json: any): MetricType {
+    return MetricTypeFromJSONTyped(json, false);
+}
+
+export function MetricTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricType {
+    return json as MetricType;
+}
+
+export function MetricTypeToJSON(value?: MetricType | null): any {
+    return value as any;
+}
+

package/src/models/MetricUpdate.ts

@@ -0,0 +1,134 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { MeasurementType } from './MeasurementType';
+import {
+    MeasurementTypeFromJSON,
+    MeasurementTypeFromJSONTyped,
+    MeasurementTypeToJSON,
+} from './MeasurementType';
+import type { MetricType } from './MetricType';
+import {
+    MetricTypeFromJSON,
+    MetricTypeFromJSONTyped,
+    MetricTypeToJSON,
+} from './MetricType';
+
+/**
+ * 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 {number}
+     * @memberof MetricUpdate
+     */
+    directCost?: number | null;
+    /**
+     * 
+     * @type {MeasurementType}
+     * @memberof MetricUpdate
+     */
+    measurementType?: MeasurementType | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricUpdate
+     */
+    measurementUnit?: string | null;
+    /**
+     * 
+     * @type {MetricType}
+     * @memberof MetricUpdate
+     */
+    metricType?: MetricType | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricUpdate
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricUpdate
+     */
+    objectiveId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof MetricUpdate
+     */
+    perceivedCost?: number | null;
+}
+
+/**
+ * Check if a given object implements the MetricUpdate interface.
+ */
+export function instanceOfMetricUpdate(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function MetricUpdateFromJSON(json: any): MetricUpdate {
+    return MetricUpdateFromJSONTyped(json, false);
+}
+
+export function MetricUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricUpdate {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'directCost': !exists(json, 'direct_cost') ? undefined : json['direct_cost'],
+        'measurementType': !exists(json, 'measurement_type') ? undefined : MeasurementTypeFromJSON(json['measurement_type']),
+        'measurementUnit': !exists(json, 'measurement_unit') ? undefined : json['measurement_unit'],
+        'metricType': !exists(json, 'metric_type') ? undefined : MetricTypeFromJSON(json['metric_type']),
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'objectiveId': !exists(json, 'objective_id') ? undefined : json['objective_id'],
+        'perceivedCost': !exists(json, 'perceived_cost') ? undefined : json['perceived_cost'],
+    };
+}
+
+export function MetricUpdateToJSON(value?: MetricUpdate | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'description': value.description,
+        'direct_cost': value.directCost,
+        'measurement_type': MeasurementTypeToJSON(value.measurementType),
+        'measurement_unit': value.measurementUnit,
+        'metric_type': MetricTypeToJSON(value.metricType),
+        'name': value.name,
+        'objective_id': value.objectiveId,
+        'perceived_cost': value.perceivedCost,
+    };
+}
+

package/src/models/ObjectiveCreate.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 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;
+}
+
+/**
+ * Check if a given object implements the ObjectiveCreate interface.
+ */
+export function instanceOfObjectiveCreate(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+
+    return isInstance;
+}
+
+export function ObjectiveCreateFromJSON(json: any): ObjectiveCreate {
+    return ObjectiveCreateFromJSONTyped(json, false);
+}
+
+export function ObjectiveCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ObjectiveCreate {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'name': json['name'],
+    };
+}
+
+export function ObjectiveCreateToJSON(value?: ObjectiveCreate | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'description': value.description,
+        'name': value.name,
+    };
+}
+

package/src/models/ObjectiveResponse.ts

@@ -0,0 +1,109 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.1.0-rc1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * Schema for Objective responses (includes all fields)
+ * @export
+ * @interface ObjectiveResponse
+ */
+export interface ObjectiveResponse {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ObjectiveResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @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
+     */
+    ownerName?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ObjectiveResponse
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the ObjectiveResponse interface.
+ */
+export function instanceOfObjectiveResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "updatedAt" in value;
+
+    return isInstance;
+}
+
+export function ObjectiveResponseFromJSON(json: any): ObjectiveResponse {
+    return ObjectiveResponseFromJSONTyped(json, false);
+}
+
+export function ObjectiveResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ObjectiveResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'createdAt': (new Date(json['created_at'])),
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'id': json['id'],
+        'name': json['name'],
+        'ownerName': !exists(json, 'owner_name') ? undefined : json['owner_name'],
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function ObjectiveResponseToJSON(value?: ObjectiveResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'created_at': (value.createdAt.toISOString()),
+        'description': value.description,
+        'id': value.id,
+        'name': value.name,
+        'owner_name': value.ownerName,
+        'updated_at': (value.updatedAt.toISOString()),
+    };
+}
+