@robosystems/client 0.1.14 → 0.1.15
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 +3 -5
- package/package.json +2 -2
- package/prepare.js +15 -16
- package/sdk.gen.d.ts +46 -48
- package/sdk.gen.js +83 -69
- package/sdk.gen.ts +82 -68
- package/types.gen.d.ts +74 -90
- package/types.gen.ts +84 -93
package/sdk.gen.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.
|
|
5
|
-
exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.getAvailableExtensions = exports.createGraph = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.getCreditBillingInfoV1GraphIdBillingCreditsGet = exports.getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet = exports.getGraphSubscriptionV1GraphIdBillingSubscriptionGet = exports.upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost = exports.getGraphPricingInfoV1GraphIdBillingPricingGet = exports.getGraphUsageDetails = exports.getGraphBillingHistory = exports.getGraphMonthlyBill = exports.getCurrentGraphBill = exports.listSchemaExtensions = exports.exportGraphSchema = exports.validateSchema = exports.getGraphSchemaInfo = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupDownloadUrl = exports.kuzuBackupHealth = exports.getBackupStats = exports.restoreBackup = void 0;
|
|
4
|
+
exports.listBackups = exports.createBackup = exports.callMcpTool = exports.listMcpTools = exports.queryFinancialAgent = exports.oauthCallback = exports.initOAuth = exports.exchangeLinkToken = exports.createLinkToken = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.listConnections = exports.getConnectionOptions = exports.getRepositoryCredits = exports.getSharedRepositoryCredits = exports.cancelSharedRepositorySubscription = exports.upgradeSharedRepositorySubscription = exports.subscribeToSharedRepository = exports.getUserSharedSubscriptions = exports.getDetailedUserAnalytics = exports.getUserUsageOverview = exports.getAllSharedRepositoryLimits = exports.getSharedRepositoryLimits = exports.getUserUsage = exports.getUserLimits = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.getAllCreditSummaries = exports.selectUserGraph = exports.getUserGraphs = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.ssoLogin = exports.generateSsoToken = exports.refreshSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
|
|
5
|
+
exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.getAvailableExtensions = exports.createGraph = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.getCreditBillingInfoV1GraphIdBillingCreditsGet = exports.getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet = exports.getGraphSubscriptionV1GraphIdBillingSubscriptionGet = exports.upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost = exports.getGraphPricingInfoV1GraphIdBillingPricingGet = exports.getGraphUsageDetails = exports.getGraphBillingHistory = exports.getGraphMonthlyBill = exports.getCurrentGraphBill = exports.listSchemaExtensions = exports.exportGraphSchema = exports.validateSchema = exports.getGraphSchemaInfo = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupDownloadUrl = exports.kuzuBackupHealth = exports.getBackupStats = exports.restoreBackup = exports.exportBackup = void 0;
|
|
6
6
|
const client_gen_1 = require("./client.gen");
|
|
7
7
|
/**
|
|
8
8
|
* Register New User
|
|
@@ -171,27 +171,6 @@ const getServiceStatus = (options) => {
|
|
|
171
171
|
});
|
|
172
172
|
};
|
|
173
173
|
exports.getServiceStatus = getServiceStatus;
|
|
174
|
-
/**
|
|
175
|
-
* MCP System Health Check
|
|
176
|
-
* Basic health check for MCP system components
|
|
177
|
-
*/
|
|
178
|
-
const getMcpHealth = (options) => {
|
|
179
|
-
return (options?.client ?? client_gen_1.client).get({
|
|
180
|
-
security: [
|
|
181
|
-
{
|
|
182
|
-
name: 'X-API-Key',
|
|
183
|
-
type: 'apiKey'
|
|
184
|
-
},
|
|
185
|
-
{
|
|
186
|
-
scheme: 'bearer',
|
|
187
|
-
type: 'http'
|
|
188
|
-
}
|
|
189
|
-
],
|
|
190
|
-
url: '/v1/mcp/health',
|
|
191
|
-
...options
|
|
192
|
-
});
|
|
193
|
-
};
|
|
194
|
-
exports.getMcpHealth = getMcpHealth;
|
|
195
174
|
/**
|
|
196
175
|
* Get Current User
|
|
197
176
|
* Returns information about the currently authenticated user.
|
|
@@ -275,7 +254,7 @@ const selectUserGraph = (options) => {
|
|
|
275
254
|
type: 'http'
|
|
276
255
|
}
|
|
277
256
|
],
|
|
278
|
-
url: '/v1/user/graphs/
|
|
257
|
+
url: '/v1/user/graphs/{graph_id}/select',
|
|
279
258
|
...options
|
|
280
259
|
});
|
|
281
260
|
};
|
|
@@ -466,6 +445,56 @@ const getUserUsage = (options) => {
|
|
|
466
445
|
});
|
|
467
446
|
};
|
|
468
447
|
exports.getUserUsage = getUserUsage;
|
|
448
|
+
/**
|
|
449
|
+
* Get shared repository rate limit status
|
|
450
|
+
* Get current rate limit status and usage for a shared repository.
|
|
451
|
+
*
|
|
452
|
+
* Returns:
|
|
453
|
+
* - Current usage across different time windows
|
|
454
|
+
* - Rate limits based on subscription tier
|
|
455
|
+
* - Remaining quota
|
|
456
|
+
* - Reset times
|
|
457
|
+
*
|
|
458
|
+
* Note: All queries are FREE - this only shows rate limit status.
|
|
459
|
+
*/
|
|
460
|
+
const getSharedRepositoryLimits = (options) => {
|
|
461
|
+
return (options.client ?? client_gen_1.client).get({
|
|
462
|
+
security: [
|
|
463
|
+
{
|
|
464
|
+
name: 'X-API-Key',
|
|
465
|
+
type: 'apiKey'
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
scheme: 'bearer',
|
|
469
|
+
type: 'http'
|
|
470
|
+
}
|
|
471
|
+
],
|
|
472
|
+
url: '/v1/user/limits/shared-repositories/{repository}',
|
|
473
|
+
...options
|
|
474
|
+
});
|
|
475
|
+
};
|
|
476
|
+
exports.getSharedRepositoryLimits = getSharedRepositoryLimits;
|
|
477
|
+
/**
|
|
478
|
+
* Get all shared repository limits
|
|
479
|
+
* Get rate limit status for all shared repositories the user has access to.
|
|
480
|
+
*/
|
|
481
|
+
const getAllSharedRepositoryLimits = (options) => {
|
|
482
|
+
return (options?.client ?? client_gen_1.client).get({
|
|
483
|
+
security: [
|
|
484
|
+
{
|
|
485
|
+
name: 'X-API-Key',
|
|
486
|
+
type: 'apiKey'
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
scheme: 'bearer',
|
|
490
|
+
type: 'http'
|
|
491
|
+
}
|
|
492
|
+
],
|
|
493
|
+
url: '/v1/user/limits/shared-repositories/summary',
|
|
494
|
+
...options
|
|
495
|
+
});
|
|
496
|
+
};
|
|
497
|
+
exports.getAllSharedRepositoryLimits = getAllSharedRepositoryLimits;
|
|
469
498
|
/**
|
|
470
499
|
* Get User Usage Overview
|
|
471
500
|
* Get a high-level overview of usage statistics for the current user.
|
|
@@ -623,7 +652,7 @@ const getSharedRepositoryCredits = (options) => {
|
|
|
623
652
|
exports.getSharedRepositoryCredits = getSharedRepositoryCredits;
|
|
624
653
|
/**
|
|
625
654
|
* Get Repository Credits
|
|
626
|
-
* Get credit balance for a specific shared repository
|
|
655
|
+
* Get credit balance for a specific shared repository
|
|
627
656
|
*/
|
|
628
657
|
const getRepositoryCredits = (options) => {
|
|
629
658
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -637,7 +666,7 @@ const getRepositoryCredits = (options) => {
|
|
|
637
666
|
type: 'http'
|
|
638
667
|
}
|
|
639
668
|
],
|
|
640
|
-
url: '/v1/user/subscriptions/shared-repositories/credits/{
|
|
669
|
+
url: '/v1/user/subscriptions/shared-repositories/credits/{repository}',
|
|
641
670
|
...options
|
|
642
671
|
});
|
|
643
672
|
};
|
|
@@ -737,10 +766,8 @@ exports.listConnections = listConnections;
|
|
|
737
766
|
* - User completes bank authentication
|
|
738
767
|
* - Exchange public token for access
|
|
739
768
|
*
|
|
740
|
-
*
|
|
741
|
-
* -
|
|
742
|
-
* - Multiplied by graph tier
|
|
743
|
-
* - Additional credits consumed during data sync
|
|
769
|
+
* Note:
|
|
770
|
+
* This operation is FREE - no credit consumption required.
|
|
744
771
|
*/
|
|
745
772
|
const createConnection = (options) => {
|
|
746
773
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -773,9 +800,8 @@ exports.createConnection = createConnection;
|
|
|
773
800
|
* - Performs provider-specific cleanup
|
|
774
801
|
* - Revokes stored credentials
|
|
775
802
|
*
|
|
776
|
-
*
|
|
777
|
-
* -
|
|
778
|
-
* - Multiplied by graph tier
|
|
803
|
+
* Note:
|
|
804
|
+
* This operation is FREE - no credit consumption required.
|
|
779
805
|
*
|
|
780
806
|
* Only users with admin role can delete connections.
|
|
781
807
|
*/
|
|
@@ -848,10 +874,8 @@ exports.getConnection = getConnection;
|
|
|
848
874
|
* - Updates account balances
|
|
849
875
|
* - Categorizes new transactions
|
|
850
876
|
*
|
|
851
|
-
*
|
|
852
|
-
* -
|
|
853
|
-
* - Multiplied by graph tier
|
|
854
|
-
* - Additional credits may be consumed during processing
|
|
877
|
+
* Note:
|
|
878
|
+
* This operation is FREE - no credit consumption required.
|
|
855
879
|
*
|
|
856
880
|
* Returns a task ID for monitoring sync progress.
|
|
857
881
|
*/
|
|
@@ -1071,10 +1095,10 @@ exports.oauthCallback = oauthCallback;
|
|
|
1071
1095
|
* - Fallback to status polling endpoint if SSE unavailable
|
|
1072
1096
|
*
|
|
1073
1097
|
* **Credit Consumption:**
|
|
1074
|
-
* -
|
|
1075
|
-
* -
|
|
1076
|
-
* -
|
|
1077
|
-
* -
|
|
1098
|
+
* - AI operations consume credits based on actual token usage
|
|
1099
|
+
* - Claude 4 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
|
|
1100
|
+
* - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
|
|
1101
|
+
* - Credits are consumed after operation completes based on actual usage
|
|
1078
1102
|
*
|
|
1079
1103
|
* The agent automatically determines query complexity or you can force extended analysis.
|
|
1080
1104
|
*/
|
|
@@ -1168,11 +1192,8 @@ exports.listMcpTools = listMcpTools;
|
|
|
1168
1192
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
1169
1193
|
* - Clients should implement exponential backoff on errors
|
|
1170
1194
|
*
|
|
1171
|
-
* **
|
|
1172
|
-
*
|
|
1173
|
-
* - Schema tools: 5-10 credits
|
|
1174
|
-
* - Query tools: 10-50 credits (based on complexity)
|
|
1175
|
-
* - Multiplied by graph tier
|
|
1195
|
+
* **Note:**
|
|
1196
|
+
* MCP tool calls are currently FREE and do not consume credits.
|
|
1176
1197
|
*/
|
|
1177
1198
|
const callMcpTool = (options) => {
|
|
1178
1199
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1431,7 +1452,7 @@ const getBackupDownloadUrl = (options) => {
|
|
|
1431
1452
|
type: 'http'
|
|
1432
1453
|
}
|
|
1433
1454
|
],
|
|
1434
|
-
url: '/v1/{graph_id}/backup/{backup_id}/download
|
|
1455
|
+
url: '/v1/{graph_id}/backup/{backup_id}/download',
|
|
1435
1456
|
...options
|
|
1436
1457
|
});
|
|
1437
1458
|
};
|
|
@@ -1453,9 +1474,8 @@ exports.getBackupDownloadUrl = getBackupDownloadUrl;
|
|
|
1453
1474
|
* - Capacity planning
|
|
1454
1475
|
* - Performance optimization
|
|
1455
1476
|
*
|
|
1456
|
-
*
|
|
1457
|
-
* -
|
|
1458
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
1477
|
+
* Note:
|
|
1478
|
+
* This operation is FREE - no credit consumption required.
|
|
1459
1479
|
*/
|
|
1460
1480
|
const getGraphMetrics = (options) => {
|
|
1461
1481
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1497,9 +1517,8 @@ exports.getGraphMetrics = getGraphMetrics;
|
|
|
1497
1517
|
* - Usage trend analysis
|
|
1498
1518
|
* - Performance tuning
|
|
1499
1519
|
*
|
|
1500
|
-
*
|
|
1501
|
-
* -
|
|
1502
|
-
* - Multiplied by graph tier
|
|
1520
|
+
* Note:
|
|
1521
|
+
* This operation is FREE - no credit consumption required.
|
|
1503
1522
|
*/
|
|
1504
1523
|
const getGraphUsageStats = (options) => {
|
|
1505
1524
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1531,7 +1550,7 @@ exports.getGraphUsageStats = getGraphUsageStats;
|
|
|
1531
1550
|
* **Response Modes:**
|
|
1532
1551
|
* - `auto` (default): Intelligent automatic selection
|
|
1533
1552
|
* - `sync`: Force synchronous JSON response (best for testing)
|
|
1534
|
-
* - `async`: Force queued response with polling
|
|
1553
|
+
* - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
|
|
1535
1554
|
* - `stream`: Force streaming response (SSE or NDJSON)
|
|
1536
1555
|
*
|
|
1537
1556
|
* **Client Detection:**
|
|
@@ -1554,19 +1573,19 @@ exports.getGraphUsageStats = getGraphUsageStats;
|
|
|
1554
1573
|
*
|
|
1555
1574
|
* **Queue Management:**
|
|
1556
1575
|
* - Automatic queuing under high load
|
|
1557
|
-
* -
|
|
1576
|
+
* - Real-time monitoring via SSE events (no polling needed)
|
|
1558
1577
|
* - Priority based on subscription tier
|
|
1559
|
-
* - Queue position updates via SSE
|
|
1578
|
+
* - Queue position and progress updates pushed via SSE
|
|
1579
|
+
* - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
|
|
1560
1580
|
*
|
|
1561
1581
|
* **Error Handling:**
|
|
1562
1582
|
* - `429 Too Many Requests`: Rate limit or connection limit exceeded
|
|
1563
1583
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
1564
1584
|
* - Clients should implement exponential backoff
|
|
1565
1585
|
*
|
|
1566
|
-
* **
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1569
|
-
* - Queue position based on subscription tier
|
|
1586
|
+
* **Note:**
|
|
1587
|
+
* Query operations are FREE - no credit consumption required.
|
|
1588
|
+
* Queue position is based on subscription tier for priority.
|
|
1570
1589
|
*/
|
|
1571
1590
|
const executeCypherQuery = (options) => {
|
|
1572
1591
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1601,10 +1620,7 @@ exports.executeCypherQuery = executeCypherQuery;
|
|
|
1601
1620
|
* This is different from custom schema management - it shows what actually exists in the database,
|
|
1602
1621
|
* useful for understanding the current graph structure before writing queries.
|
|
1603
1622
|
*
|
|
1604
|
-
*
|
|
1605
|
-
* - Base cost: 2.0 credits
|
|
1606
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
1607
|
-
* - Schema information is cached for performance
|
|
1623
|
+
* This operation is FREE - no credit consumption required.
|
|
1608
1624
|
*/
|
|
1609
1625
|
const getGraphSchemaInfo = (options) => {
|
|
1610
1626
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1646,9 +1662,7 @@ exports.getGraphSchemaInfo = getGraphSchemaInfo;
|
|
|
1646
1662
|
* - Performance problems
|
|
1647
1663
|
* - Naming conflicts
|
|
1648
1664
|
*
|
|
1649
|
-
*
|
|
1650
|
-
* - Base cost: 5.0 credits
|
|
1651
|
-
* - Multiplied by graph tier
|
|
1665
|
+
* This operation is FREE - no credit consumption required.
|
|
1652
1666
|
*/
|
|
1653
1667
|
const validateSchema = (options) => {
|
|
1654
1668
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2274,7 +2288,7 @@ const getAvailableExtensions = (options) => {
|
|
|
2274
2288
|
type: 'http'
|
|
2275
2289
|
}
|
|
2276
2290
|
],
|
|
2277
|
-
url: '/v1/create/graph/
|
|
2291
|
+
url: '/v1/create/graph/extensions',
|
|
2278
2292
|
...options
|
|
2279
2293
|
});
|
|
2280
2294
|
};
|
|
@@ -2288,7 +2302,7 @@ exports.getAvailableExtensions = getAvailableExtensions;
|
|
|
2288
2302
|
* applications to display subscription options.
|
|
2289
2303
|
*
|
|
2290
2304
|
* Includes:
|
|
2291
|
-
* - Graph subscription tiers (
|
|
2305
|
+
* - Graph subscription tiers (standard, enterprise, premium)
|
|
2292
2306
|
* - Shared repository subscriptions (SEC, industry, economic data)
|
|
2293
2307
|
* - Operation costs and credit information
|
|
2294
2308
|
* - Features and capabilities for each tier
|
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, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetServiceStatusData, GetServiceStatusResponses,
|
|
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, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, 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, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, 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, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, ExportBackupData, ExportBackupResponses, ExportBackupErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, KuzuBackupHealthData, KuzuBackupHealthResponses, KuzuBackupHealthErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphPricingInfoV1GraphIdBillingPricingGetData, GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, GetCreditBillingInfoV1GraphIdBillingCreditsGetData, GetCreditBillingInfoV1GraphIdBillingCreditsGetResponses, GetCreditBillingInfoV1GraphIdBillingCreditsGetErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, 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> & {
|
|
@@ -185,27 +185,6 @@ export const getServiceStatus = <ThrowOnError extends boolean = false>(options?:
|
|
|
185
185
|
});
|
|
186
186
|
};
|
|
187
187
|
|
|
188
|
-
/**
|
|
189
|
-
* MCP System Health Check
|
|
190
|
-
* Basic health check for MCP system components
|
|
191
|
-
*/
|
|
192
|
-
export const getMcpHealth = <ThrowOnError extends boolean = false>(options?: Options<GetMcpHealthData, ThrowOnError>) => {
|
|
193
|
-
return (options?.client ?? _heyApiClient).get<GetMcpHealthResponses, unknown, ThrowOnError>({
|
|
194
|
-
security: [
|
|
195
|
-
{
|
|
196
|
-
name: 'X-API-Key',
|
|
197
|
-
type: 'apiKey'
|
|
198
|
-
},
|
|
199
|
-
{
|
|
200
|
-
scheme: 'bearer',
|
|
201
|
-
type: 'http'
|
|
202
|
-
}
|
|
203
|
-
],
|
|
204
|
-
url: '/v1/mcp/health',
|
|
205
|
-
...options
|
|
206
|
-
});
|
|
207
|
-
};
|
|
208
|
-
|
|
209
188
|
/**
|
|
210
189
|
* Get Current User
|
|
211
190
|
* Returns information about the currently authenticated user.
|
|
@@ -289,7 +268,7 @@ export const selectUserGraph = <ThrowOnError extends boolean = false>(options: O
|
|
|
289
268
|
type: 'http'
|
|
290
269
|
}
|
|
291
270
|
],
|
|
292
|
-
url: '/v1/user/graphs/
|
|
271
|
+
url: '/v1/user/graphs/{graph_id}/select',
|
|
293
272
|
...options
|
|
294
273
|
});
|
|
295
274
|
};
|
|
@@ -480,6 +459,56 @@ export const getUserUsage = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
480
459
|
});
|
|
481
460
|
};
|
|
482
461
|
|
|
462
|
+
/**
|
|
463
|
+
* Get shared repository rate limit status
|
|
464
|
+
* Get current rate limit status and usage for a shared repository.
|
|
465
|
+
*
|
|
466
|
+
* Returns:
|
|
467
|
+
* - Current usage across different time windows
|
|
468
|
+
* - Rate limits based on subscription tier
|
|
469
|
+
* - Remaining quota
|
|
470
|
+
* - Reset times
|
|
471
|
+
*
|
|
472
|
+
* Note: All queries are FREE - this only shows rate limit status.
|
|
473
|
+
*/
|
|
474
|
+
export const getSharedRepositoryLimits = <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => {
|
|
475
|
+
return (options.client ?? _heyApiClient).get<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError>({
|
|
476
|
+
security: [
|
|
477
|
+
{
|
|
478
|
+
name: 'X-API-Key',
|
|
479
|
+
type: 'apiKey'
|
|
480
|
+
},
|
|
481
|
+
{
|
|
482
|
+
scheme: 'bearer',
|
|
483
|
+
type: 'http'
|
|
484
|
+
}
|
|
485
|
+
],
|
|
486
|
+
url: '/v1/user/limits/shared-repositories/{repository}',
|
|
487
|
+
...options
|
|
488
|
+
});
|
|
489
|
+
};
|
|
490
|
+
|
|
491
|
+
/**
|
|
492
|
+
* Get all shared repository limits
|
|
493
|
+
* Get rate limit status for all shared repositories the user has access to.
|
|
494
|
+
*/
|
|
495
|
+
export const getAllSharedRepositoryLimits = <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => {
|
|
496
|
+
return (options?.client ?? _heyApiClient).get<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError>({
|
|
497
|
+
security: [
|
|
498
|
+
{
|
|
499
|
+
name: 'X-API-Key',
|
|
500
|
+
type: 'apiKey'
|
|
501
|
+
},
|
|
502
|
+
{
|
|
503
|
+
scheme: 'bearer',
|
|
504
|
+
type: 'http'
|
|
505
|
+
}
|
|
506
|
+
],
|
|
507
|
+
url: '/v1/user/limits/shared-repositories/summary',
|
|
508
|
+
...options
|
|
509
|
+
});
|
|
510
|
+
};
|
|
511
|
+
|
|
483
512
|
/**
|
|
484
513
|
* Get User Usage Overview
|
|
485
514
|
* Get a high-level overview of usage statistics for the current user.
|
|
@@ -637,7 +666,7 @@ export const getSharedRepositoryCredits = <ThrowOnError extends boolean = false>
|
|
|
637
666
|
|
|
638
667
|
/**
|
|
639
668
|
* Get Repository Credits
|
|
640
|
-
* Get credit balance for a specific shared repository
|
|
669
|
+
* Get credit balance for a specific shared repository
|
|
641
670
|
*/
|
|
642
671
|
export const getRepositoryCredits = <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => {
|
|
643
672
|
return (options.client ?? _heyApiClient).get<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError>({
|
|
@@ -651,7 +680,7 @@ export const getRepositoryCredits = <ThrowOnError extends boolean = false>(optio
|
|
|
651
680
|
type: 'http'
|
|
652
681
|
}
|
|
653
682
|
],
|
|
654
|
-
url: '/v1/user/subscriptions/shared-repositories/credits/{
|
|
683
|
+
url: '/v1/user/subscriptions/shared-repositories/credits/{repository}',
|
|
655
684
|
...options
|
|
656
685
|
});
|
|
657
686
|
};
|
|
@@ -751,10 +780,8 @@ export const listConnections = <ThrowOnError extends boolean = false>(options: O
|
|
|
751
780
|
* - User completes bank authentication
|
|
752
781
|
* - Exchange public token for access
|
|
753
782
|
*
|
|
754
|
-
*
|
|
755
|
-
* -
|
|
756
|
-
* - Multiplied by graph tier
|
|
757
|
-
* - Additional credits consumed during data sync
|
|
783
|
+
* Note:
|
|
784
|
+
* This operation is FREE - no credit consumption required.
|
|
758
785
|
*/
|
|
759
786
|
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => {
|
|
760
787
|
return (options.client ?? _heyApiClient).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
|
|
@@ -787,9 +814,8 @@ export const createConnection = <ThrowOnError extends boolean = false>(options:
|
|
|
787
814
|
* - Performs provider-specific cleanup
|
|
788
815
|
* - Revokes stored credentials
|
|
789
816
|
*
|
|
790
|
-
*
|
|
791
|
-
* -
|
|
792
|
-
* - Multiplied by graph tier
|
|
817
|
+
* Note:
|
|
818
|
+
* This operation is FREE - no credit consumption required.
|
|
793
819
|
*
|
|
794
820
|
* Only users with admin role can delete connections.
|
|
795
821
|
*/
|
|
@@ -862,10 +888,8 @@ export const getConnection = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
862
888
|
* - Updates account balances
|
|
863
889
|
* - Categorizes new transactions
|
|
864
890
|
*
|
|
865
|
-
*
|
|
866
|
-
* -
|
|
867
|
-
* - Multiplied by graph tier
|
|
868
|
-
* - Additional credits may be consumed during processing
|
|
891
|
+
* Note:
|
|
892
|
+
* This operation is FREE - no credit consumption required.
|
|
869
893
|
*
|
|
870
894
|
* Returns a task ID for monitoring sync progress.
|
|
871
895
|
*/
|
|
@@ -1085,10 +1109,10 @@ export const oauthCallback = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
1085
1109
|
* - Fallback to status polling endpoint if SSE unavailable
|
|
1086
1110
|
*
|
|
1087
1111
|
* **Credit Consumption:**
|
|
1088
|
-
* -
|
|
1089
|
-
* -
|
|
1090
|
-
* -
|
|
1091
|
-
* -
|
|
1112
|
+
* - AI operations consume credits based on actual token usage
|
|
1113
|
+
* - Claude 4 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
|
|
1092
1116
|
*
|
|
1093
1117
|
* The agent automatically determines query complexity or you can force extended analysis.
|
|
1094
1118
|
*/
|
|
@@ -1182,11 +1206,8 @@ export const listMcpTools = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1182
1206
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
1183
1207
|
* - Clients should implement exponential backoff on errors
|
|
1184
1208
|
*
|
|
1185
|
-
* **
|
|
1186
|
-
*
|
|
1187
|
-
* - Schema tools: 5-10 credits
|
|
1188
|
-
* - Query tools: 10-50 credits (based on complexity)
|
|
1189
|
-
* - Multiplied by graph tier
|
|
1209
|
+
* **Note:**
|
|
1210
|
+
* MCP tool calls are currently FREE and do not consume credits.
|
|
1190
1211
|
*/
|
|
1191
1212
|
export const callMcpTool = <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => {
|
|
1192
1213
|
return (options.client ?? _heyApiClient).post<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError>({
|
|
@@ -1445,7 +1466,7 @@ export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(optio
|
|
|
1445
1466
|
type: 'http'
|
|
1446
1467
|
}
|
|
1447
1468
|
],
|
|
1448
|
-
url: '/v1/{graph_id}/backup/{backup_id}/download
|
|
1469
|
+
url: '/v1/{graph_id}/backup/{backup_id}/download',
|
|
1449
1470
|
...options
|
|
1450
1471
|
});
|
|
1451
1472
|
};
|
|
@@ -1467,9 +1488,8 @@ export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(optio
|
|
|
1467
1488
|
* - Capacity planning
|
|
1468
1489
|
* - Performance optimization
|
|
1469
1490
|
*
|
|
1470
|
-
*
|
|
1471
|
-
* -
|
|
1472
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
1491
|
+
* Note:
|
|
1492
|
+
* This operation is FREE - no credit consumption required.
|
|
1473
1493
|
*/
|
|
1474
1494
|
export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => {
|
|
1475
1495
|
return (options.client ?? _heyApiClient).get<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError>({
|
|
@@ -1511,9 +1531,8 @@ export const getGraphMetrics = <ThrowOnError extends boolean = false>(options: O
|
|
|
1511
1531
|
* - Usage trend analysis
|
|
1512
1532
|
* - Performance tuning
|
|
1513
1533
|
*
|
|
1514
|
-
*
|
|
1515
|
-
* -
|
|
1516
|
-
* - Multiplied by graph tier
|
|
1534
|
+
* Note:
|
|
1535
|
+
* This operation is FREE - no credit consumption required.
|
|
1517
1536
|
*/
|
|
1518
1537
|
export const getGraphUsageStats = <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageStatsData, ThrowOnError>) => {
|
|
1519
1538
|
return (options.client ?? _heyApiClient).get<GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ThrowOnError>({
|
|
@@ -1545,7 +1564,7 @@ export const getGraphUsageStats = <ThrowOnError extends boolean = false>(options
|
|
|
1545
1564
|
* **Response Modes:**
|
|
1546
1565
|
* - `auto` (default): Intelligent automatic selection
|
|
1547
1566
|
* - `sync`: Force synchronous JSON response (best for testing)
|
|
1548
|
-
* - `async`: Force queued response with polling
|
|
1567
|
+
* - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
|
|
1549
1568
|
* - `stream`: Force streaming response (SSE or NDJSON)
|
|
1550
1569
|
*
|
|
1551
1570
|
* **Client Detection:**
|
|
@@ -1568,19 +1587,19 @@ export const getGraphUsageStats = <ThrowOnError extends boolean = false>(options
|
|
|
1568
1587
|
*
|
|
1569
1588
|
* **Queue Management:**
|
|
1570
1589
|
* - Automatic queuing under high load
|
|
1571
|
-
* -
|
|
1590
|
+
* - Real-time monitoring via SSE events (no polling needed)
|
|
1572
1591
|
* - Priority based on subscription tier
|
|
1573
|
-
* - Queue position updates via SSE
|
|
1592
|
+
* - Queue position and progress updates pushed via SSE
|
|
1593
|
+
* - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
|
|
1574
1594
|
*
|
|
1575
1595
|
* **Error Handling:**
|
|
1576
1596
|
* - `429 Too Many Requests`: Rate limit or connection limit exceeded
|
|
1577
1597
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
1578
1598
|
* - Clients should implement exponential backoff
|
|
1579
1599
|
*
|
|
1580
|
-
* **
|
|
1581
|
-
*
|
|
1582
|
-
*
|
|
1583
|
-
* - Queue position based on subscription tier
|
|
1600
|
+
* **Note:**
|
|
1601
|
+
* Query operations are FREE - no credit consumption required.
|
|
1602
|
+
* Queue position is based on subscription tier for priority.
|
|
1584
1603
|
*/
|
|
1585
1604
|
export const executeCypherQuery = <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => {
|
|
1586
1605
|
return (options.client ?? _heyApiClient).post<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError>({
|
|
@@ -1615,10 +1634,7 @@ export const executeCypherQuery = <ThrowOnError extends boolean = false>(options
|
|
|
1615
1634
|
* This is different from custom schema management - it shows what actually exists in the database,
|
|
1616
1635
|
* useful for understanding the current graph structure before writing queries.
|
|
1617
1636
|
*
|
|
1618
|
-
*
|
|
1619
|
-
* - Base cost: 2.0 credits
|
|
1620
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
1621
|
-
* - Schema information is cached for performance
|
|
1637
|
+
* This operation is FREE - no credit consumption required.
|
|
1622
1638
|
*/
|
|
1623
1639
|
export const getGraphSchemaInfo = <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaInfoData, ThrowOnError>) => {
|
|
1624
1640
|
return (options.client ?? _heyApiClient).get<GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ThrowOnError>({
|
|
@@ -1660,9 +1676,7 @@ export const getGraphSchemaInfo = <ThrowOnError extends boolean = false>(options
|
|
|
1660
1676
|
* - Performance problems
|
|
1661
1677
|
* - Naming conflicts
|
|
1662
1678
|
*
|
|
1663
|
-
*
|
|
1664
|
-
* - Base cost: 5.0 credits
|
|
1665
|
-
* - Multiplied by graph tier
|
|
1679
|
+
* This operation is FREE - no credit consumption required.
|
|
1666
1680
|
*/
|
|
1667
1681
|
export const validateSchema = <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => {
|
|
1668
1682
|
return (options.client ?? _heyApiClient).post<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError>({
|
|
@@ -2288,7 +2302,7 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
|
|
|
2288
2302
|
type: 'http'
|
|
2289
2303
|
}
|
|
2290
2304
|
],
|
|
2291
|
-
url: '/v1/create/graph/
|
|
2305
|
+
url: '/v1/create/graph/extensions',
|
|
2292
2306
|
...options
|
|
2293
2307
|
});
|
|
2294
2308
|
};
|
|
@@ -2302,7 +2316,7 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
|
|
|
2302
2316
|
* applications to display subscription options.
|
|
2303
2317
|
*
|
|
2304
2318
|
* Includes:
|
|
2305
|
-
* - Graph subscription tiers (
|
|
2319
|
+
* - Graph subscription tiers (standard, enterprise, premium)
|
|
2306
2320
|
* - Shared repository subscriptions (SEC, industry, economic data)
|
|
2307
2321
|
* - Operation costs and credit information
|
|
2308
2322
|
* - Features and capabilities for each tier
|