@robosystems/client 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/sdk/sdk.gen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { Options as ClientOptions, TDataShape, Client } from './client';
2
- import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, 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, GetCurrentUserErrors, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, ListUserApiKeysErrors, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetUserUsageErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, 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, ListTablesV1GraphsGraphIdTablesGetData, ListTablesV1GraphsGraphIdTablesGetResponses, ListTablesV1GraphsGraphIdTablesGetErrors, ListTableFilesV1GraphsGraphIdTablesTableNameFilesGetData, ListTableFilesV1GraphsGraphIdTablesTableNameFilesGetResponses, ListTableFilesV1GraphsGraphIdTablesTableNameFilesGetErrors, GetUploadUrlV1GraphsGraphIdTablesTableNameFilesPostData, GetUploadUrlV1GraphsGraphIdTablesTableNameFilesPostResponses, GetUploadUrlV1GraphsGraphIdTablesTableNameFilesPostErrors, DeleteFileV1GraphsGraphIdTablesFilesFileIdDeleteData, DeleteFileV1GraphsGraphIdTablesFilesFileIdDeleteResponses, DeleteFileV1GraphsGraphIdTablesFilesFileIdDeleteErrors, GetFileInfoV1GraphsGraphIdTablesFilesFileIdGetData, GetFileInfoV1GraphsGraphIdTablesFilesFileIdGetResponses, GetFileInfoV1GraphsGraphIdTablesFilesFileIdGetErrors, UpdateFileV1GraphsGraphIdTablesFilesFileIdPatchData, UpdateFileV1GraphsGraphIdTablesFilesFileIdPatchResponses, UpdateFileV1GraphsGraphIdTablesFilesFileIdPatchErrors, IngestTablesV1GraphsGraphIdTablesIngestPostData, IngestTablesV1GraphsGraphIdTablesIngestPostResponses, IngestTablesV1GraphsGraphIdTablesIngestPostErrors, QueryTablesV1GraphsGraphIdTablesQueryPostData, QueryTablesV1GraphsGraphIdTablesQueryPostResponses, QueryTablesV1GraphsGraphIdTablesQueryPostErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
2
+ 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';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -27,7 +27,7 @@ export declare const loginUser: <ThrowOnError extends boolean = false>(options:
27
27
  * User Logout
28
28
  * Logout user and invalidate session.
29
29
  */
30
- export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError, "fields">;
30
+ export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, unknown, ThrowOnError, "fields">;
31
31
  /**
32
32
  * Get Current User
33
33
  * Get the currently authenticated user.
@@ -102,7 +102,7 @@ export declare const getServiceStatus: <ThrowOnError extends boolean = false>(op
102
102
  * Get Current User
103
103
  * Returns information about the currently authenticated user.
104
104
  */
105
- export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError, "fields">;
105
+ export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentUserResponses, unknown, ThrowOnError, "fields">;
106
106
  /**
107
107
  * Update User Profile
108
108
  * Update the current user's profile information.
@@ -128,7 +128,7 @@ export declare const updateUserPassword: <ThrowOnError extends boolean = false>(
128
128
  * List API Keys
129
129
  * Get all API keys for the current user.
130
130
  */
131
- export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => import("./client").RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError, "fields">;
131
+ export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => import("./client").RequestResult<ListUserApiKeysResponses, unknown, ThrowOnError, "fields">;
132
132
  /**
133
133
  * Create API Key
134
134
  * Create a new API key for the current user.
@@ -153,12 +153,12 @@ export declare const getUserLimits: <ThrowOnError extends boolean = false>(optio
153
153
  * Get user usage statistics
154
154
  * Retrieve current usage statistics and remaining limits for the authenticated user
155
155
  */
156
- export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, GetUserUsageErrors, ThrowOnError, "fields">;
156
+ export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, unknown, ThrowOnError, "fields">;
157
157
  /**
158
158
  * Get all shared repository limits
159
159
  * Get rate limit status for all shared repositories the user has access to.
160
160
  */
161
- export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
161
+ export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, unknown, ThrowOnError, "fields">;
162
162
  /**
163
163
  * Get shared repository rate limit status
164
164
  * Get current rate limit status and usage for a shared repository.
@@ -176,7 +176,7 @@ export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean =
176
176
  * Get User Usage Overview
177
177
  * Get a high-level overview of usage statistics for the current user.
178
178
  */
179
- export declare const getUserUsageOverview: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageOverviewData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, ThrowOnError, "fields">;
179
+ export declare const getUserUsageOverview: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageOverviewData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageOverviewResponses, unknown, ThrowOnError, "fields">;
180
180
  /**
181
181
  * Get Detailed User Analytics
182
182
  * Get comprehensive analytics for the current user including API usage and recent activity.
@@ -512,9 +512,8 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
512
512
  * - User permissions and subscription tier
513
513
  * - Backend capabilities (Kuzu, Neo4j, etc.)
514
514
  *
515
- * Credit consumption:
516
- * - Listing tools is included to encourage exploration
517
- * - Tool execution costs vary by operation complexity
515
+ * **Note:**
516
+ * MCP tool listing is included - no credit consumption required.
518
517
  */
519
518
  export declare const listMcpTools: <ThrowOnError extends boolean = false>(options: Options<ListMcpToolsData, ThrowOnError>) => import("./client").RequestResult<ListMcpToolsResponses, ListMcpToolsErrors, ThrowOnError, "fields">;
520
519
  /**
@@ -551,8 +550,11 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
551
550
  * - `408 Request Timeout`: Tool execution exceeded timeout
552
551
  * - Clients should implement exponential backoff on errors
553
552
  *
554
- * **Note:**
555
- * MCP tool calls are included and do not consume credits.
553
+ * **Credit Model:**
554
+ * MCP tool execution is included - no credit consumption required. Database
555
+ * operations (queries, schema inspection, analytics) are completely free.
556
+ * Only AI operations that invoke Claude or other LLM APIs consume credits,
557
+ * which happens at the AI agent layer, not the MCP tool layer.
556
558
  */
557
559
  export declare const callMcpTool: <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => import("./client").RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError, "fields">;
558
560
  /**
@@ -719,6 +721,13 @@ export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(
719
721
  * 1. Create file upload: `POST /v1/graphs/{graph_id}/tables/{table_name}/files`
720
722
  * 2. Ingest to graph: `POST /v1/graphs/{graph_id}/tables/ingest`
721
723
  *
724
+ * **Security Best Practice - Use Parameterized Queries:**
725
+ * ALWAYS use query parameters instead of string interpolation to prevent injection attacks:
726
+ * - ✅ SAFE: `MATCH (n:Entity {type: $entity_type}) RETURN n` with `parameters: {"entity_type": "Company"}`
727
+ * - ❌ UNSAFE: `MATCH (n:Entity {type: "Company"}) RETURN n` with user input concatenated into query string
728
+ *
729
+ * Query parameters provide automatic escaping and type safety. All examples in this API use parameterized queries.
730
+ *
722
731
  * This endpoint automatically selects the best execution strategy based on:
723
732
  * - Query characteristics (size, complexity)
724
733
  * - Client capabilities (SSE, NDJSON, JSON)
@@ -770,20 +779,91 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
770
779
  * Get Runtime Graph Schema
771
780
  * Get runtime schema information for the specified graph database.
772
781
  *
773
- * This endpoint inspects the actual graph database structure and returns:
782
+ * ## What This Returns
783
+ *
784
+ * This endpoint inspects the **actual current state** of the graph database and returns:
774
785
  * - **Node Labels**: All node types currently in the database
775
786
  * - **Relationship Types**: All relationship types currently in the database
776
- * - **Node Properties**: Properties for each node type (limited to first 10 for performance)
787
+ * - **Node Properties**: Properties discovered from actual data (up to 10 properties per node type)
788
+ *
789
+ * ## Runtime vs Declared Schema
777
790
  *
778
- * This shows what actually exists in the database right now - the runtime state.
779
- * For the declared schema definition, use GET /schema/export instead.
791
+ * **Use this endpoint** (`/schema`) when you need to know:
792
+ * - What data is ACTUALLY in the database right now
793
+ * - What properties exist on real nodes
794
+ * - What relationships have been created
795
+ * - Current database structure for querying
796
+ *
797
+ * **Use `/schema/export` instead** when you need:
798
+ * - The original schema definition used to create the graph
799
+ * - Schema in a specific format (JSON, YAML, Cypher DDL)
800
+ * - Schema for documentation or version control
801
+ * - Schema to replicate in another graph
802
+ *
803
+ * ## Example Use Cases
804
+ *
805
+ * - **Building queries**: See what node labels and properties exist to write accurate Cypher
806
+ * - **Data exploration**: Discover what's in an unfamiliar graph
807
+ * - **Schema drift detection**: Compare runtime vs declared schema
808
+ * - **API integration**: Dynamically adapt to current graph structure
809
+ *
810
+ * ## Performance Note
811
+ *
812
+ * Property discovery is limited to 10 properties per node type for performance.
813
+ * For complete schema definitions, use `/schema/export`.
780
814
  *
781
815
  * This operation is included - no credit consumption required.
782
816
  */
783
817
  export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError, "fields">;
784
818
  /**
785
- * Export Graph Schema
786
- * Export the schema of an existing graph in JSON, YAML, or Cypher format
819
+ * Export Declared Graph Schema
820
+ * Export the declared schema definition of an existing graph.
821
+ *
822
+ * ## What This Returns
823
+ *
824
+ * This endpoint returns the **original schema definition** that was used to create the graph:
825
+ * - The schema as it was **declared** during graph creation
826
+ * - Complete node and relationship definitions
827
+ * - Property types and constraints
828
+ * - Schema metadata (name, version, type)
829
+ *
830
+ * ## Runtime vs Declared Schema
831
+ *
832
+ * **Use this endpoint** (`/schema/export`) when you need:
833
+ * - The original schema definition used to create the graph
834
+ * - Schema in a specific format (JSON, YAML, Cypher DDL)
835
+ * - Schema for documentation or version control
836
+ * - Schema to replicate in another graph
837
+ *
838
+ * **Use `/schema` instead** when you need:
839
+ * - What data is ACTUALLY in the database right now
840
+ * - What properties exist on real nodes (discovered from data)
841
+ * - Current runtime database structure for querying
842
+ *
843
+ * ## Export Formats
844
+ *
845
+ * ### JSON Format (`format=json`)
846
+ * Returns structured JSON with nodes, relationships, and properties.
847
+ * Best for programmatic access and API integration.
848
+ *
849
+ * ### YAML Format (`format=yaml`)
850
+ * Returns human-readable YAML with comments.
851
+ * Best for documentation and configuration management.
852
+ *
853
+ * ### Cypher DDL Format (`format=cypher`)
854
+ * Returns Cypher CREATE statements for recreating the schema.
855
+ * Best for database migration and replication.
856
+ *
857
+ * ## Data Statistics
858
+ *
859
+ * Set `include_data_stats=true` to include:
860
+ * - Node counts by label
861
+ * - Relationship counts by type
862
+ * - Total nodes and relationships
863
+ *
864
+ * This combines declared schema with runtime statistics.
865
+ *
866
+ * This operation is included - no credit consumption required.
787
867
  */
788
868
  export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<ExportGraphSchemaResponses, ExportGraphSchemaErrors, ThrowOnError, "fields">;
789
869
  /**
@@ -1116,47 +1196,360 @@ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(opt
1116
1196
  export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
1117
1197
  /**
1118
1198
  * List Staging Tables
1119
- * List all DuckDB staging tables for a graph
1120
- */
1121
- export declare const listTablesV1GraphsGraphIdTablesGet: <ThrowOnError extends boolean = false>(options: Options<ListTablesV1GraphsGraphIdTablesGetData, ThrowOnError>) => import("./client").RequestResult<ListTablesV1GraphsGraphIdTablesGetResponses, ListTablesV1GraphsGraphIdTablesGetErrors, ThrowOnError, "fields">;
1122
- /**
1123
- * List Files in Table
1124
- * List all files uploaded to a staging table
1199
+ * List all DuckDB staging tables with comprehensive metrics and status.
1200
+ *
1201
+ * Get a complete inventory of all staging tables for a graph, including
1202
+ * file counts, storage sizes, and row estimates. Essential for monitoring
1203
+ * the data pipeline and determining which tables are ready for ingestion.
1204
+ *
1205
+ * **Returned Metrics:**
1206
+ * - Table name and type (node/relationship)
1207
+ * - File count per table
1208
+ * - Total storage size in bytes
1209
+ * - Estimated row count
1210
+ * - S3 location pattern
1211
+ * - Ready-for-ingestion status
1212
+ *
1213
+ * **Use Cases:**
1214
+ * - Monitor data upload progress
1215
+ * - Check which tables have files ready
1216
+ * - Track storage consumption
1217
+ * - Validate pipeline before ingestion
1218
+ * - Capacity planning
1219
+ *
1220
+ * **Workflow:**
1221
+ * 1. List tables to see current state
1222
+ * 2. Upload files to empty tables
1223
+ * 3. Re-list to verify uploads
1224
+ * 4. Check file counts and sizes
1225
+ * 5. Ingest when ready
1226
+ *
1227
+ * **Important Notes:**
1228
+ * - Tables with `file_count > 0` have data ready
1229
+ * - Check `total_size_bytes` for storage monitoring
1230
+ * - Use `s3_location` to verify upload paths
1231
+ * - Empty tables (file_count=0) are skipped during ingestion
1232
+ * - Table queries are included - no credit consumption
1125
1233
  */
1126
- export declare const listTableFilesV1GraphsGraphIdTablesTableNameFilesGet: <ThrowOnError extends boolean = false>(options: Options<ListTableFilesV1GraphsGraphIdTablesTableNameFilesGetData, ThrowOnError>) => import("./client").RequestResult<ListTableFilesV1GraphsGraphIdTablesTableNameFilesGetResponses, ListTableFilesV1GraphsGraphIdTablesTableNameFilesGetErrors, ThrowOnError, "fields">;
1234
+ export declare const listTables: <ThrowOnError extends boolean = false>(options: Options<ListTablesData, ThrowOnError>) => import("./client").RequestResult<ListTablesResponses, ListTablesErrors, ThrowOnError, "fields">;
1127
1235
  /**
1128
- * Create File Upload
1129
- * Create a new file upload for a table and get a presigned S3 URL
1236
+ * List Files in Staging Table
1237
+ * List all files uploaded to a staging table with comprehensive metadata.
1238
+ *
1239
+ * Get a complete inventory of all files in a staging table, including upload status,
1240
+ * file sizes, row counts, and S3 locations. Essential for monitoring upload progress
1241
+ * and validating data before ingestion.
1242
+ *
1243
+ * **Use Cases:**
1244
+ * - Monitor file upload progress
1245
+ * - Verify files are ready for ingestion
1246
+ * - Check file formats and sizes
1247
+ * - Track storage usage per table
1248
+ * - Identify failed or incomplete uploads
1249
+ * - Pre-ingestion validation
1250
+ *
1251
+ * **Returned Metadata:**
1252
+ * - File ID, name, and format (parquet, csv, json)
1253
+ * - Size in bytes and row count (if available)
1254
+ * - Upload status and method
1255
+ * - Creation and upload timestamps
1256
+ * - S3 key for reference
1257
+ *
1258
+ * **Upload Status Values:**
1259
+ * - `pending`: Upload URL generated, awaiting upload
1260
+ * - `uploaded`: Successfully uploaded, ready for ingestion
1261
+ * - `disabled`: Excluded from ingestion
1262
+ * - `archived`: Soft deleted
1263
+ * - `failed`: Upload failed
1264
+ *
1265
+ * **Important Notes:**
1266
+ * - Only `uploaded` files are ingested
1267
+ * - Check `row_count` to estimate data volume
1268
+ * - Use `total_size_bytes` for storage monitoring
1269
+ * - Files with `failed` status should be deleted and re-uploaded
1270
+ * - File listing is included - no credit consumption
1271
+ */
1272
+ export declare const listTableFiles: <ThrowOnError extends boolean = false>(options: Options<ListTableFilesData, ThrowOnError>) => import("./client").RequestResult<ListTableFilesResponses, ListTableFilesErrors, ThrowOnError, "fields">;
1273
+ /**
1274
+ * Get File Upload URL
1275
+ * Generate a presigned S3 URL for secure file upload.
1276
+ *
1277
+ * Initiates file upload to a staging table by generating a secure, time-limited
1278
+ * presigned S3 URL. Files are uploaded directly to S3, bypassing the API for
1279
+ * optimal performance.
1280
+ *
1281
+ * **Upload Workflow:**
1282
+ * 1. Call this endpoint to get presigned URL
1283
+ * 2. PUT file directly to S3 URL
1284
+ * 3. Call PATCH /tables/files/{file_id} with status='uploaded'
1285
+ * 4. Backend validates file and calculates metrics
1286
+ * 5. File ready for ingestion
1287
+ *
1288
+ * **Supported Formats:**
1289
+ * - Parquet (`application/x-parquet` with `.parquet` extension)
1290
+ * - CSV (`text/csv` with `.csv` extension)
1291
+ * - JSON (`application/json` with `.json` extension)
1292
+ *
1293
+ * **Validation:**
1294
+ * - File extension must match content type
1295
+ * - File name 1-255 characters
1296
+ * - No path traversal characters (.. / \)
1297
+ * - Auto-creates table if it doesn't exist
1298
+ *
1299
+ * **Auto-Table Creation:**
1300
+ * Tables are automatically created on first file upload with type inferred from name
1301
+ * (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
1302
+ *
1303
+ * **Important Notes:**
1304
+ * - Presigned URLs expire (default: 1 hour)
1305
+ * - Use appropriate Content-Type header when uploading to S3
1306
+ * - File extension must match content type
1307
+ * - Upload URL generation is included - no credit consumption
1130
1308
  */
1131
- export declare const getUploadUrlV1GraphsGraphIdTablesTableNameFilesPost: <ThrowOnError extends boolean = false>(options: Options<GetUploadUrlV1GraphsGraphIdTablesTableNameFilesPostData, ThrowOnError>) => import("./client").RequestResult<GetUploadUrlV1GraphsGraphIdTablesTableNameFilesPostResponses, GetUploadUrlV1GraphsGraphIdTablesTableNameFilesPostErrors, ThrowOnError, "fields">;
1309
+ export declare const getUploadUrl: <ThrowOnError extends boolean = false>(options: Options<GetUploadUrlData, ThrowOnError>) => import("./client").RequestResult<GetUploadUrlResponses, GetUploadUrlErrors, ThrowOnError, "fields">;
1132
1310
  /**
1133
- * Delete File
1134
- * Delete a specific file from S3 and database tracking. DuckDB will automatically exclude it from queries.
1311
+ * Delete File from Staging
1312
+ * Delete a file from S3 storage and database tracking.
1313
+ *
1314
+ * Remove unwanted, duplicate, or incorrect files from staging tables before ingestion.
1315
+ * The file is deleted from both S3 and database tracking, and table statistics
1316
+ * are automatically recalculated.
1317
+ *
1318
+ * **Use Cases:**
1319
+ * - Remove duplicate uploads
1320
+ * - Delete files with incorrect data
1321
+ * - Clean up failed uploads
1322
+ * - Fix data quality issues before ingestion
1323
+ * - Manage storage usage
1324
+ *
1325
+ * **What Happens:**
1326
+ * 1. File deleted from S3 storage
1327
+ * 2. Database tracking record removed
1328
+ * 3. Table statistics recalculated (file count, size, row count)
1329
+ * 4. DuckDB automatically excludes file from future queries
1330
+ *
1331
+ * **Security:**
1332
+ * - Write access required (verified via auth)
1333
+ * - Shared repositories block file deletions
1334
+ * - Full audit trail of deletion operations
1335
+ * - Cannot delete after ingestion to graph
1336
+ *
1337
+ * **Important Notes:**
1338
+ * - Delete files before ingestion for best results
1339
+ * - Table statistics update automatically
1340
+ * - No need to refresh DuckDB - exclusion is automatic
1341
+ * - Consider re-uploading corrected version after deletion
1342
+ * - File deletion is included - no credit consumption
1135
1343
  */
1136
- export declare const deleteFileV1GraphsGraphIdTablesFilesFileIdDelete: <ThrowOnError extends boolean = false>(options: Options<DeleteFileV1GraphsGraphIdTablesFilesFileIdDeleteData, ThrowOnError>) => import("./client").RequestResult<DeleteFileV1GraphsGraphIdTablesFilesFileIdDeleteResponses, DeleteFileV1GraphsGraphIdTablesFilesFileIdDeleteErrors, ThrowOnError, "fields">;
1344
+ export declare const deleteFile: <ThrowOnError extends boolean = false>(options: Options<DeleteFileData, ThrowOnError>) => import("./client").RequestResult<DeleteFileResponses, DeleteFileErrors, ThrowOnError, "fields">;
1137
1345
  /**
1138
- * Get File Info
1139
- * Get detailed information about a specific file
1346
+ * Get File Information
1347
+ * Get detailed information about a specific file.
1348
+ *
1349
+ * Retrieve comprehensive metadata for a single file, including upload status,
1350
+ * size, row count, and timestamps. Useful for validating individual files
1351
+ * before ingestion.
1352
+ *
1353
+ * **Use Cases:**
1354
+ * - Validate file upload completion
1355
+ * - Check file metadata before ingestion
1356
+ * - Debug upload issues
1357
+ * - Verify file format and size
1358
+ * - Track file lifecycle
1359
+ *
1360
+ * **Note:**
1361
+ * File info retrieval is included - no credit consumption
1140
1362
  */
1141
- export declare const getFileInfoV1GraphsGraphIdTablesFilesFileIdGet: <ThrowOnError extends boolean = false>(options: Options<GetFileInfoV1GraphsGraphIdTablesFilesFileIdGetData, ThrowOnError>) => import("./client").RequestResult<GetFileInfoV1GraphsGraphIdTablesFilesFileIdGetResponses, GetFileInfoV1GraphsGraphIdTablesFilesFileIdGetErrors, ThrowOnError, "fields">;
1363
+ export declare const getFileInfo: <ThrowOnError extends boolean = false>(options: Options<GetFileInfoData, ThrowOnError>) => import("./client").RequestResult<GetFileInfoResponses, GetFileInfoErrors, ThrowOnError, "fields">;
1142
1364
  /**
1143
- * Update File
1144
- * Update file metadata after upload (size, row count). Marks file as completed.
1365
+ * Update File Upload Status
1366
+ * Update file status after upload completes.
1367
+ *
1368
+ * Marks files as uploaded after successful S3 upload. The backend validates
1369
+ * the file, calculates size and row count, enforces storage limits, and
1370
+ * registers the DuckDB table for queries.
1371
+ *
1372
+ * **Status Values:**
1373
+ * - `uploaded`: File successfully uploaded to S3 (triggers validation)
1374
+ * - `disabled`: Exclude file from ingestion
1375
+ * - `archived`: Soft delete file
1376
+ *
1377
+ * **What Happens on 'uploaded' Status:**
1378
+ * 1. Verify file exists in S3
1379
+ * 2. Calculate actual file size
1380
+ * 3. Enforce tier storage limits
1381
+ * 4. Calculate or estimate row count
1382
+ * 5. Update table statistics
1383
+ * 6. Register DuckDB external table
1384
+ * 7. File ready for ingestion
1385
+ *
1386
+ * **Row Count Calculation:**
1387
+ * - **Parquet**: Exact count from file metadata
1388
+ * - **CSV**: Count rows (minus header)
1389
+ * - **JSON**: Count array elements
1390
+ * - **Fallback**: Estimate from file size if reading fails
1391
+ *
1392
+ * **Storage Limits:**
1393
+ * Enforced per subscription tier. Returns HTTP 413 if limit exceeded.
1394
+ * Check current usage before large uploads.
1395
+ *
1396
+ * **Important Notes:**
1397
+ * - Always call this after S3 upload completes
1398
+ * - Check response for actual row count
1399
+ * - Storage limit errors (413) mean tier upgrade needed
1400
+ * - DuckDB registration failures are non-fatal (retried later)
1401
+ * - Status updates are included - no credit consumption
1145
1402
  */
1146
- export declare const updateFileV1GraphsGraphIdTablesFilesFileIdPatch: <ThrowOnError extends boolean = false>(options: Options<UpdateFileV1GraphsGraphIdTablesFilesFileIdPatchData, ThrowOnError>) => import("./client").RequestResult<UpdateFileV1GraphsGraphIdTablesFilesFileIdPatchResponses, UpdateFileV1GraphsGraphIdTablesFilesFileIdPatchErrors, ThrowOnError, "fields">;
1403
+ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(options: Options<UpdateFileStatusData, ThrowOnError>) => import("./client").RequestResult<UpdateFileStatusResponses, UpdateFileStatusErrors, ThrowOnError, "fields">;
1147
1404
  /**
1148
1405
  * Ingest Tables to Graph
1149
- * Load all files from S3 into DuckDB staging tables and ingest into Kuzu graph database. Use rebuild=true to regenerate the entire graph from scratch (safe operation - S3 is source of truth).
1406
+ * Load all files from S3 into DuckDB staging tables and ingest into Kuzu graph database.
1407
+ *
1408
+ * Orchestrates the complete data pipeline from S3 staging files into the Kuzu graph database.
1409
+ * Processes all tables in a single bulk operation with comprehensive error handling and metrics.
1410
+ *
1411
+ * **Use Cases:**
1412
+ * - Initial graph population from uploaded data
1413
+ * - Incremental data updates with new files
1414
+ * - Complete database rebuild from source files
1415
+ * - Recovery from failed ingestion attempts
1416
+ *
1417
+ * **Workflow:**
1418
+ * 1. Upload data files via `POST /tables/{table_name}/files`
1419
+ * 2. Files are validated and marked as 'uploaded'
1420
+ * 3. Trigger ingestion: `POST /tables/ingest`
1421
+ * 4. DuckDB staging tables created from S3 patterns
1422
+ * 5. Data copied row-by-row from DuckDB to Kuzu
1423
+ * 6. Per-table results and metrics returned
1424
+ *
1425
+ * **Rebuild Feature:**
1426
+ * Setting `rebuild=true` regenerates the entire graph database from scratch:
1427
+ * - Deletes existing Kuzu database
1428
+ * - Recreates with fresh schema from active GraphSchema
1429
+ * - Ingests all data files
1430
+ * - Safe operation - S3 is source of truth
1431
+ * - Useful for schema changes or data corrections
1432
+ * - Graph marked as 'rebuilding' during process
1433
+ *
1434
+ * **Error Handling:**
1435
+ * - Per-table error isolation with `ignore_errors` flag
1436
+ * - Partial success support (some tables succeed, some fail)
1437
+ * - Detailed error reporting per table
1438
+ * - Graph status tracking throughout process
1439
+ * - Automatic failure recovery and cleanup
1440
+ *
1441
+ * **Performance:**
1442
+ * - Processes all tables in sequence
1443
+ * - Each table timed independently
1444
+ * - Total execution metrics provided
1445
+ * - Scales to thousands of files
1446
+ * - Optimized for large datasets
1447
+ *
1448
+ * **Concurrency Control:**
1449
+ * Only one ingestion can run per graph at a time. If another ingestion is in progress,
1450
+ * you'll receive a 409 Conflict error. The distributed lock automatically expires after
1451
+ * the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
1452
+ *
1453
+ * **Important Notes:**
1454
+ * - Only files with 'uploaded' status are processed
1455
+ * - Tables with no uploaded files are skipped
1456
+ * - Use `ignore_errors=false` for strict validation
1457
+ * - Monitor progress via per-table results
1458
+ * - Check graph metadata for rebuild status
1459
+ * - Wait for current ingestion to complete before starting another
1460
+ * - Table ingestion is included - no credit consumption
1150
1461
  */
1151
- export declare const ingestTablesV1GraphsGraphIdTablesIngestPost: <ThrowOnError extends boolean = false>(options: Options<IngestTablesV1GraphsGraphIdTablesIngestPostData, ThrowOnError>) => import("./client").RequestResult<IngestTablesV1GraphsGraphIdTablesIngestPostResponses, IngestTablesV1GraphsGraphIdTablesIngestPostErrors, ThrowOnError, "fields">;
1462
+ export declare const ingestTables: <ThrowOnError extends boolean = false>(options: Options<IngestTablesData, ThrowOnError>) => import("./client").RequestResult<IngestTablesResponses, IngestTablesErrors, ThrowOnError, "fields">;
1152
1463
  /**
1153
1464
  * Query Staging Tables with SQL
1154
- * Execute SQL queries on DuckDB staging tables
1465
+ * Execute SQL queries on DuckDB staging tables for data inspection and validation.
1466
+ *
1467
+ * Query raw staging data directly with SQL before ingestion into the graph database.
1468
+ * Useful for data quality checks, validation, and exploratory analysis.
1469
+ *
1470
+ * **Security Best Practice - Use Parameterized Queries:**
1471
+ * ALWAYS use query parameters instead of string concatenation to prevent SQL injection:
1472
+ * - ✅ SAFE: `SELECT * FROM Entity WHERE type = ? LIMIT ?` with `parameters: ["Company", 100]`
1473
+ * - ❌ UNSAFE: `SELECT * FROM Entity WHERE type = 'Company' LIMIT 100` with user input concatenated into SQL string
1474
+ *
1475
+ * Query parameters provide automatic escaping and type safety. Use `?` placeholders with parameters array.
1476
+ *
1477
+ * **Use Cases:**
1478
+ * - Validate data quality before graph ingestion
1479
+ * - Inspect row-level data for debugging
1480
+ * - Run analytics on staging tables
1481
+ * - Check for duplicates, nulls, or data issues
1482
+ * - Preview data transformations
1483
+ *
1484
+ * **Workflow:**
1485
+ * 1. Upload data files via `POST /tables/{table_name}/files`
1486
+ * 2. Query staging tables to validate: `POST /tables/query`
1487
+ * 3. Fix any data issues by re-uploading
1488
+ * 4. Ingest validated data: `POST /tables/ingest`
1489
+ *
1490
+ * **Supported SQL:**
1491
+ * - Full DuckDB SQL syntax
1492
+ * - SELECT, JOIN, WHERE, GROUP BY, ORDER BY
1493
+ * - Aggregations, window functions, CTEs
1494
+ * - Multiple table joins across staging area
1495
+ *
1496
+ * **Common Operations:**
1497
+ * - Count rows: `SELECT COUNT(*) FROM Entity`
1498
+ * - Filter by type: `SELECT * FROM Entity WHERE entity_type = ? LIMIT ?` with `parameters: ["Company", 100]`
1499
+ * - Check for nulls: `SELECT * FROM Entity WHERE name IS NULL LIMIT 10`
1500
+ * - Find duplicates: `SELECT identifier, COUNT(*) as cnt FROM Entity GROUP BY identifier HAVING COUNT(*) > 1`
1501
+ * - Filter amounts: `SELECT * FROM Transaction WHERE amount > ? AND date >= ?` with `parameters: [1000, "2024-01-01"]`
1502
+ *
1503
+ * **Limits:**
1504
+ * - Query timeout: 30 seconds
1505
+ * - Result limit: 10,000 rows (use LIMIT clause)
1506
+ * - Read-only: No INSERT, UPDATE, DELETE
1507
+ * - User's tables only: Cannot query other users' data
1508
+ *
1509
+ * **Shared Repositories:**
1510
+ * Shared repositories (SEC, etc.) do not allow direct SQL queries.
1511
+ * Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
1512
+ *
1513
+ * **Note:**
1514
+ * Staging table queries are included - no credit consumption
1155
1515
  */
1156
- export declare const queryTablesV1GraphsGraphIdTablesQueryPost: <ThrowOnError extends boolean = false>(options: Options<QueryTablesV1GraphsGraphIdTablesQueryPostData, ThrowOnError>) => import("./client").RequestResult<QueryTablesV1GraphsGraphIdTablesQueryPostResponses, QueryTablesV1GraphsGraphIdTablesQueryPostErrors, ThrowOnError, "fields">;
1516
+ export declare const queryTables: <ThrowOnError extends boolean = false>(options: Options<QueryTablesData, ThrowOnError>) => import("./client").RequestResult<QueryTablesResponses, QueryTablesErrors, ThrowOnError, "fields">;
1157
1517
  /**
1158
1518
  * Get User Graphs
1159
- * Get all graph databases accessible to the current user.
1519
+ * List all graph databases accessible to the current user with roles and selection status.
1520
+ *
1521
+ * Returns a comprehensive list of all graphs the user can access, including their
1522
+ * role in each graph (admin or member) and which graph is currently selected as
1523
+ * the active workspace.
1524
+ *
1525
+ * **Returned Information:**
1526
+ * - Graph ID and display name for each accessible graph
1527
+ * - User's role (admin/member) indicating permission level
1528
+ * - Selection status (one graph can be marked as "selected")
1529
+ * - Creation timestamp for each graph
1530
+ *
1531
+ * **Graph Roles:**
1532
+ * - `admin`: Full access - can manage graph settings, invite users, delete graph
1533
+ * - `member`: Read/write access - can query and modify data, cannot manage settings
1534
+ *
1535
+ * **Selected Graph Concept:**
1536
+ * The "selected" graph is the user's currently active workspace. Many API operations
1537
+ * default to the selected graph if no graph_id is provided. Users can change their
1538
+ * selected graph via the `POST /v1/graphs/{graph_id}/select` endpoint.
1539
+ *
1540
+ * **Use Cases:**
1541
+ * - Display graph selector in UI
1542
+ * - Show user's accessible workspaces
1543
+ * - Identify which graph is currently active
1544
+ * - Filter graphs by role for permission-based features
1545
+ *
1546
+ * **Empty Response:**
1547
+ * New users or users without graph access will receive an empty list with
1548
+ * `selectedGraphId: null`. Users should create a new graph or request access
1549
+ * to an existing graph.
1550
+ *
1551
+ * **Note:**
1552
+ * Graph listing is included - no credit consumption required.
1160
1553
  */
1161
1554
  export declare const getGraphs: <ThrowOnError extends boolean = false>(options?: Options<GetGraphsData, ThrowOnError>) => import("./client").RequestResult<GetGraphsResponses, GetGraphsErrors, ThrowOnError, "fields">;
1162
1555
  /**
@@ -1205,12 +1598,67 @@ export declare const getGraphs: <ThrowOnError extends boolean = false>(options?:
1205
1598
  export declare const createGraph: <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => import("./client").RequestResult<CreateGraphResponses, CreateGraphErrors, ThrowOnError, "fields">;
1206
1599
  /**
1207
1600
  * Get Available Schema Extensions
1208
- * List all available schema extensions for graph creation
1601
+ * List all available schema extensions for graph creation.
1602
+ *
1603
+ * Schema extensions provide pre-built industry-specific data models that extend
1604
+ * the base graph schema with specialized nodes, relationships, and properties.
1605
+ *
1606
+ * **Available Extensions:**
1607
+ * - **RoboLedger**: Complete accounting system with XBRL reporting, general ledger, and financial statements
1608
+ * - **RoboInvestor**: Investment portfolio management and tracking
1609
+ * - **RoboSCM**: Supply chain management and logistics
1610
+ * - **RoboFO**: Front office operations and CRM
1611
+ * - **RoboHRM**: Human resources management
1612
+ * - **RoboEPM**: Enterprise performance management
1613
+ * - **RoboReport**: Business intelligence and reporting
1614
+ *
1615
+ * **Extension Information:**
1616
+ * Each extension includes:
1617
+ * - Display name and description
1618
+ * - Node and relationship counts
1619
+ * - Context-aware capabilities (e.g., SEC repositories get different features than entity graphs)
1620
+ *
1621
+ * **Use Cases:**
1622
+ * - Browse available extensions before creating a graph
1623
+ * - Understand extension capabilities and data models
1624
+ * - Plan graph schema based on business requirements
1625
+ * - Combine multiple extensions for comprehensive data modeling
1626
+ *
1627
+ * **Note:**
1628
+ * Extension listing is included - no credit consumption required.
1209
1629
  */
1210
- export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, unknown, ThrowOnError, "fields">;
1630
+ export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, ThrowOnError, "fields">;
1211
1631
  /**
1212
1632
  * Select Graph
1213
- * Select a specific graph as the active graph for the user.
1633
+ * Select a specific graph as the active workspace for the user.
1634
+ *
1635
+ * The selected graph becomes the default context for operations in client applications
1636
+ * and can be used to maintain user workspace preferences across sessions.
1637
+ *
1638
+ * **Functionality:**
1639
+ * - Sets the specified graph as the user's currently selected graph
1640
+ * - Deselects any previously selected graph (only one can be selected at a time)
1641
+ * - Persists selection across sessions until changed
1642
+ * - Returns confirmation with the selected graph ID
1643
+ *
1644
+ * **Requirements:**
1645
+ * - User must have access to the graph (as admin or member)
1646
+ * - Graph must exist and not be deleted
1647
+ * - User can only select graphs they have permission to access
1648
+ *
1649
+ * **Use Cases:**
1650
+ * - Switch between multiple graphs in a multi-graph environment
1651
+ * - Set default workspace after creating a new graph
1652
+ * - Restore user's preferred workspace on login
1653
+ * - Support graph context switching in client applications
1654
+ *
1655
+ * **Client Integration:**
1656
+ * Many client operations can default to the selected graph, simplifying API calls
1657
+ * by eliminating the need to specify graph_id repeatedly. Check the selected
1658
+ * graph with `GET /v1/graphs` which returns `selectedGraphId`.
1659
+ *
1660
+ * **Note:**
1661
+ * Graph selection is included - no credit consumption required.
1214
1662
  */
1215
1663
  export declare const selectGraph: <ThrowOnError extends boolean = false>(options: Options<SelectGraphData, ThrowOnError>) => import("./client").RequestResult<SelectGraphResponses, SelectGraphErrors, ThrowOnError, "fields">;
1216
1664
  /**