@knowledge-stack/ksapi 1.84.0 → 1.85.0

package/src/models/DocumentCheckoutResponse.ts

@@ -0,0 +1,110 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 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 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 function instanceOfDocumentCheckoutResponse(value: object): value is DocumentCheckoutResponse {
+    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: any): DocumentCheckoutResponse {
+    return DocumentCheckoutResponseFromJSONTyped(json, false);
+}
+
+export function DocumentCheckoutResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentCheckoutResponse {
+    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: any): DocumentCheckoutResponse {
+    return DocumentCheckoutResponseToJSONTyped(json, false);
+}
+
+export function DocumentCheckoutResponseToJSONTyped(value?: DocumentCheckoutResponse | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/DocumentResponse.ts

@@ -34,6 +34,13 @@ import {
     DocumentTypeToJSON,
     DocumentTypeToJSONTyped,
 } from './DocumentType';
+import type { DocumentCheckoutResponse } from './DocumentCheckoutResponse';
+import {
+    DocumentCheckoutResponseFromJSON,
+    DocumentCheckoutResponseFromJSONTyped,
+    DocumentCheckoutResponseToJSON,
+    DocumentCheckoutResponseToJSONTyped,
+} from './DocumentCheckoutResponse';
 import type { DocumentVersionResponse } from './DocumentVersionResponse';
 import {
     DocumentVersionResponseFromJSON,
@@ -156,6 +163,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;
 }
 
 
@@ -236,6 +249,7 @@ export function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'updatedAt': (new Date(json['updated_at'])),
         'tags': json['tags'] == null ? undefined : ((json['tags'] as Array<any>).map(TagResponseFromJSON)),
         'canWrite': json['can_write'] == null ? undefined : json['can_write'],
+        'checkout': json['checkout'] == null ? undefined : DocumentCheckoutResponseFromJSON(json['checkout']),
     };
 }
 
@@ -268,6 +282,7 @@ export function DocumentResponseToJSONTyped(value?: DocumentResponse | null, ign
         'updated_at': value['updatedAt'].toISOString(),
         'tags': value['tags'] == null ? undefined : ((value['tags'] as Array<any>).map(TagResponseToJSON)),
         'can_write': value['canWrite'],
+        'checkout': DocumentCheckoutResponseToJSON(value['checkout']),
     };
 }
 

package/src/models/index.ts

@@ -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';