@knowledge-stack/ksapi 1.15.0 → 1.17.0

package/src/models/DocumentVersionResponse.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { DocumentVersionMetadata } from './DocumentVersionMetadata';
+import {
+    DocumentVersionMetadataFromJSON,
+    DocumentVersionMetadataFromJSONTyped,
+    DocumentVersionMetadataToJSON,
+    DocumentVersionMetadataToJSONTyped,
+} from './DocumentVersionMetadata';
+
 /**
  * DocumentVersion response model.
  * 
@@ -76,6 +84,18 @@ export interface DocumentVersionResponse {
      * @memberof DocumentVersionResponse
      */
     updatedAt: Date;
+    /**
+     * Presigned URL to download the source document (6-hour validity)
+     * @type {string}
+     * @memberof DocumentVersionResponse
+     */
+    assetS3Url?: string;
+    /**
+     * Version metadata (S3 artifacts, pipeline state, statistics)
+     * @type {DocumentVersionMetadata}
+     * @memberof DocumentVersionResponse
+     */
+    metadata?: DocumentVersionMetadata;
 }
 
 /**
@@ -113,6 +133,8 @@ export function DocumentVersionResponseFromJSONTyped(json: any, ignoreDiscrimina
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
+        'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
+        'metadata': json['metadata'] == null ? undefined : DocumentVersionMetadataFromJSON(json['metadata']),
     };
 }
 
@@ -136,6 +158,8 @@ export function DocumentVersionResponseToJSONTyped(value?: DocumentVersionRespon
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
+        'asset_s3_url': value['assetS3Url'],
+        'metadata': DocumentVersionMetadataToJSON(value['metadata']),
     };
 }
 

package/src/models/FolderResponse.ts

@@ -38,11 +38,11 @@ export interface FolderResponse {
      */
     name: string;
     /**
-     * Parent PathPart ID
+     * Parent folder ID
      * @type {string}
      * @memberof FolderResponse
      */
-    parentId: string;
+    parentFolderId: string;
     /**
      * Full materialized path from root
      * @type {string}
@@ -76,7 +76,7 @@ export function instanceOfFolderResponse(value: object): value is FolderResponse
     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 (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('parentFolderId' in value) || value['parentFolderId'] === undefined) return false;
     if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
@@ -97,7 +97,7 @@ export function FolderResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'id': json['id'],
         'pathPartId': json['path_part_id'],
         'name': json['name'],
-        'parentId': json['parent_id'],
+        'parentFolderId': json['parent_folder_id'],
         'materializedPath': json['materialized_path'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
@@ -119,7 +119,7 @@ export function FolderResponseToJSONTyped(value?: FolderResponse | null, ignoreD
         'id': value['id'],
         'path_part_id': value['pathPartId'],
         'name': value['name'],
-        'parent_id': value['parentId'],
+        'parent_folder_id': value['parentFolderId'],
         'materialized_path': value['materializedPath'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),

package/src/models/IngestDocumentResponse.ts

@@ -0,0 +1,101 @@
+/* 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';
+/**
+ * Response with workflow execution details.
+ * @export
+ * @interface IngestDocumentResponse
+ */
+export interface IngestDocumentResponse {
+    /**
+     * Temporal workflow ID
+     * @type {string}
+     * @memberof IngestDocumentResponse
+     */
+    workflowId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IngestDocumentResponse
+     */
+    documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IngestDocumentResponse
+     */
+    documentVersionId: string;
+}
+
+/**
+ * Check if a given object implements the IngestDocumentResponse interface.
+ */
+export function instanceOfIngestDocumentResponse(value: object): value is IngestDocumentResponse {
+    if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('documentVersionId' in value) || value['documentVersionId'] === undefined) return false;
+    return true;
+}
+
+export function IngestDocumentResponseFromJSON(json: any): IngestDocumentResponse {
+    return IngestDocumentResponseFromJSONTyped(json, false);
+}
+
+export function IngestDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestDocumentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'workflowId': json['workflow_id'],
+        'documentId': json['document_id'],
+        'documentVersionId': json['document_version_id'],
+    };
+}
+
+export function IngestDocumentResponseToJSON(json: any): IngestDocumentResponse {
+    return IngestDocumentResponseToJSONTyped(json, false);
+}
+
+export function IngestDocumentResponseToJSONTyped(value?: IngestDocumentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'workflow_id': value['workflowId'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+    };
+}
+
+export const IngestDocumentResponsePropertyValidationAttributesMap: {
+    [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/PaginatedResponseWorkflowSummaryResponse.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 { WorkflowSummaryResponse } from './WorkflowSummaryResponse';
+import {
+    WorkflowSummaryResponseFromJSON,
+    WorkflowSummaryResponseFromJSONTyped,
+    WorkflowSummaryResponseToJSON,
+    WorkflowSummaryResponseToJSONTyped,
+} from './WorkflowSummaryResponse';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseWorkflowSummaryResponse
+ */
+export interface PaginatedResponseWorkflowSummaryResponse {
+    /**
+     * List of items
+     * @type {Array<WorkflowSummaryResponse>}
+     * @memberof PaginatedResponseWorkflowSummaryResponse
+     */
+    items: Array<WorkflowSummaryResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseWorkflowSummaryResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseWorkflowSummaryResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseWorkflowSummaryResponse
+     */
+    offset: number;
+}
+
+/**
+ * Check if a given object implements the PaginatedResponseWorkflowSummaryResponse interface.
+ */
+export function instanceOfPaginatedResponseWorkflowSummaryResponse(value: object): value is PaginatedResponseWorkflowSummaryResponse {
+    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 PaginatedResponseWorkflowSummaryResponseFromJSON(json: any): PaginatedResponseWorkflowSummaryResponse {
+    return PaginatedResponseWorkflowSummaryResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseWorkflowSummaryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseWorkflowSummaryResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(WorkflowSummaryResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseWorkflowSummaryResponseToJSON(json: any): PaginatedResponseWorkflowSummaryResponse {
+    return PaginatedResponseWorkflowSummaryResponseToJSONTyped(json, false);
+}
+
+export function PaginatedResponseWorkflowSummaryResponseToJSONTyped(value?: PaginatedResponseWorkflowSummaryResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(WorkflowSummaryResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+
+export const PaginatedResponseWorkflowSummaryResponsePropertyValidationAttributesMap: {
+    [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/PipelineState.ts

@@ -0,0 +1,134 @@
+/* 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 { PipelineStatus } from './PipelineStatus';
+import {
+    PipelineStatusFromJSON,
+    PipelineStatusFromJSONTyped,
+    PipelineStatusToJSON,
+    PipelineStatusToJSONTyped,
+} from './PipelineStatus';
+
+/**
+ * Pipeline execution state tracking.
+ * @export
+ * @interface PipelineState
+ */
+export interface PipelineState {
+    /**
+     * Current status of the ingestion pipeline
+     * @type {PipelineStatus}
+     * @memberof PipelineState
+     */
+    status: PipelineStatus;
+    /**
+     * Timestamp of the last pipeline execution attempt
+     * @type {Date}
+     * @memberof PipelineState
+     */
+    lastRunTimestamp: Date;
+    /**
+     * Name of the last activity that executed (e.g., 'docling_conversion')
+     * @type {string}
+     * @memberof PipelineState
+     */
+    lastActivity?: string;
+    /**
+     * Error message if pipeline failed
+     * @type {string}
+     * @memberof PipelineState
+     */
+    error?: string;
+    /**
+     * Temporal workflow ID for tracking the ingestion run
+     * @type {string}
+     * @memberof PipelineState
+     */
+    temporalWorkflowId?: string;
+    /**
+     * Number of chunks processed (for progress tracking)
+     * @type {number}
+     * @memberof PipelineState
+     */
+    chunksProcessed?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the PipelineState interface.
+ */
+export function instanceOfPipelineState(value: object): value is PipelineState {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined) return false;
+    return true;
+}
+
+export function PipelineStateFromJSON(json: any): PipelineState {
+    return PipelineStateFromJSONTyped(json, false);
+}
+
+export function PipelineStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineState {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': PipelineStatusFromJSON(json['status']),
+        'lastRunTimestamp': (new Date(json['last_run_timestamp'])),
+        'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'temporalWorkflowId': json['temporal_workflow_id'] == null ? undefined : json['temporal_workflow_id'],
+        'chunksProcessed': json['chunks_processed'] == null ? undefined : json['chunks_processed'],
+    };
+}
+
+export function PipelineStateToJSON(json: any): PipelineState {
+    return PipelineStateToJSONTyped(json, false);
+}
+
+export function PipelineStateToJSONTyped(value?: PipelineState | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': PipelineStatusToJSON(value['status']),
+        'last_run_timestamp': value['lastRunTimestamp'].toISOString(),
+        'last_activity': value['lastActivity'],
+        'error': value['error'],
+        'temporal_workflow_id': value['temporalWorkflowId'],
+        'chunks_processed': value['chunksProcessed'],
+    };
+}
+
+export const PipelineStatePropertyValidationAttributesMap: {
+    [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/PipelineStatus.ts

@@ -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.
+ */
+
+
+/**
+ * Status of the ingestion pipeline workflow.
+ * @export
+ */
+export const PipelineStatus = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed',
+    Cancelled: 'cancelled'
+} as const;
+export type PipelineStatus = typeof PipelineStatus[keyof typeof PipelineStatus];
+
+
+export function instanceOfPipelineStatus(value: any): boolean {
+    for (const key in PipelineStatus) {
+        if (Object.prototype.hasOwnProperty.call(PipelineStatus, key)) {
+            if (PipelineStatus[key as keyof typeof PipelineStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PipelineStatusFromJSON(json: any): PipelineStatus {
+    return PipelineStatusFromJSONTyped(json, false);
+}
+
+export function PipelineStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PipelineStatus {
+    return json as PipelineStatus;
+}
+
+export function PipelineStatusToJSON(value?: PipelineStatus | null): any {
+    return value as any;
+}
+
+export function PipelineStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): PipelineStatus {
+    return value as PipelineStatus;
+}
+

package/src/models/UpdateDocumentRequest.ts

@@ -26,11 +26,11 @@ export interface UpdateDocumentRequest {
      */
     name?: string;
     /**
-     * New parent folder PathPart ID (for move)
+     * New parent folder ID (for move)
      * @type {string}
      * @memberof UpdateDocumentRequest
      */
-    parentId?: string;
+    parentFolderId?: string;
     /**
      * New active version ID
      * @type {string}
@@ -57,7 +57,7 @@ export function UpdateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'name': json['name'] == null ? undefined : json['name'],
-        'parentId': json['parent_id'] == null ? undefined : json['parent_id'],
+        'parentFolderId': json['parent_folder_id'] == null ? undefined : json['parent_folder_id'],
         'activeVersionId': json['active_version_id'] == null ? undefined : json['active_version_id'],
     };
 }
@@ -74,7 +74,7 @@ export function UpdateDocumentRequestToJSONTyped(value?: UpdateDocumentRequest |
     return {
         
         'name': value['name'],
-        'parent_id': value['parentId'],
+        'parent_folder_id': value['parentFolderId'],
         'active_version_id': value['activeVersionId'],
     };
 }

package/src/models/UpdateFolderRequest.ts

@@ -26,11 +26,11 @@ export interface UpdateFolderRequest {
      */
     name?: string;
     /**
-     * New parent folder PathPart ID (for move)
+     * New parent folder ID (for move)
      * @type {string}
      * @memberof UpdateFolderRequest
      */
-    parentId?: string;
+    parentFolderId?: string;
 }
 
 /**
@@ -51,7 +51,7 @@ export function UpdateFolderRequestFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'name': json['name'] == null ? undefined : json['name'],
-        'parentId': json['parent_id'] == null ? undefined : json['parent_id'],
+        'parentFolderId': json['parent_folder_id'] == null ? undefined : json['parent_folder_id'],
     };
 }
 
@@ -67,7 +67,7 @@ export function UpdateFolderRequestToJSONTyped(value?: UpdateFolderRequest | nul
     return {
         
         'name': value['name'],
-        'parent_id': value['parentId'],
+        'parent_folder_id': value['parentFolderId'],
     };
 }
 

package/src/models/WorkflowAction.ts

@@ -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.
+ */
+
+
+/**
+ * Supported workflow actions.
+ * @export
+ */
+export const WorkflowAction = {
+    Rerun: 'rerun',
+    Cancel: 'cancel'
+} as const;
+export type WorkflowAction = typeof WorkflowAction[keyof typeof WorkflowAction];
+
+
+export function instanceOfWorkflowAction(value: any): boolean {
+    for (const key in WorkflowAction) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowAction, key)) {
+            if (WorkflowAction[key as keyof typeof WorkflowAction] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function WorkflowActionFromJSON(json: any): WorkflowAction {
+    return WorkflowActionFromJSONTyped(json, false);
+}
+
+export function WorkflowActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowAction {
+    return json as WorkflowAction;
+}
+
+export function WorkflowActionToJSON(value?: WorkflowAction | null): any {
+    return value as any;
+}
+
+export function WorkflowActionToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowAction {
+    return value as WorkflowAction;
+}
+