@nvisy/sdk 0.1.0 → 0.2.0

package/dist/client-D6GtLRbO.d.ts

@@ -0,0 +1,823 @@
+import { A as Account, U as UpdateAccount, a2 as Pagination, a as Activity, c as Annotation, C as CreateAnnotation, d as UpdateAnnotation, e as ApiToken, h as CreateApiToken, f as ApiTokenWithSecret, i as UpdateApiToken, L as Login, j as AuthToken, S as Signup, k as Comment, l as CreateComment, D as Document, n as CreateDocument, o as UpdateDocument, v as ListFilesQuery, F as File, q as UpdateFile, s as DownloadMultipleFilesRequest, t as DownloadArchivedFilesRequest, H as ListIntegrationsQuery, I as Integration, y as CreateIntegration, z as UpdateIntegration, B as UpdateIntegrationCredentials, V as ListInvitesQuery, J as Invite, K as CreateInvite, R as ReplyInvite, M as GenerateInviteCode, N as InviteCode, Y as Member, _ as ListMembersQuery, Z as UpdateMemberRole, a0 as Notification, a3 as IntegrationRun, a6 as CheckHealth, a4 as MonitorStatus, a7 as Webhook, a9 as CreateWebhook, a8 as WebhookWithSecret, aa as UpdateWebhook, ac as Workspace, ad as CreateWorkspace, ae as UpdateWorkspace, ah as paths } from './workspace-3RLqaMcj.js';
+import { Client as Client$1 } from 'openapi-fetch';
+
+/**
+ * @fileoverview Configuration types and constants for the Nvisy SDK.
+ *
+ * This module provides configuration interfaces, default values, and environment
+ * variable names used throughout the SDK.
+ *
+ * @module config
+ */
+/**
+ * Current SDK version.
+ *
+ * Used in the default user agent string and for version tracking.
+ */
+declare const VERSION = "0.2.0";
+/**
+ * Configuration options for creating a Nvisy client.
+ *
+ * The `apiToken` field is required for authentication. All other fields are optional
+ * and will use sensible defaults when omitted.
+ *
+ * @example
+ * ```typescript
+ * const config: ClientConfig = {
+ *   apiToken: "your-api-token",
+ *   baseUrl: "https://api.nvisy.com",
+ *   headers: { "X-Custom-Header": "value" },
+ * };
+ * const client = new Client(config);
+ * ```
+ */
+interface ClientConfig {
+    /**
+     * API token for authentication.
+     *
+     * Tokens can be obtained from the Nvisy dashboard or via the auth endpoints.
+     */
+    apiToken: string;
+    /**
+     * Base URL for the Nvisy API.
+     *
+     * @default "https://api.nvisy.com"
+     */
+    baseUrl?: string;
+    /**
+     * Custom headers to include with every request.
+     *
+     * These headers are merged with the default headers (Content-Type, User-Agent,
+     * and Authorization). Custom headers take precedence over defaults if there
+     * are conflicts.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom user agent string to identify your application.
+     *
+     * @default "@nvisy/sdk v.{version}"
+     */
+    userAgent?: string;
+}
+/**
+ * Default configuration values used when options are not explicitly provided.
+ */
+declare const DEFAULTS: {
+    /**
+     * Default base URL for the Nvisy API.
+     */
+    readonly BASE_URL: "https://api.nvisy.com";
+    /**
+     * Default user agent string.
+     */
+    readonly USER_AGENT: "@nvisy/sdk v.0.2.0";
+};
+
+/**
+ * Service for handling account operations
+ */
+declare class AccountService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * Get the authenticated user's account details
+     * @returns Promise that resolves with the account details
+     * @throws {ApiError} if the request fails
+     */
+    get(): Promise<Account>;
+    /**
+     * Update the authenticated user's account details
+     * @param updates - Account update request
+     * @returns Promise that resolves with the updated account
+     * @throws {ApiError} if the request fails
+     */
+    update(updates: UpdateAccount): Promise<Account>;
+    /**
+     * Delete the authenticated user's account
+     * @returns Promise that resolves when the account is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(): Promise<void>;
+}
+
+/**
+ * Service for handling workspace activity operations
+ */
+declare class ActivitiesService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List activities for a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of activities
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: Pagination): Promise<Activity[]>;
+}
+
+/**
+ * Service for handling file annotation operations
+ */
+declare class AnnotationsService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List annotations for a file
+     * @param fileId - File ID
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of annotations
+     * @throws {ApiError} if the request fails
+     */
+    list(fileId: string, query?: Pagination): Promise<Annotation[]>;
+    /**
+     * Get annotation details by ID
+     * @param annotationId - Annotation ID
+     * @returns Promise that resolves with the annotation details
+     * @throws {ApiError} if the request fails
+     */
+    get(annotationId: string): Promise<Annotation>;
+    /**
+     * Create a new annotation
+     * @param fileId - File ID
+     * @param annotation - Annotation creation request
+     * @returns Promise that resolves with the created annotation
+     * @throws {ApiError} if the request fails
+     */
+    create(fileId: string, annotation: CreateAnnotation): Promise<Annotation>;
+    /**
+     * Update an existing annotation
+     * @param annotationId - Annotation ID
+     * @param updates - Annotation update request
+     * @returns Promise that resolves with the updated annotation
+     * @throws {ApiError} if the request fails
+     */
+    update(annotationId: string, updates: UpdateAnnotation): Promise<Annotation>;
+    /**
+     * Delete an annotation
+     * @param annotationId - Annotation ID
+     * @returns Promise that resolves when the annotation is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(annotationId: string): Promise<void>;
+}
+
+/**
+ * Service for handling API token operations
+ */
+declare class ApiTokensService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List all API tokens for the authenticated account
+     * @param options - Pagination options
+     * @returns Promise that resolves with the list of API tokens
+     * @throws {ApiError} if the request fails
+     */
+    list(options?: {
+        offset?: number;
+        limit?: number;
+    }): Promise<ApiToken[]>;
+    /**
+     * Get a specific API token by access token
+     * @param accessToken - The access token identifier
+     * @returns Promise that resolves with the API token details
+     * @throws {ApiError} if the request fails
+     */
+    get(accessToken: string): Promise<ApiToken>;
+    /**
+     * Create a new API token
+     * @param token - Token creation request
+     * @returns Promise that resolves with the created token (includes secret, shown only once)
+     * @throws {ApiError} if the request fails
+     */
+    create(token: CreateApiToken): Promise<ApiTokenWithSecret>;
+    /**
+     * Update an existing API token
+     * @param accessToken - The access token identifier
+     * @param updates - Token update request
+     * @returns Promise that resolves with the updated token
+     * @throws {ApiError} if the request fails
+     */
+    update(accessToken: string, updates: UpdateApiToken): Promise<ApiToken>;
+    /**
+     * Revoke an API token
+     * @param accessToken - The access token identifier
+     * @returns Promise that resolves when the token is revoked
+     * @throws {ApiError} if the request fails
+     */
+    revoke(accessToken: string): Promise<void>;
+}
+
+/**
+ * Service for handling authentication operations
+ */
+declare class AuthService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * Login with email and password
+     * @param credentials - Login credentials
+     * @returns Promise that resolves with the auth response containing access token
+     * @throws {ApiError} if the request fails
+     */
+    login(credentials: Login): Promise<AuthToken>;
+    /**
+     * Sign up a new account
+     * @param details - Signup details
+     * @returns Promise that resolves with the auth response containing access token
+     * @throws {ApiError} if the request fails
+     */
+    signup(details: Signup): Promise<AuthToken>;
+}
+
+/**
+ * Service for handling file comment operations
+ */
+declare class CommentsService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List all comments on a file
+     * @param fileId - File ID
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of comments
+     * @throws {ApiError} if the request fails
+     */
+    list(fileId: string, query?: Pagination): Promise<Comment[]>;
+    /**
+     * Create a new comment on a file
+     * @param fileId - File ID
+     * @param comment - Comment creation request
+     * @returns Promise that resolves with the created comment
+     * @throws {ApiError} if the request fails
+     */
+    create(fileId: string, comment: CreateComment): Promise<Comment>;
+    /**
+     * Delete a comment
+     * @param fileId - File ID
+     * @param commentId - Comment ID
+     * @returns Promise that resolves when the comment is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(fileId: string, commentId: string): Promise<void>;
+}
+
+/**
+ * Service for handling document operations
+ */
+declare class DocumentsService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List documents in a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of documents
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: Pagination): Promise<Document[]>;
+    /**
+     * Get document details by ID
+     * @param documentId - Document ID
+     * @returns Promise that resolves with the document details
+     * @throws {ApiError} if the request fails
+     */
+    get(documentId: string): Promise<Document>;
+    /**
+     * Create a new document
+     * @param workspaceId - Workspace ID
+     * @param document - Document creation request
+     * @returns Promise that resolves with the created document
+     * @throws {ApiError} if the request fails
+     */
+    create(workspaceId: string, document: CreateDocument): Promise<Document>;
+    /**
+     * Update an existing document
+     * @param documentId - Document ID
+     * @param updates - Document update request
+     * @returns Promise that resolves with the updated document
+     * @throws {ApiError} if the request fails
+     */
+    update(documentId: string, updates: UpdateDocument): Promise<Document>;
+    /**
+     * Delete a document
+     * @param documentId - Document ID
+     * @returns Promise that resolves when the document is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(documentId: string): Promise<void>;
+}
+
+/**
+ * Service for handling file operations
+ */
+declare class FilesService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List files in a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (formats, sortBy, order, offset, limit)
+     * @returns Promise that resolves with the list of files
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: ListFilesQuery & Pagination): Promise<File[]>;
+    /**
+     * Download a file by ID
+     * @param fileId - File ID
+     * @returns Promise that resolves with the file response
+     * @throws {ApiError} if the request fails
+     */
+    download(fileId: string): Promise<Response>;
+    /**
+     * Update a file's metadata
+     * @param fileId - File ID
+     * @param updates - File update request
+     * @returns Promise that resolves with the updated file
+     * @throws {ApiError} if the request fails
+     */
+    update(fileId: string, updates: UpdateFile): Promise<File>;
+    /**
+     * Delete a file
+     * @param fileId - File ID
+     * @returns Promise that resolves when the file is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(fileId: string): Promise<void>;
+    /**
+     * Download multiple files
+     * @param workspaceId - Workspace ID
+     * @param request - Download request with file IDs
+     * @returns Promise that resolves with the download response
+     * @throws {ApiError} if the request fails
+     */
+    downloadMultiple(workspaceId: string, request: DownloadMultipleFilesRequest): Promise<Response>;
+    /**
+     * Download files as an archive
+     * @param workspaceId - Workspace ID
+     * @param request - Archive download request
+     * @returns Promise that resolves with the archive response
+     * @throws {ApiError} if the request fails
+     */
+    downloadArchive(workspaceId: string, request: DownloadArchivedFilesRequest): Promise<Response>;
+}
+
+/**
+ * Service for handling integration operations
+ */
+declare class IntegrationsService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List integrations for a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (integrationType, offset, limit)
+     * @returns Promise that resolves with the list of integrations
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: ListIntegrationsQuery & Pagination): Promise<Integration[]>;
+    /**
+     * Get integration details by ID
+     * @param integrationId - Integration ID
+     * @returns Promise that resolves with the integration details
+     * @throws {ApiError} if the request fails
+     */
+    get(integrationId: string): Promise<Integration>;
+    /**
+     * Create a new integration
+     * @param workspaceId - Workspace ID
+     * @param integration - Integration creation request
+     * @returns Promise that resolves with the created integration
+     * @throws {ApiError} if the request fails
+     */
+    create(workspaceId: string, integration: CreateIntegration): Promise<Integration>;
+    /**
+     * Update an existing integration
+     * @param integrationId - Integration ID
+     * @param updates - Integration update request
+     * @returns Promise that resolves with the updated integration
+     * @throws {ApiError} if the request fails
+     */
+    update(integrationId: string, updates: UpdateIntegration): Promise<Integration>;
+    /**
+     * Update integration credentials
+     * @param integrationId - Integration ID
+     * @param credentials - New credentials
+     * @returns Promise that resolves with the updated integration
+     * @throws {ApiError} if the request fails
+     */
+    updateCredentials(integrationId: string, credentials: UpdateIntegrationCredentials): Promise<Integration>;
+    /**
+     * Delete an integration
+     * @param integrationId - Integration ID
+     * @returns Promise that resolves when the integration is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(integrationId: string): Promise<void>;
+}
+
+/**
+ * Service for handling workspace invitation operations
+ */
+declare class InvitesService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List all invitations for a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (role, sortBy, order, offset, limit)
+     * @returns Promise that resolves with the list of invitations
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: ListInvitesQuery & Pagination): Promise<Invite[]>;
+    /**
+     * Send an invitation to join a workspace
+     * @param workspaceId - Workspace ID
+     * @param invite - Invitation request
+     * @returns Promise that resolves with the created invitation
+     * @throws {ApiError} if the request fails
+     */
+    send(workspaceId: string, invite: CreateInvite): Promise<Invite>;
+    /**
+     * Cancel a pending invitation
+     * @param inviteId - Invite ID
+     * @returns Promise that resolves when the invitation is canceled
+     * @throws {ApiError} if the request fails
+     */
+    cancel(inviteId: string): Promise<void>;
+    /**
+     * Reply to an invitation (accept or decline)
+     * @param inviteId - Invite ID
+     * @param reply - Reply request
+     * @returns Promise that resolves with the updated invitation
+     * @throws {ApiError} if the request fails
+     */
+    reply(inviteId: string, reply: ReplyInvite): Promise<Invite>;
+    /**
+     * Generate a shareable invite code for a workspace
+     * @param workspaceId - Workspace ID
+     * @param options - Invite code generation options
+     * @returns Promise that resolves with the generated invite code
+     * @throws {ApiError} if the request fails
+     */
+    generateCode(workspaceId: string, options: GenerateInviteCode): Promise<InviteCode>;
+    /**
+     * Join a workspace using an invite code
+     * @param inviteCode - The invite code
+     * @returns Promise that resolves with the member details
+     * @throws {ApiError} if the request fails
+     */
+    joinWithCode(inviteCode: string): Promise<Member>;
+}
+
+/**
+ * Service for handling member operations
+ */
+declare class MembersService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List members of a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (role, has2fa, sortBy, order, offset, limit)
+     * @returns Promise that resolves with the list of members
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: ListMembersQuery & Pagination): Promise<Member[]>;
+    /**
+     * Get member details by account ID
+     * @param workspaceId - Workspace ID
+     * @param accountId - Account ID
+     * @returns Promise that resolves with the member details
+     * @throws {ApiError} if the request fails
+     */
+    get(workspaceId: string, accountId: string): Promise<Member>;
+    /**
+     * Update a member's role
+     * @param workspaceId - Workspace ID
+     * @param accountId - Account ID
+     * @param role - New role for the member
+     * @returns Promise that resolves with the updated member
+     * @throws {ApiError} if the request fails
+     */
+    updateRole(workspaceId: string, accountId: string, role: UpdateMemberRole): Promise<Member>;
+    /**
+     * Remove a member from a workspace
+     * @param workspaceId - Workspace ID
+     * @param accountId - Account ID
+     * @returns Promise that resolves when the member is removed
+     * @throws {ApiError} if the request fails
+     */
+    remove(workspaceId: string, accountId: string): Promise<void>;
+    /**
+     * Leave a workspace
+     * @param workspaceId - Workspace ID
+     * @returns Promise that resolves when the member has left
+     * @throws {ApiError} if the request fails
+     */
+    leave(workspaceId: string): Promise<void>;
+}
+
+/**
+ * Service for handling account notification operations
+ */
+declare class NotificationsService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List notifications for the authenticated account
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of notifications
+     * @throws {ApiError} if the request fails
+     */
+    list(query?: Pagination): Promise<Notification[]>;
+}
+
+/**
+ * Service for handling integration run operations
+ */
+declare class RunsService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List integration runs for a workspace
+     * @param workspaceId - Workspace ID
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of integration runs
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string, query?: Pagination): Promise<IntegrationRun[]>;
+    /**
+     * Get integration run details by ID
+     * @param runId - Run ID
+     * @returns Promise that resolves with the integration run details
+     * @throws {ApiError} if the request fails
+     */
+    get(runId: string): Promise<IntegrationRun>;
+}
+
+/**
+ * Service for handling status and health check operations
+ */
+declare class StatusService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * Check the health status of the API
+     * @param options - Health check options
+     * @returns Promise that resolves with the API health status
+     */
+    health(options?: CheckHealth): Promise<MonitorStatus>;
+}
+
+/**
+ * Service for handling webhook operations
+ */
+declare class WebhooksService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List all webhooks in a workspace
+     * @param workspaceId - Workspace ID
+     * @returns Promise that resolves with the list of webhooks
+     * @throws {ApiError} if the request fails
+     */
+    list(workspaceId: string): Promise<Webhook[]>;
+    /**
+     * Get a specific webhook by ID
+     * @param webhookId - Webhook ID
+     * @returns Promise that resolves with the webhook details
+     * @throws {ApiError} if the request fails
+     */
+    get(webhookId: string): Promise<Webhook>;
+    /**
+     * Create a new webhook
+     * @param workspaceId - Workspace ID
+     * @param webhook - Webhook creation request
+     * @returns Promise that resolves with the created webhook (includes secret, shown only once)
+     * @throws {ApiError} if the request fails
+     */
+    create(workspaceId: string, webhook: CreateWebhook): Promise<WebhookWithSecret>;
+    /**
+     * Update an existing webhook
+     * @param webhookId - Webhook ID
+     * @param updates - Webhook update request
+     * @returns Promise that resolves with the updated webhook
+     * @throws {ApiError} if the request fails
+     */
+    update(webhookId: string, updates: UpdateWebhook): Promise<Webhook>;
+    /**
+     * Delete a webhook
+     * @param webhookId - Webhook ID
+     * @returns Promise that resolves when the webhook is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(webhookId: string): Promise<void>;
+}
+
+/**
+ * Service for handling workspace operations
+ */
+declare class WorkspacesService {
+    #private;
+    constructor(api: ApiClient);
+    /**
+     * List all workspaces
+     * @param query - Optional query parameters (offset, limit)
+     * @returns Promise that resolves with the list of workspaces
+     * @throws {ApiError} if the request fails
+     */
+    list(query?: Pagination): Promise<Workspace[]>;
+    /**
+     * Get workspace details by ID
+     * @param workspaceId - Workspace ID
+     * @returns Promise that resolves with the workspace details
+     * @throws {ApiError} if the request fails
+     */
+    get(workspaceId: string): Promise<Workspace>;
+    /**
+     * Create a new workspace
+     * @param workspace - Workspace creation request
+     * @returns Promise that resolves with the created workspace
+     * @throws {ApiError} if the request fails
+     */
+    create(workspace: CreateWorkspace): Promise<Workspace>;
+    /**
+     * Update an existing workspace
+     * @param workspaceId - Workspace ID
+     * @param updates - Workspace update request
+     * @returns Promise that resolves with the updated workspace
+     * @throws {ApiError} if the request fails
+     */
+    update(workspaceId: string, updates: UpdateWorkspace): Promise<Workspace>;
+    /**
+     * Delete a workspace
+     * @param workspaceId - Workspace ID
+     * @returns Promise that resolves when the workspace is deleted
+     * @throws {ApiError} if the request fails
+     */
+    delete(workspaceId: string): Promise<void>;
+}
+
+/**
+ * @fileoverview Main client for the Nvisy SDK.
+ *
+ * This module exports the {@link Client} class, which is the primary entry point
+ * for interacting with the Nvisy document processing API.
+ *
+ * @module client
+ *
+ * @example
+ * ```typescript
+ * const client = new Client({ apiToken: "your-api-token" });
+ * const account = await client.account.get();
+ * ```
+ */
+
+/**
+ * Typed openapi-fetch client for the Nvisy API.
+ *
+ * This type represents the low-level HTTP client configured with the Nvisy API schema.
+ * It's exposed via {@link Client.api} for advanced use cases requiring direct API access.
+ */
+type ApiClient = Client$1<paths>;
+/**
+ * Main client class for interacting with the Nvisy document processing API.
+ *
+ * @example
+ * ```typescript
+ * const client = new Client({ apiToken: "your-api-token" });
+ * const account = await client.account.get();
+ * const workspaces = await client.workspaces.list();
+ * ```
+ */
+declare class Client {
+    #private;
+    /**
+     * Creates a new Nvisy client instance.
+     *
+     * @param config - Configuration options with required `apiToken`
+     * @throws {ConfigError} If the API token is invalid
+     *
+     * @example
+     * ```typescript
+     * const client = new Client({
+     *   apiToken: "your-api-token",
+     *   baseUrl: "https://custom.api.nvisy.com",
+     * });
+     * const account = await client.account.get();
+     * ```
+     */
+    constructor(config: ClientConfig);
+    /**
+     * Creates a new client with a different API token.
+     *
+     * Returns a new client instance with the new token. The original client
+     * remains unchanged. All other configuration (base URL, headers, etc.)
+     * is preserved in the new client.
+     *
+     * @param apiToken - The new API token
+     * @returns A new Client instance with the new token
+     * @throws {ConfigError} If the API token is invalid
+     *
+     * @example
+     * ```typescript
+     * const client = new Client({ apiToken: "original-token" });
+     * const newClient = client.withApiToken("new-token");
+     *
+     * // newClient uses the new token
+     * // client still uses the original token
+     * ```
+     */
+    withApiToken(apiToken: string): Client;
+    /**
+     * The base URL used for API requests.
+     *
+     * @returns The configured base URL
+     */
+    get baseUrl(): string;
+    /**
+     * The underlying openapi-fetch client for direct API access.
+     *
+     * Use this for advanced scenarios where you need direct access to the
+     * HTTP client, such as calling endpoints not covered by the service classes.
+     *
+     * @returns The configured ApiClient instance
+     */
+    get api(): ApiClient;
+    /**
+     * Service for authentication operations (login, signup, logout).
+     *
+     * @returns The AuthService instance
+     */
+    get auth(): AuthService;
+    /**
+     * Service for API status and health checks.
+     *
+     * @returns The StatusService instance
+     */
+    get status(): StatusService;
+    /**
+     * Service for managing the authenticated user's account.
+     *
+     * @returns The AccountService instance
+     */
+    get account(): AccountService;
+    /**
+     * Service for managing API tokens.
+     *
+     * @returns The ApiTokensService instance
+     */
+    get apiTokens(): ApiTokensService;
+    /**
+     * Service for managing file comments.
+     *
+     * @returns The CommentsService instance
+     */
+    get comments(): CommentsService;
+    /**
+     * Service for document operations.
+     *
+     * @returns The DocumentsService instance
+     */
+    get documents(): DocumentsService;
+    /**
+     * Service for file operations (upload, download, delete).
+     *
+     * @returns The FilesService instance
+     */
+    get files(): FilesService;
+    /**
+     * Service for managing integrations.
+     *
+     * @returns The IntegrationsService instance
+     */
+    get integrations(): IntegrationsService;
+    /**
+     * Service for managing workspace invitations.
+     *
+     * @returns The InvitesService instance
+     */
+    get invites(): InvitesService;
+    /**
+     * Service for managing workspace members.
+     *
+     * @returns The MembersService instance
+     */
+    get members(): MembersService;
+    /**
+     * Service for managing webhooks.
+     *
+     * @returns The WebhooksService instance
+     */
+    get webhooks(): WebhooksService;
+    /**
+     * Service for managing workspaces.
+     *
+     * @returns The WorkspacesService instance
+     */
+    get workspaces(): WorkspacesService;
+}
+
+export { type ApiClient as A, Client as C, DEFAULTS as D, FilesService as F, IntegrationsService as I, MembersService as M, NotificationsService as N, RunsService as R, StatusService as S, VERSION as V, WebhooksService as W, type ClientConfig as a, AccountService as b, ActivitiesService as c, AnnotationsService as d, ApiTokensService as e, AuthService as f, CommentsService as g, DocumentsService as h, InvitesService as i, WorkspacesService as j };