@robosystems/client 0.1.15 → 0.1.16

package/sdk/sdk.gen.d.ts

@@ -0,0 +1,1269 @@
+import type { Options as ClientOptions, TDataShape, Client } from './client';
+import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, GetCurrentUserErrors, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetUserGraphsData, GetUserGraphsResponses, GetUserGraphsErrors, SelectUserGraphData, SelectUserGraphResponses, SelectUserGraphErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, ListUserApiKeysErrors, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetUserUsageErrors, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, ExportBackupData, ExportBackupResponses, ExportBackupErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, KuzuBackupHealthData, KuzuBackupHealthResponses, KuzuBackupHealthErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphPricingInfoV1GraphIdBillingPricingGetData, GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, GetCreditBillingInfoV1GraphIdBillingCreditsGetData, GetCreditBillingInfoV1GraphIdBillingCreditsGetResponses, GetCreditBillingInfoV1GraphIdBillingCreditsGetErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Register New User
+ * Register a new user account with email and password. Security controls vary by environment: CAPTCHA and email verification are disabled in development for API testing, but required in production.
+ */
+export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => import("./client").RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "fields">;
+/**
+ * User Login
+ * Authenticate user with email and password.
+ */
+export declare const loginUser: <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => import("./client").RequestResult<LoginUserResponses, LoginUserErrors, ThrowOnError, "fields">;
+/**
+ * User Logout
+ * Logout user and invalidate session.
+ */
+export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError, "fields">;
+/**
+ * Get Current User
+ * Get current authenticated user from session.
+ */
+export declare const getCurrentAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError, "fields">;
+/**
+ * Refresh Session
+ * Refresh user session and extend authentication token.
+ */
+export declare const refreshSession: <ThrowOnError extends boolean = false>(options?: Options<RefreshSessionData, ThrowOnError>) => import("./client").RequestResult<RefreshSessionResponses, RefreshSessionErrors, ThrowOnError, "fields">;
+/**
+ * Generate SSO Token
+ * Generate a temporary SSO token for cross-app authentication.
+ */
+export declare const generateSsoToken: <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) => import("./client").RequestResult<GenerateSsoTokenResponses, GenerateSsoTokenErrors, ThrowOnError, "fields">;
+/**
+ * SSO Login
+ * Authenticate user with SSO token and establish session.
+ */
+export declare const ssoLogin: <ThrowOnError extends boolean = false>(options: Options<SsoLoginData, ThrowOnError>) => import("./client").RequestResult<SsoLoginResponses, SsoLoginErrors, ThrowOnError, "fields">;
+/**
+ * SSO Token Exchange
+ * Exchange SSO token for secure session handoff to target application.
+ */
+export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) => import("./client").RequestResult<SsoTokenExchangeResponses, SsoTokenExchangeErrors, ThrowOnError, "fields">;
+/**
+ * Complete SSO Authentication
+ * Complete SSO authentication using session ID from secure handoff.
+ */
+export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => import("./client").RequestResult<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError, "fields">;
+/**
+ * Get CAPTCHA Configuration
+ * Get CAPTCHA configuration including site key and whether CAPTCHA is required.
+ */
+export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => import("./client").RequestResult<GetCaptchaConfigResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Password Policy
+ * Get current password policy requirements for frontend validation
+ */
+export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => import("./client").RequestResult<GetPasswordPolicyResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Check Password Strength
+ * Check password strength and get validation feedback
+ */
+export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => import("./client").RequestResult<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError, "fields">;
+/**
+ * Health Check
+ * Service health check endpoint for monitoring and load balancers
+ */
+export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => import("./client").RequestResult<GetServiceStatusResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Current User
+ * Returns information about the currently authenticated user.
+ */
+export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError, "fields">;
+/**
+ * Update User Profile
+ * Update the current user's profile information.
+ */
+export declare const updateUser: <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => import("./client").RequestResult<UpdateUserResponses, UpdateUserErrors, ThrowOnError, "fields">;
+/**
+ * Get User Graphs
+ * Get all graph databases accessible to the current user.
+ */
+export declare const getUserGraphs: <ThrowOnError extends boolean = false>(options?: Options<GetUserGraphsData, ThrowOnError>) => import("./client").RequestResult<GetUserGraphsResponses, GetUserGraphsErrors, ThrowOnError, "fields">;
+/**
+ * Select User Graph
+ * Select a specific graph as the active graph for the user.
+ */
+export declare const selectUserGraph: <ThrowOnError extends boolean = false>(options: Options<SelectUserGraphData, ThrowOnError>) => import("./client").RequestResult<SelectUserGraphResponses, SelectUserGraphErrors, ThrowOnError, "fields">;
+/**
+ * Get All Credit Summaries
+ * Get credit summaries for all graphs owned by the user.
+ *
+ * This endpoint provides a consolidated view of credit usage across
+ * all graphs where the user has access, helping to monitor overall
+ * credit consumption and plan usage.
+ *
+ * No credits are consumed for viewing summaries.
+ */
+export declare const getAllCreditSummaries: <ThrowOnError extends boolean = false>(options?: Options<GetAllCreditSummariesData, ThrowOnError>) => import("./client").RequestResult<GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, ThrowOnError, "fields">;
+/**
+ * Update Password
+ * Update the current user's password.
+ */
+export declare const updateUserPassword: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) => import("./client").RequestResult<UpdateUserPasswordResponses, UpdateUserPasswordErrors, ThrowOnError, "fields">;
+/**
+ * List API Keys
+ * Get all API keys for the current user.
+ */
+export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => import("./client").RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError, "fields">;
+/**
+ * Create API Key
+ * Create a new API key for the current user.
+ */
+export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError, "fields">;
+/**
+ * Revoke API Key
+ * Revoke (deactivate) an API key.
+ */
+export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, ThrowOnError, "fields">;
+/**
+ * Update API Key
+ * Update an API key's name or description.
+ */
+export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError, "fields">;
+/**
+ * Get user limits
+ * Retrieve current limits and restrictions for the authenticated user
+ */
+export declare const getUserLimits: <ThrowOnError extends boolean = false>(options?: Options<GetUserLimitsData, ThrowOnError>) => import("./client").RequestResult<GetUserLimitsResponses, GetUserLimitsErrors, ThrowOnError, "fields">;
+/**
+ * Get user usage statistics
+ * Retrieve current usage statistics and remaining limits for the authenticated user
+ */
+export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, GetUserUsageErrors, ThrowOnError, "fields">;
+/**
+ * Get shared repository rate limit status
+ * Get current rate limit status and usage for a shared repository.
+ *
+ * Returns:
+ * - Current usage across different time windows
+ * - Rate limits based on subscription tier
+ * - Remaining quota
+ * - Reset times
+ *
+ * Note: All queries are FREE - this only shows rate limit status.
+ */
+export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
+/**
+ * Get all shared repository limits
+ * Get rate limit status for all shared repositories the user has access to.
+ */
+export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
+/**
+ * Get User Usage Overview
+ * Get a high-level overview of usage statistics for the current user.
+ */
+export declare const getUserUsageOverview: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageOverviewData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, ThrowOnError, "fields">;
+/**
+ * Get Detailed User Analytics
+ * Get comprehensive analytics for the current user including API usage and recent activity.
+ */
+export declare const getDetailedUserAnalytics: <ThrowOnError extends boolean = false>(options?: Options<GetDetailedUserAnalyticsData, ThrowOnError>) => import("./client").RequestResult<GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, ThrowOnError, "fields">;
+/**
+ * Get User Subscriptions
+ * Retrieve user's current shared repository subscriptions with detailed information
+ */
+export declare const getUserSharedSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<GetUserSharedSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, ThrowOnError, "fields">;
+/**
+ * Subscribe to Shared Repository
+ * Create a new subscription to a shared repository add-on with specified tier
+ */
+export declare const subscribeToSharedRepository: <ThrowOnError extends boolean = false>(options: Options<SubscribeToSharedRepositoryData, ThrowOnError>) => import("./client").RequestResult<SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, ThrowOnError, "fields">;
+/**
+ * Upgrade Subscription Tier
+ * Upgrade a subscription to a higher tier with immediate credit adjustment
+ */
+export declare const upgradeSharedRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<UpgradeSharedRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Subscription
+ * Cancel a shared repository subscription and disable associated credit pool
+ */
+export declare const cancelSharedRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSharedRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, ThrowOnError, "fields">;
+/**
+ * Get Credit Balances
+ * Retrieve credit balances for all shared repository subscriptions
+ */
+export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean = false>(options?: Options<GetSharedRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, ThrowOnError, "fields">;
+/**
+ * Get Repository Credits
+ * Get credit balance for a specific shared repository
+ */
+export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
+/**
+ * List Connection Options
+ * Get metadata about all available data connection providers.
+ *
+ * This endpoint returns comprehensive information about each supported provider:
+ *
+ * **SEC EDGAR**: Public entity financial filings
+ * - No authentication required (public data)
+ * - 10-K, 10-Q, 8-K reports with XBRL data
+ * - Historical and real-time filing access
+ *
+ * **QuickBooks Online**: Full accounting system integration
+ * - OAuth 2.0 authentication
+ * - Chart of accounts, transactions, trial balance
+ * - Real-time sync capabilities
+ *
+ * **Plaid**: Bank account connections
+ * - Secure bank authentication via Plaid Link
+ * - Transaction history and balances
+ * - Multi-account support
+ *
+ * No credits are consumed for viewing connection options.
+ */
+export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => import("./client").RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError, "fields">;
+/**
+ * List Connections
+ * List all data connections in the graph.
+ *
+ * Returns active and inactive connections with their current status.
+ * Connections can be filtered by:
+ * - **Entity**: Show connections for a specific entity
+ * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
+ *
+ * Each connection shows:
+ * - Current sync status and health
+ * - Last successful sync timestamp
+ * - Configuration metadata
+ * - Error messages if any
+ *
+ * No credits are consumed for listing connections.
+ */
+export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
+/**
+ * Create Connection
+ * Create a new data connection for external system integration.
+ *
+ * This endpoint initiates connections to external data sources:
+ *
+ * **SEC Connections**:
+ * - Provide entity CIK for automatic filing retrieval
+ * - No authentication needed
+ * - Begins immediate data sync
+ *
+ * **QuickBooks Connections**:
+ * - Returns OAuth URL for authorization
+ * - Requires admin permissions in QuickBooks
+ * - Complete with OAuth callback
+ *
+ * **Plaid Connections**:
+ * - Returns Plaid Link token
+ * - User completes bank authentication
+ * - Exchange public token for access
+ *
+ * Note:
+ * This operation is FREE - no credit consumption required.
+ */
+export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
+/**
+ * Delete Connection
+ * Delete a data connection and clean up related resources.
+ *
+ * This operation:
+ * - Removes the connection configuration
+ * - Preserves any imported data in the graph
+ * - Performs provider-specific cleanup
+ * - Revokes stored credentials
+ *
+ * Note:
+ * This operation is FREE - no credit consumption required.
+ *
+ * Only users with admin role can delete connections.
+ */
+export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
+/**
+ * Get Connection
+ * Get detailed information about a specific connection.
+ *
+ * Returns comprehensive connection details including:
+ * - Current status and health indicators
+ * - Authentication state
+ * - Sync history and statistics
+ * - Error details if any
+ * - Provider-specific metadata
+ *
+ * No credits are consumed for viewing connection details.
+ */
+export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
+/**
+ * Sync Connection
+ * Trigger a data synchronization for the connection.
+ *
+ * Initiates data sync based on provider type:
+ *
+ * **SEC Sync**:
+ * - Downloads latest filings from EDGAR
+ * - Parses XBRL data and updates graph
+ * - Typically completes in 5-10 minutes
+ *
+ * **QuickBooks Sync**:
+ * - Fetches latest transactions and balances
+ * - Updates chart of accounts
+ * - Generates fresh trial balance
+ * - Duration depends on data volume
+ *
+ * **Plaid Sync**:
+ * - Retrieves recent bank transactions
+ * - Updates account balances
+ * - Categorizes new transactions
+ *
+ * Note:
+ * This operation is FREE - no credit consumption required.
+ *
+ * Returns a task ID for monitoring sync progress.
+ */
+export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
+/**
+ * Create Link Token
+ * Create a link token for embedded authentication providers.
+ *
+ * This endpoint generates a temporary token used to initialize embedded authentication UI.
+ *
+ * Currently supported providers:
+ * - **Plaid**: Bank account connections with real-time transaction access
+ *
+ * The link token:
+ * - Expires after 4 hours
+ * - Is single-use only
+ * - Must be used with the matching frontend SDK
+ * - Includes user and entity context
+ *
+ * No credits are consumed for creating link tokens.
+ */
+export declare const createLinkToken: <ThrowOnError extends boolean = false>(options: Options<CreateLinkTokenData, ThrowOnError>) => import("./client").RequestResult<CreateLinkTokenResponses, CreateLinkTokenErrors, ThrowOnError, "fields">;
+/**
+ * Exchange Link Token
+ * Exchange a public token for permanent access credentials.
+ *
+ * This completes the embedded authentication flow after user authorization.
+ *
+ * The exchange process:
+ * 1. Validates the temporary public token
+ * 2. Exchanges it for permanent access credentials
+ * 3. Updates the connection with account information
+ * 4. Optionally triggers initial data sync
+ *
+ * Supported providers:
+ * - **Plaid**: Exchanges Plaid Link public token for access token
+ *
+ * Security:
+ * - Public tokens expire after 30 minutes
+ * - Each token can only be exchanged once
+ * - Full audit trail is maintained
+ *
+ * No credits are consumed for token exchange.
+ */
+export declare const exchangeLinkToken: <ThrowOnError extends boolean = false>(options: Options<ExchangeLinkTokenData, ThrowOnError>) => import("./client").RequestResult<ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, ThrowOnError, "fields">;
+/**
+ * Init Oauth
+ * Initialize OAuth flow for a connection.
+ *
+ * This generates an authorization URL that the frontend should redirect the user to.
+ * Currently supports: QuickBooks
+ */
+export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => import("./client").RequestResult<InitOAuthResponses, InitOAuthErrors, ThrowOnError, "fields">;
+/**
+ * OAuth Callback
+ * Handle OAuth callback from provider after user authorization.
+ *
+ * This endpoint completes the OAuth flow:
+ * 1. Validates the OAuth state parameter
+ * 2. Exchanges authorization code for access tokens
+ * 3. Stores tokens securely
+ * 4. Updates connection status
+ * 5. Optionally triggers initial sync
+ *
+ * Supported providers:
+ * - **QuickBooks**: Accounting data integration
+ *
+ * Security measures:
+ * - State validation prevents CSRF attacks
+ * - User context is verified
+ * - Tokens are encrypted before storage
+ * - Full audit trail is maintained
+ *
+ * No credits are consumed for OAuth callbacks.
+ */
+export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => import("./client").RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError, "fields">;
+/**
+ * Query Financial Agent
+ * AI-powered financial analysis with direct access to graph data.
+ *
+ * This endpoint provides intelligent financial analysis using an AI agent that can:
+ * - Analyze entity financial statements and SEC filings
+ * - Review QuickBooks transactions and accounting data
+ * - Perform multi-period trend analysis
+ * - Generate insights from balance sheets and income statements
+ * - Answer complex financial queries with contextual understanding
+ *
+ * **Execution Modes:**
+ * - **Quick Analysis** (default): Synchronous responses for simple queries (1-2 tool calls)
+ * - **Extended Analysis**: Asynchronous processing for complex research (returns operation_id for SSE monitoring)
+ *
+ * **Extended Analysis Monitoring:**
+ * For complex queries, connect to the SSE stream for real-time progress:
+ * ```javascript
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
+ * eventSource.onmessage = (event) => {
+ * const data = JSON.parse(event.data);
+ * console.log('Analysis:', data.message);
+ * };
+ * ```
+ *
+ * **SSE Connection Limits:**
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic circuit breaker for Redis failures
+ * - Graceful degradation with fallback to polling if SSE unavailable
+ *
+ * **Events Emitted:**
+ * - `operation_started`: Analysis begins
+ * - `operation_progress`: Tool calls, analysis steps
+ * - `operation_completed`: Final comprehensive analysis
+ * - `operation_error`: Analysis failed
+ *
+ * **Error Handling:**
+ * - `429 Too Many Requests`: SSE connection limit exceeded
+ * - `503 Service Unavailable`: SSE system temporarily disabled
+ * - Fallback to status polling endpoint if SSE unavailable
+ *
+ * **Credit Consumption:**
+ * - AI operations consume credits based on actual token usage
+ * - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
+ * - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
+ * - Credits are consumed after operation completes based on actual usage
+ *
+ * The agent automatically determines query complexity or you can force extended analysis.
+ */
+export declare const queryFinancialAgent: <ThrowOnError extends boolean = false>(options: Options<QueryFinancialAgentData, ThrowOnError>) => import("./client").RequestResult<QueryFinancialAgentResponses, QueryFinancialAgentErrors, ThrowOnError, "fields">;
+/**
+ * List MCP Tools
+ * Get available Model Context Protocol tools for graph analysis.
+ *
+ * This endpoint returns a comprehensive list of MCP tools optimized for AI agents:
+ * - Tool schemas with detailed parameter documentation
+ * - Context-aware descriptions based on graph type
+ * - Capability indicators for streaming and progress
+ *
+ * The tool list is customized based on:
+ * - Graph type (shared repository vs user graph)
+ * - User permissions and subscription tier
+ * - Backend capabilities (Kuzu, Neo4j, etc.)
+ *
+ * Credit consumption:
+ * - Listing tools is FREE to encourage exploration
+ * - Tool execution costs vary by operation complexity
+ */
+export declare const listMcpTools: <ThrowOnError extends boolean = false>(options: Options<ListMcpToolsData, ThrowOnError>) => import("./client").RequestResult<ListMcpToolsResponses, ListMcpToolsErrors, ThrowOnError, "fields">;
+/**
+ * Execute MCP Tool
+ * Execute an MCP tool with intelligent response optimization.
+ *
+ * This endpoint automatically selects the best execution strategy based on:
+ * - Tool type and estimated complexity
+ * - Client capabilities (AI agent detection)
+ * - System load and queue status
+ * - Graph type (shared repository vs user graph)
+ *
+ * **Response Formats:**
+ * - **JSON**: Direct response for small/fast operations
+ * - **SSE**: Server-Sent Events for progress monitoring
+ * - **NDJSON**: Newline-delimited JSON for streaming
+ * - **Queued**: Asynchronous execution with status monitoring
+ *
+ * **SSE Streaming Support:**
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic circuit breaker for Redis failures
+ * - Graceful degradation to direct response if SSE unavailable
+ * - Progress events for long-running operations
+ *
+ * **AI Agent Optimization:**
+ * The Node.js MCP client transparently handles all response formats,
+ * presenting a unified interface to AI agents. Streaming responses are
+ * automatically aggregated for seamless consumption.
+ *
+ * **Error Handling:**
+ * - `429 Too Many Requests`: Connection limit or rate limit exceeded
+ * - `503 Service Unavailable`: SSE system temporarily disabled
+ * - `408 Request Timeout`: Tool execution exceeded timeout
+ * - Clients should implement exponential backoff on errors
+ *
+ * **Note:**
+ * MCP tool calls are currently FREE and do not consume credits.
+ */
+export declare const callMcpTool: <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => import("./client").RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError, "fields">;
+/**
+ * Create Backup
+ * Create a backup of the graph database.
+ *
+ * Creates a complete backup of the Kuzu database (.kuzu file) with:
+ * - **Format**: Full database backup only (complete .kuzu file)
+ * - **Compression**: Always enabled for optimal storage
+ * - **Encryption**: Optional AES-256 encryption for security
+ * - **Retention**: Configurable retention period (1-2555 days)
+ *
+ * **Backup Features:**
+ * - **Complete Backup**: Full database file backup
+ * - **Consistency**: Point-in-time consistent snapshot
+ * - **Download Support**: Unencrypted backups can be downloaded
+ * - **Restore Support**: Future support for encrypted backup restoration
+ *
+ * **Progress Monitoring:**
+ * Use the returned operation_id to connect to the SSE stream:
+ * ```javascript
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
+ * eventSource.addEventListener('operation_progress', (event) => {
+ * const data = JSON.parse(event.data);
+ * console.log('Backup progress:', data.progress_percent + '%');
+ * });
+ * ```
+ *
+ * **SSE Connection Limits:**
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic circuit breaker for Redis failures
+ * - Graceful degradation if event system unavailable
+ *
+ * **Important Notes:**
+ * - Only full_dump format is supported (no CSV/JSON exports)
+ * - Compression is always enabled
+ * - Encrypted backups cannot be downloaded (security measure)
+ * - All backups are stored securely in cloud storage
+ *
+ * **Credit Consumption:**
+ * - Base cost: 25.0 credits
+ * - Large databases (>10GB): 50.0 credits
+ * - Multiplied by graph tier
+ *
+ * Returns operation details for SSE monitoring.
+ */
+export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => import("./client").RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError, "fields">;
+/**
+ * List Kuzu graph backups
+ * List all backups for the specified graph database
+ */
+export declare const listBackups: <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => import("./client").RequestResult<ListBackupsResponses, ListBackupsErrors, ThrowOnError, "fields">;
+/**
+ * Export Kuzu backup for download
+ * Export a backup file for download (only available for non-encrypted, compressed .kuzu backups)
+ */
+export declare const exportBackup: <ThrowOnError extends boolean = false>(options: Options<ExportBackupData, ThrowOnError>) => import("./client").RequestResult<ExportBackupResponses, ExportBackupErrors, ThrowOnError, "fields">;
+/**
+ * Restore Encrypted Backup
+ * Restore a graph database from an encrypted backup.
+ *
+ * Restores a complete Kuzu database from an encrypted backup:
+ * - **Format**: Only full_dump backups can be restored
+ * - **Encryption**: Only encrypted backups can be restored (security requirement)
+ * - **System Backup**: Creates automatic backup of existing database before restore
+ * - **Verification**: Optionally verifies database integrity after restore
+ *
+ * **Restore Features:**
+ * - **Atomic Operation**: Complete replacement of database
+ * - **Rollback Protection**: System backup created before restore
+ * - **Data Integrity**: Verification ensures successful restore
+ * - **Security**: Only encrypted backups to prevent data tampering
+ *
+ * **Progress Monitoring:**
+ * Use the returned operation_id to connect to the SSE stream:
+ * ```javascript
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
+ * eventSource.addEventListener('operation_progress', (event) => {
+ * const data = JSON.parse(event.data);
+ * console.log('Restore progress:', data.message);
+ * });
+ * ```
+ *
+ * **SSE Connection Limits:**
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic circuit breaker for Redis failures
+ * - Graceful degradation if event system unavailable
+ *
+ * **Important Notes:**
+ * - Only encrypted backups can be restored (security measure)
+ * - Existing database is backed up to S3 before restore
+ * - Restore is a destructive operation - existing data is replaced
+ * - System backups are stored separately for recovery
+ *
+ * **Credit Consumption:**
+ * - Base cost: 100.0 credits
+ * - Large databases (>10GB): 200.0 credits
+ * - Multiplied by graph tier
+ *
+ * Returns operation details for SSE monitoring.
+ */
+export declare const restoreBackup: <ThrowOnError extends boolean = false>(options: Options<RestoreBackupData, ThrowOnError>) => import("./client").RequestResult<RestoreBackupResponses, RestoreBackupErrors, ThrowOnError, "fields">;
+/**
+ * Get backup statistics
+ * Get comprehensive backup statistics for the specified graph database
+ */
+export declare const getBackupStats: <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => import("./client").RequestResult<GetBackupStatsResponses, GetBackupStatsErrors, ThrowOnError, "fields">;
+/**
+ * Check Kuzu backup system health
+ * Check the health status of the Kuzu backup system
+ */
+export declare const kuzuBackupHealth: <ThrowOnError extends boolean = false>(options: Options<KuzuBackupHealthData, ThrowOnError>) => import("./client").RequestResult<KuzuBackupHealthResponses, KuzuBackupHealthErrors, ThrowOnError, "fields">;
+/**
+ * Get temporary download URL for backup
+ * Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
+ */
+export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
+/**
+ * Get Graph Metrics
+ * Get comprehensive metrics for the graph database.
+ *
+ * Provides detailed analytics including:
+ * - **Node Statistics**: Counts by type (Entity, Report, Account, Transaction)
+ * - **Relationship Metrics**: Connection counts and patterns
+ * - **Data Quality**: Completeness scores and validation results
+ * - **Performance Metrics**: Query response times and database health
+ * - **Storage Analytics**: Database size and growth trends
+ *
+ * This data helps with:
+ * - Monitoring data completeness
+ * - Identifying data quality issues
+ * - Capacity planning
+ * - Performance optimization
+ *
+ * Note:
+ * This operation is FREE - no credit consumption required.
+ */
+export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
+/**
+ * Get Usage Statistics
+ * Get detailed usage statistics for the graph.
+ *
+ * Provides temporal usage patterns including:
+ * - **Query Volume**: API calls per day/hour
+ * - **Credit Consumption**: Usage patterns and trends
+ * - **Operation Breakdown**: Usage by operation type
+ * - **User Activity**: Access patterns by user role
+ * - **Peak Usage Times**: Identify high-activity periods
+ *
+ * Time ranges available:
+ * - Last 24 hours (hourly breakdown)
+ * - Last 7 days (daily breakdown)
+ * - Last 30 days (daily breakdown)
+ * - Custom date ranges
+ *
+ * Useful for:
+ * - Capacity planning
+ * - Cost optimization
+ * - Usage trend analysis
+ * - Performance tuning
+ *
+ * Note:
+ * This operation is FREE - no credit consumption required.
+ */
+export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageStatsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ThrowOnError, "fields">;
+/**
+ * Execute Cypher Query
+ * Execute a Cypher query with intelligent response optimization.
+ *
+ * This endpoint automatically selects the best execution strategy based on:
+ * - Query characteristics (size, complexity)
+ * - Client capabilities (SSE, NDJSON, JSON)
+ * - System load (queue status, concurrent queries)
+ * - User preferences (mode parameter, headers)
+ *
+ * **Response Modes:**
+ * - `auto` (default): Intelligent automatic selection
+ * - `sync`: Force synchronous JSON response (best for testing)
+ * - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
+ * - `stream`: Force streaming response (SSE or NDJSON)
+ *
+ * **Client Detection:**
+ * - Automatically detects testing tools (Postman, Swagger UI)
+ * - Adjusts behavior for better interactive experience
+ * - Respects Accept and Prefer headers for capabilities
+ *
+ * **Streaming Support (SSE):**
+ * - Real-time events with progress updates
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic circuit breaker for Redis failures
+ * - Graceful degradation if event system unavailable
+ * - 30-second keepalive to prevent timeouts
+ *
+ * **Streaming Support (NDJSON):**
+ * - Efficient line-delimited JSON for large results
+ * - Automatic chunking (configurable 10-10000 rows)
+ * - No connection limits (stateless streaming)
+ *
+ * **Queue Management:**
+ * - Automatic queuing under high load
+ * - Real-time monitoring via SSE events (no polling needed)
+ * - Priority based on subscription tier
+ * - Queue position and progress updates pushed via SSE
+ * - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
+ *
+ * **Error Handling:**
+ * - `429 Too Many Requests`: Rate limit or connection limit exceeded
+ * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
+ * - Clients should implement exponential backoff
+ *
+ * **Note:**
+ * Query operations are FREE - no credit consumption required.
+ * Queue position is based on subscription tier for priority.
+ */
+export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => import("./client").RequestResult<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError, "fields">;
+/**
+ * Get Runtime Graph Schema Information
+ * Get runtime schema information for the specified graph database.
+ *
+ * This endpoint inspects the actual graph database structure and returns:
+ * - **Node Labels**: All node types currently in the database
+ * - **Relationship Types**: All relationship types currently in the database
+ * - **Node Properties**: Properties for each node type (limited to first 10 for performance)
+ *
+ * This is different from custom schema management - it shows what actually exists in the database,
+ * useful for understanding the current graph structure before writing queries.
+ *
+ * This operation is FREE - no credit consumption required.
+ */
+export declare const getGraphSchemaInfo: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaInfoData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ThrowOnError, "fields">;
+/**
+ * Validate Schema
+ * Validate a custom schema definition before deployment.
+ *
+ * This endpoint performs comprehensive validation including:
+ * - **Structure Validation**: Ensures proper JSON/YAML format
+ * - **Type Checking**: Validates data types (STRING, INT, DOUBLE, etc.)
+ * - **Constraint Verification**: Checks primary keys and unique constraints
+ * - **Relationship Integrity**: Validates node references in relationships
+ * - **Naming Conventions**: Ensures valid identifiers
+ * - **Compatibility**: Checks against existing extensions if specified
+ *
+ * Supported formats:
+ * - JSON schema definitions
+ * - YAML schema definitions
+ * - Direct dictionary format
+ *
+ * Validation helps prevent:
+ * - Schema deployment failures
+ * - Data integrity issues
+ * - Performance problems
+ * - Naming conflicts
+ *
+ * This operation is FREE - no credit consumption required.
+ */
+export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
+/**
+ * Export Graph Schema
+ * Export the schema of an existing graph in JSON, YAML, or Cypher format
+ */
+export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<ExportGraphSchemaResponses, ExportGraphSchemaErrors, ThrowOnError, "fields">;
+/**
+ * List Available Schema Extensions
+ * Get list of available schema extensions and compatibility groups
+ */
+export declare const listSchemaExtensions: <ThrowOnError extends boolean = false>(options: Options<ListSchemaExtensionsData, ThrowOnError>) => import("./client").RequestResult<ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, ThrowOnError, "fields">;
+/**
+ * Get Current Bill
+ * Get current month's billing details for the graph.
+ *
+ * Returns comprehensive billing information including:
+ * - **Credit Usage**: Consumed vs. allocated credits
+ * - **Storage Charges**: Current storage usage and costs
+ * - **Subscription Tier**: Current plan and features
+ * - **Pro-rated Charges**: If plan changed mid-month
+ * - **Estimated Total**: Current charges to date
+ *
+ * Billing calculations are updated hourly. Storage is measured in GB-months.
+ *
+ * ℹ️ No credits are consumed for viewing billing information.
+ */
+export declare const getCurrentGraphBill: <ThrowOnError extends boolean = false>(options: Options<GetCurrentGraphBillData, ThrowOnError>) => import("./client").RequestResult<GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, ThrowOnError, "fields">;
+/**
+ * Get Monthly Bill
+ * Get billing details for a specific month.
+ *
+ * Retrieve historical billing information for any previous month.
+ * Useful for:
+ * - Reconciling past charges
+ * - Tracking usage trends
+ * - Expense reporting
+ * - Budget analysis
+ *
+ * Returns the same detailed breakdown as the current bill endpoint.
+ *
+ * ℹ️ No credits are consumed for viewing billing history.
+ */
+export declare const getGraphMonthlyBill: <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => import("./client").RequestResult<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError, "fields">;
+/**
+ * Get Billing History
+ * Get billing history for the graph.
+ *
+ * Returns a chronological list of monthly bills, perfect for:
+ * - Tracking spending trends over time
+ * - Identifying usage patterns
+ * - Budget forecasting
+ * - Financial reporting
+ *
+ * Each month includes:
+ * - Credit usage and overages
+ * - Storage charges
+ * - Total charges
+ * - Usage metrics
+ *
+ * ℹ️ No credits are consumed for viewing billing history.
+ */
+export declare const getGraphBillingHistory: <ThrowOnError extends boolean = false>(options: Options<GetGraphBillingHistoryData, ThrowOnError>) => import("./client").RequestResult<GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, ThrowOnError, "fields">;
+/**
+ * Get Usage Details
+ * Get detailed usage metrics for the graph.
+ *
+ * Provides granular usage information including:
+ * - **Daily Credit Consumption**: Track credit usage patterns
+ * - **Storage Growth**: Monitor database size over time
+ * - **Operation Breakdown**: Credits by operation type
+ * - **Peak Usage Times**: Identify high-activity periods
+ * - **API Call Volumes**: Request counts and patterns
+ *
+ * Useful for:
+ * - Optimizing credit consumption
+ * - Capacity planning
+ * - Usage trend analysis
+ * - Cost optimization
+ *
+ * ℹ️ No credits are consumed for viewing usage details.
+ */
+export declare const getGraphUsageDetails: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError, "fields">;
+/**
+ * Get Graph Pricing Info
+ * Get pricing information for a specific graph database.
+ */
+export declare const getGraphPricingInfoV1GraphIdBillingPricingGet: <ThrowOnError extends boolean = false>(options: Options<GetGraphPricingInfoV1GraphIdBillingPricingGetData, ThrowOnError>) => import("./client").RequestResult<GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, ThrowOnError, "fields">;
+/**
+ * Upgrade Graph Subscription
+ * Upgrade subscription for a specific graph database.
+ */
+export declare const upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost: <ThrowOnError extends boolean = false>(options: Options<UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, ThrowOnError>) => import("./client").RequestResult<UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, ThrowOnError, "fields">;
+/**
+ * Get Graph Subscription
+ * Get current subscription for a graph database.
+ */
+export declare const getGraphSubscriptionV1GraphIdBillingSubscriptionGet: <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, ThrowOnError>) => import("./client").RequestResult<GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, ThrowOnError, "fields">;
+/**
+ * Get Available Subscription Plans
+ * Get available subscription plans for upgrade.
+ */
+export declare const getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet: <ThrowOnError extends boolean = false>(options: Options<GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, ThrowOnError>) => import("./client").RequestResult<GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, ThrowOnError, "fields">;
+/**
+ * Get Credit Billing Info
+ * Get credit-based billing information for a specific graph.
+ *
+ * This endpoint provides comprehensive credit usage and billing information
+ * without consuming credits (for billing transparency).
+ */
+export declare const getCreditBillingInfoV1GraphIdBillingCreditsGet: <ThrowOnError extends boolean = false>(options: Options<GetCreditBillingInfoV1GraphIdBillingCreditsGetData, ThrowOnError>) => import("./client").RequestResult<GetCreditBillingInfoV1GraphIdBillingCreditsGetResponses, GetCreditBillingInfoV1GraphIdBillingCreditsGetErrors, ThrowOnError, "fields">;
+/**
+ * Get Credit Summary
+ * Retrieve comprehensive credit usage summary for the specified graph.
+ *
+ * This endpoint provides:
+ * - Current credit balance and monthly allocation
+ * - Credit consumption metrics for the current month
+ * - Graph tier and credit multiplier information
+ * - Usage percentage to help monitor credit consumption
+ *
+ * No credits are consumed for checking credit status.
+ */
+export declare const getCreditSummary: <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => import("./client").RequestResult<GetCreditSummaryResponses, GetCreditSummaryErrors, ThrowOnError, "fields">;
+/**
+ * List Credit Transactions
+ * Retrieve detailed credit transaction history for the specified graph.
+ *
+ * This enhanced endpoint provides:
+ * - Detailed transaction records with idempotency information
+ * - Summary by operation type to identify high-consumption operations
+ * - Date range filtering for analysis
+ * - Metadata search capabilities
+ *
+ * Transaction types include:
+ * - ALLOCATION: Monthly credit allocations
+ * - CONSUMPTION: Credit usage for operations
+ * - BONUS: Bonus credits added by admins
+ * - REFUND: Credit refunds
+ *
+ * No credits are consumed for viewing transaction history.
+ */
+export declare const listCreditTransactions: <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) => import("./client").RequestResult<ListCreditTransactionsResponses, ListCreditTransactionsErrors, ThrowOnError, "fields">;
+/**
+ * Check Credit Balance
+ * Check if the graph has sufficient credits for a planned operation.
+ *
+ * This endpoint allows you to verify credit availability before performing
+ * an operation, helping prevent failed operations due to insufficient credits.
+ *
+ * The check considers:
+ * - Base operation cost
+ * - Graph tier multiplier
+ * - Current credit balance
+ *
+ * No credits are consumed for checking availability.
+ */
+export declare const checkCreditBalance: <ThrowOnError extends boolean = false>(options: Options<CheckCreditBalanceData, ThrowOnError>) => import("./client").RequestResult<CheckCreditBalanceResponses, CheckCreditBalanceErrors, ThrowOnError, "fields">;
+/**
+ * Get Storage Usage
+ * Get storage usage history for a graph.
+ *
+ * Returns detailed storage usage information including:
+ * - Daily average storage consumption
+ * - Storage trends over time
+ * - Credit costs for storage
+ * - Current storage billing information
+ *
+ * This endpoint helps users understand their storage patterns
+ * and associated credit costs.
+ */
+export declare const getStorageUsage: <ThrowOnError extends boolean = false>(options: Options<GetStorageUsageData, ThrowOnError>) => import("./client").RequestResult<GetStorageUsageResponses, GetStorageUsageErrors, ThrowOnError, "fields">;
+/**
+ * Check Storage Limits
+ * Check storage limits and usage for a graph.
+ *
+ * Returns comprehensive storage limit information including:
+ * - Current storage usage
+ * - Effective limit (override or default)
+ * - Usage percentage and warnings
+ * - Recommendations for limit management
+ *
+ * This endpoint helps users monitor storage usage and plan for potential
+ * limit increases. No credits are consumed for checking storage limits.
+ */
+export declare const checkStorageLimits: <ThrowOnError extends boolean = false>(options: Options<CheckStorageLimitsData, ThrowOnError>) => import("./client").RequestResult<CheckStorageLimitsResponses, CheckStorageLimitsErrors, ThrowOnError, "fields">;
+/**
+ * Database Health Check
+ * Get comprehensive health information for the graph database.
+ *
+ * Returns detailed health metrics including:
+ * - **Connection Status**: Database connectivity and responsiveness
+ * - **Performance Metrics**: Query execution times and throughput
+ * - **Resource Usage**: Memory and storage utilization
+ * - **Error Monitoring**: Recent error rates and patterns
+ * - **Uptime Statistics**: Service availability metrics
+ *
+ * Health indicators:
+ * - **Status**: healthy, degraded, or unhealthy
+ * - **Query Performance**: Average execution times
+ * - **Error Rates**: Recent failure percentages
+ * - **Resource Usage**: Memory and storage consumption
+ * - **Alerts**: Active warnings or issues
+ *
+ * This endpoint provides essential monitoring data for operational visibility.
+ */
+export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
+/**
+ * Database Information
+ * Get comprehensive database information and statistics.
+ *
+ * Returns detailed database metrics including:
+ * - **Database Metadata**: Name, path, size, and timestamps
+ * - **Schema Information**: Node labels, relationship types, and counts
+ * - **Storage Statistics**: Database size and usage metrics
+ * - **Data Composition**: Node and relationship counts
+ * - **Backup Information**: Available backups and last backup date
+ * - **Configuration**: Read-only status and schema version
+ *
+ * Database statistics:
+ * - **Size**: Storage usage in bytes and MB
+ * - **Content**: Node and relationship counts
+ * - **Schema**: Available labels and relationship types
+ * - **Backup Status**: Backup availability and recency
+ * - **Timestamps**: Creation and modification dates
+ *
+ * This endpoint provides essential database information for capacity planning and monitoring.
+ */
+export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
+/**
+ * List Subgraphs
+ * List all subgraphs for a parent graph.
+ *
+ * **Requirements:**
+ * - User must have at least read access to parent graph
+ *
+ * **Response includes:**
+ * - List of all subgraphs with metadata
+ * - Current usage vs limits
+ * - Size and statistics per subgraph
+ * - Creation timestamps
+ *
+ * **Filtering:**
+ * Currently returns all subgraphs. Future versions will support:
+ * - Filtering by status
+ * - Filtering by creation date
+ * - Pagination for large lists
+ */
+export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => import("./client").RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError, "fields">;
+/**
+ * Create New Subgraph
+ * Create a new subgraph database under an Enterprise or Premium parent graph.
+ *
+ * **Requirements:**
+ * - Parent graph must be Enterprise or Premium tier
+ * - User must have admin access to parent graph
+ * - Subgraph name must be unique within parent
+ * - Subgraph name must be alphanumeric (1-20 chars)
+ *
+ * **Subgraph Benefits:**
+ * - Shares parent's infrastructure (no additional cost)
+ * - Inherits parent's credit pool
+ * - Isolated database on same instance
+ * - Full Kuzu database capabilities
+ *
+ * **Use Cases:**
+ * - Separate environments (dev/staging/prod)
+ * - Department-specific data isolation
+ * - Multi-tenant applications
+ * - Testing and experimentation
+ *
+ * **Schema Inheritance:**
+ * - Subgraphs can use parent's schema or custom extensions
+ * - Extensions are additive only
+ * - Base schema always included
+ *
+ * **Limits:**
+ * - Standard: Not supported (0 subgraphs)
+ * - Enterprise: Configurable limit (default: 10 subgraphs)
+ * - Premium: Unlimited subgraphs
+ * - Limits are defined in deployment configuration
+ *
+ * **Response includes:**
+ * - `graph_id`: Full subgraph identifier
+ * - `parent_graph_id`: Parent graph ID
+ * - `subgraph_name`: Short name within parent
+ * - `status`: Creation status
+ */
+export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
+/**
+ * Delete Subgraph
+ * Delete a subgraph database.
+ *
+ * **Requirements:**
+ * - Must be a valid subgraph (not parent graph)
+ * - User must have admin access to parent graph
+ * - Optional backup before deletion
+ *
+ * **Deletion Options:**
+ * - `force`: Delete even if contains data
+ * - `backup_first`: Create backup before deletion
+ *
+ * **Warning:**
+ * Deletion is permanent unless backup is created.
+ * All data in the subgraph will be lost.
+ *
+ * **Backup Location:**
+ * If backup requested, stored in S3 at:
+ * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
+ */
+export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
+/**
+ * Get Subgraph Quota
+ * Get subgraph quota and usage information for a parent graph.
+ *
+ * **Shows:**
+ * - Current subgraph count
+ * - Maximum allowed subgraphs per tier
+ * - Remaining capacity
+ * - Total size usage across all subgraphs
+ *
+ * **Tier Limits:**
+ * - Standard: 0 subgraphs (not supported)
+ * - Enterprise: Configurable limit (default: 10 subgraphs)
+ * - Premium: Unlimited subgraphs
+ * - Limits are defined in deployment configuration
+ *
+ * **Size Tracking:**
+ * Provides aggregate size metrics when available.
+ * Individual subgraph sizes shown in list endpoint.
+ */
+export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
+/**
+ * Get Subgraph Details
+ * Get detailed information about a specific subgraph.
+ *
+ * **Requirements:**
+ * - User must have read access to parent graph
+ *
+ * **Response includes:**
+ * - Full subgraph metadata
+ * - Database statistics (nodes, edges)
+ * - Size information
+ * - Schema configuration
+ * - Creation/modification timestamps
+ * - Last access time (when available)
+ *
+ * **Statistics:**
+ * Real-time statistics queried from Kuzu:
+ * - Node count
+ * - Edge count
+ * - Database size on disk
+ * - Schema information
+ */
+export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
+/**
+ * Create New Graph Database
+ * Create a new graph database with specified schema and optionally an initial entity.
+ *
+ * This endpoint starts an asynchronous graph creation operation and returns
+ * connection details for monitoring progress via Server-Sent Events (SSE).
+ *
+ * **Operation Types:**
+ * - **Generic Graph**: Creates empty graph with schema extensions
+ * - **Entity Graph**: Creates graph with initial entity data
+ *
+ * **Monitoring Progress:**
+ * Use the returned `operation_id` to connect to the SSE stream:
+ * ```javascript
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
+ * eventSource.onmessage = (event) => {
+ * const data = JSON.parse(event.data);
+ * console.log('Progress:', data.progress_percent + '%');
+ * };
+ * ```
+ *
+ * **SSE Connection Limits:**
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic circuit breaker for Redis failures
+ * - Graceful degradation if event system unavailable
+ *
+ * **Events Emitted:**
+ * - `operation_started`: Graph creation begins
+ * - `operation_progress`: Schema loading, database setup, etc.
+ * - `operation_completed`: Graph ready with connection details
+ * - `operation_error`: Creation failed with error details
+ *
+ * **Error Handling:**
+ * - `429 Too Many Requests`: SSE connection limit exceeded
+ * - `503 Service Unavailable`: SSE system temporarily disabled
+ * - Clients should implement exponential backoff on errors
+ *
+ * **Response includes:**
+ * - `operation_id`: Unique identifier for monitoring
+ * - `_links.stream`: SSE endpoint for real-time updates
+ * - `_links.status`: Point-in-time status check endpoint
+ */
+export declare const createGraph: <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => import("./client").RequestResult<CreateGraphResponses, CreateGraphErrors, ThrowOnError, "fields">;
+/**
+ * Get Available Schema Extensions
+ * List all available schema extensions for graph creation
+ */
+export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Get Service Offerings
+ * Get comprehensive information about all subscription offerings.
+ *
+ * This endpoint provides complete information about both graph database subscriptions
+ * and shared repository subscriptions. This is the primary endpoint for frontend
+ * applications to display subscription options.
+ *
+ * Includes:
+ * - Graph subscription tiers (standard, enterprise, premium)
+ * - Shared repository subscriptions (SEC, industry, economic data)
+ * - Operation costs and credit information
+ * - Features and capabilities for each tier
+ * - Enabled/disabled status for repositories
+ *
+ * All data comes from the config-based systems to ensure accuracy with backend behavior.
+ *
+ * No authentication required - this is public service information.
+ */
+export declare const getServiceOfferings: <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) => import("./client").RequestResult<GetServiceOfferingsResponses, GetServiceOfferingsErrors, ThrowOnError, "fields">;
+/**
+ * Stream Operation Events
+ * Stream real-time events for an operation using Server-Sent Events (SSE).
+ *
+ * This endpoint provides real-time monitoring for all non-immediate operations including:
+ * - Graph creation and management
+ * - Agent analysis processing
+ * - Database backups and restores
+ * - Data synchronization tasks
+ *
+ * **Event Types:**
+ * - `operation_started`: Operation began execution
+ * - `operation_progress`: Progress update with details
+ * - `operation_completed`: Operation finished successfully
+ * - `operation_error`: Operation failed with error details
+ * - `operation_cancelled`: Operation was cancelled
+ *
+ * **Features:**
+ * - **Event Replay**: Use `from_sequence` parameter to replay missed events
+ * - **Automatic Reconnection**: Client can reconnect and resume from last seen event
+ * - **Real-time Updates**: Live progress updates during execution
+ * - **Timeout Handling**: 30-second keepalive messages prevent connection timeouts
+ * - **Graceful Degradation**: Automatic fallback if Redis is unavailable
+ *
+ * **Connection Limits:**
+ * - Maximum 5 concurrent SSE connections per user
+ * - Rate limited to 10 new connections per minute
+ * - Automatic cleanup of stale connections
+ * - Circuit breaker protection for Redis failures
+ *
+ * **Client Usage:**
+ * ```javascript
+ * const eventSource = new EventSource('/v1/operations/abc123/stream');
+ * eventSource.onmessage = (event) => {
+ * const data = JSON.parse(event.data);
+ * console.log('Progress:', data);
+ * };
+ * eventSource.onerror = (error) => {
+ * // Handle connection errors or rate limits
+ * console.error('SSE Error:', error);
+ * };
+ * ```
+ *
+ * **Error Handling:**
+ * - `429 Too Many Requests`: Connection limit or rate limit exceeded
+ * - `503 Service Unavailable`: SSE system temporarily disabled
+ * - Clients should implement exponential backoff on errors
+ *
+ * **No credits are consumed for SSE connections.**
+ */
+export declare const streamOperationEvents: <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) => import("./client").RequestResult<StreamOperationEventsResponses, StreamOperationEventsErrors, ThrowOnError, "fields">;
+/**
+ * Get Operation Status
+ * Get current status and metadata for an operation.
+ *
+ * Returns detailed information including:
+ * - Current status (pending, running, completed, failed, cancelled)
+ * - Creation and update timestamps
+ * - Operation type and associated graph
+ * - Result data (for completed operations)
+ * - Error details (for failed operations)
+ *
+ * This endpoint provides a point-in-time status check, while the `/stream` endpoint
+ * provides real-time updates. Use this for polling or initial status checks.
+ *
+ * **No credits are consumed for status checks.**
+ */
+export declare const getOperationStatus: <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) => import("./client").RequestResult<GetOperationStatusResponses, GetOperationStatusErrors, ThrowOnError, "fields">;
+/**
+ * Cancel Operation
+ * Cancel a pending or running operation.
+ *
+ * Cancels the specified operation if it's still in progress. Once cancelled,
+ * the operation cannot be resumed and will emit a cancellation event to any
+ * active SSE connections.
+ *
+ * **Note**: Completed or already failed operations cannot be cancelled.
+ *
+ * **No credits are consumed for cancellation requests.**
+ */
+export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => import("./client").RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError, "fields">;