/** * 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 { CreateTransformationResponse } from '../models'; import { CreateTypeMappingTransformationsRequest } from '../models'; import { Generic200Response } from '../models'; import { GetDataTypeMappingResponse } from '../models'; import { ImportDataTypeMappingResponse } from '../models'; import { ListDataTypeMappingResponse } from '../models'; import { ListTransformationResponse } from '../models'; import { TypeMapping } from '../models'; import { TypeMappingExportPayload } from '../models'; import { UpdateDataTypeMappingResponse } from '../models'; import { UpdateTransformationResponse } from '../models'; /** * DataTypeMappingsApi - axios parameter creator * @export */ export declare const DataTypeMappingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a transformation for the type mapping. * @summary Create Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransformation: (body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, options?: any) => Promise; /** * Permanently remove data type mapping. * @summary Delete Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDataTypeMapping: (containerId: string, dataSourceId: string, mappingId: string, options?: any) => Promise; /** * Delete a transformation. * @summary Delete Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTransformation: (containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any) => Promise; /** * Export type mappings for a datasource. Providing a JSON body is optional. If provided, the mapping_ids may be specified to indicate certain type mapping IDs to return. Additionally, a target data source may be provided to which the mappings will be copied. * @summary Export Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {TypeMappingExportPayload} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportTypeMappings: (containerId: string, dataSourceId: string, body?: TypeMappingExportPayload, options?: any) => Promise; /** * Import type mappings for a datasource. Accepts either a JSON body or actual JSON file. The payload should be an array of type mapping classes, previously generated using the export route. * @summary Import Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {Array<any>} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ importDataTypeMappings: (containerId: string, dataSourceId: string, body?: Array, options?: any) => Promise; /** * Lists data type mappings for the data source * @summary List Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {number} [limit] * @param {number} [offset] * @param {boolean} [needsTransformations] boolean indicating if the return should consist of only mappings that need transformations * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {string} [resultingMetatypeName] if supplied, filters returned transformations by those that produce the resulting metatype * @param {string} [resultingMetatypeRelationshipName] if supplied, filters returned transformations by those that produce the resulting metatype relationship * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataTypeMappings: (containerId: string, dataSourceId: string, limit?: number, offset?: number, needsTransformations?: boolean, count?: boolean, sortBy?: string, sortDesc?: boolean, resultingMetatypeName?: string, resultingMetatypeRelationshipName?: string, options?: any) => Promise; /** * List transformations for a type mapping from storage. * @summary List Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransformations: (containerId: string, dataSourceId: string, mappingId: string, options?: any) => Promise; /** * Retrieve a data type mapping * @summary Retrieve Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataTypeMapping: (containerId: string, dataSourceId: string, mappingId: string, options?: any) => Promise; /** * Updates a data type mapping. * @summary Update Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {TypeMapping} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDataTypeMapping: (containerId: string, dataSourceId: string, mappingId: string, body?: TypeMapping, options?: any) => Promise; /** * Update a transformation. * @summary Update Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTransformation: (body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any) => Promise; }; /** * DataTypeMappingsApi - functional programming interface * @export */ export declare const DataTypeMappingsApiFp: (configuration?: Configuration) => { /** * Create a transformation for the type mapping. * @summary Create Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransformation(body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Permanently remove data type mapping. * @summary Delete Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a transformation. * @summary Delete Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTransformation(containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Export type mappings for a datasource. Providing a JSON body is optional. If provided, the mapping_ids may be specified to indicate certain type mapping IDs to return. Additionally, a target data source may be provided to which the mappings will be copied. * @summary Export Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {TypeMappingExportPayload} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportTypeMappings(containerId: string, dataSourceId: string, body?: TypeMappingExportPayload, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Import type mappings for a datasource. Accepts either a JSON body or actual JSON file. The payload should be an array of type mapping classes, previously generated using the export route. * @summary Import Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {Array<any>} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ importDataTypeMappings(containerId: string, dataSourceId: string, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists data type mappings for the data source * @summary List Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {number} [limit] * @param {number} [offset] * @param {boolean} [needsTransformations] boolean indicating if the return should consist of only mappings that need transformations * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {string} [resultingMetatypeName] if supplied, filters returned transformations by those that produce the resulting metatype * @param {string} [resultingMetatypeRelationshipName] if supplied, filters returned transformations by those that produce the resulting metatype relationship * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataTypeMappings(containerId: string, dataSourceId: string, limit?: number, offset?: number, needsTransformations?: boolean, count?: boolean, sortBy?: string, sortDesc?: boolean, resultingMetatypeName?: string, resultingMetatypeRelationshipName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List transformations for a type mapping from storage. * @summary List Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransformations(containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a data type mapping * @summary Retrieve Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a data type mapping. * @summary Update Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {TypeMapping} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, body?: TypeMapping, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a transformation. * @summary Update Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTransformation(body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DataTypeMappingsApi - factory interface * @export */ export declare const DataTypeMappingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a transformation for the type mapping. * @summary Create Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransformation(body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, options?: any): AxiosPromise; /** * Permanently remove data type mapping. * @summary Delete Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, options?: any): AxiosPromise; /** * Delete a transformation. * @summary Delete Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTransformation(containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any): AxiosPromise; /** * Export type mappings for a datasource. Providing a JSON body is optional. If provided, the mapping_ids may be specified to indicate certain type mapping IDs to return. Additionally, a target data source may be provided to which the mappings will be copied. * @summary Export Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {TypeMappingExportPayload} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportTypeMappings(containerId: string, dataSourceId: string, body?: TypeMappingExportPayload, options?: any): AxiosPromise>; /** * Import type mappings for a datasource. Accepts either a JSON body or actual JSON file. The payload should be an array of type mapping classes, previously generated using the export route. * @summary Import Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {Array<any>} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ importDataTypeMappings(containerId: string, dataSourceId: string, body?: Array, options?: any): AxiosPromise; /** * Lists data type mappings for the data source * @summary List Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {number} [limit] * @param {number} [offset] * @param {boolean} [needsTransformations] boolean indicating if the return should consist of only mappings that need transformations * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {string} [resultingMetatypeName] if supplied, filters returned transformations by those that produce the resulting metatype * @param {string} [resultingMetatypeRelationshipName] if supplied, filters returned transformations by those that produce the resulting metatype relationship * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDataTypeMappings(containerId: string, dataSourceId: string, limit?: number, offset?: number, needsTransformations?: boolean, count?: boolean, sortBy?: string, sortDesc?: boolean, resultingMetatypeName?: string, resultingMetatypeRelationshipName?: string, options?: any): AxiosPromise; /** * List transformations for a type mapping from storage. * @summary List Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransformations(containerId: string, dataSourceId: string, mappingId: string, options?: any): AxiosPromise; /** * Retrieve a data type mapping * @summary Retrieve Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, options?: any): AxiosPromise; /** * Updates a data type mapping. * @summary Update Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {TypeMapping} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, body?: TypeMapping, options?: any): AxiosPromise; /** * Update a transformation. * @summary Update Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTransformation(body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any): AxiosPromise; }; /** * DataTypeMappingsApi - object-oriented interface * @export * @class DataTypeMappingsApi * @extends {BaseAPI} */ export declare class DataTypeMappingsApi extends BaseAPI { /** * Create a transformation for the type mapping. * @summary Create Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ createTransformation(body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise>; /** * Permanently remove data type mapping. * @summary Delete Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ deleteDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise>; /** * Delete a transformation. * @summary Delete Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ deleteTransformation(containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any): Promise>; /** * Export type mappings for a datasource. Providing a JSON body is optional. If provided, the mapping_ids may be specified to indicate certain type mapping IDs to return. Additionally, a target data source may be provided to which the mappings will be copied. * @summary Export Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {TypeMappingExportPayload} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ exportTypeMappings(containerId: string, dataSourceId: string, body?: TypeMappingExportPayload, options?: any): Promise>; /** * Import type mappings for a datasource. Accepts either a JSON body or actual JSON file. The payload should be an array of type mapping classes, previously generated using the export route. * @summary Import Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {Array<any>} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ importDataTypeMappings(containerId: string, dataSourceId: string, body?: Array, options?: any): Promise>; /** * Lists data type mappings for the data source * @summary List Data Type Mappings * @param {string} containerId * @param {string} dataSourceId * @param {number} [limit] * @param {number} [offset] * @param {boolean} [needsTransformations] boolean indicating if the return should consist of only mappings that need transformations * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {string} [sortBy] column to sort results by * @param {boolean} [sortDesc] boolean indicating if results should be in descending order * @param {string} [resultingMetatypeName] if supplied, filters returned transformations by those that produce the resulting metatype * @param {string} [resultingMetatypeRelationshipName] if supplied, filters returned transformations by those that produce the resulting metatype relationship * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ listDataTypeMappings(containerId: string, dataSourceId: string, limit?: number, offset?: number, needsTransformations?: boolean, count?: boolean, sortBy?: string, sortDesc?: boolean, resultingMetatypeName?: string, resultingMetatypeRelationshipName?: string, options?: any): Promise>; /** * List transformations for a type mapping from storage. * @summary List Data Type Mapping's Transformations * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ listTransformations(containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise>; /** * Retrieve a data type mapping * @summary Retrieve Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ retrieveDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, options?: any): Promise>; /** * Updates a data type mapping. * @summary Update Data Type Mapping * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {TypeMapping} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ updateDataTypeMapping(containerId: string, dataSourceId: string, mappingId: string, body?: TypeMapping, options?: any): Promise>; /** * Update a transformation. * @summary Update Data Type Mapping's Transformations * @param {CreateTypeMappingTransformationsRequest} body * @param {string} containerId * @param {string} dataSourceId * @param {string} mappingId * @param {string} transformationId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DataTypeMappingsApi */ updateTransformation(body: CreateTypeMappingTransformationsRequest, containerId: string, dataSourceId: string, mappingId: string, transformationId: string, options?: any): Promise>; }