@robosystems/client 0.2.11 → 0.2.13

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.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { Options as ClientOptions, TDataShape, Client } from './client';
2
- import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, CancelSubscriptionData, CancelSubscriptionResponses, CancelSubscriptionErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, UpdateOrgPaymentMethodData, UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
2
+ import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshAuthSessionData, RefreshAuthSessionResponses, RefreshAuthSessionErrors, ResendVerificationEmailData, ResendVerificationEmailResponses, ResendVerificationEmailErrors, VerifyEmailData, VerifyEmailResponses, VerifyEmailErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ForgotPasswordData, ForgotPasswordResponses, ForgotPasswordErrors, ValidateResetTokenData, ValidateResetTokenResponses, ValidateResetTokenErrors, ResetPasswordData, ResetPasswordResponses, ResetPasswordErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, UpdateUserData, UpdateUserResponses, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, ListUserOrgsData, ListUserOrgsResponses, CreateOrgData, CreateOrgResponses, CreateOrgErrors, GetOrgData, GetOrgResponses, GetOrgErrors, UpdateOrgData, UpdateOrgResponses, UpdateOrgErrors, ListOrgGraphsData, ListOrgGraphsResponses, ListOrgGraphsErrors, ListOrgMembersData, ListOrgMembersResponses, ListOrgMembersErrors, InviteOrgMemberData, InviteOrgMemberResponses, InviteOrgMemberErrors, RemoveOrgMemberData, RemoveOrgMemberResponses, RemoveOrgMemberErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleResponses, UpdateOrgMemberRoleErrors, GetOrgLimitsData, GetOrgLimitsResponses, GetOrgLimitsErrors, GetOrgUsageData, GetOrgUsageResponses, GetOrgUsageErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, ListAgentsData, ListAgentsResponses, ListAgentsErrors, AutoSelectAgentData, AutoSelectAgentResponses, AutoSelectAgentErrors, GetAgentMetadataData, GetAgentMetadataResponses, GetAgentMetadataErrors, ExecuteSpecificAgentData, ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, BatchProcessQueriesData, BatchProcessQueriesResponses, BatchProcessQueriesErrors, RecommendAgentData, RecommendAgentResponses, RecommendAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsResponses, GetGraphUsageAnalyticsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaData, GetGraphSchemaResponses, GetGraphSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, GetGraphLimitsData, GetGraphLimitsResponses, GetGraphLimitsErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, GetGraphSubscriptionData, GetGraphSubscriptionResponses, GetGraphSubscriptionErrors, CreateRepositorySubscriptionData, CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, UpgradeSubscriptionData, UpgradeSubscriptionResponses, UpgradeSubscriptionErrors, ListTablesData, ListTablesResponses, ListTablesErrors, ListTableFilesData, ListTableFilesResponses, ListTableFilesErrors, GetUploadUrlData, GetUploadUrlResponses, GetUploadUrlErrors, DeleteFileData, DeleteFileResponses, DeleteFileErrors, GetFileInfoData, GetFileInfoResponses, GetFileInfoErrors, UpdateFileStatusData, UpdateFileStatusResponses, UpdateFileStatusErrors, IngestTablesData, IngestTablesResponses, IngestTablesErrors, QueryTablesData, QueryTablesResponses, QueryTablesErrors, GetGraphsData, GetGraphsResponses, GetGraphsErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetAvailableExtensionsErrors, GetAvailableGraphTiersData, GetAvailableGraphTiersResponses, GetAvailableGraphTiersErrors, SelectGraphData, SelectGraphResponses, SelectGraphErrors, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors, GetOrgBillingCustomerData, GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, CreatePortalSessionData, CreatePortalSessionResponses, CreatePortalSessionErrors, ListOrgSubscriptionsData, ListOrgSubscriptionsResponses, ListOrgSubscriptionsErrors, GetOrgSubscriptionData, GetOrgSubscriptionResponses, GetOrgSubscriptionErrors, CancelOrgSubscriptionData, CancelOrgSubscriptionResponses, CancelOrgSubscriptionErrors, ListOrgInvoicesData, ListOrgInvoicesResponses, ListOrgInvoicesErrors, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceResponses, GetOrgUpcomingInvoiceErrors, CreateCheckoutSessionData, CreateCheckoutSessionResponses, CreateCheckoutSessionErrors, GetCheckoutStatusData, GetCheckoutStatusResponses, GetCheckoutStatusErrors } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -392,9 +392,22 @@ export declare const getConnection: <ThrowOnError extends boolean = false>(optio
392
392
  * Returns a task ID for monitoring sync progress.
393
393
  */
394
394
  export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
395
+ /**
396
+ * List available agents
397
+ * Get a comprehensive list of all available agents with their metadata.
398
+ *
399
+ * **Returns:**
400
+ * - Agent types and names
401
+ * - Capabilities and supported modes
402
+ * - Version information
403
+ * - Credit requirements
404
+ *
405
+ * Use the optional `capability` filter to find agents with specific capabilities.
406
+ */
407
+ export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => import("./client").RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, "fields">;
395
408
  /**
396
409
  * Auto-select agent for query
397
- * Automatically select the best agent for your query.
410
+ * Automatically select the best agent for your query with intelligent execution strategy.
398
411
  *
399
412
  * **Agent Selection Process:**
400
413
  *
@@ -403,7 +416,8 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
403
416
  * 2. Enriching context with RAG if enabled
404
417
  * 3. Evaluating all available agents against selection criteria
405
418
  * 4. Selecting the best match based on confidence scores
406
- * 5. Executing the query with the selected agent
419
+ * 5. Choosing execution strategy (sync/SSE/async) based on expected time
420
+ * 6. Executing the query with the selected agent
407
421
  *
408
422
  * **Available Agent Types:**
409
423
  * - `financial`: Financial analysis, SEC filings, company metrics
@@ -416,6 +430,14 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
416
430
  * - `extended`: Comprehensive analysis (~15-60s), deep research
417
431
  * - `streaming`: Real-time response streaming
418
432
  *
433
+ * **Execution Strategies (automatic):**
434
+ * - Fast operations (<5s): Immediate synchronous response
435
+ * - Medium operations (5-30s): SSE streaming with progress updates
436
+ * - Long operations (>30s): Async Celery worker with operation tracking
437
+ *
438
+ * **Response Mode Override:**
439
+ * Use query parameter `?mode=sync|async` to override automatic strategy selection.
440
+ *
419
441
  * **Confidence Score Interpretation:**
420
442
  * - `0.9-1.0`: High confidence, agent is ideal match
421
443
  * - `0.7-0.9`: Good confidence, agent is suitable
@@ -438,15 +460,38 @@ export declare const syncConnection: <ThrowOnError extends boolean = false>(opti
438
460
  * See request/response examples in the "Examples" dropdown below.
439
461
  */
440
462
  export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
463
+ /**
464
+ * Get agent metadata
465
+ * Get comprehensive metadata for a specific agent type.
466
+ *
467
+ * **Returns:**
468
+ * - Agent name and description
469
+ * - Version information
470
+ * - Supported capabilities and modes
471
+ * - Credit requirements
472
+ * - Author and tags
473
+ * - Configuration options
474
+ *
475
+ * Use this to understand agent capabilities before execution.
476
+ */
477
+ export declare const getAgentMetadata: <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => import("./client").RequestResult<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError, "fields">;
441
478
  /**
442
479
  * Execute specific agent
443
- * Execute a specific agent type directly.
480
+ * Execute a specific agent type directly with intelligent execution strategy.
444
481
  *
445
482
  * Available agents:
446
483
  * - **financial**: Financial analysis, SEC filings, accounting data
447
484
  * - **research**: Deep research and comprehensive analysis
448
485
  * - **rag**: Fast retrieval without AI (no credits required)
449
486
  *
487
+ * **Execution Strategies (automatic):**
488
+ * - Fast operations (<5s): Immediate synchronous response
489
+ * - Medium operations (5-30s): SSE streaming with progress updates
490
+ * - Long operations (>30s): Async Celery worker with operation tracking
491
+ *
492
+ * **Response Mode Override:**
493
+ * Use query parameter `?mode=sync|async` to override automatic strategy selection.
494
+ *
450
495
  * Use this endpoint when you know which agent you want to use.
451
496
  */
452
497
  export declare const executeSpecificAgent: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, ThrowOnError, "fields">;
@@ -468,34 +513,6 @@ export declare const executeSpecificAgent: <ThrowOnError extends boolean = false
468
513
  * Returns individual results for each query with execution metrics.
469
514
  */
470
515
  export declare const batchProcessQueries: <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => import("./client").RequestResult<BatchProcessQueriesResponses, BatchProcessQueriesErrors, ThrowOnError, "fields">;
471
- /**
472
- * List available agents
473
- * Get a comprehensive list of all available agents with their metadata.
474
- *
475
- * **Returns:**
476
- * - Agent types and names
477
- * - Capabilities and supported modes
478
- * - Version information
479
- * - Credit requirements
480
- *
481
- * Use the optional `capability` filter to find agents with specific capabilities.
482
- */
483
- export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => import("./client").RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, "fields">;
484
- /**
485
- * Get agent metadata
486
- * Get comprehensive metadata for a specific agent type.
487
- *
488
- * **Returns:**
489
- * - Agent name and description
490
- * - Version information
491
- * - Supported capabilities and modes
492
- * - Credit requirements
493
- * - Author and tags
494
- * - Configuration options
495
- *
496
- * Use this to understand agent capabilities before execution.
497
- */
498
- export declare const getAgentMetadata: <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => import("./client").RequestResult<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError, "fields">;
499
516
  /**
500
517
  * Get agent recommendations
501
518
  * Get intelligent agent recommendations for a specific query.
@@ -1112,7 +1129,7 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
1112
1129
  * - Valid authentication
1113
1130
  * - Parent graph must exist and be accessible to the user
1114
1131
  * - User must have 'admin' permission on the parent graph
1115
- * - Parent graph tier must support subgraphs (Enterprise or Premium only)
1132
+ * - Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
1116
1133
  * - Must be within subgraph quota limits
1117
1134
  * - Subgraph name must be unique within the parent graph
1118
1135
  *
@@ -1138,8 +1155,8 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
1138
1155
  * All data in the subgraph will be lost.
1139
1156
  *
1140
1157
  * **Backup Location:**
1141
- * If backup requested, stored in S3 at:
1142
- * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
1158
+ * If backup requested, stored in S3 Kuzu database bucket at:
1159
+ * `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
1143
1160
  */
1144
1161
  export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
1145
1162
  /**
@@ -1186,16 +1203,6 @@ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(opt
1186
1203
  * Individual subgraph sizes shown in list endpoint.
1187
1204
  */
1188
1205
  export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
1189
- /**
1190
- * Cancel Subscription
1191
- * Cancel a subscription.
1192
- *
1193
- * For shared repositories: Cancels the user's personal subscription
1194
- * For user graphs: Not allowed - delete the graph instead
1195
- *
1196
- * The subscription will be marked as canceled and will end at the current period end date.
1197
- */
1198
- export declare const cancelSubscription: <ThrowOnError extends boolean = false>(options: Options<CancelSubscriptionData, ThrowOnError>) => import("./client").RequestResult<CancelSubscriptionResponses, CancelSubscriptionErrors, ThrowOnError, "fields">;
1199
1206
  /**
1200
1207
  * Get Subscription
1201
1208
  * Get subscription details for a graph or shared repository.
@@ -1874,15 +1881,22 @@ export declare const cancelOperation: <ThrowOnError extends boolean = false>(opt
1874
1881
  */
1875
1882
  export declare const getOrgBillingCustomer: <ThrowOnError extends boolean = false>(options: Options<GetOrgBillingCustomerData, ThrowOnError>) => import("./client").RequestResult<GetOrgBillingCustomerResponses, GetOrgBillingCustomerErrors, ThrowOnError, "fields">;
1876
1883
  /**
1877
- * Update Organization Default Payment Method
1878
- * Update the default payment method for the organization.
1884
+ * Create Customer Portal Session
1885
+ * Create a Stripe Customer Portal session for managing payment methods.
1886
+ *
1887
+ * The portal allows users to:
1888
+ * - Add new payment methods
1889
+ * - Remove existing payment methods
1890
+ * - Update default payment method
1891
+ * - View billing history
1879
1892
  *
1880
- * This changes which payment method will be used for future subscription charges.
1893
+ * The user will be redirected to Stripe's hosted portal page and returned to the billing page when done.
1881
1894
  *
1882
1895
  * **Requirements:**
1883
1896
  * - User must be an OWNER of the organization
1897
+ * - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
1884
1898
  */
1885
- export declare const updateOrgPaymentMethod: <ThrowOnError extends boolean = false>(options: Options<UpdateOrgPaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdateOrgPaymentMethodResponses, UpdateOrgPaymentMethodErrors, ThrowOnError, "fields">;
1899
+ export declare const createPortalSession: <ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>) => import("./client").RequestResult<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError, "fields">;
1886
1900
  /**
1887
1901
  * List Organization Subscriptions
1888
1902
  * List all active and past subscriptions for an organization.
package/sdk/sdk.gen.js CHANGED
@@ -1,9 +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.getAgentMetadata = exports.listAgents = exports.batchProcessQueries = exports.executeSpecificAgent = exports.autoSelectAgent = 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.updateOrgPaymentMethod = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.queryTables = exports.ingestTables = exports.updateFileStatus = exports.getFileInfo = exports.deleteFile = exports.getUploadUrl = exports.listTableFiles = exports.listTables = exports.upgradeSubscription = exports.createRepositorySubscription = exports.getGraphSubscription = exports.cancelSubscription = 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 = void 0;
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.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.queryTables = exports.ingestTables = exports.updateFileStatus = exports.getFileInfo = exports.deleteFile = exports.getUploadUrl = exports.listTableFiles = 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 = void 0;
7
7
  const client_gen_1 = require("./client.gen");
8
8
  /**
9
9
  * Register New User
@@ -1022,9 +1022,38 @@ const syncConnection = (options) => {
1022
1022
  });
1023
1023
  };
1024
1024
  exports.syncConnection = syncConnection;
1025
+ /**
1026
+ * List available agents
1027
+ * Get a comprehensive list of all available agents with their metadata.
1028
+ *
1029
+ * **Returns:**
1030
+ * - Agent types and names
1031
+ * - Capabilities and supported modes
1032
+ * - Version information
1033
+ * - Credit requirements
1034
+ *
1035
+ * Use the optional `capability` filter to find agents with specific capabilities.
1036
+ */
1037
+ const listAgents = (options) => {
1038
+ return (options.client ?? client_gen_1.client).get({
1039
+ security: [
1040
+ {
1041
+ name: 'X-API-Key',
1042
+ type: 'apiKey'
1043
+ },
1044
+ {
1045
+ scheme: 'bearer',
1046
+ type: 'http'
1047
+ }
1048
+ ],
1049
+ url: '/v1/graphs/{graph_id}/agent',
1050
+ ...options
1051
+ });
1052
+ };
1053
+ exports.listAgents = listAgents;
1025
1054
  /**
1026
1055
  * Auto-select agent for query
1027
- * Automatically select the best agent for your query.
1056
+ * Automatically select the best agent for your query with intelligent execution strategy.
1028
1057
  *
1029
1058
  * **Agent Selection Process:**
1030
1059
  *
@@ -1033,7 +1062,8 @@ exports.syncConnection = syncConnection;
1033
1062
  * 2. Enriching context with RAG if enabled
1034
1063
  * 3. Evaluating all available agents against selection criteria
1035
1064
  * 4. Selecting the best match based on confidence scores
1036
- * 5. Executing the query with the selected agent
1065
+ * 5. Choosing execution strategy (sync/SSE/async) based on expected time
1066
+ * 6. Executing the query with the selected agent
1037
1067
  *
1038
1068
  * **Available Agent Types:**
1039
1069
  * - `financial`: Financial analysis, SEC filings, company metrics
@@ -1046,6 +1076,14 @@ exports.syncConnection = syncConnection;
1046
1076
  * - `extended`: Comprehensive analysis (~15-60s), deep research
1047
1077
  * - `streaming`: Real-time response streaming
1048
1078
  *
1079
+ * **Execution Strategies (automatic):**
1080
+ * - Fast operations (<5s): Immediate synchronous response
1081
+ * - Medium operations (5-30s): SSE streaming with progress updates
1082
+ * - Long operations (>30s): Async Celery worker with operation tracking
1083
+ *
1084
+ * **Response Mode Override:**
1085
+ * Use query parameter `?mode=sync|async` to override automatic strategy selection.
1086
+ *
1049
1087
  * **Confidence Score Interpretation:**
1050
1088
  * - `0.9-1.0`: High confidence, agent is ideal match
1051
1089
  * - `0.7-0.9`: Good confidence, agent is suitable
@@ -1088,15 +1126,54 @@ const autoSelectAgent = (options) => {
1088
1126
  });
1089
1127
  };
1090
1128
  exports.autoSelectAgent = autoSelectAgent;
1129
+ /**
1130
+ * Get agent metadata
1131
+ * Get comprehensive metadata for a specific agent type.
1132
+ *
1133
+ * **Returns:**
1134
+ * - Agent name and description
1135
+ * - Version information
1136
+ * - Supported capabilities and modes
1137
+ * - Credit requirements
1138
+ * - Author and tags
1139
+ * - Configuration options
1140
+ *
1141
+ * Use this to understand agent capabilities before execution.
1142
+ */
1143
+ const getAgentMetadata = (options) => {
1144
+ return (options.client ?? client_gen_1.client).get({
1145
+ security: [
1146
+ {
1147
+ name: 'X-API-Key',
1148
+ type: 'apiKey'
1149
+ },
1150
+ {
1151
+ scheme: 'bearer',
1152
+ type: 'http'
1153
+ }
1154
+ ],
1155
+ url: '/v1/graphs/{graph_id}/agent/{agent_type}',
1156
+ ...options
1157
+ });
1158
+ };
1159
+ exports.getAgentMetadata = getAgentMetadata;
1091
1160
  /**
1092
1161
  * Execute specific agent
1093
- * Execute a specific agent type directly.
1162
+ * Execute a specific agent type directly with intelligent execution strategy.
1094
1163
  *
1095
1164
  * Available agents:
1096
1165
  * - **financial**: Financial analysis, SEC filings, accounting data
1097
1166
  * - **research**: Deep research and comprehensive analysis
1098
1167
  * - **rag**: Fast retrieval without AI (no credits required)
1099
1168
  *
1169
+ * **Execution Strategies (automatic):**
1170
+ * - Fast operations (<5s): Immediate synchronous response
1171
+ * - Medium operations (5-30s): SSE streaming with progress updates
1172
+ * - Long operations (>30s): Async Celery worker with operation tracking
1173
+ *
1174
+ * **Response Mode Override:**
1175
+ * Use query parameter `?mode=sync|async` to override automatic strategy selection.
1176
+ *
1100
1177
  * Use this endpoint when you know which agent you want to use.
1101
1178
  */
1102
1179
  const executeSpecificAgent = (options) => {
@@ -1158,66 +1235,6 @@ const batchProcessQueries = (options) => {
1158
1235
  });
1159
1236
  };
1160
1237
  exports.batchProcessQueries = batchProcessQueries;
1161
- /**
1162
- * List available agents
1163
- * Get a comprehensive list of all available agents with their metadata.
1164
- *
1165
- * **Returns:**
1166
- * - Agent types and names
1167
- * - Capabilities and supported modes
1168
- * - Version information
1169
- * - Credit requirements
1170
- *
1171
- * Use the optional `capability` filter to find agents with specific capabilities.
1172
- */
1173
- const listAgents = (options) => {
1174
- return (options.client ?? client_gen_1.client).get({
1175
- security: [
1176
- {
1177
- name: 'X-API-Key',
1178
- type: 'apiKey'
1179
- },
1180
- {
1181
- scheme: 'bearer',
1182
- type: 'http'
1183
- }
1184
- ],
1185
- url: '/v1/graphs/{graph_id}/agent/list',
1186
- ...options
1187
- });
1188
- };
1189
- exports.listAgents = listAgents;
1190
- /**
1191
- * Get agent metadata
1192
- * Get comprehensive metadata for a specific agent type.
1193
- *
1194
- * **Returns:**
1195
- * - Agent name and description
1196
- * - Version information
1197
- * - Supported capabilities and modes
1198
- * - Credit requirements
1199
- * - Author and tags
1200
- * - Configuration options
1201
- *
1202
- * Use this to understand agent capabilities before execution.
1203
- */
1204
- const getAgentMetadata = (options) => {
1205
- return (options.client ?? client_gen_1.client).get({
1206
- security: [
1207
- {
1208
- name: 'X-API-Key',
1209
- type: 'apiKey'
1210
- },
1211
- {
1212
- scheme: 'bearer',
1213
- type: 'http'
1214
- }
1215
- ],
1216
- url: '/v1/graphs/{graph_id}/agent/{agent_type}/metadata',
1217
- ...options
1218
- });
1219
- };
1220
- exports.getAgentMetadata = getAgentMetadata;
1221
1238
  /**
1222
1239
  * Get agent recommendations
1223
1240
  * Get intelligent agent recommendations for a specific query.
@@ -2226,7 +2243,7 @@ exports.listSubgraphs = listSubgraphs;
2226
2243
  * - Valid authentication
2227
2244
  * - Parent graph must exist and be accessible to the user
2228
2245
  * - User must have 'admin' permission on the parent graph
2229
- * - Parent graph tier must support subgraphs (Enterprise or Premium only)
2246
+ * - Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
2230
2247
  * - Must be within subgraph quota limits
2231
2248
  * - Subgraph name must be unique within the parent graph
2232
2249
  *
@@ -2272,8 +2289,8 @@ exports.createSubgraph = createSubgraph;
2272
2289
  * All data in the subgraph will be lost.
2273
2290
  *
2274
2291
  * **Backup Location:**
2275
- * If backup requested, stored in S3 at:
2276
- * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
2292
+ * If backup requested, stored in S3 Kuzu database bucket at:
2293
+ * `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
2277
2294
  */
2278
2295
  const deleteSubgraph = (options) => {
2279
2296
  return (options.client ?? client_gen_1.client).delete({
@@ -2372,32 +2389,6 @@ const getSubgraphQuota = (options) => {
2372
2389
  });
2373
2390
  };
2374
2391
  exports.getSubgraphQuota = getSubgraphQuota;
2375
- /**
2376
- * Cancel Subscription
2377
- * Cancel a subscription.
2378
- *
2379
- * For shared repositories: Cancels the user's personal subscription
2380
- * For user graphs: Not allowed - delete the graph instead
2381
- *
2382
- * The subscription will be marked as canceled and will end at the current period end date.
2383
- */
2384
- const cancelSubscription = (options) => {
2385
- return (options.client ?? client_gen_1.client).delete({
2386
- security: [
2387
- {
2388
- name: 'X-API-Key',
2389
- type: 'apiKey'
2390
- },
2391
- {
2392
- scheme: 'bearer',
2393
- type: 'http'
2394
- }
2395
- ],
2396
- url: '/v1/graphs/{graph_id}/subscriptions',
2397
- ...options
2398
- });
2399
- };
2400
- exports.cancelSubscription = cancelSubscription;
2401
2392
  /**
2402
2393
  * Get Subscription
2403
2394
  * Get subscription details for a graph or shared repository.
@@ -3430,15 +3421,22 @@ const getOrgBillingCustomer = (options) => {
3430
3421
  };
3431
3422
  exports.getOrgBillingCustomer = getOrgBillingCustomer;
3432
3423
  /**
3433
- * Update Organization Default Payment Method
3434
- * Update the default payment method for the organization.
3424
+ * Create Customer Portal Session
3425
+ * Create a Stripe Customer Portal session for managing payment methods.
3426
+ *
3427
+ * The portal allows users to:
3428
+ * - Add new payment methods
3429
+ * - Remove existing payment methods
3430
+ * - Update default payment method
3431
+ * - View billing history
3435
3432
  *
3436
- * This changes which payment method will be used for future subscription charges.
3433
+ * The user will be redirected to Stripe's hosted portal page and returned to the billing page when done.
3437
3434
  *
3438
3435
  * **Requirements:**
3439
3436
  * - User must be an OWNER of the organization
3437
+ * - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
3440
3438
  */
3441
- const updateOrgPaymentMethod = (options) => {
3439
+ const createPortalSession = (options) => {
3442
3440
  return (options.client ?? client_gen_1.client).post({
3443
3441
  security: [
3444
3442
  {
@@ -3450,15 +3448,11 @@ const updateOrgPaymentMethod = (options) => {
3450
3448
  type: 'http'
3451
3449
  }
3452
3450
  ],
3453
- url: '/v1/billing/customer/{org_id}/payment-method',
3454
- ...options,
3455
- headers: {
3456
- 'Content-Type': 'application/json',
3457
- ...options.headers
3458
- }
3451
+ url: '/v1/billing/customer/{org_id}/portal',
3452
+ ...options
3459
3453
  });
3460
3454
  };
3461
- exports.updateOrgPaymentMethod = updateOrgPaymentMethod;
3455
+ exports.createPortalSession = createPortalSession;
3462
3456
  /**
3463
3457
  * List Organization Subscriptions
3464
3458
  * List all active and past subscriptions for an organization.