@robosystems/client 0.1.19 → 0.1.21
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/LICENSE +1 -1
- package/README.md +10 -423
- package/bin/create-feature +58 -55
- package/client/utils.gen.js +14 -1
- package/client/utils.gen.ts +23 -2
- package/core/bodySerializer.gen.js +3 -0
- package/core/bodySerializer.gen.ts +2 -0
- package/package.json +3 -3
- package/sdk/client/utils.gen.js +14 -1
- package/sdk/client/utils.gen.ts +23 -2
- package/sdk/core/bodySerializer.gen.js +3 -0
- package/sdk/core/bodySerializer.gen.ts +2 -0
- package/sdk/sdk.gen.d.ts +192 -129
- package/sdk/sdk.gen.js +413 -216
- package/sdk/sdk.gen.ts +412 -215
- package/sdk/types.gen.d.ts +952 -252
- package/sdk/types.gen.ts +1016 -253
- package/sdk-extensions/README.md +2 -3
- package/sdk.gen.d.ts +192 -129
- package/sdk.gen.js +413 -216
- package/sdk.gen.ts +412 -215
- package/types.gen.d.ts +952 -252
- package/types.gen.ts +1016 -253
package/sdk-extensions/README.md
CHANGED
|
@@ -879,10 +879,9 @@ See the [Contributing Guide](../../CONTRIBUTING.md) for development setup and gu
|
|
|
879
879
|
|
|
880
880
|
## 📞 Support
|
|
881
881
|
|
|
882
|
-
- **Documentation**: [docs.robosystems.ai](https://docs.robosystems.ai)
|
|
883
882
|
- **API Reference**: [api.robosystems.ai/docs](https://api.robosystems.ai/docs)
|
|
884
|
-
- **Discord**: [Join our community](https://discord.gg/
|
|
885
|
-
- **Issues**: [GitHub Issues](https://github.com/robosystems/
|
|
883
|
+
- **Discord**: [Join our community](https://discord.gg/V9vjcqstxX)
|
|
884
|
+
- **Issues**: [GitHub Issues](https://github.com/RoboFinSystems/robosystems-typescript-client/issues)
|
|
886
885
|
|
|
887
886
|
---
|
|
888
887
|
|
package/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, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors,
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, 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, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, GetCurrentUserErrors, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetUserGraphsData, GetUserGraphsResponses, GetUserGraphsErrors, SelectUserGraphData, SelectUserGraphResponses, SelectUserGraphErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, ListUserApiKeysErrors, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetUserUsageErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, 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, ExportBackupData, ExportBackupResponses, ExportBackupErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, 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, CopyDataToGraphData, CopyDataToGraphResponses, CopyDataToGraphErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } 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
|
|
@@ -30,14 +30,49 @@ export declare const loginUser: <ThrowOnError extends boolean = false>(options:
|
|
|
30
30
|
export declare const logoutUser: <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => import("./client").RequestResult<LogoutUserResponses, LogoutUserErrors, ThrowOnError, "fields">;
|
|
31
31
|
/**
|
|
32
32
|
* Get Current User
|
|
33
|
-
* Get
|
|
33
|
+
* Get the currently authenticated user.
|
|
34
34
|
*/
|
|
35
35
|
export declare const getCurrentAuthUser: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => import("./client").RequestResult<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError, "fields">;
|
|
36
36
|
/**
|
|
37
37
|
* Refresh Session
|
|
38
|
-
* Refresh
|
|
38
|
+
* Refresh authentication session with a new JWT token.
|
|
39
39
|
*/
|
|
40
|
-
export declare const
|
|
40
|
+
export declare const refreshAuthSession: <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) => import("./client").RequestResult<RefreshAuthSessionResponses, RefreshAuthSessionErrors, ThrowOnError, "fields">;
|
|
41
|
+
/**
|
|
42
|
+
* Resend Email Verification
|
|
43
|
+
* Resend verification email to the authenticated user. Rate limited to 3 per hour.
|
|
44
|
+
*/
|
|
45
|
+
export declare const resendVerificationEmail: <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationEmailData, ThrowOnError>) => import("./client").RequestResult<ResendVerificationEmailResponses, ResendVerificationEmailErrors, ThrowOnError, "fields">;
|
|
46
|
+
/**
|
|
47
|
+
* Verify Email
|
|
48
|
+
* Verify email address with token from email link. Returns JWT for auto-login.
|
|
49
|
+
*/
|
|
50
|
+
export declare const verifyEmail: <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) => import("./client").RequestResult<VerifyEmailResponses, VerifyEmailErrors, ThrowOnError, "fields">;
|
|
51
|
+
/**
|
|
52
|
+
* Get Password Policy
|
|
53
|
+
* Get current password policy requirements for frontend validation
|
|
54
|
+
*/
|
|
55
|
+
export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => import("./client").RequestResult<GetPasswordPolicyResponses, unknown, ThrowOnError, "fields">;
|
|
56
|
+
/**
|
|
57
|
+
* Check Password Strength
|
|
58
|
+
* Check password strength and get validation feedback
|
|
59
|
+
*/
|
|
60
|
+
export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => import("./client").RequestResult<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError, "fields">;
|
|
61
|
+
/**
|
|
62
|
+
* Forgot Password
|
|
63
|
+
* Request password reset email. Always returns success to prevent email enumeration.
|
|
64
|
+
*/
|
|
65
|
+
export declare const forgotPassword: <ThrowOnError extends boolean = false>(options: Options<ForgotPasswordData, ThrowOnError>) => import("./client").RequestResult<ForgotPasswordResponses, ForgotPasswordErrors, ThrowOnError, "fields">;
|
|
66
|
+
/**
|
|
67
|
+
* Validate Reset Token
|
|
68
|
+
* Check if a password reset token is valid without consuming it.
|
|
69
|
+
*/
|
|
70
|
+
export declare const validateResetToken: <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) => import("./client").RequestResult<ValidateResetTokenResponses, ValidateResetTokenErrors, ThrowOnError, "fields">;
|
|
71
|
+
/**
|
|
72
|
+
* Reset Password
|
|
73
|
+
* Reset password with token from email. Returns JWT for auto-login.
|
|
74
|
+
*/
|
|
75
|
+
export declare const resetPassword: <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) => import("./client").RequestResult<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError, "fields">;
|
|
41
76
|
/**
|
|
42
77
|
* Generate SSO Token
|
|
43
78
|
* Generate a temporary SSO token for cross-app authentication.
|
|
@@ -58,16 +93,6 @@ export declare const ssoTokenExchange: <ThrowOnError extends boolean = false>(op
|
|
|
58
93
|
* Complete SSO authentication using session ID from secure handoff.
|
|
59
94
|
*/
|
|
60
95
|
export declare const completeSsoAuth: <ThrowOnError extends boolean = false>(options: Options<CompleteSsoAuthData, ThrowOnError>) => import("./client").RequestResult<CompleteSsoAuthResponses, CompleteSsoAuthErrors, ThrowOnError, "fields">;
|
|
61
|
-
/**
|
|
62
|
-
* Get Password Policy
|
|
63
|
-
* Get current password policy requirements for frontend validation
|
|
64
|
-
*/
|
|
65
|
-
export declare const getPasswordPolicy: <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => import("./client").RequestResult<GetPasswordPolicyResponses, unknown, ThrowOnError, "fields">;
|
|
66
|
-
/**
|
|
67
|
-
* Check Password Strength
|
|
68
|
-
* Check password strength and get validation feedback
|
|
69
|
-
*/
|
|
70
|
-
export declare const checkPasswordStrength: <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => import("./client").RequestResult<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError, "fields">;
|
|
71
96
|
/**
|
|
72
97
|
* Get CAPTCHA Configuration
|
|
73
98
|
* Get CAPTCHA configuration including site key and whether CAPTCHA is required.
|
|
@@ -202,79 +227,6 @@ export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean =
|
|
|
202
227
|
* Get credit balance for a specific shared repository
|
|
203
228
|
*/
|
|
204
229
|
export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
205
|
-
/**
|
|
206
|
-
* List Connections
|
|
207
|
-
* List all data connections in the graph.
|
|
208
|
-
*
|
|
209
|
-
* Returns active and inactive connections with their current status.
|
|
210
|
-
* Connections can be filtered by:
|
|
211
|
-
* - **Entity**: Show connections for a specific entity
|
|
212
|
-
* - **Provider**: Filter by connection type (sec, quickbooks, plaid)
|
|
213
|
-
*
|
|
214
|
-
* Each connection shows:
|
|
215
|
-
* - Current sync status and health
|
|
216
|
-
* - Last successful sync timestamp
|
|
217
|
-
* - Configuration metadata
|
|
218
|
-
* - Error messages if any
|
|
219
|
-
*
|
|
220
|
-
* No credits are consumed for listing connections.
|
|
221
|
-
*/
|
|
222
|
-
export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
|
|
223
|
-
/**
|
|
224
|
-
* Create Connection
|
|
225
|
-
* Create a new data connection for external system integration.
|
|
226
|
-
*
|
|
227
|
-
* This endpoint initiates connections to external data sources:
|
|
228
|
-
*
|
|
229
|
-
* **SEC Connections**:
|
|
230
|
-
* - Provide entity CIK for automatic filing retrieval
|
|
231
|
-
* - No authentication needed
|
|
232
|
-
* - Begins immediate data sync
|
|
233
|
-
*
|
|
234
|
-
* **QuickBooks Connections**:
|
|
235
|
-
* - Returns OAuth URL for authorization
|
|
236
|
-
* - Requires admin permissions in QuickBooks
|
|
237
|
-
* - Complete with OAuth callback
|
|
238
|
-
*
|
|
239
|
-
* **Plaid Connections**:
|
|
240
|
-
* - Returns Plaid Link token
|
|
241
|
-
* - User completes bank authentication
|
|
242
|
-
* - Exchange public token for access
|
|
243
|
-
*
|
|
244
|
-
* Note:
|
|
245
|
-
* This operation is FREE - no credit consumption required.
|
|
246
|
-
*/
|
|
247
|
-
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
|
|
248
|
-
/**
|
|
249
|
-
* Delete Connection
|
|
250
|
-
* Delete a data connection and clean up related resources.
|
|
251
|
-
*
|
|
252
|
-
* This operation:
|
|
253
|
-
* - Removes the connection configuration
|
|
254
|
-
* - Preserves any imported data in the graph
|
|
255
|
-
* - Performs provider-specific cleanup
|
|
256
|
-
* - Revokes stored credentials
|
|
257
|
-
*
|
|
258
|
-
* Note:
|
|
259
|
-
* This operation is FREE - no credit consumption required.
|
|
260
|
-
*
|
|
261
|
-
* Only users with admin role can delete connections.
|
|
262
|
-
*/
|
|
263
|
-
export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
|
|
264
|
-
/**
|
|
265
|
-
* Get Connection
|
|
266
|
-
* Get detailed information about a specific connection.
|
|
267
|
-
*
|
|
268
|
-
* Returns comprehensive connection details including:
|
|
269
|
-
* - Current status and health indicators
|
|
270
|
-
* - Authentication state
|
|
271
|
-
* - Sync history and statistics
|
|
272
|
-
* - Error details if any
|
|
273
|
-
* - Provider-specific metadata
|
|
274
|
-
*
|
|
275
|
-
* No credits are consumed for viewing connection details.
|
|
276
|
-
*/
|
|
277
|
-
export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
|
|
278
230
|
/**
|
|
279
231
|
* List Connection Options
|
|
280
232
|
* Get metadata about all available data connection providers.
|
|
@@ -391,7 +343,7 @@ export declare const initOAuth: <ThrowOnError extends boolean = false>(options:
|
|
|
391
343
|
* - **QuickBooks**: Accounting data integration
|
|
392
344
|
*
|
|
393
345
|
* Security measures:
|
|
394
|
-
* - State validation prevents
|
|
346
|
+
* - State validation prevents session hijacking
|
|
395
347
|
* - User context is verified
|
|
396
348
|
* - Tokens are encrypted before storage
|
|
397
349
|
* - Full audit trail is maintained
|
|
@@ -400,56 +352,167 @@ export declare const initOAuth: <ThrowOnError extends boolean = false>(options:
|
|
|
400
352
|
*/
|
|
401
353
|
export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => import("./client").RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError, "fields">;
|
|
402
354
|
/**
|
|
403
|
-
*
|
|
404
|
-
*
|
|
355
|
+
* List Connections
|
|
356
|
+
* List all data connections in the graph.
|
|
357
|
+
*
|
|
358
|
+
* Returns active and inactive connections with their current status.
|
|
359
|
+
* Connections can be filtered by:
|
|
360
|
+
* - **Entity**: Show connections for a specific entity
|
|
361
|
+
* - **Provider**: Filter by connection type (sec, quickbooks, plaid)
|
|
362
|
+
*
|
|
363
|
+
* Each connection shows:
|
|
364
|
+
* - Current sync status and health
|
|
365
|
+
* - Last successful sync timestamp
|
|
366
|
+
* - Configuration metadata
|
|
367
|
+
* - Error messages if any
|
|
368
|
+
*
|
|
369
|
+
* No credits are consumed for listing connections.
|
|
370
|
+
*/
|
|
371
|
+
export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
|
|
372
|
+
/**
|
|
373
|
+
* Create Connection
|
|
374
|
+
* Create a new data connection for external system integration.
|
|
405
375
|
*
|
|
406
|
-
* This endpoint
|
|
407
|
-
* - Analyze entity financial statements and SEC filings
|
|
408
|
-
* - Review QuickBooks transactions and accounting data
|
|
409
|
-
* - Perform multi-period trend analysis
|
|
410
|
-
* - Generate insights from balance sheets and income statements
|
|
411
|
-
* - Answer complex financial queries with contextual understanding
|
|
376
|
+
* This endpoint initiates connections to external data sources:
|
|
412
377
|
*
|
|
413
|
-
* **
|
|
414
|
-
* -
|
|
415
|
-
* -
|
|
378
|
+
* **SEC Connections**:
|
|
379
|
+
* - Provide entity CIK for automatic filing retrieval
|
|
380
|
+
* - No authentication needed
|
|
381
|
+
* - Begins immediate data sync
|
|
416
382
|
*
|
|
417
|
-
* **
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
* eventSource.onmessage = (event) => {
|
|
422
|
-
* const data = JSON.parse(event.data);
|
|
423
|
-
* console.log('Analysis:', data.message);
|
|
424
|
-
* };
|
|
425
|
-
* ```
|
|
383
|
+
* **QuickBooks Connections**:
|
|
384
|
+
* - Returns OAuth URL for authorization
|
|
385
|
+
* - Requires admin permissions in QuickBooks
|
|
386
|
+
* - Complete with OAuth callback
|
|
426
387
|
*
|
|
427
|
-
* **
|
|
428
|
-
* -
|
|
429
|
-
* -
|
|
430
|
-
* -
|
|
431
|
-
* - Graceful degradation with fallback to polling if SSE unavailable
|
|
388
|
+
* **Plaid Connections**:
|
|
389
|
+
* - Returns Plaid Link token
|
|
390
|
+
* - User completes bank authentication
|
|
391
|
+
* - Exchange public token for access
|
|
432
392
|
*
|
|
433
|
-
*
|
|
434
|
-
* -
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
393
|
+
* Note:
|
|
394
|
+
* This operation is FREE - no credit consumption required.
|
|
395
|
+
*/
|
|
396
|
+
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
|
|
397
|
+
/**
|
|
398
|
+
* Delete Connection
|
|
399
|
+
* Delete a data connection and clean up related resources.
|
|
438
400
|
*
|
|
439
|
-
*
|
|
440
|
-
* -
|
|
441
|
-
* -
|
|
442
|
-
* -
|
|
401
|
+
* This operation:
|
|
402
|
+
* - Removes the connection configuration
|
|
403
|
+
* - Preserves any imported data in the graph
|
|
404
|
+
* - Performs provider-specific cleanup
|
|
405
|
+
* - Revokes stored credentials
|
|
443
406
|
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
|
|
407
|
+
* Note:
|
|
408
|
+
* This operation is FREE - no credit consumption required.
|
|
409
|
+
*
|
|
410
|
+
* Only users with admin role can delete connections.
|
|
411
|
+
*/
|
|
412
|
+
export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
|
|
413
|
+
/**
|
|
414
|
+
* Get Connection
|
|
415
|
+
* Get detailed information about a specific connection.
|
|
416
|
+
*
|
|
417
|
+
* Returns comprehensive connection details including:
|
|
418
|
+
* - Current status and health indicators
|
|
419
|
+
* - Authentication state
|
|
420
|
+
* - Sync history and statistics
|
|
421
|
+
* - Error details if any
|
|
422
|
+
* - Provider-specific metadata
|
|
423
|
+
*
|
|
424
|
+
* No credits are consumed for viewing connection details.
|
|
425
|
+
*/
|
|
426
|
+
export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
|
|
427
|
+
/**
|
|
428
|
+
* Auto-select agent for query
|
|
429
|
+
* Automatically select the best agent for your query.
|
|
430
|
+
*
|
|
431
|
+
* The orchestrator will:
|
|
432
|
+
* 1. Enrich context with RAG if enabled
|
|
433
|
+
* 2. Evaluate all available agents
|
|
434
|
+
* 3. Select the best match based on confidence scores
|
|
435
|
+
* 4. Execute the query with the selected agent
|
|
436
|
+
*
|
|
437
|
+
* Use this endpoint when you want the system to intelligently route your query.
|
|
438
|
+
*/
|
|
439
|
+
export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
|
|
440
|
+
/**
|
|
441
|
+
* Execute specific agent
|
|
442
|
+
* Execute a specific agent type directly.
|
|
443
|
+
*
|
|
444
|
+
* Available agents:
|
|
445
|
+
* - **financial**: Financial analysis, SEC filings, accounting data
|
|
446
|
+
* - **research**: Deep research and comprehensive analysis
|
|
447
|
+
* - **rag**: Fast retrieval without AI (no credits required)
|
|
448
|
+
*
|
|
449
|
+
* Use this endpoint when you know which agent you want to use.
|
|
450
|
+
*/
|
|
451
|
+
export declare const executeSpecificAgent: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, ThrowOnError, "fields">;
|
|
452
|
+
/**
|
|
453
|
+
* Batch process multiple queries
|
|
454
|
+
* Process multiple queries either sequentially or in parallel.
|
|
455
|
+
*
|
|
456
|
+
* **Features:**
|
|
457
|
+
* - Process up to 10 queries in a single request
|
|
458
|
+
* - Sequential or parallel execution modes
|
|
459
|
+
* - Automatic error handling per query
|
|
460
|
+
* - Credit checking before execution
|
|
461
|
+
*
|
|
462
|
+
* **Use Cases:**
|
|
463
|
+
* - Bulk analysis of multiple entities
|
|
464
|
+
* - Comparative analysis across queries
|
|
465
|
+
* - Automated report generation
|
|
466
|
+
*
|
|
467
|
+
* Returns individual results for each query with execution metrics.
|
|
468
|
+
*/
|
|
469
|
+
export declare const batchProcessQueries: <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => import("./client").RequestResult<BatchProcessQueriesResponses, BatchProcessQueriesErrors, ThrowOnError, "fields">;
|
|
470
|
+
/**
|
|
471
|
+
* List available agents
|
|
472
|
+
* Get a comprehensive list of all available agents with their metadata.
|
|
473
|
+
*
|
|
474
|
+
* **Returns:**
|
|
475
|
+
* - Agent types and names
|
|
476
|
+
* - Capabilities and supported modes
|
|
477
|
+
* - Version information
|
|
478
|
+
* - Credit requirements
|
|
479
|
+
*
|
|
480
|
+
* Use the optional `capability` filter to find agents with specific capabilities.
|
|
481
|
+
*/
|
|
482
|
+
export declare const listAgents: <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => import("./client").RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError, "fields">;
|
|
483
|
+
/**
|
|
484
|
+
* Get agent metadata
|
|
485
|
+
* Get comprehensive metadata for a specific agent type.
|
|
486
|
+
*
|
|
487
|
+
* **Returns:**
|
|
488
|
+
* - Agent name and description
|
|
489
|
+
* - Version information
|
|
490
|
+
* - Supported capabilities and modes
|
|
491
|
+
* - Credit requirements
|
|
492
|
+
* - Author and tags
|
|
493
|
+
* - Configuration options
|
|
494
|
+
*
|
|
495
|
+
* Use this to understand agent capabilities before execution.
|
|
496
|
+
*/
|
|
497
|
+
export declare const getAgentMetadata: <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => import("./client").RequestResult<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError, "fields">;
|
|
498
|
+
/**
|
|
499
|
+
* Get agent recommendations
|
|
500
|
+
* Get intelligent agent recommendations for a specific query.
|
|
501
|
+
*
|
|
502
|
+
* **How it works:**
|
|
503
|
+
* 1. Analyzes query content and structure
|
|
504
|
+
* 2. Evaluates agent capabilities
|
|
505
|
+
* 3. Calculates confidence scores
|
|
506
|
+
* 4. Returns ranked recommendations
|
|
507
|
+
*
|
|
508
|
+
* **Use this when:**
|
|
509
|
+
* - Unsure which agent to use
|
|
510
|
+
* - Need to understand agent suitability
|
|
511
|
+
* - Want confidence scores for decision making
|
|
449
512
|
*
|
|
450
|
-
*
|
|
513
|
+
* Returns top agents ranked by confidence with explanations.
|
|
451
514
|
*/
|
|
452
|
-
export declare const
|
|
515
|
+
export declare const recommendAgent: <ThrowOnError extends boolean = false>(options: Options<RecommendAgentData, ThrowOnError>) => import("./client").RequestResult<RecommendAgentResponses, RecommendAgentErrors, ThrowOnError, "fields">;
|
|
453
516
|
/**
|
|
454
517
|
* List MCP Tools
|
|
455
518
|
* Get available Model Context Protocol tools for graph analysis.
|