@cosmotech/aip-client 0.0.1-rc1

package/src/apis/ValueFrameworkApi.ts

@@ -0,0 +1,256 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ValueFrameworkCreate,
+  ValueFrameworkResponse,
+  ValueFrameworkUpdate,
+} from '../models/index';
+import {
+    ValueFrameworkCreateFromJSON,
+    ValueFrameworkCreateToJSON,
+    ValueFrameworkResponseFromJSON,
+    ValueFrameworkResponseToJSON,
+    ValueFrameworkUpdateFromJSON,
+    ValueFrameworkUpdateToJSON,
+} from '../models/index';
+
+export interface DeleteValueFrameworkValueFrameworkValueFrameworkIdDeleteRequest {
+    valueFrameworkId: string;
+}
+
+export interface GetValueFrameworkByIdValueFrameworkValueFrameworkIdGetRequest {
+    valueFrameworkId: string;
+}
+
+export interface GetValueFrameworksValueFrameworkGetRequest {
+    offset?: number;
+    limit?: number;
+}
+
+export interface PatchValueFrameworkValueFrameworkValueFrameworkIdPatchRequest {
+    valueFrameworkId: string;
+    valueFrameworkUpdate: ValueFrameworkUpdate;
+}
+
+export interface PostValueFrameworkValueFrameworkPostRequest {
+    valueFrameworkCreate: ValueFrameworkCreate;
+}
+
+/**
+ * 
+ */
+export class ValueFrameworkApi extends runtime.BaseAPI {
+
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * Delete a value framework
+     */
+    async deleteValueFrameworkValueFrameworkValueFrameworkIdDeleteRaw(requestParameters: DeleteValueFrameworkValueFrameworkValueFrameworkIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.valueFrameworkId === null || requestParameters.valueFrameworkId === undefined) {
+            throw new runtime.RequiredError('valueFrameworkId','Required parameter requestParameters.valueFrameworkId was null or undefined when calling deleteValueFrameworkValueFrameworkValueFrameworkIdDelete.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/value_framework/{value_framework_id}`.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(requestParameters.valueFrameworkId))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
+     * Delete a value framework
+     */
+    async deleteValueFrameworkValueFrameworkValueFrameworkIdDelete(requestParameters: DeleteValueFrameworkValueFrameworkValueFrameworkIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteValueFrameworkValueFrameworkValueFrameworkIdDeleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieve a single value framework by its ID.
+     * Get a value framework by ID
+     */
+    async getValueFrameworkByIdValueFrameworkValueFrameworkIdGetRaw(requestParameters: GetValueFrameworkByIdValueFrameworkValueFrameworkIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValueFrameworkResponse>> {
+        if (requestParameters.valueFrameworkId === null || requestParameters.valueFrameworkId === undefined) {
+            throw new runtime.RequiredError('valueFrameworkId','Required parameter requestParameters.valueFrameworkId was null or undefined when calling getValueFrameworkByIdValueFrameworkValueFrameworkIdGet.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/value_framework/{value_framework_id}`.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(requestParameters.valueFrameworkId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ValueFrameworkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a single value framework by its ID.
+     * Get a value framework by ID
+     */
+    async getValueFrameworkByIdValueFrameworkValueFrameworkIdGet(requestParameters: GetValueFrameworkByIdValueFrameworkValueFrameworkIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValueFrameworkResponse> {
+        const response = await this.getValueFrameworkByIdValueFrameworkValueFrameworkIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * List value frameworks
+     */
+    async getValueFrameworksValueFrameworkGetRaw(requestParameters: GetValueFrameworksValueFrameworkGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ValueFrameworkResponse>>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/value_framework/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ValueFrameworkResponseFromJSON));
+    }
+
+    /**
+     * Retrieve a paginated list of all value frameworks.
+     * List value frameworks
+     */
+    async getValueFrameworksValueFrameworkGet(requestParameters: GetValueFrameworksValueFrameworkGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ValueFrameworkResponse>> {
+        const response = await this.getValueFrameworksValueFrameworkGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * Partially update a value framework
+     */
+    async patchValueFrameworkValueFrameworkValueFrameworkIdPatchRaw(requestParameters: PatchValueFrameworkValueFrameworkValueFrameworkIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValueFrameworkResponse>> {
+        if (requestParameters.valueFrameworkId === null || requestParameters.valueFrameworkId === undefined) {
+            throw new runtime.RequiredError('valueFrameworkId','Required parameter requestParameters.valueFrameworkId was null or undefined when calling patchValueFrameworkValueFrameworkValueFrameworkIdPatch.');
+        }
+
+        if (requestParameters.valueFrameworkUpdate === null || requestParameters.valueFrameworkUpdate === undefined) {
+            throw new runtime.RequiredError('valueFrameworkUpdate','Required parameter requestParameters.valueFrameworkUpdate was null or undefined when calling patchValueFrameworkValueFrameworkValueFrameworkIdPatch.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/value_framework/{value_framework_id}`.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(requestParameters.valueFrameworkId))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ValueFrameworkUpdateToJSON(requestParameters.valueFrameworkUpdate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ValueFrameworkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+     * Partially update a value framework
+     */
+    async patchValueFrameworkValueFrameworkValueFrameworkIdPatch(requestParameters: PatchValueFrameworkValueFrameworkValueFrameworkIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValueFrameworkResponse> {
+        const response = await this.patchValueFrameworkValueFrameworkValueFrameworkIdPatchRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * Create a value framework
+     */
+    async postValueFrameworkValueFrameworkPostRaw(requestParameters: PostValueFrameworkValueFrameworkPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValueFrameworkResponse>> {
+        if (requestParameters.valueFrameworkCreate === null || requestParameters.valueFrameworkCreate === undefined) {
+            throw new runtime.RequiredError('valueFrameworkCreate','Required parameter requestParameters.valueFrameworkCreate was null or undefined when calling postValueFrameworkValueFrameworkPost.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2AuthorizationCodeBearer", []);
+        }
+
+        const response = await this.request({
+            path: `/value_framework/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ValueFrameworkCreateToJSON(requestParameters.valueFrameworkCreate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ValueFrameworkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new value framework. Name must be unique and non-empty.
+     * Create a value framework
+     */
+    async postValueFrameworkValueFrameworkPost(requestParameters: PostValueFrameworkValueFrameworkPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValueFrameworkResponse> {
+        const response = await this.postValueFrameworkValueFrameworkPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,8 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './DefaultApi';
+export * from './MetricApi';
+export * from './MetricCostsPerYearApi';
+export * from './ObjectiveApi';
+export * from './ObjectiveWeightApi';
+export * from './ValueFrameworkApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/HTTPValidationError.ts

@@ -0,0 +1,72 @@
+/* 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 { ValidationError } from './ValidationError';
+import {
+    ValidationErrorFromJSON,
+    ValidationErrorFromJSONTyped,
+    ValidationErrorToJSON,
+} from './ValidationError';
+
+/**
+ * 
+ * @export
+ * @interface HTTPValidationError
+ */
+export interface HTTPValidationError {
+    /**
+     * 
+     * @type {Array<ValidationError>}
+     * @memberof HTTPValidationError
+     */
+    detail?: Array<ValidationError>;
+}
+
+/**
+ * Check if a given object implements the HTTPValidationError interface.
+ */
+export function instanceOfHTTPValidationError(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function HTTPValidationErrorFromJSON(json: any): HTTPValidationError {
+    return HTTPValidationErrorFromJSONTyped(json, false);
+}
+
+export function HTTPValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): HTTPValidationError {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'detail': !exists(json, 'detail') ? undefined : ((json['detail'] as Array<any>).map(ValidationErrorFromJSON)),
+    };
+}
+
+export function HTTPValidationErrorToJSON(value?: HTTPValidationError | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'detail': value.detail === undefined ? undefined : ((value.detail as Array<any>).map(ValidationErrorToJSON)),
+    };
+}
+

package/src/models/MeasurementType.ts

@@ -0,0 +1,38 @@
+/* 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 MeasurementType = {
+    MAXIMIZATION: 'maximization',
+    MINIMIZATION: 'minimization'
+} as const;
+export type MeasurementType = typeof MeasurementType[keyof typeof MeasurementType];
+
+
+export function MeasurementTypeFromJSON(json: any): MeasurementType {
+    return MeasurementTypeFromJSONTyped(json, false);
+}
+
+export function MeasurementTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): MeasurementType {
+    return json as MeasurementType;
+}
+
+export function MeasurementTypeToJSON(value?: MeasurementType | null): any {
+    return value as any;
+}
+

package/src/models/MetricCostsPerYearCreate.ts

@@ -0,0 +1,102 @@
+/* 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 MetricCostsPerYear
+ * @export
+ * @interface MetricCostsPerYearCreate
+ */
+export interface MetricCostsPerYearCreate {
+    /**
+     * Direct cost for the year
+     * @type {number}
+     * @memberof MetricCostsPerYearCreate
+     */
+    directCost: number;
+    /**
+     * ID of the value framework
+     * @type {string}
+     * @memberof MetricCostsPerYearCreate
+     */
+    frameworkId: string;
+    /**
+     * ID of the metric
+     * @type {string}
+     * @memberof MetricCostsPerYearCreate
+     */
+    metricId: string;
+    /**
+     * Perceived cost for the year
+     * @type {number}
+     * @memberof MetricCostsPerYearCreate
+     */
+    perceivedCost: number;
+    /**
+     * Year for the cost data
+     * @type {number}
+     * @memberof MetricCostsPerYearCreate
+     */
+    year: number;
+}
+
+/**
+ * Check if a given object implements the MetricCostsPerYearCreate interface.
+ */
+export function instanceOfMetricCostsPerYearCreate(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "directCost" in value;
+    isInstance = isInstance && "frameworkId" in value;
+    isInstance = isInstance && "metricId" in value;
+    isInstance = isInstance && "perceivedCost" in value;
+    isInstance = isInstance && "year" in value;
+
+    return isInstance;
+}
+
+export function MetricCostsPerYearCreateFromJSON(json: any): MetricCostsPerYearCreate {
+    return MetricCostsPerYearCreateFromJSONTyped(json, false);
+}
+
+export function MetricCostsPerYearCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricCostsPerYearCreate {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'directCost': json['direct_cost'],
+        'frameworkId': json['framework_id'],
+        'metricId': json['metric_id'],
+        'perceivedCost': json['perceived_cost'],
+        'year': json['year'],
+    };
+}
+
+export function MetricCostsPerYearCreateToJSON(value?: MetricCostsPerYearCreate | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'direct_cost': value.directCost,
+        'framework_id': value.frameworkId,
+        'metric_id': value.metricId,
+        'perceived_cost': value.perceivedCost,
+        'year': value.year,
+    };
+}
+

package/src/models/MetricCostsPerYearResponse.ts

@@ -0,0 +1,110 @@
+/* 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 MetricCostsPerYear responses
+ * @export
+ * @interface MetricCostsPerYearResponse
+ */
+export interface MetricCostsPerYearResponse {
+    /**
+     * Direct cost for the year
+     * @type {number}
+     * @memberof MetricCostsPerYearResponse
+     */
+    directCost: number;
+    /**
+     * ID of the value framework
+     * @type {string}
+     * @memberof MetricCostsPerYearResponse
+     */
+    frameworkId: string;
+    /**
+     * ID of the metric
+     * @type {string}
+     * @memberof MetricCostsPerYearResponse
+     */
+    metricId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetricCostsPerYearResponse
+     */
+    ownerName?: string | null;
+    /**
+     * Perceived cost for the year
+     * @type {number}
+     * @memberof MetricCostsPerYearResponse
+     */
+    perceivedCost: number;
+    /**
+     * Year for the cost data
+     * @type {number}
+     * @memberof MetricCostsPerYearResponse
+     */
+    year: number;
+}
+
+/**
+ * Check if a given object implements the MetricCostsPerYearResponse interface.
+ */
+export function instanceOfMetricCostsPerYearResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "directCost" in value;
+    isInstance = isInstance && "frameworkId" in value;
+    isInstance = isInstance && "metricId" in value;
+    isInstance = isInstance && "perceivedCost" in value;
+    isInstance = isInstance && "year" in value;
+
+    return isInstance;
+}
+
+export function MetricCostsPerYearResponseFromJSON(json: any): MetricCostsPerYearResponse {
+    return MetricCostsPerYearResponseFromJSONTyped(json, false);
+}
+
+export function MetricCostsPerYearResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricCostsPerYearResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'directCost': json['direct_cost'],
+        'frameworkId': json['framework_id'],
+        'metricId': json['metric_id'],
+        'ownerName': !exists(json, 'owner_name') ? undefined : json['owner_name'],
+        'perceivedCost': json['perceived_cost'],
+        'year': json['year'],
+    };
+}
+
+export function MetricCostsPerYearResponseToJSON(value?: MetricCostsPerYearResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'direct_cost': value.directCost,
+        'framework_id': value.frameworkId,
+        'metric_id': value.metricId,
+        'owner_name': value.ownerName,
+        'perceived_cost': value.perceivedCost,
+        'year': value.year,
+    };
+}
+

package/src/models/MetricCostsPerYearUpdate.ts

@@ -0,0 +1,73 @@
+/* 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 partially updating Metric Costs Per Year. Only cost fields can be updated.
+ * @export
+ * @interface MetricCostsPerYearUpdate
+ */
+export interface MetricCostsPerYearUpdate {
+    /**
+     * 
+     * @type {number}
+     * @memberof MetricCostsPerYearUpdate
+     */
+    directCost?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof MetricCostsPerYearUpdate
+     */
+    perceivedCost?: number | null;
+}
+
+/**
+ * Check if a given object implements the MetricCostsPerYearUpdate interface.
+ */
+export function instanceOfMetricCostsPerYearUpdate(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function MetricCostsPerYearUpdateFromJSON(json: any): MetricCostsPerYearUpdate {
+    return MetricCostsPerYearUpdateFromJSONTyped(json, false);
+}
+
+export function MetricCostsPerYearUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): MetricCostsPerYearUpdate {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'directCost': !exists(json, 'direct_cost') ? undefined : json['direct_cost'],
+        'perceivedCost': !exists(json, 'perceived_cost') ? undefined : json['perceived_cost'],
+    };
+}
+
+export function MetricCostsPerYearUpdateToJSON(value?: MetricCostsPerYearUpdate | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'direct_cost': value.directCost,
+        'perceived_cost': value.perceivedCost,
+    };
+}
+