@knowledge-stack/ksapi 1.84.0 → 1.86.0

package/dist/esm/models/DocumentCheckoutResponse.js

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+export const DocumentCheckoutResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DocumentCheckoutResponse interface.
+ */
+export function instanceOfDocumentCheckoutResponse(value) {
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('acquiredAt' in value) || value['acquiredAt'] === undefined)
+        return false;
+    return true;
+}
+export function DocumentCheckoutResponseFromJSON(json) {
+    return DocumentCheckoutResponseFromJSONTyped(json, false);
+}
+export function DocumentCheckoutResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tenantId': json['tenant_id'],
+        'pathPartId': json['path_part_id'],
+        'userId': json['user_id'],
+        'acquiredAt': (new Date(json['acquired_at'])),
+    };
+}
+export function DocumentCheckoutResponseToJSON(json) {
+    return DocumentCheckoutResponseToJSONTyped(json, false);
+}
+export function DocumentCheckoutResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tenant_id': value['tenantId'],
+        'path_part_id': value['pathPartId'],
+        'user_id': value['userId'],
+        'acquired_at': value['acquiredAt'].toISOString(),
+    };
+}

package/dist/esm/models/DocumentResponse.d.ts

@@ -12,6 +12,7 @@
 import type { DocumentOrigin } from './DocumentOrigin';
 import type { TagResponse } from './TagResponse';
 import type { DocumentType } from './DocumentType';
+import type { DocumentCheckoutResponse } from './DocumentCheckoutResponse';
 import type { DocumentVersionResponse } from './DocumentVersionResponse';
 /**
  * Document response model.
@@ -127,6 +128,12 @@ export interface DocumentResponse {
      * @memberof DocumentResponse
      */
     canWrite?: boolean | null;
+    /**
+     * Active write-lock state. Null when no checkout is held. Populated on detail endpoints (GET /v1/documents/{id}). Any tenant member with read access may observe this state.
+     * @type {DocumentCheckoutResponse}
+     * @memberof DocumentResponse
+     */
+    checkout?: DocumentCheckoutResponse | null;
 }
 /**
  * @export

package/dist/esm/models/DocumentResponse.js

@@ -14,6 +14,7 @@
 import { DocumentOriginFromJSON, DocumentOriginToJSON, } from './DocumentOrigin';
 import { TagResponseFromJSON, TagResponseToJSON, } from './TagResponse';
 import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
+import { DocumentCheckoutResponseFromJSON, DocumentCheckoutResponseToJSON, } from './DocumentCheckoutResponse';
 import { DocumentVersionResponseFromJSON, DocumentVersionResponseToJSON, } from './DocumentVersionResponse';
 /**
  * @export
@@ -86,6 +87,7 @@ export function DocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
         'updatedAt': (new Date(json['updated_at'])),
         'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponseFromJSON)),
         'canWrite': json['can_write'] == null ? undefined : json['can_write'],
+        'checkout': json['checkout'] == null ? undefined : DocumentCheckoutResponseFromJSON(json['checkout']),
     };
 }
 export function DocumentResponseToJSON(json) {
@@ -114,5 +116,6 @@ export function DocumentResponseToJSONTyped(value, ignoreDiscriminator = false)
         'updated_at': value['updatedAt'].toISOString(),
         'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponseToJSON)),
         'can_write': value['canWrite'],
+        'checkout': DocumentCheckoutResponseToJSON(value['checkout']),
     };
 }

package/dist/esm/models/index.d.ts

@@ -41,6 +41,7 @@ export * from './CreateThreadRequest';
 export * from './CreateWorkflowDefinitionRequest';
 export * from './DirectorySyncResponse';
 export * from './DissolveSectionResponse';
+export * from './DocumentCheckoutResponse';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
 export * from './DocumentType';
@@ -139,7 +140,6 @@ export * from './RejectFileRequest';
 export * from './ResolvedReferenceInput';
 export * from './ResolvedReferenceOutput';
 export * from './RootResponse';
-export * from './RunLockResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
 export * from './SearchSortOrder';

package/dist/esm/models/index.js

@@ -43,6 +43,7 @@ export * from './CreateThreadRequest';
 export * from './CreateWorkflowDefinitionRequest';
 export * from './DirectorySyncResponse';
 export * from './DissolveSectionResponse';
+export * from './DocumentCheckoutResponse';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
 export * from './DocumentType';
@@ -141,7 +142,6 @@ export * from './RejectFileRequest';
 export * from './ResolvedReferenceInput';
 export * from './ResolvedReferenceOutput';
 export * from './RootResponse';
-export * from './RunLockResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
 export * from './SearchSortOrder';

package/dist/models/DocumentCheckoutResponse.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ * Active checkout state on a document.
+ * @export
+ * @interface DocumentCheckoutResponse
+ */
+export interface DocumentCheckoutResponse {
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof DocumentCheckoutResponse
+     */
+    tenantId: string;
+    /**
+     * Document's PathPart ID
+     * @type {string}
+     * @memberof DocumentCheckoutResponse
+     */
+    pathPartId: string;
+    /**
+     * User who holds the checkout
+     * @type {string}
+     * @memberof DocumentCheckoutResponse
+     */
+    userId: string;
+    /**
+     * When the checkout was acquired
+     * @type {Date}
+     * @memberof DocumentCheckoutResponse
+     */
+    acquiredAt: Date;
+}
+export declare const DocumentCheckoutResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the DocumentCheckoutResponse interface.
+ */
+export declare function instanceOfDocumentCheckoutResponse(value: object): value is DocumentCheckoutResponse;
+export declare function DocumentCheckoutResponseFromJSON(json: any): DocumentCheckoutResponse;
+export declare function DocumentCheckoutResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentCheckoutResponse;
+export declare function DocumentCheckoutResponseToJSON(json: any): DocumentCheckoutResponse;
+export declare function DocumentCheckoutResponseToJSONTyped(value?: DocumentCheckoutResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DocumentCheckoutResponse.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentCheckoutResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfDocumentCheckoutResponse = instanceOfDocumentCheckoutResponse;
+exports.DocumentCheckoutResponseFromJSON = DocumentCheckoutResponseFromJSON;
+exports.DocumentCheckoutResponseFromJSONTyped = DocumentCheckoutResponseFromJSONTyped;
+exports.DocumentCheckoutResponseToJSON = DocumentCheckoutResponseToJSON;
+exports.DocumentCheckoutResponseToJSONTyped = DocumentCheckoutResponseToJSONTyped;
+exports.DocumentCheckoutResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DocumentCheckoutResponse interface.
+ */
+function instanceOfDocumentCheckoutResponse(value) {
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('acquiredAt' in value) || value['acquiredAt'] === undefined)
+        return false;
+    return true;
+}
+function DocumentCheckoutResponseFromJSON(json) {
+    return DocumentCheckoutResponseFromJSONTyped(json, false);
+}
+function DocumentCheckoutResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tenantId': json['tenant_id'],
+        'pathPartId': json['path_part_id'],
+        'userId': json['user_id'],
+        'acquiredAt': (new Date(json['acquired_at'])),
+    };
+}
+function DocumentCheckoutResponseToJSON(json) {
+    return DocumentCheckoutResponseToJSONTyped(json, false);
+}
+function DocumentCheckoutResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tenant_id': value['tenantId'],
+        'path_part_id': value['pathPartId'],
+        'user_id': value['userId'],
+        'acquired_at': value['acquiredAt'].toISOString(),
+    };
+}

package/dist/models/DocumentResponse.d.ts

@@ -12,6 +12,7 @@
 import type { DocumentOrigin } from './DocumentOrigin';
 import type { TagResponse } from './TagResponse';
 import type { DocumentType } from './DocumentType';
+import type { DocumentCheckoutResponse } from './DocumentCheckoutResponse';
 import type { DocumentVersionResponse } from './DocumentVersionResponse';
 /**
  * Document response model.
@@ -127,6 +128,12 @@ export interface DocumentResponse {
      * @memberof DocumentResponse
      */
     canWrite?: boolean | null;
+    /**
+     * Active write-lock state. Null when no checkout is held. Populated on detail endpoints (GET /v1/documents/{id}). Any tenant member with read access may observe this state.
+     * @type {DocumentCheckoutResponse}
+     * @memberof DocumentResponse
+     */
+    checkout?: DocumentCheckoutResponse | null;
 }
 /**
  * @export

package/dist/models/DocumentResponse.js

@@ -22,6 +22,7 @@ exports.DocumentResponseToJSONTyped = DocumentResponseToJSONTyped;
 const DocumentOrigin_1 = require("./DocumentOrigin");
 const TagResponse_1 = require("./TagResponse");
 const DocumentType_1 = require("./DocumentType");
+const DocumentCheckoutResponse_1 = require("./DocumentCheckoutResponse");
 const DocumentVersionResponse_1 = require("./DocumentVersionResponse");
 /**
  * @export
@@ -94,6 +95,7 @@ function DocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
         'updatedAt': (new Date(json['updated_at'])),
         'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
         'canWrite': json['can_write'] == null ? undefined : json['can_write'],
+        'checkout': json['checkout'] == null ? undefined : (0, DocumentCheckoutResponse_1.DocumentCheckoutResponseFromJSON)(json['checkout']),
     };
 }
 function DocumentResponseToJSON(json) {
@@ -122,5 +124,6 @@ function DocumentResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'updated_at': value['updatedAt'].toISOString(),
         'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
         'can_write': value['canWrite'],
+        'checkout': (0, DocumentCheckoutResponse_1.DocumentCheckoutResponseToJSON)(value['checkout']),
     };
 }

package/dist/models/index.d.ts

@@ -41,6 +41,7 @@ export * from './CreateThreadRequest';
 export * from './CreateWorkflowDefinitionRequest';
 export * from './DirectorySyncResponse';
 export * from './DissolveSectionResponse';
+export * from './DocumentCheckoutResponse';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
 export * from './DocumentType';
@@ -139,7 +140,6 @@ export * from './RejectFileRequest';
 export * from './ResolvedReferenceInput';
 export * from './ResolvedReferenceOutput';
 export * from './RootResponse';
-export * from './RunLockResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
 export * from './SearchSortOrder';

package/dist/models/index.js

@@ -59,6 +59,7 @@ __exportStar(require("./CreateThreadRequest"), exports);
 __exportStar(require("./CreateWorkflowDefinitionRequest"), exports);
 __exportStar(require("./DirectorySyncResponse"), exports);
 __exportStar(require("./DissolveSectionResponse"), exports);
+__exportStar(require("./DocumentCheckoutResponse"), exports);
 __exportStar(require("./DocumentOrigin"), exports);
 __exportStar(require("./DocumentResponse"), exports);
 __exportStar(require("./DocumentType"), exports);
@@ -157,7 +158,6 @@ __exportStar(require("./RejectFileRequest"), exports);
 __exportStar(require("./ResolvedReferenceInput"), exports);
 __exportStar(require("./ResolvedReferenceOutput"), exports);
 __exportStar(require("./RootResponse"), exports);
-__exportStar(require("./RunLockResponse"), exports);
 __exportStar(require("./SSOInitiateResponse"), exports);
 __exportStar(require("./ScoredChunkResponse"), exports);
 __exportStar(require("./SearchSortOrder"), exports);

package/docs/DocumentCheckoutApi.md

@@ -0,0 +1,233 @@
+# DocumentCheckoutApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**acquireDocumentCheckout**](DocumentCheckoutApi.md#acquiredocumentcheckout) | **POST** /v1/documents/{path_part_id}/checkout | Acquire Document Checkout Handler |
+| [**getDocumentCheckout**](DocumentCheckoutApi.md#getdocumentcheckout) | **GET** /v1/documents/{path_part_id}/checkout | Get Document Checkout Handler |
+| [**releaseDocumentCheckout**](DocumentCheckoutApi.md#releasedocumentcheckout) | **DELETE** /v1/documents/{path_part_id}/checkout | Release Document Checkout Handler |
+
+
+
+## acquireDocumentCheckout
+
+> DocumentCheckoutResponse acquireDocumentCheckout(pathPartId, authorization, ksUat)
+
+Acquire Document Checkout Handler
+
+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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { AcquireDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AcquireDocumentCheckoutRequest;
+
+  try {
+    const data = await api.acquireDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentCheckoutResponse**](DocumentCheckoutResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDocumentCheckout
+
+> DocumentCheckoutResponse getDocumentCheckout(pathPartId, authorization, ksUat)
+
+Get Document Checkout Handler
+
+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).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { GetDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetDocumentCheckoutRequest;
+
+  try {
+    const data = await api.getDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentCheckoutResponse**](DocumentCheckoutResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## releaseDocumentCheckout
+
+> releaseDocumentCheckout(pathPartId, authorization, ksUat)
+
+Release Document Checkout Handler
+
+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).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { ReleaseDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ReleaseDocumentCheckoutRequest;
+
+  try {
+    const data = await api.releaseDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/{RunLockResponse.md → DocumentCheckoutResponse.md}

@@ -1,27 +1,29 @@
 
-# RunLockResponse
+# DocumentCheckoutResponse
 
-Reviewer-lock state on a workflow run.
+Active checkout state on a document.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`runId` | string
-`lockUserId` | string
-`lockAcquiredAt` | Date
+`tenantId` | string
+`pathPartId` | string
+`userId` | string
+`acquiredAt` | Date
 
 ## Example
 
 ```typescript
-import type { RunLockResponse } from '@knowledge-stack/ksapi'
+import type { DocumentCheckoutResponse } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "runId": null,
-  "lockUserId": null,
-  "lockAcquiredAt": null,
-} satisfies RunLockResponse
+  "tenantId": null,
+  "pathPartId": null,
+  "userId": null,
+  "acquiredAt": null,
+} satisfies DocumentCheckoutResponse
 
 console.log(example)
 
@@ -30,7 +32,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RunLockResponse
+const exampleParsed = JSON.parse(exampleJSON) as DocumentCheckoutResponse
 console.log(exampleParsed)
 ```
 

package/docs/DocumentResponse.md

@@ -25,6 +25,7 @@ Name | Type
 `updatedAt` | Date
 `tags` | [Array<TagResponse>](TagResponse.md)
 `canWrite` | boolean
+`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
 
 ## Example
 
@@ -51,6 +52,7 @@ const example = {
   "updatedAt": null,
   "tags": null,
   "canWrite": null,
+  "checkout": null,
 } satisfies DocumentResponse
 
 console.log(example)

package/docs/FolderResponseOrDocumentResponse.md

@@ -24,6 +24,7 @@ Name | Type
 `activeVersionId` | string
 `activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
 `ownerTenantUserId` | string
+`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
 
 ## Example
 
@@ -50,6 +51,7 @@ const example = {
   "activeVersionId": null,
   "activeVersion": null,
   "ownerTenantUserId": null,
+  "checkout": null,
 } satisfies FolderResponseOrDocumentResponse
 
 console.log(example)