@robosystems/client 0.2.28 → 0.2.30

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/sdk.gen.js CHANGED
@@ -1,9 +1,8 @@
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.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.createLinkToken = exports.exchangeLinkToken = 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.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.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.materializeGraph = exports.getMaterializationStatus = exports.saveView = exports.createView = 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 = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = void 0;
6
- exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = void 0;
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.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;
7
6
  const client_gen_1 = require("./client.gen");
8
7
  /**
9
8
  * Register New User
@@ -417,287 +416,6 @@ const getOrgUsage = (options) => (options.client ?? client_gen_1.client).get({
417
416
  ...options
418
417
  });
419
418
  exports.getOrgUsage = getOrgUsage;
420
- /**
421
- * List Connections
422
- *
423
- * List all data connections in the graph.
424
- *
425
- * Returns active and inactive connections with their current status.
426
- * Connections can be filtered by:
427
- * - **Entity**: Show connections for a specific entity
428
- * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
429
- *
430
- * Each connection shows:
431
- * - Current sync status and health
432
- * - Last successful sync timestamp
433
- * - Configuration metadata
434
- * - Error messages if any
435
- *
436
- * No credits are consumed for listing connections.
437
- */
438
- const listConnections = (options) => (options.client ?? client_gen_1.client).get({
439
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
440
- url: '/v1/graphs/{graph_id}/connections',
441
- ...options
442
- });
443
- exports.listConnections = listConnections;
444
- /**
445
- * Create Connection
446
- *
447
- * Create a new data connection for external system integration.
448
- *
449
- * This endpoint initiates connections to external data sources:
450
- *
451
- * **SEC Connections**:
452
- * - Provide entity CIK for automatic filing retrieval
453
- * - No authentication needed
454
- * - Begins immediate data sync
455
- *
456
- * **QuickBooks Connections**:
457
- * - Returns OAuth URL for authorization
458
- * - Requires admin permissions in QuickBooks
459
- * - Complete with OAuth callback
460
- *
461
- * **Plaid Connections**:
462
- * - Returns Plaid Link token
463
- * - User completes bank authentication
464
- * - Exchange public token for access
465
- *
466
- * Note:
467
- * This operation is included - no credit consumption required.
468
- */
469
- const createConnection = (options) => (options.client ?? client_gen_1.client).post({
470
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
471
- url: '/v1/graphs/{graph_id}/connections',
472
- ...options,
473
- headers: {
474
- 'Content-Type': 'application/json',
475
- ...options.headers
476
- }
477
- });
478
- exports.createConnection = createConnection;
479
- /**
480
- * List Connection Options
481
- *
482
- * Get metadata about all available data connection providers.
483
- *
484
- * This endpoint returns comprehensive information about each supported provider:
485
- *
486
- * **SEC EDGAR**: Public entity financial filings
487
- * - No authentication required (public data)
488
- * - 10-K, 10-Q, 8-K reports with XBRL data
489
- * - Historical and real-time filing access
490
- *
491
- * **QuickBooks Online**: Full accounting system integration
492
- * - OAuth 2.0 authentication
493
- * - Chart of accounts, transactions, trial balance
494
- * - Real-time sync capabilities
495
- *
496
- * **Plaid**: Bank account connections
497
- * - Secure bank authentication via Plaid Link
498
- * - Transaction history and balances
499
- * - Multi-account support
500
- *
501
- * No credits are consumed for viewing connection options.
502
- */
503
- const getConnectionOptions = (options) => (options.client ?? client_gen_1.client).get({
504
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
505
- url: '/v1/graphs/{graph_id}/connections/options',
506
- ...options
507
- });
508
- exports.getConnectionOptions = getConnectionOptions;
509
- /**
510
- * Exchange Link Token
511
- *
512
- * Exchange a public token for permanent access credentials.
513
- *
514
- * This completes the embedded authentication flow after user authorization.
515
- *
516
- * The exchange process:
517
- * 1. Validates the temporary public token
518
- * 2. Exchanges it for permanent access credentials
519
- * 3. Updates the connection with account information
520
- * 4. Optionally triggers initial data sync
521
- *
522
- * Supported providers:
523
- * - **Plaid**: Exchanges Plaid Link public token for access token
524
- *
525
- * Security:
526
- * - Public tokens expire after 30 minutes
527
- * - Each token can only be exchanged once
528
- * - Full audit trail is maintained
529
- *
530
- * No credits are consumed for token exchange.
531
- */
532
- const exchangeLinkToken = (options) => (options.client ?? client_gen_1.client).post({
533
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
534
- url: '/v1/graphs/{graph_id}/connections/link/exchange',
535
- ...options,
536
- headers: {
537
- 'Content-Type': 'application/json',
538
- ...options.headers
539
- }
540
- });
541
- exports.exchangeLinkToken = exchangeLinkToken;
542
- /**
543
- * Create Link Token
544
- *
545
- * Create a link token for embedded authentication providers.
546
- *
547
- * This endpoint generates a temporary token used to initialize embedded authentication UI.
548
- *
549
- * Currently supported providers:
550
- * - **Plaid**: Bank account connections with real-time transaction access
551
- *
552
- * The link token:
553
- * - Expires after 4 hours
554
- * - Is single-use only
555
- * - Must be used with the matching frontend SDK
556
- * - Includes user and entity context
557
- *
558
- * No credits are consumed for creating link tokens.
559
- */
560
- const createLinkToken = (options) => (options.client ?? client_gen_1.client).post({
561
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
562
- url: '/v1/graphs/{graph_id}/connections/link/token',
563
- ...options,
564
- headers: {
565
- 'Content-Type': 'application/json',
566
- ...options.headers
567
- }
568
- });
569
- exports.createLinkToken = createLinkToken;
570
- /**
571
- * Init Oauth
572
- *
573
- * Initialize OAuth flow for a connection.
574
- *
575
- * This generates an authorization URL that the frontend should redirect the user to.
576
- * Currently supports: QuickBooks
577
- */
578
- const initOAuth = (options) => (options.client ?? client_gen_1.client).post({
579
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
580
- url: '/v1/graphs/{graph_id}/connections/oauth/init',
581
- ...options,
582
- headers: {
583
- 'Content-Type': 'application/json',
584
- ...options.headers
585
- }
586
- });
587
- exports.initOAuth = initOAuth;
588
- /**
589
- * OAuth Callback
590
- *
591
- * Handle OAuth callback from provider after user authorization.
592
- *
593
- * This endpoint completes the OAuth flow:
594
- * 1. Validates the OAuth state parameter
595
- * 2. Exchanges authorization code for access tokens
596
- * 3. Stores tokens securely
597
- * 4. Updates connection status
598
- * 5. Optionally triggers initial sync
599
- *
600
- * Supported providers:
601
- * - **QuickBooks**: Accounting data integration
602
- *
603
- * Security measures:
604
- * - State validation prevents session hijacking
605
- * - User context is verified
606
- * - Tokens are encrypted before storage
607
- * - Full audit trail is maintained
608
- *
609
- * No credits are consumed for OAuth callbacks.
610
- */
611
- const oauthCallback = (options) => (options.client ?? client_gen_1.client).post({
612
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
613
- url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
614
- ...options,
615
- headers: {
616
- 'Content-Type': 'application/json',
617
- ...options.headers
618
- }
619
- });
620
- exports.oauthCallback = oauthCallback;
621
- /**
622
- * Delete Connection
623
- *
624
- * Delete a data connection and clean up related resources.
625
- *
626
- * This operation:
627
- * - Removes the connection configuration
628
- * - Preserves any imported data in the graph
629
- * - Performs provider-specific cleanup
630
- * - Revokes stored credentials
631
- *
632
- * Note:
633
- * This operation is included - no credit consumption required.
634
- *
635
- * Only users with admin role can delete connections.
636
- */
637
- const deleteConnection = (options) => (options.client ?? client_gen_1.client).delete({
638
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
639
- url: '/v1/graphs/{graph_id}/connections/{connection_id}',
640
- ...options
641
- });
642
- exports.deleteConnection = deleteConnection;
643
- /**
644
- * Get Connection
645
- *
646
- * Get detailed information about a specific connection.
647
- *
648
- * Returns comprehensive connection details including:
649
- * - Current status and health indicators
650
- * - Authentication state
651
- * - Sync history and statistics
652
- * - Error details if any
653
- * - Provider-specific metadata
654
- *
655
- * No credits are consumed for viewing connection details.
656
- */
657
- const getConnection = (options) => (options.client ?? client_gen_1.client).get({
658
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
659
- url: '/v1/graphs/{graph_id}/connections/{connection_id}',
660
- ...options
661
- });
662
- exports.getConnection = getConnection;
663
- /**
664
- * Sync Connection
665
- *
666
- * Trigger a data synchronization for the connection.
667
- *
668
- * Initiates data sync based on provider type:
669
- *
670
- * **SEC Sync**:
671
- * - Downloads latest filings from EDGAR
672
- * - Parses XBRL data and updates graph
673
- * - Typically completes in 5-10 minutes
674
- *
675
- * **QuickBooks Sync**:
676
- * - Fetches latest transactions and balances
677
- * - Updates chart of accounts
678
- * - Generates fresh trial balance
679
- * - Duration depends on data volume
680
- *
681
- * **Plaid Sync**:
682
- * - Retrieves recent bank transactions
683
- * - Updates account balances
684
- * - Categorizes new transactions
685
- *
686
- * Note:
687
- * This operation is included - no credit consumption required.
688
- *
689
- * Returns a task ID for monitoring sync progress.
690
- */
691
- const syncConnection = (options) => (options.client ?? client_gen_1.client).post({
692
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
693
- url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
694
- ...options,
695
- headers: {
696
- 'Content-Type': 'application/json',
697
- ...options.headers
698
- }
699
- });
700
- exports.syncConnection = syncConnection;
701
419
  /**
702
420
  * List available agents
703
421
  *
@@ -1659,6 +1377,7 @@ exports.getDatabaseInfo = getDatabaseInfo;
1659
1377
  * - **Backup Limits**: Frequency, retention, size limits
1660
1378
  * - **Rate Limits**: Requests per minute/hour based on tier
1661
1379
  * - **Credit Limits**: AI operation credits (if applicable)
1380
+ * - **Content Limits**: Node, relationship, and row limits (if applicable)
1662
1381
  *
1663
1382
  * This unified endpoint provides all limits in one place for easier client integration.
1664
1383
  *
@@ -1998,79 +1717,6 @@ const queryTables = (options) => (options.client ?? client_gen_1.client).post({
1998
1717
  }
1999
1718
  });
2000
1719
  exports.queryTables = queryTables;
2001
- /**
2002
- * Create View
2003
- *
2004
- * Generate financial report view from data source (dual-mode support).
2005
- *
2006
- * **Mode 1: Transaction Aggregation (generate_from_transactions)**
2007
- * - Aggregates raw transaction data to trial balance
2008
- * - Creates facts on-demand
2009
- * - Shows real-time reporting from source of truth
2010
- *
2011
- * **Mode 2: Existing Facts (pivot_existing_facts)**
2012
- * - Queries existing Fact nodes
2013
- * - Supports multi-dimensional analysis
2014
- * - Works with SEC filings and pre-computed facts
2015
- *
2016
- * Both modes:
2017
- * - Build FactGrid from data
2018
- * - Generate pivot table presentation
2019
- * - Return consistent response format
2020
- */
2021
- const createView = (options) => (options.client ?? client_gen_1.client).post({
2022
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
2023
- url: '/v1/graphs/{graph_id}/views',
2024
- ...options,
2025
- headers: {
2026
- 'Content-Type': 'application/json',
2027
- ...options.headers
2028
- }
2029
- });
2030
- exports.createView = createView;
2031
- /**
2032
- * Save View
2033
- *
2034
- * Save or update view as materialized report in the graph.
2035
- *
2036
- * Converts computed view results into persistent Report, Fact, and Structure nodes.
2037
- * This establishes what data exists in the subgraph, which then defines what
2038
- * needs to be exported for publishing to the parent graph.
2039
- *
2040
- * **Create Mode** (no report_id provided):
2041
- * - Generates new report_id from entity + period + report type
2042
- * - Creates new Report, Facts, and Structures
2043
- *
2044
- * **Update Mode** (report_id provided):
2045
- * - Deletes all existing Facts and Structures for the report
2046
- * - Updates Report metadata
2047
- * - Creates fresh Facts and Structures from current view
2048
- * - Useful for refreshing reports with updated data or view configurations
2049
- *
2050
- * **This is NOT publishing** - it only creates nodes in the subgraph workspace.
2051
- * Publishing (export → parquet → parent ingest) happens separately.
2052
- *
2053
- * Creates/Updates:
2054
- * - Report node with metadata
2055
- * - Fact nodes with all aspects (period, entity, element, unit)
2056
- * - PresentationStructure nodes (how facts are displayed)
2057
- * - CalculationStructure nodes (how facts roll up)
2058
- *
2059
- * Returns:
2060
- * - report_id: Unique identifier used as parquet export prefix
2061
- * - parquet_export_prefix: Filename prefix for future exports
2062
- * - All created facts and structures
2063
- */
2064
- const saveView = (options) => (options.client ?? client_gen_1.client).post({
2065
- security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
2066
- url: '/v1/graphs/{graph_id}/views/save',
2067
- ...options,
2068
- headers: {
2069
- 'Content-Type': 'application/json',
2070
- ...options.headers
2071
- }
2072
- });
2073
- exports.saveView = saveView;
2074
1720
  /**
2075
1721
  * Get Materialization Status
2076
1722
  *
@@ -2157,6 +1803,10 @@ exports.getMaterializationStatus = getMaterializationStatus;
2157
1803
  * Full graph materialization can take minutes for large datasets. Consider running
2158
1804
  * during off-peak hours for production systems.
2159
1805
  *
1806
+ * **Dry Run:**
1807
+ * Set `dry_run=true` to validate limits without executing. Returns current usage, tier limits,
1808
+ * and any warnings or errors. No lock is acquired, no SSE operation is created.
1809
+ *
2160
1810
  * **Credits:**
2161
1811
  * Materialization is included - no credit consumption
2162
1812
  */
@@ -2567,11 +2217,9 @@ exports.getAvailableExtensions = getAvailableExtensions;
2567
2217
  * - Availability status
2568
2218
  *
2569
2219
  * **Available Tiers:**
2570
- * - **ladybug-standard**: Multi-tenant entry-level tier
2220
+ * - **ladybug-standard**: Dedicated entry-level tier
2571
2221
  * - **ladybug-large**: Dedicated professional tier with subgraph support
2572
2222
  * - **ladybug-xlarge**: Enterprise tier with maximum resources
2573
- * - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
2574
- * - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
2575
2223
  *
2576
2224
  * **Use Cases:**
2577
2225
  * - Display tier options in graph creation UI
@@ -2916,10 +2564,11 @@ exports.createCheckoutSession = createCheckoutSession;
2916
2564
  * **Status Values:**
2917
2565
  * - `pending_payment`: Waiting for payment to complete
2918
2566
  * - `provisioning`: Payment confirmed, resource being created
2919
- * - `completed`: Resource is ready (resource_id will be set)
2567
+ * - `active`: Resource is ready (resource_id will be set)
2920
2568
  * - `failed`: Something went wrong (error field will be set)
2569
+ * - `canceled`: Payment was canceled
2921
2570
  *
2922
- * **When status is 'completed':**
2571
+ * **When status is 'active':**
2923
2572
  * - For graphs: `resource_id` will be the graph_id, and `operation_id` can be used to monitor SSE progress
2924
2573
  * - For repositories: `resource_id` will be the repository name and access is immediately available
2925
2574
  */