@knowledge-stack/ksapi 1.84.0 → 1.86.0

package/dist/apis/WorkflowRunsApi.d.ts

@@ -10,12 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PathPartApprovalResponse, RejectFileRequest, RunLockResponse, WorkflowCallbackResponse, WorkflowRunCallbackRequest, WorkflowRunResponse } from '../models/index';
-export interface AcquireWorkflowRunLockRequest {
-    runId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
+import type { PathPartApprovalResponse, RejectFileRequest, WorkflowCallbackResponse, WorkflowRunCallbackRequest, WorkflowRunResponse } from '../models/index';
 export interface ApproveWorkflowRunFileRequest {
     runId: string;
     pathPartId: string;
@@ -39,11 +34,6 @@ export interface RejectWorkflowRunFileRequest {
     authorization?: string | null;
     ksUat?: string | null;
 }
-export interface ReleaseWorkflowRunLockRequest {
-    runId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
 export interface UnapproveWorkflowRunFileRequest {
     runId: string;
     pathPartId: string;
@@ -61,31 +51,6 @@ export interface WorkflowRunCallbackOperationRequest {
  * @interface WorkflowRunsApiInterface
  */
 export interface WorkflowRunsApiInterface {
-    /**
-     * Creates request options for acquireWorkflowRunLock without sending the request
-     * @param {string} runId
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof WorkflowRunsApiInterface
-     */
-    acquireWorkflowRunLockRequestOpts(requestParameters: AcquireWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Acquire (or renew) the reviewer lock on ``run_id``.  The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
-     * @summary Acquire Workflow Run Lock Handler
-     * @param {string} runId
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof WorkflowRunsApiInterface
-     */
-    acquireWorkflowRunLockRaw(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RunLockResponse>>;
-    /**
-     * Acquire (or renew) the reviewer lock on ``run_id``.  The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
-     * Acquire Workflow Run Lock Handler
-     */
-    acquireWorkflowRunLock(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RunLockResponse>;
     /**
      * Creates request options for approveWorkflowRunFile without sending the request
      * @param {string} runId
@@ -97,7 +62,7 @@ export interface WorkflowRunsApiInterface {
      */
     approveWorkflowRunFileRequestOpts(requestParameters: ApproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Approve a single generated file. Caller must hold the run lock.
+     * 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.
      * @summary Approve Workflow Run File Handler
      * @param {string} runId
      * @param {string} pathPartId
@@ -109,7 +74,7 @@ export interface WorkflowRunsApiInterface {
      */
     approveWorkflowRunFileRaw(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
     /**
-     * Approve a single generated file. Caller must hold the run lock.
+     * 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
      */
     approveWorkflowRunFile(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
@@ -173,7 +138,7 @@ export interface WorkflowRunsApiInterface {
      */
     rejectWorkflowRunFileRequestOpts(requestParameters: RejectWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Reject a single generated file with a reason. Caller must hold the run lock.
+     * 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).
      * @summary Reject Workflow Run File Handler
      * @param {string} runId
      * @param {string} pathPartId
@@ -186,35 +151,10 @@ export interface WorkflowRunsApiInterface {
      */
     rejectWorkflowRunFileRaw(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
     /**
-     * Reject a single generated file with a reason. Caller must hold the run lock.
+     * 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
      */
     rejectWorkflowRunFile(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
-    /**
-     * Creates request options for releaseWorkflowRunLock without sending the request
-     * @param {string} runId
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof WorkflowRunsApiInterface
-     */
-    releaseWorkflowRunLockRequestOpts(requestParameters: ReleaseWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Release the reviewer lock; only the holder may call this.  DELETE /lock is idempotent: returns 204 even if no lock is held.
-     * @summary Release Workflow Run Lock Handler
-     * @param {string} runId
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof WorkflowRunsApiInterface
-     */
-    releaseWorkflowRunLockRaw(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Release the reviewer lock; only the holder may call this.  DELETE /lock is idempotent: returns 204 even if no lock is held.
-     * Release Workflow Run Lock Handler
-     */
-    releaseWorkflowRunLock(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for unapproveWorkflowRunFile without sending the request
      * @param {string} runId
@@ -226,7 +166,7 @@ export interface WorkflowRunsApiInterface {
      */
     unapproveWorkflowRunFileRequestOpts(requestParameters: UnapproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Revert an approved file to ``pending``.  Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
+     * 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.
      * @summary Unapprove Workflow Run File Handler
      * @param {string} runId
      * @param {string} pathPartId
@@ -238,7 +178,7 @@ export interface WorkflowRunsApiInterface {
      */
     unapproveWorkflowRunFileRaw(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
     /**
-     * Revert an approved file to ``pending``.  Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
+     * 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
      */
     unapproveWorkflowRunFile(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
@@ -269,31 +209,17 @@ export interface WorkflowRunsApiInterface {
  *
  */
 export declare class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiInterface {
-    /**
-     * Creates request options for acquireWorkflowRunLock without sending the request
-     */
-    acquireWorkflowRunLockRequestOpts(requestParameters: AcquireWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Acquire (or renew) the reviewer lock on ``run_id``.  The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
-     * Acquire Workflow Run Lock Handler
-     */
-    acquireWorkflowRunLockRaw(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RunLockResponse>>;
-    /**
-     * Acquire (or renew) the reviewer lock on ``run_id``.  The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
-     * Acquire Workflow Run Lock Handler
-     */
-    acquireWorkflowRunLock(requestParameters: AcquireWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RunLockResponse>;
     /**
      * Creates request options for approveWorkflowRunFile without sending the request
      */
     approveWorkflowRunFileRequestOpts(requestParameters: ApproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Approve a single generated file. Caller must hold the run lock.
+     * 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
      */
     approveWorkflowRunFileRaw(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
     /**
-     * Approve a single generated file. Caller must hold the run lock.
+     * 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
      */
     approveWorkflowRunFile(requestParameters: ApproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
@@ -326,40 +252,26 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
      */
     rejectWorkflowRunFileRequestOpts(requestParameters: RejectWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Reject a single generated file with a reason. Caller must hold the run lock.
+     * 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
      */
     rejectWorkflowRunFileRaw(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
     /**
-     * Reject a single generated file with a reason. Caller must hold the run lock.
+     * 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
      */
     rejectWorkflowRunFile(requestParameters: RejectWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;
-    /**
-     * Creates request options for releaseWorkflowRunLock without sending the request
-     */
-    releaseWorkflowRunLockRequestOpts(requestParameters: ReleaseWorkflowRunLockRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Release the reviewer lock; only the holder may call this.  DELETE /lock is idempotent: returns 204 even if no lock is held.
-     * Release Workflow Run Lock Handler
-     */
-    releaseWorkflowRunLockRaw(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Release the reviewer lock; only the holder may call this.  DELETE /lock is idempotent: returns 204 even if no lock is held.
-     * Release Workflow Run Lock Handler
-     */
-    releaseWorkflowRunLock(requestParameters: ReleaseWorkflowRunLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for unapproveWorkflowRunFile without sending the request
      */
     unapproveWorkflowRunFileRequestOpts(requestParameters: UnapproveWorkflowRunFileRequest): Promise<runtime.RequestOpts>;
     /**
-     * Revert an approved file to ``pending``.  Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
+     * 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
      */
     unapproveWorkflowRunFileRaw(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartApprovalResponse>>;
     /**
-     * Revert an approved file to ``pending``.  Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
+     * 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
      */
     unapproveWorkflowRunFile(requestParameters: UnapproveWorkflowRunFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartApprovalResponse>;

package/dist/apis/WorkflowRunsApi.js

@@ -62,50 +62,6 @@ const index_1 = require("../models/index");
  *
  */
 class WorkflowRunsApi extends runtime.BaseAPI {
-    /**
-     * Creates request options for acquireWorkflowRunLock without sending the request
-     */
-    acquireWorkflowRunLockRequestOpts(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 acquireWorkflowRunLock().');
-            }
-            const queryParameters = {};
-            const headerParameters = {};
-            if (requestParameters['authorization'] != null) {
-                headerParameters['authorization'] = String(requestParameters['authorization']);
-            }
-            let urlPath = `/v1/workflow-runs/{run_id}/lock`;
-            urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
-            return {
-                path: urlPath,
-                method: 'POST',
-                headers: headerParameters,
-                query: queryParameters,
-            };
-        });
-    }
-    /**
-     * Acquire (or renew) the reviewer lock on ``run_id``.  The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
-     * Acquire Workflow Run Lock Handler
-     */
-    acquireWorkflowRunLockRaw(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.acquireWorkflowRunLockRequestOpts(requestParameters);
-            const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RunLockResponseFromJSON)(jsonValue));
-        });
-    }
-    /**
-     * Acquire (or renew) the reviewer lock on ``run_id``.  The current holder may re-POST to refresh ``lock_acquired_at``. A different user receives 409 until the lock is released or auto-swept.
-     * Acquire Workflow Run Lock Handler
-     */
-    acquireWorkflowRunLock(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.acquireWorkflowRunLockRaw(requestParameters, initOverrides);
-            return yield response.value();
-        });
-    }
     /**
      * Creates request options for approveWorkflowRunFile without sending the request
      */
@@ -134,7 +90,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Approve a single generated file. Caller must hold the run lock.
+     * 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
      */
     approveWorkflowRunFileRaw(requestParameters, initOverrides) {
@@ -145,7 +101,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Approve a single generated file. Caller must hold the run lock.
+     * 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
      */
     approveWorkflowRunFile(requestParameters, initOverrides) {
@@ -270,7 +226,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Reject a single generated file with a reason. Caller must hold the run lock.
+     * 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
      */
     rejectWorkflowRunFileRaw(requestParameters, initOverrides) {
@@ -281,7 +237,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Reject a single generated file with a reason. Caller must hold the run lock.
+     * 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
      */
     rejectWorkflowRunFile(requestParameters, initOverrides) {
@@ -290,49 +246,6 @@ class WorkflowRunsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
-    /**
-     * Creates request options for releaseWorkflowRunLock without sending the request
-     */
-    releaseWorkflowRunLockRequestOpts(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 releaseWorkflowRunLock().');
-            }
-            const queryParameters = {};
-            const headerParameters = {};
-            if (requestParameters['authorization'] != null) {
-                headerParameters['authorization'] = String(requestParameters['authorization']);
-            }
-            let urlPath = `/v1/workflow-runs/{run_id}/lock`;
-            urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
-            return {
-                path: urlPath,
-                method: 'DELETE',
-                headers: headerParameters,
-                query: queryParameters,
-            };
-        });
-    }
-    /**
-     * Release the reviewer lock; only the holder may call this.  DELETE /lock is idempotent: returns 204 even if no lock is held.
-     * Release Workflow Run Lock Handler
-     */
-    releaseWorkflowRunLockRaw(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.releaseWorkflowRunLockRequestOpts(requestParameters);
-            const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.VoidApiResponse(response);
-        });
-    }
-    /**
-     * Release the reviewer lock; only the holder may call this.  DELETE /lock is idempotent: returns 204 even if no lock is held.
-     * Release Workflow Run Lock Handler
-     */
-    releaseWorkflowRunLock(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.releaseWorkflowRunLockRaw(requestParameters, initOverrides);
-        });
-    }
     /**
      * Creates request options for unapproveWorkflowRunFile without sending the request
      */
@@ -361,7 +274,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Revert an approved file to ``pending``.  Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
+     * 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
      */
     unapproveWorkflowRunFileRaw(requestParameters, initOverrides) {
@@ -372,7 +285,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Revert an approved file to ``pending``.  Does NOT require the reviewer lock — anyone with ``can_write`` on the run path may unapprove (pilot plan §11.7).
+     * 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
      */
     unapproveWorkflowRunFile(requestParameters, initOverrides) {

package/dist/apis/index.d.ts

@@ -4,6 +4,7 @@ export * from './AuthApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DefaultApi';
+export * from './DocumentCheckoutApi';
 export * from './DocumentVersionsApi';
 export * from './DocumentsApi';
 export * from './FeaturesApi';

package/dist/apis/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./AuthApi"), exports);
 __exportStar(require("./ChunkLineagesApi"), exports);
 __exportStar(require("./ChunksApi"), exports);
 __exportStar(require("./DefaultApi"), exports);
+__exportStar(require("./DocumentCheckoutApi"), exports);
 __exportStar(require("./DocumentVersionsApi"), exports);
 __exportStar(require("./DocumentsApi"), exports);
 __exportStar(require("./FeaturesApi"), exports);

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

@@ -0,0 +1,158 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { DocumentCheckoutResponse } from '../models/index';
+export interface AcquireDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ReleaseDocumentCheckoutRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * DocumentCheckoutApi - interface
+ *
+ * @export
+ * @interface DocumentCheckoutApiInterface
+ */
+export interface DocumentCheckoutApiInterface {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     * @param {string} pathPartId Document\'s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof 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.
+     * @summary Acquire Document Checkout Handler
+     * @param {string} pathPartId Document\&#39;s PathPart ID
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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 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} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    getDocumentCheckoutRequestOpts(requestParameters: GetDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    getDocumentCheckoutRaw(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+    /**
+     * 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).
+     * Get Document Checkout Handler
+     */
+    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} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    releaseDocumentCheckoutRequestOpts(requestParameters: ReleaseDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentCheckoutApiInterface
+     */
+    releaseDocumentCheckoutRaw(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckout(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class DocumentCheckoutApi extends runtime.BaseAPI implements DocumentCheckoutApiInterface {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     */
+    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 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 Document Checkout Handler
+     */
+    acquireDocumentCheckout(requestParameters: AcquireDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     */
+    getDocumentCheckoutRequestOpts(requestParameters: GetDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckoutRaw(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentCheckoutResponse>>;
+    /**
+     * 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).
+     * Get Document Checkout Handler
+     */
+    getDocumentCheckout(requestParameters: GetDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentCheckoutResponse>;
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     */
+    releaseDocumentCheckoutRequestOpts(requestParameters: ReleaseDocumentCheckoutRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckoutRaw(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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).
+     * Release Document Checkout Handler
+     */
+    releaseDocumentCheckout(requestParameters: ReleaseDocumentCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}