@knowledge-stack/ksapi 1.83.0 → 1.85.0

package/dist/models/ChunkResponse.d.ts

@@ -116,17 +116,17 @@ export interface ChunkResponse {
      */
     assetS3Urls?: Array<string>;
     /**
-     *
+     * Ancestor document info (populated when with_document=true)
      * @type {ChunkDocumentResponse}
      * @memberof ChunkResponse
      */
-    document?: ChunkDocumentResponse;
+    document?: ChunkDocumentResponse | null;
     /**
-     *
+     * Ancestor document version info (populated when with_document=true)
      * @type {ChunkDocumentVersionResponse}
      * @memberof ChunkResponse
      */
-    documentVersion?: ChunkDocumentVersionResponse;
+    documentVersion?: ChunkDocumentVersionResponse | null;
 }
 export declare const ChunkResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/CreateThreadMessageRequest.d.ts

@@ -37,11 +37,11 @@ export interface CreateThreadMessageRequest {
      */
     content: ThreadMessageContent;
     /**
-     *
+     * Message details (execution steps). Omit for user messages.
      * @type {ThreadMessageDetailsInput}
      * @memberof CreateThreadMessageRequest
      */
-    details?: ThreadMessageDetailsInput;
+    details?: ThreadMessageDetailsInput | null;
 }
 export declare const CreateThreadMessageRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/CreateWorkflowDefinitionRequest.d.ts

@@ -47,7 +47,7 @@ export interface CreateWorkflowDefinitionRequest {
      * @type {SelfHostedRunnerConfig}
      * @memberof CreateWorkflowDefinitionRequest
      */
-    runnerConfig?: SelfHostedRunnerConfig;
+    runnerConfig?: SelfHostedRunnerConfig | null;
     /**
      *
      * @type {number}

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/DocumentVersionMetadata.d.ts

@@ -51,11 +51,11 @@ export interface DocumentVersionMetadata {
      */
     hash?: string | null;
     /**
-     *
+     * Current state of the ingestion pipeline workflow
      * @type {PipelineState}
      * @memberof DocumentVersionMetadata
      */
-    pipelineState?: PipelineState;
+    pipelineState?: PipelineState | null;
     /**
      * Total number of pages in the document
      * @type {number}
@@ -103,11 +103,11 @@ export interface DocumentVersionMetadata {
         [key: string]: any;
     }> | null;
     /**
-     *
+     * Aggregate statistics for the document version (tokens, chunk counts, depth)
      * @type {InformationStatistics}
      * @memberof DocumentVersionMetadata
      */
-    informationStatistics?: InformationStatistics;
+    informationStatistics?: InformationStatistics | null;
     /**
      * True once the conversion activity successfully consumed PAGE quota
      * @type {boolean}

package/dist/models/DocumentVersionMetadataUpdate.d.ts

@@ -67,7 +67,7 @@ export interface DocumentVersionMetadataUpdate {
      * @type {PipelineState}
      * @memberof DocumentVersionMetadataUpdate
      */
-    pipelineState?: PipelineState;
+    pipelineState?: PipelineState | null;
     /**
      *
      * @type {number}
@@ -119,7 +119,7 @@ export interface DocumentVersionMetadataUpdate {
      * @type {InformationStatistics}
      * @memberof DocumentVersionMetadataUpdate
      */
-    informationStatistics?: InformationStatistics;
+    informationStatistics?: InformationStatistics | null;
     /**
      *
      * @type {boolean}

package/dist/models/EditMemoryChunkRequest.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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
+ * @interface EditMemoryChunkRequest
+ */
+export interface EditMemoryChunkRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof EditMemoryChunkRequest
+     */
+    body: string;
+}
+export declare const EditMemoryChunkRequestPropertyValidationAttributesMap: {
+    [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 EditMemoryChunkRequest interface.
+ */
+export declare function instanceOfEditMemoryChunkRequest(value: object): value is EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestFromJSON(json: any): EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestToJSON(json: any): EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestToJSONTyped(value?: EditMemoryChunkRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/EditMemoryChunkRequest.js

@@ -0,0 +1,57 @@
+"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.EditMemoryChunkRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfEditMemoryChunkRequest = instanceOfEditMemoryChunkRequest;
+exports.EditMemoryChunkRequestFromJSON = EditMemoryChunkRequestFromJSON;
+exports.EditMemoryChunkRequestFromJSONTyped = EditMemoryChunkRequestFromJSONTyped;
+exports.EditMemoryChunkRequestToJSON = EditMemoryChunkRequestToJSON;
+exports.EditMemoryChunkRequestToJSONTyped = EditMemoryChunkRequestToJSONTyped;
+exports.EditMemoryChunkRequestPropertyValidationAttributesMap = {
+    body: {
+        maxLength: 16384,
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the EditMemoryChunkRequest interface.
+ */
+function instanceOfEditMemoryChunkRequest(value) {
+    if (!('body' in value) || value['body'] === undefined)
+        return false;
+    return true;
+}
+function EditMemoryChunkRequestFromJSON(json) {
+    return EditMemoryChunkRequestFromJSONTyped(json, false);
+}
+function EditMemoryChunkRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'body': json['body'],
+    };
+}
+function EditMemoryChunkRequestToJSON(json) {
+    return EditMemoryChunkRequestToJSONTyped(json, false);
+}
+function EditMemoryChunkRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'body': value['body'],
+    };
+}

package/dist/models/EventResponse.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+/**
+ * One event row, anchored to a path_part subject.
+ *
+ * ``kind`` is namespaced ``domain.action`` (e.g. ``workflow.approval``,
+ * ``document.created``). ``payload`` is the domain-specific structured
+ * JSON associated with the event.
+ * @export
+ * @interface EventResponse
+ */
+export interface EventResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    subjectPathPartId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    kind: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof EventResponse
+     */
+    ts: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    actorUserId: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof EventResponse
+     */
+    payload: {
+        [key: string]: any;
+    };
+}
+export declare const EventResponsePropertyValidationAttributesMap: {
+    [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 EventResponse interface.
+ */
+export declare function instanceOfEventResponse(value: object): value is EventResponse;
+export declare function EventResponseFromJSON(json: any): EventResponse;
+export declare function EventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventResponse;
+export declare function EventResponseToJSON(json: any): EventResponse;
+export declare function EventResponseToJSONTyped(value?: EventResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/EventResponse.js

@@ -0,0 +1,72 @@
+"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.EventResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfEventResponse = instanceOfEventResponse;
+exports.EventResponseFromJSON = EventResponseFromJSON;
+exports.EventResponseFromJSONTyped = EventResponseFromJSONTyped;
+exports.EventResponseToJSON = EventResponseToJSON;
+exports.EventResponseToJSONTyped = EventResponseToJSONTyped;
+exports.EventResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the EventResponse interface.
+ */
+function instanceOfEventResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('subjectPathPartId' in value) || value['subjectPathPartId'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('ts' in value) || value['ts'] === undefined)
+        return false;
+    if (!('actorUserId' in value) || value['actorUserId'] === undefined)
+        return false;
+    if (!('payload' in value) || value['payload'] === undefined)
+        return false;
+    return true;
+}
+function EventResponseFromJSON(json) {
+    return EventResponseFromJSONTyped(json, false);
+}
+function EventResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'subjectPathPartId': json['subject_path_part_id'],
+        'kind': json['kind'],
+        'ts': (new Date(json['ts'])),
+        'actorUserId': json['actor_user_id'],
+        'payload': json['payload'],
+    };
+}
+function EventResponseToJSON(json) {
+    return EventResponseToJSONTyped(json, false);
+}
+function EventResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'subject_path_part_id': value['subjectPathPartId'],
+        'kind': value['kind'],
+        'ts': value['ts'].toISOString(),
+        'actor_user_id': value['actorUserId'],
+        'payload': value['payload'],
+    };
+}

package/dist/models/ListMemoryChunksResponse.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 type { MemoryChunkResponse } from './MemoryChunkResponse';
+/**
+ *
+ * @export
+ * @interface ListMemoryChunksResponse
+ */
+export interface ListMemoryChunksResponse {
+    /**
+     *
+     * @type {Array<MemoryChunkResponse>}
+     * @memberof ListMemoryChunksResponse
+     */
+    chunks: Array<MemoryChunkResponse>;
+}
+export declare const ListMemoryChunksResponsePropertyValidationAttributesMap: {
+    [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 ListMemoryChunksResponse interface.
+ */
+export declare function instanceOfListMemoryChunksResponse(value: object): value is ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseFromJSON(json: any): ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseToJSON(json: any): ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseToJSONTyped(value?: ListMemoryChunksResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListMemoryChunksResponse.js

@@ -0,0 +1,53 @@
+"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.ListMemoryChunksResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfListMemoryChunksResponse = instanceOfListMemoryChunksResponse;
+exports.ListMemoryChunksResponseFromJSON = ListMemoryChunksResponseFromJSON;
+exports.ListMemoryChunksResponseFromJSONTyped = ListMemoryChunksResponseFromJSONTyped;
+exports.ListMemoryChunksResponseToJSON = ListMemoryChunksResponseToJSON;
+exports.ListMemoryChunksResponseToJSONTyped = ListMemoryChunksResponseToJSONTyped;
+const MemoryChunkResponse_1 = require("./MemoryChunkResponse");
+exports.ListMemoryChunksResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ListMemoryChunksResponse interface.
+ */
+function instanceOfListMemoryChunksResponse(value) {
+    if (!('chunks' in value) || value['chunks'] === undefined)
+        return false;
+    return true;
+}
+function ListMemoryChunksResponseFromJSON(json) {
+    return ListMemoryChunksResponseFromJSONTyped(json, false);
+}
+function ListMemoryChunksResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chunks': (json['chunks'].map(MemoryChunkResponse_1.MemoryChunkResponseFromJSON)),
+    };
+}
+function ListMemoryChunksResponseToJSON(json) {
+    return ListMemoryChunksResponseToJSONTyped(json, false);
+}
+function ListMemoryChunksResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chunks': (value['chunks'].map(MemoryChunkResponse_1.MemoryChunkResponseToJSON)),
+    };
+}