@knowledge-stack/ksapi 1.84.0 → 1.85.0

package/dist/esm/apis/DocumentCheckoutApi.js

@@ -0,0 +1,160 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { DocumentCheckoutResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class DocumentCheckoutApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for acquireDocumentCheckout without sending the request
+     */
+    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().');
+            }
+            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'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.acquireDocumentCheckoutRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCheckoutResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.acquireDocumentCheckoutRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getDocumentCheckout without sending the request
+     */
+    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().');
+            }
+            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'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDocumentCheckoutRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentCheckoutResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentCheckoutRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for releaseDocumentCheckout without sending the request
+     */
+    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().');
+            }
+            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'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.releaseDocumentCheckoutRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.releaseDocumentCheckoutRaw(requestParameters, initOverrides);
+        });
+    }
+}

package/dist/esm/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/esm/apis/index.js

@@ -6,6 +6,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/esm/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/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';

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

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

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);