/** * 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 { CreateDataExportRequest } from '../models'; import { Generic200Response } from '../models'; import { GetDataExportResponse } from '../models'; import { ListDataExportsResponse } from '../models'; /** * DataExportApi - axios parameter creator * @export */ export declare const DataExportApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new data export with the included configuration. Configuration values may be encrypted depending on the adapter you've choosen. See the readme for the exporters for more information. * @summary Create Data Export * @param {CreateDataExportRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDataExport: (body: CreateDataExportRequest, containerId: string, options?: any) => Promise; /** * Deletes a data export record. This does not guarantee the export will stop immediately. * @summary Delete Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDataExport: (containerId: string, exportId: string, options?: any) => Promise; /** * List data exports for the container. * @summary List Data Exports * @param {string} containerId * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {number} [limit] * @param {number} [offset] * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataExports: (containerId: string, count?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any) => Promise; /** * Fetch a data export record by ID * @summary Retrieve Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataExport: (containerId: string, exportId: string, options?: any) => Promise; /** * Start or restart a data export by id. * @summary Start Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ startDataExport: (containerId: string, exportId: string, options?: any) => Promise; /** * Stops a data export. Please note that this just sends a **stop** signal. The application's export adapter determines how to handle the said signal. In some cases the export stopping might not be immediate. * @summary Stop Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ stopDataExport: (containerId: string, exportId: string, options?: any) => Promise; }; /** * DataExportApi - functional programming interface * @export */ export declare const DataExportApiFp: (configuration?: Configuration) => { /** * Create a new data export with the included configuration. Configuration values may be encrypted depending on the adapter you've choosen. See the readme for the exporters for more information. * @summary Create Data Export * @param {CreateDataExportRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDataExport(body: CreateDataExportRequest, containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a data export record. This does not guarantee the export will stop immediately. * @summary Delete Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDataExport(containerId: string, exportId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List data exports for the container. * @summary List Data Exports * @param {string} containerId * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {number} [limit] * @param {number} [offset] * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataExports(containerId: string, count?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch a data export record by ID * @summary Retrieve Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataExport(containerId: string, exportId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Start or restart a data export by id. * @summary Start Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ startDataExport(containerId: string, exportId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Stops a data export. Please note that this just sends a **stop** signal. The application's export adapter determines how to handle the said signal. In some cases the export stopping might not be immediate. * @summary Stop Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ stopDataExport(containerId: string, exportId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DataExportApi - factory interface * @export */ export declare const DataExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new data export with the included configuration. Configuration values may be encrypted depending on the adapter you've choosen. See the readme for the exporters for more information. * @summary Create Data Export * @param {CreateDataExportRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDataExport(body: CreateDataExportRequest, containerId: string, options?: any): AxiosPromise; /** * Deletes a data export record. This does not guarantee the export will stop immediately. * @summary Delete Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDataExport(containerId: string, exportId: string, options?: any): AxiosPromise; /** * List data exports for the container. * @summary List Data Exports * @param {string} containerId * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {number} [limit] * @param {number} [offset] * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataExports(containerId: string, count?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any): AxiosPromise; /** * Fetch a data export record by ID * @summary Retrieve Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataExport(containerId: string, exportId: string, options?: any): AxiosPromise; /** * Start or restart a data export by id. * @summary Start Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ startDataExport(containerId: string, exportId: string, options?: any): AxiosPromise; /** * Stops a data export. Please note that this just sends a **stop** signal. The application's export adapter determines how to handle the said signal. In some cases the export stopping might not be immediate. * @summary Stop Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} */ stopDataExport(containerId: string, exportId: string, options?: any): AxiosPromise; }; /** * DataExportApi - object-oriented interface * @export * @class DataExportApi * @extends {BaseAPI} */ export declare class DataExportApi extends BaseAPI { /** * Create a new data export with the included configuration. Configuration values may be encrypted depending on the adapter you've choosen. See the readme for the exporters for more information. * @summary Create Data Export * @param {CreateDataExportRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportApi */ createDataExport(body: CreateDataExportRequest, containerId: string, options?: any): Promise>; /** * Deletes a data export record. This does not guarantee the export will stop immediately. * @summary Delete Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportApi */ deleteDataExport(containerId: string, exportId: string, options?: any): Promise>; /** * List data exports for the container. * @summary List Data Exports * @param {string} containerId * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {number} [limit] * @param {number} [offset] * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportApi */ listDataExports(containerId: string, count?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any): Promise>; /** * Fetch a data export record by ID * @summary Retrieve Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportApi */ retrieveDataExport(containerId: string, exportId: string, options?: any): Promise>; /** * Start or restart a data export by id. * @summary Start Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportApi */ startDataExport(containerId: string, exportId: string, options?: any): Promise>; /** * Stops a data export. Please note that this just sends a **stop** signal. The application's export adapter determines how to handle the said signal. In some cases the export stopping might not be immediate. * @summary Stop Data Export * @param {string} containerId * @param {string} exportId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataExportApi */ stopDataExport(containerId: string, exportId: string, options?: any): Promise>; }