@robosystems/client 0.1.15 → 0.1.17
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/extensions/hooks.d.ts +1 -1
- package/package.json +48 -6
- package/sdk/client/client.gen.d.ts +2 -0
- package/sdk/client/client.gen.js +153 -0
- package/sdk/client/client.gen.ts +200 -0
- package/sdk/client/index.d.ts +7 -0
- package/sdk/client/index.js +15 -0
- package/sdk/client/index.ts +25 -0
- package/sdk/client/types.gen.d.ts +122 -0
- package/sdk/client/types.gen.js +4 -0
- package/sdk/client/types.gen.ts +233 -0
- package/sdk/client/utils.gen.d.ts +45 -0
- package/sdk/client/utils.gen.js +296 -0
- package/sdk/client/utils.gen.ts +419 -0
- package/sdk/client.gen.d.ts +12 -0
- package/sdk/client.gen.js +8 -0
- package/sdk/client.gen.ts +18 -0
- package/sdk/core/auth.gen.d.ts +18 -0
- package/sdk/core/auth.gen.js +18 -0
- package/sdk/core/auth.gen.ts +42 -0
- package/sdk/core/bodySerializer.gen.d.ts +17 -0
- package/sdk/core/bodySerializer.gen.js +57 -0
- package/sdk/core/bodySerializer.gen.ts +90 -0
- package/sdk/core/params.gen.d.ts +33 -0
- package/sdk/core/params.gen.js +92 -0
- package/sdk/core/params.gen.ts +153 -0
- package/sdk/core/pathSerializer.gen.d.ts +33 -0
- package/sdk/core/pathSerializer.gen.js +123 -0
- package/sdk/core/pathSerializer.gen.ts +181 -0
- package/sdk/core/types.gen.d.ts +78 -0
- package/sdk/core/types.gen.js +4 -0
- package/sdk/core/types.gen.ts +121 -0
- package/sdk/index.d.ts +2 -0
- package/sdk/index.js +19 -0
- package/sdk/index.ts +3 -0
- package/sdk/sdk.gen.d.ts +1249 -0
- package/sdk/sdk.gen.js +2572 -0
- package/sdk/sdk.gen.ts +2585 -0
- package/sdk/types.gen.d.ts +6347 -0
- package/sdk/types.gen.js +3 -0
- package/sdk/types.gen.ts +6852 -0
- package/sdk-extensions/OperationClient.d.ts +64 -0
- package/sdk-extensions/OperationClient.js +251 -0
- package/sdk-extensions/OperationClient.ts +322 -0
- package/sdk-extensions/QueryClient.d.ts +50 -0
- package/sdk-extensions/QueryClient.js +190 -0
- package/sdk-extensions/QueryClient.ts +283 -0
- package/sdk-extensions/README.md +672 -0
- package/sdk-extensions/SSEClient.d.ts +48 -0
- package/sdk-extensions/SSEClient.js +148 -0
- package/sdk-extensions/SSEClient.ts +189 -0
- package/sdk-extensions/config.d.ts +32 -0
- package/sdk-extensions/config.js +74 -0
- package/sdk-extensions/config.ts +91 -0
- package/sdk-extensions/hooks.d.ts +110 -0
- package/sdk-extensions/hooks.js +371 -0
- package/sdk-extensions/hooks.ts +438 -0
- package/sdk-extensions/index.d.ts +46 -0
- package/sdk-extensions/index.js +110 -0
- package/sdk-extensions/index.ts +123 -0
- package/sdk.gen.d.ts +210 -104
- package/sdk.gen.js +409 -287
- package/sdk.gen.ts +404 -282
- package/types.gen.d.ts +1218 -567
- package/types.gen.ts +1236 -566
- package/openapi-ts.config.js +0 -9
- package/prepare.js +0 -220
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.
|
|
4
|
+
exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.queryFinancialAgent = exports.oauthCallback = exports.initOAuth = exports.exchangeLinkToken = exports.createLinkToken = exports.syncConnection = exports.getConnectionOptions = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.listConnections = exports.getRepositoryCredits = exports.getSharedRepositoryCredits = exports.cancelSharedRepositorySubscription = exports.upgradeSharedRepositorySubscription = exports.subscribeToSharedRepository = exports.getUserSharedSubscriptions = exports.getDetailedUserAnalytics = exports.getUserUsageOverview = exports.getSharedRepositoryLimits = exports.getAllSharedRepositoryLimits = exports.getUserUsage = exports.getUserLimits = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.getAllCreditSummaries = exports.selectUserGraph = exports.getUserGraphs = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.completeSsoAuth = exports.ssoTokenExchange = exports.ssoLogin = exports.generateSsoToken = exports.refreshSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
|
|
5
|
+
exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.getAvailableExtensions = exports.createGraph = exports.copyDataToGraph = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.getGraphMonthlyBill = exports.getGraphBillingHistory = exports.getGraphUsageDetails = exports.getCurrentGraphBill = exports.listSchemaExtensions = exports.exportGraphSchema = exports.validateSchema = exports.getGraphSchemaInfo = exports.executeCypherQuery = exports.getGraphUsageStats = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.exportBackup = void 0;
|
|
6
6
|
const client_gen_1 = require("./client.gen");
|
|
7
7
|
/**
|
|
8
8
|
* Register New User
|
|
@@ -123,17 +123,6 @@ const completeSsoAuth = (options) => {
|
|
|
123
123
|
});
|
|
124
124
|
};
|
|
125
125
|
exports.completeSsoAuth = completeSsoAuth;
|
|
126
|
-
/**
|
|
127
|
-
* Get CAPTCHA Configuration
|
|
128
|
-
* Get CAPTCHA configuration including site key and whether CAPTCHA is required.
|
|
129
|
-
*/
|
|
130
|
-
const getCaptchaConfig = (options) => {
|
|
131
|
-
return (options?.client ?? client_gen_1.client).get({
|
|
132
|
-
url: '/v1/auth/captcha/config',
|
|
133
|
-
...options
|
|
134
|
-
});
|
|
135
|
-
};
|
|
136
|
-
exports.getCaptchaConfig = getCaptchaConfig;
|
|
137
126
|
/**
|
|
138
127
|
* Get Password Policy
|
|
139
128
|
* Get current password policy requirements for frontend validation
|
|
@@ -160,6 +149,17 @@ const checkPasswordStrength = (options) => {
|
|
|
160
149
|
});
|
|
161
150
|
};
|
|
162
151
|
exports.checkPasswordStrength = checkPasswordStrength;
|
|
152
|
+
/**
|
|
153
|
+
* Get CAPTCHA Configuration
|
|
154
|
+
* Get CAPTCHA configuration including site key and whether CAPTCHA is required.
|
|
155
|
+
*/
|
|
156
|
+
const getCaptchaConfig = (options) => {
|
|
157
|
+
return (options?.client ?? client_gen_1.client).get({
|
|
158
|
+
url: '/v1/auth/captcha/config',
|
|
159
|
+
...options
|
|
160
|
+
});
|
|
161
|
+
};
|
|
162
|
+
exports.getCaptchaConfig = getCaptchaConfig;
|
|
163
163
|
/**
|
|
164
164
|
* Health Check
|
|
165
165
|
* Service health check endpoint for monitoring and load balancers
|
|
@@ -281,7 +281,7 @@ const getAllCreditSummaries = (options) => {
|
|
|
281
281
|
type: 'http'
|
|
282
282
|
}
|
|
283
283
|
],
|
|
284
|
-
url: '/v1/user/credits
|
|
284
|
+
url: '/v1/user/credits',
|
|
285
285
|
...options
|
|
286
286
|
});
|
|
287
287
|
};
|
|
@@ -446,19 +446,11 @@ const getUserUsage = (options) => {
|
|
|
446
446
|
};
|
|
447
447
|
exports.getUserUsage = getUserUsage;
|
|
448
448
|
/**
|
|
449
|
-
* Get shared repository
|
|
450
|
-
* Get
|
|
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.
|
|
449
|
+
* Get all shared repository limits
|
|
450
|
+
* Get rate limit status for all shared repositories the user has access to.
|
|
459
451
|
*/
|
|
460
|
-
const
|
|
461
|
-
return (options
|
|
452
|
+
const getAllSharedRepositoryLimits = (options) => {
|
|
453
|
+
return (options?.client ?? client_gen_1.client).get({
|
|
462
454
|
security: [
|
|
463
455
|
{
|
|
464
456
|
name: 'X-API-Key',
|
|
@@ -469,17 +461,25 @@ const getSharedRepositoryLimits = (options) => {
|
|
|
469
461
|
type: 'http'
|
|
470
462
|
}
|
|
471
463
|
],
|
|
472
|
-
url: '/v1/user/limits/shared-repositories/
|
|
464
|
+
url: '/v1/user/limits/shared-repositories/summary',
|
|
473
465
|
...options
|
|
474
466
|
});
|
|
475
467
|
};
|
|
476
|
-
exports.
|
|
468
|
+
exports.getAllSharedRepositoryLimits = getAllSharedRepositoryLimits;
|
|
477
469
|
/**
|
|
478
|
-
* Get
|
|
479
|
-
* Get rate limit status for
|
|
470
|
+
* Get shared repository rate limit status
|
|
471
|
+
* Get current rate limit status and usage for a shared repository.
|
|
472
|
+
*
|
|
473
|
+
* Returns:
|
|
474
|
+
* - Current usage across different time windows
|
|
475
|
+
* - Rate limits based on subscription tier
|
|
476
|
+
* - Remaining quota
|
|
477
|
+
* - Reset times
|
|
478
|
+
*
|
|
479
|
+
* Note: All queries are FREE - this only shows rate limit status.
|
|
480
480
|
*/
|
|
481
|
-
const
|
|
482
|
-
return (options
|
|
481
|
+
const getSharedRepositoryLimits = (options) => {
|
|
482
|
+
return (options.client ?? client_gen_1.client).get({
|
|
483
483
|
security: [
|
|
484
484
|
{
|
|
485
485
|
name: 'X-API-Key',
|
|
@@ -490,11 +490,11 @@ const getAllSharedRepositoryLimits = (options) => {
|
|
|
490
490
|
type: 'http'
|
|
491
491
|
}
|
|
492
492
|
],
|
|
493
|
-
url: '/v1/user/limits/shared-repositories/
|
|
493
|
+
url: '/v1/user/limits/shared-repositories/{repository}',
|
|
494
494
|
...options
|
|
495
495
|
});
|
|
496
496
|
};
|
|
497
|
-
exports.
|
|
497
|
+
exports.getSharedRepositoryLimits = getSharedRepositoryLimits;
|
|
498
498
|
/**
|
|
499
499
|
* Get User Usage Overview
|
|
500
500
|
* Get a high-level overview of usage statistics for the current user.
|
|
@@ -671,46 +671,6 @@ const getRepositoryCredits = (options) => {
|
|
|
671
671
|
});
|
|
672
672
|
};
|
|
673
673
|
exports.getRepositoryCredits = getRepositoryCredits;
|
|
674
|
-
/**
|
|
675
|
-
* List Connection Options
|
|
676
|
-
* Get metadata about all available data connection providers.
|
|
677
|
-
*
|
|
678
|
-
* This endpoint returns comprehensive information about each supported provider:
|
|
679
|
-
*
|
|
680
|
-
* **SEC EDGAR**: Public entity financial filings
|
|
681
|
-
* - No authentication required (public data)
|
|
682
|
-
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
683
|
-
* - Historical and real-time filing access
|
|
684
|
-
*
|
|
685
|
-
* **QuickBooks Online**: Full accounting system integration
|
|
686
|
-
* - OAuth 2.0 authentication
|
|
687
|
-
* - Chart of accounts, transactions, trial balance
|
|
688
|
-
* - Real-time sync capabilities
|
|
689
|
-
*
|
|
690
|
-
* **Plaid**: Bank account connections
|
|
691
|
-
* - Secure bank authentication via Plaid Link
|
|
692
|
-
* - Transaction history and balances
|
|
693
|
-
* - Multi-account support
|
|
694
|
-
*
|
|
695
|
-
* No credits are consumed for viewing connection options.
|
|
696
|
-
*/
|
|
697
|
-
const getConnectionOptions = (options) => {
|
|
698
|
-
return (options.client ?? client_gen_1.client).get({
|
|
699
|
-
security: [
|
|
700
|
-
{
|
|
701
|
-
name: 'X-API-Key',
|
|
702
|
-
type: 'apiKey'
|
|
703
|
-
},
|
|
704
|
-
{
|
|
705
|
-
scheme: 'bearer',
|
|
706
|
-
type: 'http'
|
|
707
|
-
}
|
|
708
|
-
],
|
|
709
|
-
url: '/v1/{graph_id}/connections/options',
|
|
710
|
-
...options
|
|
711
|
-
});
|
|
712
|
-
};
|
|
713
|
-
exports.getConnectionOptions = getConnectionOptions;
|
|
714
674
|
/**
|
|
715
675
|
* List Connections
|
|
716
676
|
* List all data connections in the graph.
|
|
@@ -852,6 +812,46 @@ const getConnection = (options) => {
|
|
|
852
812
|
});
|
|
853
813
|
};
|
|
854
814
|
exports.getConnection = getConnection;
|
|
815
|
+
/**
|
|
816
|
+
* List Connection Options
|
|
817
|
+
* Get metadata about all available data connection providers.
|
|
818
|
+
*
|
|
819
|
+
* This endpoint returns comprehensive information about each supported provider:
|
|
820
|
+
*
|
|
821
|
+
* **SEC EDGAR**: Public entity financial filings
|
|
822
|
+
* - No authentication required (public data)
|
|
823
|
+
* - 10-K, 10-Q, 8-K reports with XBRL data
|
|
824
|
+
* - Historical and real-time filing access
|
|
825
|
+
*
|
|
826
|
+
* **QuickBooks Online**: Full accounting system integration
|
|
827
|
+
* - OAuth 2.0 authentication
|
|
828
|
+
* - Chart of accounts, transactions, trial balance
|
|
829
|
+
* - Real-time sync capabilities
|
|
830
|
+
*
|
|
831
|
+
* **Plaid**: Bank account connections
|
|
832
|
+
* - Secure bank authentication via Plaid Link
|
|
833
|
+
* - Transaction history and balances
|
|
834
|
+
* - Multi-account support
|
|
835
|
+
*
|
|
836
|
+
* No credits are consumed for viewing connection options.
|
|
837
|
+
*/
|
|
838
|
+
const getConnectionOptions = (options) => {
|
|
839
|
+
return (options.client ?? client_gen_1.client).get({
|
|
840
|
+
security: [
|
|
841
|
+
{
|
|
842
|
+
name: 'X-API-Key',
|
|
843
|
+
type: 'apiKey'
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
scheme: 'bearer',
|
|
847
|
+
type: 'http'
|
|
848
|
+
}
|
|
849
|
+
],
|
|
850
|
+
url: '/v1/{graph_id}/connections/options',
|
|
851
|
+
...options
|
|
852
|
+
});
|
|
853
|
+
};
|
|
854
|
+
exports.getConnectionOptions = getConnectionOptions;
|
|
855
855
|
/**
|
|
856
856
|
* Sync Connection
|
|
857
857
|
* Trigger a data synchronization for the connection.
|
|
@@ -1096,7 +1096,7 @@ exports.oauthCallback = oauthCallback;
|
|
|
1096
1096
|
*
|
|
1097
1097
|
* **Credit Consumption:**
|
|
1098
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
|
|
1099
|
+
* - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
|
|
1100
1100
|
* - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
|
|
1101
1101
|
* - Credits are consumed after operation completes based on actual usage
|
|
1102
1102
|
*
|
|
@@ -1216,6 +1216,27 @@ const callMcpTool = (options) => {
|
|
|
1216
1216
|
});
|
|
1217
1217
|
};
|
|
1218
1218
|
exports.callMcpTool = callMcpTool;
|
|
1219
|
+
/**
|
|
1220
|
+
* List Kuzu graph backups
|
|
1221
|
+
* List all backups for the specified graph database
|
|
1222
|
+
*/
|
|
1223
|
+
const listBackups = (options) => {
|
|
1224
|
+
return (options.client ?? client_gen_1.client).get({
|
|
1225
|
+
security: [
|
|
1226
|
+
{
|
|
1227
|
+
name: 'X-API-Key',
|
|
1228
|
+
type: 'apiKey'
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
scheme: 'bearer',
|
|
1232
|
+
type: 'http'
|
|
1233
|
+
}
|
|
1234
|
+
],
|
|
1235
|
+
url: '/v1/{graph_id}/backups',
|
|
1236
|
+
...options
|
|
1237
|
+
});
|
|
1238
|
+
};
|
|
1239
|
+
exports.listBackups = listBackups;
|
|
1219
1240
|
/**
|
|
1220
1241
|
* Create Backup
|
|
1221
1242
|
* Create a backup of the graph database.
|
|
@@ -1273,7 +1294,7 @@ const createBackup = (options) => {
|
|
|
1273
1294
|
type: 'http'
|
|
1274
1295
|
}
|
|
1275
1296
|
],
|
|
1276
|
-
url: '/v1/{graph_id}/
|
|
1297
|
+
url: '/v1/{graph_id}/backups',
|
|
1277
1298
|
...options,
|
|
1278
1299
|
headers: {
|
|
1279
1300
|
'Content-Type': 'application/json',
|
|
@@ -1283,11 +1304,11 @@ const createBackup = (options) => {
|
|
|
1283
1304
|
};
|
|
1284
1305
|
exports.createBackup = createBackup;
|
|
1285
1306
|
/**
|
|
1286
|
-
*
|
|
1287
|
-
*
|
|
1307
|
+
* Export Kuzu backup for download
|
|
1308
|
+
* Export a backup file for download (only available for non-encrypted, compressed .kuzu backups)
|
|
1288
1309
|
*/
|
|
1289
|
-
const
|
|
1290
|
-
return (options.client ?? client_gen_1.client).
|
|
1310
|
+
const exportBackup = (options) => {
|
|
1311
|
+
return (options.client ?? client_gen_1.client).post({
|
|
1291
1312
|
security: [
|
|
1292
1313
|
{
|
|
1293
1314
|
name: 'X-API-Key',
|
|
@@ -1298,17 +1319,17 @@ const listBackups = (options) => {
|
|
|
1298
1319
|
type: 'http'
|
|
1299
1320
|
}
|
|
1300
1321
|
],
|
|
1301
|
-
url: '/v1/{graph_id}/
|
|
1322
|
+
url: '/v1/{graph_id}/backups/{backup_id}/export',
|
|
1302
1323
|
...options
|
|
1303
1324
|
});
|
|
1304
1325
|
};
|
|
1305
|
-
exports.
|
|
1326
|
+
exports.exportBackup = exportBackup;
|
|
1306
1327
|
/**
|
|
1307
|
-
*
|
|
1308
|
-
*
|
|
1328
|
+
* Get temporary download URL for backup
|
|
1329
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
|
|
1309
1330
|
*/
|
|
1310
|
-
const
|
|
1311
|
-
return (options.client ?? client_gen_1.client).
|
|
1331
|
+
const getBackupDownloadUrl = (options) => {
|
|
1332
|
+
return (options.client ?? client_gen_1.client).get({
|
|
1312
1333
|
security: [
|
|
1313
1334
|
{
|
|
1314
1335
|
name: 'X-API-Key',
|
|
@@ -1319,15 +1340,11 @@ const exportBackup = (options) => {
|
|
|
1319
1340
|
type: 'http'
|
|
1320
1341
|
}
|
|
1321
1342
|
],
|
|
1322
|
-
url: '/v1/{graph_id}/
|
|
1323
|
-
...options
|
|
1324
|
-
headers: {
|
|
1325
|
-
'Content-Type': 'application/json',
|
|
1326
|
-
...options.headers
|
|
1327
|
-
}
|
|
1343
|
+
url: '/v1/{graph_id}/backups/{backup_id}/download',
|
|
1344
|
+
...options
|
|
1328
1345
|
});
|
|
1329
1346
|
};
|
|
1330
|
-
exports.
|
|
1347
|
+
exports.getBackupDownloadUrl = getBackupDownloadUrl;
|
|
1331
1348
|
/**
|
|
1332
1349
|
* Restore Encrypted Backup
|
|
1333
1350
|
* Restore a graph database from an encrypted backup.
|
|
@@ -1385,7 +1402,7 @@ const restoreBackup = (options) => {
|
|
|
1385
1402
|
type: 'http'
|
|
1386
1403
|
}
|
|
1387
1404
|
],
|
|
1388
|
-
url: '/v1/{graph_id}/
|
|
1405
|
+
url: '/v1/{graph_id}/backups/restore',
|
|
1389
1406
|
...options,
|
|
1390
1407
|
headers: {
|
|
1391
1408
|
'Content-Type': 'application/json',
|
|
@@ -1410,53 +1427,11 @@ const getBackupStats = (options) => {
|
|
|
1410
1427
|
type: 'http'
|
|
1411
1428
|
}
|
|
1412
1429
|
],
|
|
1413
|
-
url: '/v1/{graph_id}/
|
|
1430
|
+
url: '/v1/{graph_id}/backups/stats',
|
|
1414
1431
|
...options
|
|
1415
1432
|
});
|
|
1416
1433
|
};
|
|
1417
1434
|
exports.getBackupStats = getBackupStats;
|
|
1418
|
-
/**
|
|
1419
|
-
* Check Kuzu backup system health
|
|
1420
|
-
* Check the health status of the Kuzu backup system
|
|
1421
|
-
*/
|
|
1422
|
-
const kuzuBackupHealth = (options) => {
|
|
1423
|
-
return (options.client ?? client_gen_1.client).get({
|
|
1424
|
-
security: [
|
|
1425
|
-
{
|
|
1426
|
-
name: 'X-API-Key',
|
|
1427
|
-
type: 'apiKey'
|
|
1428
|
-
},
|
|
1429
|
-
{
|
|
1430
|
-
scheme: 'bearer',
|
|
1431
|
-
type: 'http'
|
|
1432
|
-
}
|
|
1433
|
-
],
|
|
1434
|
-
url: '/v1/{graph_id}/backup/health',
|
|
1435
|
-
...options
|
|
1436
|
-
});
|
|
1437
|
-
};
|
|
1438
|
-
exports.kuzuBackupHealth = kuzuBackupHealth;
|
|
1439
|
-
/**
|
|
1440
|
-
* Get temporary download URL for backup
|
|
1441
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .kuzu files only)
|
|
1442
|
-
*/
|
|
1443
|
-
const getBackupDownloadUrl = (options) => {
|
|
1444
|
-
return (options.client ?? client_gen_1.client).get({
|
|
1445
|
-
security: [
|
|
1446
|
-
{
|
|
1447
|
-
name: 'X-API-Key',
|
|
1448
|
-
type: 'apiKey'
|
|
1449
|
-
},
|
|
1450
|
-
{
|
|
1451
|
-
scheme: 'bearer',
|
|
1452
|
-
type: 'http'
|
|
1453
|
-
}
|
|
1454
|
-
],
|
|
1455
|
-
url: '/v1/{graph_id}/backup/{backup_id}/download',
|
|
1456
|
-
...options
|
|
1457
|
-
});
|
|
1458
|
-
};
|
|
1459
|
-
exports.getBackupDownloadUrl = getBackupDownloadUrl;
|
|
1460
1435
|
/**
|
|
1461
1436
|
* Get Graph Metrics
|
|
1462
1437
|
* Get comprehensive metrics for the graph database.
|
|
@@ -1760,21 +1735,25 @@ const getCurrentGraphBill = (options) => {
|
|
|
1760
1735
|
};
|
|
1761
1736
|
exports.getCurrentGraphBill = getCurrentGraphBill;
|
|
1762
1737
|
/**
|
|
1763
|
-
* Get
|
|
1764
|
-
* Get
|
|
1738
|
+
* Get Usage Details
|
|
1739
|
+
* Get detailed usage metrics for the graph.
|
|
1765
1740
|
*
|
|
1766
|
-
*
|
|
1767
|
-
*
|
|
1768
|
-
* -
|
|
1769
|
-
* -
|
|
1770
|
-
* -
|
|
1771
|
-
* -
|
|
1741
|
+
* Provides granular usage information including:
|
|
1742
|
+
* - **Daily Credit Consumption**: Track credit usage patterns
|
|
1743
|
+
* - **Storage Growth**: Monitor database size over time
|
|
1744
|
+
* - **Operation Breakdown**: Credits by operation type
|
|
1745
|
+
* - **Peak Usage Times**: Identify high-activity periods
|
|
1746
|
+
* - **API Call Volumes**: Request counts and patterns
|
|
1772
1747
|
*
|
|
1773
|
-
*
|
|
1748
|
+
* Useful for:
|
|
1749
|
+
* - Optimizing credit consumption
|
|
1750
|
+
* - Capacity planning
|
|
1751
|
+
* - Usage trend analysis
|
|
1752
|
+
* - Cost optimization
|
|
1774
1753
|
*
|
|
1775
|
-
* ℹ️ No credits are consumed for viewing
|
|
1754
|
+
* ℹ️ No credits are consumed for viewing usage details.
|
|
1776
1755
|
*/
|
|
1777
|
-
const
|
|
1756
|
+
const getGraphUsageDetails = (options) => {
|
|
1778
1757
|
return (options.client ?? client_gen_1.client).get({
|
|
1779
1758
|
security: [
|
|
1780
1759
|
{
|
|
@@ -1786,11 +1765,11 @@ const getGraphMonthlyBill = (options) => {
|
|
|
1786
1765
|
type: 'http'
|
|
1787
1766
|
}
|
|
1788
1767
|
],
|
|
1789
|
-
url: '/v1/{graph_id}/billing/
|
|
1768
|
+
url: '/v1/{graph_id}/billing/usage',
|
|
1790
1769
|
...options
|
|
1791
1770
|
});
|
|
1792
1771
|
};
|
|
1793
|
-
exports.
|
|
1772
|
+
exports.getGraphUsageDetails = getGraphUsageDetails;
|
|
1794
1773
|
/**
|
|
1795
1774
|
* Get Billing History
|
|
1796
1775
|
* Get billing history for the graph.
|
|
@@ -1827,137 +1806,21 @@ const getGraphBillingHistory = (options) => {
|
|
|
1827
1806
|
};
|
|
1828
1807
|
exports.getGraphBillingHistory = getGraphBillingHistory;
|
|
1829
1808
|
/**
|
|
1830
|
-
* Get
|
|
1831
|
-
* Get
|
|
1832
|
-
*
|
|
1833
|
-
* Provides granular usage information including:
|
|
1834
|
-
* - **Daily Credit Consumption**: Track credit usage patterns
|
|
1835
|
-
* - **Storage Growth**: Monitor database size over time
|
|
1836
|
-
* - **Operation Breakdown**: Credits by operation type
|
|
1837
|
-
* - **Peak Usage Times**: Identify high-activity periods
|
|
1838
|
-
* - **API Call Volumes**: Request counts and patterns
|
|
1809
|
+
* Get Monthly Bill
|
|
1810
|
+
* Get billing details for a specific month.
|
|
1839
1811
|
*
|
|
1812
|
+
* Retrieve historical billing information for any previous month.
|
|
1840
1813
|
* Useful for:
|
|
1841
|
-
* -
|
|
1842
|
-
* -
|
|
1843
|
-
* -
|
|
1844
|
-
* -
|
|
1814
|
+
* - Reconciling past charges
|
|
1815
|
+
* - Tracking usage trends
|
|
1816
|
+
* - Expense reporting
|
|
1817
|
+
* - Budget analysis
|
|
1845
1818
|
*
|
|
1846
|
-
*
|
|
1847
|
-
*/
|
|
1848
|
-
const getGraphUsageDetails = (options) => {
|
|
1849
|
-
return (options.client ?? client_gen_1.client).get({
|
|
1850
|
-
security: [
|
|
1851
|
-
{
|
|
1852
|
-
name: 'X-API-Key',
|
|
1853
|
-
type: 'apiKey'
|
|
1854
|
-
},
|
|
1855
|
-
{
|
|
1856
|
-
scheme: 'bearer',
|
|
1857
|
-
type: 'http'
|
|
1858
|
-
}
|
|
1859
|
-
],
|
|
1860
|
-
url: '/v1/{graph_id}/billing/usage',
|
|
1861
|
-
...options
|
|
1862
|
-
});
|
|
1863
|
-
};
|
|
1864
|
-
exports.getGraphUsageDetails = getGraphUsageDetails;
|
|
1865
|
-
/**
|
|
1866
|
-
* Get Graph Pricing Info
|
|
1867
|
-
* Get pricing information for a specific graph database.
|
|
1868
|
-
*/
|
|
1869
|
-
const getGraphPricingInfoV1GraphIdBillingPricingGet = (options) => {
|
|
1870
|
-
return (options.client ?? client_gen_1.client).get({
|
|
1871
|
-
security: [
|
|
1872
|
-
{
|
|
1873
|
-
name: 'X-API-Key',
|
|
1874
|
-
type: 'apiKey'
|
|
1875
|
-
},
|
|
1876
|
-
{
|
|
1877
|
-
scheme: 'bearer',
|
|
1878
|
-
type: 'http'
|
|
1879
|
-
}
|
|
1880
|
-
],
|
|
1881
|
-
url: '/v1/{graph_id}/billing/pricing',
|
|
1882
|
-
...options
|
|
1883
|
-
});
|
|
1884
|
-
};
|
|
1885
|
-
exports.getGraphPricingInfoV1GraphIdBillingPricingGet = getGraphPricingInfoV1GraphIdBillingPricingGet;
|
|
1886
|
-
/**
|
|
1887
|
-
* Upgrade Graph Subscription
|
|
1888
|
-
* Upgrade subscription for a specific graph database.
|
|
1889
|
-
*/
|
|
1890
|
-
const upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost = (options) => {
|
|
1891
|
-
return (options.client ?? client_gen_1.client).post({
|
|
1892
|
-
security: [
|
|
1893
|
-
{
|
|
1894
|
-
name: 'X-API-Key',
|
|
1895
|
-
type: 'apiKey'
|
|
1896
|
-
},
|
|
1897
|
-
{
|
|
1898
|
-
scheme: 'bearer',
|
|
1899
|
-
type: 'http'
|
|
1900
|
-
}
|
|
1901
|
-
],
|
|
1902
|
-
url: '/v1/{graph_id}/billing/subscription/upgrade',
|
|
1903
|
-
...options,
|
|
1904
|
-
headers: {
|
|
1905
|
-
'Content-Type': 'application/json',
|
|
1906
|
-
...options.headers
|
|
1907
|
-
}
|
|
1908
|
-
});
|
|
1909
|
-
};
|
|
1910
|
-
exports.upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost = upgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePost;
|
|
1911
|
-
/**
|
|
1912
|
-
* Get Graph Subscription
|
|
1913
|
-
* Get current subscription for a graph database.
|
|
1914
|
-
*/
|
|
1915
|
-
const getGraphSubscriptionV1GraphIdBillingSubscriptionGet = (options) => {
|
|
1916
|
-
return (options.client ?? client_gen_1.client).get({
|
|
1917
|
-
security: [
|
|
1918
|
-
{
|
|
1919
|
-
name: 'X-API-Key',
|
|
1920
|
-
type: 'apiKey'
|
|
1921
|
-
},
|
|
1922
|
-
{
|
|
1923
|
-
scheme: 'bearer',
|
|
1924
|
-
type: 'http'
|
|
1925
|
-
}
|
|
1926
|
-
],
|
|
1927
|
-
url: '/v1/{graph_id}/billing/subscription',
|
|
1928
|
-
...options
|
|
1929
|
-
});
|
|
1930
|
-
};
|
|
1931
|
-
exports.getGraphSubscriptionV1GraphIdBillingSubscriptionGet = getGraphSubscriptionV1GraphIdBillingSubscriptionGet;
|
|
1932
|
-
/**
|
|
1933
|
-
* Get Available Subscription Plans
|
|
1934
|
-
* Get available subscription plans for upgrade.
|
|
1935
|
-
*/
|
|
1936
|
-
const getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet = (options) => {
|
|
1937
|
-
return (options.client ?? client_gen_1.client).get({
|
|
1938
|
-
security: [
|
|
1939
|
-
{
|
|
1940
|
-
name: 'X-API-Key',
|
|
1941
|
-
type: 'apiKey'
|
|
1942
|
-
},
|
|
1943
|
-
{
|
|
1944
|
-
scheme: 'bearer',
|
|
1945
|
-
type: 'http'
|
|
1946
|
-
}
|
|
1947
|
-
],
|
|
1948
|
-
url: '/v1/{graph_id}/billing/available-plans',
|
|
1949
|
-
...options
|
|
1950
|
-
});
|
|
1951
|
-
};
|
|
1952
|
-
exports.getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet = getAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGet;
|
|
1953
|
-
/**
|
|
1954
|
-
* Get Credit Billing Info
|
|
1955
|
-
* Get credit-based billing information for a specific graph.
|
|
1819
|
+
* Returns the same detailed breakdown as the current bill endpoint.
|
|
1956
1820
|
*
|
|
1957
|
-
*
|
|
1958
|
-
* without consuming credits (for billing transparency).
|
|
1821
|
+
* ℹ️ No credits are consumed for viewing billing history.
|
|
1959
1822
|
*/
|
|
1960
|
-
const
|
|
1823
|
+
const getGraphMonthlyBill = (options) => {
|
|
1961
1824
|
return (options.client ?? client_gen_1.client).get({
|
|
1962
1825
|
security: [
|
|
1963
1826
|
{
|
|
@@ -1969,11 +1832,11 @@ const getCreditBillingInfoV1GraphIdBillingCreditsGet = (options) => {
|
|
|
1969
1832
|
type: 'http'
|
|
1970
1833
|
}
|
|
1971
1834
|
],
|
|
1972
|
-
url: '/v1/{graph_id}/billing/
|
|
1835
|
+
url: '/v1/{graph_id}/billing/history/{year}/{month}',
|
|
1973
1836
|
...options
|
|
1974
1837
|
});
|
|
1975
1838
|
};
|
|
1976
|
-
exports.
|
|
1839
|
+
exports.getGraphMonthlyBill = getGraphMonthlyBill;
|
|
1977
1840
|
/**
|
|
1978
1841
|
* Get Credit Summary
|
|
1979
1842
|
* Retrieve comprehensive credit usage summary for the specified graph.
|
|
@@ -2053,7 +1916,7 @@ exports.listCreditTransactions = listCreditTransactions;
|
|
|
2053
1916
|
* No credits are consumed for checking availability.
|
|
2054
1917
|
*/
|
|
2055
1918
|
const checkCreditBalance = (options) => {
|
|
2056
|
-
return (options.client ?? client_gen_1.client).
|
|
1919
|
+
return (options.client ?? client_gen_1.client).get({
|
|
2057
1920
|
security: [
|
|
2058
1921
|
{
|
|
2059
1922
|
name: 'X-API-Key',
|
|
@@ -2064,12 +1927,8 @@ const checkCreditBalance = (options) => {
|
|
|
2064
1927
|
type: 'http'
|
|
2065
1928
|
}
|
|
2066
1929
|
],
|
|
2067
|
-
url: '/v1/{graph_id}/credits/check',
|
|
2068
|
-
...options
|
|
2069
|
-
headers: {
|
|
2070
|
-
'Content-Type': 'application/json',
|
|
2071
|
-
...options.headers
|
|
2072
|
-
}
|
|
1930
|
+
url: '/v1/{graph_id}/credits/balance/check',
|
|
1931
|
+
...options
|
|
2073
1932
|
});
|
|
2074
1933
|
};
|
|
2075
1934
|
exports.checkCreditBalance = checkCreditBalance;
|
|
@@ -2165,7 +2024,7 @@ const getDatabaseHealth = (options) => {
|
|
|
2165
2024
|
type: 'http'
|
|
2166
2025
|
}
|
|
2167
2026
|
],
|
|
2168
|
-
url: '/v1/{graph_id}/
|
|
2027
|
+
url: '/v1/{graph_id}/health',
|
|
2169
2028
|
...options
|
|
2170
2029
|
});
|
|
2171
2030
|
};
|
|
@@ -2203,11 +2062,274 @@ const getDatabaseInfo = (options) => {
|
|
|
2203
2062
|
type: 'http'
|
|
2204
2063
|
}
|
|
2205
2064
|
],
|
|
2206
|
-
url: '/v1/{graph_id}/
|
|
2065
|
+
url: '/v1/{graph_id}/info',
|
|
2207
2066
|
...options
|
|
2208
2067
|
});
|
|
2209
2068
|
};
|
|
2210
2069
|
exports.getDatabaseInfo = getDatabaseInfo;
|
|
2070
|
+
/**
|
|
2071
|
+
* Get Graph Operational Limits
|
|
2072
|
+
* Get comprehensive operational limits for the graph database.
|
|
2073
|
+
*
|
|
2074
|
+
* Returns all operational limits that apply to this graph including:
|
|
2075
|
+
* - **Storage Limits**: Maximum storage size and current usage
|
|
2076
|
+
* - **Query Limits**: Timeouts, complexity, row limits
|
|
2077
|
+
* - **Copy/Ingestion Limits**: File sizes, timeouts, concurrent operations
|
|
2078
|
+
* - **Backup Limits**: Frequency, retention, size limits
|
|
2079
|
+
* - **Rate Limits**: Requests per minute/hour based on tier
|
|
2080
|
+
* - **Credit Limits**: AI operation credits (if applicable)
|
|
2081
|
+
*
|
|
2082
|
+
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2083
|
+
*
|
|
2084
|
+
* **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
|
|
2085
|
+
*/
|
|
2086
|
+
const getGraphLimits = (options) => {
|
|
2087
|
+
return (options.client ?? client_gen_1.client).get({
|
|
2088
|
+
security: [
|
|
2089
|
+
{
|
|
2090
|
+
name: 'X-API-Key',
|
|
2091
|
+
type: 'apiKey'
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
scheme: 'bearer',
|
|
2095
|
+
type: 'http'
|
|
2096
|
+
}
|
|
2097
|
+
],
|
|
2098
|
+
url: '/v1/{graph_id}/limits',
|
|
2099
|
+
...options
|
|
2100
|
+
});
|
|
2101
|
+
};
|
|
2102
|
+
exports.getGraphLimits = getGraphLimits;
|
|
2103
|
+
/**
|
|
2104
|
+
* List Subgraphs
|
|
2105
|
+
* List all subgraphs for a parent graph.
|
|
2106
|
+
*
|
|
2107
|
+
* **Requirements:**
|
|
2108
|
+
* - Valid authentication
|
|
2109
|
+
* - Parent graph must exist and be accessible to the user
|
|
2110
|
+
* - User must have at least 'read' permission on the parent graph
|
|
2111
|
+
*
|
|
2112
|
+
* **Returns:**
|
|
2113
|
+
* - List of all subgraphs for the parent graph
|
|
2114
|
+
* - Each subgraph includes its ID, name, description, type, status, and creation date
|
|
2115
|
+
*/
|
|
2116
|
+
const listSubgraphs = (options) => {
|
|
2117
|
+
return (options.client ?? client_gen_1.client).get({
|
|
2118
|
+
security: [
|
|
2119
|
+
{
|
|
2120
|
+
name: 'X-API-Key',
|
|
2121
|
+
type: 'apiKey'
|
|
2122
|
+
},
|
|
2123
|
+
{
|
|
2124
|
+
scheme: 'bearer',
|
|
2125
|
+
type: 'http'
|
|
2126
|
+
}
|
|
2127
|
+
],
|
|
2128
|
+
url: '/v1/{graph_id}/subgraphs',
|
|
2129
|
+
...options
|
|
2130
|
+
});
|
|
2131
|
+
};
|
|
2132
|
+
exports.listSubgraphs = listSubgraphs;
|
|
2133
|
+
/**
|
|
2134
|
+
* Create Subgraph
|
|
2135
|
+
* Create a new subgraph within a parent graph.
|
|
2136
|
+
*
|
|
2137
|
+
* **Requirements:**
|
|
2138
|
+
* - Valid authentication
|
|
2139
|
+
* - Parent graph must exist and be accessible to the user
|
|
2140
|
+
* - User must have 'admin' permission on the parent graph
|
|
2141
|
+
* - Parent graph tier must support subgraphs (Enterprise or Premium only)
|
|
2142
|
+
* - Must be within subgraph quota limits
|
|
2143
|
+
* - Subgraph name must be unique within the parent graph
|
|
2144
|
+
*
|
|
2145
|
+
* **Returns:**
|
|
2146
|
+
* - Created subgraph details including its unique ID
|
|
2147
|
+
*/
|
|
2148
|
+
const createSubgraph = (options) => {
|
|
2149
|
+
return (options.client ?? client_gen_1.client).post({
|
|
2150
|
+
security: [
|
|
2151
|
+
{
|
|
2152
|
+
name: 'X-API-Key',
|
|
2153
|
+
type: 'apiKey'
|
|
2154
|
+
},
|
|
2155
|
+
{
|
|
2156
|
+
scheme: 'bearer',
|
|
2157
|
+
type: 'http'
|
|
2158
|
+
}
|
|
2159
|
+
],
|
|
2160
|
+
url: '/v1/{graph_id}/subgraphs',
|
|
2161
|
+
...options,
|
|
2162
|
+
headers: {
|
|
2163
|
+
'Content-Type': 'application/json',
|
|
2164
|
+
...options.headers
|
|
2165
|
+
}
|
|
2166
|
+
});
|
|
2167
|
+
};
|
|
2168
|
+
exports.createSubgraph = createSubgraph;
|
|
2169
|
+
/**
|
|
2170
|
+
* Delete Subgraph
|
|
2171
|
+
* Delete a subgraph database.
|
|
2172
|
+
*
|
|
2173
|
+
* **Requirements:**
|
|
2174
|
+
* - Must be a valid subgraph (not parent graph)
|
|
2175
|
+
* - User must have admin access to parent graph
|
|
2176
|
+
* - Optional backup before deletion
|
|
2177
|
+
*
|
|
2178
|
+
* **Deletion Options:**
|
|
2179
|
+
* - `force`: Delete even if contains data
|
|
2180
|
+
* - `backup_first`: Create backup before deletion
|
|
2181
|
+
*
|
|
2182
|
+
* **Warning:**
|
|
2183
|
+
* Deletion is permanent unless backup is created.
|
|
2184
|
+
* All data in the subgraph will be lost.
|
|
2185
|
+
*
|
|
2186
|
+
* **Backup Location:**
|
|
2187
|
+
* If backup requested, stored in S3 at:
|
|
2188
|
+
* `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2189
|
+
*/
|
|
2190
|
+
const deleteSubgraph = (options) => {
|
|
2191
|
+
return (options.client ?? client_gen_1.client).delete({
|
|
2192
|
+
security: [
|
|
2193
|
+
{
|
|
2194
|
+
name: 'X-API-Key',
|
|
2195
|
+
type: 'apiKey'
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
scheme: 'bearer',
|
|
2199
|
+
type: 'http'
|
|
2200
|
+
}
|
|
2201
|
+
],
|
|
2202
|
+
url: '/v1/{graph_id}/subgraphs/{subgraph_id}',
|
|
2203
|
+
...options,
|
|
2204
|
+
headers: {
|
|
2205
|
+
'Content-Type': 'application/json',
|
|
2206
|
+
...options.headers
|
|
2207
|
+
}
|
|
2208
|
+
});
|
|
2209
|
+
};
|
|
2210
|
+
exports.deleteSubgraph = deleteSubgraph;
|
|
2211
|
+
/**
|
|
2212
|
+
* Get Subgraph Details
|
|
2213
|
+
* Get detailed information about a specific subgraph.
|
|
2214
|
+
*
|
|
2215
|
+
* **Requirements:**
|
|
2216
|
+
* - User must have read access to parent graph
|
|
2217
|
+
*
|
|
2218
|
+
* **Response includes:**
|
|
2219
|
+
* - Full subgraph metadata
|
|
2220
|
+
* - Database statistics (nodes, edges)
|
|
2221
|
+
* - Size information
|
|
2222
|
+
* - Schema configuration
|
|
2223
|
+
* - Creation/modification timestamps
|
|
2224
|
+
* - Last access time (when available)
|
|
2225
|
+
*
|
|
2226
|
+
* **Statistics:**
|
|
2227
|
+
* Real-time statistics queried from Kuzu:
|
|
2228
|
+
* - Node count
|
|
2229
|
+
* - Edge count
|
|
2230
|
+
* - Database size on disk
|
|
2231
|
+
* - Schema information
|
|
2232
|
+
*/
|
|
2233
|
+
const getSubgraphInfo = (options) => {
|
|
2234
|
+
return (options.client ?? client_gen_1.client).get({
|
|
2235
|
+
security: [
|
|
2236
|
+
{
|
|
2237
|
+
name: 'X-API-Key',
|
|
2238
|
+
type: 'apiKey'
|
|
2239
|
+
},
|
|
2240
|
+
{
|
|
2241
|
+
scheme: 'bearer',
|
|
2242
|
+
type: 'http'
|
|
2243
|
+
}
|
|
2244
|
+
],
|
|
2245
|
+
url: '/v1/{graph_id}/subgraphs/{subgraph_id}/info',
|
|
2246
|
+
...options
|
|
2247
|
+
});
|
|
2248
|
+
};
|
|
2249
|
+
exports.getSubgraphInfo = getSubgraphInfo;
|
|
2250
|
+
/**
|
|
2251
|
+
* Get Subgraph Quota
|
|
2252
|
+
* Get subgraph quota and usage information for a parent graph.
|
|
2253
|
+
*
|
|
2254
|
+
* **Shows:**
|
|
2255
|
+
* - Current subgraph count
|
|
2256
|
+
* - Maximum allowed subgraphs per tier
|
|
2257
|
+
* - Remaining capacity
|
|
2258
|
+
* - Total size usage across all subgraphs
|
|
2259
|
+
*
|
|
2260
|
+
* **Tier Limits:**
|
|
2261
|
+
* - Standard: 0 subgraphs (not supported)
|
|
2262
|
+
* - Enterprise: Configurable limit (default: 10 subgraphs)
|
|
2263
|
+
* - Premium: Unlimited subgraphs
|
|
2264
|
+
* - Limits are defined in deployment configuration
|
|
2265
|
+
*
|
|
2266
|
+
* **Size Tracking:**
|
|
2267
|
+
* Provides aggregate size metrics when available.
|
|
2268
|
+
* Individual subgraph sizes shown in list endpoint.
|
|
2269
|
+
*/
|
|
2270
|
+
const getSubgraphQuota = (options) => {
|
|
2271
|
+
return (options.client ?? client_gen_1.client).get({
|
|
2272
|
+
security: [
|
|
2273
|
+
{
|
|
2274
|
+
name: 'X-API-Key',
|
|
2275
|
+
type: 'apiKey'
|
|
2276
|
+
},
|
|
2277
|
+
{
|
|
2278
|
+
scheme: 'bearer',
|
|
2279
|
+
type: 'http'
|
|
2280
|
+
}
|
|
2281
|
+
],
|
|
2282
|
+
url: '/v1/{graph_id}/subgraphs/quota',
|
|
2283
|
+
...options
|
|
2284
|
+
});
|
|
2285
|
+
};
|
|
2286
|
+
exports.getSubgraphQuota = getSubgraphQuota;
|
|
2287
|
+
/**
|
|
2288
|
+
* Copy Data to Graph
|
|
2289
|
+
* Copy data from external sources into the graph database.
|
|
2290
|
+
*
|
|
2291
|
+
* This endpoint supports multiple data sources through a unified interface:
|
|
2292
|
+
* - **S3**: Copy from S3 buckets with user-provided credentials
|
|
2293
|
+
* - **URL** (future): Copy from HTTP(S) URLs
|
|
2294
|
+
* - **DataFrame** (future): Copy from uploaded DataFrames
|
|
2295
|
+
*
|
|
2296
|
+
* **Security:**
|
|
2297
|
+
* - Requires write permissions to the target graph
|
|
2298
|
+
* - **Not allowed on shared repositories** (sec, industry, economic) - these are read-only
|
|
2299
|
+
* - User must provide their own AWS credentials for S3 access
|
|
2300
|
+
* - All operations are logged for audit purposes
|
|
2301
|
+
*
|
|
2302
|
+
* **Tier Limits:**
|
|
2303
|
+
* - Standard: 10GB max file size, 15 min timeout
|
|
2304
|
+
* - Enterprise: 50GB max file size, 30 min timeout
|
|
2305
|
+
* - Premium: 100GB max file size, 60 min timeout
|
|
2306
|
+
*
|
|
2307
|
+
* **Copy Options:**
|
|
2308
|
+
* - `ignore_errors`: Skip duplicate/invalid rows (enables upsert-like behavior)
|
|
2309
|
+
* - `extended_timeout`: Use extended timeout for large datasets
|
|
2310
|
+
* - `validate_schema`: Validate source schema against target table
|
|
2311
|
+
*/
|
|
2312
|
+
const copyDataToGraph = (options) => {
|
|
2313
|
+
return (options.client ?? client_gen_1.client).post({
|
|
2314
|
+
security: [
|
|
2315
|
+
{
|
|
2316
|
+
name: 'X-API-Key',
|
|
2317
|
+
type: 'apiKey'
|
|
2318
|
+
},
|
|
2319
|
+
{
|
|
2320
|
+
scheme: 'bearer',
|
|
2321
|
+
type: 'http'
|
|
2322
|
+
}
|
|
2323
|
+
],
|
|
2324
|
+
url: '/v1/{graph_id}/copy',
|
|
2325
|
+
...options,
|
|
2326
|
+
headers: {
|
|
2327
|
+
'Content-Type': 'application/json',
|
|
2328
|
+
...options.headers
|
|
2329
|
+
}
|
|
2330
|
+
});
|
|
2331
|
+
};
|
|
2332
|
+
exports.copyDataToGraph = copyDataToGraph;
|
|
2211
2333
|
/**
|
|
2212
2334
|
* Create New Graph Database
|
|
2213
2335
|
* Create a new graph database with specified schema and optionally an initial entity.
|