@robosystems/client 0.1.15 → 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.
Files changed (67) hide show
  1. package/extensions/hooks.d.ts +1 -1
  2. package/package.json +48 -6
  3. package/sdk/client/client.gen.d.ts +2 -0
  4. package/sdk/client/client.gen.js +153 -0
  5. package/sdk/client/client.gen.ts +200 -0
  6. package/sdk/client/index.d.ts +7 -0
  7. package/sdk/client/index.js +15 -0
  8. package/sdk/client/index.ts +25 -0
  9. package/sdk/client/types.gen.d.ts +122 -0
  10. package/sdk/client/types.gen.js +4 -0
  11. package/sdk/client/types.gen.ts +233 -0
  12. package/sdk/client/utils.gen.d.ts +45 -0
  13. package/sdk/client/utils.gen.js +296 -0
  14. package/sdk/client/utils.gen.ts +419 -0
  15. package/sdk/client.gen.d.ts +12 -0
  16. package/sdk/client.gen.js +8 -0
  17. package/sdk/client.gen.ts +18 -0
  18. package/sdk/core/auth.gen.d.ts +18 -0
  19. package/sdk/core/auth.gen.js +18 -0
  20. package/sdk/core/auth.gen.ts +42 -0
  21. package/sdk/core/bodySerializer.gen.d.ts +17 -0
  22. package/sdk/core/bodySerializer.gen.js +57 -0
  23. package/sdk/core/bodySerializer.gen.ts +90 -0
  24. package/sdk/core/params.gen.d.ts +33 -0
  25. package/sdk/core/params.gen.js +92 -0
  26. package/sdk/core/params.gen.ts +153 -0
  27. package/sdk/core/pathSerializer.gen.d.ts +33 -0
  28. package/sdk/core/pathSerializer.gen.js +123 -0
  29. package/sdk/core/pathSerializer.gen.ts +181 -0
  30. package/sdk/core/types.gen.d.ts +78 -0
  31. package/sdk/core/types.gen.js +4 -0
  32. package/sdk/core/types.gen.ts +121 -0
  33. package/sdk/index.d.ts +2 -0
  34. package/sdk/index.js +19 -0
  35. package/sdk/index.ts +3 -0
  36. package/sdk/sdk.gen.d.ts +1249 -0
  37. package/sdk/sdk.gen.js +2572 -0
  38. package/sdk/sdk.gen.ts +2585 -0
  39. package/sdk/types.gen.d.ts +6347 -0
  40. package/sdk/types.gen.js +3 -0
  41. package/sdk/types.gen.ts +6852 -0
  42. package/sdk-extensions/OperationClient.d.ts +64 -0
  43. package/sdk-extensions/OperationClient.js +251 -0
  44. package/sdk-extensions/OperationClient.ts +322 -0
  45. package/sdk-extensions/QueryClient.d.ts +50 -0
  46. package/sdk-extensions/QueryClient.js +190 -0
  47. package/sdk-extensions/QueryClient.ts +283 -0
  48. package/sdk-extensions/README.md +672 -0
  49. package/sdk-extensions/SSEClient.d.ts +48 -0
  50. package/sdk-extensions/SSEClient.js +148 -0
  51. package/sdk-extensions/SSEClient.ts +189 -0
  52. package/sdk-extensions/config.d.ts +32 -0
  53. package/sdk-extensions/config.js +74 -0
  54. package/sdk-extensions/config.ts +91 -0
  55. package/sdk-extensions/hooks.d.ts +110 -0
  56. package/sdk-extensions/hooks.js +371 -0
  57. package/sdk-extensions/hooks.ts +438 -0
  58. package/sdk-extensions/index.d.ts +46 -0
  59. package/sdk-extensions/index.js +110 -0
  60. package/sdk-extensions/index.ts +123 -0
  61. package/sdk.gen.d.ts +210 -104
  62. package/sdk.gen.js +409 -287
  63. package/sdk.gen.ts +404 -282
  64. package/types.gen.d.ts +1218 -567
  65. package/types.gen.ts +1236 -566
  66. package/openapi-ts.config.js +0 -9
  67. package/prepare.js +0 -220
@@ -0,0 +1,1249 @@
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, 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
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
4
+ /**
5
+ * You can provide a client instance returned by `createClient()` instead of
6
+ * individual options. This might be also useful if you want to implement a
7
+ * custom client.
8
+ */
9
+ client?: Client;
10
+ /**
11
+ * You can pass arbitrary values through the `meta` object. This can be
12
+ * used to access values that aren't defined as part of the SDK function.
13
+ */
14
+ meta?: Record<string, unknown>;
15
+ };
16
+ /**
17
+ * Register New User
18
+ * Register a new user account with email and password. Security controls vary by environment: CAPTCHA and email verification are disabled in development for API testing, but required in production.
19
+ */
20
+ export declare const registerUser: <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => import("./client").RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "fields">;
21
+ /**
22
+ * User Login
23
+ * Authenticate user with email and password.
24
+ */
25
+ export declare const loginUser: <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => import("./client").RequestResult<LoginUserResponses, LoginUserErrors, ThrowOnError, "fields">;
26
+ /**
27
+ * User Logout
28
+ * Logout user and invalidate session.
29
+ */
30
+ export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError, "fields">;
31
+ /**
32
+ * Get Current User
33
+ * Get current authenticated user from session.
34
+ */
35
+ export declare const getCurrentAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError, "fields">;
36
+ /**
37
+ * Refresh Session
38
+ * Refresh user session and extend authentication token.
39
+ */
40
+ export declare const refreshSession: <ThrowOnError extends boolean = false>(options?: Options<RefreshSessionData, ThrowOnError>) => import("./client").RequestResult<RefreshSessionResponses, RefreshSessionErrors, ThrowOnError, "fields">;
41
+ /**
42
+ * Generate SSO Token
43
+ * Generate a temporary SSO token for cross-app authentication.
44
+ */
45
+ export declare const generateSsoToken: <ThrowOnError extends boolean = false>(options?: Options<GenerateSsoTokenData, ThrowOnError>) => import("./client").RequestResult<GenerateSsoTokenResponses, GenerateSsoTokenErrors, ThrowOnError, "fields">;
46
+ /**
47
+ * SSO Login
48
+ * Authenticate user with SSO token and establish session.
49
+ */
50
+ export declare const ssoLogin: <ThrowOnError extends boolean = false>(options: Options<SsoLoginData, ThrowOnError>) => import("./client").RequestResult<SsoLoginResponses, SsoLoginErrors, ThrowOnError, "fields">;
51
+ /**
52
+ * SSO Token Exchange
53
+ * Exchange SSO token for secure session handoff to target application.
54
+ */
55
+ export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(options: Options<SsoTokenExchangeData, ThrowOnError>) => import("./client").RequestResult<SsoTokenExchangeResponses, SsoTokenExchangeErrors, ThrowOnError, "fields">;
56
+ /**
57
+ * Complete SSO Authentication
58
+ * Complete SSO authentication using session ID from secure handoff.
59
+ */
60
+ export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => import("./client").RequestResult<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError, "fields">;
61
+ /**
62
+ * Get Password Policy
63
+ * Get current password policy requirements for frontend validation
64
+ */
65
+ export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => import("./client").RequestResult<GetPasswordPolicyResponses, unknown, ThrowOnError, "fields">;
66
+ /**
67
+ * Check Password Strength
68
+ * Check password strength and get validation feedback
69
+ */
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
+ /**
77
+ * Health Check
78
+ * Service health check endpoint for monitoring and load balancers
79
+ */
80
+ export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => import("./client").RequestResult<GetServiceStatusResponses, unknown, ThrowOnError, "fields">;
81
+ /**
82
+ * Get Current User
83
+ * Returns information about the currently authenticated user.
84
+ */
85
+ export declare const getCurrentUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError, "fields">;
86
+ /**
87
+ * Update User Profile
88
+ * Update the current user's profile information.
89
+ */
90
+ export declare const updateUser: <ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>) => import("./client").RequestResult<UpdateUserResponses, UpdateUserErrors, ThrowOnError, "fields">;
91
+ /**
92
+ * Get User Graphs
93
+ * Get all graph databases accessible to the current user.
94
+ */
95
+ export declare const getUserGraphs: <ThrowOnError extends boolean = false>(options?: Options<GetUserGraphsData, ThrowOnError>) => import("./client").RequestResult<GetUserGraphsResponses, GetUserGraphsErrors, ThrowOnError, "fields">;
96
+ /**
97
+ * Select User Graph
98
+ * Select a specific graph as the active graph for the user.
99
+ */
100
+ export declare const selectUserGraph: <ThrowOnError extends boolean = false>(options: Options<SelectUserGraphData, ThrowOnError>) => import("./client").RequestResult<SelectUserGraphResponses, SelectUserGraphErrors, ThrowOnError, "fields">;
101
+ /**
102
+ * Get All Credit Summaries
103
+ * Get credit summaries for all graphs owned by the user.
104
+ *
105
+ * This endpoint provides a consolidated view of credit usage across
106
+ * all graphs where the user has access, helping to monitor overall
107
+ * credit consumption and plan usage.
108
+ *
109
+ * No credits are consumed for viewing summaries.
110
+ */
111
+ export declare const getAllCreditSummaries: <ThrowOnError extends boolean = false>(options?: Options<GetAllCreditSummariesData, ThrowOnError>) => import("./client").RequestResult<GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, ThrowOnError, "fields">;
112
+ /**
113
+ * Update Password
114
+ * Update the current user's password.
115
+ */
116
+ export declare const updateUserPassword: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPasswordData, ThrowOnError>) => import("./client").RequestResult<UpdateUserPasswordResponses, UpdateUserPasswordErrors, ThrowOnError, "fields">;
117
+ /**
118
+ * List API Keys
119
+ * Get all API keys for the current user.
120
+ */
121
+ export declare const listUserApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>) => import("./client").RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError, "fields">;
122
+ /**
123
+ * Create API Key
124
+ * Create a new API key for the current user.
125
+ */
126
+ export declare const createUserApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError, "fields">;
127
+ /**
128
+ * Revoke API Key
129
+ * Revoke (deactivate) an API key.
130
+ */
131
+ export declare const revokeUserApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, ThrowOnError, "fields">;
132
+ /**
133
+ * Update API Key
134
+ * Update an API key's name or description.
135
+ */
136
+ export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(options: Options<UpdateUserApiKeyData, ThrowOnError>) => import("./client").RequestResult<UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ThrowOnError, "fields">;
137
+ /**
138
+ * Get user limits
139
+ * Retrieve current limits and restrictions for the authenticated user
140
+ */
141
+ export declare const getUserLimits: <ThrowOnError extends boolean = false>(options?: Options<GetUserLimitsData, ThrowOnError>) => import("./client").RequestResult<GetUserLimitsResponses, GetUserLimitsErrors, ThrowOnError, "fields">;
142
+ /**
143
+ * Get user usage statistics
144
+ * Retrieve current usage statistics and remaining limits for the authenticated user
145
+ */
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">;
152
+ /**
153
+ * Get shared repository rate limit status
154
+ * Get current rate limit status and usage for a shared repository.
155
+ *
156
+ * Returns:
157
+ * - Current usage across different time windows
158
+ * - Rate limits based on subscription tier
159
+ * - Remaining quota
160
+ * - Reset times
161
+ *
162
+ * Note: All queries are FREE - this only shows rate limit status.
163
+ */
164
+ export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
165
+ /**
166
+ * Get User Usage Overview
167
+ * Get a high-level overview of usage statistics for the current user.
168
+ */
169
+ export declare const getUserUsageOverview: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageOverviewData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, ThrowOnError, "fields">;
170
+ /**
171
+ * Get Detailed User Analytics
172
+ * Get comprehensive analytics for the current user including API usage and recent activity.
173
+ */
174
+ export declare const getDetailedUserAnalytics: <ThrowOnError extends boolean = false>(options?: Options<GetDetailedUserAnalyticsData, ThrowOnError>) => import("./client").RequestResult<GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, ThrowOnError, "fields">;
175
+ /**
176
+ * Get User Subscriptions
177
+ * Retrieve user's current shared repository subscriptions with detailed information
178
+ */
179
+ export declare const getUserSharedSubscriptions: <ThrowOnError extends boolean = false>(options?: Options<GetUserSharedSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, ThrowOnError, "fields">;
180
+ /**
181
+ * Subscribe to Shared Repository
182
+ * Create a new subscription to a shared repository add-on with specified tier
183
+ */
184
+ export declare const subscribeToSharedRepository: <ThrowOnError extends boolean = false>(options: Options<SubscribeToSharedRepositoryData, ThrowOnError>) => import("./client").RequestResult<SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, ThrowOnError, "fields">;
185
+ /**
186
+ * Upgrade Subscription Tier
187
+ * Upgrade a subscription to a higher tier with immediate credit adjustment
188
+ */
189
+ export declare const upgradeSharedRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<UpgradeSharedRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, ThrowOnError, "fields">;
190
+ /**
191
+ * Cancel Subscription
192
+ * Cancel a shared repository subscription and disable associated credit pool
193
+ */
194
+ export declare const cancelSharedRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSharedRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, ThrowOnError, "fields">;
195
+ /**
196
+ * Get Credit Balances
197
+ * Retrieve credit balances for all shared repository subscriptions
198
+ */
199
+ export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean = false>(options?: Options<GetSharedRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, ThrowOnError, "fields">;
200
+ /**
201
+ * Get Repository Credits
202
+ * Get credit balance for a specific shared repository
203
+ */
204
+ export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
205
+ /**
206
+ * List Connections
207
+ * List all data connections in the graph.
208
+ *
209
+ * Returns active and inactive connections with their current status.
210
+ * Connections can be filtered by:
211
+ * - **Entity**: Show connections for a specific entity
212
+ * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
213
+ *
214
+ * Each connection shows:
215
+ * - Current sync status and health
216
+ * - Last successful sync timestamp
217
+ * - Configuration metadata
218
+ * - Error messages if any
219
+ *
220
+ * No credits are consumed for listing connections.
221
+ */
222
+ export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
223
+ /**
224
+ * Create Connection
225
+ * Create a new data connection for external system integration.
226
+ *
227
+ * This endpoint initiates connections to external data sources:
228
+ *
229
+ * **SEC Connections**:
230
+ * - Provide entity CIK for automatic filing retrieval
231
+ * - No authentication needed
232
+ * - Begins immediate data sync
233
+ *
234
+ * **QuickBooks Connections**:
235
+ * - Returns OAuth URL for authorization
236
+ * - Requires admin permissions in QuickBooks
237
+ * - Complete with OAuth callback
238
+ *
239
+ * **Plaid Connections**:
240
+ * - Returns Plaid Link token
241
+ * - User completes bank authentication
242
+ * - Exchange public token for access
243
+ *
244
+ * Note:
245
+ * This operation is FREE - no credit consumption required.
246
+ */
247
+ export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
248
+ /**
249
+ * Delete Connection
250
+ * Delete a data connection and clean up related resources.
251
+ *
252
+ * This operation:
253
+ * - Removes the connection configuration
254
+ * - Preserves any imported data in the graph
255
+ * - Performs provider-specific cleanup
256
+ * - Revokes stored credentials
257
+ *
258
+ * Note:
259
+ * This operation is FREE - no credit consumption required.
260
+ *
261
+ * Only users with admin role can delete connections.
262
+ */
263
+ export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
264
+ /**
265
+ * Get Connection
266
+ * Get detailed information about a specific connection.
267
+ *
268
+ * Returns comprehensive connection details including:
269
+ * - Current status and health indicators
270
+ * - Authentication state
271
+ * - Sync history and statistics
272
+ * - Error details if any
273
+ * - Provider-specific metadata
274
+ *
275
+ * No credits are consumed for viewing connection details.
276
+ */
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
+ /**
303
+ * Sync Connection
304
+ * Trigger a data synchronization for the connection.
305
+ *
306
+ * Initiates data sync based on provider type:
307
+ *
308
+ * **SEC Sync**:
309
+ * - Downloads latest filings from EDGAR
310
+ * - Parses XBRL data and updates graph
311
+ * - Typically completes in 5-10 minutes
312
+ *
313
+ * **QuickBooks Sync**:
314
+ * - Fetches latest transactions and balances
315
+ * - Updates chart of accounts
316
+ * - Generates fresh trial balance
317
+ * - Duration depends on data volume
318
+ *
319
+ * **Plaid Sync**:
320
+ * - Retrieves recent bank transactions
321
+ * - Updates account balances
322
+ * - Categorizes new transactions
323
+ *
324
+ * Note:
325
+ * This operation is FREE - no credit consumption required.
326
+ *
327
+ * Returns a task ID for monitoring sync progress.
328
+ */
329
+ export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
330
+ /**
331
+ * Create Link Token
332
+ * Create a link token for embedded authentication providers.
333
+ *
334
+ * This endpoint generates a temporary token used to initialize embedded authentication UI.
335
+ *
336
+ * Currently supported providers:
337
+ * - **Plaid**: Bank account connections with real-time transaction access
338
+ *
339
+ * The link token:
340
+ * - Expires after 4 hours
341
+ * - Is single-use only
342
+ * - Must be used with the matching frontend SDK
343
+ * - Includes user and entity context
344
+ *
345
+ * No credits are consumed for creating link tokens.
346
+ */
347
+ export declare const createLinkToken: <ThrowOnError extends boolean = false>(options: Options<CreateLinkTokenData, ThrowOnError>) => import("./client").RequestResult<CreateLinkTokenResponses, CreateLinkTokenErrors, ThrowOnError, "fields">;
348
+ /**
349
+ * Exchange Link Token
350
+ * Exchange a public token for permanent access credentials.
351
+ *
352
+ * This completes the embedded authentication flow after user authorization.
353
+ *
354
+ * The exchange process:
355
+ * 1. Validates the temporary public token
356
+ * 2. Exchanges it for permanent access credentials
357
+ * 3. Updates the connection with account information
358
+ * 4. Optionally triggers initial data sync
359
+ *
360
+ * Supported providers:
361
+ * - **Plaid**: Exchanges Plaid Link public token for access token
362
+ *
363
+ * Security:
364
+ * - Public tokens expire after 30 minutes
365
+ * - Each token can only be exchanged once
366
+ * - Full audit trail is maintained
367
+ *
368
+ * No credits are consumed for token exchange.
369
+ */
370
+ export declare const exchangeLinkToken: <ThrowOnError extends boolean = false>(options: Options<ExchangeLinkTokenData, ThrowOnError>) => import("./client").RequestResult<ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, ThrowOnError, "fields">;
371
+ /**
372
+ * Init Oauth
373
+ * Initialize OAuth flow for a connection.
374
+ *
375
+ * This generates an authorization URL that the frontend should redirect the user to.
376
+ * Currently supports: QuickBooks
377
+ */
378
+ export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => import("./client").RequestResult<InitOAuthResponses, InitOAuthErrors, ThrowOnError, "fields">;
379
+ /**
380
+ * OAuth Callback
381
+ * Handle OAuth callback from provider after user authorization.
382
+ *
383
+ * This endpoint completes the OAuth flow:
384
+ * 1. Validates the OAuth state parameter
385
+ * 2. Exchanges authorization code for access tokens
386
+ * 3. Stores tokens securely
387
+ * 4. Updates connection status
388
+ * 5. Optionally triggers initial sync
389
+ *
390
+ * Supported providers:
391
+ * - **QuickBooks**: Accounting data integration
392
+ *
393
+ * Security measures:
394
+ * - State validation prevents CSRF attacks
395
+ * - User context is verified
396
+ * - Tokens are encrypted before storage
397
+ * - Full audit trail is maintained
398
+ *
399
+ * No credits are consumed for OAuth callbacks.
400
+ */
401
+ export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => import("./client").RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError, "fields">;
402
+ /**
403
+ * Query Financial Agent
404
+ * AI-powered financial analysis with direct access to graph data.
405
+ *
406
+ * This endpoint provides intelligent financial analysis using an AI agent that can:
407
+ * - Analyze entity financial statements and SEC filings
408
+ * - Review QuickBooks transactions and accounting data
409
+ * - Perform multi-period trend analysis
410
+ * - Generate insights from balance sheets and income statements
411
+ * - Answer complex financial queries with contextual understanding
412
+ *
413
+ * **Execution Modes:**
414
+ * - **Quick Analysis** (default): Synchronous responses for simple queries (1-2 tool calls)
415
+ * - **Extended Analysis**: Asynchronous processing for complex research (returns operation_id for SSE monitoring)
416
+ *
417
+ * **Extended Analysis Monitoring:**
418
+ * For complex queries, connect to the SSE stream for real-time progress:
419
+ * ```javascript
420
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
421
+ * eventSource.onmessage = (event) => {
422
+ * const data = JSON.parse(event.data);
423
+ * console.log('Analysis:', data.message);
424
+ * };
425
+ * ```
426
+ *
427
+ * **SSE Connection Limits:**
428
+ * - Maximum 5 concurrent SSE connections per user
429
+ * - Rate limited to 10 new connections per minute
430
+ * - Automatic circuit breaker for Redis failures
431
+ * - Graceful degradation with fallback to polling if SSE unavailable
432
+ *
433
+ * **Events Emitted:**
434
+ * - `operation_started`: Analysis begins
435
+ * - `operation_progress`: Tool calls, analysis steps
436
+ * - `operation_completed`: Final comprehensive analysis
437
+ * - `operation_error`: Analysis failed
438
+ *
439
+ * **Error Handling:**
440
+ * - `429 Too Many Requests`: SSE connection limit exceeded
441
+ * - `503 Service Unavailable`: SSE system temporarily disabled
442
+ * - Fallback to status polling endpoint if SSE unavailable
443
+ *
444
+ * **Credit Consumption:**
445
+ * - AI operations consume credits based on actual token usage
446
+ * - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
447
+ * - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
448
+ * - Credits are consumed after operation completes based on actual usage
449
+ *
450
+ * The agent automatically determines query complexity or you can force extended analysis.
451
+ */
452
+ export declare const queryFinancialAgent: <ThrowOnError extends boolean = false>(options: Options<QueryFinancialAgentData, ThrowOnError>) => import("./client").RequestResult<QueryFinancialAgentResponses, QueryFinancialAgentErrors, ThrowOnError, "fields">;
453
+ /**
454
+ * List MCP Tools
455
+ * Get available Model Context Protocol tools for graph analysis.
456
+ *
457
+ * This endpoint returns a comprehensive list of MCP tools optimized for AI agents:
458
+ * - Tool schemas with detailed parameter documentation
459
+ * - Context-aware descriptions based on graph type
460
+ * - Capability indicators for streaming and progress
461
+ *
462
+ * The tool list is customized based on:
463
+ * - Graph type (shared repository vs user graph)
464
+ * - User permissions and subscription tier
465
+ * - Backend capabilities (Kuzu, Neo4j, etc.)
466
+ *
467
+ * Credit consumption:
468
+ * - Listing tools is FREE to encourage exploration
469
+ * - Tool execution costs vary by operation complexity
470
+ */
471
+ export declare const listMcpTools: <ThrowOnError extends boolean = false>(options: Options<ListMcpToolsData, ThrowOnError>) => import("./client").RequestResult<ListMcpToolsResponses, ListMcpToolsErrors, ThrowOnError, "fields">;
472
+ /**
473
+ * Execute MCP Tool
474
+ * Execute an MCP tool with intelligent response optimization.
475
+ *
476
+ * This endpoint automatically selects the best execution strategy based on:
477
+ * - Tool type and estimated complexity
478
+ * - Client capabilities (AI agent detection)
479
+ * - System load and queue status
480
+ * - Graph type (shared repository vs user graph)
481
+ *
482
+ * **Response Formats:**
483
+ * - **JSON**: Direct response for small/fast operations
484
+ * - **SSE**: Server-Sent Events for progress monitoring
485
+ * - **NDJSON**: Newline-delimited JSON for streaming
486
+ * - **Queued**: Asynchronous execution with status monitoring
487
+ *
488
+ * **SSE Streaming Support:**
489
+ * - Maximum 5 concurrent SSE connections per user
490
+ * - Rate limited to 10 new connections per minute
491
+ * - Automatic circuit breaker for Redis failures
492
+ * - Graceful degradation to direct response if SSE unavailable
493
+ * - Progress events for long-running operations
494
+ *
495
+ * **AI Agent Optimization:**
496
+ * The Node.js MCP client transparently handles all response formats,
497
+ * presenting a unified interface to AI agents. Streaming responses are
498
+ * automatically aggregated for seamless consumption.
499
+ *
500
+ * **Error Handling:**
501
+ * - `429 Too Many Requests`: Connection limit or rate limit exceeded
502
+ * - `503 Service Unavailable`: SSE system temporarily disabled
503
+ * - `408 Request Timeout`: Tool execution exceeded timeout
504
+ * - Clients should implement exponential backoff on errors
505
+ *
506
+ * **Note:**
507
+ * MCP tool calls are currently FREE and do not consume credits.
508
+ */
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">;
515
+ /**
516
+ * Create Backup
517
+ * Create a backup of the graph database.
518
+ *
519
+ * Creates a complete backup of the Kuzu database (.kuzu file) with:
520
+ * - **Format**: Full database backup only (complete .kuzu file)
521
+ * - **Compression**: Always enabled for optimal storage
522
+ * - **Encryption**: Optional AES-256 encryption for security
523
+ * - **Retention**: Configurable retention period (1-2555 days)
524
+ *
525
+ * **Backup Features:**
526
+ * - **Complete Backup**: Full database file backup
527
+ * - **Consistency**: Point-in-time consistent snapshot
528
+ * - **Download Support**: Unencrypted backups can be downloaded
529
+ * - **Restore Support**: Future support for encrypted backup restoration
530
+ *
531
+ * **Progress Monitoring:**
532
+ * Use the returned operation_id to connect to the SSE stream:
533
+ * ```javascript
534
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
535
+ * eventSource.addEventListener('operation_progress', (event) => {
536
+ * const data = JSON.parse(event.data);
537
+ * console.log('Backup progress:', data.progress_percent + '%');
538
+ * });
539
+ * ```
540
+ *
541
+ * **SSE Connection Limits:**
542
+ * - Maximum 5 concurrent SSE connections per user
543
+ * - Rate limited to 10 new connections per minute
544
+ * - Automatic circuit breaker for Redis failures
545
+ * - Graceful degradation if event system unavailable
546
+ *
547
+ * **Important Notes:**
548
+ * - Only full_dump format is supported (no CSV/JSON exports)
549
+ * - Compression is always enabled
550
+ * - Encrypted backups cannot be downloaded (security measure)
551
+ * - All backups are stored securely in cloud storage
552
+ *
553
+ * **Credit Consumption:**
554
+ * - Base cost: 25.0 credits
555
+ * - Large databases (>10GB): 50.0 credits
556
+ * - Multiplied by graph tier
557
+ *
558
+ * Returns operation details for SSE monitoring.
559
+ */
560
+ export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => import("./client").RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError, "fields">;
561
+ /**
562
+ * Export Kuzu backup for download
563
+ * Export a backup file for download (only available for non-encrypted, compressed .kuzu backups)
564
+ */
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">;
571
+ /**
572
+ * Restore Encrypted Backup
573
+ * Restore a graph database from an encrypted backup.
574
+ *
575
+ * Restores a complete Kuzu database from an encrypted backup:
576
+ * - **Format**: Only full_dump backups can be restored
577
+ * - **Encryption**: Only encrypted backups can be restored (security requirement)
578
+ * - **System Backup**: Creates automatic backup of existing database before restore
579
+ * - **Verification**: Optionally verifies database integrity after restore
580
+ *
581
+ * **Restore Features:**
582
+ * - **Atomic Operation**: Complete replacement of database
583
+ * - **Rollback Protection**: System backup created before restore
584
+ * - **Data Integrity**: Verification ensures successful restore
585
+ * - **Security**: Only encrypted backups to prevent data tampering
586
+ *
587
+ * **Progress Monitoring:**
588
+ * Use the returned operation_id to connect to the SSE stream:
589
+ * ```javascript
590
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
591
+ * eventSource.addEventListener('operation_progress', (event) => {
592
+ * const data = JSON.parse(event.data);
593
+ * console.log('Restore progress:', data.message);
594
+ * });
595
+ * ```
596
+ *
597
+ * **SSE Connection Limits:**
598
+ * - Maximum 5 concurrent SSE connections per user
599
+ * - Rate limited to 10 new connections per minute
600
+ * - Automatic circuit breaker for Redis failures
601
+ * - Graceful degradation if event system unavailable
602
+ *
603
+ * **Important Notes:**
604
+ * - Only encrypted backups can be restored (security measure)
605
+ * - Existing database is backed up to S3 before restore
606
+ * - Restore is a destructive operation - existing data is replaced
607
+ * - System backups are stored separately for recovery
608
+ *
609
+ * **Credit Consumption:**
610
+ * - Base cost: 100.0 credits
611
+ * - Large databases (>10GB): 200.0 credits
612
+ * - Multiplied by graph tier
613
+ *
614
+ * Returns operation details for SSE monitoring.
615
+ */
616
+ export declare const restoreBackup: <ThrowOnError extends boolean = false>(options: Options<RestoreBackupData, ThrowOnError>) => import("./client").RequestResult<RestoreBackupResponses, RestoreBackupErrors, ThrowOnError, "fields">;
617
+ /**
618
+ * Get backup statistics
619
+ * Get comprehensive backup statistics for the specified graph database
620
+ */
621
+ export declare const getBackupStats: <ThrowOnError extends boolean = false>(options: Options<GetBackupStatsData, ThrowOnError>) => import("./client").RequestResult<GetBackupStatsResponses, GetBackupStatsErrors, ThrowOnError, "fields">;
622
+ /**
623
+ * Get Graph Metrics
624
+ * Get comprehensive metrics for the graph database.
625
+ *
626
+ * Provides detailed analytics including:
627
+ * - **Node Statistics**: Counts by type (Entity, Report, Account, Transaction)
628
+ * - **Relationship Metrics**: Connection counts and patterns
629
+ * - **Data Quality**: Completeness scores and validation results
630
+ * - **Performance Metrics**: Query response times and database health
631
+ * - **Storage Analytics**: Database size and growth trends
632
+ *
633
+ * This data helps with:
634
+ * - Monitoring data completeness
635
+ * - Identifying data quality issues
636
+ * - Capacity planning
637
+ * - Performance optimization
638
+ *
639
+ * Note:
640
+ * This operation is FREE - no credit consumption required.
641
+ */
642
+ export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
643
+ /**
644
+ * Get Usage Statistics
645
+ * Get detailed usage statistics for the graph.
646
+ *
647
+ * Provides temporal usage patterns including:
648
+ * - **Query Volume**: API calls per day/hour
649
+ * - **Credit Consumption**: Usage patterns and trends
650
+ * - **Operation Breakdown**: Usage by operation type
651
+ * - **User Activity**: Access patterns by user role
652
+ * - **Peak Usage Times**: Identify high-activity periods
653
+ *
654
+ * Time ranges available:
655
+ * - Last 24 hours (hourly breakdown)
656
+ * - Last 7 days (daily breakdown)
657
+ * - Last 30 days (daily breakdown)
658
+ * - Custom date ranges
659
+ *
660
+ * Useful for:
661
+ * - Capacity planning
662
+ * - Cost optimization
663
+ * - Usage trend analysis
664
+ * - Performance tuning
665
+ *
666
+ * Note:
667
+ * This operation is FREE - no credit consumption required.
668
+ */
669
+ export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageStatsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ThrowOnError, "fields">;
670
+ /**
671
+ * Execute Cypher Query
672
+ * Execute a Cypher query with intelligent response optimization.
673
+ *
674
+ * This endpoint automatically selects the best execution strategy based on:
675
+ * - Query characteristics (size, complexity)
676
+ * - Client capabilities (SSE, NDJSON, JSON)
677
+ * - System load (queue status, concurrent queries)
678
+ * - User preferences (mode parameter, headers)
679
+ *
680
+ * **Response Modes:**
681
+ * - `auto` (default): Intelligent automatic selection
682
+ * - `sync`: Force synchronous JSON response (best for testing)
683
+ * - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
684
+ * - `stream`: Force streaming response (SSE or NDJSON)
685
+ *
686
+ * **Client Detection:**
687
+ * - Automatically detects testing tools (Postman, Swagger UI)
688
+ * - Adjusts behavior for better interactive experience
689
+ * - Respects Accept and Prefer headers for capabilities
690
+ *
691
+ * **Streaming Support (SSE):**
692
+ * - Real-time events with progress updates
693
+ * - Maximum 5 concurrent SSE connections per user
694
+ * - Rate limited to 10 new connections per minute
695
+ * - Automatic circuit breaker for Redis failures
696
+ * - Graceful degradation if event system unavailable
697
+ * - 30-second keepalive to prevent timeouts
698
+ *
699
+ * **Streaming Support (NDJSON):**
700
+ * - Efficient line-delimited JSON for large results
701
+ * - Automatic chunking (configurable 10-10000 rows)
702
+ * - No connection limits (stateless streaming)
703
+ *
704
+ * **Queue Management:**
705
+ * - Automatic queuing under high load
706
+ * - Real-time monitoring via SSE events (no polling needed)
707
+ * - Priority based on subscription tier
708
+ * - Queue position and progress updates pushed via SSE
709
+ * - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
710
+ *
711
+ * **Error Handling:**
712
+ * - `429 Too Many Requests`: Rate limit or connection limit exceeded
713
+ * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
714
+ * - Clients should implement exponential backoff
715
+ *
716
+ * **Note:**
717
+ * Query operations are FREE - no credit consumption required.
718
+ * Queue position is based on subscription tier for priority.
719
+ */
720
+ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => import("./client").RequestResult<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError, "fields">;
721
+ /**
722
+ * Get Runtime Graph Schema Information
723
+ * Get runtime schema information for the specified graph database.
724
+ *
725
+ * This endpoint inspects the actual graph database structure and returns:
726
+ * - **Node Labels**: All node types currently in the database
727
+ * - **Relationship Types**: All relationship types currently in the database
728
+ * - **Node Properties**: Properties for each node type (limited to first 10 for performance)
729
+ *
730
+ * This is different from custom schema management - it shows what actually exists in the database,
731
+ * useful for understanding the current graph structure before writing queries.
732
+ *
733
+ * This operation is FREE - no credit consumption required.
734
+ */
735
+ export declare const getGraphSchemaInfo: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaInfoData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ThrowOnError, "fields">;
736
+ /**
737
+ * Validate Schema
738
+ * Validate a custom schema definition before deployment.
739
+ *
740
+ * This endpoint performs comprehensive validation including:
741
+ * - **Structure Validation**: Ensures proper JSON/YAML format
742
+ * - **Type Checking**: Validates data types (STRING, INT, DOUBLE, etc.)
743
+ * - **Constraint Verification**: Checks primary keys and unique constraints
744
+ * - **Relationship Integrity**: Validates node references in relationships
745
+ * - **Naming Conventions**: Ensures valid identifiers
746
+ * - **Compatibility**: Checks against existing extensions if specified
747
+ *
748
+ * Supported formats:
749
+ * - JSON schema definitions
750
+ * - YAML schema definitions
751
+ * - Direct dictionary format
752
+ *
753
+ * Validation helps prevent:
754
+ * - Schema deployment failures
755
+ * - Data integrity issues
756
+ * - Performance problems
757
+ * - Naming conflicts
758
+ *
759
+ * This operation is FREE - no credit consumption required.
760
+ */
761
+ export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
762
+ /**
763
+ * Export Graph Schema
764
+ * Export the schema of an existing graph in JSON, YAML, or Cypher format
765
+ */
766
+ export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(options: Options<ExportGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<ExportGraphSchemaResponses, ExportGraphSchemaErrors, ThrowOnError, "fields">;
767
+ /**
768
+ * List Available Schema Extensions
769
+ * Get list of available schema extensions and compatibility groups
770
+ */
771
+ export declare const listSchemaExtensions: <ThrowOnError extends boolean = false>(options: Options<ListSchemaExtensionsData, ThrowOnError>) => import("./client").RequestResult<ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, ThrowOnError, "fields">;
772
+ /**
773
+ * Get Current Bill
774
+ * Get current month's billing details for the graph.
775
+ *
776
+ * Returns comprehensive billing information including:
777
+ * - **Credit Usage**: Consumed vs. allocated credits
778
+ * - **Storage Charges**: Current storage usage and costs
779
+ * - **Subscription Tier**: Current plan and features
780
+ * - **Pro-rated Charges**: If plan changed mid-month
781
+ * - **Estimated Total**: Current charges to date
782
+ *
783
+ * Billing calculations are updated hourly. Storage is measured in GB-months.
784
+ *
785
+ * ℹ️ No credits are consumed for viewing billing information.
786
+ */
787
+ export declare const getCurrentGraphBill: <ThrowOnError extends boolean = false>(options: Options<GetCurrentGraphBillData, ThrowOnError>) => import("./client").RequestResult<GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, ThrowOnError, "fields">;
788
+ /**
789
+ * Get Usage Details
790
+ * Get detailed usage metrics for the graph.
791
+ *
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
798
+ *
799
+ * Useful for:
800
+ * - Optimizing credit consumption
801
+ * - Capacity planning
802
+ * - Usage trend analysis
803
+ * - Cost optimization
804
+ *
805
+ * ℹ️ No credits are consumed for viewing usage details.
806
+ */
807
+ export declare const getGraphUsageDetails: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageDetailsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, ThrowOnError, "fields">;
808
+ /**
809
+ * Get Billing History
810
+ * Get billing history for the graph.
811
+ *
812
+ * Returns a chronological list of monthly bills, perfect for:
813
+ * - Tracking spending trends over time
814
+ * - Identifying usage patterns
815
+ * - Budget forecasting
816
+ * - Financial reporting
817
+ *
818
+ * Each month includes:
819
+ * - Credit usage and overages
820
+ * - Storage charges
821
+ * - Total charges
822
+ * - Usage metrics
823
+ *
824
+ * ℹ️ No credits are consumed for viewing billing history.
825
+ */
826
+ export declare const getGraphBillingHistory: <ThrowOnError extends boolean = false>(options: Options<GetGraphBillingHistoryData, ThrowOnError>) => import("./client").RequestResult<GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, ThrowOnError, "fields">;
827
+ /**
828
+ * Get Monthly Bill
829
+ * Get billing details for a specific month.
830
+ *
831
+ * Retrieve historical billing information for any previous month.
832
+ * Useful for:
833
+ * - Reconciling past charges
834
+ * - Tracking usage trends
835
+ * - Expense reporting
836
+ * - Budget analysis
837
+ *
838
+ * Returns the same detailed breakdown as the current bill endpoint.
839
+ *
840
+ * ℹ️ No credits are consumed for viewing billing history.
841
+ */
842
+ export declare const getGraphMonthlyBill: <ThrowOnError extends boolean = false>(options: Options<GetGraphMonthlyBillData, ThrowOnError>) => import("./client").RequestResult<GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, ThrowOnError, "fields">;
843
+ /**
844
+ * Get Credit Summary
845
+ * Retrieve comprehensive credit usage summary for the specified graph.
846
+ *
847
+ * This endpoint provides:
848
+ * - Current credit balance and monthly allocation
849
+ * - Credit consumption metrics for the current month
850
+ * - Graph tier and credit multiplier information
851
+ * - Usage percentage to help monitor credit consumption
852
+ *
853
+ * No credits are consumed for checking credit status.
854
+ */
855
+ export declare const getCreditSummary: <ThrowOnError extends boolean = false>(options: Options<GetCreditSummaryData, ThrowOnError>) => import("./client").RequestResult<GetCreditSummaryResponses, GetCreditSummaryErrors, ThrowOnError, "fields">;
856
+ /**
857
+ * List Credit Transactions
858
+ * Retrieve detailed credit transaction history for the specified graph.
859
+ *
860
+ * This enhanced endpoint provides:
861
+ * - Detailed transaction records with idempotency information
862
+ * - Summary by operation type to identify high-consumption operations
863
+ * - Date range filtering for analysis
864
+ * - Metadata search capabilities
865
+ *
866
+ * Transaction types include:
867
+ * - ALLOCATION: Monthly credit allocations
868
+ * - CONSUMPTION: Credit usage for operations
869
+ * - BONUS: Bonus credits added by admins
870
+ * - REFUND: Credit refunds
871
+ *
872
+ * No credits are consumed for viewing transaction history.
873
+ */
874
+ export declare const listCreditTransactions: <ThrowOnError extends boolean = false>(options: Options<ListCreditTransactionsData, ThrowOnError>) => import("./client").RequestResult<ListCreditTransactionsResponses, ListCreditTransactionsErrors, ThrowOnError, "fields">;
875
+ /**
876
+ * Check Credit Balance
877
+ * Check if the graph has sufficient credits for a planned operation.
878
+ *
879
+ * This endpoint allows you to verify credit availability before performing
880
+ * an operation, helping prevent failed operations due to insufficient credits.
881
+ *
882
+ * The check considers:
883
+ * - Base operation cost
884
+ * - Graph tier multiplier
885
+ * - Current credit balance
886
+ *
887
+ * No credits are consumed for checking availability.
888
+ */
889
+ export declare const checkCreditBalance: <ThrowOnError extends boolean = false>(options: Options<CheckCreditBalanceData, ThrowOnError>) => import("./client").RequestResult<CheckCreditBalanceResponses, CheckCreditBalanceErrors, ThrowOnError, "fields">;
890
+ /**
891
+ * Get Storage Usage
892
+ * Get storage usage history for a graph.
893
+ *
894
+ * Returns detailed storage usage information including:
895
+ * - Daily average storage consumption
896
+ * - Storage trends over time
897
+ * - Credit costs for storage
898
+ * - Current storage billing information
899
+ *
900
+ * This endpoint helps users understand their storage patterns
901
+ * and associated credit costs.
902
+ */
903
+ export declare const getStorageUsage: <ThrowOnError extends boolean = false>(options: Options<GetStorageUsageData, ThrowOnError>) => import("./client").RequestResult<GetStorageUsageResponses, GetStorageUsageErrors, ThrowOnError, "fields">;
904
+ /**
905
+ * Check Storage Limits
906
+ * Check storage limits and usage for a graph.
907
+ *
908
+ * Returns comprehensive storage limit information including:
909
+ * - Current storage usage
910
+ * - Effective limit (override or default)
911
+ * - Usage percentage and warnings
912
+ * - Recommendations for limit management
913
+ *
914
+ * This endpoint helps users monitor storage usage and plan for potential
915
+ * limit increases. No credits are consumed for checking storage limits.
916
+ */
917
+ export declare const checkStorageLimits: <ThrowOnError extends boolean = false>(options: Options<CheckStorageLimitsData, ThrowOnError>) => import("./client").RequestResult<CheckStorageLimitsResponses, CheckStorageLimitsErrors, ThrowOnError, "fields">;
918
+ /**
919
+ * Database Health Check
920
+ * Get comprehensive health information for the graph database.
921
+ *
922
+ * Returns detailed health metrics including:
923
+ * - **Connection Status**: Database connectivity and responsiveness
924
+ * - **Performance Metrics**: Query execution times and throughput
925
+ * - **Resource Usage**: Memory and storage utilization
926
+ * - **Error Monitoring**: Recent error rates and patterns
927
+ * - **Uptime Statistics**: Service availability metrics
928
+ *
929
+ * Health indicators:
930
+ * - **Status**: healthy, degraded, or unhealthy
931
+ * - **Query Performance**: Average execution times
932
+ * - **Error Rates**: Recent failure percentages
933
+ * - **Resource Usage**: Memory and storage consumption
934
+ * - **Alerts**: Active warnings or issues
935
+ *
936
+ * This endpoint provides essential monitoring data for operational visibility.
937
+ */
938
+ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
939
+ /**
940
+ * Database Information
941
+ * Get comprehensive database information and statistics.
942
+ *
943
+ * Returns detailed database metrics including:
944
+ * - **Database Metadata**: Name, path, size, and timestamps
945
+ * - **Schema Information**: Node labels, relationship types, and counts
946
+ * - **Storage Statistics**: Database size and usage metrics
947
+ * - **Data Composition**: Node and relationship counts
948
+ * - **Backup Information**: Available backups and last backup date
949
+ * - **Configuration**: Read-only status and schema version
950
+ *
951
+ * Database statistics:
952
+ * - **Size**: Storage usage in bytes and MB
953
+ * - **Content**: Node and relationship counts
954
+ * - **Schema**: Available labels and relationship types
955
+ * - **Backup Status**: Backup availability and recency
956
+ * - **Timestamps**: Creation and modification dates
957
+ *
958
+ * This endpoint provides essential database information for capacity planning and monitoring.
959
+ */
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">;
978
+ /**
979
+ * List Subgraphs
980
+ * List all subgraphs for a parent graph.
981
+ *
982
+ * **Requirements:**
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
986
+ *
987
+ * **Returns:**
988
+ * - List of all subgraphs for the parent graph
989
+ * - Each subgraph includes its ID, name, description, type, status, and creation date
990
+ */
991
+ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => import("./client").RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError, "fields">;
992
+ /**
993
+ * Create Subgraph
994
+ * Create a new subgraph within a parent graph.
995
+ *
996
+ * **Requirements:**
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
1003
+ *
1004
+ * **Returns:**
1005
+ * - Created subgraph details including its unique ID
1006
+ */
1007
+ export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
1008
+ /**
1009
+ * Delete Subgraph
1010
+ * Delete a subgraph database.
1011
+ *
1012
+ * **Requirements:**
1013
+ * - Must be a valid subgraph (not parent graph)
1014
+ * - User must have admin access to parent graph
1015
+ * - Optional backup before deletion
1016
+ *
1017
+ * **Deletion Options:**
1018
+ * - `force`: Delete even if contains data
1019
+ * - `backup_first`: Create backup before deletion
1020
+ *
1021
+ * **Warning:**
1022
+ * Deletion is permanent unless backup is created.
1023
+ * All data in the subgraph will be lost.
1024
+ *
1025
+ * **Backup Location:**
1026
+ * If backup requested, stored in S3 at:
1027
+ * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
1028
+ */
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">;
1053
+ /**
1054
+ * Get Subgraph Quota
1055
+ * Get subgraph quota and usage information for a parent graph.
1056
+ *
1057
+ * **Shows:**
1058
+ * - Current subgraph count
1059
+ * - Maximum allowed subgraphs per tier
1060
+ * - Remaining capacity
1061
+ * - Total size usage across all subgraphs
1062
+ *
1063
+ * **Tier Limits:**
1064
+ * - Standard: 0 subgraphs (not supported)
1065
+ * - Enterprise: Configurable limit (default: 10 subgraphs)
1066
+ * - Premium: Unlimited subgraphs
1067
+ * - Limits are defined in deployment configuration
1068
+ *
1069
+ * **Size Tracking:**
1070
+ * Provides aggregate size metrics when available.
1071
+ * Individual subgraph sizes shown in list endpoint.
1072
+ */
1073
+ export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
1074
+ /**
1075
+ * Copy Data to Graph
1076
+ * Copy data from external sources into the graph database.
1077
+ *
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
1082
+ *
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
1088
+ *
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
1098
+ */
1099
+ export declare const copyDataToGraph: <ThrowOnError extends boolean = false>(options: Options<CopyDataToGraphData, ThrowOnError>) => import("./client").RequestResult<CopyDataToGraphResponses, CopyDataToGraphErrors, ThrowOnError, "fields">;
1100
+ /**
1101
+ * Create New Graph Database
1102
+ * Create a new graph database with specified schema and optionally an initial entity.
1103
+ *
1104
+ * This endpoint starts an asynchronous graph creation operation and returns
1105
+ * connection details for monitoring progress via Server-Sent Events (SSE).
1106
+ *
1107
+ * **Operation Types:**
1108
+ * - **Generic Graph**: Creates empty graph with schema extensions
1109
+ * - **Entity Graph**: Creates graph with initial entity data
1110
+ *
1111
+ * **Monitoring Progress:**
1112
+ * Use the returned `operation_id` to connect to the SSE stream:
1113
+ * ```javascript
1114
+ * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
1115
+ * eventSource.onmessage = (event) => {
1116
+ * const data = JSON.parse(event.data);
1117
+ * console.log('Progress:', data.progress_percent + '%');
1118
+ * };
1119
+ * ```
1120
+ *
1121
+ * **SSE Connection Limits:**
1122
+ * - Maximum 5 concurrent SSE connections per user
1123
+ * - Rate limited to 10 new connections per minute
1124
+ * - Automatic circuit breaker for Redis failures
1125
+ * - Graceful degradation if event system unavailable
1126
+ *
1127
+ * **Events Emitted:**
1128
+ * - `operation_started`: Graph creation begins
1129
+ * - `operation_progress`: Schema loading, database setup, etc.
1130
+ * - `operation_completed`: Graph ready with connection details
1131
+ * - `operation_error`: Creation failed with error details
1132
+ *
1133
+ * **Error Handling:**
1134
+ * - `429 Too Many Requests`: SSE connection limit exceeded
1135
+ * - `503 Service Unavailable`: SSE system temporarily disabled
1136
+ * - Clients should implement exponential backoff on errors
1137
+ *
1138
+ * **Response includes:**
1139
+ * - `operation_id`: Unique identifier for monitoring
1140
+ * - `_links.stream`: SSE endpoint for real-time updates
1141
+ * - `_links.status`: Point-in-time status check endpoint
1142
+ */
1143
+ export declare const createGraph: <ThrowOnError extends boolean = false>(options: Options<CreateGraphData, ThrowOnError>) => import("./client").RequestResult<CreateGraphResponses, CreateGraphErrors, ThrowOnError, "fields">;
1144
+ /**
1145
+ * Get Available Schema Extensions
1146
+ * List all available schema extensions for graph creation
1147
+ */
1148
+ export declare const getAvailableExtensions: <ThrowOnError extends boolean = false>(options?: Options<GetAvailableExtensionsData, ThrowOnError>) => import("./client").RequestResult<GetAvailableExtensionsResponses, unknown, ThrowOnError, "fields">;
1149
+ /**
1150
+ * Get Service Offerings
1151
+ * Get comprehensive information about all subscription offerings.
1152
+ *
1153
+ * This endpoint provides complete information about both graph database subscriptions
1154
+ * and shared repository subscriptions. This is the primary endpoint for frontend
1155
+ * applications to display subscription options.
1156
+ *
1157
+ * Includes:
1158
+ * - Graph subscription tiers (standard, enterprise, premium)
1159
+ * - Shared repository subscriptions (SEC, industry, economic data)
1160
+ * - Operation costs and credit information
1161
+ * - Features and capabilities for each tier
1162
+ * - Enabled/disabled status for repositories
1163
+ *
1164
+ * All data comes from the config-based systems to ensure accuracy with backend behavior.
1165
+ *
1166
+ * No authentication required - this is public service information.
1167
+ */
1168
+ export declare const getServiceOfferings: <ThrowOnError extends boolean = false>(options?: Options<GetServiceOfferingsData, ThrowOnError>) => import("./client").RequestResult<GetServiceOfferingsResponses, GetServiceOfferingsErrors, ThrowOnError, "fields">;
1169
+ /**
1170
+ * Stream Operation Events
1171
+ * Stream real-time events for an operation using Server-Sent Events (SSE).
1172
+ *
1173
+ * This endpoint provides real-time monitoring for all non-immediate operations including:
1174
+ * - Graph creation and management
1175
+ * - Agent analysis processing
1176
+ * - Database backups and restores
1177
+ * - Data synchronization tasks
1178
+ *
1179
+ * **Event Types:**
1180
+ * - `operation_started`: Operation began execution
1181
+ * - `operation_progress`: Progress update with details
1182
+ * - `operation_completed`: Operation finished successfully
1183
+ * - `operation_error`: Operation failed with error details
1184
+ * - `operation_cancelled`: Operation was cancelled
1185
+ *
1186
+ * **Features:**
1187
+ * - **Event Replay**: Use `from_sequence` parameter to replay missed events
1188
+ * - **Automatic Reconnection**: Client can reconnect and resume from last seen event
1189
+ * - **Real-time Updates**: Live progress updates during execution
1190
+ * - **Timeout Handling**: 30-second keepalive messages prevent connection timeouts
1191
+ * - **Graceful Degradation**: Automatic fallback if Redis is unavailable
1192
+ *
1193
+ * **Connection Limits:**
1194
+ * - Maximum 5 concurrent SSE connections per user
1195
+ * - Rate limited to 10 new connections per minute
1196
+ * - Automatic cleanup of stale connections
1197
+ * - Circuit breaker protection for Redis failures
1198
+ *
1199
+ * **Client Usage:**
1200
+ * ```javascript
1201
+ * const eventSource = new EventSource('/v1/operations/abc123/stream');
1202
+ * eventSource.onmessage = (event) => {
1203
+ * const data = JSON.parse(event.data);
1204
+ * console.log('Progress:', data);
1205
+ * };
1206
+ * eventSource.onerror = (error) => {
1207
+ * // Handle connection errors or rate limits
1208
+ * console.error('SSE Error:', error);
1209
+ * };
1210
+ * ```
1211
+ *
1212
+ * **Error Handling:**
1213
+ * - `429 Too Many Requests`: Connection limit or rate limit exceeded
1214
+ * - `503 Service Unavailable`: SSE system temporarily disabled
1215
+ * - Clients should implement exponential backoff on errors
1216
+ *
1217
+ * **No credits are consumed for SSE connections.**
1218
+ */
1219
+ export declare const streamOperationEvents: <ThrowOnError extends boolean = false>(options: Options<StreamOperationEventsData, ThrowOnError>) => import("./client").RequestResult<StreamOperationEventsResponses, StreamOperationEventsErrors, ThrowOnError, "fields">;
1220
+ /**
1221
+ * Get Operation Status
1222
+ * Get current status and metadata for an operation.
1223
+ *
1224
+ * Returns detailed information including:
1225
+ * - Current status (pending, running, completed, failed, cancelled)
1226
+ * - Creation and update timestamps
1227
+ * - Operation type and associated graph
1228
+ * - Result data (for completed operations)
1229
+ * - Error details (for failed operations)
1230
+ *
1231
+ * This endpoint provides a point-in-time status check, while the `/stream` endpoint
1232
+ * provides real-time updates. Use this for polling or initial status checks.
1233
+ *
1234
+ * **No credits are consumed for status checks.**
1235
+ */
1236
+ export declare const getOperationStatus: <ThrowOnError extends boolean = false>(options: Options<GetOperationStatusData, ThrowOnError>) => import("./client").RequestResult<GetOperationStatusResponses, GetOperationStatusErrors, ThrowOnError, "fields">;
1237
+ /**
1238
+ * Cancel Operation
1239
+ * Cancel a pending or running operation.
1240
+ *
1241
+ * Cancels the specified operation if it's still in progress. Once cancelled,
1242
+ * the operation cannot be resumed and will emit a cancellation event to any
1243
+ * active SSE connections.
1244
+ *
1245
+ * **Note**: Completed or already failed operations cannot be cancelled.
1246
+ *
1247
+ * **No credits are consumed for cancellation requests.**
1248
+ */
1249
+ export declare const cancelOperation: <ThrowOnError extends boolean = false>(options: Options<CancelOperationData, ThrowOnError>) => import("./client").RequestResult<CancelOperationResponses, CancelOperationErrors, ThrowOnError, "fields">;