@knowledge-stack/ksapi 1.88.1 → 1.89.0

package/dist/apis/WorkflowRunsApi.js

@@ -63,50 +63,51 @@ const index_1 = require("../models/index");
  */
 class WorkflowRunsApi extends runtime.BaseAPI {
     /**
-     * Creates request options for approveWorkflowRunFile without sending the request
+     * Creates request options for cloneWorkflowRun without sending the request
      */
-    approveWorkflowRunFileRequestOpts(requestParameters) {
+    cloneWorkflowRunRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['runId'] == null) {
-                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling approveWorkflowRunFile().');
+                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling cloneWorkflowRun().');
             }
-            if (requestParameters['pathPartId'] == null) {
-                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling approveWorkflowRunFile().');
+            if (requestParameters['cloneWorkflowRunRequest'] == null) {
+                throw new runtime.RequiredError('cloneWorkflowRunRequest', 'Required parameter "cloneWorkflowRunRequest" was null or undefined when calling cloneWorkflowRun().');
             }
             const queryParameters = {};
             const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
             if (requestParameters['authorization'] != null) {
                 headerParameters['authorization'] = String(requestParameters['authorization']);
             }
-            let urlPath = `/v1/workflow-runs/{run_id}/files/{path_part_id}/approve`;
+            let urlPath = `/v1/workflow-runs/{run_id}/clone`;
             urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
-            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
             return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
+                body: (0, index_1.CloneWorkflowRunRequestToJSON)(requestParameters['cloneWorkflowRunRequest']),
             };
         });
     }
     /**
-     * Approve a generated file or the run folder itself.  Open to any user with ``can_write`` on the run path — both individual child files and the run folder (the final verdict that flips the run to APPROVED). Folder approval still requires no descendants in ``pending`` or ``rejected`` state.
-     * Approve Workflow Run File Handler
+     * Clone a started run into a new NOT_STARTED draft.  ``include_inputs=True`` pins the source\'s snapshotted inputs onto the new run; uploads stay in the source\'s ``inputs/`` and are referenced by path_part_id. No S3 copy. A NOT_STARTED source has no snapshot to pin → 409. The clone is born NOT_STARTED so the user can edit it (PATCH) before pressing Start.
+     * Clone Workflow Run Handler
      */
-    approveWorkflowRunFileRaw(requestParameters, initOverrides) {
+    cloneWorkflowRunRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.approveWorkflowRunFileRequestOpts(requestParameters);
+            const requestOptions = yield this.cloneWorkflowRunRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PathPartApprovalResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowRunResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Approve a generated file or the run folder itself.  Open to any user with ``can_write`` on the run path — both individual child files and the run folder (the final verdict that flips the run to APPROVED). Folder approval still requires no descendants in ``pending`` or ``rejected`` state.
-     * Approve Workflow Run File Handler
+     * Clone a started run into a new NOT_STARTED draft.  ``include_inputs=True`` pins the source\'s snapshotted inputs onto the new run; uploads stay in the source\'s ``inputs/`` and are referenced by path_part_id. No S3 copy. A NOT_STARTED source has no snapshot to pin → 409. The clone is born NOT_STARTED so the user can edit it (PATCH) before pressing Start.
+     * Clone Workflow Run Handler
      */
-    approveWorkflowRunFile(requestParameters, initOverrides) {
+    cloneWorkflowRun(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.approveWorkflowRunFileRaw(requestParameters, initOverrides);
+            const response = yield this.cloneWorkflowRunRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -194,18 +195,15 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates request options for rejectWorkflowRunFile without sending the request
+     * Creates request options for setWorkflowRunApproval without sending the request
      */
-    rejectWorkflowRunFileRequestOpts(requestParameters) {
+    setWorkflowRunApprovalRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['runId'] == null) {
-                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling rejectWorkflowRunFile().');
-            }
-            if (requestParameters['pathPartId'] == null) {
-                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling rejectWorkflowRunFile().');
+                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling setWorkflowRunApproval().');
             }
-            if (requestParameters['rejectFileRequest'] == null) {
-                throw new runtime.RequiredError('rejectFileRequest', 'Required parameter "rejectFileRequest" was null or undefined when calling rejectWorkflowRunFile().');
+            if (requestParameters['setWorkflowRunApprovalRequest'] == null) {
+                throw new runtime.RequiredError('setWorkflowRunApprovalRequest', 'Required parameter "setWorkflowRunApprovalRequest" was null or undefined when calling setWorkflowRunApproval().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -213,58 +211,53 @@ class WorkflowRunsApi extends runtime.BaseAPI {
             if (requestParameters['authorization'] != null) {
                 headerParameters['authorization'] = String(requestParameters['authorization']);
             }
-            let urlPath = `/v1/workflow-runs/{run_id}/files/{path_part_id}/reject`;
+            let urlPath = `/v1/workflow-runs/{run_id}/approval`;
             urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
-            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
             return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.RejectFileRequestToJSON)(requestParameters['rejectFileRequest']),
+                body: (0, index_1.SetWorkflowRunApprovalRequestToJSON)(requestParameters['setWorkflowRunApprovalRequest']),
             };
         });
     }
     /**
-     * Reject a generated file or the run folder itself with a reason.  Open to any user with ``can_write`` on the run path — both individual child files and the run folder (the final verdict that flips the run to REJECTED).
-     * Reject Workflow Run File Handler
+     * Approve an entire completed run in one call.  Approves every output document under ``outputs/`` then the run folder. The run must be ``COMPLETED`` and its definition must have required approval. Requires write access to the run folder. ``run_id`` is the WorkflowRun id.
+     * Set Workflow Run Approval Handler
      */
-    rejectWorkflowRunFileRaw(requestParameters, initOverrides) {
+    setWorkflowRunApprovalRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.rejectWorkflowRunFileRequestOpts(requestParameters);
+            const requestOptions = yield this.setWorkflowRunApprovalRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PathPartApprovalResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowRunResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Reject a generated file or the run folder itself with a reason.  Open to any user with ``can_write`` on the run path — both individual child files and the run folder (the final verdict that flips the run to REJECTED).
-     * Reject Workflow Run File Handler
+     * Approve an entire completed run in one call.  Approves every output document under ``outputs/`` then the run folder. The run must be ``COMPLETED`` and its definition must have required approval. Requires write access to the run folder. ``run_id`` is the WorkflowRun id.
+     * Set Workflow Run Approval Handler
      */
-    rejectWorkflowRunFile(requestParameters, initOverrides) {
+    setWorkflowRunApproval(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.rejectWorkflowRunFileRaw(requestParameters, initOverrides);
+            const response = yield this.setWorkflowRunApprovalRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * Creates request options for unapproveWorkflowRunFile without sending the request
+     * Creates request options for startWorkflowRun without sending the request
      */
-    unapproveWorkflowRunFileRequestOpts(requestParameters) {
+    startWorkflowRunRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['runId'] == null) {
-                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling unapproveWorkflowRunFile().');
-            }
-            if (requestParameters['pathPartId'] == null) {
-                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling unapproveWorkflowRunFile().');
+                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling startWorkflowRun().');
             }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['authorization'] != null) {
                 headerParameters['authorization'] = String(requestParameters['authorization']);
             }
-            let urlPath = `/v1/workflow-runs/{run_id}/files/{path_part_id}/unapprove`;
+            let urlPath = `/v1/workflow-runs/{run_id}/start`;
             urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
-            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
             return {
                 path: urlPath,
                 method: 'POST',
@@ -274,23 +267,72 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Revert an approved or rejected file to ``pending``.  Open to any user with ``can_write`` on the run path. Cannot unapprove a leaf whose ancestor is currently ``approved`` — unapprove the ancestor first.
-     * Unapprove Workflow Run File Handler
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Start Workflow Run Handler
      */
-    unapproveWorkflowRunFileRaw(requestParameters, initOverrides) {
+    startWorkflowRunRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.unapproveWorkflowRunFileRequestOpts(requestParameters);
+            const requestOptions = yield this.startWorkflowRunRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PathPartApprovalResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowRunResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Revert an approved or rejected file to ``pending``.  Open to any user with ``can_write`` on the run path. Cannot unapprove a leaf whose ancestor is currently ``approved`` — unapprove the ancestor first.
-     * Unapprove Workflow Run File Handler
+     * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run.  Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
+     * Start Workflow Run Handler
      */
-    unapproveWorkflowRunFile(requestParameters, initOverrides) {
+    startWorkflowRun(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.unapproveWorkflowRunFileRaw(requestParameters, initOverrides);
+            const response = yield this.startWorkflowRunRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateWorkflowRun without sending the request
+     */
+    updateWorkflowRunRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['runId'] == null) {
+                throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling updateWorkflowRun().');
+            }
+            if (requestParameters['updateWorkflowRunRequest'] == null) {
+                throw new runtime.RequiredError('updateWorkflowRunRequest', 'Required parameter "updateWorkflowRunRequest" was null or undefined when calling updateWorkflowRun().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/workflow-runs/{run_id}`;
+            urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateWorkflowRunRequestToJSON)(requestParameters['updateWorkflowRunRequest']),
+            };
+        });
+    }
+    /**
+     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Update Workflow Run Handler
+     */
+    updateWorkflowRunRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateWorkflowRunRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowRunResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Edit a NOT_STARTED run\'s KB scope and / or display name.  Both body fields are optional but at least one must be present. The run must be ``NOT_STARTED`` (409 otherwise). Caller must be the triggerer or OWNER/ADMIN (403 otherwise). A name collision with a sibling run under the same definition\'s ``runs/`` folder maps to a 409 via ``IntegrityError`` translation.
+     * Update Workflow Run Handler
+     */
+    updateWorkflowRun(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateWorkflowRunRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -308,6 +350,9 @@ class WorkflowRunsApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
             let urlPath = `/v1/workflow-runs/{run_id}/callback`;
             urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
             return {
@@ -320,6 +365,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
      * Workflow Run Callback Handler
      */
     workflowRunCallbackRaw(requestParameters, initOverrides) {
@@ -330,6 +376,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
      * Workflow Run Callback Handler
      */
     workflowRunCallback(requestParameters, initOverrides) {

package/dist/apis/index.d.ts

@@ -11,6 +11,7 @@ export * from './FeaturesApi';
 export * from './FeedbackApi';
 export * from './FoldersApi';
 export * from './InvitesApi';
+export * from './PathPartApprovalsApi';
 export * from './PathPartsApi';
 export * from './PublicApi';
 export * from './SectionsApi';

package/dist/apis/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./FeaturesApi"), exports);
 __exportStar(require("./FeedbackApi"), exports);
 __exportStar(require("./FoldersApi"), exports);
 __exportStar(require("./InvitesApi"), exports);
+__exportStar(require("./PathPartApprovalsApi"), exports);
 __exportStar(require("./PathPartsApi"), exports);
 __exportStar(require("./PublicApi"), exports);
 __exportStar(require("./SectionsApi"), exports);

package/dist/esm/apis/DocumentCheckoutApi.d.ts

@@ -12,17 +12,18 @@
 import * as runtime from '../runtime';
 import type { DocumentCheckoutResponse } from '../models/index';
 export interface AcquireDocumentCheckoutRequest {
-    pathPartId: string;
+    documentId: string;
+    force?: boolean;
     authorization?: string | null;
     ksUat?: string | null;
 }
 export interface GetDocumentCheckoutRequest {
-    pathPartId: string;
+    documentId: string;
     authorization?: string | null;
     ksUat?: string | null;
 }
 export interface ReleaseDocumentCheckoutRequest {
-    pathPartId: string;
+    documentId: string;
     authorization?: string | null;
     ksUat?: string | null;
 }
@@ -35,7 +36,8 @@ export interface ReleaseDocumentCheckoutRequest {
 export interface DocumentCheckoutApiInterface {
     /**
      * Creates request options for acquireDocumentCheckout without sending the request
-     * @param {string} pathPartId Document\'s PathPart ID
+     * @param {string} documentId Document ID
+     * @param {boolean} [force] OWNER/ADMIN only — atomically take the checkout regardless of the current holder. Sealed docs are still refused.
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @throws {RequiredError}
@@ -43,9 +45,10 @@ export interface DocumentCheckoutApiInterface {
      */
     acquireDocumentCheckoutRequestOpts(requestParameters: AcquireDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
     /**
-     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
      * @summary Acquire Document Checkout Handler
-     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} documentId Document ID
+     * @param {boolean} [force] OWNER/ADMIN only — atomically take the checkout regardless of the current holder. Sealed docs are still refused.
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
@@ -54,13 +57,13 @@ export interface DocumentCheckoutApiInterface {
      */
     acquireDocumentCheckoutRaw(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
     /**
-     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
      * Acquire Document Checkout Handler
      */
     acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
     /**
      * Creates request options for getDocumentCheckout without sending the request
-     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} documentId Document ID
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @throws {RequiredError}
@@ -70,7 +73,7 @@ export interface DocumentCheckoutApiInterface {
     /**
      * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
      * @summary Get Document Checkout Handler
-     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} documentId Document ID
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
@@ -85,7 +88,7 @@ export interface DocumentCheckoutApiInterface {
     getDocumentCheckout(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
     /**
      * Creates request options for releaseDocumentCheckout without sending the request
-     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} documentId Document ID
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @throws {RequiredError}
@@ -95,7 +98,7 @@ export interface DocumentCheckoutApiInterface {
     /**
      * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
      * @summary Release Document Checkout Handler
-     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} documentId Document ID
      * @param {string} [authorization]
      * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
@@ -118,12 +121,12 @@ export declare class DocumentCheckoutApi extends runtime.BaseAPI implements Docu
      */
     acquireDocumentCheckoutRequestOpts(requestParameters: AcquireDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
     /**
-     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
      * Acquire Document Checkout Handler
      */
     acquireDocumentCheckoutRaw(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
     /**
-     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
      * Acquire Document Checkout Handler
      */
     acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;

package/dist/esm/apis/DocumentCheckoutApi.js

@@ -31,16 +31,19 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
      */
     acquireDocumentCheckoutRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['pathPartId'] == null) {
-                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling acquireDocumentCheckout().');
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling acquireDocumentCheckout().');
             }
             const queryParameters = {};
+            if (requestParameters['force'] != null) {
+                queryParameters['force'] = requestParameters['force'];
+            }
             const headerParameters = {};
             if (requestParameters['authorization'] != null) {
                 headerParameters['authorization'] = String(requestParameters['authorization']);
             }
-            let urlPath = `/v1/documents/{path_part_id}/checkout`;
-            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            let urlPath = `/v1/documents/{document_id}/checkout`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
             return {
                 path: urlPath,
                 method: 'POST',
@@ -50,7 +53,7 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
      * Acquire Document Checkout Handler
      */
     acquireDocumentCheckoutRaw(requestParameters, initOverrides) {
@@ -61,7 +64,7 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+     * Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
      * Acquire Document Checkout Handler
      */
     acquireDocumentCheckout(requestParameters, initOverrides) {
@@ -75,16 +78,16 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
      */
     getDocumentCheckoutRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['pathPartId'] == null) {
-                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling getDocumentCheckout().');
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling getDocumentCheckout().');
             }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['authorization'] != null) {
                 headerParameters['authorization'] = String(requestParameters['authorization']);
             }
-            let urlPath = `/v1/documents/{path_part_id}/checkout`;
-            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            let urlPath = `/v1/documents/{document_id}/checkout`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
             return {
                 path: urlPath,
                 method: 'GET',
@@ -119,16 +122,16 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
      */
     releaseDocumentCheckoutRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['pathPartId'] == null) {
-                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling releaseDocumentCheckout().');
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling releaseDocumentCheckout().');
             }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['authorization'] != null) {
                 headerParameters['authorization'] = String(requestParameters['authorization']);
             }
-            let urlPath = `/v1/documents/{path_part_id}/checkout`;
-            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            let urlPath = `/v1/documents/{document_id}/checkout`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
             return {
                 path: urlPath,
                 method: 'DELETE',

package/dist/esm/apis/DocumentVersionsApi.d.ts

@@ -180,7 +180,7 @@ export interface DocumentVersionsApiInterface {
      */
     getDocumentVersionRequestOpts(requestParameters: GetDocumentVersionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Get a document version by its ID.
+     *
      * @summary Get Document Version Handler
      * @param {string} versionId DocumentVersion ID
      * @param {boolean} [includePageScreenshots] When true, populate page_screenshot_urls with presigned URLs for every per-page WEBP screenshot the ingestion pipeline produced. Off by default to keep typical responses small.
@@ -192,7 +192,6 @@ export interface DocumentVersionsApiInterface {
      */
     getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
     /**
-     * Get a document version by its ID.
      * Get Document Version Handler
      */
     getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
@@ -351,12 +350,10 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
      */
     getDocumentVersionRequestOpts(requestParameters: GetDocumentVersionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Get a document version by its ID.
      * Get Document Version Handler
      */
     getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
     /**
-     * Get a document version by its ID.
      * Get Document Version Handler
      */
     getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;

package/dist/esm/apis/DocumentVersionsApi.js

@@ -234,7 +234,6 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a document version by its ID.
      * Get Document Version Handler
      */
     getDocumentVersionRaw(requestParameters, initOverrides) {
@@ -245,7 +244,6 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a document version by its ID.
      * Get Document Version Handler
      */
     getDocumentVersion(requestParameters, initOverrides) {

package/dist/esm/apis/DocumentsApi.d.ts

@@ -131,7 +131,7 @@ export interface DocumentsApiInterface {
      */
     getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
     /**
-     * Get a document by its document ID.
+     *
      * @summary Get Document Handler
      * @param {string} documentId
      * @param {boolean} [withTags] Include tags in the response (default: false)
@@ -143,7 +143,6 @@ export interface DocumentsApiInterface {
      */
     getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
     /**
-     * Get a document by its document ID.
      * Get Document Handler
      */
     getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
@@ -317,12 +316,10 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      */
     getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
     /**
-     * Get a document by its document ID.
      * Get Document Handler
      */
     getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
     /**
-     * Get a document by its document ID.
      * Get Document Handler
      */
     getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;

package/dist/esm/apis/DocumentsApi.js

@@ -141,7 +141,6 @@ export class DocumentsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a document by its document ID.
      * Get Document Handler
      */
     getDocumentRaw(requestParameters, initOverrides) {
@@ -152,7 +151,6 @@ export class DocumentsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a document by its document ID.
      * Get Document Handler
      */
     getDocument(requestParameters, initOverrides) {