@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/sdk.gen.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
3
  import type { Options as ClientOptions, TDataShape, Client } from './client';
4
- import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, 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, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, 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';
4
+ 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';
5
5
  import { client as _heyApiClient } from './client.gen';
6
6
 
7
7
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -61,7 +61,7 @@ export const logoutUser = <ThrowOnError extends boolean = false>(options?: Optio
61
61
 
62
62
  /**
63
63
  * Get Current User
64
- * Get current authenticated user from session.
64
+ * Get the currently authenticated user.
65
65
  */
66
66
  export const getCurrentAuthUser = <ThrowOnError extends boolean = false>(options?: Options<GetCurrentAuthUserData, ThrowOnError>) => {
67
67
  return (options?.client ?? _heyApiClient).get<GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, ThrowOnError>({
@@ -72,15 +72,108 @@ export const getCurrentAuthUser = <ThrowOnError extends boolean = false>(options
72
72
 
73
73
  /**
74
74
  * Refresh Session
75
- * Refresh user session and extend authentication token.
75
+ * Refresh authentication session with a new JWT token.
76
76
  */
77
- export const refreshSession = <ThrowOnError extends boolean = false>(options?: Options<RefreshSessionData, ThrowOnError>) => {
78
- return (options?.client ?? _heyApiClient).post<RefreshSessionResponses, RefreshSessionErrors, ThrowOnError>({
77
+ export const refreshAuthSession = <ThrowOnError extends boolean = false>(options?: Options<RefreshAuthSessionData, ThrowOnError>) => {
78
+ return (options?.client ?? _heyApiClient).post<RefreshAuthSessionResponses, RefreshAuthSessionErrors, ThrowOnError>({
79
79
  url: '/v1/auth/refresh',
80
80
  ...options
81
81
  });
82
82
  };
83
83
 
84
+ /**
85
+ * Resend Email Verification
86
+ * Resend verification email to the authenticated user. Rate limited to 3 per hour.
87
+ */
88
+ export const resendVerificationEmail = <ThrowOnError extends boolean = false>(options?: Options<ResendVerificationEmailData, ThrowOnError>) => {
89
+ return (options?.client ?? _heyApiClient).post<ResendVerificationEmailResponses, ResendVerificationEmailErrors, ThrowOnError>({
90
+ url: '/v1/auth/email/resend',
91
+ ...options
92
+ });
93
+ };
94
+
95
+ /**
96
+ * Verify Email
97
+ * Verify email address with token from email link. Returns JWT for auto-login.
98
+ */
99
+ export const verifyEmail = <ThrowOnError extends boolean = false>(options: Options<VerifyEmailData, ThrowOnError>) => {
100
+ return (options.client ?? _heyApiClient).post<VerifyEmailResponses, VerifyEmailErrors, ThrowOnError>({
101
+ url: '/v1/auth/email/verify',
102
+ ...options,
103
+ headers: {
104
+ 'Content-Type': 'application/json',
105
+ ...options.headers
106
+ }
107
+ });
108
+ };
109
+
110
+ /**
111
+ * Get Password Policy
112
+ * Get current password policy requirements for frontend validation
113
+ */
114
+ export const getPasswordPolicy = <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => {
115
+ return (options?.client ?? _heyApiClient).get<GetPasswordPolicyResponses, unknown, ThrowOnError>({
116
+ url: '/v1/auth/password/policy',
117
+ ...options
118
+ });
119
+ };
120
+
121
+ /**
122
+ * Check Password Strength
123
+ * Check password strength and get validation feedback
124
+ */
125
+ export const checkPasswordStrength = <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => {
126
+ return (options.client ?? _heyApiClient).post<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError>({
127
+ url: '/v1/auth/password/check',
128
+ ...options,
129
+ headers: {
130
+ 'Content-Type': 'application/json',
131
+ ...options.headers
132
+ }
133
+ });
134
+ };
135
+
136
+ /**
137
+ * Forgot Password
138
+ * Request password reset email. Always returns success to prevent email enumeration.
139
+ */
140
+ export const forgotPassword = <ThrowOnError extends boolean = false>(options: Options<ForgotPasswordData, ThrowOnError>) => {
141
+ return (options.client ?? _heyApiClient).post<ForgotPasswordResponses, ForgotPasswordErrors, ThrowOnError>({
142
+ url: '/v1/auth/password/forgot',
143
+ ...options,
144
+ headers: {
145
+ 'Content-Type': 'application/json',
146
+ ...options.headers
147
+ }
148
+ });
149
+ };
150
+
151
+ /**
152
+ * Validate Reset Token
153
+ * Check if a password reset token is valid without consuming it.
154
+ */
155
+ export const validateResetToken = <ThrowOnError extends boolean = false>(options: Options<ValidateResetTokenData, ThrowOnError>) => {
156
+ return (options.client ?? _heyApiClient).get<ValidateResetTokenResponses, ValidateResetTokenErrors, ThrowOnError>({
157
+ url: '/v1/auth/password/reset/validate',
158
+ ...options
159
+ });
160
+ };
161
+
162
+ /**
163
+ * Reset Password
164
+ * Reset password with token from email. Returns JWT for auto-login.
165
+ */
166
+ export const resetPassword = <ThrowOnError extends boolean = false>(options: Options<ResetPasswordData, ThrowOnError>) => {
167
+ return (options.client ?? _heyApiClient).post<ResetPasswordResponses, ResetPasswordErrors, ThrowOnError>({
168
+ url: '/v1/auth/password/reset',
169
+ ...options,
170
+ headers: {
171
+ 'Content-Type': 'application/json',
172
+ ...options.headers
173
+ }
174
+ });
175
+ };
176
+
84
177
  /**
85
178
  * Generate SSO Token
86
179
  * Generate a temporary SSO token for cross-app authentication.
@@ -137,32 +230,6 @@ export const completeSsoAuth = <ThrowOnError extends boolean = false>(options: O
137
230
  });
138
231
  };
139
232
 
140
- /**
141
- * Get Password Policy
142
- * Get current password policy requirements for frontend validation
143
- */
144
- export const getPasswordPolicy = <ThrowOnError extends boolean = false>(options?: Options<GetPasswordPolicyData, ThrowOnError>) => {
145
- return (options?.client ?? _heyApiClient).get<GetPasswordPolicyResponses, unknown, ThrowOnError>({
146
- url: '/v1/auth/password/policy',
147
- ...options
148
- });
149
- };
150
-
151
- /**
152
- * Check Password Strength
153
- * Check password strength and get validation feedback
154
- */
155
- export const checkPasswordStrength = <ThrowOnError extends boolean = false>(options: Options<CheckPasswordStrengthData, ThrowOnError>) => {
156
- return (options.client ?? _heyApiClient).post<CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, ThrowOnError>({
157
- url: '/v1/auth/password/check',
158
- ...options,
159
- headers: {
160
- 'Content-Type': 'application/json',
161
- ...options.headers
162
- }
163
- });
164
- };
165
-
166
233
  /**
167
234
  * Get CAPTCHA Configuration
168
235
  * Get CAPTCHA configuration including site key and whether CAPTCHA is required.
@@ -685,147 +752,6 @@ export const getRepositoryCredits = <ThrowOnError extends boolean = false>(optio
685
752
  });
686
753
  };
687
754
 
688
- /**
689
- * List Connections
690
- * List all data connections in the graph.
691
- *
692
- * Returns active and inactive connections with their current status.
693
- * Connections can be filtered by:
694
- * - **Entity**: Show connections for a specific entity
695
- * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
696
- *
697
- * Each connection shows:
698
- * - Current sync status and health
699
- * - Last successful sync timestamp
700
- * - Configuration metadata
701
- * - Error messages if any
702
- *
703
- * No credits are consumed for listing connections.
704
- */
705
- export const listConnections = <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => {
706
- return (options.client ?? _heyApiClient).get<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError>({
707
- security: [
708
- {
709
- name: 'X-API-Key',
710
- type: 'apiKey'
711
- },
712
- {
713
- scheme: 'bearer',
714
- type: 'http'
715
- }
716
- ],
717
- url: '/v1/{graph_id}/connections',
718
- ...options
719
- });
720
- };
721
-
722
- /**
723
- * Create Connection
724
- * Create a new data connection for external system integration.
725
- *
726
- * This endpoint initiates connections to external data sources:
727
- *
728
- * **SEC Connections**:
729
- * - Provide entity CIK for automatic filing retrieval
730
- * - No authentication needed
731
- * - Begins immediate data sync
732
- *
733
- * **QuickBooks Connections**:
734
- * - Returns OAuth URL for authorization
735
- * - Requires admin permissions in QuickBooks
736
- * - Complete with OAuth callback
737
- *
738
- * **Plaid Connections**:
739
- * - Returns Plaid Link token
740
- * - User completes bank authentication
741
- * - Exchange public token for access
742
- *
743
- * Note:
744
- * This operation is FREE - no credit consumption required.
745
- */
746
- export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => {
747
- return (options.client ?? _heyApiClient).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
748
- security: [
749
- {
750
- name: 'X-API-Key',
751
- type: 'apiKey'
752
- },
753
- {
754
- scheme: 'bearer',
755
- type: 'http'
756
- }
757
- ],
758
- url: '/v1/{graph_id}/connections',
759
- ...options,
760
- headers: {
761
- 'Content-Type': 'application/json',
762
- ...options.headers
763
- }
764
- });
765
- };
766
-
767
- /**
768
- * Delete Connection
769
- * Delete a data connection and clean up related resources.
770
- *
771
- * This operation:
772
- * - Removes the connection configuration
773
- * - Preserves any imported data in the graph
774
- * - Performs provider-specific cleanup
775
- * - Revokes stored credentials
776
- *
777
- * Note:
778
- * This operation is FREE - no credit consumption required.
779
- *
780
- * Only users with admin role can delete connections.
781
- */
782
- export const deleteConnection = <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => {
783
- return (options.client ?? _heyApiClient).delete<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError>({
784
- security: [
785
- {
786
- name: 'X-API-Key',
787
- type: 'apiKey'
788
- },
789
- {
790
- scheme: 'bearer',
791
- type: 'http'
792
- }
793
- ],
794
- url: '/v1/{graph_id}/connections/{connection_id}',
795
- ...options
796
- });
797
- };
798
-
799
- /**
800
- * Get Connection
801
- * Get detailed information about a specific connection.
802
- *
803
- * Returns comprehensive connection details including:
804
- * - Current status and health indicators
805
- * - Authentication state
806
- * - Sync history and statistics
807
- * - Error details if any
808
- * - Provider-specific metadata
809
- *
810
- * No credits are consumed for viewing connection details.
811
- */
812
- export const getConnection = <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => {
813
- return (options.client ?? _heyApiClient).get<GetConnectionResponses, GetConnectionErrors, ThrowOnError>({
814
- security: [
815
- {
816
- name: 'X-API-Key',
817
- type: 'apiKey'
818
- },
819
- {
820
- scheme: 'bearer',
821
- type: 'http'
822
- }
823
- ],
824
- url: '/v1/{graph_id}/connections/{connection_id}',
825
- ...options
826
- });
827
- };
828
-
829
755
  /**
830
756
  * List Connection Options
831
757
  * Get metadata about all available data connection providers.
@@ -1038,7 +964,7 @@ export const initOAuth = <ThrowOnError extends boolean = false>(options: Options
1038
964
  * - **QuickBooks**: Accounting data integration
1039
965
  *
1040
966
  * Security measures:
1041
- * - State validation prevents CSRF attacks
967
+ * - State validation prevents session hijacking
1042
968
  * - User context is verified
1043
969
  * - Tokens are encrypted before storage
1044
970
  * - Full audit trail is maintained
@@ -1067,57 +993,160 @@ export const oauthCallback = <ThrowOnError extends boolean = false>(options: Opt
1067
993
  };
1068
994
 
1069
995
  /**
1070
- * Query Financial Agent
1071
- * AI-powered financial analysis with direct access to graph data.
996
+ * List Connections
997
+ * List all data connections in the graph.
998
+ *
999
+ * Returns active and inactive connections with their current status.
1000
+ * Connections can be filtered by:
1001
+ * - **Entity**: Show connections for a specific entity
1002
+ * - **Provider**: Filter by connection type (sec, quickbooks, plaid)
1003
+ *
1004
+ * Each connection shows:
1005
+ * - Current sync status and health
1006
+ * - Last successful sync timestamp
1007
+ * - Configuration metadata
1008
+ * - Error messages if any
1009
+ *
1010
+ * No credits are consumed for listing connections.
1011
+ */
1012
+ export const listConnections = <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => {
1013
+ return (options.client ?? _heyApiClient).get<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError>({
1014
+ security: [
1015
+ {
1016
+ name: 'X-API-Key',
1017
+ type: 'apiKey'
1018
+ },
1019
+ {
1020
+ scheme: 'bearer',
1021
+ type: 'http'
1022
+ }
1023
+ ],
1024
+ url: '/v1/{graph_id}/connections',
1025
+ ...options
1026
+ });
1027
+ };
1028
+
1029
+ /**
1030
+ * Create Connection
1031
+ * Create a new data connection for external system integration.
1072
1032
  *
1073
- * This endpoint provides intelligent financial analysis using an AI agent that can:
1074
- * - Analyze entity financial statements and SEC filings
1075
- * - Review QuickBooks transactions and accounting data
1076
- * - Perform multi-period trend analysis
1077
- * - Generate insights from balance sheets and income statements
1078
- * - Answer complex financial queries with contextual understanding
1033
+ * This endpoint initiates connections to external data sources:
1079
1034
  *
1080
- * **Execution Modes:**
1081
- * - **Quick Analysis** (default): Synchronous responses for simple queries (1-2 tool calls)
1082
- * - **Extended Analysis**: Asynchronous processing for complex research (returns operation_id for SSE monitoring)
1035
+ * **SEC Connections**:
1036
+ * - Provide entity CIK for automatic filing retrieval
1037
+ * - No authentication needed
1038
+ * - Begins immediate data sync
1083
1039
  *
1084
- * **Extended Analysis Monitoring:**
1085
- * For complex queries, connect to the SSE stream for real-time progress:
1086
- * ```javascript
1087
- * const eventSource = new EventSource('/v1/operations/{operation_id}/stream');
1088
- * eventSource.onmessage = (event) => {
1089
- * const data = JSON.parse(event.data);
1090
- * console.log('Analysis:', data.message);
1091
- * };
1092
- * ```
1040
+ * **QuickBooks Connections**:
1041
+ * - Returns OAuth URL for authorization
1042
+ * - Requires admin permissions in QuickBooks
1043
+ * - Complete with OAuth callback
1093
1044
  *
1094
- * **SSE Connection Limits:**
1095
- * - Maximum 5 concurrent SSE connections per user
1096
- * - Rate limited to 10 new connections per minute
1097
- * - Automatic circuit breaker for Redis failures
1098
- * - Graceful degradation with fallback to polling if SSE unavailable
1045
+ * **Plaid Connections**:
1046
+ * - Returns Plaid Link token
1047
+ * - User completes bank authentication
1048
+ * - Exchange public token for access
1099
1049
  *
1100
- * **Events Emitted:**
1101
- * - `operation_started`: Analysis begins
1102
- * - `operation_progress`: Tool calls, analysis steps
1103
- * - `operation_completed`: Final comprehensive analysis
1104
- * - `operation_error`: Analysis failed
1050
+ * Note:
1051
+ * This operation is FREE - no credit consumption required.
1052
+ */
1053
+ export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => {
1054
+ return (options.client ?? _heyApiClient).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
1055
+ security: [
1056
+ {
1057
+ name: 'X-API-Key',
1058
+ type: 'apiKey'
1059
+ },
1060
+ {
1061
+ scheme: 'bearer',
1062
+ type: 'http'
1063
+ }
1064
+ ],
1065
+ url: '/v1/{graph_id}/connections',
1066
+ ...options,
1067
+ headers: {
1068
+ 'Content-Type': 'application/json',
1069
+ ...options.headers
1070
+ }
1071
+ });
1072
+ };
1073
+
1074
+ /**
1075
+ * Delete Connection
1076
+ * Delete a data connection and clean up related resources.
1105
1077
  *
1106
- * **Error Handling:**
1107
- * - `429 Too Many Requests`: SSE connection limit exceeded
1108
- * - `503 Service Unavailable`: SSE system temporarily disabled
1109
- * - Fallback to status polling endpoint if SSE unavailable
1078
+ * This operation:
1079
+ * - Removes the connection configuration
1080
+ * - Preserves any imported data in the graph
1081
+ * - Performs provider-specific cleanup
1082
+ * - Revokes stored credentials
1110
1083
  *
1111
- * **Credit Consumption:**
1112
- * - AI operations consume credits based on actual token usage
1113
- * - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
1114
- * - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
1115
- * - Credits are consumed after operation completes based on actual usage
1084
+ * Note:
1085
+ * This operation is FREE - no credit consumption required.
1086
+ *
1087
+ * Only users with admin role can delete connections.
1088
+ */
1089
+ export const deleteConnection = <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => {
1090
+ return (options.client ?? _heyApiClient).delete<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError>({
1091
+ security: [
1092
+ {
1093
+ name: 'X-API-Key',
1094
+ type: 'apiKey'
1095
+ },
1096
+ {
1097
+ scheme: 'bearer',
1098
+ type: 'http'
1099
+ }
1100
+ ],
1101
+ url: '/v1/{graph_id}/connections/{connection_id}',
1102
+ ...options
1103
+ });
1104
+ };
1105
+
1106
+ /**
1107
+ * Get Connection
1108
+ * Get detailed information about a specific connection.
1109
+ *
1110
+ * Returns comprehensive connection details including:
1111
+ * - Current status and health indicators
1112
+ * - Authentication state
1113
+ * - Sync history and statistics
1114
+ * - Error details if any
1115
+ * - Provider-specific metadata
1116
+ *
1117
+ * No credits are consumed for viewing connection details.
1118
+ */
1119
+ export const getConnection = <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => {
1120
+ return (options.client ?? _heyApiClient).get<GetConnectionResponses, GetConnectionErrors, ThrowOnError>({
1121
+ security: [
1122
+ {
1123
+ name: 'X-API-Key',
1124
+ type: 'apiKey'
1125
+ },
1126
+ {
1127
+ scheme: 'bearer',
1128
+ type: 'http'
1129
+ }
1130
+ ],
1131
+ url: '/v1/{graph_id}/connections/{connection_id}',
1132
+ ...options
1133
+ });
1134
+ };
1135
+
1136
+ /**
1137
+ * Auto-select agent for query
1138
+ * Automatically select the best agent for your query.
1139
+ *
1140
+ * The orchestrator will:
1141
+ * 1. Enrich context with RAG if enabled
1142
+ * 2. Evaluate all available agents
1143
+ * 3. Select the best match based on confidence scores
1144
+ * 4. Execute the query with the selected agent
1116
1145
  *
1117
- * The agent automatically determines query complexity or you can force extended analysis.
1146
+ * Use this endpoint when you want the system to intelligently route your query.
1118
1147
  */
1119
- export const queryFinancialAgent = <ThrowOnError extends boolean = false>(options: Options<QueryFinancialAgentData, ThrowOnError>) => {
1120
- return (options.client ?? _heyApiClient).post<QueryFinancialAgentResponses, QueryFinancialAgentErrors, ThrowOnError>({
1148
+ export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => {
1149
+ return (options.client ?? _heyApiClient).post<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError>({
1121
1150
  security: [
1122
1151
  {
1123
1152
  name: 'X-API-Key',
@@ -1137,6 +1166,174 @@ export const queryFinancialAgent = <ThrowOnError extends boolean = false>(option
1137
1166
  });
1138
1167
  };
1139
1168
 
1169
+ /**
1170
+ * Execute specific agent
1171
+ * Execute a specific agent type directly.
1172
+ *
1173
+ * Available agents:
1174
+ * - **financial**: Financial analysis, SEC filings, accounting data
1175
+ * - **research**: Deep research and comprehensive analysis
1176
+ * - **rag**: Fast retrieval without AI (no credits required)
1177
+ *
1178
+ * Use this endpoint when you know which agent you want to use.
1179
+ */
1180
+ export const executeSpecificAgent = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificAgentData, ThrowOnError>) => {
1181
+ return (options.client ?? _heyApiClient).post<ExecuteSpecificAgentResponses, ExecuteSpecificAgentErrors, ThrowOnError>({
1182
+ security: [
1183
+ {
1184
+ name: 'X-API-Key',
1185
+ type: 'apiKey'
1186
+ },
1187
+ {
1188
+ scheme: 'bearer',
1189
+ type: 'http'
1190
+ }
1191
+ ],
1192
+ url: '/v1/{graph_id}/agent/{agent_type}',
1193
+ ...options,
1194
+ headers: {
1195
+ 'Content-Type': 'application/json',
1196
+ ...options.headers
1197
+ }
1198
+ });
1199
+ };
1200
+
1201
+ /**
1202
+ * Batch process multiple queries
1203
+ * Process multiple queries either sequentially or in parallel.
1204
+ *
1205
+ * **Features:**
1206
+ * - Process up to 10 queries in a single request
1207
+ * - Sequential or parallel execution modes
1208
+ * - Automatic error handling per query
1209
+ * - Credit checking before execution
1210
+ *
1211
+ * **Use Cases:**
1212
+ * - Bulk analysis of multiple entities
1213
+ * - Comparative analysis across queries
1214
+ * - Automated report generation
1215
+ *
1216
+ * Returns individual results for each query with execution metrics.
1217
+ */
1218
+ export const batchProcessQueries = <ThrowOnError extends boolean = false>(options: Options<BatchProcessQueriesData, ThrowOnError>) => {
1219
+ return (options.client ?? _heyApiClient).post<BatchProcessQueriesResponses, BatchProcessQueriesErrors, ThrowOnError>({
1220
+ security: [
1221
+ {
1222
+ name: 'X-API-Key',
1223
+ type: 'apiKey'
1224
+ },
1225
+ {
1226
+ scheme: 'bearer',
1227
+ type: 'http'
1228
+ }
1229
+ ],
1230
+ url: '/v1/{graph_id}/agent/batch',
1231
+ ...options,
1232
+ headers: {
1233
+ 'Content-Type': 'application/json',
1234
+ ...options.headers
1235
+ }
1236
+ });
1237
+ };
1238
+
1239
+ /**
1240
+ * List available agents
1241
+ * Get a comprehensive list of all available agents with their metadata.
1242
+ *
1243
+ * **Returns:**
1244
+ * - Agent types and names
1245
+ * - Capabilities and supported modes
1246
+ * - Version information
1247
+ * - Credit requirements
1248
+ *
1249
+ * Use the optional `capability` filter to find agents with specific capabilities.
1250
+ */
1251
+ export const listAgents = <ThrowOnError extends boolean = false>(options: Options<ListAgentsData, ThrowOnError>) => {
1252
+ return (options.client ?? _heyApiClient).get<ListAgentsResponses, ListAgentsErrors, ThrowOnError>({
1253
+ security: [
1254
+ {
1255
+ name: 'X-API-Key',
1256
+ type: 'apiKey'
1257
+ },
1258
+ {
1259
+ scheme: 'bearer',
1260
+ type: 'http'
1261
+ }
1262
+ ],
1263
+ url: '/v1/{graph_id}/agent/list',
1264
+ ...options
1265
+ });
1266
+ };
1267
+
1268
+ /**
1269
+ * Get agent metadata
1270
+ * Get comprehensive metadata for a specific agent type.
1271
+ *
1272
+ * **Returns:**
1273
+ * - Agent name and description
1274
+ * - Version information
1275
+ * - Supported capabilities and modes
1276
+ * - Credit requirements
1277
+ * - Author and tags
1278
+ * - Configuration options
1279
+ *
1280
+ * Use this to understand agent capabilities before execution.
1281
+ */
1282
+ export const getAgentMetadata = <ThrowOnError extends boolean = false>(options: Options<GetAgentMetadataData, ThrowOnError>) => {
1283
+ return (options.client ?? _heyApiClient).get<GetAgentMetadataResponses, GetAgentMetadataErrors, ThrowOnError>({
1284
+ security: [
1285
+ {
1286
+ name: 'X-API-Key',
1287
+ type: 'apiKey'
1288
+ },
1289
+ {
1290
+ scheme: 'bearer',
1291
+ type: 'http'
1292
+ }
1293
+ ],
1294
+ url: '/v1/{graph_id}/agent/{agent_type}/metadata',
1295
+ ...options
1296
+ });
1297
+ };
1298
+
1299
+ /**
1300
+ * Get agent recommendations
1301
+ * Get intelligent agent recommendations for a specific query.
1302
+ *
1303
+ * **How it works:**
1304
+ * 1. Analyzes query content and structure
1305
+ * 2. Evaluates agent capabilities
1306
+ * 3. Calculates confidence scores
1307
+ * 4. Returns ranked recommendations
1308
+ *
1309
+ * **Use this when:**
1310
+ * - Unsure which agent to use
1311
+ * - Need to understand agent suitability
1312
+ * - Want confidence scores for decision making
1313
+ *
1314
+ * Returns top agents ranked by confidence with explanations.
1315
+ */
1316
+ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Options<RecommendAgentData, ThrowOnError>) => {
1317
+ return (options.client ?? _heyApiClient).post<RecommendAgentResponses, RecommendAgentErrors, ThrowOnError>({
1318
+ security: [
1319
+ {
1320
+ name: 'X-API-Key',
1321
+ type: 'apiKey'
1322
+ },
1323
+ {
1324
+ scheme: 'bearer',
1325
+ type: 'http'
1326
+ }
1327
+ ],
1328
+ url: '/v1/{graph_id}/agent/recommend',
1329
+ ...options,
1330
+ headers: {
1331
+ 'Content-Type': 'application/json',
1332
+ ...options.headers
1333
+ }
1334
+ });
1335
+ };
1336
+
1140
1337
  /**
1141
1338
  * List MCP Tools
1142
1339
  * Get available Model Context Protocol tools for graph analysis.