@robosystems/client 0.1.19 → 0.1.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/sdk.gen.js CHANGED
@@ -1,8 +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.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.queryFinancialAgent = exports.oauthCallback = exports.initOAuth = exports.exchangeLinkToken = exports.createLinkToken = exports.syncConnection = exports.getConnectionOptions = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.listConnections = exports.getRepositoryCredits = exports.getSharedRepositoryCredits = exports.cancelSharedRepositorySubscription = exports.upgradeSharedRepositorySubscription = exports.subscribeToSharedRepository = exports.getUserSharedSubscriptions = exports.getDetailedUserAnalytics = exports.getUserUsageOverview = exports.getSharedRepositoryLimits = exports.getAllSharedRepositoryLimits = exports.getUserUsage = exports.getUserLimits = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.getAllCreditSummaries = exports.selectUserGraph = exports.getUserGraphs = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.completeSsoAuth = exports.ssoTokenExchange = exports.ssoLogin = exports.generateSsoToken = exports.refreshSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
5
- exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.getAvailableExtensions = exports.createGraph = exports.copyDataToGraph = 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.getGraphMonthlyBill = exports.getGraphBillingHistory = exports.getGraphUsageDetails = exports.getCurrentGraphBill = exports.listSchemaExtensions = exports.exportGraphSchema = exports.validateSchema = exports.getGraphSchemaInfo = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.exportBackup = void 0;
4
+ exports.getAgentMetadata = exports.listAgents = exports.batchProcessQueries = exports.executeSpecificAgent = exports.autoSelectAgent = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.listConnections = exports.oauthCallback = exports.initOAuth = exports.exchangeLinkToken = exports.createLinkToken = exports.syncConnection = exports.getConnectionOptions = exports.getRepositoryCredits = exports.getSharedRepositoryCredits = exports.cancelSharedRepositorySubscription = exports.upgradeSharedRepositorySubscription = exports.subscribeToSharedRepository = exports.getUserSharedSubscriptions = exports.getDetailedUserAnalytics = exports.getUserUsageOverview = exports.getSharedRepositoryLimits = exports.getAllSharedRepositoryLimits = exports.getUserUsage = exports.getUserLimits = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.getAllCreditSummaries = exports.selectUserGraph = exports.getUserGraphs = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.completeSsoAuth = exports.ssoTokenExchange = exports.ssoLogin = exports.generateSsoToken = exports.refreshSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
5
+ exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.getAvailableExtensions = exports.createGraph = exports.copyDataToGraph = 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.getGraphMonthlyBill = exports.getGraphBillingHistory = exports.getGraphUsageDetails = exports.getCurrentGraphBill = exports.listSchemaExtensions = exports.exportGraphSchema = exports.validateSchema = exports.getGraphSchemaInfo = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.exportBackup = exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = void 0;
6
6
  const client_gen_1 = require("./client.gen");
7
7
  /**
8
8
  * Register New User
@@ -671,147 +671,6 @@ const getRepositoryCredits = (options) => {
671
671
  });
672
672
  };
673
673
  exports.getRepositoryCredits = getRepositoryCredits;
674
- /**
675
- * List Connections
676
- * List all data connections in the graph.
677
- *
678
- * Returns active and inactive connections with their current status.
679
- * Connections can be filtered by:
680
- * - **Entity**: Show connections for a specific entity
681
- * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
682
- *
683
- * Each connection shows:
684
- * - Current sync status and health
685
- * - Last successful sync timestamp
686
- * - Configuration metadata
687
- * - Error messages if any
688
- *
689
- * No credits are consumed for listing connections.
690
- */
691
- const listConnections = (options) => {
692
- return (options.client ?? client_gen_1.client).get({
693
- security: [
694
- {
695
- name: 'X-API-Key',
696
- type: 'apiKey'
697
- },
698
- {
699
- scheme: 'bearer',
700
- type: 'http'
701
- }
702
- ],
703
- url: '/v1/{graph_id}/connections',
704
- ...options
705
- });
706
- };
707
- exports.listConnections = listConnections;
708
- /**
709
- * Create Connection
710
- * Create a new data connection for external system integration.
711
- *
712
- * This endpoint initiates connections to external data sources:
713
- *
714
- * **SEC Connections**:
715
- * - Provide entity CIK for automatic filing retrieval
716
- * - No authentication needed
717
- * - Begins immediate data sync
718
- *
719
- * **QuickBooks Connections**:
720
- * - Returns OAuth URL for authorization
721
- * - Requires admin permissions in QuickBooks
722
- * - Complete with OAuth callback
723
- *
724
- * **Plaid Connections**:
725
- * - Returns Plaid Link token
726
- * - User completes bank authentication
727
- * - Exchange public token for access
728
- *
729
- * Note:
730
- * This operation is FREE - no credit consumption required.
731
- */
732
- const createConnection = (options) => {
733
- return (options.client ?? client_gen_1.client).post({
734
- security: [
735
- {
736
- name: 'X-API-Key',
737
- type: 'apiKey'
738
- },
739
- {
740
- scheme: 'bearer',
741
- type: 'http'
742
- }
743
- ],
744
- url: '/v1/{graph_id}/connections',
745
- ...options,
746
- headers: {
747
- 'Content-Type': 'application/json',
748
- ...options.headers
749
- }
750
- });
751
- };
752
- exports.createConnection = createConnection;
753
- /**
754
- * Delete Connection
755
- * Delete a data connection and clean up related resources.
756
- *
757
- * This operation:
758
- * - Removes the connection configuration
759
- * - Preserves any imported data in the graph
760
- * - Performs provider-specific cleanup
761
- * - Revokes stored credentials
762
- *
763
- * Note:
764
- * This operation is FREE - no credit consumption required.
765
- *
766
- * Only users with admin role can delete connections.
767
- */
768
- const deleteConnection = (options) => {
769
- return (options.client ?? client_gen_1.client).delete({
770
- security: [
771
- {
772
- name: 'X-API-Key',
773
- type: 'apiKey'
774
- },
775
- {
776
- scheme: 'bearer',
777
- type: 'http'
778
- }
779
- ],
780
- url: '/v1/{graph_id}/connections/{connection_id}',
781
- ...options
782
- });
783
- };
784
- exports.deleteConnection = deleteConnection;
785
- /**
786
- * Get Connection
787
- * Get detailed information about a specific connection.
788
- *
789
- * Returns comprehensive connection details including:
790
- * - Current status and health indicators
791
- * - Authentication state
792
- * - Sync history and statistics
793
- * - Error details if any
794
- * - Provider-specific metadata
795
- *
796
- * No credits are consumed for viewing connection details.
797
- */
798
- const getConnection = (options) => {
799
- return (options.client ?? client_gen_1.client).get({
800
- security: [
801
- {
802
- name: 'X-API-Key',
803
- type: 'apiKey'
804
- },
805
- {
806
- scheme: 'bearer',
807
- type: 'http'
808
- }
809
- ],
810
- url: '/v1/{graph_id}/connections/{connection_id}',
811
- ...options
812
- });
813
- };
814
- exports.getConnection = getConnection;
815
674
  /**
816
675
  * List Connection Options
817
676
  * Get metadata about all available data connection providers.
@@ -1053,56 +912,159 @@ const oauthCallback = (options) => {
1053
912
  };
1054
913
  exports.oauthCallback = oauthCallback;
1055
914
  /**
1056
- * Query Financial Agent
1057
- * AI-powered financial analysis with direct access to graph data.
915
+ * List Connections
916
+ * List all data connections in the graph.
1058
917
  *
1059
- * This endpoint provides intelligent financial analysis using an AI agent that can:
1060
- * - Analyze entity financial statements and SEC filings
1061
- * - Review QuickBooks transactions and accounting data
1062
- * - Perform multi-period trend analysis
1063
- * - Generate insights from balance sheets and income statements
1064
- * - Answer complex financial queries with contextual understanding
918
+ * Returns active and inactive connections with their current status.
919
+ * Connections can be filtered by:
920
+ * - **Entity**: Show connections for a specific entity
921
+ * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
1065
922
  *
1066
- * **Execution Modes:**
1067
- * - **Quick Analysis** (default): Synchronous responses for simple queries (1-2 tool calls)
1068
- * - **Extended Analysis**: Asynchronous processing for complex research (returns operation_id for SSE monitoring)
923
+ * Each connection shows:
924
+ * - Current sync status and health
925
+ * - Last successful sync timestamp
926
+ * - Configuration metadata
927
+ * - Error messages if any
1069
928
  *
1070
- * **Extended Analysis Monitoring:**
1071
- * For complex queries, connect to the SSE stream for real-time progress:
1072
- * ```javascript
1073
- * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
1074
- * eventSource.onmessage = (event) => {
1075
- * const data = JSON.parse(event.data);
1076
- * console.log('Analysis:', data.message);
1077
- * };
1078
- * ```
929
+ * No credits are consumed for listing connections.
930
+ */
931
+ const listConnections = (options) => {
932
+ return (options.client ?? client_gen_1.client).get({
933
+ security: [
934
+ {
935
+ name: 'X-API-Key',
936
+ type: 'apiKey'
937
+ },
938
+ {
939
+ scheme: 'bearer',
940
+ type: 'http'
941
+ }
942
+ ],
943
+ url: '/v1/{graph_id}/connections',
944
+ ...options
945
+ });
946
+ };
947
+ exports.listConnections = listConnections;
948
+ /**
949
+ * Create Connection
950
+ * Create a new data connection for external system integration.
1079
951
  *
1080
- * **SSE Connection Limits:**
1081
- * - Maximum 5 concurrent SSE connections per user
1082
- * - Rate limited to 10 new connections per minute
1083
- * - Automatic circuit breaker for Redis failures
1084
- * - Graceful degradation with fallback to polling if SSE unavailable
952
+ * This endpoint initiates connections to external data sources:
1085
953
  *
1086
- * **Events Emitted:**
1087
- * - `operation_started`: Analysis begins
1088
- * - `operation_progress`: Tool calls, analysis steps
1089
- * - `operation_completed`: Final comprehensive analysis
1090
- * - `operation_error`: Analysis failed
954
+ * **SEC Connections**:
955
+ * - Provide entity CIK for automatic filing retrieval
956
+ * - No authentication needed
957
+ * - Begins immediate data sync
1091
958
  *
1092
- * **Error Handling:**
1093
- * - `429 Too Many Requests`: SSE connection limit exceeded
1094
- * - `503 Service Unavailable`: SSE system temporarily disabled
1095
- * - Fallback to status polling endpoint if SSE unavailable
959
+ * **QuickBooks Connections**:
960
+ * - Returns OAuth URL for authorization
961
+ * - Requires admin permissions in QuickBooks
962
+ * - Complete with OAuth callback
1096
963
  *
1097
- * **Credit Consumption:**
1098
- * - AI operations consume credits based on actual token usage
1099
- * - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
1100
- * - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
1101
- * - Credits are consumed after operation completes based on actual usage
964
+ * **Plaid Connections**:
965
+ * - Returns Plaid Link token
966
+ * - User completes bank authentication
967
+ * - Exchange public token for access
968
+ *
969
+ * Note:
970
+ * This operation is FREE - no credit consumption required.
971
+ */
972
+ const createConnection = (options) => {
973
+ return (options.client ?? client_gen_1.client).post({
974
+ security: [
975
+ {
976
+ name: 'X-API-Key',
977
+ type: 'apiKey'
978
+ },
979
+ {
980
+ scheme: 'bearer',
981
+ type: 'http'
982
+ }
983
+ ],
984
+ url: '/v1/{graph_id}/connections',
985
+ ...options,
986
+ headers: {
987
+ 'Content-Type': 'application/json',
988
+ ...options.headers
989
+ }
990
+ });
991
+ };
992
+ exports.createConnection = createConnection;
993
+ /**
994
+ * Delete Connection
995
+ * Delete a data connection and clean up related resources.
996
+ *
997
+ * This operation:
998
+ * - Removes the connection configuration
999
+ * - Preserves any imported data in the graph
1000
+ * - Performs provider-specific cleanup
1001
+ * - Revokes stored credentials
1002
+ *
1003
+ * Note:
1004
+ * This operation is FREE - no credit consumption required.
1005
+ *
1006
+ * Only users with admin role can delete connections.
1007
+ */
1008
+ const deleteConnection = (options) => {
1009
+ return (options.client ?? client_gen_1.client).delete({
1010
+ security: [
1011
+ {
1012
+ name: 'X-API-Key',
1013
+ type: 'apiKey'
1014
+ },
1015
+ {
1016
+ scheme: 'bearer',
1017
+ type: 'http'
1018
+ }
1019
+ ],
1020
+ url: '/v1/{graph_id}/connections/{connection_id}',
1021
+ ...options
1022
+ });
1023
+ };
1024
+ exports.deleteConnection = deleteConnection;
1025
+ /**
1026
+ * Get Connection
1027
+ * Get detailed information about a specific connection.
1028
+ *
1029
+ * Returns comprehensive connection details including:
1030
+ * - Current status and health indicators
1031
+ * - Authentication state
1032
+ * - Sync history and statistics
1033
+ * - Error details if any
1034
+ * - Provider-specific metadata
1035
+ *
1036
+ * No credits are consumed for viewing connection details.
1037
+ */
1038
+ const getConnection = (options) => {
1039
+ return (options.client ?? client_gen_1.client).get({
1040
+ security: [
1041
+ {
1042
+ name: 'X-API-Key',
1043
+ type: 'apiKey'
1044
+ },
1045
+ {
1046
+ scheme: 'bearer',
1047
+ type: 'http'
1048
+ }
1049
+ ],
1050
+ url: '/v1/{graph_id}/connections/{connection_id}',
1051
+ ...options
1052
+ });
1053
+ };
1054
+ exports.getConnection = getConnection;
1055
+ /**
1056
+ * Auto-select agent for query
1057
+ * Automatically select the best agent for your query.
1102
1058
  *
1103
- * The agent automatically determines query complexity or you can force extended analysis.
1059
+ * The orchestrator will:
1060
+ * 1. Enrich context with RAG if enabled
1061
+ * 2. Evaluate all available agents
1062
+ * 3. Select the best match based on confidence scores
1063
+ * 4. Execute the query with the selected agent
1064
+ *
1065
+ * Use this endpoint when you want the system to intelligently route your query.
1104
1066
  */
1105
- const queryFinancialAgent = (options) => {
1067
+ const autoSelectAgent = (options) => {
1106
1068
  return (options.client ?? client_gen_1.client).post({
1107
1069
  security: [
1108
1070
  {
@@ -1122,7 +1084,175 @@ const queryFinancialAgent = (options) => {
1122
1084
  }
1123
1085
  });
1124
1086
  };
1125
- exports.queryFinancialAgent = queryFinancialAgent;
1087
+ exports.autoSelectAgent = autoSelectAgent;
1088
+ /**
1089
+ * Execute specific agent
1090
+ * Execute a specific agent type directly.
1091
+ *
1092
+ * Available agents:
1093
+ * - **financial**: Financial analysis, SEC filings, accounting data
1094
+ * - **research**: Deep research and comprehensive analysis
1095
+ * - **rag**: Fast retrieval without AI (no credits required)
1096
+ *
1097
+ * Use this endpoint when you know which agent you want to use.
1098
+ */
1099
+ const executeSpecificAgent = (options) => {
1100
+ return (options.client ?? client_gen_1.client).post({
1101
+ security: [
1102
+ {
1103
+ name: 'X-API-Key',
1104
+ type: 'apiKey'
1105
+ },
1106
+ {
1107
+ scheme: 'bearer',
1108
+ type: 'http'
1109
+ }
1110
+ ],
1111
+ url: '/v1/{graph_id}/agent/{agent_type}',
1112
+ ...options,
1113
+ headers: {
1114
+ 'Content-Type': 'application/json',
1115
+ ...options.headers
1116
+ }
1117
+ });
1118
+ };
1119
+ exports.executeSpecificAgent = executeSpecificAgent;
1120
+ /**
1121
+ * Batch process multiple queries
1122
+ * Process multiple queries either sequentially or in parallel.
1123
+ *
1124
+ * **Features:**
1125
+ * - Process up to 10 queries in a single request
1126
+ * - Sequential or parallel execution modes
1127
+ * - Automatic error handling per query
1128
+ * - Credit checking before execution
1129
+ *
1130
+ * **Use Cases:**
1131
+ * - Bulk analysis of multiple entities
1132
+ * - Comparative analysis across queries
1133
+ * - Automated report generation
1134
+ *
1135
+ * Returns individual results for each query with execution metrics.
1136
+ */
1137
+ const batchProcessQueries = (options) => {
1138
+ return (options.client ?? client_gen_1.client).post({
1139
+ security: [
1140
+ {
1141
+ name: 'X-API-Key',
1142
+ type: 'apiKey'
1143
+ },
1144
+ {
1145
+ scheme: 'bearer',
1146
+ type: 'http'
1147
+ }
1148
+ ],
1149
+ url: '/v1/{graph_id}/agent/batch',
1150
+ ...options,
1151
+ headers: {
1152
+ 'Content-Type': 'application/json',
1153
+ ...options.headers
1154
+ }
1155
+ });
1156
+ };
1157
+ exports.batchProcessQueries = batchProcessQueries;
1158
+ /**
1159
+ * List available agents
1160
+ * Get a comprehensive list of all available agents with their metadata.
1161
+ *
1162
+ * **Returns:**
1163
+ * - Agent types and names
1164
+ * - Capabilities and supported modes
1165
+ * - Version information
1166
+ * - Credit requirements
1167
+ *
1168
+ * Use the optional `capability` filter to find agents with specific capabilities.
1169
+ */
1170
+ const listAgents = (options) => {
1171
+ return (options.client ?? client_gen_1.client).get({
1172
+ security: [
1173
+ {
1174
+ name: 'X-API-Key',
1175
+ type: 'apiKey'
1176
+ },
1177
+ {
1178
+ scheme: 'bearer',
1179
+ type: 'http'
1180
+ }
1181
+ ],
1182
+ url: '/v1/{graph_id}/agent/list',
1183
+ ...options
1184
+ });
1185
+ };
1186
+ exports.listAgents = listAgents;
1187
+ /**
1188
+ * Get agent metadata
1189
+ * Get comprehensive metadata for a specific agent type.
1190
+ *
1191
+ * **Returns:**
1192
+ * - Agent name and description
1193
+ * - Version information
1194
+ * - Supported capabilities and modes
1195
+ * - Credit requirements
1196
+ * - Author and tags
1197
+ * - Configuration options
1198
+ *
1199
+ * Use this to understand agent capabilities before execution.
1200
+ */
1201
+ const getAgentMetadata = (options) => {
1202
+ return (options.client ?? client_gen_1.client).get({
1203
+ security: [
1204
+ {
1205
+ name: 'X-API-Key',
1206
+ type: 'apiKey'
1207
+ },
1208
+ {
1209
+ scheme: 'bearer',
1210
+ type: 'http'
1211
+ }
1212
+ ],
1213
+ url: '/v1/{graph_id}/agent/{agent_type}/metadata',
1214
+ ...options
1215
+ });
1216
+ };
1217
+ exports.getAgentMetadata = getAgentMetadata;
1218
+ /**
1219
+ * Get agent recommendations
1220
+ * Get intelligent agent recommendations for a specific query.
1221
+ *
1222
+ * **How it works:**
1223
+ * 1. Analyzes query content and structure
1224
+ * 2. Evaluates agent capabilities
1225
+ * 3. Calculates confidence scores
1226
+ * 4. Returns ranked recommendations
1227
+ *
1228
+ * **Use this when:**
1229
+ * - Unsure which agent to use
1230
+ * - Need to understand agent suitability
1231
+ * - Want confidence scores for decision making
1232
+ *
1233
+ * Returns top agents ranked by confidence with explanations.
1234
+ */
1235
+ const recommendAgent = (options) => {
1236
+ return (options.client ?? client_gen_1.client).post({
1237
+ security: [
1238
+ {
1239
+ name: 'X-API-Key',
1240
+ type: 'apiKey'
1241
+ },
1242
+ {
1243
+ scheme: 'bearer',
1244
+ type: 'http'
1245
+ }
1246
+ ],
1247
+ url: '/v1/{graph_id}/agent/recommend',
1248
+ ...options,
1249
+ headers: {
1250
+ 'Content-Type': 'application/json',
1251
+ ...options.headers
1252
+ }
1253
+ });
1254
+ };
1255
+ exports.recommendAgent = recommendAgent;
1126
1256
  /**
1127
1257
  * List MCP Tools
1128
1258
  * Get available Model Context Protocol tools for graph analysis.