@knowledge-stack/ksapi 1.14.1 → 1.16.0

package/src/apis/DocumentsApi.ts

@@ -18,6 +18,7 @@ import type {
   CreateDocumentRequest,
   DocumentResponse,
   HTTPValidationError,
+  IngestDocumentResponse,
   PaginatedResponseDocumentResponse,
   PathOrder,
   UpdateDocumentRequest,
@@ -29,6 +30,8 @@ import {
     DocumentResponseToJSON,
     HTTPValidationErrorFromJSON,
     HTTPValidationErrorToJSON,
+    IngestDocumentResponseFromJSON,
+    IngestDocumentResponseToJSON,
     PaginatedResponseDocumentResponseFromJSON,
     PaginatedResponseDocumentResponseToJSON,
     PathOrderFromJSON,
@@ -52,6 +55,13 @@ export interface GetDocumentRequest {
     ksUat?: string;
 }
 
+export interface IngestDocumentRequest {
+    file: Blob;
+    folderId: string;
+    ksUat?: string;
+    name?: string;
+}
+
 export interface ListDocumentsRequest {
     parentId?: string;
     sortOrder?: PathOrder;
@@ -124,6 +134,25 @@ export interface DocumentsApiInterface {
      */
     getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
 
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
+     * @summary Ingest Document Handler
+     * @param {Blob} file 
+     * @param {string} folderId Parent folder ID
+     * @param {string} [ksUat] 
+     * @param {string} [name] Document name (defaults to filename)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
+
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
+     * Ingest Document Handler
+     */
+    ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+
     /**
      * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
      * @summary List Documents Handler
@@ -287,6 +316,80 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
         return await response.value();
     }
 
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
+     * Ingest Document Handler
+     */
+    async ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>> {
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling ingestDocument().'
+            );
+        }
+
+        if (requestParameters['folderId'] == null) {
+            throw new runtime.RequiredError(
+                'folderId',
+                'Required parameter "folderId" was null or undefined when calling ingestDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+        if (requestParameters['folderId'] != null) {
+            formParams.append('folder_id', requestParameters['folderId'] as any);
+        }
+
+        if (requestParameters['name'] != null) {
+            formParams.append('name', requestParameters['name'] as any);
+        }
+
+
+        let urlPath = `/v1/documents/ingest`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
+     * Ingest Document Handler
+     */
+    async ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse> {
+        const response = await this.ingestDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
      * List Documents Handler

package/src/apis/InvitesApi.ts

@@ -44,6 +44,11 @@ export interface CreateInviteRequest {
     ksUat?: string;
 }
 
+export interface DeleteInviteRequest {
+    inviteId: string;
+    ksUat?: string;
+}
+
 export interface ListInvitesRequest {
     email?: string;
     status?: InviteStatus;
@@ -93,6 +98,23 @@ export interface InvitesApiInterface {
      */
     createInvite(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteResponse>;
 
+    /**
+     * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
+     * @summary Delete Invite
+     * @param {string} inviteId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    deleteInviteRaw(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
+     * Delete Invite
+     */
+    deleteInvite(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
      * @summary List Invites Handler
@@ -204,6 +226,44 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
         return await response.value();
     }
 
+    /**
+     * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
+     * Delete Invite
+     */
+    async deleteInviteRaw(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['inviteId'] == null) {
+            throw new runtime.RequiredError(
+                'inviteId',
+                'Required parameter "inviteId" was null or undefined when calling deleteInvite().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/invites/{invite_id}`;
+        urlPath = urlPath.replace(`{${"invite_id"}}`, encodeURIComponent(String(requestParameters['inviteId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
+     * Delete Invite
+     */
+    async deleteInvite(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteInviteRaw(requestParameters, initOverrides);
+    }
+
     /**
      * List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
      * List Invites Handler

package/src/apis/TenantsApi.ts

@@ -96,7 +96,7 @@ export interface TenantsApiInterface {
     createTenant(requestParameters: CreateTenantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse>;
 
     /**
-     * Delete a tenant.  Requires OWNER role in the tenant.
+     * Delete a tenant.  Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
      * @summary Delete Tenant
      * @param {string} tenantId 
      * @param {string} [ksUat] 
@@ -107,7 +107,7 @@ export interface TenantsApiInterface {
     deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
-     * Delete a tenant.  Requires OWNER role in the tenant.
+     * Delete a tenant.  Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
      * Delete Tenant
      */
     deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -233,7 +233,7 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
     }
 
     /**
-     * Delete a tenant.  Requires OWNER role in the tenant.
+     * Delete a tenant.  Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
      * Delete Tenant
      */
     async deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -263,7 +263,7 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
     }
 
     /**
-     * Delete a tenant.  Requires OWNER role in the tenant.
+     * Delete a tenant.  Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
      * Delete Tenant
      */
     async deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {

package/src/models/AssumeUserRequest.ts

@@ -0,0 +1,92 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface AssumeUserRequest
+ */
+export interface AssumeUserRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssumeUserRequest
+     */
+    tenantId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssumeUserRequest
+     */
+    userId: string;
+}
+
+/**
+ * Check if a given object implements the AssumeUserRequest interface.
+ */
+export function instanceOfAssumeUserRequest(value: object): value is AssumeUserRequest {
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function AssumeUserRequestFromJSON(json: any): AssumeUserRequest {
+    return AssumeUserRequestFromJSONTyped(json, false);
+}
+
+export function AssumeUserRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssumeUserRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tenantId': json['tenant_id'],
+        'userId': json['user_id'],
+    };
+}
+
+export function AssumeUserRequestToJSON(json: any): AssumeUserRequest {
+    return AssumeUserRequestToJSONTyped(json, false);
+}
+
+export function AssumeUserRequestToJSONTyped(value?: AssumeUserRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tenant_id': value['tenantId'],
+        'user_id': value['userId'],
+    };
+}
+
+export const AssumeUserRequestPropertyValidationAttributesMap: {
+    [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/AssumeUserResponse.ts

@@ -0,0 +1,83 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface AssumeUserResponse
+ */
+export interface AssumeUserResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssumeUserResponse
+     */
+    token: string;
+}
+
+/**
+ * Check if a given object implements the AssumeUserResponse interface.
+ */
+export function instanceOfAssumeUserResponse(value: object): value is AssumeUserResponse {
+    if (!('token' in value) || value['token'] === undefined) return false;
+    return true;
+}
+
+export function AssumeUserResponseFromJSON(json: any): AssumeUserResponse {
+    return AssumeUserResponseFromJSONTyped(json, false);
+}
+
+export function AssumeUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssumeUserResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'token': json['token'],
+    };
+}
+
+export function AssumeUserResponseToJSON(json: any): AssumeUserResponse {
+    return AssumeUserResponseToJSONTyped(json, false);
+}
+
+export function AssumeUserResponseToJSONTyped(value?: AssumeUserResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'token': value['token'],
+    };
+}
+
+export const AssumeUserResponsePropertyValidationAttributesMap: {
+    [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/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
+    }
+} = {
+}
+