@knowledge-stack/ksapi 1.146.0 → 1.147.0

package/.openapi-generator/FILES

@@ -161,6 +161,7 @@ docs/IdpType.md
 docs/ImageTaxonomy.md
 docs/InformationStatistics.md
 docs/IngestDocumentResponse.md
+docs/IngestZipResponse.md
 docs/IngestionMode.md
 docs/Input.md
 docs/InputOrigin.md
@@ -399,6 +400,7 @@ docs/XlsxCellAnchorInput.md
 docs/XlsxCellAnchorInputOrDocxParagraphAnchorInput.md
 docs/XlsxCellAnchorOutput.md
 docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md
+docs/ZipFileResult.md
 package.json
 src/apis/AdminKbApi.ts
 src/apis/AdminWorkflowsApi.ts
@@ -581,6 +583,7 @@ src/models/IdpType.ts
 src/models/ImageTaxonomy.ts
 src/models/InformationStatistics.ts
 src/models/IngestDocumentResponse.ts
+src/models/IngestZipResponse.ts
 src/models/IngestionMode.ts
 src/models/Input.ts
 src/models/InputOrigin.ts
@@ -799,6 +802,7 @@ src/models/XlsxCellAnchorInput.ts
 src/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.ts
 src/models/XlsxCellAnchorOutput.ts
 src/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.ts
+src/models/ZipFileResult.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.esm.json

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.146.0
+# @knowledge-stack/ksapi@1.147.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -142,6 +142,7 @@ All URIs are relative to *http://localhost:8000*
 *DocumentsApi* | [**getDocument**](docs/DocumentsApi.md#getdocument) | **GET** /v1/documents/{document_id} | Get Document Handler
 *DocumentsApi* | [**ingestDocument**](docs/DocumentsApi.md#ingestdocument) | **POST** /v1/documents/ingest | Ingest Document Handler
 *DocumentsApi* | [**ingestDocumentVersion**](docs/DocumentsApi.md#ingestdocumentversion) | **POST** /v1/documents/{document_id}/ingest | Ingest Document Version Handler
+*DocumentsApi* | [**ingestZip**](docs/DocumentsApi.md#ingestzip) | **POST** /v1/documents/ingest-zip | Ingest Zip Handler
 *DocumentsApi* | [**listDocuments**](docs/DocumentsApi.md#listdocuments) | **GET** /v1/documents | List Documents Handler
 *DocumentsApi* | [**updateDocument**](docs/DocumentsApi.md#updatedocumentoperation) | **PATCH** /v1/documents/{document_id} | Update Document Handler
 *FeaturesApi* | [**getFeatures**](docs/FeaturesApi.md#getfeatures) | **GET** /v1/features | Get Features Handler
@@ -430,6 +431,7 @@ All URIs are relative to *http://localhost:8000*
 - [ImageTaxonomy](docs/ImageTaxonomy.md)
 - [InformationStatistics](docs/InformationStatistics.md)
 - [IngestDocumentResponse](docs/IngestDocumentResponse.md)
+- [IngestZipResponse](docs/IngestZipResponse.md)
 - [IngestionMode](docs/IngestionMode.md)
 - [Input](docs/Input.md)
 - [InputOrigin](docs/InputOrigin.md)
@@ -648,6 +650,7 @@ All URIs are relative to *http://localhost:8000*
 - [XlsxCellAnchorInputOrDocxParagraphAnchorInput](docs/XlsxCellAnchorInputOrDocxParagraphAnchorInput.md)
 - [XlsxCellAnchorOutput](docs/XlsxCellAnchorOutput.md)
 - [XlsxCellAnchorOutputOrDocxParagraphAnchorOutput](docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md)
+- [ZipFileResult](docs/ZipFileResult.md)
 
 ### Authorization
 
@@ -673,7 +676,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.146.0`
+- Package version: `1.147.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/DocumentsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ChunkType, CreateDocumentRequest, DocumentDownloadResponse, DocumentResponse, DocumentType, DownloadArtifact, ImageTaxonomy, IngestDocumentResponse, IngestionMode, PaginatedResponseDocumentResponse, PathOrder, SortDirection, UpdateDocumentRequest } from '../models/index';
+import type { ChunkType, CreateDocumentRequest, DocumentDownloadResponse, DocumentResponse, DocumentType, DownloadArtifact, ImageTaxonomy, IngestDocumentResponse, IngestZipResponse, IngestionMode, PaginatedResponseDocumentResponse, PathOrder, SortDirection, UpdateDocumentRequest } from '../models/index';
 export interface CreateDocumentOperationRequest {
     createDocumentRequest: CreateDocumentRequest;
 }
@@ -46,6 +46,11 @@ export interface IngestDocumentVersionRequest {
     workflowRunId?: string | null;
     workflowDefinitionId?: string | null;
 }
+export interface IngestZipRequest {
+    file: Blob;
+    pathPartId: string;
+    ingestionMode?: IngestionMode;
+}
 export interface ListDocumentsRequest {
     parentPathPartId?: string | null;
     sortOrder?: PathOrder;
@@ -230,6 +235,31 @@ export interface DocumentsApiInterface {
      * Ingest Document Version Handler
      */
     ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for ingestZip without sending the request
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {IngestionMode} [ingestionMode]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * @summary Ingest Zip Handler
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {IngestionMode} [ingestionMode]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
     /**
      * Creates request options for listDocuments without sending the request
      * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
@@ -383,6 +413,20 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * Ingest Document Version Handler
      */
     ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for ingestZip without sending the request
+     */
+    ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
     /**
      * Creates request options for listDocuments without sending the request
      */

package/dist/apis/DocumentsApi.js

@@ -439,6 +439,81 @@ class DocumentsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for ingestZip without sending the request
+     */
+    ingestZipRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['file'] == null) {
+                throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestZip().');
+            }
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling ingestZip().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            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']);
+            }
+            if (requestParameters['pathPartId'] != null) {
+                formParams.append('path_part_id', requestParameters['pathPartId']);
+            }
+            if (requestParameters['ingestionMode'] != null) {
+                formParams.append('ingestion_mode', requestParameters['ingestionMode']);
+            }
+            let urlPath = `/v1/documents/ingest-zip`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            };
+        });
+    }
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZipRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.ingestZipRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.IngestZipResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.ingestZipRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for listDocuments without sending the request
      */

package/dist/esm/apis/DocumentsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ChunkType, CreateDocumentRequest, DocumentDownloadResponse, DocumentResponse, DocumentType, DownloadArtifact, ImageTaxonomy, IngestDocumentResponse, IngestionMode, PaginatedResponseDocumentResponse, PathOrder, SortDirection, UpdateDocumentRequest } from '../models/index';
+import type { ChunkType, CreateDocumentRequest, DocumentDownloadResponse, DocumentResponse, DocumentType, DownloadArtifact, ImageTaxonomy, IngestDocumentResponse, IngestZipResponse, IngestionMode, PaginatedResponseDocumentResponse, PathOrder, SortDirection, UpdateDocumentRequest } from '../models/index';
 export interface CreateDocumentOperationRequest {
     createDocumentRequest: CreateDocumentRequest;
 }
@@ -46,6 +46,11 @@ export interface IngestDocumentVersionRequest {
     workflowRunId?: string | null;
     workflowDefinitionId?: string | null;
 }
+export interface IngestZipRequest {
+    file: Blob;
+    pathPartId: string;
+    ingestionMode?: IngestionMode;
+}
 export interface ListDocumentsRequest {
     parentPathPartId?: string | null;
     sortOrder?: PathOrder;
@@ -230,6 +235,31 @@ export interface DocumentsApiInterface {
      * Ingest Document Version Handler
      */
     ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for ingestZip without sending the request
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {IngestionMode} [ingestionMode]
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * @summary Ingest Zip Handler
+     * @param {Blob} file
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
+     * @param {IngestionMode} [ingestionMode]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
     /**
      * Creates request options for listDocuments without sending the request
      * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
@@ -383,6 +413,20 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      * Ingest Document Version Handler
      */
     ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
+    /**
+     * Creates request options for ingestZip without sending the request
+     */
+    ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
     /**
      * Creates request options for listDocuments without sending the request
      */

package/dist/esm/apis/DocumentsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CreateDocumentRequestToJSON, DocumentDownloadResponseFromJSON, DocumentResponseFromJSON, IngestDocumentResponseFromJSON, PaginatedResponseDocumentResponseFromJSON, UpdateDocumentRequestToJSON, } from '../models/index';
+import { CreateDocumentRequestToJSON, DocumentDownloadResponseFromJSON, DocumentResponseFromJSON, IngestDocumentResponseFromJSON, IngestZipResponseFromJSON, PaginatedResponseDocumentResponseFromJSON, UpdateDocumentRequestToJSON, } from '../models/index';
 /**
  *
  */
@@ -403,6 +403,81 @@ export class DocumentsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for ingestZip without sending the request
+     */
+    ingestZipRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['file'] == null) {
+                throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestZip().');
+            }
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling ingestZip().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            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']);
+            }
+            if (requestParameters['pathPartId'] != null) {
+                formParams.append('path_part_id', requestParameters['pathPartId']);
+            }
+            if (requestParameters['ingestionMode'] != null) {
+                formParams.append('ingestion_mode', requestParameters['ingestionMode']);
+            }
+            let urlPath = `/v1/documents/ingest-zip`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            };
+        });
+    }
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZipRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.ingestZipRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => IngestZipResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Upload a ZIP archive and ingest each member file individually.  Directory structure inside the ZIP is preserved as FOLDER PathParts under the target folder. Returns 202 with per-file outcomes — each file that ingests successfully has its own Temporal workflow ID to poll for status.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes. Per-file failures (unsupported type, oversized) are included in the response with ``error`` set; other files continue processing.
+     * Ingest Zip Handler
+     */
+    ingestZip(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.ingestZipRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for listDocuments without sending the request
      */

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

@@ -0,0 +1,72 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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 { ZipFileResult } from './ZipFileResult';
+/**
+ * Aggregate response from a ZIP ingestion batch.
+ * @export
+ * @interface IngestZipResponse
+ */
+export interface IngestZipResponse {
+    /**
+     *
+     * @type {Array<ZipFileResult>}
+     * @memberof IngestZipResponse
+     */
+    files: Array<ZipFileResult>;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    totalFound: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    succeeded: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    skipped: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IngestZipResponse
+     */
+    failed: number;
+}
+export declare const IngestZipResponsePropertyValidationAttributesMap: {
+    [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 IngestZipResponse interface.
+ */
+export declare function instanceOfIngestZipResponse(value: object): value is IngestZipResponse;
+export declare function IngestZipResponseFromJSON(json: any): IngestZipResponse;
+export declare function IngestZipResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestZipResponse;
+export declare function IngestZipResponseToJSON(json: any): IngestZipResponse;
+export declare function IngestZipResponseToJSONTyped(value?: IngestZipResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/IngestZipResponse.js

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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 { ZipFileResultFromJSON, ZipFileResultToJSON, } from './ZipFileResult';
+export const IngestZipResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the IngestZipResponse interface.
+ */
+export function instanceOfIngestZipResponse(value) {
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    if (!('totalFound' in value) || value['totalFound'] === undefined)
+        return false;
+    if (!('succeeded' in value) || value['succeeded'] === undefined)
+        return false;
+    if (!('skipped' in value) || value['skipped'] === undefined)
+        return false;
+    if (!('failed' in value) || value['failed'] === undefined)
+        return false;
+    return true;
+}
+export function IngestZipResponseFromJSON(json) {
+    return IngestZipResponseFromJSONTyped(json, false);
+}
+export function IngestZipResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'files': (json['files'].map(ZipFileResultFromJSON)),
+        'totalFound': json['total_found'],
+        'succeeded': json['succeeded'],
+        'skipped': json['skipped'],
+        'failed': json['failed'],
+    };
+}
+export function IngestZipResponseToJSON(json) {
+    return IngestZipResponseToJSONTyped(json, false);
+}
+export function IngestZipResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'files': (value['files'].map(ZipFileResultToJSON)),
+        'total_found': value['totalFound'],
+        'succeeded': value['succeeded'],
+        'skipped': value['skipped'],
+        'failed': value['failed'],
+    };
+}

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

@@ -0,0 +1,77 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * 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.
+ */
+/**
+ * Per-file outcome from a ZIP ingestion batch.
+ * @export
+ * @interface ZipFileResult
+ */
+export interface ZipFileResult {
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    zipPath: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentVersionId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    workflowId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ZipFileResult
+     */
+    skipped?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    error?: string | null;
+}
+export declare const ZipFileResultPropertyValidationAttributesMap: {
+    [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 ZipFileResult interface.
+ */
+export declare function instanceOfZipFileResult(value: object): value is ZipFileResult;
+export declare function ZipFileResultFromJSON(json: any): ZipFileResult;
+export declare function ZipFileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipFileResult;
+export declare function ZipFileResultToJSON(json: any): ZipFileResult;
+export declare function ZipFileResultToJSONTyped(value?: ZipFileResult | null, ignoreDiscriminator?: boolean): any;