@robosystems/client 0.2.12 → 0.2.14

package/sdk/sdk.gen.js

@@ -2,8 +2,8 @@
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = exports.createLinkToken = exports.exchangeLinkToken = exports.getConnectionOptions = exports.createConnection = exports.listConnections = exports.getOrgUsage = exports.getOrgLimits = exports.updateOrgMemberRole = exports.removeOrgMember = exports.inviteOrgMember = exports.listOrgMembers = exports.listOrgGraphs = exports.updateOrg = exports.getOrg = exports.createOrg = exports.listUserOrgs = exports.updateUserApiKey = exports.revokeUserApiKey = exports.createUserApiKey = exports.listUserApiKeys = exports.updateUserPassword = exports.updateUser = exports.getCurrentUser = exports.getServiceStatus = exports.getCaptchaConfig = exports.completeSsoAuth = exports.ssoTokenExchange = exports.generateSsoToken = exports.resetPassword = exports.validateResetToken = exports.forgotPassword = exports.checkPasswordStrength = exports.getPasswordPolicy = exports.verifyEmail = exports.resendVerificationEmail = exports.refreshAuthSession = exports.getCurrentAuthUser = exports.logoutUser = exports.loginUser = exports.registerUser = void 0;
-exports.updateOrgPaymentMethod = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.queryTables = exports.ingestTables = exports.updateFileStatus = exports.getFileInfo = exports.deleteFile = exports.getUploadUrl = exports.listTableFiles = exports.listTables = exports.upgradeSubscription = exports.createRepositorySubscription = exports.getGraphSubscription = exports.cancelSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = void 0;
-exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = void 0;
+exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.queryTables = exports.ingestTables = exports.updateFileStatus = exports.getFileInfo = exports.deleteFile = exports.getUploadUrl = exports.listTableFiles = exports.listTables = exports.upgradeSubscription = exports.createRepositorySubscription = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.deleteSubgraph = exports.createSubgraph = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.checkStorageLimits = exports.getStorageUsage = exports.checkCreditBalance = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.restoreBackup = exports.getBackupDownloadUrl = exports.createBackup = exports.listBackups = exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = void 0;
+exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = void 0;
 const client_gen_1 = require("./client.gen");
 /**
  * Register New User
@@ -1103,6 +1103,13 @@ exports.listAgents = listAgents;
  * - Leverage conversation history for contextual understanding
  * - Enable RAG for knowledge base enrichment
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Agents operate on the specified graph/subgraph's data independently. RAG enrichment
+ * and knowledge base search are scoped to the specific graph/subgraph.
+ *
  * See request/response examples in the "Examples" dropdown below.
  */
 const autoSelectAgent = (options) => {
@@ -1287,6 +1294,13 @@ exports.recommendAgent = recommendAgent;
  * - User permissions and subscription tier
  * - Backend capabilities (Kuzu, Neo4j, etc.)
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * The returned tool list is identical for parent graphs and subgraphs, as all
+ * MCP tools work uniformly across graph boundaries.
+ *
  * **Note:**
  * MCP tool listing is included - no credit consumption required.
  */
@@ -1341,6 +1355,13 @@ exports.listMcpTools = listMcpTools;
  * - `408 Request Timeout`: Tool execution exceeded timeout
  * - Clients should implement exponential backoff on errors
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * MCP tools operate on the specified graph/subgraph independently. Each subgraph
+ * has its own schema, data, and can be queried separately via MCP.
+ *
  * **Credit Model:**
  * MCP tool execution is included - no credit consumption required. Database
  * operations (queries, schema inspection, analytics) are completely free.
@@ -1748,6 +1769,12 @@ exports.getGraphUsageAnalytics = getGraphUsageAnalytics;
  * - `503 Service Unavailable`: Circuit breaker open or SSE disabled
  * - Clients should implement exponential backoff
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Subgraphs share the same instance as their parent graph and have independent data.
+ *
  * **Note:**
  * Query operations are included - no credit consumption required.
  * Queue position is based on subscription tier for priority.
@@ -1810,6 +1837,14 @@ exports.executeCypherQuery = executeCypherQuery;
  * Property discovery is limited to 10 properties per node type for performance.
  * For complete schema definitions, use `/schema/export`.
  *
+ * ## Subgraph Support
+ *
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Each subgraph has independent schema and data. The returned schema reflects
+ * only the specified graph/subgraph's actual structure.
+ *
  * This operation is included - no credit consumption required.
  */
 const getGraphSchema = (options) => {
@@ -1919,6 +1954,13 @@ exports.exportGraphSchema = exportGraphSchema;
  * - Performance problems
  * - Naming conflicts
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Schema validation is performed against the specified graph/subgraph's current
+ * schema and data structure.
+ *
  * This operation is included - no credit consumption required.
  */
 const validateSchema = (options) => {
@@ -2115,6 +2157,13 @@ exports.checkStorageLimits = checkStorageLimits;
  * - **Resource Usage**: Memory and storage consumption
  * - **Alerts**: Active warnings or issues
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Health metrics are specific to the requested graph/subgraph. Subgraphs share the
+ * same physical instance as their parent but have independent health indicators.
+ *
  * This endpoint provides essential monitoring data for operational visibility.
  */
 const getDatabaseHealth = (options) => {
@@ -2153,6 +2202,13 @@ exports.getDatabaseHealth = getDatabaseHealth;
  * - **Backup Status**: Backup availability and recency
  * - **Timestamps**: Creation and modification dates
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Returned metrics are specific to the requested graph/subgraph. Subgraphs have
+ * independent size, node/relationship counts, and backup status.
+ *
  * This endpoint provides essential database information for capacity planning and monitoring.
  */
 const getDatabaseInfo = (options) => {
@@ -2186,7 +2242,7 @@ exports.getDatabaseInfo = getDatabaseInfo;
  *
  * This unified endpoint provides all limits in one place for easier client integration.
  *
- * **Note**: Limits vary based on subscription tier (Standard, Enterprise, Premium).
+ * **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
  */
 const getGraphLimits = (options) => {
     return (options.client ?? client_gen_1.client).get({
@@ -2243,12 +2299,18 @@ exports.listSubgraphs = listSubgraphs;
  * - Valid authentication
  * - Parent graph must exist and be accessible to the user
  * - User must have 'admin' permission on the parent graph
- * - Parent graph tier must support subgraphs (Enterprise or Premium only)
+ * - Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
  * - Must be within subgraph quota limits
  * - Subgraph name must be unique within the parent graph
  *
  * **Returns:**
  * - Created subgraph details including its unique ID
+ * - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
+ *
+ * **Usage:**
+ * - Subgraphs share parent's credit pool
+ * - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
+ * - Permissions inherited from parent graph
  */
 const createSubgraph = (options) => {
     return (options.client ?? client_gen_1.client).post({
@@ -2278,6 +2340,7 @@ exports.createSubgraph = createSubgraph;
  * **Requirements:**
  * - Must be a valid subgraph (not parent graph)
  * - User must have admin access to parent graph
+ * - Subgraph name must be alphanumeric (1-20 characters)
  * - Optional backup before deletion
  *
  * **Deletion Options:**
@@ -2289,8 +2352,13 @@ exports.createSubgraph = createSubgraph;
  * 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`
+ * If backup requested, stored in S3 Kuzu database bucket at:
+ * `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
+ *
+ * **Notes:**
+ * - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
+ * - Deletion does not affect parent graph's credit pool or permissions
+ * - Backup creation consumes credits from parent graph's allocation
  */
 const deleteSubgraph = (options) => {
     return (options.client ?? client_gen_1.client).delete({
@@ -2304,7 +2372,7 @@ const deleteSubgraph = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}',
+        url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
         ...options,
         headers: {
             'Content-Type': 'application/json',
@@ -2319,6 +2387,7 @@ exports.deleteSubgraph = deleteSubgraph;
  *
  * **Requirements:**
  * - User must have read access to parent graph
+ * - Subgraph name must be alphanumeric (1-20 characters)
  *
  * **Response includes:**
  * - Full subgraph metadata
@@ -2334,6 +2403,10 @@ exports.deleteSubgraph = deleteSubgraph;
  * - Edge count
  * - Database size on disk
  * - Schema information
+ *
+ * **Note:**
+ * Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
+ * The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
  */
 const getSubgraphInfo = (options) => {
     return (options.client ?? client_gen_1.client).get({
@@ -2347,7 +2420,7 @@ const getSubgraphInfo = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_id}/info',
+        url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
         ...options
     });
 };
@@ -2389,32 +2462,6 @@ const getSubgraphQuota = (options) => {
     });
 };
 exports.getSubgraphQuota = getSubgraphQuota;
-/**
- * Cancel Subscription
- * Cancel a subscription.
- *
- * For shared repositories: Cancels the user's personal subscription
- * For user graphs: Not allowed - delete the graph instead
- *
- * The subscription will be marked as canceled and will end at the current period end date.
- */
-const cancelSubscription = (options) => {
-    return (options.client ?? client_gen_1.client).delete({
-        security: [
-            {
-                name: 'X-API-Key',
-                type: 'apiKey'
-            },
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/v1/graphs/{graph_id}/subscriptions',
-        ...options
-    });
-};
-exports.cancelSubscription = cancelSubscription;
 /**
  * Get Subscription
  * Get subscription details for a graph or shared repository.
@@ -2637,6 +2684,13 @@ exports.listTableFiles = listTableFiles;
  * Tables are automatically created on first file upload with type inferred from name
  * (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
+ * to one subgraph do not appear in other subgraphs.
+ *
  * **Important Notes:**
  * - Presigned URLs expire (default: 1 hour)
  * - Use appropriate Content-Type header when uploading to S3
@@ -2828,7 +2882,7 @@ exports.updateFileStatus = updateFileStatus;
  * 2. Files are validated and marked as 'uploaded'
  * 3. Trigger ingestion: `POST /tables/ingest`
  * 4. DuckDB staging tables created from S3 patterns
- * 5. Data copied row-by-row from DuckDB to Kuzu
+ * 5. Data copied from DuckDB to Kuzu
  * 6. Per-table results and metrics returned
  *
  * **Rebuild Feature:**
@@ -2859,6 +2913,13 @@ exports.updateFileStatus = updateFileStatus;
  * you'll receive a 409 Conflict error. The distributed lock automatically expires after
  * the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Each subgraph has independent staging tables and graph data. Ingestion operates
+ * on the specified graph/subgraph only and does not affect other subgraphs.
+ *
  * **Important Notes:**
  * - Only files with 'uploaded' status are processed
  * - Tables with no uploaded files are skipped
@@ -2935,6 +2996,12 @@ exports.ingestTables = ingestTables;
  * - Read-only: No INSERT, UPDATE, DELETE
  * - User's tables only: Cannot query other users' data
  *
+ * **Subgraph Support:**
+ * This endpoint accepts both parent graph IDs and subgraph IDs.
+ * - Parent graph: Use `graph_id` like `kg0123456789abcdef`
+ * - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
+ * Each subgraph has its own independent staging tables.
+ *
  * **Shared Repositories:**
  * Shared repositories (SEC, etc.) do not allow direct SQL queries.
  * Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
@@ -3447,15 +3514,22 @@ const getOrgBillingCustomer = (options) => {
 };
 exports.getOrgBillingCustomer = getOrgBillingCustomer;
 /**
- * Update Organization Default Payment Method
- * Update the default payment method for the organization.
+ * Create Customer Portal Session
+ * Create a Stripe Customer Portal session for managing payment methods.
  *
- * This changes which payment method will be used for future subscription charges.
+ * The portal allows users to:
+ * - Add new payment methods
+ * - Remove existing payment methods
+ * - Update default payment method
+ * - View billing history
+ *
+ * The user will be redirected to Stripe's hosted portal page and returned to the billing page when done.
  *
  * **Requirements:**
  * - User must be an OWNER of the organization
+ * - Organization must have a Stripe customer ID (i.e., has gone through checkout at least once)
  */
-const updateOrgPaymentMethod = (options) => {
+const createPortalSession = (options) => {
     return (options.client ?? client_gen_1.client).post({
         security: [
             {
@@ -3467,15 +3541,11 @@ const updateOrgPaymentMethod = (options) => {
                 type: 'http'
             }
         ],
-        url: '/v1/billing/customer/{org_id}/payment-method',
-        ...options,
-        headers: {
-            'Content-Type': 'application/json',
-            ...options.headers
-        }
+        url: '/v1/billing/customer/{org_id}/portal',
+        ...options
     });
 };
-exports.updateOrgPaymentMethod = updateOrgPaymentMethod;
+exports.createPortalSession = createPortalSession;
 /**
  * List Organization Subscriptions
  * List all active and past subscriptions for an organization.