@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/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +2 -15
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +10 -268
- package/sdk/sdk.gen.js +11 -362
- package/sdk/sdk.gen.ts +10 -360
- package/sdk/types.gen.d.ts +259 -1389
- package/sdk/types.gen.ts +252 -1459
- package/sdk.gen.d.ts +10 -268
- package/sdk.gen.js +11 -362
- package/sdk.gen.ts +10 -360
- package/types.gen.d.ts +259 -1389
- package/types.gen.ts +252 -1459
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,
|
|
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, 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, 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';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
@@ -430,287 +430,6 @@ export const getOrgUsage = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
430
430
|
...options
|
|
431
431
|
});
|
|
432
432
|
|
|
433
|
-
/**
|
|
434
|
-
* List Connections
|
|
435
|
-
*
|
|
436
|
-
* List all data connections in the graph.
|
|
437
|
-
*
|
|
438
|
-
* Returns active and inactive connections with their current status.
|
|
439
|
-
* Connections can be filtered by:
|
|
440
|
-
* - **Entity**: Show connections for a specific entity
|
|
441
|
-
* - **Provider**: Filter by connection type (sec, quickbooks, plaid)
|
|
442
|
-
*
|
|
443
|
-
* Each connection shows:
|
|
444
|
-
* - Current sync status and health
|
|
445
|
-
* - Last successful sync timestamp
|
|
446
|
-
* - Configuration metadata
|
|
447
|
-
* - Error messages if any
|
|
448
|
-
*
|
|
449
|
-
* No credits are consumed for listing connections.
|
|
450
|
-
*/
|
|
451
|
-
export const listConnections = <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => (options.client ?? client).get<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError>({
|
|
452
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
453
|
-
url: '/v1/graphs/{graph_id}/connections',
|
|
454
|
-
...options
|
|
455
|
-
});
|
|
456
|
-
|
|
457
|
-
/**
|
|
458
|
-
* Create Connection
|
|
459
|
-
*
|
|
460
|
-
* Create a new data connection for external system integration.
|
|
461
|
-
*
|
|
462
|
-
* This endpoint initiates connections to external data sources:
|
|
463
|
-
*
|
|
464
|
-
* **SEC Connections**:
|
|
465
|
-
* - Provide entity CIK for automatic filing retrieval
|
|
466
|
-
* - No authentication needed
|
|
467
|
-
* - Begins immediate data sync
|
|
468
|
-
*
|
|
469
|
-
* **QuickBooks Connections**:
|
|
470
|
-
* - Returns OAuth URL for authorization
|
|
471
|
-
* - Requires admin permissions in QuickBooks
|
|
472
|
-
* - Complete with OAuth callback
|
|
473
|
-
*
|
|
474
|
-
* **Plaid Connections**:
|
|
475
|
-
* - Returns Plaid Link token
|
|
476
|
-
* - User completes bank authentication
|
|
477
|
-
* - Exchange public token for access
|
|
478
|
-
*
|
|
479
|
-
* Note:
|
|
480
|
-
* This operation is included - no credit consumption required.
|
|
481
|
-
*/
|
|
482
|
-
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => (options.client ?? client).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
|
|
483
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
484
|
-
url: '/v1/graphs/{graph_id}/connections',
|
|
485
|
-
...options,
|
|
486
|
-
headers: {
|
|
487
|
-
'Content-Type': 'application/json',
|
|
488
|
-
...options.headers
|
|
489
|
-
}
|
|
490
|
-
});
|
|
491
|
-
|
|
492
|
-
/**
|
|
493
|
-
* List Connection Options
|
|
494
|
-
*
|
|
495
|
-
* Get metadata about all available data connection providers.
|
|
496
|
-
*
|
|
497
|
-
* This endpoint returns comprehensive information about each supported provider:
|
|
498
|
-
*
|
|
499
|
-
* **SEC EDGAR**: Public entity financial filings
|
|
500
|
-
* - No authentication required (public data)
|
|
501
|
-
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
502
|
-
* - Historical and real-time filing access
|
|
503
|
-
*
|
|
504
|
-
* **QuickBooks Online**: Full accounting system integration
|
|
505
|
-
* - OAuth 2.0 authentication
|
|
506
|
-
* - Chart of accounts, transactions, trial balance
|
|
507
|
-
* - Real-time sync capabilities
|
|
508
|
-
*
|
|
509
|
-
* **Plaid**: Bank account connections
|
|
510
|
-
* - Secure bank authentication via Plaid Link
|
|
511
|
-
* - Transaction history and balances
|
|
512
|
-
* - Multi-account support
|
|
513
|
-
*
|
|
514
|
-
* No credits are consumed for viewing connection options.
|
|
515
|
-
*/
|
|
516
|
-
export const getConnectionOptions = <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => (options.client ?? client).get<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError>({
|
|
517
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
518
|
-
url: '/v1/graphs/{graph_id}/connections/options',
|
|
519
|
-
...options
|
|
520
|
-
});
|
|
521
|
-
|
|
522
|
-
/**
|
|
523
|
-
* Exchange Link Token
|
|
524
|
-
*
|
|
525
|
-
* Exchange a public token for permanent access credentials.
|
|
526
|
-
*
|
|
527
|
-
* This completes the embedded authentication flow after user authorization.
|
|
528
|
-
*
|
|
529
|
-
* The exchange process:
|
|
530
|
-
* 1. Validates the temporary public token
|
|
531
|
-
* 2. Exchanges it for permanent access credentials
|
|
532
|
-
* 3. Updates the connection with account information
|
|
533
|
-
* 4. Optionally triggers initial data sync
|
|
534
|
-
*
|
|
535
|
-
* Supported providers:
|
|
536
|
-
* - **Plaid**: Exchanges Plaid Link public token for access token
|
|
537
|
-
*
|
|
538
|
-
* Security:
|
|
539
|
-
* - Public tokens expire after 30 minutes
|
|
540
|
-
* - Each token can only be exchanged once
|
|
541
|
-
* - Full audit trail is maintained
|
|
542
|
-
*
|
|
543
|
-
* No credits are consumed for token exchange.
|
|
544
|
-
*/
|
|
545
|
-
export const exchangeLinkToken = <ThrowOnError extends boolean = false>(options: Options<ExchangeLinkTokenData, ThrowOnError>) => (options.client ?? client).post<ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, ThrowOnError>({
|
|
546
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
547
|
-
url: '/v1/graphs/{graph_id}/connections/link/exchange',
|
|
548
|
-
...options,
|
|
549
|
-
headers: {
|
|
550
|
-
'Content-Type': 'application/json',
|
|
551
|
-
...options.headers
|
|
552
|
-
}
|
|
553
|
-
});
|
|
554
|
-
|
|
555
|
-
/**
|
|
556
|
-
* Create Link Token
|
|
557
|
-
*
|
|
558
|
-
* Create a link token for embedded authentication providers.
|
|
559
|
-
*
|
|
560
|
-
* This endpoint generates a temporary token used to initialize embedded authentication UI.
|
|
561
|
-
*
|
|
562
|
-
* Currently supported providers:
|
|
563
|
-
* - **Plaid**: Bank account connections with real-time transaction access
|
|
564
|
-
*
|
|
565
|
-
* The link token:
|
|
566
|
-
* - Expires after 4 hours
|
|
567
|
-
* - Is single-use only
|
|
568
|
-
* - Must be used with the matching frontend SDK
|
|
569
|
-
* - Includes user and entity context
|
|
570
|
-
*
|
|
571
|
-
* No credits are consumed for creating link tokens.
|
|
572
|
-
*/
|
|
573
|
-
export const createLinkToken = <ThrowOnError extends boolean = false>(options: Options<CreateLinkTokenData, ThrowOnError>) => (options.client ?? client).post<CreateLinkTokenResponses, CreateLinkTokenErrors, ThrowOnError>({
|
|
574
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
575
|
-
url: '/v1/graphs/{graph_id}/connections/link/token',
|
|
576
|
-
...options,
|
|
577
|
-
headers: {
|
|
578
|
-
'Content-Type': 'application/json',
|
|
579
|
-
...options.headers
|
|
580
|
-
}
|
|
581
|
-
});
|
|
582
|
-
|
|
583
|
-
/**
|
|
584
|
-
* Init Oauth
|
|
585
|
-
*
|
|
586
|
-
* Initialize OAuth flow for a connection.
|
|
587
|
-
*
|
|
588
|
-
* This generates an authorization URL that the frontend should redirect the user to.
|
|
589
|
-
* Currently supports: QuickBooks
|
|
590
|
-
*/
|
|
591
|
-
export const initOAuth = <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => (options.client ?? client).post<InitOAuthResponses, InitOAuthErrors, ThrowOnError>({
|
|
592
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
593
|
-
url: '/v1/graphs/{graph_id}/connections/oauth/init',
|
|
594
|
-
...options,
|
|
595
|
-
headers: {
|
|
596
|
-
'Content-Type': 'application/json',
|
|
597
|
-
...options.headers
|
|
598
|
-
}
|
|
599
|
-
});
|
|
600
|
-
|
|
601
|
-
/**
|
|
602
|
-
* OAuth Callback
|
|
603
|
-
*
|
|
604
|
-
* Handle OAuth callback from provider after user authorization.
|
|
605
|
-
*
|
|
606
|
-
* This endpoint completes the OAuth flow:
|
|
607
|
-
* 1. Validates the OAuth state parameter
|
|
608
|
-
* 2. Exchanges authorization code for access tokens
|
|
609
|
-
* 3. Stores tokens securely
|
|
610
|
-
* 4. Updates connection status
|
|
611
|
-
* 5. Optionally triggers initial sync
|
|
612
|
-
*
|
|
613
|
-
* Supported providers:
|
|
614
|
-
* - **QuickBooks**: Accounting data integration
|
|
615
|
-
*
|
|
616
|
-
* Security measures:
|
|
617
|
-
* - State validation prevents session hijacking
|
|
618
|
-
* - User context is verified
|
|
619
|
-
* - Tokens are encrypted before storage
|
|
620
|
-
* - Full audit trail is maintained
|
|
621
|
-
*
|
|
622
|
-
* No credits are consumed for OAuth callbacks.
|
|
623
|
-
*/
|
|
624
|
-
export const oauthCallback = <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => (options.client ?? client).post<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError>({
|
|
625
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
626
|
-
url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
|
|
627
|
-
...options,
|
|
628
|
-
headers: {
|
|
629
|
-
'Content-Type': 'application/json',
|
|
630
|
-
...options.headers
|
|
631
|
-
}
|
|
632
|
-
});
|
|
633
|
-
|
|
634
|
-
/**
|
|
635
|
-
* Delete Connection
|
|
636
|
-
*
|
|
637
|
-
* Delete a data connection and clean up related resources.
|
|
638
|
-
*
|
|
639
|
-
* This operation:
|
|
640
|
-
* - Removes the connection configuration
|
|
641
|
-
* - Preserves any imported data in the graph
|
|
642
|
-
* - Performs provider-specific cleanup
|
|
643
|
-
* - Revokes stored credentials
|
|
644
|
-
*
|
|
645
|
-
* Note:
|
|
646
|
-
* This operation is included - no credit consumption required.
|
|
647
|
-
*
|
|
648
|
-
* Only users with admin role can delete connections.
|
|
649
|
-
*/
|
|
650
|
-
export const deleteConnection = <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => (options.client ?? client).delete<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError>({
|
|
651
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
652
|
-
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
653
|
-
...options
|
|
654
|
-
});
|
|
655
|
-
|
|
656
|
-
/**
|
|
657
|
-
* Get Connection
|
|
658
|
-
*
|
|
659
|
-
* Get detailed information about a specific connection.
|
|
660
|
-
*
|
|
661
|
-
* Returns comprehensive connection details including:
|
|
662
|
-
* - Current status and health indicators
|
|
663
|
-
* - Authentication state
|
|
664
|
-
* - Sync history and statistics
|
|
665
|
-
* - Error details if any
|
|
666
|
-
* - Provider-specific metadata
|
|
667
|
-
*
|
|
668
|
-
* No credits are consumed for viewing connection details.
|
|
669
|
-
*/
|
|
670
|
-
export const getConnection = <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => (options.client ?? client).get<GetConnectionResponses, GetConnectionErrors, ThrowOnError>({
|
|
671
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
672
|
-
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
673
|
-
...options
|
|
674
|
-
});
|
|
675
|
-
|
|
676
|
-
/**
|
|
677
|
-
* Sync Connection
|
|
678
|
-
*
|
|
679
|
-
* Trigger a data synchronization for the connection.
|
|
680
|
-
*
|
|
681
|
-
* Initiates data sync based on provider type:
|
|
682
|
-
*
|
|
683
|
-
* **SEC Sync**:
|
|
684
|
-
* - Downloads latest filings from EDGAR
|
|
685
|
-
* - Parses XBRL data and updates graph
|
|
686
|
-
* - Typically completes in 5-10 minutes
|
|
687
|
-
*
|
|
688
|
-
* **QuickBooks Sync**:
|
|
689
|
-
* - Fetches latest transactions and balances
|
|
690
|
-
* - Updates chart of accounts
|
|
691
|
-
* - Generates fresh trial balance
|
|
692
|
-
* - Duration depends on data volume
|
|
693
|
-
*
|
|
694
|
-
* **Plaid Sync**:
|
|
695
|
-
* - Retrieves recent bank transactions
|
|
696
|
-
* - Updates account balances
|
|
697
|
-
* - Categorizes new transactions
|
|
698
|
-
*
|
|
699
|
-
* Note:
|
|
700
|
-
* This operation is included - no credit consumption required.
|
|
701
|
-
*
|
|
702
|
-
* Returns a task ID for monitoring sync progress.
|
|
703
|
-
*/
|
|
704
|
-
export const syncConnection = <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => (options.client ?? client).post<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError>({
|
|
705
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
706
|
-
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
|
|
707
|
-
...options,
|
|
708
|
-
headers: {
|
|
709
|
-
'Content-Type': 'application/json',
|
|
710
|
-
...options.headers
|
|
711
|
-
}
|
|
712
|
-
});
|
|
713
|
-
|
|
714
433
|
/**
|
|
715
434
|
* List available agents
|
|
716
435
|
*
|
|
@@ -1672,6 +1391,7 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
1672
1391
|
* - **Backup Limits**: Frequency, retention, size limits
|
|
1673
1392
|
* - **Rate Limits**: Requests per minute/hour based on tier
|
|
1674
1393
|
* - **Credit Limits**: AI operation credits (if applicable)
|
|
1394
|
+
* - **Content Limits**: Node, relationship, and row limits (if applicable)
|
|
1675
1395
|
*
|
|
1676
1396
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1677
1397
|
*
|
|
@@ -2011,79 +1731,6 @@ export const queryTables = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2011
1731
|
}
|
|
2012
1732
|
});
|
|
2013
1733
|
|
|
2014
|
-
/**
|
|
2015
|
-
* Create View
|
|
2016
|
-
*
|
|
2017
|
-
* Generate financial report view from data source (dual-mode support).
|
|
2018
|
-
*
|
|
2019
|
-
* **Mode 1: Transaction Aggregation (generate_from_transactions)**
|
|
2020
|
-
* - Aggregates raw transaction data to trial balance
|
|
2021
|
-
* - Creates facts on-demand
|
|
2022
|
-
* - Shows real-time reporting from source of truth
|
|
2023
|
-
*
|
|
2024
|
-
* **Mode 2: Existing Facts (pivot_existing_facts)**
|
|
2025
|
-
* - Queries existing Fact nodes
|
|
2026
|
-
* - Supports multi-dimensional analysis
|
|
2027
|
-
* - Works with SEC filings and pre-computed facts
|
|
2028
|
-
*
|
|
2029
|
-
* Both modes:
|
|
2030
|
-
* - Build FactGrid from data
|
|
2031
|
-
* - Generate pivot table presentation
|
|
2032
|
-
* - Return consistent response format
|
|
2033
|
-
*/
|
|
2034
|
-
export const createView = <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => (options.client ?? client).post<CreateViewResponses, CreateViewErrors, ThrowOnError>({
|
|
2035
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2036
|
-
url: '/v1/graphs/{graph_id}/views',
|
|
2037
|
-
...options,
|
|
2038
|
-
headers: {
|
|
2039
|
-
'Content-Type': 'application/json',
|
|
2040
|
-
...options.headers
|
|
2041
|
-
}
|
|
2042
|
-
});
|
|
2043
|
-
|
|
2044
|
-
/**
|
|
2045
|
-
* Save View
|
|
2046
|
-
*
|
|
2047
|
-
* Save or update view as materialized report in the graph.
|
|
2048
|
-
*
|
|
2049
|
-
* Converts computed view results into persistent Report, Fact, and Structure nodes.
|
|
2050
|
-
* This establishes what data exists in the subgraph, which then defines what
|
|
2051
|
-
* needs to be exported for publishing to the parent graph.
|
|
2052
|
-
*
|
|
2053
|
-
* **Create Mode** (no report_id provided):
|
|
2054
|
-
* - Generates new report_id from entity + period + report type
|
|
2055
|
-
* - Creates new Report, Facts, and Structures
|
|
2056
|
-
*
|
|
2057
|
-
* **Update Mode** (report_id provided):
|
|
2058
|
-
* - Deletes all existing Facts and Structures for the report
|
|
2059
|
-
* - Updates Report metadata
|
|
2060
|
-
* - Creates fresh Facts and Structures from current view
|
|
2061
|
-
* - Useful for refreshing reports with updated data or view configurations
|
|
2062
|
-
*
|
|
2063
|
-
* **This is NOT publishing** - it only creates nodes in the subgraph workspace.
|
|
2064
|
-
* Publishing (export → parquet → parent ingest) happens separately.
|
|
2065
|
-
*
|
|
2066
|
-
* Creates/Updates:
|
|
2067
|
-
* - Report node with metadata
|
|
2068
|
-
* - Fact nodes with all aspects (period, entity, element, unit)
|
|
2069
|
-
* - PresentationStructure nodes (how facts are displayed)
|
|
2070
|
-
* - CalculationStructure nodes (how facts roll up)
|
|
2071
|
-
*
|
|
2072
|
-
* Returns:
|
|
2073
|
-
* - report_id: Unique identifier used as parquet export prefix
|
|
2074
|
-
* - parquet_export_prefix: Filename prefix for future exports
|
|
2075
|
-
* - All created facts and structures
|
|
2076
|
-
*/
|
|
2077
|
-
export const saveView = <ThrowOnError extends boolean = false>(options: Options<SaveViewData, ThrowOnError>) => (options.client ?? client).post<SaveViewResponses, SaveViewErrors, ThrowOnError>({
|
|
2078
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
2079
|
-
url: '/v1/graphs/{graph_id}/views/save',
|
|
2080
|
-
...options,
|
|
2081
|
-
headers: {
|
|
2082
|
-
'Content-Type': 'application/json',
|
|
2083
|
-
...options.headers
|
|
2084
|
-
}
|
|
2085
|
-
});
|
|
2086
|
-
|
|
2087
1734
|
/**
|
|
2088
1735
|
* Get Materialization Status
|
|
2089
1736
|
*
|
|
@@ -2170,6 +1817,10 @@ export const getMaterializationStatus = <ThrowOnError extends boolean = false>(o
|
|
|
2170
1817
|
* Full graph materialization can take minutes for large datasets. Consider running
|
|
2171
1818
|
* during off-peak hours for production systems.
|
|
2172
1819
|
*
|
|
1820
|
+
* **Dry Run:**
|
|
1821
|
+
* Set `dry_run=true` to validate limits without executing. Returns current usage, tier limits,
|
|
1822
|
+
* and any warnings or errors. No lock is acquired, no SSE operation is created.
|
|
1823
|
+
*
|
|
2173
1824
|
* **Credits:**
|
|
2174
1825
|
* Materialization is included - no credit consumption
|
|
2175
1826
|
*/
|
|
@@ -2580,11 +2231,9 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
|
|
|
2580
2231
|
* - Availability status
|
|
2581
2232
|
*
|
|
2582
2233
|
* **Available Tiers:**
|
|
2583
|
-
* - **ladybug-standard**:
|
|
2234
|
+
* - **ladybug-standard**: Dedicated entry-level tier
|
|
2584
2235
|
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
2585
2236
|
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
2586
|
-
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
2587
|
-
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
2588
2237
|
*
|
|
2589
2238
|
* **Use Cases:**
|
|
2590
2239
|
* - Display tier options in graph creation UI
|
|
@@ -2929,10 +2578,11 @@ export const createCheckoutSession = <ThrowOnError extends boolean = false>(opti
|
|
|
2929
2578
|
* **Status Values:**
|
|
2930
2579
|
* - `pending_payment`: Waiting for payment to complete
|
|
2931
2580
|
* - `provisioning`: Payment confirmed, resource being created
|
|
2932
|
-
* - `
|
|
2581
|
+
* - `active`: Resource is ready (resource_id will be set)
|
|
2933
2582
|
* - `failed`: Something went wrong (error field will be set)
|
|
2583
|
+
* - `canceled`: Payment was canceled
|
|
2934
2584
|
*
|
|
2935
|
-
* **When status is '
|
|
2585
|
+
* **When status is 'active':**
|
|
2936
2586
|
* - For graphs: `resource_id` will be the graph_id, and `operation_id` can be used to monitor SSE progress
|
|
2937
2587
|
* - For repositories: `resource_id` will be the repository name and access is immediately available
|
|
2938
2588
|
*/
|