@robosystems/client 0.2.31 → 0.2.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/sdk.gen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CheckCreditBalanceData, CheckCreditBalanceErrors, CheckCreditBalanceResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CheckStorageLimitsData, CheckStorageLimitsErrors, CheckStorageLimitsResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreateOrgData, CreateOrgErrors, CreateOrgResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetMaterializationStatusData, GetMaterializationStatusErrors, GetMaterializationStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetStorageUsageData, GetStorageUsageErrors, GetStorageUsageResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, MaterializeGraphData, MaterializeGraphErrors, MaterializeGraphResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UpgradeSubscriptionData, UpgradeSubscriptionErrors, UpgradeSubscriptionResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
2
+ import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CheckCreditBalanceData, CheckCreditBalanceErrors, CheckCreditBalanceResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CheckStorageLimitsData, CheckStorageLimitsErrors, CheckStorageLimitsResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetMaterializationStatusData, GetMaterializationStatusErrors, GetMaterializationStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetStorageUsageData, GetStorageUsageErrors, GetStorageUsageResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, MaterializeGraphData, MaterializeGraphErrors, MaterializeGraphResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UpgradeSubscriptionData, UpgradeSubscriptionErrors, UpgradeSubscriptionResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -167,12 +167,6 @@ export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(op
167
167
  * Get all organizations the current user belongs to, with their role in each.
168
168
  */
169
169
  export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => import("./client").RequestResult<ListUserOrgsResponses, unknown, ThrowOnError, "fields">;
170
- /**
171
- * Create Organization
172
- *
173
- * Create a new organization. The creating user becomes the owner.
174
- */
175
- export declare const createOrg: <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => import("./client").RequestResult<CreateOrgResponses, CreateOrgErrors, ThrowOnError, "fields">;
176
170
  /**
177
171
  * Get Organization
178
172
  *
@@ -230,6 +224,170 @@ export declare const getOrgLimits: <ThrowOnError extends boolean = false>(option
230
224
  * Get detailed usage statistics for an organization aggregated across all graphs.
231
225
  */
232
226
  export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => import("./client").RequestResult<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError, "fields">;
227
+ /**
228
+ * List Connections
229
+ *
230
+ * List all data connections in the graph.
231
+ *
232
+ * Returns active and inactive connections with their current status.
233
+ * Connections can be filtered by:
234
+ * - **Entity**: Show connections for a specific entity
235
+ * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
236
+ *
237
+ * Each connection shows:
238
+ * - Current sync status and health
239
+ * - Last successful sync timestamp
240
+ * - Configuration metadata
241
+ * - Error messages if any
242
+ *
243
+ * No credits are consumed for listing connections.
244
+ */
245
+ export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
246
+ /**
247
+ * Create Connection
248
+ *
249
+ * Create a new data connection for external system integration.
250
+ *
251
+ * This endpoint initiates connections to external data sources:
252
+ *
253
+ * **SEC Connections**:
254
+ * - Provide entity CIK for automatic filing retrieval
255
+ * - No authentication needed
256
+ * - Begins immediate data sync
257
+ *
258
+ * **QuickBooks Connections**:
259
+ * - Returns OAuth URL for authorization
260
+ * - Requires admin permissions in QuickBooks
261
+ * - Complete with OAuth callback
262
+ *
263
+ * **Plaid Connections**:
264
+ * - Returns Plaid Link token
265
+ * - User completes bank authentication
266
+ * - Exchange public token for access
267
+ *
268
+ * Note:
269
+ * This operation is included - no credit consumption required.
270
+ */
271
+ export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
272
+ /**
273
+ * List Connection Options
274
+ *
275
+ * Get metadata about all available data connection providers.
276
+ *
277
+ * This endpoint returns comprehensive information about each supported provider:
278
+ *
279
+ * **SEC EDGAR**: Public entity financial filings
280
+ * - No authentication required (public data)
281
+ * - 10-K, 10-Q, 8-K reports with XBRL data
282
+ * - Historical and real-time filing access
283
+ *
284
+ * **QuickBooks Online**: Full accounting system integration
285
+ * - OAuth 2.0 authentication
286
+ * - Chart of accounts, transactions, trial balance
287
+ * - Real-time sync capabilities
288
+ *
289
+ * **Plaid**: Bank account connections
290
+ * - Secure bank authentication via Plaid Link
291
+ * - Transaction history and balances
292
+ * - Multi-account support
293
+ *
294
+ * No credits are consumed for viewing connection options.
295
+ */
296
+ export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => import("./client").RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError, "fields">;
297
+ /**
298
+ * Init Oauth
299
+ *
300
+ * Initialize OAuth flow for a connection.
301
+ *
302
+ * This generates an authorization URL that the frontend should redirect the user to.
303
+ * Currently supports: QuickBooks
304
+ */
305
+ export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => import("./client").RequestResult<InitOAuthResponses, InitOAuthErrors, ThrowOnError, "fields">;
306
+ /**
307
+ * OAuth Callback
308
+ *
309
+ * Handle OAuth callback from provider after user authorization.
310
+ *
311
+ * This endpoint completes the OAuth flow:
312
+ * 1. Validates the OAuth state parameter
313
+ * 2. Exchanges authorization code for access tokens
314
+ * 3. Stores tokens securely
315
+ * 4. Updates connection status
316
+ * 5. Optionally triggers initial sync
317
+ *
318
+ * Supported providers:
319
+ * - **QuickBooks**: Accounting data integration
320
+ *
321
+ * Security measures:
322
+ * - State validation prevents session hijacking
323
+ * - User context is verified
324
+ * - Tokens are encrypted before storage
325
+ * - Full audit trail is maintained
326
+ *
327
+ * No credits are consumed for OAuth callbacks.
328
+ */
329
+ export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => import("./client").RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError, "fields">;
330
+ /**
331
+ * Delete Connection
332
+ *
333
+ * Delete a data connection and clean up related resources.
334
+ *
335
+ * This operation:
336
+ * - Removes the connection configuration
337
+ * - Preserves any imported data in the graph
338
+ * - Performs provider-specific cleanup
339
+ * - Revokes stored credentials
340
+ *
341
+ * Note:
342
+ * This operation is included - no credit consumption required.
343
+ *
344
+ * Only users with admin role can delete connections.
345
+ */
346
+ export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
347
+ /**
348
+ * Get Connection
349
+ *
350
+ * Get detailed information about a specific connection.
351
+ *
352
+ * Returns comprehensive connection details including:
353
+ * - Current status and health indicators
354
+ * - Authentication state
355
+ * - Sync history and statistics
356
+ * - Error details if any
357
+ * - Provider-specific metadata
358
+ *
359
+ * No credits are consumed for viewing connection details.
360
+ */
361
+ export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
362
+ /**
363
+ * Sync Connection
364
+ *
365
+ * Trigger a data synchronization for the connection.
366
+ *
367
+ * Initiates data sync based on provider type:
368
+ *
369
+ * **SEC Sync**:
370
+ * - Downloads latest filings from EDGAR
371
+ * - Parses XBRL data and updates graph
372
+ * - Typically completes in 5-10 minutes
373
+ *
374
+ * **QuickBooks Sync**:
375
+ * - Fetches latest transactions and balances
376
+ * - Updates chart of accounts
377
+ * - Generates fresh trial balance
378
+ * - Duration depends on data volume
379
+ *
380
+ * **Plaid Sync**:
381
+ * - Retrieves recent bank transactions
382
+ * - Updates account balances
383
+ * - Categorizes new transactions
384
+ *
385
+ * Note:
386
+ * This operation is included - no credit consumption required.
387
+ *
388
+ * Returns a task ID for monitoring sync progress.
389
+ */
390
+ export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
233
391
  /**
234
392
  * List available agents
235
393
  *
@@ -1149,10 +1307,10 @@ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(opt
1149
1307
  * - Total size usage across all subgraphs
1150
1308
  *
1151
1309
  * **Tier Limits:**
1152
- * - Standard: 0 subgraphs (not supported)
1153
- * - Enterprise: Configurable limit (default: 10 subgraphs)
1154
- * - Premium: Unlimited subgraphs
1155
- * - Limits are defined in deployment configuration
1310
+ * - Standard: Up to 3 subgraphs (dedicated m7g.large instance)
1311
+ * - Large: Up to 10 subgraphs (dedicated r7g.large instance)
1312
+ * - XLarge: Up to 25 subgraphs (dedicated r7g.xlarge instance)
1313
+ * - Limits are defined in graph.yml deployment configuration
1156
1314
  *
1157
1315
  * **Size Tracking:**
1158
1316
  * Provides aggregate size metrics when available.
package/sdk.gen.js CHANGED
@@ -1,8 +1,9 @@
1
1
  "use strict";
2
2
  // This file is auto-generated by @hey-api/openapi-ts
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.getOrgUsage = exports.getOrgLimits = exports.updateOrgMemberRole = exports.removeOrgMember = exports.inviteOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.createOrg = exports.listUserOrgs = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
5
- exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.materializeGraph = exports.getMaterializationStatus = exports.queryTables = exports.listTables = exports.upgradeSubscription = exports.createRepositorySubscription = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = void 0;
4
+ exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.getConnectionOptions = exports.createConnection = exports.listConnections = exports.getOrgUsage = exports.getOrgLimits = exports.updateOrgMemberRole = exports.removeOrgMember = exports.inviteOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.listUserOrgs = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
5
+ exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.materializeGraph = exports.getMaterializationStatus = exports.queryTables = exports.listTables = exports.upgradeSubscription = exports.createRepositorySubscription = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = void 0;
6
+ exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = void 0;
6
7
  const client_gen_1 = require("./client.gen");
7
8
  /**
8
9
  * Register New User
@@ -287,21 +288,6 @@ const listUserOrgs = (options) => (options?.client ?? client_gen_1.client).get({
287
288
  ...options
288
289
  });
289
290
  exports.listUserOrgs = listUserOrgs;
290
- /**
291
- * Create Organization
292
- *
293
- * Create a new organization. The creating user becomes the owner.
294
- */
295
- const createOrg = (options) => (options.client ?? client_gen_1.client).post({
296
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
297
- url: '/v1/orgs',
298
- ...options,
299
- headers: {
300
- 'Content-Type': 'application/json',
301
- ...options.headers
302
- }
303
- });
304
- exports.createOrg = createOrg;
305
291
  /**
306
292
  * Get Organization
307
293
  *
@@ -416,6 +402,226 @@ const getOrgUsage = (options) => (options.client ?? client_gen_1.client).get({
416
402
  ...options
417
403
  });
418
404
  exports.getOrgUsage = getOrgUsage;
405
+ /**
406
+ * List Connections
407
+ *
408
+ * List all data connections in the graph.
409
+ *
410
+ * Returns active and inactive connections with their current status.
411
+ * Connections can be filtered by:
412
+ * - **Entity**: Show connections for a specific entity
413
+ * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
414
+ *
415
+ * Each connection shows:
416
+ * - Current sync status and health
417
+ * - Last successful sync timestamp
418
+ * - Configuration metadata
419
+ * - Error messages if any
420
+ *
421
+ * No credits are consumed for listing connections.
422
+ */
423
+ const listConnections = (options) => (options.client ?? client_gen_1.client).get({
424
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
425
+ url: '/v1/graphs/{graph_id}/connections',
426
+ ...options
427
+ });
428
+ exports.listConnections = listConnections;
429
+ /**
430
+ * Create Connection
431
+ *
432
+ * Create a new data connection for external system integration.
433
+ *
434
+ * This endpoint initiates connections to external data sources:
435
+ *
436
+ * **SEC Connections**:
437
+ * - Provide entity CIK for automatic filing retrieval
438
+ * - No authentication needed
439
+ * - Begins immediate data sync
440
+ *
441
+ * **QuickBooks Connections**:
442
+ * - Returns OAuth URL for authorization
443
+ * - Requires admin permissions in QuickBooks
444
+ * - Complete with OAuth callback
445
+ *
446
+ * **Plaid Connections**:
447
+ * - Returns Plaid Link token
448
+ * - User completes bank authentication
449
+ * - Exchange public token for access
450
+ *
451
+ * Note:
452
+ * This operation is included - no credit consumption required.
453
+ */
454
+ const createConnection = (options) => (options.client ?? client_gen_1.client).post({
455
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
456
+ url: '/v1/graphs/{graph_id}/connections',
457
+ ...options,
458
+ headers: {
459
+ 'Content-Type': 'application/json',
460
+ ...options.headers
461
+ }
462
+ });
463
+ exports.createConnection = createConnection;
464
+ /**
465
+ * List Connection Options
466
+ *
467
+ * Get metadata about all available data connection providers.
468
+ *
469
+ * This endpoint returns comprehensive information about each supported provider:
470
+ *
471
+ * **SEC EDGAR**: Public entity financial filings
472
+ * - No authentication required (public data)
473
+ * - 10-K, 10-Q, 8-K reports with XBRL data
474
+ * - Historical and real-time filing access
475
+ *
476
+ * **QuickBooks Online**: Full accounting system integration
477
+ * - OAuth 2.0 authentication
478
+ * - Chart of accounts, transactions, trial balance
479
+ * - Real-time sync capabilities
480
+ *
481
+ * **Plaid**: Bank account connections
482
+ * - Secure bank authentication via Plaid Link
483
+ * - Transaction history and balances
484
+ * - Multi-account support
485
+ *
486
+ * No credits are consumed for viewing connection options.
487
+ */
488
+ const getConnectionOptions = (options) => (options.client ?? client_gen_1.client).get({
489
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
490
+ url: '/v1/graphs/{graph_id}/connections/options',
491
+ ...options
492
+ });
493
+ exports.getConnectionOptions = getConnectionOptions;
494
+ /**
495
+ * Init Oauth
496
+ *
497
+ * Initialize OAuth flow for a connection.
498
+ *
499
+ * This generates an authorization URL that the frontend should redirect the user to.
500
+ * Currently supports: QuickBooks
501
+ */
502
+ const initOAuth = (options) => (options.client ?? client_gen_1.client).post({
503
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
504
+ url: '/v1/graphs/{graph_id}/connections/oauth/init',
505
+ ...options,
506
+ headers: {
507
+ 'Content-Type': 'application/json',
508
+ ...options.headers
509
+ }
510
+ });
511
+ exports.initOAuth = initOAuth;
512
+ /**
513
+ * OAuth Callback
514
+ *
515
+ * Handle OAuth callback from provider after user authorization.
516
+ *
517
+ * This endpoint completes the OAuth flow:
518
+ * 1. Validates the OAuth state parameter
519
+ * 2. Exchanges authorization code for access tokens
520
+ * 3. Stores tokens securely
521
+ * 4. Updates connection status
522
+ * 5. Optionally triggers initial sync
523
+ *
524
+ * Supported providers:
525
+ * - **QuickBooks**: Accounting data integration
526
+ *
527
+ * Security measures:
528
+ * - State validation prevents session hijacking
529
+ * - User context is verified
530
+ * - Tokens are encrypted before storage
531
+ * - Full audit trail is maintained
532
+ *
533
+ * No credits are consumed for OAuth callbacks.
534
+ */
535
+ const oauthCallback = (options) => (options.client ?? client_gen_1.client).post({
536
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
537
+ url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
538
+ ...options,
539
+ headers: {
540
+ 'Content-Type': 'application/json',
541
+ ...options.headers
542
+ }
543
+ });
544
+ exports.oauthCallback = oauthCallback;
545
+ /**
546
+ * Delete Connection
547
+ *
548
+ * Delete a data connection and clean up related resources.
549
+ *
550
+ * This operation:
551
+ * - Removes the connection configuration
552
+ * - Preserves any imported data in the graph
553
+ * - Performs provider-specific cleanup
554
+ * - Revokes stored credentials
555
+ *
556
+ * Note:
557
+ * This operation is included - no credit consumption required.
558
+ *
559
+ * Only users with admin role can delete connections.
560
+ */
561
+ const deleteConnection = (options) => (options.client ?? client_gen_1.client).delete({
562
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
563
+ url: '/v1/graphs/{graph_id}/connections/{connection_id}',
564
+ ...options
565
+ });
566
+ exports.deleteConnection = deleteConnection;
567
+ /**
568
+ * Get Connection
569
+ *
570
+ * Get detailed information about a specific connection.
571
+ *
572
+ * Returns comprehensive connection details including:
573
+ * - Current status and health indicators
574
+ * - Authentication state
575
+ * - Sync history and statistics
576
+ * - Error details if any
577
+ * - Provider-specific metadata
578
+ *
579
+ * No credits are consumed for viewing connection details.
580
+ */
581
+ const getConnection = (options) => (options.client ?? client_gen_1.client).get({
582
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
583
+ url: '/v1/graphs/{graph_id}/connections/{connection_id}',
584
+ ...options
585
+ });
586
+ exports.getConnection = getConnection;
587
+ /**
588
+ * Sync Connection
589
+ *
590
+ * Trigger a data synchronization for the connection.
591
+ *
592
+ * Initiates data sync based on provider type:
593
+ *
594
+ * **SEC Sync**:
595
+ * - Downloads latest filings from EDGAR
596
+ * - Parses XBRL data and updates graph
597
+ * - Typically completes in 5-10 minutes
598
+ *
599
+ * **QuickBooks Sync**:
600
+ * - Fetches latest transactions and balances
601
+ * - Updates chart of accounts
602
+ * - Generates fresh trial balance
603
+ * - Duration depends on data volume
604
+ *
605
+ * **Plaid Sync**:
606
+ * - Retrieves recent bank transactions
607
+ * - Updates account balances
608
+ * - Categorizes new transactions
609
+ *
610
+ * Note:
611
+ * This operation is included - no credit consumption required.
612
+ *
613
+ * Returns a task ID for monitoring sync progress.
614
+ */
615
+ const syncConnection = (options) => (options.client ?? client_gen_1.client).post({
616
+ security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
617
+ url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
618
+ ...options,
619
+ headers: {
620
+ 'Content-Type': 'application/json',
621
+ ...options.headers
622
+ }
623
+ });
624
+ exports.syncConnection = syncConnection;
419
625
  /**
420
626
  * List available agents
421
627
  *
@@ -1534,10 +1740,10 @@ exports.getSubgraphInfo = getSubgraphInfo;
1534
1740
  * - Total size usage across all subgraphs
1535
1741
  *
1536
1742
  * **Tier Limits:**
1537
- * - Standard: 0 subgraphs (not supported)
1538
- * - Enterprise: Configurable limit (default: 10 subgraphs)
1539
- * - Premium: Unlimited subgraphs
1540
- * - Limits are defined in deployment configuration
1743
+ * - Standard: Up to 3 subgraphs (dedicated m7g.large instance)
1744
+ * - Large: Up to 10 subgraphs (dedicated r7g.large instance)
1745
+ * - XLarge: Up to 25 subgraphs (dedicated r7g.xlarge instance)
1746
+ * - Limits are defined in graph.yml deployment configuration
1541
1747
  *
1542
1748
  * **Size Tracking:**
1543
1749
  * Provides aggregate size metrics when available.