/** * Deep Lynx * The construction of megaprojects has consistently demonstrated challenges for project managers in regard to meeting cost, schedule, and performance requirements. Megaproject construction challenges are common place within megaprojects with many active projects in the United States failing to meet cost and schedule efforts by significant margins. Currently, engineering teams operate in siloed tools and disparate teams where connections across design, procurement, and construction systems are translated manually or over brittle point-to-point integrations. The manual nature of data exchange increases the risk of silent errors in the reactor design, with each silent error cascading across the design. These cascading errors lead to uncontrollable risk during construction, resulting in significant delays and cost overruns. Deep Lynx allows for an integrated platform during design and operations of mega projects. The Deep Lynx Core API delivers a few main features. 1. Provides a set of methods and endpoints for manipulating data in an object oriented database. This allows us to store complex datatypes as records and then to compile them into actual, modifiable objects at run-time. Users can store taxonomies or ontologies in a readable format. 2. Provides methods for storing and retrieving data in a graph database. This data is structured and validated against the aformentioned object oriented database before storage. * * OpenAPI spec version: 1.0 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { CreateMetatypeRequest } from '../models'; import { CreateMetatypesResponse } from '../models'; import { Generic200Response } from '../models'; import { GetMetatypeResponse } from '../models'; import { ListMetatypesResponse } from '../models'; import { UpdateMetatypeRequest } from '../models'; import { UpdateMetatypeResponse } from '../models'; import { ValidateMetatypePropertiesRequest } from '../models'; import { ValidateMetatypePropertiesResponse } from '../models'; /** * MetatypesApi - axios parameter creator * @export */ export declare const MetatypesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Archives the metatype. This is preferred over deletion as deletion has a cascading effect on the deleted metatype's keys, relationships, and relationship keys. When in doubt, archive over delete. We'd rather have tombstones than cremating the metatype. * @summary Archive Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveMetatype: (containerId: string, metatypeId: string, options?: any) => Promise; /** * Create a new metatype. Pass in an array for bulk creation. * @summary Create Metatype * @param {CreateMetatypeRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetatype: (body: CreateMetatypeRequest, containerId: string, options?: any) => Promise; /** * List all metatypes that the container has access to. * @summary List Metatypes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [name] Filter metatypes with names that match this pattern * @param {string} [description] Filter metatypes with descriptions that match this pattern * @param {string} [count] Set to true to return an integer count of the number of metatypes * @param {string} [loadKeys] Set to false to not return the keys for the selected metatypes (true by default) * @param {string} [sortBy] Supply the name of a metatype attribute (name, created_at, etc) by which to sort * @param {string} [sortDesc] Set true to sort descending * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMetatypes: (containerId: string, limit?: number, offset?: number, name?: string, description?: string, count?: string, loadKeys?: string, sortBy?: string, sortDesc?: string, options?: any) => Promise; /** * Retrieves a single metatype. * @summary Retrieve Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveMetaype: (containerId: string, metatypeId: string, options?: any) => Promise; /** * Update a single Metatype in storage. Will fail if the updated name has already been taken. * @summary Update Metatype * @param {UpdateMetatypeRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMetatype: (body: UpdateMetatypeRequest, containerId: string, metatypeId: string, options?: any) => Promise; /** * Returns any errors associated with the intended properties or keys for a metatype or else the data itself if no errors are present. * @summary Validate Metatype Properties * @param {string} containerId * @param {string} metatypeId * @param {ValidateMetatypePropertiesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateMetatypeProperties: (containerId: string, metatypeId: string, body?: ValidateMetatypePropertiesRequest, options?: any) => Promise; }; /** * MetatypesApi - functional programming interface * @export */ export declare const MetatypesApiFp: (configuration?: Configuration) => { /** * Archives the metatype. This is preferred over deletion as deletion has a cascading effect on the deleted metatype's keys, relationships, and relationship keys. When in doubt, archive over delete. We'd rather have tombstones than cremating the metatype. * @summary Archive Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveMetatype(containerId: string, metatypeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new metatype. Pass in an array for bulk creation. * @summary Create Metatype * @param {CreateMetatypeRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetatype(body: CreateMetatypeRequest, containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all metatypes that the container has access to. * @summary List Metatypes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [name] Filter metatypes with names that match this pattern * @param {string} [description] Filter metatypes with descriptions that match this pattern * @param {string} [count] Set to true to return an integer count of the number of metatypes * @param {string} [loadKeys] Set to false to not return the keys for the selected metatypes (true by default) * @param {string} [sortBy] Supply the name of a metatype attribute (name, created_at, etc) by which to sort * @param {string} [sortDesc] Set true to sort descending * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMetatypes(containerId: string, limit?: number, offset?: number, name?: string, description?: string, count?: string, loadKeys?: string, sortBy?: string, sortDesc?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a single metatype. * @summary Retrieve Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveMetaype(containerId: string, metatypeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a single Metatype in storage. Will fail if the updated name has already been taken. * @summary Update Metatype * @param {UpdateMetatypeRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMetatype(body: UpdateMetatypeRequest, containerId: string, metatypeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns any errors associated with the intended properties or keys for a metatype or else the data itself if no errors are present. * @summary Validate Metatype Properties * @param {string} containerId * @param {string} metatypeId * @param {ValidateMetatypePropertiesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateMetatypeProperties(containerId: string, metatypeId: string, body?: ValidateMetatypePropertiesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetatypesApi - factory interface * @export */ export declare const MetatypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Archives the metatype. This is preferred over deletion as deletion has a cascading effect on the deleted metatype's keys, relationships, and relationship keys. When in doubt, archive over delete. We'd rather have tombstones than cremating the metatype. * @summary Archive Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveMetatype(containerId: string, metatypeId: string, options?: any): AxiosPromise; /** * Create a new metatype. Pass in an array for bulk creation. * @summary Create Metatype * @param {CreateMetatypeRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetatype(body: CreateMetatypeRequest, containerId: string, options?: any): AxiosPromise; /** * List all metatypes that the container has access to. * @summary List Metatypes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [name] Filter metatypes with names that match this pattern * @param {string} [description] Filter metatypes with descriptions that match this pattern * @param {string} [count] Set to true to return an integer count of the number of metatypes * @param {string} [loadKeys] Set to false to not return the keys for the selected metatypes (true by default) * @param {string} [sortBy] Supply the name of a metatype attribute (name, created_at, etc) by which to sort * @param {string} [sortDesc] Set true to sort descending * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMetatypes(containerId: string, limit?: number, offset?: number, name?: string, description?: string, count?: string, loadKeys?: string, sortBy?: string, sortDesc?: string, options?: any): AxiosPromise; /** * Retrieves a single metatype. * @summary Retrieve Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveMetaype(containerId: string, metatypeId: string, options?: any): AxiosPromise; /** * Update a single Metatype in storage. Will fail if the updated name has already been taken. * @summary Update Metatype * @param {UpdateMetatypeRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMetatype(body: UpdateMetatypeRequest, containerId: string, metatypeId: string, options?: any): AxiosPromise; /** * Returns any errors associated with the intended properties or keys for a metatype or else the data itself if no errors are present. * @summary Validate Metatype Properties * @param {string} containerId * @param {string} metatypeId * @param {ValidateMetatypePropertiesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateMetatypeProperties(containerId: string, metatypeId: string, body?: ValidateMetatypePropertiesRequest, options?: any): AxiosPromise; }; /** * MetatypesApi - object-oriented interface * @export * @class MetatypesApi * @extends {BaseAPI} */ export declare class MetatypesApi extends BaseAPI { /** * Archives the metatype. This is preferred over deletion as deletion has a cascading effect on the deleted metatype's keys, relationships, and relationship keys. When in doubt, archive over delete. We'd rather have tombstones than cremating the metatype. * @summary Archive Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypesApi */ archiveMetatype(containerId: string, metatypeId: string, options?: any): Promise>; /** * Create a new metatype. Pass in an array for bulk creation. * @summary Create Metatype * @param {CreateMetatypeRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypesApi */ createMetatype(body: CreateMetatypeRequest, containerId: string, options?: any): Promise>; /** * List all metatypes that the container has access to. * @summary List Metatypes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [name] Filter metatypes with names that match this pattern * @param {string} [description] Filter metatypes with descriptions that match this pattern * @param {string} [count] Set to true to return an integer count of the number of metatypes * @param {string} [loadKeys] Set to false to not return the keys for the selected metatypes (true by default) * @param {string} [sortBy] Supply the name of a metatype attribute (name, created_at, etc) by which to sort * @param {string} [sortDesc] Set true to sort descending * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypesApi */ listMetatypes(containerId: string, limit?: number, offset?: number, name?: string, description?: string, count?: string, loadKeys?: string, sortBy?: string, sortDesc?: string, options?: any): Promise>; /** * Retrieves a single metatype. * @summary Retrieve Metatype * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypesApi */ retrieveMetaype(containerId: string, metatypeId: string, options?: any): Promise>; /** * Update a single Metatype in storage. Will fail if the updated name has already been taken. * @summary Update Metatype * @param {UpdateMetatypeRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypesApi */ updateMetatype(body: UpdateMetatypeRequest, containerId: string, metatypeId: string, options?: any): Promise>; /** * Returns any errors associated with the intended properties or keys for a metatype or else the data itself if no errors are present. * @summary Validate Metatype Properties * @param {string} containerId * @param {string} metatypeId * @param {ValidateMetatypePropertiesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypesApi */ validateMetatypeProperties(containerId: string, metatypeId: string, body?: ValidateMetatypePropertiesRequest, options?: any): Promise>; }