@realtimex/sdk 1.6.0 → 1.7.4

package/dist/errors-DoCX7LOD.d.mts

@@ -0,0 +1,445 @@
+/**
+ * DeveloperApiClient - HTTP client for the RealtimeX v1 Developer API.
+ *
+ * Supports two authentication modes:
+ * - API Key: Authorization: Bearer <apiKey>
+ * - App ID: x-app-id header (for LocalApp / SDK agent authentication)
+ *
+ * When both are provided, x-app-id takes priority on the server side.
+ */
+declare class DeveloperApiClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly appId?;
+    constructor(baseUrl: string, apiKey: string, appId?: string);
+    private getHeaders;
+    private handleResponse;
+    /**
+     * Make a JSON request to the v1 API.
+     */
+    request<T = unknown>(method: string, path: string, body?: unknown): Promise<T>;
+    /**
+     * Make a multipart/form-data request (e.g. file uploads).
+     * Do NOT set Content-Type — browser/fetch will set it with the boundary.
+     */
+    requestMultipart<T = unknown>(method: string, path: string, form: FormData): Promise<T>;
+    /**
+     * Make a raw request and return the Response object directly.
+     * Used for streaming (SSE) endpoints.
+     */
+    requestRaw(method: string, path: string, body?: unknown): Promise<Response>;
+}
+
+declare class V1AuthModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Verify the attached Authentication header contains a valid API token.
+     * @see GET /v1/auth
+     */
+    getAuth(): Promise<unknown>;
+}
+
+declare class V1AdminModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
+     * @see GET /v1/admin/is-multi-user-mode
+     */
+    getIsMultiUserMode(): Promise<unknown>;
+    /**
+     * Check to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI.
+     * @see GET /v1/admin/users
+     */
+    listUsers(): Promise<unknown>;
+    /**
+     * Create a new user with username and password. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/users/new
+     */
+    createUser(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Update existing user settings. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/users/{id}
+     */
+    updateUser(id: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Delete existing user by id. Methods are disabled until multi user mode is enabled via the UI.
+     * @see DELETE /v1/admin/users/{id}
+     */
+    deleteUser(id: string): Promise<unknown>;
+    /**
+     * List all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI.
+     * @see GET /v1/admin/invites
+     */
+    listInvites(): Promise<unknown>;
+    /**
+     * Create a new invite code for someone to use to register with instance. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/invite/new
+     */
+    createInvite(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Deactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI.
+     * @see DELETE /v1/admin/invite/{id}
+     */
+    deleteInvite(id: string): Promise<unknown>;
+    /**
+     * Retrieve a list of users with permissions to access the specified workspace.
+     * @see GET /v1/admin/workspaces/{workspaceId}/users
+     */
+    listWorkspaceUsers(workspaceId: string): Promise<unknown>;
+    /**
+     * Overwrite workspace permissions to only be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/workspaces/{workspaceId}/update-users
+     */
+    updateUsers(workspaceId: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Set workspace permissions to be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/workspaces/{workspaceSlug}/manage-users
+     */
+    workspacesManageUsers(workspaceSlug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * All chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/workspace-chats
+     */
+    workspaceChats(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Update multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.
+     * @see POST /v1/admin/preferences
+     */
+    createPreference(body?: Record<string, unknown>): Promise<unknown>;
+}
+
+declare class V1DocumentModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Upload a new file to RealTimeX to be parsed and prepared for embedding.
+     * @see POST /v1/document/upload
+     */
+    upload(form: FormData): Promise<unknown>;
+    /**
+     * Upload a new file to a specific folder in RealTimeX to be parsed and prepared for embedding. If the folder does not exist, it will be created.
+     * @see POST /v1/document/upload/{folderName}
+     */
+    uploadFolder(folderName: string, form: FormData): Promise<unknown>;
+    /**
+     * Upload a valid URL for RealTimeX to scrape and prepare for embedding. Optionally, specify a comma-separated list of workspace slugs to embed the document into post-upload.
+     * @see POST /v1/document/upload-link
+     */
+    uploadLink(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Upload a file by specifying its raw text content and metadata values without having to upload a file.
+     * @see POST /v1/document/raw-text
+     */
+    rawText(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * List of all locally-stored documents in instance
+     * @see GET /v1/documents
+     */
+    listDocuments(): Promise<unknown>;
+    /**
+     * Get all documents stored in a specific folder.
+     * @see GET /v1/documents/folder/{folderName}
+     */
+    getFolder(folderName: string): Promise<unknown>;
+    /**
+     * Check available filetypes and MIMEs that can be uploaded.
+     * @see GET /v1/document/accepted-file-types
+     */
+    listAcceptedFileTypes(): Promise<unknown>;
+    /**
+     * Get the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key.
+     * @see GET /v1/document/metadata-schema
+     */
+    getMetadataSchema(): Promise<unknown>;
+    /**
+     * Get a single document by its unique RealTimeX document name
+     * @see GET /v1/document/{docName}
+     */
+    getDocument(docName: string): Promise<unknown>;
+    /**
+     * Create a new folder inside the documents storage directory.
+     * @see POST /v1/document/create-folder
+     */
+    createFolder(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Remove a folder and all its contents from the documents storage directory.
+     * @see DELETE /v1/document/remove-folder
+     */
+    deleteRemoveFolder(): Promise<unknown>;
+    /**
+     * Move files within the documents storage directory.
+     * @see POST /v1/document/move-files
+     */
+    moveFiles(body?: Record<string, unknown>): Promise<unknown>;
+}
+
+declare class V1WorkspaceModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Create a new workspace
+     * @see POST /v1/workspace/new
+     */
+    createWorkspace(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * List all current workspaces
+     * @see GET /v1/workspaces
+     */
+    listWorkspaces(): Promise<unknown>;
+    /**
+     * Get a workspace by its unique slug.
+     * @see GET /v1/workspace/{slug}
+     */
+    getWorkspace(slug: string): Promise<unknown>;
+    /**
+     * Deletes a workspace by its slug.
+     * @see DELETE /v1/workspace/{slug}
+     */
+    deleteWorkspace(slug: string): Promise<unknown>;
+    /**
+     * Update workspace settings by its unique slug.
+     * @see POST /v1/workspace/{slug}/update
+     */
+    updateWorkspace(slug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Get a workspaces chats regardless of user by its unique slug.
+     * @see GET /v1/workspace/{slug}/chats
+     */
+    listChats(slug: string): Promise<unknown>;
+    /**
+     * Add or remove documents from a workspace by its unique slug.
+     * @see POST /v1/workspace/{slug}/update-embeddings
+     */
+    updateEmbeddings(slug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Add or remove pin from a document in a workspace by its unique slug.
+     * @see POST /v1/workspace/{slug}/update-pin
+     */
+    updatePin(slug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Execute a chat with a workspace
+     * @see POST /v1/workspace/{slug}/chat
+     */
+    chat(slug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Execute a streamable chat with a workspace
+     * @see POST /v1/workspace/{slug}/stream-chat
+     */
+    streamChat(slug: string, body?: Record<string, unknown>): Promise<Response>;
+    /**
+     * Perform a vector similarity search in a workspace
+     * @see POST /v1/workspace/{slug}/vector-search
+     */
+    vectorSearch(slug: string, body?: Record<string, unknown>): Promise<unknown>;
+}
+
+declare class V1SystemModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Dump all settings to file storage
+     * @see GET /v1/system/env-dump
+     */
+    getEnvDump(): Promise<unknown>;
+    /**
+     * Get all current system settings that are defined.
+     * @see GET /v1/system
+     */
+    getSystem(): Promise<unknown>;
+    /**
+     * Number of all vectors in connected vector database
+     * @see GET /v1/system/vector-count
+     */
+    getVectorCount(): Promise<unknown>;
+    /**
+     * Update a system setting or preference.
+     * @see POST /v1/system/update-env
+     */
+    updateEnv(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Export all of the chats from the system in a known format. Output depends on the type sent. Will be send with the correct header for the output.
+     * @see GET /v1/system/export-chats
+     */
+    listExportChats(): Promise<unknown>;
+    /**
+     * Permanently remove documents from the system.
+     * @see DELETE /v1/system/remove-documents
+     */
+    deleteRemoveDocument(): Promise<unknown>;
+    /**
+     * Returns a health check object with server uptime and version.
+     * @see GET /v1/system/health
+     */
+    getHealth(): Promise<unknown>;
+    /**
+     * Returns a health check object with server uptime and version.
+     * @see GET /v1/system/health-version-2
+     */
+    getHealthVersion2(): Promise<unknown>;
+    /**
+     * Returns a health check object with server uptime and version.
+     * @see GET /v1/system/health-version-3
+     */
+    getHealthVersion3(): Promise<unknown>;
+}
+
+declare class V1ThreadModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Create a new workspace thread
+     * @see POST /v1/workspace/{slug}/thread/new
+     */
+    createThread(slug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Update thread settings by its unique slug.
+     * @see POST /v1/workspace/{slug}/thread/{threadSlug}/update
+     */
+    updateThread(slug: string, threadSlug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Delete a workspace thread
+     * @see DELETE /v1/workspace/{slug}/thread/{threadSlug}
+     */
+    deleteThread(slug: string, threadSlug: string): Promise<unknown>;
+    /**
+     * Get chats for a workspace thread
+     * @see GET /v1/workspace/{slug}/thread/{threadSlug}/chats
+     */
+    listChats(slug: string, threadSlug: string): Promise<unknown>;
+    /**
+     * Chat with a workspace thread
+     * @see POST /v1/workspace/{slug}/thread/{threadSlug}/chat
+     */
+    chat(slug: string, threadSlug: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Stream chat with a workspace thread
+     * @see POST /v1/workspace/{slug}/thread/{threadSlug}/stream-chat
+     */
+    streamChat(slug: string, threadSlug: string, body?: Record<string, unknown>): Promise<Response>;
+}
+
+declare class V1UsersModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * List all users
+     * @see GET /v1/users
+     */
+    listUsers(): Promise<unknown>;
+    /**
+     * Issue a temporary auth token for a user
+     * @see GET /v1/users/{id}/issue-auth-token
+     */
+    getIssueAuthToken(id: string): Promise<unknown>;
+}
+
+declare class V1OpenAIModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * Get all available "models" which are workspaces you can use for chatting.
+     * @see GET /v1/openai/models
+     */
+    listModels(): Promise<unknown>;
+    /**
+     * Execute a chat with a workspace with OpenAI compatibility. Supports streaming as well. Model must be a workspace slug from /models.
+     * @see POST /v1/openai/chat/completions
+     */
+    chatCompletions(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Get the embeddings of any arbitrary text string. This will use the embedder provider set in the system. Please ensure the token length of each string fits within the context of your embedder model.
+     * @see POST /v1/openai/embeddings
+     */
+    createEmbedding(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * List all the vector database collections connected to RealTimeX. These are essentially workspaces but return their unique vector db identifier - this is the same as the workspace slug.
+     * @see GET /v1/openai/vector_stores
+     */
+    listVectorStores(): Promise<unknown>;
+}
+
+declare class V1EmbedModule {
+    private readonly client;
+    constructor(client: DeveloperApiClient);
+    /**
+     * List all active embeds
+     * @see GET /v1/embed
+     */
+    getEmbed(): Promise<unknown>;
+    /**
+     * Get all chats for a specific embed
+     * @see GET /v1/embed/{embedUuid}/chats
+     */
+    listChats(embedUuid: string): Promise<unknown>;
+    /**
+     * Get chats for a specific embed and session
+     * @see GET /v1/embed/{embedUuid}/chats/{sessionUuid}
+     */
+    getChat(embedUuid: string, sessionUuid: string): Promise<unknown>;
+    /**
+     * Create a new embed configuration
+     * @see POST /v1/embed/new
+     */
+    createEmbed(body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Update an existing embed configuration
+     * @see POST /v1/embed/{embedUuid}
+     */
+    updateEmbed(embedUuid: string, body?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Delete an existing embed configuration
+     * @see DELETE /v1/embed/{embedUuid}
+     */
+    deleteEmbed(embedUuid: string): Promise<unknown>;
+}
+
+/**
+ * V1ApiNamespace - Container for all RealtimeX Developer API (v1) modules.
+ *
+ * Usage:
+ *   const sdk = new RealtimeXSDK({ realtimex: { apiKey: 'sk-...' } });
+ *   await sdk.v1?.workspace.listWorkspaces();
+ *   await sdk.v1?.admin.listUsers();
+ *
+ * Regenerate modules: node scripts/generate-v1-sdk.mjs --force
+ */
+
+declare class V1ApiNamespace {
+    /** @internal Shared HTTP client used by all v1 modules */
+    readonly _client: DeveloperApiClient;
+    auth: V1AuthModule;
+    admin: V1AdminModule;
+    document: V1DocumentModule;
+    workspace: V1WorkspaceModule;
+    system: V1SystemModule;
+    thread: V1ThreadModule;
+    users: V1UsersModule;
+    openai: V1OpenAIModule;
+    embed: V1EmbedModule;
+    constructor(baseUrl: string, apiKey: string, appId?: string);
+}
+
+/**
+ * RealtimeX SDK - Developer API (v1) Error Classes
+ */
+declare class DeveloperApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    constructor(status: number, code: string, message: string);
+}
+declare class AuthenticationError extends DeveloperApiError {
+    constructor(message?: string);
+}
+declare class NotFoundError extends DeveloperApiError {
+    constructor(message?: string);
+}
+declare class ValidationError extends DeveloperApiError {
+    constructor(message: string);
+}
+declare class ServerError extends DeveloperApiError {
+    constructor(message?: string);
+}
+
+export { AuthenticationError as A, DeveloperApiClient as D, NotFoundError as N, ServerError as S, V1ApiNamespace as V, DeveloperApiError as a, ValidationError as b, V1AuthModule as c, V1AdminModule as d, V1DocumentModule as e, V1WorkspaceModule as f, V1SystemModule as g, V1ThreadModule as h, V1UsersModule as i, V1OpenAIModule as j, V1EmbedModule as k };