@knowledge-stack/ksapi 1.15.0 → 1.17.0

package/src/apis/WorkflowsApi.ts

@@ -0,0 +1,249 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  HTTPValidationError,
+  PaginatedResponseWorkflowSummaryResponse,
+  WorkflowAction,
+  WorkflowActionResponse,
+  WorkflowDetailResponse,
+} from '../models/index';
+import {
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponseWorkflowSummaryResponseFromJSON,
+    PaginatedResponseWorkflowSummaryResponseToJSON,
+    WorkflowActionFromJSON,
+    WorkflowActionToJSON,
+    WorkflowActionResponseFromJSON,
+    WorkflowActionResponseToJSON,
+    WorkflowDetailResponseFromJSON,
+    WorkflowDetailResponseToJSON,
+} from '../models/index';
+
+export interface GetWorkflowRequest {
+    workflowId: string;
+    ksUat?: string;
+}
+
+export interface ListWorkflowsRequest {
+    limit?: number;
+    offset?: number;
+    ksUat?: string;
+}
+
+export interface WorkflowActionRequest {
+    workflowId: string;
+    action: WorkflowAction;
+    ksUat?: string;
+}
+
+/**
+ * WorkflowsApi - interface
+ * 
+ * @export
+ * @interface WorkflowsApiInterface
+ */
+export interface WorkflowsApiInterface {
+    /**
+     * Get single workflow detail with live Temporal status.
+     * @summary Get Workflow Handler
+     * @param {string} workflowId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
+
+    /**
+     * Get single workflow detail with live Temporal status.
+     * Get Workflow Handler
+     */
+    getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
+
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).
+     * @summary List Workflows Handler
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
+
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).
+     * List Workflows Handler
+     */
+    listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
+
+    /**
+     * Cancel or rerun a workflow (OWNER/ADMIN only).
+     * @summary Workflow Action Handler
+     * @param {string} workflowId 
+     * @param {WorkflowAction} action Action to perform
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
+
+    /**
+     * Cancel or rerun a workflow (OWNER/ADMIN only).
+     * Workflow Action Handler
+     */
+    workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
+
+}
+
+/**
+ * 
+ */
+export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
+
+    /**
+     * Get single workflow detail with live Temporal status.
+     * Get Workflow Handler
+     */
+    async getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>> {
+        if (requestParameters['workflowId'] == null) {
+            throw new runtime.RequiredError(
+                'workflowId',
+                'Required parameter "workflowId" was null or undefined when calling getWorkflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/workflows/{workflow_id}`;
+        urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get single workflow detail with live Temporal status.
+     * Get Workflow Handler
+     */
+    async getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse> {
+        const response = await this.getWorkflowRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).
+     * List Workflows Handler
+     */
+    async listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/workflows`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).
+     * List Workflows Handler
+     */
+    async listWorkflows(requestParameters: ListWorkflowsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse> {
+        const response = await this.listWorkflowsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Cancel or rerun a workflow (OWNER/ADMIN only).
+     * Workflow Action Handler
+     */
+    async workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>> {
+        if (requestParameters['workflowId'] == null) {
+            throw new runtime.RequiredError(
+                'workflowId',
+                'Required parameter "workflowId" was null or undefined when calling workflowAction().'
+            );
+        }
+
+        if (requestParameters['action'] == null) {
+            throw new runtime.RequiredError(
+                'action',
+                'Required parameter "action" was null or undefined when calling workflowAction().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['action'] != null) {
+            queryParameters['action'] = requestParameters['action'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/workflows/{workflow_id}`;
+        urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cancel or rerun a workflow (OWNER/ADMIN only).
+     * Workflow Action Handler
+     */
+    async workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse> {
+        const response = await this.workflowActionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -16,3 +16,4 @@ export * from './ThreadMessagesApi';
 export * from './ThreadsApi';
 export * from './UserPermissionsApi';
 export * from './UsersApi';
+export * from './WorkflowsApi';

package/src/models/CreateDocumentRequest.ts

@@ -41,11 +41,11 @@ export interface CreateDocumentRequest {
      */
     name: string;
     /**
-     * Parent folder PathPart ID
+     * Parent folder ID
      * @type {string}
      * @memberof CreateDocumentRequest
      */
-    parentId: string;
+    parentFolderId: string;
     /**
      * Type of document (PDF, UNKNOWN, etc.)
      * @type {DocumentType}
@@ -67,7 +67,7 @@ export interface CreateDocumentRequest {
  */
 export function instanceOfCreateDocumentRequest(value: object): value is CreateDocumentRequest {
     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 (!('documentType' in value) || value['documentType'] === undefined) return false;
     if (!('documentOrigin' in value) || value['documentOrigin'] === undefined) return false;
     return true;
@@ -84,7 +84,7 @@ export function CreateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'name': json['name'],
-        'parentId': json['parent_id'],
+        'parentFolderId': json['parent_folder_id'],
         'documentType': DocumentTypeFromJSON(json['document_type']),
         'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
     };
@@ -102,7 +102,7 @@ export function CreateDocumentRequestToJSONTyped(value?: CreateDocumentRequest |
     return {
         
         'name': value['name'],
-        'parent_id': value['parentId'],
+        'parent_folder_id': value['parentFolderId'],
         'document_type': DocumentTypeToJSON(value['documentType']),
         'document_origin': DocumentOriginToJSON(value['documentOrigin']),
     };

package/src/models/CreateFolderRequest.ts

@@ -26,11 +26,11 @@ export interface CreateFolderRequest {
      */
     name: string;
     /**
-     * Parent folder PathPart ID
+     * Parent folder ID
      * @type {string}
      * @memberof CreateFolderRequest
      */
-    parentId: string;
+    parentFolderId: string;
 }
 
 /**
@@ -38,7 +38,7 @@ export interface CreateFolderRequest {
  */
 export function instanceOfCreateFolderRequest(value: object): value is CreateFolderRequest {
     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;
     return true;
 }
 
@@ -53,7 +53,7 @@ export function CreateFolderRequestFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'name': json['name'],
-        'parentId': json['parent_id'],
+        'parentFolderId': json['parent_folder_id'],
     };
 }
 
@@ -69,7 +69,7 @@ export function CreateFolderRequestToJSONTyped(value?: CreateFolderRequest | nul
     return {
         
         'name': value['name'],
-        'parent_id': value['parentId'],
+        'parent_folder_id': value['parentFolderId'],
     };
 }
 

package/src/models/DocumentResponse.ts

@@ -60,11 +60,11 @@ export interface DocumentResponse {
      */
     name: string;
     /**
-     * Parent PathPart ID
+     * Parent folder ID
      * @type {string}
      * @memberof DocumentResponse
      */
-    parentId: string;
+    parentFolderId: string;
     /**
      * Type of document
      * @type {DocumentType}
@@ -124,7 +124,7 @@ export function instanceOfDocumentResponse(value: object): value is DocumentResp
     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 (!('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;
@@ -149,7 +149,7 @@ export function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'id': json['id'],
         'pathPartId': json['path_part_id'],
         'name': json['name'],
-        'parentId': json['parent_id'],
+        'parentFolderId': json['parent_folder_id'],
         'documentType': DocumentTypeFromJSON(json['document_type']),
         'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
         'activeVersionId': json['active_version_id'],
@@ -175,7 +175,7 @@ export function DocumentResponseToJSONTyped(value?: DocumentResponse | null, ign
         'id': value['id'],
         'path_part_id': value['pathPartId'],
         'name': value['name'],
-        'parent_id': value['parentId'],
+        'parent_folder_id': value['parentFolderId'],
         'document_type': DocumentTypeToJSON(value['documentType']),
         'document_origin': DocumentOriginToJSON(value['documentOrigin']),
         'active_version_id': value['activeVersionId'],

package/src/models/DocumentVersionMetadata.ts

@@ -0,0 +1,143 @@
+/* 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 { PipelineState } from './PipelineState';
+import {
+    PipelineStateFromJSON,
+    PipelineStateFromJSONTyped,
+    PipelineStateToJSON,
+    PipelineStateToJSONTyped,
+} from './PipelineState';
+
+/**
+ * Schema for document_version.metadata JSONB field.
+ * 
+ * Tracks S3 URLs for generated artifacts, pipeline execution state,
+ * and document statistics. Convention-based paths (images, page screenshots)
+ * are derived from document_id/document_version_id via s3_paths helpers,
+ * using a flat S3 layout: documents/{document_id}/{document_version_id}/...
+ * @export
+ * @interface DocumentVersionMetadata
+ */
+export interface DocumentVersionMetadata {
+    /**
+     * S3 URL to the source document (set by API on upload)
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    sourceS3?: string;
+    /**
+     * S3 URL to watermark-removed source document
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    cleanedSourceS3?: string;
+    /**
+     * S3 URL to the Docling JSON conversion output
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    doclingJsonS3?: string;
+    /**
+     * Current state of the ingestion pipeline workflow
+     * @type {PipelineState}
+     * @memberof DocumentVersionMetadata
+     */
+    pipelineState?: PipelineState;
+    /**
+     * Total number of pages in the document
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    totalPages?: number;
+    /**
+     * Total number of sections created
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    totalSections?: number;
+    /**
+     * Total number of chunks created
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    totalChunks?: number;
+}
+
+/**
+ * Check if a given object implements the DocumentVersionMetadata interface.
+ */
+export function instanceOfDocumentVersionMetadata(value: object): value is DocumentVersionMetadata {
+    return true;
+}
+
+export function DocumentVersionMetadataFromJSON(json: any): DocumentVersionMetadata {
+    return DocumentVersionMetadataFromJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
+        'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
+        'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
+        'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
+        'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
+        'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
+        'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+    };
+}
+
+export function DocumentVersionMetadataToJSON(json: any): DocumentVersionMetadata {
+    return DocumentVersionMetadataToJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetadata | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'source_s3': value['sourceS3'],
+        'cleaned_source_s3': value['cleanedSourceS3'],
+        'docling_json_s3': value['doclingJsonS3'],
+        'pipeline_state': PipelineStateToJSON(value['pipelineState']),
+        'total_pages': value['totalPages'],
+        'total_sections': value['totalSections'],
+        'total_chunks': value['totalChunks'],
+    };
+}
+
+export const DocumentVersionMetadataPropertyValidationAttributesMap: {
+    [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/DocumentVersionMetadataUpdate.ts

@@ -0,0 +1,141 @@
+/* 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 { PipelineState } from './PipelineState';
+import {
+    PipelineStateFromJSON,
+    PipelineStateFromJSONTyped,
+    PipelineStateToJSON,
+    PipelineStateToJSONTyped,
+} from './PipelineState';
+
+/**
+ * Partial update schema for document version metadata.
+ * 
+ * All fields are optional.  Only non-``None`` fields are merged into
+ * the existing metadata dict.
+ * @export
+ * @interface DocumentVersionMetadataUpdate
+ */
+export interface DocumentVersionMetadataUpdate {
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    sourceS3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    cleanedSourceS3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    doclingJsonS3?: string;
+    /**
+     * 
+     * @type {PipelineState}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    pipelineState?: PipelineState;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    totalPages?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    totalSections?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    totalChunks?: number;
+}
+
+/**
+ * Check if a given object implements the DocumentVersionMetadataUpdate interface.
+ */
+export function instanceOfDocumentVersionMetadataUpdate(value: object): value is DocumentVersionMetadataUpdate {
+    return true;
+}
+
+export function DocumentVersionMetadataUpdateFromJSON(json: any): DocumentVersionMetadataUpdate {
+    return DocumentVersionMetadataUpdateFromJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionMetadataUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sourceS3': json['source_s3'] == null ? undefined : json['source_s3'],
+        'cleanedSourceS3': json['cleaned_source_s3'] == null ? undefined : json['cleaned_source_s3'],
+        'doclingJsonS3': json['docling_json_s3'] == null ? undefined : json['docling_json_s3'],
+        'pipelineState': json['pipeline_state'] == null ? undefined : PipelineStateFromJSON(json['pipeline_state']),
+        'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
+        'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
+        'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+    };
+}
+
+export function DocumentVersionMetadataUpdateToJSON(json: any): DocumentVersionMetadataUpdate {
+    return DocumentVersionMetadataUpdateToJSONTyped(json, false);
+}
+
+export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersionMetadataUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'source_s3': value['sourceS3'],
+        'cleaned_source_s3': value['cleanedSourceS3'],
+        'docling_json_s3': value['doclingJsonS3'],
+        'pipeline_state': PipelineStateToJSON(value['pipelineState']),
+        'total_pages': value['totalPages'],
+        'total_sections': value['totalSections'],
+        'total_chunks': value['totalChunks'],
+    };
+}
+
+export const DocumentVersionMetadataUpdatePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+