@robosystems/client 0.2.31 → 0.2.33
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/README.md +1 -1
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +12 -3
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +165 -12
- package/sdk/sdk.gen.js +232 -22
- package/sdk/sdk.gen.ts +230 -21
- package/sdk/types.gen.d.ts +852 -55
- package/sdk/types.gen.ts +902 -55
- package/sdk.gen.d.ts +165 -12
- package/sdk.gen.js +232 -22
- package/sdk.gen.ts +230 -21
- package/types.gen.d.ts +852 -55
- package/types.gen.ts +902 -55
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CheckCreditBalanceData, CheckCreditBalanceErrors, CheckCreditBalanceResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CheckStorageLimitsData, CheckStorageLimitsErrors, CheckStorageLimitsResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses,
|
|
2
|
+
import type { AutoSelectAgentData, AutoSelectAgentErrors, AutoSelectAgentResponses, BatchProcessQueriesData, BatchProcessQueriesErrors, BatchProcessQueriesResponses, CallMcpToolData, CallMcpToolErrors, CallMcpToolResponses, CancelOperationData, CancelOperationErrors, CancelOperationResponses, CancelOrgSubscriptionData, CancelOrgSubscriptionErrors, CancelOrgSubscriptionResponses, CheckCreditBalanceData, CheckCreditBalanceErrors, CheckCreditBalanceResponses, CheckPasswordStrengthData, CheckPasswordStrengthErrors, CheckPasswordStrengthResponses, CheckStorageLimitsData, CheckStorageLimitsErrors, CheckStorageLimitsResponses, CompleteSsoAuthData, CompleteSsoAuthErrors, CompleteSsoAuthResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateCheckoutSessionData, CreateCheckoutSessionErrors, CreateCheckoutSessionResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateFileUploadData, CreateFileUploadErrors, CreateFileUploadResponses, CreateGraphData, CreateGraphErrors, CreateGraphResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateRepositorySubscriptionData, CreateRepositorySubscriptionErrors, CreateRepositorySubscriptionResponses, CreateSubgraphData, CreateSubgraphErrors, CreateSubgraphResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, CreateViewData, CreateViewErrors, CreateViewResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteFileData, DeleteFileErrors, DeleteFileResponses, DeleteSubgraphData, DeleteSubgraphErrors, DeleteSubgraphResponses, ExecuteCypherQueryData, ExecuteCypherQueryErrors, ExecuteCypherQueryResponses, ExecuteSpecificAgentData, ExecuteSpecificAgentErrors, ExecuteSpecificAgentResponses, ExportGraphSchemaData, ExportGraphSchemaErrors, ExportGraphSchemaResponses, ForgotPasswordData, ForgotPasswordErrors, ForgotPasswordResponses, GenerateSsoTokenData, GenerateSsoTokenErrors, GenerateSsoTokenResponses, GetAgentMetadataData, GetAgentMetadataErrors, GetAgentMetadataResponses, GetAvailableExtensionsData, GetAvailableExtensionsErrors, GetAvailableExtensionsResponses, GetAvailableGraphTiersData, GetAvailableGraphTiersErrors, GetAvailableGraphTiersResponses, GetBackupDownloadUrlData, GetBackupDownloadUrlErrors, GetBackupDownloadUrlResponses, GetBackupStatsData, GetBackupStatsErrors, GetBackupStatsResponses, GetCaptchaConfigData, GetCaptchaConfigResponses, GetCheckoutStatusData, GetCheckoutStatusErrors, GetCheckoutStatusResponses, GetConnectionData, GetConnectionErrors, GetConnectionOptionsData, GetConnectionOptionsErrors, GetConnectionOptionsResponses, GetConnectionResponses, GetCreditSummaryData, GetCreditSummaryErrors, GetCreditSummaryResponses, GetCurrentAuthUserData, GetCurrentAuthUserErrors, GetCurrentAuthUserResponses, GetCurrentUserData, GetCurrentUserResponses, GetDatabaseHealthData, GetDatabaseHealthErrors, GetDatabaseHealthResponses, GetDatabaseInfoData, GetDatabaseInfoErrors, GetDatabaseInfoResponses, GetFileData, GetFileErrors, GetFileResponses, GetGraphCapacityData, GetGraphCapacityErrors, GetGraphCapacityResponses, GetGraphLimitsData, GetGraphLimitsErrors, GetGraphLimitsResponses, GetGraphMetricsData, GetGraphMetricsErrors, GetGraphMetricsResponses, GetGraphSchemaData, GetGraphSchemaErrors, GetGraphSchemaResponses, GetGraphsData, GetGraphsErrors, GetGraphsResponses, GetGraphSubscriptionData, GetGraphSubscriptionErrors, GetGraphSubscriptionResponses, GetGraphUsageAnalyticsData, GetGraphUsageAnalyticsErrors, GetGraphUsageAnalyticsResponses, GetMaterializationStatusData, GetMaterializationStatusErrors, GetMaterializationStatusResponses, GetOperationStatusData, GetOperationStatusErrors, GetOperationStatusResponses, GetOrgBillingCustomerData, GetOrgBillingCustomerErrors, GetOrgBillingCustomerResponses, GetOrgData, GetOrgErrors, GetOrgLimitsData, GetOrgLimitsErrors, GetOrgLimitsResponses, GetOrgResponses, GetOrgSubscriptionData, GetOrgSubscriptionErrors, GetOrgSubscriptionResponses, GetOrgUpcomingInvoiceData, GetOrgUpcomingInvoiceErrors, GetOrgUpcomingInvoiceResponses, GetOrgUsageData, GetOrgUsageErrors, GetOrgUsageResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, GetServiceOfferingsData, GetServiceOfferingsErrors, GetServiceOfferingsResponses, GetServiceStatusData, GetServiceStatusResponses, GetStorageUsageData, GetStorageUsageErrors, GetStorageUsageResponses, GetSubgraphInfoData, GetSubgraphInfoErrors, GetSubgraphInfoResponses, GetSubgraphQuotaData, GetSubgraphQuotaErrors, GetSubgraphQuotaResponses, InitOAuthData, InitOAuthErrors, InitOAuthResponses, InviteOrgMemberData, InviteOrgMemberErrors, InviteOrgMemberResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCreditTransactionsData, ListCreditTransactionsErrors, ListCreditTransactionsResponses, ListFilesData, ListFilesErrors, ListFilesResponses, ListMcpToolsData, ListMcpToolsErrors, ListMcpToolsResponses, ListOrgGraphsData, ListOrgGraphsErrors, ListOrgGraphsResponses, ListOrgInvoicesData, ListOrgInvoicesErrors, ListOrgInvoicesResponses, ListOrgMembersData, ListOrgMembersErrors, ListOrgMembersResponses, ListOrgSubscriptionsData, ListOrgSubscriptionsErrors, ListOrgSubscriptionsResponses, ListSubgraphsData, ListSubgraphsErrors, ListSubgraphsResponses, ListTablesData, ListTablesErrors, ListTablesResponses, ListUserApiKeysData, ListUserApiKeysResponses, ListUserOrgsData, ListUserOrgsResponses, LoginUserData, LoginUserErrors, LoginUserResponses, LogoutUserData, LogoutUserResponses, MaterializeGraphData, MaterializeGraphErrors, MaterializeGraphResponses, OauthCallbackData, OauthCallbackErrors, OauthCallbackResponses, QueryTablesData, QueryTablesErrors, QueryTablesResponses, RecommendAgentData, RecommendAgentErrors, RecommendAgentResponses, RefreshAuthSessionData, RefreshAuthSessionErrors, RefreshAuthSessionResponses, RegisterUserData, RegisterUserErrors, RegisterUserResponses, RemoveOrgMemberData, RemoveOrgMemberErrors, RemoveOrgMemberResponses, ResendVerificationEmailData, ResendVerificationEmailErrors, ResendVerificationEmailResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, RevokeUserApiKeyData, RevokeUserApiKeyErrors, RevokeUserApiKeyResponses, SelectGraphData, SelectGraphErrors, SelectGraphResponses, SsoTokenExchangeData, SsoTokenExchangeErrors, SsoTokenExchangeResponses, StreamOperationEventsData, StreamOperationEventsErrors, StreamOperationEventsResponses, SyncConnectionData, SyncConnectionErrors, SyncConnectionResponses, UpdateFileData, UpdateFileErrors, UpdateFileResponses, UpdateOrgData, UpdateOrgErrors, UpdateOrgMemberRoleData, UpdateOrgMemberRoleErrors, UpdateOrgMemberRoleResponses, UpdateOrgResponses, UpdateUserApiKeyData, UpdateUserApiKeyErrors, UpdateUserApiKeyResponses, UpdateUserData, UpdateUserErrors, UpdateUserPasswordData, UpdateUserPasswordErrors, UpdateUserPasswordResponses, UpdateUserResponses, UpgradeSubscriptionData, UpgradeSubscriptionErrors, UpgradeSubscriptionResponses, ValidateResetTokenData, ValidateResetTokenErrors, ValidateResetTokenResponses, ValidateSchemaData, ValidateSchemaErrors, ValidateSchemaResponses, VerifyEmailData, VerifyEmailErrors, VerifyEmailResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -167,12 +167,6 @@ export declare const updateUserApiKey: <ThrowOnError extends boolean = false>(op
|
|
|
167
167
|
* Get all organizations the current user belongs to, with their role in each.
|
|
168
168
|
*/
|
|
169
169
|
export declare const listUserOrgs: <ThrowOnError extends boolean = false>(options?: Options<ListUserOrgsData, ThrowOnError>) => import("./client").RequestResult<ListUserOrgsResponses, unknown, ThrowOnError, "fields">;
|
|
170
|
-
/**
|
|
171
|
-
* Create Organization
|
|
172
|
-
*
|
|
173
|
-
* Create a new organization. The creating user becomes the owner.
|
|
174
|
-
*/
|
|
175
|
-
export declare const createOrg: <ThrowOnError extends boolean = false>(options: Options<CreateOrgData, ThrowOnError>) => import("./client").RequestResult<CreateOrgResponses, CreateOrgErrors, ThrowOnError, "fields">;
|
|
176
170
|
/**
|
|
177
171
|
* Get Organization
|
|
178
172
|
*
|
|
@@ -230,6 +224,155 @@ export declare const getOrgLimits: <ThrowOnError extends boolean = false>(option
|
|
|
230
224
|
* Get detailed usage statistics for an organization aggregated across all graphs.
|
|
231
225
|
*/
|
|
232
226
|
export declare const getOrgUsage: <ThrowOnError extends boolean = false>(options: Options<GetOrgUsageData, ThrowOnError>) => import("./client").RequestResult<GetOrgUsageResponses, GetOrgUsageErrors, ThrowOnError, "fields">;
|
|
227
|
+
/**
|
|
228
|
+
* List Connections
|
|
229
|
+
*
|
|
230
|
+
* List all data connections in the graph.
|
|
231
|
+
*
|
|
232
|
+
* Returns active and inactive connections with their current status.
|
|
233
|
+
* Connections can be filtered by:
|
|
234
|
+
* - **Entity**: Show connections for a specific entity
|
|
235
|
+
* - **Provider**: Filter by connection type (sec, quickbooks)
|
|
236
|
+
*
|
|
237
|
+
* Each connection shows:
|
|
238
|
+
* - Current sync status and health
|
|
239
|
+
* - Last successful sync timestamp
|
|
240
|
+
* - Configuration metadata
|
|
241
|
+
* - Error messages if any
|
|
242
|
+
*
|
|
243
|
+
* No credits are consumed for listing connections.
|
|
244
|
+
*/
|
|
245
|
+
export declare const listConnections: <ThrowOnError extends boolean = false>(options: Options<ListConnectionsData, ThrowOnError>) => import("./client").RequestResult<ListConnectionsResponses, ListConnectionsErrors, ThrowOnError, "fields">;
|
|
246
|
+
/**
|
|
247
|
+
* Create Connection
|
|
248
|
+
*
|
|
249
|
+
* Create a new data connection for external system integration.
|
|
250
|
+
*
|
|
251
|
+
* This endpoint initiates connections to external data sources:
|
|
252
|
+
*
|
|
253
|
+
* **SEC Connections**:
|
|
254
|
+
* - Provide entity CIK for automatic filing retrieval
|
|
255
|
+
* - No authentication needed
|
|
256
|
+
* - Begins immediate data sync
|
|
257
|
+
*
|
|
258
|
+
* **QuickBooks Connections**:
|
|
259
|
+
* - Returns OAuth URL for authorization
|
|
260
|
+
* - Requires admin permissions in QuickBooks
|
|
261
|
+
* - Complete with OAuth callback
|
|
262
|
+
*
|
|
263
|
+
* Note:
|
|
264
|
+
* This operation is included - no credit consumption required.
|
|
265
|
+
*/
|
|
266
|
+
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
|
|
267
|
+
/**
|
|
268
|
+
* List Connection Options
|
|
269
|
+
*
|
|
270
|
+
* Get metadata about all available data connection providers.
|
|
271
|
+
*
|
|
272
|
+
* This endpoint returns comprehensive information about each supported provider:
|
|
273
|
+
*
|
|
274
|
+
* **SEC EDGAR**: Public entity financial filings
|
|
275
|
+
* - No authentication required (public data)
|
|
276
|
+
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
277
|
+
* - Historical and real-time filing access
|
|
278
|
+
*
|
|
279
|
+
* **QuickBooks Online**: Full accounting system integration
|
|
280
|
+
* - OAuth 2.0 authentication
|
|
281
|
+
* - Chart of accounts, transactions, trial balance
|
|
282
|
+
* - Real-time sync capabilities
|
|
283
|
+
*
|
|
284
|
+
* No credits are consumed for viewing connection options.
|
|
285
|
+
*/
|
|
286
|
+
export declare const getConnectionOptions: <ThrowOnError extends boolean = false>(options: Options<GetConnectionOptionsData, ThrowOnError>) => import("./client").RequestResult<GetConnectionOptionsResponses, GetConnectionOptionsErrors, ThrowOnError, "fields">;
|
|
287
|
+
/**
|
|
288
|
+
* Init Oauth
|
|
289
|
+
*
|
|
290
|
+
* Initialize OAuth flow for a connection.
|
|
291
|
+
*
|
|
292
|
+
* This generates an authorization URL that the frontend should redirect the user to.
|
|
293
|
+
* Currently supports: QuickBooks
|
|
294
|
+
*/
|
|
295
|
+
export declare const initOAuth: <ThrowOnError extends boolean = false>(options: Options<InitOAuthData, ThrowOnError>) => import("./client").RequestResult<InitOAuthResponses, InitOAuthErrors, ThrowOnError, "fields">;
|
|
296
|
+
/**
|
|
297
|
+
* OAuth Callback
|
|
298
|
+
*
|
|
299
|
+
* Handle OAuth callback from provider after user authorization.
|
|
300
|
+
*
|
|
301
|
+
* This endpoint completes the OAuth flow:
|
|
302
|
+
* 1. Validates the OAuth state parameter
|
|
303
|
+
* 2. Exchanges authorization code for access tokens
|
|
304
|
+
* 3. Stores tokens securely
|
|
305
|
+
* 4. Updates connection status
|
|
306
|
+
* 5. Optionally triggers initial sync
|
|
307
|
+
*
|
|
308
|
+
* Supported providers:
|
|
309
|
+
* - **QuickBooks**: Accounting data integration
|
|
310
|
+
*
|
|
311
|
+
* Security measures:
|
|
312
|
+
* - State validation prevents session hijacking
|
|
313
|
+
* - User context is verified
|
|
314
|
+
* - Tokens are encrypted before storage
|
|
315
|
+
* - Full audit trail is maintained
|
|
316
|
+
*
|
|
317
|
+
* No credits are consumed for OAuth callbacks.
|
|
318
|
+
*/
|
|
319
|
+
export declare const oauthCallback: <ThrowOnError extends boolean = false>(options: Options<OauthCallbackData, ThrowOnError>) => import("./client").RequestResult<OauthCallbackResponses, OauthCallbackErrors, ThrowOnError, "fields">;
|
|
320
|
+
/**
|
|
321
|
+
* Delete Connection
|
|
322
|
+
*
|
|
323
|
+
* Delete a data connection and clean up related resources.
|
|
324
|
+
*
|
|
325
|
+
* This operation:
|
|
326
|
+
* - Removes the connection configuration
|
|
327
|
+
* - Preserves any imported data in the graph
|
|
328
|
+
* - Performs provider-specific cleanup
|
|
329
|
+
* - Revokes stored credentials
|
|
330
|
+
*
|
|
331
|
+
* Note:
|
|
332
|
+
* This operation is included - no credit consumption required.
|
|
333
|
+
*
|
|
334
|
+
* Only users with admin role can delete connections.
|
|
335
|
+
*/
|
|
336
|
+
export declare const deleteConnection: <ThrowOnError extends boolean = false>(options: Options<DeleteConnectionData, ThrowOnError>) => import("./client").RequestResult<DeleteConnectionResponses, DeleteConnectionErrors, ThrowOnError, "fields">;
|
|
337
|
+
/**
|
|
338
|
+
* Get Connection
|
|
339
|
+
*
|
|
340
|
+
* Get detailed information about a specific connection.
|
|
341
|
+
*
|
|
342
|
+
* Returns comprehensive connection details including:
|
|
343
|
+
* - Current status and health indicators
|
|
344
|
+
* - Authentication state
|
|
345
|
+
* - Sync history and statistics
|
|
346
|
+
* - Error details if any
|
|
347
|
+
* - Provider-specific metadata
|
|
348
|
+
*
|
|
349
|
+
* No credits are consumed for viewing connection details.
|
|
350
|
+
*/
|
|
351
|
+
export declare const getConnection: <ThrowOnError extends boolean = false>(options: Options<GetConnectionData, ThrowOnError>) => import("./client").RequestResult<GetConnectionResponses, GetConnectionErrors, ThrowOnError, "fields">;
|
|
352
|
+
/**
|
|
353
|
+
* Sync Connection
|
|
354
|
+
*
|
|
355
|
+
* Trigger a data synchronization for the connection.
|
|
356
|
+
*
|
|
357
|
+
* Initiates data sync based on provider type:
|
|
358
|
+
*
|
|
359
|
+
* **SEC Sync**:
|
|
360
|
+
* - Downloads latest filings from EDGAR
|
|
361
|
+
* - Parses XBRL data and updates graph
|
|
362
|
+
* - Typically completes in 5-10 minutes
|
|
363
|
+
*
|
|
364
|
+
* **QuickBooks Sync**:
|
|
365
|
+
* - Fetches latest transactions and balances
|
|
366
|
+
* - Updates chart of accounts
|
|
367
|
+
* - Generates fresh trial balance
|
|
368
|
+
* - Duration depends on data volume
|
|
369
|
+
*
|
|
370
|
+
* Note:
|
|
371
|
+
* This operation is included - no credit consumption required.
|
|
372
|
+
*
|
|
373
|
+
* Returns a task ID for monitoring sync progress.
|
|
374
|
+
*/
|
|
375
|
+
export declare const syncConnection: <ThrowOnError extends boolean = false>(options: Options<SyncConnectionData, ThrowOnError>) => import("./client").RequestResult<SyncConnectionResponses, SyncConnectionErrors, ThrowOnError, "fields">;
|
|
233
376
|
/**
|
|
234
377
|
* List available agents
|
|
235
378
|
*
|
|
@@ -1149,10 +1292,10 @@ export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1149
1292
|
* - Total size usage across all subgraphs
|
|
1150
1293
|
*
|
|
1151
1294
|
* **Tier Limits:**
|
|
1152
|
-
* - Standard:
|
|
1153
|
-
* -
|
|
1154
|
-
* -
|
|
1155
|
-
* - Limits are defined in deployment configuration
|
|
1295
|
+
* - Standard: Up to 3 subgraphs (dedicated m7g.large instance)
|
|
1296
|
+
* - Large: Up to 10 subgraphs (dedicated r7g.large instance)
|
|
1297
|
+
* - XLarge: Up to 25 subgraphs (dedicated r7g.xlarge instance)
|
|
1298
|
+
* - Limits are defined in graph.yml deployment configuration
|
|
1156
1299
|
*
|
|
1157
1300
|
* **Size Tracking:**
|
|
1158
1301
|
* Provides aggregate size metrics when available.
|
|
@@ -1290,6 +1433,16 @@ export declare const listTables: <ThrowOnError extends boolean = false>(options:
|
|
|
1290
1433
|
* Staging table queries are included - no credit consumption
|
|
1291
1434
|
*/
|
|
1292
1435
|
export declare const queryTables: <ThrowOnError extends boolean = false>(options: Options<QueryTablesData, ThrowOnError>) => import("./client").RequestResult<QueryTablesResponses, QueryTablesErrors, ThrowOnError, "fields">;
|
|
1436
|
+
/**
|
|
1437
|
+
* Create View
|
|
1438
|
+
*
|
|
1439
|
+
* Build a fact grid from existing facts in the graph.
|
|
1440
|
+
*
|
|
1441
|
+
* Queries Fact nodes by element qnames or canonical concepts, with optional
|
|
1442
|
+
* filters for periods, entities, filing form, fiscal context, and period type.
|
|
1443
|
+
* Returns deduplicated consolidated facts as a pivot table.
|
|
1444
|
+
*/
|
|
1445
|
+
export declare const createView: <ThrowOnError extends boolean = false>(options: Options<CreateViewData, ThrowOnError>) => import("./client").RequestResult<CreateViewResponses, CreateViewErrors, ThrowOnError, "fields">;
|
|
1293
1446
|
/**
|
|
1294
1447
|
* Get Materialization Status
|
|
1295
1448
|
*
|
|
@@ -1685,7 +1838,7 @@ export declare const createGraph: <ThrowOnError extends boolean = false>(options
|
|
|
1685
1838
|
*
|
|
1686
1839
|
* **Available Extensions:**
|
|
1687
1840
|
* - **RoboLedger**: Complete accounting system with XBRL reporting, general ledger, and financial statements
|
|
1688
|
-
* - **RoboInvestor**: Investment portfolio management and
|
|
1841
|
+
* - **RoboInvestor**: Investment portfolio management with securities tracking, trade execution, and risk analysis
|
|
1689
1842
|
* - **RoboSCM**: Supply chain management and logistics
|
|
1690
1843
|
* - **RoboFO**: Front office operations and CRM
|
|
1691
1844
|
* - **RoboHRM**: Human resources management
|
package/sdk.gen.js
CHANGED
|
@@ -1,8 +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.
|
|
5
|
-
exports.
|
|
4
|
+
exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = 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.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.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.materializeGraph = exports.getMaterializationStatus = exports.createView = exports.queryTables = 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 = void 0;
|
|
6
|
+
exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = void 0;
|
|
6
7
|
const client_gen_1 = require("./client.gen");
|
|
7
8
|
/**
|
|
8
9
|
* Register New User
|
|
@@ -287,21 +288,6 @@ const listUserOrgs = (options) => (options?.client ?? client_gen_1.client).get({
|
|
|
287
288
|
...options
|
|
288
289
|
});
|
|
289
290
|
exports.listUserOrgs = listUserOrgs;
|
|
290
|
-
/**
|
|
291
|
-
* Create Organization
|
|
292
|
-
*
|
|
293
|
-
* Create a new organization. The creating user becomes the owner.
|
|
294
|
-
*/
|
|
295
|
-
const createOrg = (options) => (options.client ?? client_gen_1.client).post({
|
|
296
|
-
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
297
|
-
url: '/v1/orgs',
|
|
298
|
-
...options,
|
|
299
|
-
headers: {
|
|
300
|
-
'Content-Type': 'application/json',
|
|
301
|
-
...options.headers
|
|
302
|
-
}
|
|
303
|
-
});
|
|
304
|
-
exports.createOrg = createOrg;
|
|
305
291
|
/**
|
|
306
292
|
* Get Organization
|
|
307
293
|
*
|
|
@@ -416,6 +402,211 @@ const getOrgUsage = (options) => (options.client ?? client_gen_1.client).get({
|
|
|
416
402
|
...options
|
|
417
403
|
});
|
|
418
404
|
exports.getOrgUsage = getOrgUsage;
|
|
405
|
+
/**
|
|
406
|
+
* List Connections
|
|
407
|
+
*
|
|
408
|
+
* List all data connections in the graph.
|
|
409
|
+
*
|
|
410
|
+
* Returns active and inactive connections with their current status.
|
|
411
|
+
* Connections can be filtered by:
|
|
412
|
+
* - **Entity**: Show connections for a specific entity
|
|
413
|
+
* - **Provider**: Filter by connection type (sec, quickbooks)
|
|
414
|
+
*
|
|
415
|
+
* Each connection shows:
|
|
416
|
+
* - Current sync status and health
|
|
417
|
+
* - Last successful sync timestamp
|
|
418
|
+
* - Configuration metadata
|
|
419
|
+
* - Error messages if any
|
|
420
|
+
*
|
|
421
|
+
* No credits are consumed for listing connections.
|
|
422
|
+
*/
|
|
423
|
+
const listConnections = (options) => (options.client ?? client_gen_1.client).get({
|
|
424
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
425
|
+
url: '/v1/graphs/{graph_id}/connections',
|
|
426
|
+
...options
|
|
427
|
+
});
|
|
428
|
+
exports.listConnections = listConnections;
|
|
429
|
+
/**
|
|
430
|
+
* Create Connection
|
|
431
|
+
*
|
|
432
|
+
* Create a new data connection for external system integration.
|
|
433
|
+
*
|
|
434
|
+
* This endpoint initiates connections to external data sources:
|
|
435
|
+
*
|
|
436
|
+
* **SEC Connections**:
|
|
437
|
+
* - Provide entity CIK for automatic filing retrieval
|
|
438
|
+
* - No authentication needed
|
|
439
|
+
* - Begins immediate data sync
|
|
440
|
+
*
|
|
441
|
+
* **QuickBooks Connections**:
|
|
442
|
+
* - Returns OAuth URL for authorization
|
|
443
|
+
* - Requires admin permissions in QuickBooks
|
|
444
|
+
* - Complete with OAuth callback
|
|
445
|
+
*
|
|
446
|
+
* Note:
|
|
447
|
+
* This operation is included - no credit consumption required.
|
|
448
|
+
*/
|
|
449
|
+
const createConnection = (options) => (options.client ?? client_gen_1.client).post({
|
|
450
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
451
|
+
url: '/v1/graphs/{graph_id}/connections',
|
|
452
|
+
...options,
|
|
453
|
+
headers: {
|
|
454
|
+
'Content-Type': 'application/json',
|
|
455
|
+
...options.headers
|
|
456
|
+
}
|
|
457
|
+
});
|
|
458
|
+
exports.createConnection = createConnection;
|
|
459
|
+
/**
|
|
460
|
+
* List Connection Options
|
|
461
|
+
*
|
|
462
|
+
* Get metadata about all available data connection providers.
|
|
463
|
+
*
|
|
464
|
+
* This endpoint returns comprehensive information about each supported provider:
|
|
465
|
+
*
|
|
466
|
+
* **SEC EDGAR**: Public entity financial filings
|
|
467
|
+
* - No authentication required (public data)
|
|
468
|
+
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
469
|
+
* - Historical and real-time filing access
|
|
470
|
+
*
|
|
471
|
+
* **QuickBooks Online**: Full accounting system integration
|
|
472
|
+
* - OAuth 2.0 authentication
|
|
473
|
+
* - Chart of accounts, transactions, trial balance
|
|
474
|
+
* - Real-time sync capabilities
|
|
475
|
+
*
|
|
476
|
+
* No credits are consumed for viewing connection options.
|
|
477
|
+
*/
|
|
478
|
+
const getConnectionOptions = (options) => (options.client ?? client_gen_1.client).get({
|
|
479
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
480
|
+
url: '/v1/graphs/{graph_id}/connections/options',
|
|
481
|
+
...options
|
|
482
|
+
});
|
|
483
|
+
exports.getConnectionOptions = getConnectionOptions;
|
|
484
|
+
/**
|
|
485
|
+
* Init Oauth
|
|
486
|
+
*
|
|
487
|
+
* Initialize OAuth flow for a connection.
|
|
488
|
+
*
|
|
489
|
+
* This generates an authorization URL that the frontend should redirect the user to.
|
|
490
|
+
* Currently supports: QuickBooks
|
|
491
|
+
*/
|
|
492
|
+
const initOAuth = (options) => (options.client ?? client_gen_1.client).post({
|
|
493
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
494
|
+
url: '/v1/graphs/{graph_id}/connections/oauth/init',
|
|
495
|
+
...options,
|
|
496
|
+
headers: {
|
|
497
|
+
'Content-Type': 'application/json',
|
|
498
|
+
...options.headers
|
|
499
|
+
}
|
|
500
|
+
});
|
|
501
|
+
exports.initOAuth = initOAuth;
|
|
502
|
+
/**
|
|
503
|
+
* OAuth Callback
|
|
504
|
+
*
|
|
505
|
+
* Handle OAuth callback from provider after user authorization.
|
|
506
|
+
*
|
|
507
|
+
* This endpoint completes the OAuth flow:
|
|
508
|
+
* 1. Validates the OAuth state parameter
|
|
509
|
+
* 2. Exchanges authorization code for access tokens
|
|
510
|
+
* 3. Stores tokens securely
|
|
511
|
+
* 4. Updates connection status
|
|
512
|
+
* 5. Optionally triggers initial sync
|
|
513
|
+
*
|
|
514
|
+
* Supported providers:
|
|
515
|
+
* - **QuickBooks**: Accounting data integration
|
|
516
|
+
*
|
|
517
|
+
* Security measures:
|
|
518
|
+
* - State validation prevents session hijacking
|
|
519
|
+
* - User context is verified
|
|
520
|
+
* - Tokens are encrypted before storage
|
|
521
|
+
* - Full audit trail is maintained
|
|
522
|
+
*
|
|
523
|
+
* No credits are consumed for OAuth callbacks.
|
|
524
|
+
*/
|
|
525
|
+
const oauthCallback = (options) => (options.client ?? client_gen_1.client).post({
|
|
526
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
527
|
+
url: '/v1/graphs/{graph_id}/connections/oauth/callback/{provider}',
|
|
528
|
+
...options,
|
|
529
|
+
headers: {
|
|
530
|
+
'Content-Type': 'application/json',
|
|
531
|
+
...options.headers
|
|
532
|
+
}
|
|
533
|
+
});
|
|
534
|
+
exports.oauthCallback = oauthCallback;
|
|
535
|
+
/**
|
|
536
|
+
* Delete Connection
|
|
537
|
+
*
|
|
538
|
+
* Delete a data connection and clean up related resources.
|
|
539
|
+
*
|
|
540
|
+
* This operation:
|
|
541
|
+
* - Removes the connection configuration
|
|
542
|
+
* - Preserves any imported data in the graph
|
|
543
|
+
* - Performs provider-specific cleanup
|
|
544
|
+
* - Revokes stored credentials
|
|
545
|
+
*
|
|
546
|
+
* Note:
|
|
547
|
+
* This operation is included - no credit consumption required.
|
|
548
|
+
*
|
|
549
|
+
* Only users with admin role can delete connections.
|
|
550
|
+
*/
|
|
551
|
+
const deleteConnection = (options) => (options.client ?? client_gen_1.client).delete({
|
|
552
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
553
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
554
|
+
...options
|
|
555
|
+
});
|
|
556
|
+
exports.deleteConnection = deleteConnection;
|
|
557
|
+
/**
|
|
558
|
+
* Get Connection
|
|
559
|
+
*
|
|
560
|
+
* Get detailed information about a specific connection.
|
|
561
|
+
*
|
|
562
|
+
* Returns comprehensive connection details including:
|
|
563
|
+
* - Current status and health indicators
|
|
564
|
+
* - Authentication state
|
|
565
|
+
* - Sync history and statistics
|
|
566
|
+
* - Error details if any
|
|
567
|
+
* - Provider-specific metadata
|
|
568
|
+
*
|
|
569
|
+
* No credits are consumed for viewing connection details.
|
|
570
|
+
*/
|
|
571
|
+
const getConnection = (options) => (options.client ?? client_gen_1.client).get({
|
|
572
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
573
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}',
|
|
574
|
+
...options
|
|
575
|
+
});
|
|
576
|
+
exports.getConnection = getConnection;
|
|
577
|
+
/**
|
|
578
|
+
* Sync Connection
|
|
579
|
+
*
|
|
580
|
+
* Trigger a data synchronization for the connection.
|
|
581
|
+
*
|
|
582
|
+
* Initiates data sync based on provider type:
|
|
583
|
+
*
|
|
584
|
+
* **SEC Sync**:
|
|
585
|
+
* - Downloads latest filings from EDGAR
|
|
586
|
+
* - Parses XBRL data and updates graph
|
|
587
|
+
* - Typically completes in 5-10 minutes
|
|
588
|
+
*
|
|
589
|
+
* **QuickBooks Sync**:
|
|
590
|
+
* - Fetches latest transactions and balances
|
|
591
|
+
* - Updates chart of accounts
|
|
592
|
+
* - Generates fresh trial balance
|
|
593
|
+
* - Duration depends on data volume
|
|
594
|
+
*
|
|
595
|
+
* Note:
|
|
596
|
+
* This operation is included - no credit consumption required.
|
|
597
|
+
*
|
|
598
|
+
* Returns a task ID for monitoring sync progress.
|
|
599
|
+
*/
|
|
600
|
+
const syncConnection = (options) => (options.client ?? client_gen_1.client).post({
|
|
601
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
602
|
+
url: '/v1/graphs/{graph_id}/connections/{connection_id}/sync',
|
|
603
|
+
...options,
|
|
604
|
+
headers: {
|
|
605
|
+
'Content-Type': 'application/json',
|
|
606
|
+
...options.headers
|
|
607
|
+
}
|
|
608
|
+
});
|
|
609
|
+
exports.syncConnection = syncConnection;
|
|
419
610
|
/**
|
|
420
611
|
* List available agents
|
|
421
612
|
*
|
|
@@ -1534,10 +1725,10 @@ exports.getSubgraphInfo = getSubgraphInfo;
|
|
|
1534
1725
|
* - Total size usage across all subgraphs
|
|
1535
1726
|
*
|
|
1536
1727
|
* **Tier Limits:**
|
|
1537
|
-
* - Standard:
|
|
1538
|
-
* -
|
|
1539
|
-
* -
|
|
1540
|
-
* - Limits are defined in deployment configuration
|
|
1728
|
+
* - Standard: Up to 3 subgraphs (dedicated m7g.large instance)
|
|
1729
|
+
* - Large: Up to 10 subgraphs (dedicated r7g.large instance)
|
|
1730
|
+
* - XLarge: Up to 25 subgraphs (dedicated r7g.xlarge instance)
|
|
1731
|
+
* - Limits are defined in graph.yml deployment configuration
|
|
1541
1732
|
*
|
|
1542
1733
|
* **Size Tracking:**
|
|
1543
1734
|
* Provides aggregate size metrics when available.
|
|
@@ -1717,6 +1908,25 @@ const queryTables = (options) => (options.client ?? client_gen_1.client).post({
|
|
|
1717
1908
|
}
|
|
1718
1909
|
});
|
|
1719
1910
|
exports.queryTables = queryTables;
|
|
1911
|
+
/**
|
|
1912
|
+
* Create View
|
|
1913
|
+
*
|
|
1914
|
+
* Build a fact grid from existing facts in the graph.
|
|
1915
|
+
*
|
|
1916
|
+
* Queries Fact nodes by element qnames or canonical concepts, with optional
|
|
1917
|
+
* filters for periods, entities, filing form, fiscal context, and period type.
|
|
1918
|
+
* Returns deduplicated consolidated facts as a pivot table.
|
|
1919
|
+
*/
|
|
1920
|
+
const createView = (options) => (options.client ?? client_gen_1.client).post({
|
|
1921
|
+
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
1922
|
+
url: '/v1/graphs/{graph_id}/views',
|
|
1923
|
+
...options,
|
|
1924
|
+
headers: {
|
|
1925
|
+
'Content-Type': 'application/json',
|
|
1926
|
+
...options.headers
|
|
1927
|
+
}
|
|
1928
|
+
});
|
|
1929
|
+
exports.createView = createView;
|
|
1720
1930
|
/**
|
|
1721
1931
|
* Get Materialization Status
|
|
1722
1932
|
*
|
|
@@ -2173,7 +2383,7 @@ exports.createGraph = createGraph;
|
|
|
2173
2383
|
*
|
|
2174
2384
|
* **Available Extensions:**
|
|
2175
2385
|
* - **RoboLedger**: Complete accounting system with XBRL reporting, general ledger, and financial statements
|
|
2176
|
-
* - **RoboInvestor**: Investment portfolio management and
|
|
2386
|
+
* - **RoboInvestor**: Investment portfolio management with securities tracking, trade execution, and risk analysis
|
|
2177
2387
|
* - **RoboSCM**: Supply chain management and logistics
|
|
2178
2388
|
* - **RoboFO**: Front office operations and CRM
|
|
2179
2389
|
* - **RoboHRM**: Human resources management
|