@knowledge-stack/ksapi 1.66.2 → 1.67.0

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

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * Origin of document - source/purpose (all origins are first-class).
+ * @export
+ */
+export declare const DocumentOrigin: {
+    readonly Source: "SOURCE";
+    readonly Generated: "GENERATED";
+};
+export type DocumentOrigin = typeof DocumentOrigin[keyof typeof DocumentOrigin];
+export declare function instanceOfDocumentOrigin(value: any): boolean;
+export declare function DocumentOriginFromJSON(json: any): DocumentOrigin;
+export declare function DocumentOriginFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentOrigin;
+export declare function DocumentOriginToJSON(value?: DocumentOrigin | null): any;
+export declare function DocumentOriginToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentOrigin;

package/dist/esm/models/DocumentOrigin.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Origin of document - source/purpose (all origins are first-class).
+ * @export
+ */
+export const DocumentOrigin = {
+    Source: 'SOURCE',
+    Generated: 'GENERATED'
+};
+export function instanceOfDocumentOrigin(value) {
+    for (const key in DocumentOrigin) {
+        if (Object.prototype.hasOwnProperty.call(DocumentOrigin, key)) {
+            if (DocumentOrigin[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function DocumentOriginFromJSON(json) {
+    return DocumentOriginFromJSONTyped(json, false);
+}
+export function DocumentOriginFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function DocumentOriginToJSON(value) {
+    return value;
+}
+export function DocumentOriginToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,142 @@
+/**
+ * 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 { DocumentOrigin } from './DocumentOrigin';
+import type { TagResponse } from './TagResponse';
+import type { DocumentType } from './DocumentType';
+import type { DocumentVersionResponse } from './DocumentVersionResponse';
+/**
+ * Document response model.
+ * @export
+ * @interface DocumentResponse
+ */
+export interface DocumentResponse {
+    /**
+     * Path part type
+     * @type {DocumentResponsePartTypeEnum}
+     * @memberof DocumentResponse
+     */
+    partType: DocumentResponsePartTypeEnum;
+    /**
+     * Document ID
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    id: string;
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    pathPartId: string;
+    /**
+     * Document name
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    name: string;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    parentPathPartId: string | null;
+    /**
+     *
+     * @type {DocumentType}
+     * @memberof DocumentResponse
+     */
+    documentType: DocumentType;
+    /**
+     *
+     * @type {DocumentOrigin}
+     * @memberof DocumentResponse
+     */
+    documentOrigin: DocumentOrigin;
+    /**
+     * Active version ID
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    activeVersionId: string;
+    /**
+     *
+     * @type {DocumentVersionResponse}
+     * @memberof DocumentResponse
+     */
+    activeVersion: DocumentVersionResponse;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    materializedPath: string;
+    /**
+     * Whether this document is system-managed
+     * @type {boolean}
+     * @memberof DocumentResponse
+     */
+    systemManaged: boolean;
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof DocumentResponse
+     */
+    tenantId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof DocumentResponse
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof DocumentResponse
+     */
+    updatedAt: Date;
+    /**
+     * Tags attached to this document
+     * @type {Array<TagResponse>}
+     * @memberof DocumentResponse
+     */
+    tags?: Array<TagResponse> | null;
+}
+/**
+ * @export
+ */
+export declare const DocumentResponsePartTypeEnum: {
+    readonly Document: "DOCUMENT";
+};
+export type DocumentResponsePartTypeEnum = typeof DocumentResponsePartTypeEnum[keyof typeof DocumentResponsePartTypeEnum];
+export declare const DocumentResponsePropertyValidationAttributesMap: {
+    [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 DocumentResponse interface.
+ */
+export declare function instanceOfDocumentResponse(value: object): value is DocumentResponse;
+export declare function DocumentResponseFromJSON(json: any): DocumentResponse;
+export declare function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentResponse;
+export declare function DocumentResponseToJSON(json: any): DocumentResponse;
+export declare function DocumentResponseToJSONTyped(value?: DocumentResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DocumentResponse.js

@@ -0,0 +1,108 @@
+/* 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 { DocumentOriginFromJSON, DocumentOriginToJSON, } from './DocumentOrigin';
+import { TagResponseFromJSON, TagResponseToJSON, } from './TagResponse';
+import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
+import { DocumentVersionResponseFromJSON, DocumentVersionResponseToJSON, } from './DocumentVersionResponse';
+/**
+ * @export
+ */
+export const DocumentResponsePartTypeEnum = {
+    Document: 'DOCUMENT'
+};
+export const DocumentResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DocumentResponse interface.
+ */
+export function instanceOfDocumentResponse(value) {
+    if (!('partType' in value) || value['partType'] === undefined)
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined)
+        return false;
+    if (!('documentType' in value) || value['documentType'] === undefined)
+        return false;
+    if (!('documentOrigin' in value) || value['documentOrigin'] === undefined)
+        return false;
+    if (!('activeVersionId' in value) || value['activeVersionId'] === undefined)
+        return false;
+    if (!('activeVersion' in value) || value['activeVersion'] === undefined)
+        return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined)
+        return false;
+    if (!('systemManaged' in value) || value['systemManaged'] === undefined)
+        return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function DocumentResponseFromJSON(json) {
+    return DocumentResponseFromJSONTyped(json, false);
+}
+export function DocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'partType': json['part_type'],
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'documentType': DocumentTypeFromJSON(json['document_type']),
+        'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
+        'activeVersionId': json['active_version_id'],
+        'activeVersion': DocumentVersionResponseFromJSON(json['active_version']),
+        'materializedPath': json['materialized_path'],
+        'systemManaged': json['system_managed'],
+        'tenantId': json['tenant_id'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponseFromJSON)),
+    };
+}
+export function DocumentResponseToJSON(json) {
+    return DocumentResponseToJSONTyped(json, false);
+}
+export function DocumentResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'part_type': value['partType'],
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'document_type': DocumentTypeToJSON(value['documentType']),
+        'document_origin': DocumentOriginToJSON(value['documentOrigin']),
+        'active_version_id': value['activeVersionId'],
+        'active_version': DocumentVersionResponseToJSON(value['activeVersion']),
+        'materialized_path': value['materializedPath'],
+        'system_managed': value['systemManaged'],
+        'tenant_id': value['tenantId'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+        'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponseToJSON)),
+    };
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+/**
+ * Type of document.
+ * @export
+ */
+export declare const DocumentType: {
+    readonly Pdf: "PDF";
+    readonly Docx: "DOCX";
+    readonly Plaintext: "PLAINTEXT";
+    readonly Image: "IMAGE";
+    readonly Xlsx: "XLSX";
+    readonly Csv: "CSV";
+    readonly Pptx: "PPTX";
+    readonly Unknown: "UNKNOWN";
+};
+export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
+export declare function instanceOfDocumentType(value: any): boolean;
+export declare function DocumentTypeFromJSON(json: any): DocumentType;
+export declare function DocumentTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentType;
+export declare function DocumentTypeToJSON(value?: DocumentType | null): any;
+export declare function DocumentTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentType;

package/dist/esm/models/DocumentType.js

@@ -0,0 +1,49 @@
+/* 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.
+ */
+/**
+ * Type of document.
+ * @export
+ */
+export const DocumentType = {
+    Pdf: 'PDF',
+    Docx: 'DOCX',
+    Plaintext: 'PLAINTEXT',
+    Image: 'IMAGE',
+    Xlsx: 'XLSX',
+    Csv: 'CSV',
+    Pptx: 'PPTX',
+    Unknown: 'UNKNOWN'
+};
+export function instanceOfDocumentType(value) {
+    for (const key in DocumentType) {
+        if (Object.prototype.hasOwnProperty.call(DocumentType, key)) {
+            if (DocumentType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function DocumentTypeFromJSON(json) {
+    return DocumentTypeFromJSONTyped(json, false);
+}
+export function DocumentTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function DocumentTypeToJSON(value) {
+    return value;
+}
+export function DocumentTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * Actions that can be performed on a document version.
+ * @export
+ */
+export declare const DocumentVersionAction: {
+    readonly Reembed: "reembed";
+};
+export type DocumentVersionAction = typeof DocumentVersionAction[keyof typeof DocumentVersionAction];
+export declare function instanceOfDocumentVersionAction(value: any): boolean;
+export declare function DocumentVersionActionFromJSON(json: any): DocumentVersionAction;
+export declare function DocumentVersionActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionAction;
+export declare function DocumentVersionActionToJSON(value?: DocumentVersionAction | null): any;
+export declare function DocumentVersionActionToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentVersionAction;

package/dist/esm/models/DocumentVersionAction.js

@@ -0,0 +1,42 @@
+/* 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.
+ */
+/**
+ * Actions that can be performed on a document version.
+ * @export
+ */
+export const DocumentVersionAction = {
+    Reembed: 'reembed'
+};
+export function instanceOfDocumentVersionAction(value) {
+    for (const key in DocumentVersionAction) {
+        if (Object.prototype.hasOwnProperty.call(DocumentVersionAction, key)) {
+            if (DocumentVersionAction[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function DocumentVersionActionFromJSON(json) {
+    return DocumentVersionActionFromJSONTyped(json, false);
+}
+export function DocumentVersionActionFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function DocumentVersionActionToJSON(value) {
+    return value;
+}
+export function DocumentVersionActionToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,60 @@
+/**
+ * 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 { DocumentVersionAction } from './DocumentVersionAction';
+/**
+ * Response from a document version action.
+ * @export
+ * @interface DocumentVersionActionResponse
+ */
+export interface DocumentVersionActionResponse {
+    /**
+     * DocumentVersion ID
+     * @type {string}
+     * @memberof DocumentVersionActionResponse
+     */
+    versionId: string;
+    /**
+     *
+     * @type {DocumentVersionAction}
+     * @memberof DocumentVersionActionResponse
+     */
+    action: DocumentVersionAction;
+    /**
+     * Temporal workflow ID
+     * @type {string}
+     * @memberof DocumentVersionActionResponse
+     */
+    workflowId: string;
+}
+export declare const DocumentVersionActionResponsePropertyValidationAttributesMap: {
+    [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 DocumentVersionActionResponse interface.
+ */
+export declare function instanceOfDocumentVersionActionResponse(value: object): value is DocumentVersionActionResponse;
+export declare function DocumentVersionActionResponseFromJSON(json: any): DocumentVersionActionResponse;
+export declare function DocumentVersionActionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionActionResponse;
+export declare function DocumentVersionActionResponseToJSON(json: any): DocumentVersionActionResponse;
+export declare function DocumentVersionActionResponseToJSONTyped(value?: DocumentVersionActionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DocumentVersionActionResponse.js

@@ -0,0 +1,53 @@
+/* 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 { DocumentVersionActionFromJSON, DocumentVersionActionToJSON, } from './DocumentVersionAction';
+export const DocumentVersionActionResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DocumentVersionActionResponse interface.
+ */
+export function instanceOfDocumentVersionActionResponse(value) {
+    if (!('versionId' in value) || value['versionId'] === undefined)
+        return false;
+    if (!('action' in value) || value['action'] === undefined)
+        return false;
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    return true;
+}
+export function DocumentVersionActionResponseFromJSON(json) {
+    return DocumentVersionActionResponseFromJSONTyped(json, false);
+}
+export function DocumentVersionActionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'versionId': json['version_id'],
+        'action': DocumentVersionActionFromJSON(json['action']),
+        'workflowId': json['workflow_id'],
+    };
+}
+export function DocumentVersionActionResponseToJSON(json) {
+    return DocumentVersionActionResponseToJSONTyped(json, false);
+}
+export function DocumentVersionActionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version_id': value['versionId'],
+        'action': DocumentVersionActionToJSON(value['action']),
+        'workflow_id': value['workflowId'],
+    };
+}

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

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * Filter for the type of content rows to return.
+ * @export
+ */
+export declare const DocumentVersionContentTypeFilter: {
+    readonly Section: "SECTION";
+    readonly Chunk: "CHUNK";
+};
+export type DocumentVersionContentTypeFilter = typeof DocumentVersionContentTypeFilter[keyof typeof DocumentVersionContentTypeFilter];
+export declare function instanceOfDocumentVersionContentTypeFilter(value: any): boolean;
+export declare function DocumentVersionContentTypeFilterFromJSON(json: any): DocumentVersionContentTypeFilter;
+export declare function DocumentVersionContentTypeFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionContentTypeFilter;
+export declare function DocumentVersionContentTypeFilterToJSON(value?: DocumentVersionContentTypeFilter | null): any;
+export declare function DocumentVersionContentTypeFilterToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentVersionContentTypeFilter;

package/dist/esm/models/DocumentVersionContentTypeFilter.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Filter for the type of content rows to return.
+ * @export
+ */
+export const DocumentVersionContentTypeFilter = {
+    Section: 'SECTION',
+    Chunk: 'CHUNK'
+};
+export function instanceOfDocumentVersionContentTypeFilter(value) {
+    for (const key in DocumentVersionContentTypeFilter) {
+        if (Object.prototype.hasOwnProperty.call(DocumentVersionContentTypeFilter, key)) {
+            if (DocumentVersionContentTypeFilter[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function DocumentVersionContentTypeFilterFromJSON(json) {
+    return DocumentVersionContentTypeFilterFromJSONTyped(json, false);
+}
+export function DocumentVersionContentTypeFilterFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function DocumentVersionContentTypeFilterToJSON(value) {
+    return value;
+}
+export function DocumentVersionContentTypeFilterToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}