/** * 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 { CreateDataSourceConfig } from '../models'; import { CreateDataSourceRequest } from '../models'; import { CreateDataSourcesResponse } from '../models'; import { CreateManualImportResponse } from '../models'; import { Generic200Response } from '../models'; import { GetDataSourceResponse } from '../models'; import { GetFileInfoResponse } from '../models'; import { ListDataSourceImportsResponse } from '../models'; import { ListDataSourcesResponse } from '../models'; import { UpdateDataSourceResponse } from '../models'; import { UploadFileResponse } from '../models'; /** * DataSourcesApi - axios parameter creator * @export */ export declare const DataSourcesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Archive a data source, with options to permanently remove it (and associated data). * @summary Archive Data Source * @param {string} containerId * @param {string} dataSourceId * @param {string} [archive] Set to true to archive the data source. * @param {string} [forceDelete] Set to true to force deletion of the data source. * @param {string} [removeData] Set to true to remove data associated with the data source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveDataSource: (containerId: string, dataSourceId: string, archive?: string, forceDelete?: string, removeData?: string, options?: any) => Promise; /** * Create new datasource. Supported data source types are `http`, `standard` (or `manual`), `jazz`, and `aveva`. * @summary Create Data Source * @param {CreateDataSourceRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDataSource: (body: CreateDataSourceRequest, containerId: string, options?: any) => Promise; /** * Create a manual import. * @summary Create Manual Import * @param {any} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createManualImport: (body: any, containerId: string, dataSourceId: string, options?: any) => Promise; /** * Downloads a previously uploaded file. * @summary Download File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile: (containerId: string, fileId: string, options?: any) => Promise; /** * List the datasources for the container. * @summary List Data Sources * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataSources: (containerId: string, options?: any) => Promise; /** * List the imports for the datasource. * @summary List Imports for Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listImportsForDataSource: (containerId: string, dataSourceId: string, options?: any) => Promise; /** * Retrieve a single data source by ID. * @summary Retrieve Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataSource: (containerId: string, dataSourceId: string, options?: any) => Promise; /** * Get information about a file by ID. * @summary Retrieve File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveFile: (containerId: string, fileId: string, options?: any) => Promise; /** * Sets a data source active. * @summary Set Data Source Active * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceActive: (containerId: string, dataSourceId: string, options?: any) => Promise; /** * Updates a data source's configuration in storage. Note that this request body's structure must match that of the data source's adapter type. * @summary Set Data Source Configuration * @param {CreateDataSourceConfig} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceConfiguration: (body: CreateDataSourceConfig, containerId: string, dataSourceId: string, options?: any) => Promise; /** * Sets a data source inactive. * @summary Set Data Source Inactive * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceInactive: (containerId: string, dataSourceId: string, options?: any) => Promise; /** * Uploads a file and it's metadata to Deep Lynx. All additional fields on the multipart form will be processed and added as metadata to the file upload itself. This should be a collection of files and normal fields. If you include a file field and call that \"metadata\" - you can include a normal metadata upload as either a json, csv, or xml file. This data will be processed like a normal import and the files attached to the processed data. Once Deep Lynx generates nodes and edges from that data, any files attached will automatically be attached to the resulting nodes/edges as well. NOTE: The metadata file you upload, if json, must be wrapped in an array. If you do not pass in an array of objects, even if it's a single object, then Deep Lynx will attempt to split up your metadata into its parts instead of treating it like a whole object. * @summary Upload File * @param {string} containerId * @param {string} dataSourceId * @param {string} [file] * @param {string} [metadata] * @param {string} [importID] You can attach the metadata to an existing import if desired. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile: (containerId: string, dataSourceId: string, file?: string, metadata?: string, importID?: string, options?: any) => Promise; }; /** * DataSourcesApi - functional programming interface * @export */ export declare const DataSourcesApiFp: (configuration?: Configuration) => { /** * Archive a data source, with options to permanently remove it (and associated data). * @summary Archive Data Source * @param {string} containerId * @param {string} dataSourceId * @param {string} [archive] Set to true to archive the data source. * @param {string} [forceDelete] Set to true to force deletion of the data source. * @param {string} [removeData] Set to true to remove data associated with the data source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveDataSource(containerId: string, dataSourceId: string, archive?: string, forceDelete?: string, removeData?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create new datasource. Supported data source types are `http`, `standard` (or `manual`), `jazz`, and `aveva`. * @summary Create Data Source * @param {CreateDataSourceRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDataSource(body: CreateDataSourceRequest, containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a manual import. * @summary Create Manual Import * @param {any} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createManualImport(body: any, containerId: string, dataSourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Downloads a previously uploaded file. * @summary Download File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(containerId: string, fileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the datasources for the container. * @summary List Data Sources * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataSources(containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the imports for the datasource. * @summary List Imports for Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listImportsForDataSource(containerId: string, dataSourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single data source by ID. * @summary Retrieve Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataSource(containerId: string, dataSourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get information about a file by ID. * @summary Retrieve File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveFile(containerId: string, fileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets a data source active. * @summary Set Data Source Active * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceActive(containerId: string, dataSourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a data source's configuration in storage. Note that this request body's structure must match that of the data source's adapter type. * @summary Set Data Source Configuration * @param {CreateDataSourceConfig} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceConfiguration(body: CreateDataSourceConfig, containerId: string, dataSourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sets a data source inactive. * @summary Set Data Source Inactive * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceInactive(containerId: string, dataSourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a file and it's metadata to Deep Lynx. All additional fields on the multipart form will be processed and added as metadata to the file upload itself. This should be a collection of files and normal fields. If you include a file field and call that \"metadata\" - you can include a normal metadata upload as either a json, csv, or xml file. This data will be processed like a normal import and the files attached to the processed data. Once Deep Lynx generates nodes and edges from that data, any files attached will automatically be attached to the resulting nodes/edges as well. NOTE: The metadata file you upload, if json, must be wrapped in an array. If you do not pass in an array of objects, even if it's a single object, then Deep Lynx will attempt to split up your metadata into its parts instead of treating it like a whole object. * @summary Upload File * @param {string} containerId * @param {string} dataSourceId * @param {string} [file] * @param {string} [metadata] * @param {string} [importID] You can attach the metadata to an existing import if desired. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile(containerId: string, dataSourceId: string, file?: string, metadata?: string, importID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DataSourcesApi - factory interface * @export */ export declare const DataSourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Archive a data source, with options to permanently remove it (and associated data). * @summary Archive Data Source * @param {string} containerId * @param {string} dataSourceId * @param {string} [archive] Set to true to archive the data source. * @param {string} [forceDelete] Set to true to force deletion of the data source. * @param {string} [removeData] Set to true to remove data associated with the data source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ archiveDataSource(containerId: string, dataSourceId: string, archive?: string, forceDelete?: string, removeData?: string, options?: any): AxiosPromise; /** * Create new datasource. Supported data source types are `http`, `standard` (or `manual`), `jazz`, and `aveva`. * @summary Create Data Source * @param {CreateDataSourceRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDataSource(body: CreateDataSourceRequest, containerId: string, options?: any): AxiosPromise; /** * Create a manual import. * @summary Create Manual Import * @param {any} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createManualImport(body: any, containerId: string, dataSourceId: string, options?: any): AxiosPromise; /** * Downloads a previously uploaded file. * @summary Download File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadFile(containerId: string, fileId: string, options?: any): AxiosPromise; /** * List the datasources for the container. * @summary List Data Sources * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataSources(containerId: string, options?: any): AxiosPromise; /** * List the imports for the datasource. * @summary List Imports for Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listImportsForDataSource(containerId: string, dataSourceId: string, options?: any): AxiosPromise; /** * Retrieve a single data source by ID. * @summary Retrieve Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataSource(containerId: string, dataSourceId: string, options?: any): AxiosPromise; /** * Get information about a file by ID. * @summary Retrieve File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveFile(containerId: string, fileId: string, options?: any): AxiosPromise; /** * Sets a data source active. * @summary Set Data Source Active * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceActive(containerId: string, dataSourceId: string, options?: any): AxiosPromise; /** * Updates a data source's configuration in storage. Note that this request body's structure must match that of the data source's adapter type. * @summary Set Data Source Configuration * @param {CreateDataSourceConfig} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceConfiguration(body: CreateDataSourceConfig, containerId: string, dataSourceId: string, options?: any): AxiosPromise; /** * Sets a data source inactive. * @summary Set Data Source Inactive * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ setDataSourceInactive(containerId: string, dataSourceId: string, options?: any): AxiosPromise; /** * Uploads a file and it's metadata to Deep Lynx. All additional fields on the multipart form will be processed and added as metadata to the file upload itself. This should be a collection of files and normal fields. If you include a file field and call that \"metadata\" - you can include a normal metadata upload as either a json, csv, or xml file. This data will be processed like a normal import and the files attached to the processed data. Once Deep Lynx generates nodes and edges from that data, any files attached will automatically be attached to the resulting nodes/edges as well. NOTE: The metadata file you upload, if json, must be wrapped in an array. If you do not pass in an array of objects, even if it's a single object, then Deep Lynx will attempt to split up your metadata into its parts instead of treating it like a whole object. * @summary Upload File * @param {string} containerId * @param {string} dataSourceId * @param {string} [file] * @param {string} [metadata] * @param {string} [importID] You can attach the metadata to an existing import if desired. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadFile(containerId: string, dataSourceId: string, file?: string, metadata?: string, importID?: string, options?: any): AxiosPromise; }; /** * DataSourcesApi - object-oriented interface * @export * @class DataSourcesApi * @extends {BaseAPI} */ export declare class DataSourcesApi extends BaseAPI { /** * Archive a data source, with options to permanently remove it (and associated data). * @summary Archive Data Source * @param {string} containerId * @param {string} dataSourceId * @param {string} [archive] Set to true to archive the data source. * @param {string} [forceDelete] Set to true to force deletion of the data source. * @param {string} [removeData] Set to true to remove data associated with the data source. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ archiveDataSource(containerId: string, dataSourceId: string, archive?: string, forceDelete?: string, removeData?: string, options?: any): Promise>; /** * Create new datasource. Supported data source types are `http`, `standard` (or `manual`), `jazz`, and `aveva`. * @summary Create Data Source * @param {CreateDataSourceRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ createDataSource(body: CreateDataSourceRequest, containerId: string, options?: any): Promise>; /** * Create a manual import. * @summary Create Manual Import * @param {any} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ createManualImport(body: any, containerId: string, dataSourceId: string, options?: any): Promise>; /** * Downloads a previously uploaded file. * @summary Download File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ downloadFile(containerId: string, fileId: string, options?: any): Promise>; /** * List the datasources for the container. * @summary List Data Sources * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ listDataSources(containerId: string, options?: any): Promise>; /** * List the imports for the datasource. * @summary List Imports for Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ listImportsForDataSource(containerId: string, dataSourceId: string, options?: any): Promise>; /** * Retrieve a single data source by ID. * @summary Retrieve Data Source * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ retrieveDataSource(containerId: string, dataSourceId: string, options?: any): Promise>; /** * Get information about a file by ID. * @summary Retrieve File * @param {string} containerId * @param {string} fileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ retrieveFile(containerId: string, fileId: string, options?: any): Promise>; /** * Sets a data source active. * @summary Set Data Source Active * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ setDataSourceActive(containerId: string, dataSourceId: string, options?: any): Promise>; /** * Updates a data source's configuration in storage. Note that this request body's structure must match that of the data source's adapter type. * @summary Set Data Source Configuration * @param {CreateDataSourceConfig} body * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ setDataSourceConfiguration(body: CreateDataSourceConfig, containerId: string, dataSourceId: string, options?: any): Promise>; /** * Sets a data source inactive. * @summary Set Data Source Inactive * @param {string} containerId * @param {string} dataSourceId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ setDataSourceInactive(containerId: string, dataSourceId: string, options?: any): Promise>; /** * Uploads a file and it's metadata to Deep Lynx. All additional fields on the multipart form will be processed and added as metadata to the file upload itself. This should be a collection of files and normal fields. If you include a file field and call that \"metadata\" - you can include a normal metadata upload as either a json, csv, or xml file. This data will be processed like a normal import and the files attached to the processed data. Once Deep Lynx generates nodes and edges from that data, any files attached will automatically be attached to the resulting nodes/edges as well. NOTE: The metadata file you upload, if json, must be wrapped in an array. If you do not pass in an array of objects, even if it's a single object, then Deep Lynx will attempt to split up your metadata into its parts instead of treating it like a whole object. * @summary Upload File * @param {string} containerId * @param {string} dataSourceId * @param {string} [file] * @param {string} [metadata] * @param {string} [importID] You can attach the metadata to an existing import if desired. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataSourcesApi */ uploadFile(containerId: string, dataSourceId: string, file?: string, metadata?: string, importID?: string, options?: any): Promise>; }