@robosystems/client 0.1.16 → 0.1.17

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.
@@ -62,7 +62,7 @@ export declare function useStreamingQuery(graphId: string): {
62
62
  export declare function useOperation<T = any>(operationId?: string): {
63
63
  monitor: (id: string, timeout?: number) => Promise<OperationResult<T> | null>;
64
64
  cancel: (id: string) => Promise<void>;
65
- status: "error" | "idle" | "running" | "completed";
65
+ status: "completed" | "error" | "idle" | "running";
66
66
  progress: OperationProgress;
67
67
  error: Error;
68
68
  result: OperationResult<T>;
package/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, 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';
2
+ 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, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, 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, 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, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, ExportBackupData, ExportBackupResponses, ExportBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, 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, CopyDataToGraphData, CopyDataToGraphResponses, CopyDataToGraphErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, 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
@@ -58,11 +58,6 @@ export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(op
58
58
  * Complete SSO authentication using session ID from secure handoff.
59
59
  */
60
60
  export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => import("./client").RequestResult<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError, "fields">;
61
- /**
62
- * Get CAPTCHA Configuration
63
- * Get CAPTCHA configuration including site key and whether CAPTCHA is required.
64
- */
65
- export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => import("./client").RequestResult<GetCaptchaConfigResponses, unknown, ThrowOnError, "fields">;
66
61
  /**
67
62
  * Get Password Policy
68
63
  * Get current password policy requirements for frontend validation
@@ -73,6 +68,11 @@ export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(o
73
68
  * Check password strength and get validation feedback
74
69
  */
75
70
  export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => import("./client").RequestResult<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError, "fields">;
71
+ /**
72
+ * Get CAPTCHA Configuration
73
+ * Get CAPTCHA configuration including site key and whether CAPTCHA is required.
74
+ */
75
+ export declare const getCaptchaConfig: <ThrowOnError extends boolean = false>(options?: Options<GetCaptchaConfigData, ThrowOnError>) => import("./client").RequestResult<GetCaptchaConfigResponses, unknown, ThrowOnError, "fields">;
76
76
  /**
77
77
  * Health Check
78
78
  * Service health check endpoint for monitoring and load balancers
@@ -144,6 +144,11 @@ export declare const getUserLimits: <ThrowOnError extends boolean = false>(optio
144
144
  * Retrieve current usage statistics and remaining limits for the authenticated user
145
145
  */
146
146
  export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, GetUserUsageErrors, ThrowOnError, "fields">;
147
+ /**
148
+ * Get all shared repository limits
149
+ * Get rate limit status for all shared repositories the user has access to.
150
+ */
151
+ export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
147
152
  /**
148
153
  * Get shared repository rate limit status
149
154
  * Get current rate limit status and usage for a shared repository.
@@ -157,11 +162,6 @@ export declare const getUserUsage: <ThrowOnError extends boolean = false>(option
157
162
  * Note: All queries are FREE - this only shows rate limit status.
158
163
  */
159
164
  export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
160
- /**
161
- * Get all shared repository limits
162
- * Get rate limit status for all shared repositories the user has access to.
163
- */
164
- export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
165
165
  /**
166
166
  * Get User Usage Overview
167
167
  * Get a high-level overview of usage statistics for the current user.
@@ -202,30 +202,6 @@ export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean =
202
202
  * Get credit balance for a specific shared repository
203
203
  */
204
204
  export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
205
- /**
206
- * List Connection Options
207
- * Get metadata about all available data connection providers.
208
- *
209
- * This endpoint returns comprehensive information about each supported provider:
210
- *
211
- * **SEC EDGAR**: Public entity financial filings
212
- * - No authentication required (public data)
213
- * - 10-K, 10-Q, 8-K reports with XBRL data
214
- * - Historical and real-time filing access
215
- *
216
- * **QuickBooks Online**: Full accounting system integration
217
- * - OAuth 2.0 authentication
218
- * - Chart of accounts, transactions, trial balance
219
- * - Real-time sync capabilities
220
- *
221
- * **Plaid**: Bank account connections
222
- * - Secure bank authentication via Plaid Link
223
- * - Transaction history and balances
224
- * - Multi-account support
225
- *
226
- * No credits are consumed for viewing connection options.
227
- */
228
- export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => import("./client").RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError, "fields">;
229
205
  /**
230
206
  * List Connections
231
207
  * List all data connections in the graph.
@@ -299,6 +275,30 @@ export declare const deleteConnection: <ThrowOnError extends boolean = false>(op
299
275
  * No credits are consumed for viewing connection details.
300
276
  */
301
277
  export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
278
+ /**
279
+ * List Connection Options
280
+ * Get metadata about all available data connection providers.
281
+ *
282
+ * This endpoint returns comprehensive information about each supported provider:
283
+ *
284
+ * **SEC EDGAR**: Public entity financial filings
285
+ * - No authentication required (public data)
286
+ * - 10-K, 10-Q, 8-K reports with XBRL data
287
+ * - Historical and real-time filing access
288
+ *
289
+ * **QuickBooks Online**: Full accounting system integration
290
+ * - OAuth 2.0 authentication
291
+ * - Chart of accounts, transactions, trial balance
292
+ * - Real-time sync capabilities
293
+ *
294
+ * **Plaid**: Bank account connections
295
+ * - Secure bank authentication via Plaid Link
296
+ * - Transaction history and balances
297
+ * - Multi-account support
298
+ *
299
+ * No credits are consumed for viewing connection options.
300
+ */
301
+ export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => import("./client").RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError, "fields">;
302
302
  /**
303
303
  * Sync Connection
304
304
  * Trigger a data synchronization for the connection.
@@ -507,6 +507,11 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
507
507
  * MCP tool calls are currently FREE and do not consume credits.
508
508
  */
509
509
  export declare const callMcpTool: <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => import("./client").RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError, "fields">;
510
+ /**
511
+ * List Kuzu graph backups
512
+ * List all backups for the specified graph database
513
+ */
514
+ export declare const listBackups: <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => import("./client").RequestResult<ListBackupsResponses, ListBackupsErrors, ThrowOnError, "fields">;
510
515
  /**
511
516
  * Create Backup
512
517
  * Create a backup of the graph database.
@@ -553,16 +558,16 @@ export declare const callMcpTool: <ThrowOnError extends boolean = false>(options
553
558
  * Returns operation details for SSE monitoring.
554
559
  */
555
560
  export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => import("./client").RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError, "fields">;
556
- /**
557
- * List Kuzu graph backups
558
- * List all backups for the specified graph database
559
- */
560
- export declare const listBackups: <ThrowOnError extends boolean = false>(options: Options<ListBackupsData, ThrowOnError>) => import("./client").RequestResult<ListBackupsResponses, ListBackupsErrors, ThrowOnError, "fields">;
561
561
  /**
562
562
  * Export Kuzu backup for download
563
563
  * Export a backup file for download (only available for non-encrypted, compressed .kuzu backups)
564
564
  */
565
565
  export declare const exportBackup: <ThrowOnError extends boolean = false>(options: Options<ExportBackupData, ThrowOnError>) => import("./client").RequestResult<ExportBackupResponses, ExportBackupErrors, ThrowOnError, "fields">;
566
+ /**
567
+ * Get temporary download URL for backup
568
+ * Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
569
+ */
570
+ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
566
571
  /**
567
572
  * Restore Encrypted Backup
568
573
  * Restore a graph database from an encrypted backup.
@@ -614,16 +619,6 @@ export declare const restoreBackup: <ThrowOnError extends boolean = false>(optio
614
619
  * Get comprehensive backup statistics for the specified graph database
615
620
  */
616
621
  export declare const getBackupStats: <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => import("./client").RequestResult<GetBackupStatsResponses, GetBackupStatsErrors, ThrowOnError, "fields">;
617
- /**
618
- * Check Kuzu backup system health
619
- * Check the health status of the Kuzu backup system
620
- */
621
- export declare const kuzuBackupHealth: <ThrowOnError extends boolean = false>(options: Options<KuzuBackupHealthData, ThrowOnError>) => import("./client").RequestResult<KuzuBackupHealthResponses, KuzuBackupHealthErrors, ThrowOnError, "fields">;
622
- /**
623
- * Get temporary download URL for backup
624
- * Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
625
- */
626
- export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
627
622
  /**
628
623
  * Get Graph Metrics
629
624
  * Get comprehensive metrics for the graph database.
@@ -791,21 +786,25 @@ export declare const listSchemaExtensions: <ThrowOnError extends boolean = false
791
786
  */
792
787
  export declare const getCurrentGraphBill: <ThrowOnError extends boolean = false>(options: Options<GetCurrentGraphBillData, ThrowOnError>) => import("./client").RequestResult<GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, ThrowOnError, "fields">;
793
788
  /**
794
- * Get Monthly Bill
795
- * Get billing details for a specific month.
789
+ * Get Usage Details
790
+ * Get detailed usage metrics for the graph.
796
791
  *
797
- * Retrieve historical billing information for any previous month.
798
- * Useful for:
799
- * - Reconciling past charges
800
- * - Tracking usage trends
801
- * - Expense reporting
802
- * - Budget analysis
792
+ * Provides granular usage information including:
793
+ * - **Daily Credit Consumption**: Track credit usage patterns
794
+ * - **Storage Growth**: Monitor database size over time
795
+ * - **Operation Breakdown**: Credits by operation type
796
+ * - **Peak Usage Times**: Identify high-activity periods
797
+ * - **API Call Volumes**: Request counts and patterns
803
798
  *
804
- * Returns the same detailed breakdown as the current bill endpoint.
799
+ * Useful for:
800
+ * - Optimizing credit consumption
801
+ * - Capacity planning
802
+ * - Usage trend analysis
803
+ * - Cost optimization
805
804
  *
806
- * ℹ️ No credits are consumed for viewing billing history.
805
+ * ℹ️ No credits are consumed for viewing usage details.
807
806
  */
808
- export declare const getGraphMonthlyBill: <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => import("./client").RequestResult<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError, "fields">;
807
+ export declare const getGraphUsageDetails: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError, "fields">;
809
808
  /**
810
809
  * Get Billing History
811
810
  * Get billing history for the graph.
@@ -826,53 +825,21 @@ export declare const getGraphMonthlyBill: <ThrowOnError extends boolean = false>
826
825
  */
827
826
  export declare const getGraphBillingHistory: <ThrowOnError extends boolean = false>(options: Options<GetGraphBillingHistoryData, ThrowOnError>) => import("./client").RequestResult<GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, ThrowOnError, "fields">;
828
827
  /**
829
- * Get Usage Details
830
- * Get detailed usage metrics for the graph.
831
- *
832
- * Provides granular usage information including:
833
- * - **Daily Credit Consumption**: Track credit usage patterns
834
- * - **Storage Growth**: Monitor database size over time
835
- * - **Operation Breakdown**: Credits by operation type
836
- * - **Peak Usage Times**: Identify high-activity periods
837
- * - **API Call Volumes**: Request counts and patterns
828
+ * Get Monthly Bill
829
+ * Get billing details for a specific month.
838
830
  *
831
+ * Retrieve historical billing information for any previous month.
839
832
  * Useful for:
840
- * - Optimizing credit consumption
841
- * - Capacity planning
842
- * - Usage trend analysis
843
- * - Cost optimization
833
+ * - Reconciling past charges
834
+ * - Tracking usage trends
835
+ * - Expense reporting
836
+ * - Budget analysis
844
837
  *
845
- * ℹ️ No credits are consumed for viewing usage details.
846
- */
847
- export declare const getGraphUsageDetails: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError, "fields">;
848
- /**
849
- * Get Graph Pricing Info
850
- * Get pricing information for a specific graph database.
851
- */
852
- export declare const getGraphPricingInfoV1GraphIdBillingPricingGet: <ThrowOnError extends boolean = false>(options: Options<GetGraphPricingInfoV1GraphIdBillingPricingGetData, ThrowOnError>) => import("./client").RequestResult<GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, ThrowOnError, "fields">;
853
- /**
854
- * Upgrade Graph Subscription
855
- * Upgrade subscription for a specific graph database.
856
- */
857
- export declare const upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost: <ThrowOnError extends boolean = false>(options: Options<UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, ThrowOnError>) => import("./client").RequestResult<UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, ThrowOnError, "fields">;
858
- /**
859
- * Get Graph Subscription
860
- * Get current subscription for a graph database.
861
- */
862
- export declare const getGraphSubscriptionV1GraphIdBillingSubscriptionGet: <ThrowOnError extends boolean = false>(options: Options<GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, ThrowOnError>) => import("./client").RequestResult<GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, ThrowOnError, "fields">;
863
- /**
864
- * Get Available Subscription Plans
865
- * Get available subscription plans for upgrade.
866
- */
867
- export declare const getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet: <ThrowOnError extends boolean = false>(options: Options<GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, ThrowOnError>) => import("./client").RequestResult<GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, ThrowOnError, "fields">;
868
- /**
869
- * Get Credit Billing Info
870
- * Get credit-based billing information for a specific graph.
838
+ * Returns the same detailed breakdown as the current bill endpoint.
871
839
  *
872
- * This endpoint provides comprehensive credit usage and billing information
873
- * without consuming credits (for billing transparency).
840
+ * ℹ️ No credits are consumed for viewing billing history.
874
841
  */
875
- export declare const getCreditBillingInfoV1GraphIdBillingCreditsGet: <ThrowOnError extends boolean = false>(options: Options<GetCreditBillingInfoV1GraphIdBillingCreditsGetData, ThrowOnError>) => import("./client").RequestResult<GetCreditBillingInfoV1GraphIdBillingCreditsGetResponses, GetCreditBillingInfoV1GraphIdBillingCreditsGetErrors, ThrowOnError, "fields">;
842
+ export declare const getGraphMonthlyBill: <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => import("./client").RequestResult<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError, "fields">;
876
843
  /**
877
844
  * Get Credit Summary
878
845
  * Retrieve comprehensive credit usage summary for the specified graph.
@@ -991,64 +958,51 @@ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(o
991
958
  * This endpoint provides essential database information for capacity planning and monitoring.
992
959
  */
993
960
  export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
961
+ /**
962
+ * Get Graph Operational Limits
963
+ * Get comprehensive operational limits for the graph database.
964
+ *
965
+ * Returns all operational limits that apply to this graph including:
966
+ * - **Storage Limits**: Maximum storage size and current usage
967
+ * - **Query Limits**: Timeouts, complexity, row limits
968
+ * - **Copy/Ingestion Limits**: File sizes, timeouts, concurrent operations
969
+ * - **Backup Limits**: Frequency, retention, size limits
970
+ * - **Rate Limits**: Requests per minute/hour based on tier
971
+ * - **Credit Limits**: AI operation credits (if applicable)
972
+ *
973
+ * This unified endpoint provides all limits in one place for easier client integration.
974
+ *
975
+ * **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
976
+ */
977
+ export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
994
978
  /**
995
979
  * List Subgraphs
996
980
  * List all subgraphs for a parent graph.
997
981
  *
998
982
  * **Requirements:**
999
- * - User must have at least read access to parent graph
1000
- *
1001
- * **Response includes:**
1002
- * - List of all subgraphs with metadata
1003
- * - Current usage vs limits
1004
- * - Size and statistics per subgraph
1005
- * - Creation timestamps
983
+ * - Valid authentication
984
+ * - Parent graph must exist and be accessible to the user
985
+ * - User must have at least 'read' permission on the parent graph
1006
986
  *
1007
- * **Filtering:**
1008
- * Currently returns all subgraphs. Future versions will support:
1009
- * - Filtering by status
1010
- * - Filtering by creation date
1011
- * - Pagination for large lists
987
+ * **Returns:**
988
+ * - List of all subgraphs for the parent graph
989
+ * - Each subgraph includes its ID, name, description, type, status, and creation date
1012
990
  */
1013
991
  export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => import("./client").RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError, "fields">;
1014
992
  /**
1015
- * Create New Subgraph
1016
- * Create a new subgraph database under an Enterprise or Premium parent graph.
993
+ * Create Subgraph
994
+ * Create a new subgraph within a parent graph.
1017
995
  *
1018
996
  * **Requirements:**
1019
- * - Parent graph must be Enterprise or Premium tier
1020
- * - User must have admin access to parent graph
1021
- * - Subgraph name must be unique within parent
1022
- * - Subgraph name must be alphanumeric (1-20 chars)
1023
- *
1024
- * **Subgraph Benefits:**
1025
- * - Shares parent's infrastructure (no additional cost)
1026
- * - Inherits parent's credit pool
1027
- * - Isolated database on same instance
1028
- * - Full Kuzu database capabilities
1029
- *
1030
- * **Use Cases:**
1031
- * - Separate environments (dev/staging/prod)
1032
- * - Department-specific data isolation
1033
- * - Multi-tenant applications
1034
- * - Testing and experimentation
1035
- *
1036
- * **Schema Inheritance:**
1037
- * - Subgraphs can use parent's schema or custom extensions
1038
- * - Extensions are additive only
1039
- * - Base schema always included
1040
- *
1041
- * **Limits:**
1042
- * - Standard: Not supported (0 subgraphs)
1043
- * - Enterprise: Configurable limit (default: 10 subgraphs)
1044
- * - Premium: Unlimited subgraphs
1045
- * - Limits are defined in deployment configuration
997
+ * - Valid authentication
998
+ * - Parent graph must exist and be accessible to the user
999
+ * - User must have 'admin' permission on the parent graph
1000
+ * - Parent graph tier must support subgraphs (Enterprise or Premium only)
1001
+ * - Must be within subgraph quota limits
1002
+ * - Subgraph name must be unique within the parent graph
1046
1003
  *
1047
- * **Response includes:**
1048
- * - `graph_id`: Full subgraph identifier
1049
- * - `parent_graph_id`: Parent graph ID
1050
- * - `subgraph_name`: Short name within parent
1051
- * - `status`: Creation status
1004
+ * **Returns:**
1005
+ * - Created subgraph details including its unique ID
1052
1006
  */
1053
1007
  export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
1054
1008
  /**
@@ -1073,6 +1027,29 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
1073
1027
  * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
1074
1028
  */
1075
1029
  export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
1030
+ /**
1031
+ * Get Subgraph Details
1032
+ * Get detailed information about a specific subgraph.
1033
+ *
1034
+ * **Requirements:**
1035
+ * - User must have read access to parent graph
1036
+ *
1037
+ * **Response includes:**
1038
+ * - Full subgraph metadata
1039
+ * - Database statistics (nodes, edges)
1040
+ * - Size information
1041
+ * - Schema configuration
1042
+ * - Creation/modification timestamps
1043
+ * - Last access time (when available)
1044
+ *
1045
+ * **Statistics:**
1046
+ * Real-time statistics queried from Kuzu:
1047
+ * - Node count
1048
+ * - Edge count
1049
+ * - Database size on disk
1050
+ * - Schema information
1051
+ */
1052
+ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
1076
1053
  /**
1077
1054
  * Get Subgraph Quota
1078
1055
  * Get subgraph quota and usage information for a parent graph.
@@ -1095,28 +1072,31 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
1095
1072
  */
1096
1073
  export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
1097
1074
  /**
1098
- * Get Subgraph Details
1099
- * Get detailed information about a specific subgraph.
1075
+ * Copy Data to Graph
1076
+ * Copy data from external sources into the graph database.
1100
1077
  *
1101
- * **Requirements:**
1102
- * - User must have read access to parent graph
1078
+ * This endpoint supports multiple data sources through a unified interface:
1079
+ * - **S3**: Copy from S3 buckets with user-provided credentials
1080
+ * - **URL** (future): Copy from HTTP(S) URLs
1081
+ * - **DataFrame** (future): Copy from uploaded DataFrames
1103
1082
  *
1104
- * **Response includes:**
1105
- * - Full subgraph metadata
1106
- * - Database statistics (nodes, edges)
1107
- * - Size information
1108
- * - Schema configuration
1109
- * - Creation/modification timestamps
1110
- * - Last access time (when available)
1083
+ * **Security:**
1084
+ * - Requires write permissions to the target graph
1085
+ * - **Not allowed on shared repositories** (sec, industry, economic) - these are read-only
1086
+ * - User must provide their own AWS credentials for S3 access
1087
+ * - All operations are logged for audit purposes
1111
1088
  *
1112
- * **Statistics:**
1113
- * Real-time statistics queried from Kuzu:
1114
- * - Node count
1115
- * - Edge count
1116
- * - Database size on disk
1117
- * - Schema information
1089
+ * **Tier Limits:**
1090
+ * - Standard: 10GB max file size, 15 min timeout
1091
+ * - Enterprise: 50GB max file size, 30 min timeout
1092
+ * - Premium: 100GB max file size, 60 min timeout
1093
+ *
1094
+ * **Copy Options:**
1095
+ * - `ignore_errors`: Skip duplicate/invalid rows (enables upsert-like behavior)
1096
+ * - `extended_timeout`: Use extended timeout for large datasets
1097
+ * - `validate_schema`: Validate source schema against target table
1118
1098
  */
1119
- export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
1099
+ export declare const copyDataToGraph: <ThrowOnError extends boolean = false>(options: Options<CopyDataToGraphData, ThrowOnError>) => import("./client").RequestResult<CopyDataToGraphResponses, CopyDataToGraphErrors, ThrowOnError, "fields">;
1120
1100
  /**
1121
1101
  * Create New Graph Database
1122
1102
  * Create a new graph database with specified schema and optionally an initial entity.