@robosystems/client 0.2.4 → 0.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
   "main": "index.js",
   "types": "index.d.ts",

package/sdk/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Options as ClientOptions, TDataShape, Client } from './client';
-import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
+import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, 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
@@ -413,13 +413,46 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
  * Auto-select agent for query
  * Automatically select the best agent for your query.
  *
- * The orchestrator will:
- * 1. Enrich context with RAG if enabled
- * 2. Evaluate all available agents
- * 3. Select the best match based on confidence scores
- * 4. Execute the query with the selected agent
+ * **Agent Selection Process:**
+ *
+ * The orchestrator intelligently routes your query by:
+ * 1. Analyzing query intent and complexity
+ * 2. Enriching context with RAG if enabled
+ * 3. Evaluating all available agents against selection criteria
+ * 4. Selecting the best match based on confidence scores
+ * 5. Executing the query with the selected agent
+ *
+ * **Available Agent Types:**
+ * - `financial`: Financial analysis, SEC filings, company metrics
+ * - `research`: General research, data exploration, trend analysis
+ * - `rag`: Knowledge base search using RAG enrichment
+ *
+ * **Execution Modes:**
+ * - `quick`: Fast responses (~2-5s), suitable for simple queries
+ * - `standard`: Balanced approach (~5-15s), default mode
+ * - `extended`: Comprehensive analysis (~15-60s), deep research
+ * - `streaming`: Real-time response streaming
+ *
+ * **Confidence Score Interpretation:**
+ * - `0.9-1.0`: High confidence, agent is ideal match
+ * - `0.7-0.9`: Good confidence, agent is suitable
+ * - `0.5-0.7`: Moderate confidence, agent can handle but may not be optimal
+ * - `0.3-0.5`: Low confidence, fallback agent used
+ * - `<0.3`: Very low confidence, consider using specific agent endpoint
+ *
+ * **Credit Costs:**
+ * - Quick mode: 5-10 credits per query
+ * - Standard mode: 15-25 credits per query
+ * - Extended mode: 30-75 credits per query
+ * - RAG enrichment: +5-15 credits (if enabled)
  *
- * Use this endpoint when you want the system to intelligently route your query.
+ * **Use Cases:**
+ * - Ask questions without specifying agent type
+ * - Get intelligent routing for complex multi-domain queries
+ * - Leverage conversation history for contextual understanding
+ * - Enable RAG for knowledge base enrichment
+ *
+ * See request/response examples in the "Examples" dropdown below.
  */
 export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
 /**
@@ -578,6 +611,23 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
  * - **Download Support**: Unencrypted backups can be downloaded
  * - **Restore Support**: Future support for encrypted backup restoration
  *
+ * **Operation State Machine:**
+ * ```
+ * pending → processing → completed
+ * ↘ failed
+ * ```
+ * - **pending**: Backup queued, waiting to start
+ * - **processing**: Actively backing up database
+ * - **completed**: Backup successfully created and stored
+ * - **failed**: Backup failed (check error message)
+ *
+ * **Expected Durations:**
+ * Operation times vary by database size:
+ * - **Small** (<1GB): 30 seconds - 2 minutes
+ * - **Medium** (1-10GB): 2-10 minutes
+ * - **Large** (10-100GB): 10-30 minutes
+ * - **Very Large** (>100GB): 30+ minutes
+ *
  * **Progress Monitoring:**
  * Use the returned operation_id to connect to the SSE stream:
  * ```javascript
@@ -585,6 +635,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
  * eventSource.addEventListener('operation_progress', (event) => {
  * const data = JSON.parse(event.data);
  * console.log('Backup progress:', data.progress_percent + '%');
+ * console.log('Status:', data.status); // pending, processing, completed, failed
  * });
  * ```
  *
@@ -629,6 +680,28 @@ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false
  * - **Data Integrity**: Verification ensures successful restore
  * - **Security**: Only encrypted backups to prevent data tampering
  *
+ * **Operation State Machine:**
+ * ```
+ * pending → backing_up_current → downloading → restoring → verifying → completed
+ * ↘ failed
+ * ```
+ * - **pending**: Restore queued, waiting to start
+ * - **backing_up_current**: Creating safety backup of existing database
+ * - **downloading**: Downloading backup from storage
+ * - **restoring**: Replacing database with backup contents
+ * - **verifying**: Verifying database integrity (if enabled)
+ * - **completed**: Restore successful, database operational
+ * - **failed**: Restore failed (rollback may be available)
+ *
+ * **Expected Durations:**
+ * Operation times vary by database size (includes backup + restore):
+ * - **Small** (<1GB): 1-3 minutes
+ * - **Medium** (1-10GB): 5-15 minutes
+ * - **Large** (10-100GB): 20-45 minutes
+ * - **Very Large** (>100GB): 45+ minutes
+ *
+ * Note: Restore operations take longer than backups due to safety backup step.
+ *
  * **Progress Monitoring:**
  * Use the returned operation_id to connect to the SSE stream:
  * ```javascript
@@ -636,6 +709,7 @@ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false
  * eventSource.addEventListener('operation_progress', (event) => {
  * const data = JSON.parse(event.data);
  * console.log('Restore progress:', data.message);
+ * console.log('Status:', data.status); // Shows current state
  * });
  * ```
  *
@@ -1559,9 +1633,35 @@ export declare const getGraphs: <ThrowOnError extends boolean = false>(options?:
  * 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
+ * **Graph Creation Options:**
+ *
+ * 1. **Entity Graph with Initial Entity** (`initial_entity` provided, `create_entity=True`):
+ * - Creates graph structure with entity schema extensions
+ * - Populates an initial entity node with provided data
+ * - Useful when you want a pre-configured entity to start with
+ * - Example: Creating a company graph with the company already populated
+ *
+ * 2. **Entity Graph without Initial Entity** (`initial_entity=None`, `create_entity=False`):
+ * - Creates graph structure with entity schema extensions
+ * - Graph starts empty, ready for data import
+ * - Useful for bulk data imports or custom workflows
+ * - Example: Creating a graph structure before importing from CSV/API
+ *
+ * 3. **Generic Graph** (no `initial_entity` provided):
+ * - Creates empty graph with custom schema extensions
+ * - General-purpose knowledge graph
+ * - Example: Analytics graphs, custom data models
+ *
+ * **Required Fields:**
+ * - `metadata.graph_name`: Unique name for the graph
+ * - `instance_tier`: Resource tier (kuzu-standard, kuzu-large, kuzu-xlarge)
+ *
+ * **Optional Fields:**
+ * - `metadata.description`: Human-readable description of the graph's purpose
+ * - `metadata.schema_extensions`: List of schema extensions (roboledger, roboinvestor, etc.)
+ * - `tags`: Organizational tags (max 10)
+ * - `initial_entity`: Entity data (required for entity graphs with initial data)
+ * - `create_entity`: Whether to populate initial entity (default: true when initial_entity provided)
  *
  * **Monitoring Progress:**
  * Use the returned `operation_id` to connect to the SSE stream:
@@ -1628,6 +1728,37 @@ export declare const createGraph: <ThrowOnError extends boolean = false>(options
  * Extension listing is included - no credit consumption required.
  */
 export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, ThrowOnError, "fields">;
+/**
+ * Get Available Graph Tiers
+ * List all available graph database tier configurations.
+ *
+ * This endpoint provides comprehensive technical specifications for each available
+ * graph database tier, including instance types, resource limits, and features.
+ *
+ * **Tier Information:**
+ * Each tier includes:
+ * - Technical specifications (instance type, memory, storage)
+ * - Resource limits (subgraphs, credits, rate limits)
+ * - Feature list with capabilities
+ * - Availability status
+ *
+ * **Available Tiers:**
+ * - **kuzu-standard**: Multi-tenant entry-level tier
+ * - **kuzu-large**: Dedicated professional tier with subgraph support
+ * - **kuzu-xlarge**: Enterprise tier with maximum resources
+ * - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
+ * - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
+ *
+ * **Use Cases:**
+ * - Display tier options in graph creation UI
+ * - Show technical specifications for tier selection
+ * - Validate tier availability before graph creation
+ * - Display feature comparisons
+ *
+ * **Note:**
+ * Tier listing is included - no credit consumption required.
+ */
+export declare const getAvailableGraphTiers: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableGraphTiersData, ThrowOnError>) => import("./client").RequestResult<GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, ThrowOnError, "fields">;
 /**
  * Select Graph
  * Select a specific graph as the active workspace for the user.

package/sdk/sdk.gen.js

@@ -2,7 +2,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batchProcessQueries = exports.executeSpecificAgent = exports.autoSelectAgent = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.createLinkToken = exports.exchangeLinkToken = exports.getConnectionOptions = exports.createConnection = exports.listConnections = exports.getRepositoryCredits = exports.getSharedRepositoryCredits = exports.cancelSharedRepositorySubscription = exports.upgradeSharedRepositorySubscription = exports.subscribeToSharedRepository = exports.getUserSharedSubscriptions = exports.getDetailedUserAnalytics = exports.getUserUsageOverview = exports.getSharedRepositoryLimits = exports.getAllSharedRepositoryLimits = exports.getUserUsage = exports.getUserLimits = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.getAllCreditSummaries = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
-exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.queryTables = exports.ingestTables = exports.updateFileStatus = exports.getFileInfo = exports.deleteFile = exports.getUploadUrl = exports.listTableFiles = exports.listTables = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.getGraphMonthlyBill = exports.getGraphBillingHistory = exports.getGraphUsageDetails = exports.getCurrentGraphBill = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.getAgentMetadata = exports.listAgents = void 0;
+exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.queryTables = exports.ingestTables = exports.updateFileStatus = exports.getFileInfo = exports.deleteFile = exports.getUploadUrl = exports.listTableFiles = exports.listTables = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.getGraphMonthlyBill = exports.getGraphBillingHistory = exports.getGraphUsageDetails = exports.getCurrentGraphBill = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.getAgentMetadata = exports.listAgents = void 0;
 const client_gen_1 = require("./client.gen");
 /**
  * Register New User
@@ -1066,13 +1066,46 @@ exports.syncConnection = syncConnection;
  * Auto-select agent for query
  * Automatically select the best agent for your query.
  *
- * The orchestrator will:
- * 1. Enrich context with RAG if enabled
- * 2. Evaluate all available agents
- * 3. Select the best match based on confidence scores
- * 4. Execute the query with the selected agent
+ * **Agent Selection Process:**
+ *
+ * The orchestrator intelligently routes your query by:
+ * 1. Analyzing query intent and complexity
+ * 2. Enriching context with RAG if enabled
+ * 3. Evaluating all available agents against selection criteria
+ * 4. Selecting the best match based on confidence scores
+ * 5. Executing the query with the selected agent
+ *
+ * **Available Agent Types:**
+ * - `financial`: Financial analysis, SEC filings, company metrics
+ * - `research`: General research, data exploration, trend analysis
+ * - `rag`: Knowledge base search using RAG enrichment
+ *
+ * **Execution Modes:**
+ * - `quick`: Fast responses (~2-5s), suitable for simple queries
+ * - `standard`: Balanced approach (~5-15s), default mode
+ * - `extended`: Comprehensive analysis (~15-60s), deep research
+ * - `streaming`: Real-time response streaming
+ *
+ * **Confidence Score Interpretation:**
+ * - `0.9-1.0`: High confidence, agent is ideal match
+ * - `0.7-0.9`: Good confidence, agent is suitable
+ * - `0.5-0.7`: Moderate confidence, agent can handle but may not be optimal
+ * - `0.3-0.5`: Low confidence, fallback agent used
+ * - `<0.3`: Very low confidence, consider using specific agent endpoint
+ *
+ * **Credit Costs:**
+ * - Quick mode: 5-10 credits per query
+ * - Standard mode: 15-25 credits per query
+ * - Extended mode: 30-75 credits per query
+ * - RAG enrichment: +5-15 credits (if enabled)
  *
- * Use this endpoint when you want the system to intelligently route your query.
+ * **Use Cases:**
+ * - Ask questions without specifying agent type
+ * - Get intelligent routing for complex multi-domain queries
+ * - Leverage conversation history for contextual understanding
+ * - Enable RAG for knowledge base enrichment
+ *
+ * See request/response examples in the "Examples" dropdown below.
  */
 const autoSelectAgent = (options) => {
     return (options.client ?? client_gen_1.client).post({
@@ -1395,6 +1428,23 @@ exports.listBackups = listBackups;
  * - **Download Support**: Unencrypted backups can be downloaded
  * - **Restore Support**: Future support for encrypted backup restoration
  *
+ * **Operation State Machine:**
+ * ```
+ * pending → processing → completed
+ * ↘ failed
+ * ```
+ * - **pending**: Backup queued, waiting to start
+ * - **processing**: Actively backing up database
+ * - **completed**: Backup successfully created and stored
+ * - **failed**: Backup failed (check error message)
+ *
+ * **Expected Durations:**
+ * Operation times vary by database size:
+ * - **Small** (<1GB): 30 seconds - 2 minutes
+ * - **Medium** (1-10GB): 2-10 minutes
+ * - **Large** (10-100GB): 10-30 minutes
+ * - **Very Large** (>100GB): 30+ minutes
+ *
  * **Progress Monitoring:**
  * Use the returned operation_id to connect to the SSE stream:
  * ```javascript
@@ -1402,6 +1452,7 @@ exports.listBackups = listBackups;
  * eventSource.addEventListener('operation_progress', (event) => {
  * const data = JSON.parse(event.data);
  * console.log('Backup progress:', data.progress_percent + '%');
+ * console.log('Status:', data.status); // pending, processing, completed, failed
  * });
  * ```
  *
@@ -1482,6 +1533,28 @@ exports.getBackupDownloadUrl = getBackupDownloadUrl;
  * - **Data Integrity**: Verification ensures successful restore
  * - **Security**: Only encrypted backups to prevent data tampering
  *
+ * **Operation State Machine:**
+ * ```
+ * pending → backing_up_current → downloading → restoring → verifying → completed
+ * ↘ failed
+ * ```
+ * - **pending**: Restore queued, waiting to start
+ * - **backing_up_current**: Creating safety backup of existing database
+ * - **downloading**: Downloading backup from storage
+ * - **restoring**: Replacing database with backup contents
+ * - **verifying**: Verifying database integrity (if enabled)
+ * - **completed**: Restore successful, database operational
+ * - **failed**: Restore failed (rollback may be available)
+ *
+ * **Expected Durations:**
+ * Operation times vary by database size (includes backup + restore):
+ * - **Small** (<1GB): 1-3 minutes
+ * - **Medium** (1-10GB): 5-15 minutes
+ * - **Large** (10-100GB): 20-45 minutes
+ * - **Very Large** (>100GB): 45+ minutes
+ *
+ * Note: Restore operations take longer than backups due to safety backup step.
+ *
  * **Progress Monitoring:**
  * Use the returned operation_id to connect to the SSE stream:
  * ```javascript
@@ -1489,6 +1562,7 @@ exports.getBackupDownloadUrl = getBackupDownloadUrl;
  * eventSource.addEventListener('operation_progress', (event) => {
  * const data = JSON.parse(event.data);
  * console.log('Restore progress:', data.message);
+ * console.log('Status:', data.status); // Shows current state
  * });
  * ```
  *
@@ -2992,9 +3066,35 @@ exports.getGraphs = getGraphs;
  * 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
+ * **Graph Creation Options:**
+ *
+ * 1. **Entity Graph with Initial Entity** (`initial_entity` provided, `create_entity=True`):
+ * - Creates graph structure with entity schema extensions
+ * - Populates an initial entity node with provided data
+ * - Useful when you want a pre-configured entity to start with
+ * - Example: Creating a company graph with the company already populated
+ *
+ * 2. **Entity Graph without Initial Entity** (`initial_entity=None`, `create_entity=False`):
+ * - Creates graph structure with entity schema extensions
+ * - Graph starts empty, ready for data import
+ * - Useful for bulk data imports or custom workflows
+ * - Example: Creating a graph structure before importing from CSV/API
+ *
+ * 3. **Generic Graph** (no `initial_entity` provided):
+ * - Creates empty graph with custom schema extensions
+ * - General-purpose knowledge graph
+ * - Example: Analytics graphs, custom data models
+ *
+ * **Required Fields:**
+ * - `metadata.graph_name`: Unique name for the graph
+ * - `instance_tier`: Resource tier (kuzu-standard, kuzu-large, kuzu-xlarge)
+ *
+ * **Optional Fields:**
+ * - `metadata.description`: Human-readable description of the graph's purpose
+ * - `metadata.schema_extensions`: List of schema extensions (roboledger, roboinvestor, etc.)
+ * - `tags`: Organizational tags (max 10)
+ * - `initial_entity`: Entity data (required for entity graphs with initial data)
+ * - `create_entity`: Whether to populate initial entity (default: true when initial_entity provided)
  *
  * **Monitoring Progress:**
  * Use the returned `operation_id` to connect to the SSE stream:
@@ -3097,6 +3197,53 @@ const getAvailableExtensions = (options) => {
     });
 };
 exports.getAvailableExtensions = getAvailableExtensions;
+/**
+ * Get Available Graph Tiers
+ * List all available graph database tier configurations.
+ *
+ * This endpoint provides comprehensive technical specifications for each available
+ * graph database tier, including instance types, resource limits, and features.
+ *
+ * **Tier Information:**
+ * Each tier includes:
+ * - Technical specifications (instance type, memory, storage)
+ * - Resource limits (subgraphs, credits, rate limits)
+ * - Feature list with capabilities
+ * - Availability status
+ *
+ * **Available Tiers:**
+ * - **kuzu-standard**: Multi-tenant entry-level tier
+ * - **kuzu-large**: Dedicated professional tier with subgraph support
+ * - **kuzu-xlarge**: Enterprise tier with maximum resources
+ * - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
+ * - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
+ *
+ * **Use Cases:**
+ * - Display tier options in graph creation UI
+ * - Show technical specifications for tier selection
+ * - Validate tier availability before graph creation
+ * - Display feature comparisons
+ *
+ * **Note:**
+ * Tier listing is included - no credit consumption required.
+ */
+const getAvailableGraphTiers = (options) => {
+    return (options?.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/graphs/tiers',
+        ...options
+    });
+};
+exports.getAvailableGraphTiers = getAvailableGraphTiers;
 /**
  * Select Graph
  * Select a specific graph as the active workspace for the user.