/** * 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 { CreateOrUpdateEdgesRequest } from '../models'; import { CreateOrUpdateNodesRequest } from '../models'; import { Generic200Response } from '../models'; import { GetEdgeResponse } from '../models'; import { GetNodeResponse } from '../models'; import { ListEdgeFiles } from '../models'; import { ListEdgesResponse } from '../models'; import { ListNodeFiles } from '../models'; import { ListNodesByMetatypeResponse } from '../models'; import { ListNodesResponse } from '../models'; /** * GraphApi - axios parameter creator * @export */ export declare const GraphApiAxiosParamCreator: (configuration?: Configuration) => { /** * Archives an edge * @summary Archive Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveEdge: (containerId: string, edgeId: string, options?: any) => Promise; /** * Archives a node * @summary Archive Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveNode: (containerId: string, nodeId: string, options?: any) => Promise; /** * Attach a file to an edge. * @summary Attach Edge File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachEdgeFile: (containerId: string, fileId: string, edgeId: string, options?: any) => Promise; /** * Attach a file to a node. * @summary Attach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachNodeFile: (containerId: string, nodeId: string, fileId: string, options?: any) => Promise; /** * This endpoint will attempt to create a connection between two nodes. You can either pass in the node's Deep Lynx IDs, or the node's original id, metatype id, and data source id to create these edges. * @summary Create or Update Edges * @param {string} containerId * @param {CreateOrUpdateEdgesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateEdges: (containerId: string, body?: CreateOrUpdateEdgesRequest, options?: any) => Promise; /** * This endpoint will either create new nodes or update nodes if one with the same original_id is passed. * @summary Create Or Update Nodes * @param {CreateOrUpdateNodesRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateNodes: (body: CreateOrUpdateNodesRequest, containerId: string, options?: any) => Promise; /** * Detach file from node * @summary Detach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNodeFile: (containerId: string, nodeId: string, fileId: string, options?: any) => Promise; /** * Detach file from an edge. * @summary Detach Node File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ detachNodeFile: (containerId: string, fileId: string, edgeId: string, options?: any) => Promise; /** * Lists all attached files for edge. * @summary List Edge Files * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEdgeFiles: (containerId: string, edgeId: string, options?: any) => Promise; /** * List Edges from storage * @summary List Edges * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [originID] * @param {string} [destinationID] * @param {string} [relationshipPairID] * @param {string} [relationshipPairName] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEdges: (containerId: string, limit?: number, offset?: number, originID?: string, destinationID?: string, relationshipPairID?: string, relationshipPairName?: string, options?: any) => Promise; /** * Lists all attached files for node. * @summary List Node Files * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodeFiles: (containerId: string, nodeId: string, options?: any) => Promise; /** * List nodes * @summary List Nodes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [transformationID] Return only nodes for the selected type transformation * @param {string} [metatypeID] Return only nodes for the selected metatype * @param {string} [dataSourceID] Return only nodes for the selected datasource * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodes: (containerId: string, limit?: number, offset?: number, transformationID?: string, metatypeID?: string, dataSourceID?: string, options?: any) => Promise; /** * List Nodes, filter by MetatypeID * @summary List Nodes By Metatype ID * @param {string} containerId * @param {string} metatypeId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodesByMetatypeID: (containerId: string, metatypeId: string, limit?: number, offset?: number, options?: any) => Promise; /** * Retrieve a single edge * @summary Retrieve Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveEdge: (containerId: string, edgeId: string, options?: any) => Promise; /** * Retrieve a single node from storage. * @summary Retrieve Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNode: (containerId: string, nodeId: string, options?: any) => Promise; }; /** * GraphApi - functional programming interface * @export */ export declare const GraphApiFp: (configuration?: Configuration) => { /** * Archives an edge * @summary Archive Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveEdge(containerId: string, edgeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Archives a node * @summary Archive Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveNode(containerId: string, nodeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Attach a file to an edge. * @summary Attach Edge File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachEdgeFile(containerId: string, fileId: string, edgeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Attach a file to a node. * @summary Attach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachNodeFile(containerId: string, nodeId: string, fileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint will attempt to create a connection between two nodes. You can either pass in the node's Deep Lynx IDs, or the node's original id, metatype id, and data source id to create these edges. * @summary Create or Update Edges * @param {string} containerId * @param {CreateOrUpdateEdgesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateEdges(containerId: string, body?: CreateOrUpdateEdgesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint will either create new nodes or update nodes if one with the same original_id is passed. * @summary Create Or Update Nodes * @param {CreateOrUpdateNodesRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateNodes(body: CreateOrUpdateNodesRequest, containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Detach file from node * @summary Detach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNodeFile(containerId: string, nodeId: string, fileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Detach file from an edge. * @summary Detach Node File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ detachNodeFile(containerId: string, fileId: string, edgeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all attached files for edge. * @summary List Edge Files * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEdgeFiles(containerId: string, edgeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Edges from storage * @summary List Edges * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [originID] * @param {string} [destinationID] * @param {string} [relationshipPairID] * @param {string} [relationshipPairName] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEdges(containerId: string, limit?: number, offset?: number, originID?: string, destinationID?: string, relationshipPairID?: string, relationshipPairName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all attached files for node. * @summary List Node Files * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodeFiles(containerId: string, nodeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List nodes * @summary List Nodes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [transformationID] Return only nodes for the selected type transformation * @param {string} [metatypeID] Return only nodes for the selected metatype * @param {string} [dataSourceID] Return only nodes for the selected datasource * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodes(containerId: string, limit?: number, offset?: number, transformationID?: string, metatypeID?: string, dataSourceID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Nodes, filter by MetatypeID * @summary List Nodes By Metatype ID * @param {string} containerId * @param {string} metatypeId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodesByMetatypeID(containerId: string, metatypeId: string, limit?: number, offset?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single edge * @summary Retrieve Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveEdge(containerId: string, edgeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single node from storage. * @summary Retrieve Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNode(containerId: string, nodeId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * GraphApi - factory interface * @export */ export declare const GraphApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Archives an edge * @summary Archive Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveEdge(containerId: string, edgeId: string, options?: any): AxiosPromise; /** * Archives a node * @summary Archive Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveNode(containerId: string, nodeId: string, options?: any): AxiosPromise; /** * Attach a file to an edge. * @summary Attach Edge File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachEdgeFile(containerId: string, fileId: string, edgeId: string, options?: any): AxiosPromise; /** * Attach a file to a node. * @summary Attach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ attachNodeFile(containerId: string, nodeId: string, fileId: string, options?: any): AxiosPromise; /** * This endpoint will attempt to create a connection between two nodes. You can either pass in the node's Deep Lynx IDs, or the node's original id, metatype id, and data source id to create these edges. * @summary Create or Update Edges * @param {string} containerId * @param {CreateOrUpdateEdgesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateEdges(containerId: string, body?: CreateOrUpdateEdgesRequest, options?: any): AxiosPromise; /** * This endpoint will either create new nodes or update nodes if one with the same original_id is passed. * @summary Create Or Update Nodes * @param {CreateOrUpdateNodesRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrUpdateNodes(body: CreateOrUpdateNodesRequest, containerId: string, options?: any): AxiosPromise; /** * Detach file from node * @summary Detach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteNodeFile(containerId: string, nodeId: string, fileId: string, options?: any): AxiosPromise; /** * Detach file from an edge. * @summary Detach Node File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ detachNodeFile(containerId: string, fileId: string, edgeId: string, options?: any): AxiosPromise; /** * Lists all attached files for edge. * @summary List Edge Files * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEdgeFiles(containerId: string, edgeId: string, options?: any): AxiosPromise; /** * List Edges from storage * @summary List Edges * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [originID] * @param {string} [destinationID] * @param {string} [relationshipPairID] * @param {string} [relationshipPairName] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEdges(containerId: string, limit?: number, offset?: number, originID?: string, destinationID?: string, relationshipPairID?: string, relationshipPairName?: string, options?: any): AxiosPromise; /** * Lists all attached files for node. * @summary List Node Files * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodeFiles(containerId: string, nodeId: string, options?: any): AxiosPromise; /** * List nodes * @summary List Nodes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [transformationID] Return only nodes for the selected type transformation * @param {string} [metatypeID] Return only nodes for the selected metatype * @param {string} [dataSourceID] Return only nodes for the selected datasource * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodes(containerId: string, limit?: number, offset?: number, transformationID?: string, metatypeID?: string, dataSourceID?: string, options?: any): AxiosPromise; /** * List Nodes, filter by MetatypeID * @summary List Nodes By Metatype ID * @param {string} containerId * @param {string} metatypeId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNodesByMetatypeID(containerId: string, metatypeId: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * Retrieve a single edge * @summary Retrieve Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveEdge(containerId: string, edgeId: string, options?: any): AxiosPromise; /** * Retrieve a single node from storage. * @summary Retrieve Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveNode(containerId: string, nodeId: string, options?: any): AxiosPromise; }; /** * GraphApi - object-oriented interface * @export * @class GraphApi * @extends {BaseAPI} */ export declare class GraphApi extends BaseAPI { /** * Archives an edge * @summary Archive Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ archiveEdge(containerId: string, edgeId: string, options?: any): Promise>; /** * Archives a node * @summary Archive Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ archiveNode(containerId: string, nodeId: string, options?: any): Promise>; /** * Attach a file to an edge. * @summary Attach Edge File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ attachEdgeFile(containerId: string, fileId: string, edgeId: string, options?: any): Promise>; /** * Attach a file to a node. * @summary Attach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ attachNodeFile(containerId: string, nodeId: string, fileId: string, options?: any): Promise>; /** * This endpoint will attempt to create a connection between two nodes. You can either pass in the node's Deep Lynx IDs, or the node's original id, metatype id, and data source id to create these edges. * @summary Create or Update Edges * @param {string} containerId * @param {CreateOrUpdateEdgesRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ createOrUpdateEdges(containerId: string, body?: CreateOrUpdateEdgesRequest, options?: any): Promise>; /** * This endpoint will either create new nodes or update nodes if one with the same original_id is passed. * @summary Create Or Update Nodes * @param {CreateOrUpdateNodesRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ createOrUpdateNodes(body: CreateOrUpdateNodesRequest, containerId: string, options?: any): Promise>; /** * Detach file from node * @summary Detach Node File * @param {string} containerId * @param {string} nodeId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ deleteNodeFile(containerId: string, nodeId: string, fileId: string, options?: any): Promise>; /** * Detach file from an edge. * @summary Detach Node File * @param {string} containerId * @param {string} fileId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ detachNodeFile(containerId: string, fileId: string, edgeId: string, options?: any): Promise>; /** * Lists all attached files for edge. * @summary List Edge Files * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ listEdgeFiles(containerId: string, edgeId: string, options?: any): Promise>; /** * List Edges from storage * @summary List Edges * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [originID] * @param {string} [destinationID] * @param {string} [relationshipPairID] * @param {string} [relationshipPairName] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ listEdges(containerId: string, limit?: number, offset?: number, originID?: string, destinationID?: string, relationshipPairID?: string, relationshipPairName?: string, options?: any): Promise>; /** * Lists all attached files for node. * @summary List Node Files * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ listNodeFiles(containerId: string, nodeId: string, options?: any): Promise>; /** * List nodes * @summary List Nodes * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {string} [transformationID] Return only nodes for the selected type transformation * @param {string} [metatypeID] Return only nodes for the selected metatype * @param {string} [dataSourceID] Return only nodes for the selected datasource * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ listNodes(containerId: string, limit?: number, offset?: number, transformationID?: string, metatypeID?: string, dataSourceID?: string, options?: any): Promise>; /** * List Nodes, filter by MetatypeID * @summary List Nodes By Metatype ID * @param {string} containerId * @param {string} metatypeId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ listNodesByMetatypeID(containerId: string, metatypeId: string, limit?: number, offset?: number, options?: any): Promise>; /** * Retrieve a single edge * @summary Retrieve Edge * @param {string} containerId * @param {string} edgeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ retrieveEdge(containerId: string, edgeId: string, options?: any): Promise>; /** * Retrieve a single node from storage. * @summary Retrieve Node * @param {string} containerId * @param {string} nodeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GraphApi */ retrieveNode(containerId: string, nodeId: string, options?: any): Promise>; }