/** * 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 { CreateMetatypeKeyRequest } from '../models'; import { CreateMetatypeKeysResponse } from '../models'; import { Generic200Response } from '../models'; import { GetMetatypeKeyResponse } from '../models'; import { ListMetatypeKeysResponse } from '../models'; import { MetatypeKey } from '../models'; import { UpdateMetatypeKeyResponse } from '../models'; /** * MetatypeKeysApi - axios parameter creator * @export */ export declare const MetatypeKeysApiAxiosParamCreator: (configuration?: Configuration) => { /** * Archiving the metatype key prevents any new types from implementing the key. It *does not remove key/value pairs on existing types*. We highly recommend you archive type keys instead of deleting them so that previous data is not affected. * @summary Archive Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveMetatypeKey: (containerId: string, metatypeId: string, keyId: string, options?: any) => Promise; /** * Creates a new key for a metatype. Keys consist of a unique key name (unique to the metatype only), key type, default values, and allowed values. Of those, only the first two are required. The `dataType` field accepts only one of the following values: number, string, date, boolean, enumeration, file. The fields `defaultValue` and `options` will only accept an array of the following types: string, boolean, number, float. Pass in an array for bulk creation. Currently the validation and cardinality functionality of keys are NOT checked at data insertion. * @summary Create Metatype Key * @param {CreateMetatypeKeyRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetatypeKey: (body: CreateMetatypeKeyRequest, containerId: string, metatypeId: string, options?: any) => Promise; /** * Lists all currently valid and available keys for the metatype. * @summary List Metatype's Keys * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMetatypesKeys: (containerId: string, metatypeId: string, options?: any) => Promise; /** * Retrieve the specified key for the metatype. * @summary Retrieve Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveMetatypeKey: (containerId: string, metatypeId: string, keyId: string, options?: any) => Promise; /** * Updates a single key for a metatype. * @summary Update Metatype Key * @param {MetatypeKey} body * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMetatypeKey: (body: MetatypeKey, containerId: string, metatypeId: string, keyId: string, options?: any) => Promise; }; /** * MetatypeKeysApi - functional programming interface * @export */ export declare const MetatypeKeysApiFp: (configuration?: Configuration) => { /** * Archiving the metatype key prevents any new types from implementing the key. It *does not remove key/value pairs on existing types*. We highly recommend you archive type keys instead of deleting them so that previous data is not affected. * @summary Archive Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveMetatypeKey(containerId: string, metatypeId: string, keyId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new key for a metatype. Keys consist of a unique key name (unique to the metatype only), key type, default values, and allowed values. Of those, only the first two are required. The `dataType` field accepts only one of the following values: number, string, date, boolean, enumeration, file. The fields `defaultValue` and `options` will only accept an array of the following types: string, boolean, number, float. Pass in an array for bulk creation. Currently the validation and cardinality functionality of keys are NOT checked at data insertion. * @summary Create Metatype Key * @param {CreateMetatypeKeyRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetatypeKey(body: CreateMetatypeKeyRequest, containerId: string, metatypeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all currently valid and available keys for the metatype. * @summary List Metatype's Keys * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMetatypesKeys(containerId: string, metatypeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the specified key for the metatype. * @summary Retrieve Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveMetatypeKey(containerId: string, metatypeId: string, keyId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a single key for a metatype. * @summary Update Metatype Key * @param {MetatypeKey} body * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMetatypeKey(body: MetatypeKey, containerId: string, metatypeId: string, keyId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetatypeKeysApi - factory interface * @export */ export declare const MetatypeKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Archiving the metatype key prevents any new types from implementing the key. It *does not remove key/value pairs on existing types*. We highly recommend you archive type keys instead of deleting them so that previous data is not affected. * @summary Archive Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveMetatypeKey(containerId: string, metatypeId: string, keyId: string, options?: any): AxiosPromise; /** * Creates a new key for a metatype. Keys consist of a unique key name (unique to the metatype only), key type, default values, and allowed values. Of those, only the first two are required. The `dataType` field accepts only one of the following values: number, string, date, boolean, enumeration, file. The fields `defaultValue` and `options` will only accept an array of the following types: string, boolean, number, float. Pass in an array for bulk creation. Currently the validation and cardinality functionality of keys are NOT checked at data insertion. * @summary Create Metatype Key * @param {CreateMetatypeKeyRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMetatypeKey(body: CreateMetatypeKeyRequest, containerId: string, metatypeId: string, options?: any): AxiosPromise; /** * Lists all currently valid and available keys for the metatype. * @summary List Metatype's Keys * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMetatypesKeys(containerId: string, metatypeId: string, options?: any): AxiosPromise; /** * Retrieve the specified key for the metatype. * @summary Retrieve Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveMetatypeKey(containerId: string, metatypeId: string, keyId: string, options?: any): AxiosPromise; /** * Updates a single key for a metatype. * @summary Update Metatype Key * @param {MetatypeKey} body * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMetatypeKey(body: MetatypeKey, containerId: string, metatypeId: string, keyId: string, options?: any): AxiosPromise; }; /** * MetatypeKeysApi - object-oriented interface * @export * @class MetatypeKeysApi * @extends {BaseAPI} */ export declare class MetatypeKeysApi extends BaseAPI { /** * Archiving the metatype key prevents any new types from implementing the key. It *does not remove key/value pairs on existing types*. We highly recommend you archive type keys instead of deleting them so that previous data is not affected. * @summary Archive Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypeKeysApi */ archiveMetatypeKey(containerId: string, metatypeId: string, keyId: string, options?: any): Promise>; /** * Creates a new key for a metatype. Keys consist of a unique key name (unique to the metatype only), key type, default values, and allowed values. Of those, only the first two are required. The `dataType` field accepts only one of the following values: number, string, date, boolean, enumeration, file. The fields `defaultValue` and `options` will only accept an array of the following types: string, boolean, number, float. Pass in an array for bulk creation. Currently the validation and cardinality functionality of keys are NOT checked at data insertion. * @summary Create Metatype Key * @param {CreateMetatypeKeyRequest} body * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypeKeysApi */ createMetatypeKey(body: CreateMetatypeKeyRequest, containerId: string, metatypeId: string, options?: any): Promise>; /** * Lists all currently valid and available keys for the metatype. * @summary List Metatype's Keys * @param {string} containerId * @param {string} metatypeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypeKeysApi */ listMetatypesKeys(containerId: string, metatypeId: string, options?: any): Promise>; /** * Retrieve the specified key for the metatype. * @summary Retrieve Metatype Key * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypeKeysApi */ retrieveMetatypeKey(containerId: string, metatypeId: string, keyId: string, options?: any): Promise>; /** * Updates a single key for a metatype. * @summary Update Metatype Key * @param {MetatypeKey} body * @param {string} containerId * @param {string} metatypeId * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetatypeKeysApi */ updateMetatypeKey(body: MetatypeKey, containerId: string, metatypeId: string, keyId: string, options?: any): Promise>; }