@knowledge-stack/ksapi 1.8.0 → 1.9.0

package/src/models/DocumentContentPathPart.ts

@@ -0,0 +1,205 @@
+/* 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';
+import type { PartType } from './PartType';
+import {
+    PartTypeFromJSON,
+    PartTypeFromJSONTyped,
+    PartTypeToJSON,
+    PartTypeToJSONTyped,
+} from './PartType';
+import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
+import {
+    ChunkMetadataOutputFromJSON,
+    ChunkMetadataOutputFromJSONTyped,
+    ChunkMetadataOutputToJSON,
+    ChunkMetadataOutputToJSONTyped,
+} from './ChunkMetadataOutput';
+import type { ChunkType } from './ChunkType';
+import {
+    ChunkTypeFromJSON,
+    ChunkTypeFromJSONTyped,
+    ChunkTypeToJSON,
+    ChunkTypeToJSONTyped,
+} from './ChunkType';
+
+/**
+ * Response model for a single item in the document version contents list.
+ * 
+ * Represents a section or chunk with enriched data (content, metadata)
+ * returned in depth-first logical order.
+ * @export
+ * @interface DocumentContentPathPart
+ */
+export interface DocumentContentPathPart {
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    pathPartId: string;
+    /**
+     * PathPart name
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    name: string;
+    /**
+     * SECTION or CHUNK
+     * @type {PartType}
+     * @memberof DocumentContentPathPart
+     */
+    partType: PartType;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    parentId: string;
+    /**
+     * Section ID or Chunk ID
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    metadataObjId: string;
+    /**
+     * Depth relative to document version root
+     * @type {number}
+     * @memberof DocumentContentPathPart
+     */
+    depth: number;
+    /**
+     * Chunk content (None for sections)
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    content?: string;
+    /**
+     * Chunk type (None for sections)
+     * @type {ChunkType}
+     * @memberof DocumentContentPathPart
+     */
+    chunkType?: ChunkType;
+    /**
+     * Chunk metadata (None for sections)
+     * @type {ChunkMetadataOutput}
+     * @memberof DocumentContentPathPart
+     */
+    chunkMetadata?: ChunkMetadataOutput;
+    /**
+     * Section page number (None for chunks)
+     * @type {number}
+     * @memberof DocumentContentPathPart
+     */
+    pageNumber?: number;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof DocumentContentPathPart
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof DocumentContentPathPart
+     */
+    updatedAt: Date;
+}
+
+
+
+/**
+ * Check if a given object implements the DocumentContentPathPart interface.
+ */
+export function instanceOfDocumentContentPathPart(value: object): value is DocumentContentPathPart {
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('partType' in value) || value['partType'] === undefined) return false;
+    if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('metadataObjId' in value) || value['metadataObjId'] === undefined) return false;
+    if (!('depth' in value) || value['depth'] === 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 DocumentContentPathPartFromJSON(json: any): DocumentContentPathPart {
+    return DocumentContentPathPartFromJSONTyped(json, false);
+}
+
+export function DocumentContentPathPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentContentPathPart {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'partType': PartTypeFromJSON(json['part_type']),
+        'parentId': json['parent_id'],
+        'metadataObjId': json['metadata_obj_id'],
+        'depth': json['depth'],
+        'content': json['content'] == null ? undefined : json['content'],
+        'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
+        'chunkMetadata': json['chunk_metadata'] == null ? undefined : ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function DocumentContentPathPartToJSON(json: any): DocumentContentPathPart {
+    return DocumentContentPathPartToJSONTyped(json, false);
+}
+
+export function DocumentContentPathPartToJSONTyped(value?: DocumentContentPathPart | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'part_type': PartTypeToJSON(value['partType']),
+        'parent_id': value['parentId'],
+        'metadata_obj_id': value['metadataObjId'],
+        'depth': value['depth'],
+        'content': value['content'],
+        'chunk_type': ChunkTypeToJSON(value['chunkType']),
+        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'page_number': value['pageNumber'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+
+export const DocumentContentPathPartPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/FolderDocumentResponse.ts

@@ -0,0 +1,234 @@
+/* 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';
+import type { DocumentOrigin } from './DocumentOrigin';
+import {
+    DocumentOriginFromJSON,
+    DocumentOriginFromJSONTyped,
+    DocumentOriginToJSON,
+    DocumentOriginToJSONTyped,
+} from './DocumentOrigin';
+import type { PartType } from './PartType';
+import {
+    PartTypeFromJSON,
+    PartTypeFromJSONTyped,
+    PartTypeToJSON,
+    PartTypeToJSONTyped,
+} from './PartType';
+import type { DocumentType } from './DocumentType';
+import {
+    DocumentTypeFromJSON,
+    DocumentTypeFromJSONTyped,
+    DocumentTypeToJSON,
+    DocumentTypeToJSONTyped,
+} from './DocumentType';
+import type { DocumentVersionResponse } from './DocumentVersionResponse';
+import {
+    DocumentVersionResponseFromJSON,
+    DocumentVersionResponseFromJSONTyped,
+    DocumentVersionResponseToJSON,
+    DocumentVersionResponseToJSONTyped,
+} from './DocumentVersionResponse';
+
+/**
+ * Response for folder contents - can be either a Folder or a Document.
+ * 
+ * Inherits PathPart fields from PathPartResponse and adds type-specific fields.
+ * 
+ * Discriminated union based on part_type:
+ * - FOLDER: folder_id is set, document fields are None
+ * - DOCUMENT: document_id and document fields are set, folder_id is None
+ * 
+ * Inherited fields from PathPartResponse:
+ * - path_part_id, name, part_type, parent_id, metadata_obj_id, created_at, updated_at
+ * @export
+ * @interface FolderDocumentResponse
+ */
+export interface FolderDocumentResponse {
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    pathPartId: string;
+    /**
+     * Item name
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    name: string;
+    /**
+     * Type (FOLDER, DOCUMENT, etc.)
+     * @type {PartType}
+     * @memberof FolderDocumentResponse
+     */
+    partType: PartType;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    parentId: string;
+    /**
+     * ID of the underlying object
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    metadataObjId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof FolderDocumentResponse
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof FolderDocumentResponse
+     */
+    updatedAt: Date;
+    /**
+     * Folder ID (present for folders)
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    folderId?: string;
+    /**
+     * Document ID (present for documents)
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    documentId?: string;
+    /**
+     * Document type (present for documents)
+     * @type {DocumentType}
+     * @memberof FolderDocumentResponse
+     */
+    documentType?: DocumentType;
+    /**
+     * Document origin (present for documents)
+     * @type {DocumentOrigin}
+     * @memberof FolderDocumentResponse
+     */
+    documentOrigin?: DocumentOrigin;
+    /**
+     * Active version ID (present for documents)
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    activeVersionId?: string;
+    /**
+     * Active version details (present for documents)
+     * @type {DocumentVersionResponse}
+     * @memberof FolderDocumentResponse
+     */
+    activeVersion?: DocumentVersionResponse;
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof FolderDocumentResponse
+     */
+    tenantId: string;
+}
+
+
+
+/**
+ * Check if a given object implements the FolderDocumentResponse interface.
+ */
+export function instanceOfFolderDocumentResponse(value: object): value is FolderDocumentResponse {
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('partType' in value) || value['partType'] === undefined) return false;
+    if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('metadataObjId' in value) || value['metadataObjId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    return true;
+}
+
+export function FolderDocumentResponseFromJSON(json: any): FolderDocumentResponse {
+    return FolderDocumentResponseFromJSONTyped(json, false);
+}
+
+export function FolderDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FolderDocumentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'partType': PartTypeFromJSON(json['part_type']),
+        'parentId': json['parent_id'],
+        'metadataObjId': json['metadata_obj_id'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'folderId': json['folder_id'] == null ? undefined : json['folder_id'],
+        'documentId': json['document_id'] == null ? undefined : json['document_id'],
+        'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
+        'documentOrigin': json['document_origin'] == null ? undefined : DocumentOriginFromJSON(json['document_origin']),
+        'activeVersionId': json['active_version_id'] == null ? undefined : json['active_version_id'],
+        'activeVersion': json['active_version'] == null ? undefined : DocumentVersionResponseFromJSON(json['active_version']),
+        'tenantId': json['tenant_id'],
+    };
+}
+
+export function FolderDocumentResponseToJSON(json: any): FolderDocumentResponse {
+    return FolderDocumentResponseToJSONTyped(json, false);
+}
+
+export function FolderDocumentResponseToJSONTyped(value?: FolderDocumentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'part_type': PartTypeToJSON(value['partType']),
+        'parent_id': value['parentId'],
+        'metadata_obj_id': value['metadataObjId'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+        'folder_id': value['folderId'],
+        'document_id': value['documentId'],
+        'document_type': DocumentTypeToJSON(value['documentType']),
+        'document_origin': DocumentOriginToJSON(value['documentOrigin']),
+        'active_version_id': value['activeVersionId'],
+        'active_version': DocumentVersionResponseToJSON(value['activeVersion']),
+        'tenant_id': value['tenantId'],
+    };
+}
+
+export const FolderDocumentResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/PaginatedResponseDocumentContentPathPart.ts

@@ -0,0 +1,130 @@
+/* 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';
+import type { DocumentContentPathPart } from './DocumentContentPathPart';
+import {
+    DocumentContentPathPartFromJSON,
+    DocumentContentPathPartFromJSONTyped,
+    DocumentContentPathPartToJSON,
+    DocumentContentPathPartToJSONTyped,
+} from './DocumentContentPathPart';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseDocumentContentPathPart
+ */
+export interface PaginatedResponseDocumentContentPathPart {
+    /**
+     * List of items
+     * @type {Array<DocumentContentPathPart>}
+     * @memberof PaginatedResponseDocumentContentPathPart
+     */
+    items: Array<DocumentContentPathPart>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseDocumentContentPathPart
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseDocumentContentPathPart
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseDocumentContentPathPart
+     */
+    offset: number;
+}
+
+/**
+ * Check if a given object implements the PaginatedResponseDocumentContentPathPart interface.
+ */
+export function instanceOfPaginatedResponseDocumentContentPathPart(value: object): value is PaginatedResponseDocumentContentPathPart {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedResponseDocumentContentPathPartFromJSON(json: any): PaginatedResponseDocumentContentPathPart {
+    return PaginatedResponseDocumentContentPathPartFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseDocumentContentPathPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseDocumentContentPathPart {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(DocumentContentPathPartFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseDocumentContentPathPartToJSON(json: any): PaginatedResponseDocumentContentPathPart {
+    return PaginatedResponseDocumentContentPathPartToJSONTyped(json, false);
+}
+
+export function PaginatedResponseDocumentContentPathPartToJSONTyped(value?: PaginatedResponseDocumentContentPathPart | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(DocumentContentPathPartToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+
+export const PaginatedResponseDocumentContentPathPartPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+

package/src/models/PaginatedResponseFolderDocumentResponse.ts

@@ -0,0 +1,130 @@
+/* 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';
+import type { FolderDocumentResponse } from './FolderDocumentResponse';
+import {
+    FolderDocumentResponseFromJSON,
+    FolderDocumentResponseFromJSONTyped,
+    FolderDocumentResponseToJSON,
+    FolderDocumentResponseToJSONTyped,
+} from './FolderDocumentResponse';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseFolderDocumentResponse
+ */
+export interface PaginatedResponseFolderDocumentResponse {
+    /**
+     * List of items
+     * @type {Array<FolderDocumentResponse>}
+     * @memberof PaginatedResponseFolderDocumentResponse
+     */
+    items: Array<FolderDocumentResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseFolderDocumentResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseFolderDocumentResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseFolderDocumentResponse
+     */
+    offset: number;
+}
+
+/**
+ * Check if a given object implements the PaginatedResponseFolderDocumentResponse interface.
+ */
+export function instanceOfPaginatedResponseFolderDocumentResponse(value: object): value is PaginatedResponseFolderDocumentResponse {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedResponseFolderDocumentResponseFromJSON(json: any): PaginatedResponseFolderDocumentResponse {
+    return PaginatedResponseFolderDocumentResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseFolderDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseFolderDocumentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(FolderDocumentResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseFolderDocumentResponseToJSON(json: any): PaginatedResponseFolderDocumentResponse {
+    return PaginatedResponseFolderDocumentResponseToJSONTyped(json, false);
+}
+
+export function PaginatedResponseFolderDocumentResponseToJSONTyped(value?: PaginatedResponseFolderDocumentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(FolderDocumentResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+
+export const PaginatedResponseFolderDocumentResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+