@robosystems/client 0.2.16 → 0.2.18
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/package.json +1 -4
- package/sdk/sdk.gen.d.ts +14 -14
- package/sdk/sdk.gen.js +14 -14
- package/sdk/sdk.gen.ts +14 -14
- package/sdk/types.gen.d.ts +27 -7
- package/sdk/types.gen.ts +27 -7
- package/sdk.gen.d.ts +14 -14
- package/sdk.gen.js +14 -14
- package/sdk.gen.ts +14 -14
- package/types.gen.d.ts +27 -7
- package/types.gen.ts +27 -7
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@robosystems/client",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.18",
|
|
4
4
|
"description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -77,8 +77,6 @@
|
|
|
77
77
|
"validate:fix": "npm run format && npm run lint:fix && npm run typecheck",
|
|
78
78
|
"test": "vitest run",
|
|
79
79
|
"test:watch": "vitest",
|
|
80
|
-
"test:ui": "vitest --ui",
|
|
81
|
-
"test:coverage": "vitest run --coverage",
|
|
82
80
|
"test:all": "npm run validate && npm run test && npm run build",
|
|
83
81
|
"prepare:publish": "node prepare.js",
|
|
84
82
|
"prepublishOnly": "npm run prepare:publish",
|
|
@@ -113,7 +111,6 @@
|
|
|
113
111
|
"@types/react": "^19.1.9",
|
|
114
112
|
"@typescript-eslint/eslint-plugin": "^7.0.0",
|
|
115
113
|
"@typescript-eslint/parser": "^7.0.0",
|
|
116
|
-
"@vitest/ui": "^4.0.3",
|
|
117
114
|
"eslint": "^8.0.0",
|
|
118
115
|
"eslint-config-prettier": "^10.0.0",
|
|
119
116
|
"eslint-plugin-prettier": "^5.0.0",
|
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -550,7 +550,7 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
|
|
|
550
550
|
* The tool list is customized based on:
|
|
551
551
|
* - Graph type (shared repository vs user graph)
|
|
552
552
|
* - User permissions and subscription tier
|
|
553
|
-
* - Backend capabilities (
|
|
553
|
+
* - Backend capabilities (LadybugDB, Neo4j, etc.)
|
|
554
554
|
*
|
|
555
555
|
* **Subgraph Support:**
|
|
556
556
|
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
@@ -620,8 +620,8 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
|
|
|
620
620
|
* Create Backup
|
|
621
621
|
* Create a backup of the graph database.
|
|
622
622
|
*
|
|
623
|
-
* Creates a complete backup of the graph database (.
|
|
624
|
-
* - **Format**: Full database backup only (complete .
|
|
623
|
+
* Creates a complete backup of the graph database (.lbug file) with:
|
|
624
|
+
* - **Format**: Full database backup only (complete .lbug file)
|
|
625
625
|
* - **Compression**: Always enabled for optimal storage
|
|
626
626
|
* - **Encryption**: Optional AES-256 encryption for security
|
|
627
627
|
* - **Retention**: Configurable retention period (1-2555 days)
|
|
@@ -682,7 +682,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
|
|
|
682
682
|
export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => import("./client").RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError, "fields">;
|
|
683
683
|
/**
|
|
684
684
|
* Get temporary download URL for backup
|
|
685
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .
|
|
685
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
686
686
|
*/
|
|
687
687
|
export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
|
|
688
688
|
/**
|
|
@@ -1163,7 +1163,7 @@ export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1163
1163
|
*
|
|
1164
1164
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1165
1165
|
*
|
|
1166
|
-
* **Note**: Limits vary based on subscription tier (
|
|
1166
|
+
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
1167
1167
|
*/
|
|
1168
1168
|
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
|
|
1169
1169
|
/**
|
|
@@ -1188,7 +1188,7 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
|
|
|
1188
1188
|
* - Valid authentication
|
|
1189
1189
|
* - Parent graph must exist and be accessible to the user
|
|
1190
1190
|
* - User must have 'admin' permission on the parent graph
|
|
1191
|
-
* - Parent graph tier must support subgraphs (
|
|
1191
|
+
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
1192
1192
|
* - Must be within subgraph quota limits
|
|
1193
1193
|
* - Subgraph name must be unique within the parent graph
|
|
1194
1194
|
*
|
|
@@ -1230,8 +1230,8 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1230
1230
|
* All data in the subgraph will be lost.
|
|
1231
1231
|
*
|
|
1232
1232
|
* **Backup Location:**
|
|
1233
|
-
* If backup requested, stored in S3
|
|
1234
|
-
* `s3://{
|
|
1233
|
+
* If backup requested, stored in S3 graph database bucket at:
|
|
1234
|
+
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1235
1235
|
*
|
|
1236
1236
|
* **Notes:**
|
|
1237
1237
|
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
@@ -1256,7 +1256,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1256
1256
|
* - Last access time (when available)
|
|
1257
1257
|
*
|
|
1258
1258
|
* **Statistics:**
|
|
1259
|
-
* Real-time statistics queried from
|
|
1259
|
+
* Real-time statistics queried from LadybugDB:
|
|
1260
1260
|
* - Node count
|
|
1261
1261
|
* - Edge count
|
|
1262
1262
|
* - Database size on disk
|
|
@@ -1797,7 +1797,7 @@ export declare const getGraphs: <ThrowOnError extends boolean = false>(options?:
|
|
|
1797
1797
|
*
|
|
1798
1798
|
* **Required Fields:**
|
|
1799
1799
|
* - `metadata.graph_name`: Unique name for the graph
|
|
1800
|
-
* - `instance_tier`: Resource tier (
|
|
1800
|
+
* - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
|
|
1801
1801
|
*
|
|
1802
1802
|
* **Optional Fields:**
|
|
1803
1803
|
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
@@ -1886,9 +1886,9 @@ export declare const getAvailableExtensions: <ThrowOnError extends boolean = fal
|
|
|
1886
1886
|
* - Availability status
|
|
1887
1887
|
*
|
|
1888
1888
|
* **Available Tiers:**
|
|
1889
|
-
* - **
|
|
1890
|
-
* - **
|
|
1891
|
-
* - **
|
|
1889
|
+
* - **ladybug-standard**: Multi-tenant entry-level tier
|
|
1890
|
+
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
1891
|
+
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
1892
1892
|
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
1893
1893
|
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
1894
1894
|
*
|
|
@@ -1950,7 +1950,7 @@ export declare const selectGraph: <ThrowOnError extends boolean = false>(options
|
|
|
1950
1950
|
* - Credits are allocated per-graph, not shared across organization
|
|
1951
1951
|
*
|
|
1952
1952
|
* Includes:
|
|
1953
|
-
* - Graph infrastructure tiers (
|
|
1953
|
+
* - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
|
|
1954
1954
|
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
1955
1955
|
* - Operation costs and credit information
|
|
1956
1956
|
* - Features and capabilities for each tier
|
package/sdk/sdk.gen.js
CHANGED
|
@@ -1292,7 +1292,7 @@ exports.recommendAgent = recommendAgent;
|
|
|
1292
1292
|
* The tool list is customized based on:
|
|
1293
1293
|
* - Graph type (shared repository vs user graph)
|
|
1294
1294
|
* - User permissions and subscription tier
|
|
1295
|
-
* - Backend capabilities (
|
|
1295
|
+
* - Backend capabilities (LadybugDB, Neo4j, etc.)
|
|
1296
1296
|
*
|
|
1297
1297
|
* **Subgraph Support:**
|
|
1298
1298
|
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
@@ -1414,8 +1414,8 @@ exports.listBackups = listBackups;
|
|
|
1414
1414
|
* Create Backup
|
|
1415
1415
|
* Create a backup of the graph database.
|
|
1416
1416
|
*
|
|
1417
|
-
* Creates a complete backup of the graph database (.
|
|
1418
|
-
* - **Format**: Full database backup only (complete .
|
|
1417
|
+
* Creates a complete backup of the graph database (.lbug file) with:
|
|
1418
|
+
* - **Format**: Full database backup only (complete .lbug file)
|
|
1419
1419
|
* - **Compression**: Always enabled for optimal storage
|
|
1420
1420
|
* - **Encryption**: Optional AES-256 encryption for security
|
|
1421
1421
|
* - **Retention**: Configurable retention period (1-2555 days)
|
|
@@ -1496,7 +1496,7 @@ const createBackup = (options) => {
|
|
|
1496
1496
|
exports.createBackup = createBackup;
|
|
1497
1497
|
/**
|
|
1498
1498
|
* Get temporary download URL for backup
|
|
1499
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .
|
|
1499
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
1500
1500
|
*/
|
|
1501
1501
|
const getBackupDownloadUrl = (options) => {
|
|
1502
1502
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2245,7 +2245,7 @@ exports.getDatabaseInfo = getDatabaseInfo;
|
|
|
2245
2245
|
*
|
|
2246
2246
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2247
2247
|
*
|
|
2248
|
-
* **Note**: Limits vary based on subscription tier (
|
|
2248
|
+
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
2249
2249
|
*/
|
|
2250
2250
|
const getGraphLimits = (options) => {
|
|
2251
2251
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2302,7 +2302,7 @@ exports.listSubgraphs = listSubgraphs;
|
|
|
2302
2302
|
* - Valid authentication
|
|
2303
2303
|
* - Parent graph must exist and be accessible to the user
|
|
2304
2304
|
* - User must have 'admin' permission on the parent graph
|
|
2305
|
-
* - Parent graph tier must support subgraphs (
|
|
2305
|
+
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2306
2306
|
* - Must be within subgraph quota limits
|
|
2307
2307
|
* - Subgraph name must be unique within the parent graph
|
|
2308
2308
|
*
|
|
@@ -2364,8 +2364,8 @@ exports.createSubgraph = createSubgraph;
|
|
|
2364
2364
|
* All data in the subgraph will be lost.
|
|
2365
2365
|
*
|
|
2366
2366
|
* **Backup Location:**
|
|
2367
|
-
* If backup requested, stored in S3
|
|
2368
|
-
* `s3://{
|
|
2367
|
+
* If backup requested, stored in S3 graph database bucket at:
|
|
2368
|
+
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2369
2369
|
*
|
|
2370
2370
|
* **Notes:**
|
|
2371
2371
|
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
@@ -2410,7 +2410,7 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
2410
2410
|
* - Last access time (when available)
|
|
2411
2411
|
*
|
|
2412
2412
|
* **Statistics:**
|
|
2413
|
-
* Real-time statistics queried from
|
|
2413
|
+
* Real-time statistics queried from LadybugDB:
|
|
2414
2414
|
* - Node count
|
|
2415
2415
|
* - Edge count
|
|
2416
2416
|
* - Database size on disk
|
|
@@ -3255,7 +3255,7 @@ exports.getGraphs = getGraphs;
|
|
|
3255
3255
|
*
|
|
3256
3256
|
* **Required Fields:**
|
|
3257
3257
|
* - `metadata.graph_name`: Unique name for the graph
|
|
3258
|
-
* - `instance_tier`: Resource tier (
|
|
3258
|
+
* - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
|
|
3259
3259
|
*
|
|
3260
3260
|
* **Optional Fields:**
|
|
3261
3261
|
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
@@ -3380,9 +3380,9 @@ exports.getAvailableExtensions = getAvailableExtensions;
|
|
|
3380
3380
|
* - Availability status
|
|
3381
3381
|
*
|
|
3382
3382
|
* **Available Tiers:**
|
|
3383
|
-
* - **
|
|
3384
|
-
* - **
|
|
3385
|
-
* - **
|
|
3383
|
+
* - **ladybug-standard**: Multi-tenant entry-level tier
|
|
3384
|
+
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
3385
|
+
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
3386
3386
|
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
3387
3387
|
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
3388
3388
|
*
|
|
@@ -3476,7 +3476,7 @@ exports.selectGraph = selectGraph;
|
|
|
3476
3476
|
* - Credits are allocated per-graph, not shared across organization
|
|
3477
3477
|
*
|
|
3478
3478
|
* Includes:
|
|
3479
|
-
* - Graph infrastructure tiers (
|
|
3479
|
+
* - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
|
|
3480
3480
|
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
3481
3481
|
* - Operation costs and credit information
|
|
3482
3482
|
* - Features and capabilities for each tier
|
package/sdk/sdk.gen.ts
CHANGED
|
@@ -1305,7 +1305,7 @@ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1305
1305
|
* The tool list is customized based on:
|
|
1306
1306
|
* - Graph type (shared repository vs user graph)
|
|
1307
1307
|
* - User permissions and subscription tier
|
|
1308
|
-
* - Backend capabilities (
|
|
1308
|
+
* - Backend capabilities (LadybugDB, Neo4j, etc.)
|
|
1309
1309
|
*
|
|
1310
1310
|
* **Subgraph Support:**
|
|
1311
1311
|
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
@@ -1427,8 +1427,8 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1427
1427
|
* Create Backup
|
|
1428
1428
|
* Create a backup of the graph database.
|
|
1429
1429
|
*
|
|
1430
|
-
* Creates a complete backup of the graph database (.
|
|
1431
|
-
* - **Format**: Full database backup only (complete .
|
|
1430
|
+
* Creates a complete backup of the graph database (.lbug file) with:
|
|
1431
|
+
* - **Format**: Full database backup only (complete .lbug file)
|
|
1432
1432
|
* - **Compression**: Always enabled for optimal storage
|
|
1433
1433
|
* - **Encryption**: Optional AES-256 encryption for security
|
|
1434
1434
|
* - **Retention**: Configurable retention period (1-2555 days)
|
|
@@ -1509,7 +1509,7 @@ export const createBackup = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1509
1509
|
|
|
1510
1510
|
/**
|
|
1511
1511
|
* Get temporary download URL for backup
|
|
1512
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .
|
|
1512
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
1513
1513
|
*/
|
|
1514
1514
|
export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => {
|
|
1515
1515
|
return (options.client ?? _heyApiClient).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
|
|
@@ -2258,7 +2258,7 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2258
2258
|
*
|
|
2259
2259
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2260
2260
|
*
|
|
2261
|
-
* **Note**: Limits vary based on subscription tier (
|
|
2261
|
+
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
2262
2262
|
*/
|
|
2263
2263
|
export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
|
|
2264
2264
|
return (options.client ?? _heyApiClient).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
|
|
@@ -2315,7 +2315,7 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2315
2315
|
* - Valid authentication
|
|
2316
2316
|
* - Parent graph must exist and be accessible to the user
|
|
2317
2317
|
* - User must have 'admin' permission on the parent graph
|
|
2318
|
-
* - Parent graph tier must support subgraphs (
|
|
2318
|
+
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2319
2319
|
* - Must be within subgraph quota limits
|
|
2320
2320
|
* - Subgraph name must be unique within the parent graph
|
|
2321
2321
|
*
|
|
@@ -2377,8 +2377,8 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2377
2377
|
* All data in the subgraph will be lost.
|
|
2378
2378
|
*
|
|
2379
2379
|
* **Backup Location:**
|
|
2380
|
-
* If backup requested, stored in S3
|
|
2381
|
-
* `s3://{
|
|
2380
|
+
* If backup requested, stored in S3 graph database bucket at:
|
|
2381
|
+
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2382
2382
|
*
|
|
2383
2383
|
* **Notes:**
|
|
2384
2384
|
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
@@ -2423,7 +2423,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2423
2423
|
* - Last access time (when available)
|
|
2424
2424
|
*
|
|
2425
2425
|
* **Statistics:**
|
|
2426
|
-
* Real-time statistics queried from
|
|
2426
|
+
* Real-time statistics queried from LadybugDB:
|
|
2427
2427
|
* - Node count
|
|
2428
2428
|
* - Edge count
|
|
2429
2429
|
* - Database size on disk
|
|
@@ -3268,7 +3268,7 @@ export const getGraphs = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
3268
3268
|
*
|
|
3269
3269
|
* **Required Fields:**
|
|
3270
3270
|
* - `metadata.graph_name`: Unique name for the graph
|
|
3271
|
-
* - `instance_tier`: Resource tier (
|
|
3271
|
+
* - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
|
|
3272
3272
|
*
|
|
3273
3273
|
* **Optional Fields:**
|
|
3274
3274
|
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
@@ -3393,9 +3393,9 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
|
|
|
3393
3393
|
* - Availability status
|
|
3394
3394
|
*
|
|
3395
3395
|
* **Available Tiers:**
|
|
3396
|
-
* - **
|
|
3397
|
-
* - **
|
|
3398
|
-
* - **
|
|
3396
|
+
* - **ladybug-standard**: Multi-tenant entry-level tier
|
|
3397
|
+
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
3398
|
+
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
3399
3399
|
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
3400
3400
|
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
3401
3401
|
*
|
|
@@ -3489,7 +3489,7 @@ export const selectGraph = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3489
3489
|
* - Credits are allocated per-graph, not shared across organization
|
|
3490
3490
|
*
|
|
3491
3491
|
* Includes:
|
|
3492
|
-
* - Graph infrastructure tiers (
|
|
3492
|
+
* - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
|
|
3493
3493
|
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
3494
3494
|
* - Operation costs and credit information
|
|
3495
3495
|
* - Features and capabilities for each tier
|
package/sdk/types.gen.d.ts
CHANGED
|
@@ -434,7 +434,7 @@ export type AvailableGraphTiersResponse = {
|
|
|
434
434
|
export type BackupCreateRequest = {
|
|
435
435
|
/**
|
|
436
436
|
* Backup Format
|
|
437
|
-
* Backup format - only 'full_dump' is supported (complete .
|
|
437
|
+
* Backup format - only 'full_dump' is supported (complete .lbug database file)
|
|
438
438
|
*/
|
|
439
439
|
backup_format?: string;
|
|
440
440
|
/**
|
|
@@ -1019,7 +1019,7 @@ export type CreateApiKeyResponse = {
|
|
|
1019
1019
|
export type CreateCheckoutRequest = {
|
|
1020
1020
|
/**
|
|
1021
1021
|
* Plan Name
|
|
1022
|
-
* Billing plan name (e.g., '
|
|
1022
|
+
* Billing plan name (e.g., 'ladybug-standard')
|
|
1023
1023
|
*/
|
|
1024
1024
|
plan_name: string;
|
|
1025
1025
|
/**
|
|
@@ -1069,7 +1069,7 @@ export type CreateGraphRequest = {
|
|
|
1069
1069
|
metadata: GraphMetadata;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* Instance Tier
|
|
1072
|
-
* Instance tier:
|
|
1072
|
+
* Instance tier: ladybug-standard, ladybug-large, ladybug-xlarge, neo4j-community-large, neo4j-enterprise-xlarge
|
|
1073
1073
|
*/
|
|
1074
1074
|
instance_tier?: string;
|
|
1075
1075
|
/**
|
|
@@ -2049,6 +2049,26 @@ export type GraphInfo = {
|
|
|
2049
2049
|
* Repository type if isRepository=true
|
|
2050
2050
|
*/
|
|
2051
2051
|
repositoryType?: string | null;
|
|
2052
|
+
/**
|
|
2053
|
+
* Schemaextensions
|
|
2054
|
+
* List of schema extensions installed on this graph
|
|
2055
|
+
*/
|
|
2056
|
+
schemaExtensions?: Array<string>;
|
|
2057
|
+
/**
|
|
2058
|
+
* Issubgraph
|
|
2059
|
+
* Whether this is a subgraph (vs a main graph)
|
|
2060
|
+
*/
|
|
2061
|
+
isSubgraph?: boolean;
|
|
2062
|
+
/**
|
|
2063
|
+
* Parentgraphid
|
|
2064
|
+
* Parent graph ID if this is a subgraph
|
|
2065
|
+
*/
|
|
2066
|
+
parentGraphId?: string | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* Graphtype
|
|
2069
|
+
* Type of graph: generic, entity, or repository
|
|
2070
|
+
*/
|
|
2071
|
+
graphType?: string;
|
|
2052
2072
|
};
|
|
2053
2073
|
/**
|
|
2054
2074
|
* GraphLimitsResponse
|
|
@@ -2271,7 +2291,7 @@ export type GraphSubscriptionResponse = {
|
|
|
2271
2291
|
export type GraphSubscriptionTier = {
|
|
2272
2292
|
/**
|
|
2273
2293
|
* Name
|
|
2274
|
-
* Infrastructure tier identifier (e.g.,
|
|
2294
|
+
* Infrastructure tier identifier (e.g., ladybug-standard)
|
|
2275
2295
|
*/
|
|
2276
2296
|
name: string;
|
|
2277
2297
|
/**
|
|
@@ -2341,7 +2361,7 @@ export type GraphSubscriptionTier = {
|
|
|
2341
2361
|
api_rate_multiplier: number;
|
|
2342
2362
|
/**
|
|
2343
2363
|
* Backend
|
|
2344
|
-
* Database backend (
|
|
2364
|
+
* Database backend (ladybug or neo4j)
|
|
2345
2365
|
*/
|
|
2346
2366
|
backend: string;
|
|
2347
2367
|
/**
|
|
@@ -2463,7 +2483,7 @@ export type GraphTierInfo = {
|
|
|
2463
2483
|
description: string;
|
|
2464
2484
|
/**
|
|
2465
2485
|
* Backend
|
|
2466
|
-
* Database backend (
|
|
2486
|
+
* Database backend (ladybug or neo4j)
|
|
2467
2487
|
*/
|
|
2468
2488
|
backend: string;
|
|
2469
2489
|
/**
|
|
@@ -2875,7 +2895,7 @@ export type ListSubgraphsResponse = {
|
|
|
2875
2895
|
parent_graph_tier: string;
|
|
2876
2896
|
/**
|
|
2877
2897
|
* Subgraphs Enabled
|
|
2878
|
-
* Whether subgraphs are enabled for this tier (requires
|
|
2898
|
+
* Whether subgraphs are enabled for this tier (requires LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2879
2899
|
*/
|
|
2880
2900
|
subgraphs_enabled: boolean;
|
|
2881
2901
|
/**
|
package/sdk/types.gen.ts
CHANGED
|
@@ -452,7 +452,7 @@ export type AvailableGraphTiersResponse = {
|
|
|
452
452
|
export type BackupCreateRequest = {
|
|
453
453
|
/**
|
|
454
454
|
* Backup Format
|
|
455
|
-
* Backup format - only 'full_dump' is supported (complete .
|
|
455
|
+
* Backup format - only 'full_dump' is supported (complete .lbug database file)
|
|
456
456
|
*/
|
|
457
457
|
backup_format?: string;
|
|
458
458
|
/**
|
|
@@ -1055,7 +1055,7 @@ export type CreateApiKeyResponse = {
|
|
|
1055
1055
|
export type CreateCheckoutRequest = {
|
|
1056
1056
|
/**
|
|
1057
1057
|
* Plan Name
|
|
1058
|
-
* Billing plan name (e.g., '
|
|
1058
|
+
* Billing plan name (e.g., 'ladybug-standard')
|
|
1059
1059
|
*/
|
|
1060
1060
|
plan_name: string;
|
|
1061
1061
|
/**
|
|
@@ -1107,7 +1107,7 @@ export type CreateGraphRequest = {
|
|
|
1107
1107
|
metadata: GraphMetadata;
|
|
1108
1108
|
/**
|
|
1109
1109
|
* Instance Tier
|
|
1110
|
-
* Instance tier:
|
|
1110
|
+
* Instance tier: ladybug-standard, ladybug-large, ladybug-xlarge, neo4j-community-large, neo4j-enterprise-xlarge
|
|
1111
1111
|
*/
|
|
1112
1112
|
instance_tier?: string;
|
|
1113
1113
|
/**
|
|
@@ -2116,6 +2116,26 @@ export type GraphInfo = {
|
|
|
2116
2116
|
* Repository type if isRepository=true
|
|
2117
2117
|
*/
|
|
2118
2118
|
repositoryType?: string | null;
|
|
2119
|
+
/**
|
|
2120
|
+
* Schemaextensions
|
|
2121
|
+
* List of schema extensions installed on this graph
|
|
2122
|
+
*/
|
|
2123
|
+
schemaExtensions?: Array<string>;
|
|
2124
|
+
/**
|
|
2125
|
+
* Issubgraph
|
|
2126
|
+
* Whether this is a subgraph (vs a main graph)
|
|
2127
|
+
*/
|
|
2128
|
+
isSubgraph?: boolean;
|
|
2129
|
+
/**
|
|
2130
|
+
* Parentgraphid
|
|
2131
|
+
* Parent graph ID if this is a subgraph
|
|
2132
|
+
*/
|
|
2133
|
+
parentGraphId?: string | null;
|
|
2134
|
+
/**
|
|
2135
|
+
* Graphtype
|
|
2136
|
+
* Type of graph: generic, entity, or repository
|
|
2137
|
+
*/
|
|
2138
|
+
graphType?: string;
|
|
2119
2139
|
};
|
|
2120
2140
|
|
|
2121
2141
|
/**
|
|
@@ -2343,7 +2363,7 @@ export type GraphSubscriptionResponse = {
|
|
|
2343
2363
|
export type GraphSubscriptionTier = {
|
|
2344
2364
|
/**
|
|
2345
2365
|
* Name
|
|
2346
|
-
* Infrastructure tier identifier (e.g.,
|
|
2366
|
+
* Infrastructure tier identifier (e.g., ladybug-standard)
|
|
2347
2367
|
*/
|
|
2348
2368
|
name: string;
|
|
2349
2369
|
/**
|
|
@@ -2413,7 +2433,7 @@ export type GraphSubscriptionTier = {
|
|
|
2413
2433
|
api_rate_multiplier: number;
|
|
2414
2434
|
/**
|
|
2415
2435
|
* Backend
|
|
2416
|
-
* Database backend (
|
|
2436
|
+
* Database backend (ladybug or neo4j)
|
|
2417
2437
|
*/
|
|
2418
2438
|
backend: string;
|
|
2419
2439
|
/**
|
|
@@ -2539,7 +2559,7 @@ export type GraphTierInfo = {
|
|
|
2539
2559
|
description: string;
|
|
2540
2560
|
/**
|
|
2541
2561
|
* Backend
|
|
2542
|
-
* Database backend (
|
|
2562
|
+
* Database backend (ladybug or neo4j)
|
|
2543
2563
|
*/
|
|
2544
2564
|
backend: string;
|
|
2545
2565
|
/**
|
|
@@ -2963,7 +2983,7 @@ export type ListSubgraphsResponse = {
|
|
|
2963
2983
|
parent_graph_tier: string;
|
|
2964
2984
|
/**
|
|
2965
2985
|
* Subgraphs Enabled
|
|
2966
|
-
* Whether subgraphs are enabled for this tier (requires
|
|
2986
|
+
* Whether subgraphs are enabled for this tier (requires LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2967
2987
|
*/
|
|
2968
2988
|
subgraphs_enabled: boolean;
|
|
2969
2989
|
/**
|
package/sdk.gen.d.ts
CHANGED
|
@@ -550,7 +550,7 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
|
|
|
550
550
|
* The tool list is customized based on:
|
|
551
551
|
* - Graph type (shared repository vs user graph)
|
|
552
552
|
* - User permissions and subscription tier
|
|
553
|
-
* - Backend capabilities (
|
|
553
|
+
* - Backend capabilities (LadybugDB, Neo4j, etc.)
|
|
554
554
|
*
|
|
555
555
|
* **Subgraph Support:**
|
|
556
556
|
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
@@ -620,8 +620,8 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
|
|
|
620
620
|
* Create Backup
|
|
621
621
|
* Create a backup of the graph database.
|
|
622
622
|
*
|
|
623
|
-
* Creates a complete backup of the graph database (.
|
|
624
|
-
* - **Format**: Full database backup only (complete .
|
|
623
|
+
* Creates a complete backup of the graph database (.lbug file) with:
|
|
624
|
+
* - **Format**: Full database backup only (complete .lbug file)
|
|
625
625
|
* - **Compression**: Always enabled for optimal storage
|
|
626
626
|
* - **Encryption**: Optional AES-256 encryption for security
|
|
627
627
|
* - **Retention**: Configurable retention period (1-2555 days)
|
|
@@ -682,7 +682,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
|
|
|
682
682
|
export declare const createBackup: <ThrowOnError extends boolean = false>(options: Options<CreateBackupData, ThrowOnError>) => import("./client").RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError, "fields">;
|
|
683
683
|
/**
|
|
684
684
|
* Get temporary download URL for backup
|
|
685
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .
|
|
685
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
686
686
|
*/
|
|
687
687
|
export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => import("./client").RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError, "fields">;
|
|
688
688
|
/**
|
|
@@ -1163,7 +1163,7 @@ export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1163
1163
|
*
|
|
1164
1164
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1165
1165
|
*
|
|
1166
|
-
* **Note**: Limits vary based on subscription tier (
|
|
1166
|
+
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
1167
1167
|
*/
|
|
1168
1168
|
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
|
|
1169
1169
|
/**
|
|
@@ -1188,7 +1188,7 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
|
|
|
1188
1188
|
* - Valid authentication
|
|
1189
1189
|
* - Parent graph must exist and be accessible to the user
|
|
1190
1190
|
* - User must have 'admin' permission on the parent graph
|
|
1191
|
-
* - Parent graph tier must support subgraphs (
|
|
1191
|
+
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
1192
1192
|
* - Must be within subgraph quota limits
|
|
1193
1193
|
* - Subgraph name must be unique within the parent graph
|
|
1194
1194
|
*
|
|
@@ -1230,8 +1230,8 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1230
1230
|
* All data in the subgraph will be lost.
|
|
1231
1231
|
*
|
|
1232
1232
|
* **Backup Location:**
|
|
1233
|
-
* If backup requested, stored in S3
|
|
1234
|
-
* `s3://{
|
|
1233
|
+
* If backup requested, stored in S3 graph database bucket at:
|
|
1234
|
+
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1235
1235
|
*
|
|
1236
1236
|
* **Notes:**
|
|
1237
1237
|
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
@@ -1256,7 +1256,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1256
1256
|
* - Last access time (when available)
|
|
1257
1257
|
*
|
|
1258
1258
|
* **Statistics:**
|
|
1259
|
-
* Real-time statistics queried from
|
|
1259
|
+
* Real-time statistics queried from LadybugDB:
|
|
1260
1260
|
* - Node count
|
|
1261
1261
|
* - Edge count
|
|
1262
1262
|
* - Database size on disk
|
|
@@ -1797,7 +1797,7 @@ export declare const getGraphs: <ThrowOnError extends boolean = false>(options?:
|
|
|
1797
1797
|
*
|
|
1798
1798
|
* **Required Fields:**
|
|
1799
1799
|
* - `metadata.graph_name`: Unique name for the graph
|
|
1800
|
-
* - `instance_tier`: Resource tier (
|
|
1800
|
+
* - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
|
|
1801
1801
|
*
|
|
1802
1802
|
* **Optional Fields:**
|
|
1803
1803
|
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
@@ -1886,9 +1886,9 @@ export declare const getAvailableExtensions: <ThrowOnError extends boolean = fal
|
|
|
1886
1886
|
* - Availability status
|
|
1887
1887
|
*
|
|
1888
1888
|
* **Available Tiers:**
|
|
1889
|
-
* - **
|
|
1890
|
-
* - **
|
|
1891
|
-
* - **
|
|
1889
|
+
* - **ladybug-standard**: Multi-tenant entry-level tier
|
|
1890
|
+
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
1891
|
+
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
1892
1892
|
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
1893
1893
|
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
1894
1894
|
*
|
|
@@ -1950,7 +1950,7 @@ export declare const selectGraph: <ThrowOnError extends boolean = false>(options
|
|
|
1950
1950
|
* - Credits are allocated per-graph, not shared across organization
|
|
1951
1951
|
*
|
|
1952
1952
|
* Includes:
|
|
1953
|
-
* - Graph infrastructure tiers (
|
|
1953
|
+
* - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
|
|
1954
1954
|
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
1955
1955
|
* - Operation costs and credit information
|
|
1956
1956
|
* - Features and capabilities for each tier
|
package/sdk.gen.js
CHANGED
|
@@ -1292,7 +1292,7 @@ exports.recommendAgent = recommendAgent;
|
|
|
1292
1292
|
* The tool list is customized based on:
|
|
1293
1293
|
* - Graph type (shared repository vs user graph)
|
|
1294
1294
|
* - User permissions and subscription tier
|
|
1295
|
-
* - Backend capabilities (
|
|
1295
|
+
* - Backend capabilities (LadybugDB, Neo4j, etc.)
|
|
1296
1296
|
*
|
|
1297
1297
|
* **Subgraph Support:**
|
|
1298
1298
|
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
@@ -1414,8 +1414,8 @@ exports.listBackups = listBackups;
|
|
|
1414
1414
|
* Create Backup
|
|
1415
1415
|
* Create a backup of the graph database.
|
|
1416
1416
|
*
|
|
1417
|
-
* Creates a complete backup of the graph database (.
|
|
1418
|
-
* - **Format**: Full database backup only (complete .
|
|
1417
|
+
* Creates a complete backup of the graph database (.lbug file) with:
|
|
1418
|
+
* - **Format**: Full database backup only (complete .lbug file)
|
|
1419
1419
|
* - **Compression**: Always enabled for optimal storage
|
|
1420
1420
|
* - **Encryption**: Optional AES-256 encryption for security
|
|
1421
1421
|
* - **Retention**: Configurable retention period (1-2555 days)
|
|
@@ -1496,7 +1496,7 @@ const createBackup = (options) => {
|
|
|
1496
1496
|
exports.createBackup = createBackup;
|
|
1497
1497
|
/**
|
|
1498
1498
|
* Get temporary download URL for backup
|
|
1499
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .
|
|
1499
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
1500
1500
|
*/
|
|
1501
1501
|
const getBackupDownloadUrl = (options) => {
|
|
1502
1502
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2245,7 +2245,7 @@ exports.getDatabaseInfo = getDatabaseInfo;
|
|
|
2245
2245
|
*
|
|
2246
2246
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2247
2247
|
*
|
|
2248
|
-
* **Note**: Limits vary based on subscription tier (
|
|
2248
|
+
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
2249
2249
|
*/
|
|
2250
2250
|
const getGraphLimits = (options) => {
|
|
2251
2251
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2302,7 +2302,7 @@ exports.listSubgraphs = listSubgraphs;
|
|
|
2302
2302
|
* - Valid authentication
|
|
2303
2303
|
* - Parent graph must exist and be accessible to the user
|
|
2304
2304
|
* - User must have 'admin' permission on the parent graph
|
|
2305
|
-
* - Parent graph tier must support subgraphs (
|
|
2305
|
+
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2306
2306
|
* - Must be within subgraph quota limits
|
|
2307
2307
|
* - Subgraph name must be unique within the parent graph
|
|
2308
2308
|
*
|
|
@@ -2364,8 +2364,8 @@ exports.createSubgraph = createSubgraph;
|
|
|
2364
2364
|
* All data in the subgraph will be lost.
|
|
2365
2365
|
*
|
|
2366
2366
|
* **Backup Location:**
|
|
2367
|
-
* If backup requested, stored in S3
|
|
2368
|
-
* `s3://{
|
|
2367
|
+
* If backup requested, stored in S3 graph database bucket at:
|
|
2368
|
+
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2369
2369
|
*
|
|
2370
2370
|
* **Notes:**
|
|
2371
2371
|
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
@@ -2410,7 +2410,7 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
2410
2410
|
* - Last access time (when available)
|
|
2411
2411
|
*
|
|
2412
2412
|
* **Statistics:**
|
|
2413
|
-
* Real-time statistics queried from
|
|
2413
|
+
* Real-time statistics queried from LadybugDB:
|
|
2414
2414
|
* - Node count
|
|
2415
2415
|
* - Edge count
|
|
2416
2416
|
* - Database size on disk
|
|
@@ -3255,7 +3255,7 @@ exports.getGraphs = getGraphs;
|
|
|
3255
3255
|
*
|
|
3256
3256
|
* **Required Fields:**
|
|
3257
3257
|
* - `metadata.graph_name`: Unique name for the graph
|
|
3258
|
-
* - `instance_tier`: Resource tier (
|
|
3258
|
+
* - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
|
|
3259
3259
|
*
|
|
3260
3260
|
* **Optional Fields:**
|
|
3261
3261
|
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
@@ -3380,9 +3380,9 @@ exports.getAvailableExtensions = getAvailableExtensions;
|
|
|
3380
3380
|
* - Availability status
|
|
3381
3381
|
*
|
|
3382
3382
|
* **Available Tiers:**
|
|
3383
|
-
* - **
|
|
3384
|
-
* - **
|
|
3385
|
-
* - **
|
|
3383
|
+
* - **ladybug-standard**: Multi-tenant entry-level tier
|
|
3384
|
+
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
3385
|
+
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
3386
3386
|
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
3387
3387
|
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
3388
3388
|
*
|
|
@@ -3476,7 +3476,7 @@ exports.selectGraph = selectGraph;
|
|
|
3476
3476
|
* - Credits are allocated per-graph, not shared across organization
|
|
3477
3477
|
*
|
|
3478
3478
|
* Includes:
|
|
3479
|
-
* - Graph infrastructure tiers (
|
|
3479
|
+
* - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
|
|
3480
3480
|
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
3481
3481
|
* - Operation costs and credit information
|
|
3482
3482
|
* - Features and capabilities for each tier
|
package/sdk.gen.ts
CHANGED
|
@@ -1305,7 +1305,7 @@ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1305
1305
|
* The tool list is customized based on:
|
|
1306
1306
|
* - Graph type (shared repository vs user graph)
|
|
1307
1307
|
* - User permissions and subscription tier
|
|
1308
|
-
* - Backend capabilities (
|
|
1308
|
+
* - Backend capabilities (LadybugDB, Neo4j, etc.)
|
|
1309
1309
|
*
|
|
1310
1310
|
* **Subgraph Support:**
|
|
1311
1311
|
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
@@ -1427,8 +1427,8 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1427
1427
|
* Create Backup
|
|
1428
1428
|
* Create a backup of the graph database.
|
|
1429
1429
|
*
|
|
1430
|
-
* Creates a complete backup of the graph database (.
|
|
1431
|
-
* - **Format**: Full database backup only (complete .
|
|
1430
|
+
* Creates a complete backup of the graph database (.lbug file) with:
|
|
1431
|
+
* - **Format**: Full database backup only (complete .lbug file)
|
|
1432
1432
|
* - **Compression**: Always enabled for optimal storage
|
|
1433
1433
|
* - **Encryption**: Optional AES-256 encryption for security
|
|
1434
1434
|
* - **Retention**: Configurable retention period (1-2555 days)
|
|
@@ -1509,7 +1509,7 @@ export const createBackup = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1509
1509
|
|
|
1510
1510
|
/**
|
|
1511
1511
|
* Get temporary download URL for backup
|
|
1512
|
-
* Generate a temporary download URL for a backup (unencrypted, compressed .
|
|
1512
|
+
* Generate a temporary download URL for a backup (unencrypted, compressed .lbug files only)
|
|
1513
1513
|
*/
|
|
1514
1514
|
export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => {
|
|
1515
1515
|
return (options.client ?? _heyApiClient).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
|
|
@@ -2258,7 +2258,7 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2258
2258
|
*
|
|
2259
2259
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2260
2260
|
*
|
|
2261
|
-
* **Note**: Limits vary based on subscription tier (
|
|
2261
|
+
* **Note**: Limits vary based on subscription tier (ladybug-standard, ladybug-large, ladybug-xlarge).
|
|
2262
2262
|
*/
|
|
2263
2263
|
export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
|
|
2264
2264
|
return (options.client ?? _heyApiClient).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
|
|
@@ -2315,7 +2315,7 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2315
2315
|
* - Valid authentication
|
|
2316
2316
|
* - Parent graph must exist and be accessible to the user
|
|
2317
2317
|
* - User must have 'admin' permission on the parent graph
|
|
2318
|
-
* - Parent graph tier must support subgraphs (
|
|
2318
|
+
* - Parent graph tier must support subgraphs (LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2319
2319
|
* - Must be within subgraph quota limits
|
|
2320
2320
|
* - Subgraph name must be unique within the parent graph
|
|
2321
2321
|
*
|
|
@@ -2377,8 +2377,8 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2377
2377
|
* All data in the subgraph will be lost.
|
|
2378
2378
|
*
|
|
2379
2379
|
* **Backup Location:**
|
|
2380
|
-
* If backup requested, stored in S3
|
|
2381
|
-
* `s3://{
|
|
2380
|
+
* If backup requested, stored in S3 graph database bucket at:
|
|
2381
|
+
* `s3://{graph_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2382
2382
|
*
|
|
2383
2383
|
* **Notes:**
|
|
2384
2384
|
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
@@ -2423,7 +2423,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2423
2423
|
* - Last access time (when available)
|
|
2424
2424
|
*
|
|
2425
2425
|
* **Statistics:**
|
|
2426
|
-
* Real-time statistics queried from
|
|
2426
|
+
* Real-time statistics queried from LadybugDB:
|
|
2427
2427
|
* - Node count
|
|
2428
2428
|
* - Edge count
|
|
2429
2429
|
* - Database size on disk
|
|
@@ -3268,7 +3268,7 @@ export const getGraphs = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
3268
3268
|
*
|
|
3269
3269
|
* **Required Fields:**
|
|
3270
3270
|
* - `metadata.graph_name`: Unique name for the graph
|
|
3271
|
-
* - `instance_tier`: Resource tier (
|
|
3271
|
+
* - `instance_tier`: Resource tier (ladybug-standard, ladybug-large, ladybug-xlarge)
|
|
3272
3272
|
*
|
|
3273
3273
|
* **Optional Fields:**
|
|
3274
3274
|
* - `metadata.description`: Human-readable description of the graph's purpose
|
|
@@ -3393,9 +3393,9 @@ export const getAvailableExtensions = <ThrowOnError extends boolean = false>(opt
|
|
|
3393
3393
|
* - Availability status
|
|
3394
3394
|
*
|
|
3395
3395
|
* **Available Tiers:**
|
|
3396
|
-
* - **
|
|
3397
|
-
* - **
|
|
3398
|
-
* - **
|
|
3396
|
+
* - **ladybug-standard**: Multi-tenant entry-level tier
|
|
3397
|
+
* - **ladybug-large**: Dedicated professional tier with subgraph support
|
|
3398
|
+
* - **ladybug-xlarge**: Enterprise tier with maximum resources
|
|
3399
3399
|
* - **neo4j-community-large**: Neo4j Community Edition (optional, if enabled)
|
|
3400
3400
|
* - **neo4j-enterprise-xlarge**: Neo4j Enterprise Edition (optional, if enabled)
|
|
3401
3401
|
*
|
|
@@ -3489,7 +3489,7 @@ export const selectGraph = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3489
3489
|
* - Credits are allocated per-graph, not shared across organization
|
|
3490
3490
|
*
|
|
3491
3491
|
* Includes:
|
|
3492
|
-
* - Graph infrastructure tiers (
|
|
3492
|
+
* - Graph infrastructure tiers (ladybug-standard, ladybug-large, ladybug-xlarge) - per-graph pricing
|
|
3493
3493
|
* - Shared repository subscriptions (SEC, industry, economic data) - org-level
|
|
3494
3494
|
* - Operation costs and credit information
|
|
3495
3495
|
* - Features and capabilities for each tier
|
package/types.gen.d.ts
CHANGED
|
@@ -434,7 +434,7 @@ export type AvailableGraphTiersResponse = {
|
|
|
434
434
|
export type BackupCreateRequest = {
|
|
435
435
|
/**
|
|
436
436
|
* Backup Format
|
|
437
|
-
* Backup format - only 'full_dump' is supported (complete .
|
|
437
|
+
* Backup format - only 'full_dump' is supported (complete .lbug database file)
|
|
438
438
|
*/
|
|
439
439
|
backup_format?: string;
|
|
440
440
|
/**
|
|
@@ -1019,7 +1019,7 @@ export type CreateApiKeyResponse = {
|
|
|
1019
1019
|
export type CreateCheckoutRequest = {
|
|
1020
1020
|
/**
|
|
1021
1021
|
* Plan Name
|
|
1022
|
-
* Billing plan name (e.g., '
|
|
1022
|
+
* Billing plan name (e.g., 'ladybug-standard')
|
|
1023
1023
|
*/
|
|
1024
1024
|
plan_name: string;
|
|
1025
1025
|
/**
|
|
@@ -1069,7 +1069,7 @@ export type CreateGraphRequest = {
|
|
|
1069
1069
|
metadata: GraphMetadata;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* Instance Tier
|
|
1072
|
-
* Instance tier:
|
|
1072
|
+
* Instance tier: ladybug-standard, ladybug-large, ladybug-xlarge, neo4j-community-large, neo4j-enterprise-xlarge
|
|
1073
1073
|
*/
|
|
1074
1074
|
instance_tier?: string;
|
|
1075
1075
|
/**
|
|
@@ -2049,6 +2049,26 @@ export type GraphInfo = {
|
|
|
2049
2049
|
* Repository type if isRepository=true
|
|
2050
2050
|
*/
|
|
2051
2051
|
repositoryType?: string | null;
|
|
2052
|
+
/**
|
|
2053
|
+
* Schemaextensions
|
|
2054
|
+
* List of schema extensions installed on this graph
|
|
2055
|
+
*/
|
|
2056
|
+
schemaExtensions?: Array<string>;
|
|
2057
|
+
/**
|
|
2058
|
+
* Issubgraph
|
|
2059
|
+
* Whether this is a subgraph (vs a main graph)
|
|
2060
|
+
*/
|
|
2061
|
+
isSubgraph?: boolean;
|
|
2062
|
+
/**
|
|
2063
|
+
* Parentgraphid
|
|
2064
|
+
* Parent graph ID if this is a subgraph
|
|
2065
|
+
*/
|
|
2066
|
+
parentGraphId?: string | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* Graphtype
|
|
2069
|
+
* Type of graph: generic, entity, or repository
|
|
2070
|
+
*/
|
|
2071
|
+
graphType?: string;
|
|
2052
2072
|
};
|
|
2053
2073
|
/**
|
|
2054
2074
|
* GraphLimitsResponse
|
|
@@ -2271,7 +2291,7 @@ export type GraphSubscriptionResponse = {
|
|
|
2271
2291
|
export type GraphSubscriptionTier = {
|
|
2272
2292
|
/**
|
|
2273
2293
|
* Name
|
|
2274
|
-
* Infrastructure tier identifier (e.g.,
|
|
2294
|
+
* Infrastructure tier identifier (e.g., ladybug-standard)
|
|
2275
2295
|
*/
|
|
2276
2296
|
name: string;
|
|
2277
2297
|
/**
|
|
@@ -2341,7 +2361,7 @@ export type GraphSubscriptionTier = {
|
|
|
2341
2361
|
api_rate_multiplier: number;
|
|
2342
2362
|
/**
|
|
2343
2363
|
* Backend
|
|
2344
|
-
* Database backend (
|
|
2364
|
+
* Database backend (ladybug or neo4j)
|
|
2345
2365
|
*/
|
|
2346
2366
|
backend: string;
|
|
2347
2367
|
/**
|
|
@@ -2463,7 +2483,7 @@ export type GraphTierInfo = {
|
|
|
2463
2483
|
description: string;
|
|
2464
2484
|
/**
|
|
2465
2485
|
* Backend
|
|
2466
|
-
* Database backend (
|
|
2486
|
+
* Database backend (ladybug or neo4j)
|
|
2467
2487
|
*/
|
|
2468
2488
|
backend: string;
|
|
2469
2489
|
/**
|
|
@@ -2875,7 +2895,7 @@ export type ListSubgraphsResponse = {
|
|
|
2875
2895
|
parent_graph_tier: string;
|
|
2876
2896
|
/**
|
|
2877
2897
|
* Subgraphs Enabled
|
|
2878
|
-
* Whether subgraphs are enabled for this tier (requires
|
|
2898
|
+
* Whether subgraphs are enabled for this tier (requires LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2879
2899
|
*/
|
|
2880
2900
|
subgraphs_enabled: boolean;
|
|
2881
2901
|
/**
|
package/types.gen.ts
CHANGED
|
@@ -452,7 +452,7 @@ export type AvailableGraphTiersResponse = {
|
|
|
452
452
|
export type BackupCreateRequest = {
|
|
453
453
|
/**
|
|
454
454
|
* Backup Format
|
|
455
|
-
* Backup format - only 'full_dump' is supported (complete .
|
|
455
|
+
* Backup format - only 'full_dump' is supported (complete .lbug database file)
|
|
456
456
|
*/
|
|
457
457
|
backup_format?: string;
|
|
458
458
|
/**
|
|
@@ -1055,7 +1055,7 @@ export type CreateApiKeyResponse = {
|
|
|
1055
1055
|
export type CreateCheckoutRequest = {
|
|
1056
1056
|
/**
|
|
1057
1057
|
* Plan Name
|
|
1058
|
-
* Billing plan name (e.g., '
|
|
1058
|
+
* Billing plan name (e.g., 'ladybug-standard')
|
|
1059
1059
|
*/
|
|
1060
1060
|
plan_name: string;
|
|
1061
1061
|
/**
|
|
@@ -1107,7 +1107,7 @@ export type CreateGraphRequest = {
|
|
|
1107
1107
|
metadata: GraphMetadata;
|
|
1108
1108
|
/**
|
|
1109
1109
|
* Instance Tier
|
|
1110
|
-
* Instance tier:
|
|
1110
|
+
* Instance tier: ladybug-standard, ladybug-large, ladybug-xlarge, neo4j-community-large, neo4j-enterprise-xlarge
|
|
1111
1111
|
*/
|
|
1112
1112
|
instance_tier?: string;
|
|
1113
1113
|
/**
|
|
@@ -2116,6 +2116,26 @@ export type GraphInfo = {
|
|
|
2116
2116
|
* Repository type if isRepository=true
|
|
2117
2117
|
*/
|
|
2118
2118
|
repositoryType?: string | null;
|
|
2119
|
+
/**
|
|
2120
|
+
* Schemaextensions
|
|
2121
|
+
* List of schema extensions installed on this graph
|
|
2122
|
+
*/
|
|
2123
|
+
schemaExtensions?: Array<string>;
|
|
2124
|
+
/**
|
|
2125
|
+
* Issubgraph
|
|
2126
|
+
* Whether this is a subgraph (vs a main graph)
|
|
2127
|
+
*/
|
|
2128
|
+
isSubgraph?: boolean;
|
|
2129
|
+
/**
|
|
2130
|
+
* Parentgraphid
|
|
2131
|
+
* Parent graph ID if this is a subgraph
|
|
2132
|
+
*/
|
|
2133
|
+
parentGraphId?: string | null;
|
|
2134
|
+
/**
|
|
2135
|
+
* Graphtype
|
|
2136
|
+
* Type of graph: generic, entity, or repository
|
|
2137
|
+
*/
|
|
2138
|
+
graphType?: string;
|
|
2119
2139
|
};
|
|
2120
2140
|
|
|
2121
2141
|
/**
|
|
@@ -2343,7 +2363,7 @@ export type GraphSubscriptionResponse = {
|
|
|
2343
2363
|
export type GraphSubscriptionTier = {
|
|
2344
2364
|
/**
|
|
2345
2365
|
* Name
|
|
2346
|
-
* Infrastructure tier identifier (e.g.,
|
|
2366
|
+
* Infrastructure tier identifier (e.g., ladybug-standard)
|
|
2347
2367
|
*/
|
|
2348
2368
|
name: string;
|
|
2349
2369
|
/**
|
|
@@ -2413,7 +2433,7 @@ export type GraphSubscriptionTier = {
|
|
|
2413
2433
|
api_rate_multiplier: number;
|
|
2414
2434
|
/**
|
|
2415
2435
|
* Backend
|
|
2416
|
-
* Database backend (
|
|
2436
|
+
* Database backend (ladybug or neo4j)
|
|
2417
2437
|
*/
|
|
2418
2438
|
backend: string;
|
|
2419
2439
|
/**
|
|
@@ -2539,7 +2559,7 @@ export type GraphTierInfo = {
|
|
|
2539
2559
|
description: string;
|
|
2540
2560
|
/**
|
|
2541
2561
|
* Backend
|
|
2542
|
-
* Database backend (
|
|
2562
|
+
* Database backend (ladybug or neo4j)
|
|
2543
2563
|
*/
|
|
2544
2564
|
backend: string;
|
|
2545
2565
|
/**
|
|
@@ -2963,7 +2983,7 @@ export type ListSubgraphsResponse = {
|
|
|
2963
2983
|
parent_graph_tier: string;
|
|
2964
2984
|
/**
|
|
2965
2985
|
* Subgraphs Enabled
|
|
2966
|
-
* Whether subgraphs are enabled for this tier (requires
|
|
2986
|
+
* Whether subgraphs are enabled for this tier (requires LadybugDB Large/XLarge or Neo4j Enterprise XLarge)
|
|
2967
2987
|
*/
|
|
2968
2988
|
subgraphs_enabled: boolean;
|
|
2969
2989
|
/**
|