@robosystems/client 0.2.30 → 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/README.md +1 -1
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +12 -3
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +194 -11
- package/sdk/sdk.gen.js +257 -21
- package/sdk/sdk.gen.ts +255 -20
- package/sdk/types.gen.d.ts +769 -40
- package/sdk/types.gen.ts +830 -51
- package/sdk.gen.d.ts +194 -11
- package/sdk.gen.js +257 -21
- package/sdk.gen.ts +255 -20
- package/types.gen.d.ts +769 -40
- package/types.gen.ts +830 -51
package/sdk/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.
|
|
5
|
-
exports.
|
|
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:
|
|
1538
|
-
* -
|
|
1539
|
-
* -
|
|
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.
|
|
@@ -2236,6 +2442,36 @@ const getAvailableGraphTiers = (options) => (options?.client ?? client_gen_1.cli
|
|
|
2236
2442
|
...options
|
|
2237
2443
|
});
|
|
2238
2444
|
exports.getAvailableGraphTiers = getAvailableGraphTiers;
|
|
2445
|
+
/**
|
|
2446
|
+
* Get Graph Tier Capacity
|
|
2447
|
+
*
|
|
2448
|
+
* Check current infrastructure capacity for each graph database tier.
|
|
2449
|
+
*
|
|
2450
|
+
* Returns a status per tier indicating whether instances are immediately available,
|
|
2451
|
+
* can be provisioned on demand, or are at capacity.
|
|
2452
|
+
*
|
|
2453
|
+
* **Status Values:**
|
|
2454
|
+
* - `ready` — An instance slot is available; graph creation will succeed immediately
|
|
2455
|
+
* - `scalable` — No slots right now, but a new instance can be provisioned (3-5 min)
|
|
2456
|
+
* - `at_capacity` — Tier is full and cannot auto-scale; contact support
|
|
2457
|
+
*
|
|
2458
|
+
* **Use Cases:**
|
|
2459
|
+
* - Pre-flight check before entering the graph creation wizard
|
|
2460
|
+
* - Show availability badges on tier selection cards
|
|
2461
|
+
* - Gate tier selection and show contact form for at-capacity tiers
|
|
2462
|
+
*
|
|
2463
|
+
* **Caching:**
|
|
2464
|
+
* Results are cached for 60 seconds to avoid excessive infrastructure queries.
|
|
2465
|
+
*
|
|
2466
|
+
* **Note:**
|
|
2467
|
+
* No credit consumption required. Does not expose instance counts or IPs.
|
|
2468
|
+
*/
|
|
2469
|
+
const getGraphCapacity = (options) => (options?.client ?? client_gen_1.client).get({
|
|
2470
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2471
|
+
url: '/v1/graphs/capacity',
|
|
2472
|
+
...options
|
|
2473
|
+
});
|
|
2474
|
+
exports.getGraphCapacity = getGraphCapacity;
|
|
2239
2475
|
/**
|
|
2240
2476
|
* Select Graph
|
|
2241
2477
|
*
|
package/sdk/sdk.gen.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
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,
|
|
5
|
+
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';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
@@ -301,21 +301,6 @@ export const listUserOrgs = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
301
301
|
...options
|
|
302
302
|
});
|
|
303
303
|
|
|
304
|
-
/**
|
|
305
|
-
* Create Organization
|
|
306
|
-
*
|
|
307
|
-
* Create a new organization. The creating user becomes the owner.
|
|
308
|
-
*/
|
|
309
|
-
export const createOrg = <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => (options.client ?? client).post<CreateOrgResponses, CreateOrgErrors, ThrowOnError>({
|
|
310
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
311
|
-
url: '/v1/orgs',
|
|
312
|
-
...options,
|
|
313
|
-
headers: {
|
|
314
|
-
'Content-Type': 'application/json',
|
|
315
|
-
...options.headers
|
|
316
|
-
}
|
|
317
|
-
});
|
|
318
|
-
|
|
319
304
|
/**
|
|
320
305
|
* Get Organization
|
|
321
306
|
*
|
|
@@ -430,6 +415,226 @@ export const getOrgUsage = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
430
415
|
...options
|
|
431
416
|
});
|
|
432
417
|
|
|
418
|
+
/**
|
|
419
|
+
* List Connections
|
|
420
|
+
*
|
|
421
|
+
* List all data connections in the graph.
|
|
422
|
+
*
|
|
423
|
+
* Returns active and inactive connections with their current status.
|
|
424
|
+
* Connections can be filtered by:
|
|
425
|
+
* - **Entity**: Show connections for a specific entity
|
|
426
|
+
* - **Provider**: Filter by connection type (sec, quickbooks, plaid)
|
|
427
|
+
*
|
|
428
|
+
* Each connection shows:
|
|
429
|
+
* - Current sync status and health
|
|
430
|
+
* - Last successful sync timestamp
|
|
431
|
+
* - Configuration metadata
|
|
432
|
+
* - Error messages if any
|
|
433
|
+
*
|
|
434
|
+
* No credits are consumed for listing connections.
|
|
435
|
+
*/
|
|
436
|
+
export const listConnections = <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => (options.client ?? client).get<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError>({
|
|
437
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
438
|
+
url: '/v1/graphs/{graph_id}/connections',
|
|
439
|
+
...options
|
|
440
|
+
});
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* Create Connection
|
|
444
|
+
*
|
|
445
|
+
* Create a new data connection for external system integration.
|
|
446
|
+
*
|
|
447
|
+
* This endpoint initiates connections to external data sources:
|
|
448
|
+
*
|
|
449
|
+
* **SEC Connections**:
|
|
450
|
+
* - Provide entity CIK for automatic filing retrieval
|
|
451
|
+
* - No authentication needed
|
|
452
|
+
* - Begins immediate data sync
|
|
453
|
+
*
|
|
454
|
+
* **QuickBooks Connections**:
|
|
455
|
+
* - Returns OAuth URL for authorization
|
|
456
|
+
* - Requires admin permissions in QuickBooks
|
|
457
|
+
* - Complete with OAuth callback
|
|
458
|
+
*
|
|
459
|
+
* **Plaid Connections**:
|
|
460
|
+
* - Returns Plaid Link token
|
|
461
|
+
* - User completes bank authentication
|
|
462
|
+
* - Exchange public token for access
|
|
463
|
+
*
|
|
464
|
+
* Note:
|
|
465
|
+
* This operation is included - no credit consumption required.
|
|
466
|
+
*/
|
|
467
|
+
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => (options.client ?? client).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
|
|
468
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
469
|
+
url: '/v1/graphs/{graph_id}/connections',
|
|
470
|
+
...options,
|
|
471
|
+
headers: {
|
|
472
|
+
'Content-Type': 'application/json',
|
|
473
|
+
...options.headers
|
|
474
|
+
}
|
|
475
|
+
});
|
|
476
|
+
|
|
477
|
+
/**
|
|
478
|
+
* List Connection Options
|
|
479
|
+
*
|
|
480
|
+
* Get metadata about all available data connection providers.
|
|
481
|
+
*
|
|
482
|
+
* This endpoint returns comprehensive information about each supported provider:
|
|
483
|
+
*
|
|
484
|
+
* **SEC EDGAR**: Public entity financial filings
|
|
485
|
+
* - No authentication required (public data)
|
|
486
|
+
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
487
|
+
* - Historical and real-time filing access
|
|
488
|
+
*
|
|
489
|
+
* **QuickBooks Online**: Full accounting system integration
|
|
490
|
+
* - OAuth 2.0 authentication
|
|
491
|
+
* - Chart of accounts, transactions, trial balance
|
|
492
|
+
* - Real-time sync capabilities
|
|
493
|
+
*
|
|
494
|
+
* **Plaid**: Bank account connections
|
|
495
|
+
* - Secure bank authentication via Plaid Link
|
|
496
|
+
* - Transaction history and balances
|
|
497
|
+
* - Multi-account support
|
|
498
|
+
*
|
|
499
|
+
* No credits are consumed for viewing connection options.
|
|
500
|
+
*/
|
|
501
|
+
export const getConnectionOptions = <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => (options.client ?? client).get<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError>({
|
|
502
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
503
|
+
url: '/v1/graphs/{graph_id}/connections/options',
|
|
504
|
+
...options
|
|
505
|
+
});
|
|
506
|
+
|
|
507
|
+
/**
|
|
508
|
+
* Init Oauth
|
|
509
|
+
*
|
|
510
|
+
* Initialize OAuth flow for a connection.
|
|
511
|
+
*
|
|
512
|
+
* This generates an authorization URL that the frontend should redirect the user to.
|
|
513
|
+
* Currently supports: QuickBooks
|
|
514
|
+
*/
|
|
515
|
+
export const initOAuth = <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => (options.client ?? client).post<InitOAuthResponses, InitOAuthErrors, ThrowOnError>({
|
|
516
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
517
|
+
url: '/v1/graphs/{graph_id}/connections/oauth/init',
|
|
518
|
+
...options,
|
|
519
|
+
headers: {
|
|
520
|
+
'Content-Type': 'application/json',
|
|
521
|
+
...options.headers
|
|
522
|
+
}
|
|
523
|
+
});
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* OAuth Callback
|
|
527
|
+
*
|
|
528
|
+
* Handle OAuth callback from provider after user authorization.
|
|
529
|
+
*
|
|
530
|
+
* This endpoint completes the OAuth flow:
|
|
531
|
+
* 1. Validates the OAuth state parameter
|
|
532
|
+
* 2. Exchanges authorization code for access tokens
|
|
533
|
+
* 3. Stores tokens securely
|
|
534
|
+
* 4. Updates connection status
|
|
535
|
+
* 5. Optionally triggers initial sync
|
|
536
|
+
*
|
|
537
|
+
* Supported providers:
|
|
538
|
+
* - **QuickBooks**: Accounting data integration
|
|
539
|
+
*
|
|
540
|
+
* Security measures:
|
|
541
|
+
* - State validation prevents session hijacking
|
|
542
|
+
* - User context is verified
|
|
543
|
+
* - Tokens are encrypted before storage
|
|
544
|
+
* - Full audit trail is maintained
|
|
545
|
+
*
|
|
546
|
+
* No credits are consumed for OAuth callbacks.
|
|
547
|
+
*/
|
|
548
|
+
export const oauthCallback = <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => (options.client ?? client).post<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError>({
|
|
549
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
550
|
+
url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
|
|
551
|
+
...options,
|
|
552
|
+
headers: {
|
|
553
|
+
'Content-Type': 'application/json',
|
|
554
|
+
...options.headers
|
|
555
|
+
}
|
|
556
|
+
});
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* Delete Connection
|
|
560
|
+
*
|
|
561
|
+
* Delete a data connection and clean up related resources.
|
|
562
|
+
*
|
|
563
|
+
* This operation:
|
|
564
|
+
* - Removes the connection configuration
|
|
565
|
+
* - Preserves any imported data in the graph
|
|
566
|
+
* - Performs provider-specific cleanup
|
|
567
|
+
* - Revokes stored credentials
|
|
568
|
+
*
|
|
569
|
+
* Note:
|
|
570
|
+
* This operation is included - no credit consumption required.
|
|
571
|
+
*
|
|
572
|
+
* Only users with admin role can delete connections.
|
|
573
|
+
*/
|
|
574
|
+
export const deleteConnection = <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => (options.client ?? client).delete<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError>({
|
|
575
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
576
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
577
|
+
...options
|
|
578
|
+
});
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Get Connection
|
|
582
|
+
*
|
|
583
|
+
* Get detailed information about a specific connection.
|
|
584
|
+
*
|
|
585
|
+
* Returns comprehensive connection details including:
|
|
586
|
+
* - Current status and health indicators
|
|
587
|
+
* - Authentication state
|
|
588
|
+
* - Sync history and statistics
|
|
589
|
+
* - Error details if any
|
|
590
|
+
* - Provider-specific metadata
|
|
591
|
+
*
|
|
592
|
+
* No credits are consumed for viewing connection details.
|
|
593
|
+
*/
|
|
594
|
+
export const getConnection = <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => (options.client ?? client).get<GetConnectionResponses, GetConnectionErrors, ThrowOnError>({
|
|
595
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
596
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
597
|
+
...options
|
|
598
|
+
});
|
|
599
|
+
|
|
600
|
+
/**
|
|
601
|
+
* Sync Connection
|
|
602
|
+
*
|
|
603
|
+
* Trigger a data synchronization for the connection.
|
|
604
|
+
*
|
|
605
|
+
* Initiates data sync based on provider type:
|
|
606
|
+
*
|
|
607
|
+
* **SEC Sync**:
|
|
608
|
+
* - Downloads latest filings from EDGAR
|
|
609
|
+
* - Parses XBRL data and updates graph
|
|
610
|
+
* - Typically completes in 5-10 minutes
|
|
611
|
+
*
|
|
612
|
+
* **QuickBooks Sync**:
|
|
613
|
+
* - Fetches latest transactions and balances
|
|
614
|
+
* - Updates chart of accounts
|
|
615
|
+
* - Generates fresh trial balance
|
|
616
|
+
* - Duration depends on data volume
|
|
617
|
+
*
|
|
618
|
+
* **Plaid Sync**:
|
|
619
|
+
* - Retrieves recent bank transactions
|
|
620
|
+
* - Updates account balances
|
|
621
|
+
* - Categorizes new transactions
|
|
622
|
+
*
|
|
623
|
+
* Note:
|
|
624
|
+
* This operation is included - no credit consumption required.
|
|
625
|
+
*
|
|
626
|
+
* Returns a task ID for monitoring sync progress.
|
|
627
|
+
*/
|
|
628
|
+
export const syncConnection = <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => (options.client ?? client).post<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError>({
|
|
629
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
630
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
|
|
631
|
+
...options,
|
|
632
|
+
headers: {
|
|
633
|
+
'Content-Type': 'application/json',
|
|
634
|
+
...options.headers
|
|
635
|
+
}
|
|
636
|
+
});
|
|
637
|
+
|
|
433
638
|
/**
|
|
434
639
|
* List available agents
|
|
435
640
|
*
|
|
@@ -1548,10 +1753,10 @@ export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
1548
1753
|
* - Total size usage across all subgraphs
|
|
1549
1754
|
*
|
|
1550
1755
|
* **Tier Limits:**
|
|
1551
|
-
* - Standard:
|
|
1552
|
-
* -
|
|
1553
|
-
* -
|
|
1554
|
-
* - Limits are defined in deployment configuration
|
|
1756
|
+
* - Standard: Up to 3 subgraphs (dedicated m7g.large instance)
|
|
1757
|
+
* - Large: Up to 10 subgraphs (dedicated r7g.large instance)
|
|
1758
|
+
* - XLarge: Up to 25 subgraphs (dedicated r7g.xlarge instance)
|
|
1759
|
+
* - Limits are defined in graph.yml deployment configuration
|
|
1555
1760
|
*
|
|
1556
1761
|
* **Size Tracking:**
|
|
1557
1762
|
* Provides aggregate size metrics when available.
|
|
@@ -2250,6 +2455,36 @@ export const getAvailableGraphTiers = <ThrowOnError extends boolean = false>(opt
|
|
|
2250
2455
|
...options
|
|
2251
2456
|
});
|
|
2252
2457
|
|
|
2458
|
+
/**
|
|
2459
|
+
* Get Graph Tier Capacity
|
|
2460
|
+
*
|
|
2461
|
+
* Check current infrastructure capacity for each graph database tier.
|
|
2462
|
+
*
|
|
2463
|
+
* Returns a status per tier indicating whether instances are immediately available,
|
|
2464
|
+
* can be provisioned on demand, or are at capacity.
|
|
2465
|
+
*
|
|
2466
|
+
* **Status Values:**
|
|
2467
|
+
* - `ready` — An instance slot is available; graph creation will succeed immediately
|
|
2468
|
+
* - `scalable` — No slots right now, but a new instance can be provisioned (3-5 min)
|
|
2469
|
+
* - `at_capacity` — Tier is full and cannot auto-scale; contact support
|
|
2470
|
+
*
|
|
2471
|
+
* **Use Cases:**
|
|
2472
|
+
* - Pre-flight check before entering the graph creation wizard
|
|
2473
|
+
* - Show availability badges on tier selection cards
|
|
2474
|
+
* - Gate tier selection and show contact form for at-capacity tiers
|
|
2475
|
+
*
|
|
2476
|
+
* **Caching:**
|
|
2477
|
+
* Results are cached for 60 seconds to avoid excessive infrastructure queries.
|
|
2478
|
+
*
|
|
2479
|
+
* **Note:**
|
|
2480
|
+
* No credit consumption required. Does not expose instance counts or IPs.
|
|
2481
|
+
*/
|
|
2482
|
+
export const getGraphCapacity = <ThrowOnError extends boolean = false>(options?: Options<GetGraphCapacityData, ThrowOnError>) => (options?.client ?? client).get<GetGraphCapacityResponses, GetGraphCapacityErrors, ThrowOnError>({
|
|
2483
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2484
|
+
url: '/v1/graphs/capacity',
|
|
2485
|
+
...options
|
|
2486
|
+
});
|
|
2487
|
+
|
|
2253
2488
|
/**
|
|
2254
2489
|
* Select Graph
|
|
2255
2490
|
*
|