@robosystems/client 0.1.10 → 0.1.12

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