@robosystems/client 0.1.14 → 0.1.16

package/sdk.gen.js

@@ -1,8 +1,8 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exportBackup = 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.getUserUsage = exports.getUserLimits = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.getAllCreditSummaries = exports.selectUserGraph = exports.getUserGraphs = exports.updateUser = exports.getCurrentUser = exports.getMcpHealth = 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;
-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;
+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;
+exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.getAvailableExtensions = exports.createGraph = exports.getSubgraphInfo = exports.getSubgraphQuota = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = 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;
 const client_gen_1 = require("./client.gen");
 /**
  * Register New User
@@ -171,27 +171,6 @@ const getServiceStatus = (options) => {
     });
 };
 exports.getServiceStatus = getServiceStatus;
-/**
- * MCP System Health Check
- * Basic health check for MCP system components
- */
-const getMcpHealth = (options) => {
-    return (options?.client ?? client_gen_1.client).get({
-        security: [
-            {
-                name: 'X-API-Key',
-                type: 'apiKey'
-            },
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/v1/mcp/health',
-        ...options
-    });
-};
-exports.getMcpHealth = getMcpHealth;
 /**
  * Get Current User
  * Returns information about the currently authenticated user.
@@ -275,7 +254,7 @@ const selectUserGraph = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/user/graphs/select/{graph_id}',
+        url: '/v1/user/graphs/{graph_id}/select',
         ...options
     });
 };
@@ -466,6 +445,56 @@ const getUserUsage = (options) => {
     });
 };
 exports.getUserUsage = getUserUsage;
+/**
+ * Get shared repository rate limit status
+ * Get current rate limit status and usage for a shared repository.
+ *
+ * Returns:
+ * - Current usage across different time windows
+ * - Rate limits based on subscription tier
+ * - Remaining quota
+ * - Reset times
+ *
+ * Note: All queries are FREE - this only shows rate limit status.
+ */
+const getSharedRepositoryLimits = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/user/limits/shared-repositories/{repository}',
+        ...options
+    });
+};
+exports.getSharedRepositoryLimits = getSharedRepositoryLimits;
+/**
+ * Get all shared repository limits
+ * Get rate limit status for all shared repositories the user has access to.
+ */
+const getAllSharedRepositoryLimits = (options) => {
+    return (options?.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/user/limits/shared-repositories/summary',
+        ...options
+    });
+};
+exports.getAllSharedRepositoryLimits = getAllSharedRepositoryLimits;
 /**
  * Get User Usage Overview
  * Get a high-level overview of usage statistics for the current user.
@@ -623,7 +652,7 @@ const getSharedRepositoryCredits = (options) => {
 exports.getSharedRepositoryCredits = getSharedRepositoryCredits;
 /**
  * Get Repository Credits
- * Get credit balance for a specific shared repository type
+ * Get credit balance for a specific shared repository
  */
 const getRepositoryCredits = (options) => {
     return (options.client ?? client_gen_1.client).get({
@@ -637,7 +666,7 @@ const getRepositoryCredits = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/user/subscriptions/shared-repositories/credits/{repository_type}',
+        url: '/v1/user/subscriptions/shared-repositories/credits/{repository}',
         ...options
     });
 };
@@ -737,10 +766,8 @@ exports.listConnections = listConnections;
  * - User completes bank authentication
  * - Exchange public token for access
  *
- * Credit consumption:
- * - Base cost: 5.0 credits
- * - Multiplied by graph tier
- * - Additional credits consumed during data sync
+ * Note:
+ * This operation is FREE - no credit consumption required.
  */
 const createConnection = (options) => {
     return (options.client ?? client_gen_1.client).post({
@@ -773,9 +800,8 @@ exports.createConnection = createConnection;
  * - Performs provider-specific cleanup
  * - Revokes stored credentials
  *
- * Credit consumption:
- * - Base cost: 2.0 credits
- * - Multiplied by graph tier
+ * Note:
+ * This operation is FREE - no credit consumption required.
  *
  * Only users with admin role can delete connections.
  */
@@ -848,10 +874,8 @@ exports.getConnection = getConnection;
  * - Updates account balances
  * - Categorizes new transactions
  *
- * Credit consumption:
- * - Base cost: 20.0 credits
- * - Multiplied by graph tier
- * - Additional credits may be consumed during processing
+ * Note:
+ * This operation is FREE - no credit consumption required.
  *
  * Returns a task ID for monitoring sync progress.
  */
@@ -1071,10 +1095,10 @@ exports.oauthCallback = oauthCallback;
  * - Fallback to status polling endpoint if SSE unavailable
  *
  * **Credit Consumption:**
- * - Variable based on complexity: 3-60 credits
- * - Simple queries: 3-15 credits
- * - Complex analysis: 15-60 credits
- * - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
+ * - AI operations consume credits based on actual token usage
+ * - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
+ * - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
+ * - Credits are consumed after operation completes based on actual usage
  *
  * The agent automatically determines query complexity or you can force extended analysis.
  */
@@ -1168,11 +1192,8 @@ exports.listMcpTools = listMcpTools;
  * - `408 Request Timeout`: Tool execution exceeded timeout
  * - Clients should implement exponential backoff on errors
  *
- * **Credit Consumption:**
- * - Simple tools: 2-5 credits
- * - Schema tools: 5-10 credits
- * - Query tools: 10-50 credits (based on complexity)
- * - Multiplied by graph tier
+ * **Note:**
+ * MCP tool calls are currently FREE and do not consume credits.
  */
 const callMcpTool = (options) => {
     return (options.client ?? client_gen_1.client).post({
@@ -1431,7 +1452,7 @@ const getBackupDownloadUrl = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/{graph_id}/backup/{backup_id}/download-url',
+        url: '/v1/{graph_id}/backup/{backup_id}/download',
         ...options
     });
 };
@@ -1453,9 +1474,8 @@ exports.getBackupDownloadUrl = getBackupDownloadUrl;
  * - Capacity planning
  * - Performance optimization
  *
- * Credit consumption:
- * - Base cost: 15.0 credits
- * - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
+ * Note:
+ * This operation is FREE - no credit consumption required.
  */
 const getGraphMetrics = (options) => {
     return (options.client ?? client_gen_1.client).get({
@@ -1497,9 +1517,8 @@ exports.getGraphMetrics = getGraphMetrics;
  * - Usage trend analysis
  * - Performance tuning
  *
- * Credit consumption:
- * - Base cost: 10.0 credits
- * - Multiplied by graph tier
+ * Note:
+ * This operation is FREE - no credit consumption required.
  */
 const getGraphUsageStats = (options) => {
     return (options.client ?? client_gen_1.client).get({
@@ -1531,7 +1550,7 @@ exports.getGraphUsageStats = getGraphUsageStats;
  * **Response Modes:**
  * - `auto` (default): Intelligent automatic selection
  * - `sync`: Force synchronous JSON response (best for testing)
- * - `async`: Force queued response with polling URLs
+ * - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
  * - `stream`: Force streaming response (SSE or NDJSON)
  *
  * **Client Detection:**
@@ -1554,19 +1573,19 @@ exports.getGraphUsageStats = getGraphUsageStats;
  *
  * **Queue Management:**
  * - Automatic queuing under high load
- * - SSE-based queue monitoring (no polling needed)
+ * - Real-time monitoring via SSE events (no polling needed)
  * - Priority based on subscription tier
- * - Queue position updates via SSE events
+ * - Queue position and progress updates pushed via SSE
+ * - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
  *
  * **Error Handling:**
  * - `429 Too Many Requests`: Rate limit or connection limit exceeded
  * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
  * - Clients should implement exponential backoff
  *
- * **Credit Consumption:**
- * - Variable based on query complexity: 1-50 credits
- * - Streaming queries charged per 1000 rows
- * - Queue position based on subscription tier
+ * **Note:**
+ * Query operations are FREE - no credit consumption required.
+ * Queue position is based on subscription tier for priority.
  */
 const executeCypherQuery = (options) => {
     return (options.client ?? client_gen_1.client).post({
@@ -1601,10 +1620,7 @@ exports.executeCypherQuery = executeCypherQuery;
  * This is different from custom schema management - it shows what actually exists in the database,
  * useful for understanding the current graph structure before writing queries.
  *
- * Credit consumption:
- * - Base cost: 2.0 credits
- * - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
- * - Schema information is cached for performance
+ * This operation is FREE - no credit consumption required.
  */
 const getGraphSchemaInfo = (options) => {
     return (options.client ?? client_gen_1.client).get({
@@ -1646,9 +1662,7 @@ exports.getGraphSchemaInfo = getGraphSchemaInfo;
  * - Performance problems
  * - Naming conflicts
  *
- * Credit consumption:
- * - Base cost: 5.0 credits
- * - Multiplied by graph tier
+ * This operation is FREE - no credit consumption required.
  */
 const validateSchema = (options) => {
     return (options.client ?? client_gen_1.client).post({
@@ -2194,6 +2208,220 @@ const getDatabaseInfo = (options) => {
     });
 };
 exports.getDatabaseInfo = getDatabaseInfo;
+/**
+ * List Subgraphs
+ * List all subgraphs for a parent graph.
+ *
+ * **Requirements:**
+ * - User must have at least read access to parent graph
+ *
+ * **Response includes:**
+ * - List of all subgraphs with metadata
+ * - Current usage vs limits
+ * - Size and statistics per subgraph
+ * - Creation timestamps
+ *
+ * **Filtering:**
+ * Currently returns all subgraphs. Future versions will support:
+ * - Filtering by status
+ * - Filtering by creation date
+ * - Pagination for large lists
+ */
+const listSubgraphs = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/{graph_id}/subgraphs',
+        ...options
+    });
+};
+exports.listSubgraphs = listSubgraphs;
+/**
+ * Create New Subgraph
+ * Create a new subgraph database under an Enterprise or Premium parent graph.
+ *
+ * **Requirements:**
+ * - Parent graph must be Enterprise or Premium tier
+ * - User must have admin access to parent graph
+ * - Subgraph name must be unique within parent
+ * - Subgraph name must be alphanumeric (1-20 chars)
+ *
+ * **Subgraph Benefits:**
+ * - Shares parent's infrastructure (no additional cost)
+ * - Inherits parent's credit pool
+ * - Isolated database on same instance
+ * - Full Kuzu database capabilities
+ *
+ * **Use Cases:**
+ * - Separate environments (dev/staging/prod)
+ * - Department-specific data isolation
+ * - Multi-tenant applications
+ * - Testing and experimentation
+ *
+ * **Schema Inheritance:**
+ * - Subgraphs can use parent's schema or custom extensions
+ * - Extensions are additive only
+ * - Base schema always included
+ *
+ * **Limits:**
+ * - Standard: Not supported (0 subgraphs)
+ * - Enterprise: Configurable limit (default: 10 subgraphs)
+ * - Premium: Unlimited subgraphs
+ * - Limits are defined in deployment configuration
+ *
+ * **Response includes:**
+ * - `graph_id`: Full subgraph identifier
+ * - `parent_graph_id`: Parent graph ID
+ * - `subgraph_name`: Short name within parent
+ * - `status`: Creation status
+ */
+const createSubgraph = (options) => {
+    return (options.client ?? client_gen_1.client).post({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/{graph_id}/subgraphs',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+exports.createSubgraph = createSubgraph;
+/**
+ * Delete Subgraph
+ * Delete a subgraph database.
+ *
+ * **Requirements:**
+ * - Must be a valid subgraph (not parent graph)
+ * - User must have admin access to parent graph
+ * - Optional backup before deletion
+ *
+ * **Deletion Options:**
+ * - `force`: Delete even if contains data
+ * - `backup_first`: Create backup before deletion
+ *
+ * **Warning:**
+ * Deletion is permanent unless backup is created.
+ * All data in the subgraph will be lost.
+ *
+ * **Backup Location:**
+ * If backup requested, stored in S3 at:
+ * `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
+ */
+const deleteSubgraph = (options) => {
+    return (options.client ?? client_gen_1.client).delete({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/{graph_id}/subgraphs/{subgraph_name}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+exports.deleteSubgraph = deleteSubgraph;
+/**
+ * Get Subgraph Quota
+ * Get subgraph quota and usage information for a parent graph.
+ *
+ * **Shows:**
+ * - Current subgraph count
+ * - Maximum allowed subgraphs per tier
+ * - Remaining capacity
+ * - Total size usage across all subgraphs
+ *
+ * **Tier Limits:**
+ * - Standard: 0 subgraphs (not supported)
+ * - Enterprise: Configurable limit (default: 10 subgraphs)
+ * - Premium: Unlimited subgraphs
+ * - Limits are defined in deployment configuration
+ *
+ * **Size Tracking:**
+ * Provides aggregate size metrics when available.
+ * Individual subgraph sizes shown in list endpoint.
+ */
+const getSubgraphQuota = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/{graph_id}/subgraphs/quota',
+        ...options
+    });
+};
+exports.getSubgraphQuota = getSubgraphQuota;
+/**
+ * Get Subgraph Details
+ * Get detailed information about a specific subgraph.
+ *
+ * **Requirements:**
+ * - User must have read access to parent graph
+ *
+ * **Response includes:**
+ * - Full subgraph metadata
+ * - Database statistics (nodes, edges)
+ * - Size information
+ * - Schema configuration
+ * - Creation/modification timestamps
+ * - Last access time (when available)
+ *
+ * **Statistics:**
+ * Real-time statistics queried from Kuzu:
+ * - Node count
+ * - Edge count
+ * - Database size on disk
+ * - Schema information
+ */
+const getSubgraphInfo = (options) => {
+    return (options.client ?? client_gen_1.client).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            },
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/v1/{graph_id}/subgraphs/{subgraph_name}/info',
+        ...options
+    });
+};
+exports.getSubgraphInfo = getSubgraphInfo;
 /**
  * Create New Graph Database
  * Create a new graph database with specified schema and optionally an initial entity.
@@ -2274,7 +2502,7 @@ const getAvailableExtensions = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/create/graph/available-extensions',
+        url: '/v1/create/graph/extensions',
         ...options
     });
 };
@@ -2288,7 +2516,7 @@ exports.getAvailableExtensions = getAvailableExtensions;
  * applications to display subscription options.
  *
  * Includes:
- * - Graph subscription tiers (trial, standard, enterprise, premium)
+ * - Graph subscription tiers (standard, enterprise, premium)
  * - Shared repository subscriptions (SEC, industry, economic data)
  * - Operation costs and credit information
  * - Features and capabilities for each tier