@robosystems/client 0.3.7 → 0.3.8

package/sdk.gen.js

@@ -2,9 +2,9 @@
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.callMcpTool = exports.listMcpTools = exports.recommendAgent = exports.batchProcessQueries = exports.executeSpecificAgent = exports.getAgentMetadata = exports.autoSelectAgent = exports.listAgents = exports.syncConnection = exports.getConnection = exports.deleteConnection = exports.oauthCallback = exports.initOAuth = 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.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.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.opMaterialize = exports.opChangeTier = exports.opRestoreBackup = exports.opCreateBackup = exports.opDeleteSubgraph = exports.opCreateSubgraph = exports.uploadDocumentsBulk = exports.updateDocument = exports.getDocument = exports.deleteDocument = exports.uploadDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.queryTables = exports.listTables = exports.createRepositorySubscription = exports.changeSubscriptionPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.getBackupDownloadUrl = exports.listBackups = void 0;
-exports.opUpdatePublishList = exports.opCreatePublishList = exports.opShareReport = exports.opDeleteReport = exports.opRegenerateReport = exports.opCreateReport = exports.opAutoMapElements = exports.opDeleteSchedule = exports.opUpdateSchedule = exports.opReverseJournalEntry = exports.opDeleteJournalEntry = exports.opUpdateJournalEntry = exports.opCreateJournalEntry = exports.opCreateTransaction = exports.opDeleteAssociation = exports.opUpdateAssociation = exports.opCreateAssociations = exports.opDeleteElement = exports.opUpdateElement = exports.opCreateElement = exports.opDeleteStructure = exports.opUpdateStructure = exports.opLinkEntityTaxonomy = exports.opDeleteTaxonomy = exports.opUpdateTaxonomy = exports.opDeleteMappingAssociation = exports.opCreateMappingAssociation = exports.opCreateStructure = exports.opCreateTaxonomy = exports.opCreateManualClosingEntry = exports.opCreateClosingEntry = exports.opTruncateSchedule = exports.opCreateSchedule = exports.opReopenPeriod = exports.opClosePeriod = exports.opSetCloseTarget = exports.opInitializeLedger = exports.opUpdateEntity = exports.handleHttpPostExtensionsGraphIdGraphqlPost = exports.handleHttpGetExtensionsGraphIdGraphqlGet = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = exports.cancelOperation = void 0;
-exports.opDeletePosition = exports.opUpdatePosition = exports.opCreatePosition = exports.opDeleteSecurity = exports.opUpdateSecurity = exports.opCreateSecurity = exports.opDeletePortfolio = exports.opUpdatePortfolio = exports.opCreatePortfolio = exports.opBuildFactGrid = exports.opRemovePublishListMember = exports.opAddPublishListMembers = exports.opDeletePublishList = void 0;
+exports.cancelOperation = exports.getOperationStatus = exports.streamOperationEvents = exports.getServiceOfferings = exports.selectGraph = exports.getGraphCapacity = exports.getAvailableGraphTiers = exports.getAvailableExtensions = exports.createGraph = exports.getGraphs = exports.updateFile = exports.getFile = exports.deleteFile = exports.createFileUpload = exports.listFiles = exports.opMaterialize = exports.opChangeTier = exports.opRestoreBackup = exports.opCreateBackup = exports.opDeleteSubgraph = exports.opCreateSubgraph = exports.updateDocument = exports.getDocument = exports.deleteDocument = exports.uploadDocument = exports.listDocuments = exports.getDocumentSection = exports.searchDocuments = exports.queryTables = exports.listTables = exports.createRepositorySubscription = exports.changeSubscriptionPlan = exports.getGraphSubscription = exports.getSubgraphQuota = exports.getSubgraphInfo = exports.listSubgraphs = exports.getGraphLimits = exports.getDatabaseInfo = exports.getDatabaseHealth = exports.listCreditTransactions = exports.getCreditSummary = exports.validateSchema = exports.exportGraphSchema = exports.getGraphSchema = exports.executeCypherQuery = exports.getGraphUsageAnalytics = exports.getGraphMetrics = exports.getBackupStats = exports.getBackupDownloadUrl = exports.listBackups = void 0;
+exports.opDeletePublishList = exports.opUpdatePublishList = exports.opCreatePublishList = exports.opShareReport = exports.opDeleteReport = exports.opRegenerateReport = exports.opCreateReport = exports.opAutoMapElements = exports.opCreateMappingAssociation = exports.opDeleteSchedule = exports.opUpdateSchedule = exports.opCreateManualClosingEntry = exports.opCreateClosingEntry = exports.opTruncateSchedule = exports.opCreateSchedule = exports.opReverseJournalEntry = exports.opDeleteJournalEntry = exports.opUpdateJournalEntry = exports.opCreateJournalEntry = exports.opCreateTransaction = exports.opDeleteAssociation = exports.opUpdateAssociation = exports.opCreateAssociations = exports.opDeleteElement = exports.opUpdateElement = exports.opCreateElement = exports.opDeleteStructure = exports.opUpdateStructure = exports.opLinkEntityTaxonomy = exports.opDeleteTaxonomy = exports.opUpdateTaxonomy = exports.opDeleteMappingAssociation = exports.opCreateStructure = exports.opCreateTaxonomy = exports.opReopenPeriod = exports.opClosePeriod = exports.opSetCloseTarget = exports.opInitializeLedger = exports.opUpdateEntity = exports.handleHttpPostExtensionsGraphIdGraphqlPost = exports.handleHttpGetExtensionsGraphIdGraphqlGet = exports.getCheckoutStatus = exports.createCheckoutSession = exports.getOrgUpcomingInvoice = exports.listOrgInvoices = exports.cancelOrgSubscription = exports.getOrgSubscription = exports.listOrgSubscriptions = exports.createPortalSession = exports.getOrgBillingCustomer = void 0;
+exports.opDeletePosition = exports.opUpdatePosition = exports.opCreatePosition = exports.opDeleteSecurity = exports.opUpdateSecurity = exports.opCreateSecurity = exports.opDeletePortfolio = exports.opUpdatePortfolio = exports.opCreatePortfolio = exports.opFinancialStatementAnalysis = exports.opBuildFactGrid = exports.opLiveFinancialStatement = exports.opRemovePublishListMember = exports.opAddPublishListMembers = void 0;
 const client_gen_1 = require("./client.gen");
 /**
  * Register New User
@@ -901,21 +901,6 @@ const updateDocument = (options) => (options.client ?? client_gen_1.client).put(
     }
 });
 exports.updateDocument = updateDocument;
-/**
- * Bulk Upload Documents
- *
- * Upload up to 50 documents at once. Partial success is supported — check the errors array in the response.
- */
-const uploadDocumentsBulk = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
-    url: '/v1/graphs/{graph_id}/documents/bulk',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-exports.uploadDocumentsBulk = uploadDocumentsBulk;
 /**
  * Create Subgraph
  *
@@ -1397,74 +1382,6 @@ const opReopenPeriod = (options) => (options.client ?? client_gen_1.client).post
     }
 });
 exports.opReopenPeriod = opReopenPeriod;
-/**
- * Create Schedule
- *
- * Creates a schedule and pre-generates monthly amortization facts spanning the period range.
- *
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
- */
-const opCreateSchedule = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
-    url: '/extensions/roboledger/{graph_id}/operations/create-schedule',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-exports.opCreateSchedule = opCreateSchedule;
-/**
- * Truncate Schedule (End Early)
- *
- * Ends a schedule early by deleting forward facts and any stale draft closing entries past the cutoff.
- *
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
- */
-const opTruncateSchedule = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
-    url: '/extensions/roboledger/{graph_id}/operations/truncate-schedule',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-exports.opTruncateSchedule = opTruncateSchedule;
-/**
- * Create Closing Entry
- *
- * Creates a draft closing entry pre-populated from a schedule's facts for the given period.
- *
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
- */
-const opCreateClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
-    url: '/extensions/roboledger/{graph_id}/operations/create-closing-entry',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-exports.opCreateClosingEntry = opCreateClosingEntry;
-/**
- * Create Manual Closing Entry
- *
- * Creates a draft closing entry with manually specified amounts — not tied to a schedule.
- *
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
- */
-const opCreateManualClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
-    url: '/extensions/roboledger/{graph_id}/operations/create-manual-closing-entry',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-exports.opCreateManualClosingEntry = opCreateManualClosingEntry;
 /**
  * Create Taxonomy
  *
@@ -1499,23 +1416,6 @@ const opCreateStructure = (options) => (options.client ?? client_gen_1.client).p
     }
 });
 exports.opCreateStructure = opCreateStructure;
-/**
- * Create Mapping Association
- *
- * Links a chart-of-accounts element to a reporting concept (CoA element → US GAAP concept).
- *
- * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
- */
-const opCreateMappingAssociation = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
-    url: '/extensions/roboledger/{graph_id}/operations/create-mapping-association',
-    ...options,
-    headers: {
-        'Content-Type': 'application/json',
-        ...options.headers
-    }
-});
-exports.opCreateMappingAssociation = opCreateMappingAssociation;
 /**
  * Delete Mapping Association
  *
@@ -1805,6 +1705,74 @@ const opReverseJournalEntry = (options) => (options.client ?? client_gen_1.clien
     }
 });
 exports.opReverseJournalEntry = opReverseJournalEntry;
+/**
+ * Create Schedule
+ *
+ * Create a schedule and pre-generate monthly amortization facts spanning the period range. `entry_template` defines the debit/credit elements used by `create-closing-entry` each period.
+ *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opCreateSchedule = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/create-schedule',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opCreateSchedule = opCreateSchedule;
+/**
+ * Truncate Schedule (End Early)
+ *
+ * End a schedule early by deleting forward facts and any stale draft closing entries past the cutoff. Historical facts and posted entries are preserved. Use this when a business event (asset disposal, contract cancellation) shortens the schedule's lifespan.
+ *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opTruncateSchedule = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/truncate-schedule',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opTruncateSchedule = opTruncateSchedule;
+/**
+ * Create Closing Entry
+ *
+ * Create a draft closing entry pre-populated from a schedule's facts for the given period. Idempotent — safe to call repeatedly; the `outcome` field describes what happened (`created`, `unchanged`, `regenerated`, `removed`, `skipped`).
+ *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opCreateClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/create-closing-entry',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opCreateClosingEntry = opCreateClosingEntry;
+/**
+ * Create Manual Closing Entry
+ *
+ * Create a draft closing entry with manually specified line items — not tied to a schedule. Use for one-off business events (asset disposal, correcting entry, impairment). Total debits must equal total credits.
+ *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opCreateManualClosingEntry = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/create-manual-closing-entry',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opCreateManualClosingEntry = opCreateManualClosingEntry;
 /**
  * Update Schedule
  *
@@ -1839,6 +1807,23 @@ const opDeleteSchedule = (options) => (options.client ?? client_gen_1.client).po
     }
 });
 exports.opDeleteSchedule = opDeleteSchedule;
+/**
+ * Create Mapping Association
+ *
+ * Link a chart-of-accounts element to a US GAAP reporting concept. For bulk associations (presentation/calculation linkbases, 50+ arcs at once) use `create-associations` instead.
+ *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opCreateMappingAssociation = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/create-mapping-association',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opCreateMappingAssociation = opCreateMappingAssociation;
 /**
  * Auto-Map Elements via AI (async)
  *
@@ -2009,6 +1994,23 @@ const opRemovePublishListMember = (options) => (options.client ?? client_gen_1.c
     }
 });
 exports.opRemovePublishListMember = opRemovePublishListMember;
+/**
+ * Live Financial Statement
+ *
+ * Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. Rejected on shared-repository graphs; those should use `financial-statement-analysis` instead.
+ *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opLiveFinancialStatement = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/live-financial-statement',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opLiveFinancialStatement = opLiveFinancialStatement;
 /**
  * Build Fact Grid
  *
@@ -2027,9 +2029,26 @@ const opBuildFactGrid = (options) => (options.client ?? client_gen_1.client).pos
 });
 exports.opBuildFactGrid = opBuildFactGrid;
 /**
- * Create Portfolio
+ * Financial Statement Analysis
+ *
+ * Query a rendered financial statement from the graph-backed XBRL hypercube (Structure → FactSet → Fact). Works on the SEC shared repository today and on any RoboLedger tenant graph whose ledger has been materialized to LadybugDB. For shared-repo graphs, provide `ticker` to auto-resolve the latest filing; for tenant graphs, provide `report_id` explicitly.
  *
+ * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
+ */
+const opFinancialStatementAnalysis = (options) => (options.client ?? client_gen_1.client).post({
+    security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
+    url: '/extensions/roboledger/{graph_id}/operations/financial-statement-analysis',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+exports.opFinancialStatementAnalysis = opFinancialStatementAnalysis;
+/**
+ * Create Portfolio
  *
+ * Create an investment portfolio within this graph. Portfolios are logical groupings of securities (stocks, notes, warrants) owned by the entity; subsequent positions attach to the portfolio.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2046,7 +2065,7 @@ exports.opCreatePortfolio = opCreatePortfolio;
 /**
  * Update Portfolio
  *
- *
+ * Update mutable fields on a portfolio (name, description, strategy, inception_date, base_currency). Unset fields are ignored — partial updates are explicit.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2063,7 +2082,7 @@ exports.opUpdatePortfolio = opUpdatePortfolio;
 /**
  * Delete Portfolio
  *
- * Returns 409 if the portfolio has active positions — dispose them first.
+ * Hard-delete a portfolio. Returns 409 if the portfolio has active positions — dispose (soft-delete) them first.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2080,7 +2099,7 @@ exports.opDeletePortfolio = opDeletePortfolio;
 /**
  * Create Security
  *
- *
+ * Register a security (common stock, preferred stock, warrant, convertible note, etc.) owned by this graph's entity. Optionally cross-links to an issuing entity in another graph via `source_graph_id` for mutual-handshake attribution.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2097,7 +2116,7 @@ exports.opCreateSecurity = opCreateSecurity;
 /**
  * Update Security
  *
- *
+ * Update mutable fields on a security (name, type, subtype, terms, share counts, entity linkage). Unset fields are ignored.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2114,7 +2133,7 @@ exports.opUpdateSecurity = opUpdateSecurity;
 /**
  * Delete Security
  *
- * Soft-deletes the security (`is_active=false`). Historical positions referencing it remain valid.
+ * Soft-delete the security (`is_active=false`). Historical positions referencing it remain valid.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2131,7 +2150,7 @@ exports.opDeleteSecurity = opDeleteSecurity;
 /**
  * Create Position
  *
- * Returns 409 if an active position for this security already exists in the portfolio.
+ * Open a position in a security within a portfolio. One active position per (portfolio, security) pair — creating a second active position returns 409. Dispose an existing position via `delete-position` before opening a new one.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2148,7 +2167,7 @@ exports.opCreatePosition = opCreatePosition;
 /**
  * Update Position
  *
- *
+ * Update mutable fields on a position (quantity, cost basis, valuation, notes, status). Use `delete-position` for soft disposal instead of setting `status` manually.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */
@@ -2165,7 +2184,7 @@ exports.opUpdatePosition = opUpdatePosition;
 /**
  * Delete Position
  *
- * Soft-deletes the position (`is_active=false`). Historical holding records referencing it remain valid.
+ * Soft-delete the position (`status='disposed'`). Historical holding records referencing it remain valid.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */