/** * 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 { AssignRoleRequest } from '../models'; import { ContainerInvite } from '../models'; import { Generic200Response } from '../models'; import { GetUserResponse } from '../models'; import { ListContainerInvitesResponse } from '../models'; import { ListUserInvitesResponse } from '../models'; import { ListUserPermissionsResponse } from '../models'; import { ListUserRoles } from '../models'; import { ListUsersForContainerResponse } from '../models'; import { ListUsersResponse } from '../models'; import { User } from '../models'; /** * UsersApi - axios parameter creator * @export */ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Accepts a container invite for the current user. The token received in the container invite previously must be attached to this request as a query parameter. * @summary Accept Container Invite * @param {string} token the token supplied in the container invite * @param {*} [options] Override http request option. * @throws {RequiredError} */ acceptContainerInvite: (token: string, options?: any) => Promise; /** * Assign a role to a user, roles must consist of role name and domain * @summary Assign User Role * @param {AssignRoleRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignUserRole: (body: AssignRoleRequest, containerId: string, options?: any) => Promise; /** * Deletes the specified user. * @summary Delete User * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser: (userId: string, options?: any) => Promise; /** * Create a new user using the username_password identity type. * @summary Invite User to Container * @param {string} containerId * @param {ContainerInvite} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUserToContainer: (containerId: string, body?: ContainerInvite, options?: any) => Promise; /** * List all invitations to container. * @summary List Invited Users for Container * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitedUsersForContainer: (containerId: string, options?: any) => Promise; /** * Lists the outstanding container invites for the current user. * @summary List Outstanding Invites * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOutstandingInvites: (options?: any) => Promise; /** * List permissions for the user. * @summary List User Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUserPermissions: (options?: any) => Promise; /** * List users. * @summary List Users * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {boolean} [loadKeys] if supplied, the API keys for the user will also be returned * @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} */ listUsers: (count?: boolean, loadKeys?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any) => Promise; /** * List Users for container. * @summary List Users for Container * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersForContainer: (containerId: string, limit?: number, offset?: number, options?: any) => Promise; /** * List Users' roles * @summary List User's Roles * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersRoles: (containerId: string, userId: string, options?: any) => Promise; /** * Retrieve a user by ID * @summary Retrieve User * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveUser: (containerId: string, userId: string, options?: any) => Promise; /** * Updates the specified user. * @summary Update User * @param {string} userId * @param {User} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser: (userId: string, body?: User, options?: any) => Promise; }; /** * UsersApi - functional programming interface * @export */ export declare const UsersApiFp: (configuration?: Configuration) => { /** * Accepts a container invite for the current user. The token received in the container invite previously must be attached to this request as a query parameter. * @summary Accept Container Invite * @param {string} token the token supplied in the container invite * @param {*} [options] Override http request option. * @throws {RequiredError} */ acceptContainerInvite(token: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Assign a role to a user, roles must consist of role name and domain * @summary Assign User Role * @param {AssignRoleRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignUserRole(body: AssignRoleRequest, containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified user. * @summary Delete User * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new user using the username_password identity type. * @summary Invite User to Container * @param {string} containerId * @param {ContainerInvite} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUserToContainer(containerId: string, body?: ContainerInvite, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all invitations to container. * @summary List Invited Users for Container * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitedUsersForContainer(containerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists the outstanding container invites for the current user. * @summary List Outstanding Invites * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOutstandingInvites(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List permissions for the user. * @summary List User Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUserPermissions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List users. * @summary List Users * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {boolean} [loadKeys] if supplied, the API keys for the user will also be returned * @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} */ listUsers(count?: boolean, loadKeys?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Users for container. * @summary List Users for Container * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersForContainer(containerId: string, limit?: number, offset?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Users' roles * @summary List User's Roles * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersRoles(containerId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a user by ID * @summary Retrieve User * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveUser(containerId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the specified user. * @summary Update User * @param {string} userId * @param {User} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, body?: User, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface * @export */ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Accepts a container invite for the current user. The token received in the container invite previously must be attached to this request as a query parameter. * @summary Accept Container Invite * @param {string} token the token supplied in the container invite * @param {*} [options] Override http request option. * @throws {RequiredError} */ acceptContainerInvite(token: string, options?: any): AxiosPromise; /** * Assign a role to a user, roles must consist of role name and domain * @summary Assign User Role * @param {AssignRoleRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignUserRole(body: AssignRoleRequest, containerId: string, options?: any): AxiosPromise; /** * Deletes the specified user. * @summary Delete User * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(userId: string, options?: any): AxiosPromise; /** * Create a new user using the username_password identity type. * @summary Invite User to Container * @param {string} containerId * @param {ContainerInvite} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ inviteUserToContainer(containerId: string, body?: ContainerInvite, options?: any): AxiosPromise; /** * List all invitations to container. * @summary List Invited Users for Container * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitedUsersForContainer(containerId: string, options?: any): AxiosPromise; /** * Lists the outstanding container invites for the current user. * @summary List Outstanding Invites * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOutstandingInvites(options?: any): AxiosPromise; /** * List permissions for the user. * @summary List User Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUserPermissions(options?: any): AxiosPromise; /** * List users. * @summary List Users * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {boolean} [loadKeys] if supplied, the API keys for the user will also be returned * @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} */ listUsers(count?: boolean, loadKeys?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any): AxiosPromise; /** * List Users for container. * @summary List Users for Container * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersForContainer(containerId: string, limit?: number, offset?: number, options?: any): AxiosPromise; /** * List Users' roles * @summary List User's Roles * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersRoles(containerId: string, userId: string, options?: any): AxiosPromise; /** * Retrieve a user by ID * @summary Retrieve User * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveUser(containerId: string, userId: string, options?: any): AxiosPromise; /** * Updates the specified user. * @summary Update User * @param {string} userId * @param {User} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, body?: User, options?: any): AxiosPromise; }; /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ export declare class UsersApi extends BaseAPI { /** * Accepts a container invite for the current user. The token received in the container invite previously must be attached to this request as a query parameter. * @summary Accept Container Invite * @param {string} token the token supplied in the container invite * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ acceptContainerInvite(token: string, options?: any): Promise>; /** * Assign a role to a user, roles must consist of role name and domain * @summary Assign User Role * @param {AssignRoleRequest} body * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ assignUserRole(body: AssignRoleRequest, containerId: string, options?: any): Promise>; /** * Deletes the specified user. * @summary Delete User * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteUser(userId: string, options?: any): Promise>; /** * Create a new user using the username_password identity type. * @summary Invite User to Container * @param {string} containerId * @param {ContainerInvite} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ inviteUserToContainer(containerId: string, body?: ContainerInvite, options?: any): Promise>; /** * List all invitations to container. * @summary List Invited Users for Container * @param {string} containerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ listInvitedUsersForContainer(containerId: string, options?: any): Promise>; /** * Lists the outstanding container invites for the current user. * @summary List Outstanding Invites * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ listOutstandingInvites(options?: any): Promise>; /** * List permissions for the user. * @summary List User Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ listUserPermissions(options?: any): Promise>; /** * List users. * @summary List Users * @param {boolean} [count] boolean indicating if the return value should be a count only * @param {boolean} [loadKeys] if supplied, the API keys for the user will also be returned * @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 UsersApi */ listUsers(count?: boolean, loadKeys?: boolean, limit?: number, offset?: number, sortBy?: string, sortDesc?: boolean, options?: any): Promise>; /** * List Users for container. * @summary List Users for Container * @param {string} containerId * @param {number} [limit] * @param {number} [offset] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ listUsersForContainer(containerId: string, limit?: number, offset?: number, options?: any): Promise>; /** * List Users' roles * @summary List User's Roles * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ listUsersRoles(containerId: string, userId: string, options?: any): Promise>; /** * Retrieve a user by ID * @summary Retrieve User * @param {string} containerId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ retrieveUser(containerId: string, userId: string, options?: any): Promise>; /** * Updates the specified user. * @summary Update User * @param {string} userId * @param {User} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ updateUser(userId: string, body?: User, options?: any): Promise>; }