@knowledge-stack/ksapi 1.149.1 → 1.150.0

package/.openapi-generator/FILES

@@ -403,6 +403,8 @@ docs/XlsxCellAnchorInputOrDocxParagraphAnchorInput.md
 docs/XlsxCellAnchorOutput.md
 docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md
 docs/ZipFileResult.md
+docs/ZipIngestionStatusResponse.md
+docs/ZipMemberStatusResponse.md
 package.json
 src/apis/AdminKbApi.ts
 src/apis/AdminWorkflowsApi.ts
@@ -807,6 +809,8 @@ src/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.ts
 src/models/XlsxCellAnchorOutput.ts
 src/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.ts
 src/models/ZipFileResult.ts
+src/models/ZipIngestionStatusResponse.ts
+src/models/ZipMemberStatusResponse.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.esm.json

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.149.1
+# @knowledge-stack/ksapi@1.150.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -208,6 +208,7 @@ All URIs are relative to *http://localhost:8000*
 *SystemJobsApi* | [**dvWorkflowRerun**](docs/SystemJobsApi.md#dvworkflowrerun) | **POST** /v1/system-jobs/document_versions/{workflow_id} | Dv Workflow Rerun Handler
 *SystemJobsApi* | [**getDvWorkflow**](docs/SystemJobsApi.md#getdvworkflow) | **GET** /v1/system-jobs/document_versions/{workflow_id} | Get Dv Workflow Handler
 *SystemJobsApi* | [**getTemporalWorkflowStatus**](docs/SystemJobsApi.md#gettemporalworkflowstatus) | **GET** /v1/system-jobs/{workflow_id} | Get Temporal Workflow Status Handler
+*SystemJobsApi* | [**getZipIngestionStatus**](docs/SystemJobsApi.md#getzipingestionstatus) | **GET** /v1/system-jobs/zip-ingestions/{workflow_id} | Get Zip Ingestion Status Handler
 *SystemJobsApi* | [**listDvWorkflows**](docs/SystemJobsApi.md#listdvworkflows) | **GET** /v1/system-jobs/document_versions | List Dv Workflows Handler
 *TagsApi* | [**createTag**](docs/TagsApi.md#createtagoperation) | **POST** /v1/tags | Create Tag Handler
 *TagsApi* | [**deleteTag**](docs/TagsApi.md#deletetag) | **DELETE** /v1/tags/{tag_id} | Delete Tag Handler
@@ -653,6 +654,8 @@ All URIs are relative to *http://localhost:8000*
 - [XlsxCellAnchorOutput](docs/XlsxCellAnchorOutput.md)
 - [XlsxCellAnchorOutputOrDocxParagraphAnchorOutput](docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md)
 - [ZipFileResult](docs/ZipFileResult.md)
+- [ZipIngestionStatusResponse](docs/ZipIngestionStatusResponse.md)
+- [ZipMemberStatusResponse](docs/ZipMemberStatusResponse.md)
 
 ### Authorization
 
@@ -678,7 +681,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.149.1`
+- Package version: `1.150.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/DocumentsApi.d.ts

@@ -34,6 +34,8 @@ export interface IngestDocumentRequest {
     secondaryTaxonomy?: ImageTaxonomy;
     pageDpi?: number;
     workflowRunId?: string | null;
+    tagIds?: Array<string>;
+    idempotencyKey?: string | null;
     workflowDefinitionId?: string | null;
 }
 export interface IngestDocumentVersionRequest {
@@ -50,6 +52,7 @@ export interface IngestZipRequest {
     file: Blob;
     pathPartId: string;
     ingestionMode?: IngestionMode;
+    tagIds?: Array<string>;
 }
 export interface ListDocumentsRequest {
     parentPathPartId?: string | null;
@@ -173,6 +176,8 @@ export interface DocumentsApiInterface {
      * @param {ImageTaxonomy} [secondaryTaxonomy]
      * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
      * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
+     * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
+     * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
      * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
@@ -189,6 +194,8 @@ export interface DocumentsApiInterface {
      * @param {ImageTaxonomy} [secondaryTaxonomy]
      * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
      * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
+     * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
+     * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
      * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -240,23 +247,25 @@ export interface DocumentsApiInterface {
      * @param {Blob} file
      * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {IngestionMode} [ingestionMode]
+     * @param {Array<string>} [tagIds] Tag IDs applied to every ingested member document.
      * @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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * @summary Ingest Zip Handler
      * @param {Blob} file
      * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {IngestionMode} [ingestionMode]
+     * @param {Array<string>} [tagIds] Tag IDs applied to every ingested member document.
      * @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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
@@ -418,12 +427,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      */
     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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;

package/dist/apis/DocumentsApi.js

@@ -317,6 +317,12 @@ class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['workflowRunId'] != null) {
                 formParams.append('workflow_run_id', requestParameters['workflowRunId']);
             }
+            if (requestParameters['tagIds'] != null) {
+                formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
+            }
+            if (requestParameters['idempotencyKey'] != null) {
+                formParams.append('idempotency_key', requestParameters['idempotencyKey']);
+            }
             if (requestParameters['workflowDefinitionId'] != null) {
                 formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId']);
             }
@@ -483,6 +489,9 @@ class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['ingestionMode'] != null) {
                 formParams.append('ingestion_mode', requestParameters['ingestionMode']);
             }
+            if (requestParameters['tagIds'] != null) {
+                formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
+            }
             let urlPath = `/v1/documents/ingest-zip`;
             return {
                 path: urlPath,
@@ -494,7 +503,7 @@ class DocumentsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZipRaw(requestParameters, initOverrides) {
@@ -505,7 +514,7 @@ class DocumentsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters, initOverrides) {

package/dist/apis/SystemJobsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse } from '../models/index';
+import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse, ZipIngestionStatusResponse } from '../models/index';
 export interface CancelTemporalWorkflowRequest {
     workflowId: string;
 }
@@ -23,6 +23,9 @@ export interface GetDvWorkflowRequest {
 export interface GetTemporalWorkflowStatusRequest {
     workflowId: string;
 }
+export interface GetZipIngestionStatusRequest {
+    workflowId: string;
+}
 export interface ListDvWorkflowsRequest {
     limit?: number;
     offset?: number;
@@ -118,6 +121,27 @@ export interface SystemJobsApiInterface {
      * Get Temporal Workflow Status Handler
      */
     getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     * @param {string} workflowId
+     * @throws {RequiredError}
+     * @memberof SystemJobsApiInterface
+     */
+    getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * @summary Get Zip Ingestion Status Handler
+     * @param {string} workflowId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemJobsApiInterface
+     */
+    getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
     /**
      * Creates request options for listDvWorkflows without sending the request
      * @param {number} [limit] Number of items per page
@@ -202,6 +226,20 @@ export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobs
      * Get Temporal Workflow Status Handler
      */
     getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     */
+    getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
     /**
      * Creates request options for listDvWorkflows without sending the request
      */

package/dist/apis/SystemJobsApi.js

@@ -254,6 +254,54 @@ class SystemJobsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     */
+    getZipIngestionStatusRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['workflowId'] == null) {
+                throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getZipIngestionStatus().');
+            }
+            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}`;
+                }
+            }
+            let urlPath = `/v1/system-jobs/zip-ingestions/{workflow_id}`;
+            urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getZipIngestionStatusRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ZipIngestionStatusResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getZipIngestionStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for listDvWorkflows without sending the request
      */

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

@@ -34,6 +34,8 @@ export interface IngestDocumentRequest {
     secondaryTaxonomy?: ImageTaxonomy;
     pageDpi?: number;
     workflowRunId?: string | null;
+    tagIds?: Array<string>;
+    idempotencyKey?: string | null;
     workflowDefinitionId?: string | null;
 }
 export interface IngestDocumentVersionRequest {
@@ -50,6 +52,7 @@ export interface IngestZipRequest {
     file: Blob;
     pathPartId: string;
     ingestionMode?: IngestionMode;
+    tagIds?: Array<string>;
 }
 export interface ListDocumentsRequest {
     parentPathPartId?: string | null;
@@ -173,6 +176,8 @@ export interface DocumentsApiInterface {
      * @param {ImageTaxonomy} [secondaryTaxonomy]
      * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
      * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
+     * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
+     * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
      * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
      * @throws {RequiredError}
      * @memberof DocumentsApiInterface
@@ -189,6 +194,8 @@ export interface DocumentsApiInterface {
      * @param {ImageTaxonomy} [secondaryTaxonomy]
      * @param {number} [pageDpi] DPI for PDF page screenshots (default 72, min 36, max 216).
      * @param {string} [workflowRunId] Workflow run context for assumed agent uploads.
+     * @param {Array<string>} [tagIds] Tag IDs applied to the created document.
+     * @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
      * @param {string} [workflowDefinitionId] Workflow definition context for assumed agent uploads.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -240,23 +247,25 @@ export interface DocumentsApiInterface {
      * @param {Blob} file
      * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {IngestionMode} [ingestionMode]
+     * @param {Array<string>} [tagIds] Tag IDs applied to every ingested member document.
      * @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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * @summary Ingest Zip Handler
      * @param {Blob} file
      * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {IngestionMode} [ingestionMode]
+     * @param {Array<string>} [tagIds] Tag IDs applied to every ingested member document.
      * @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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
@@ -418,12 +427,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
      */
     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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;

package/dist/esm/apis/DocumentsApi.js

@@ -281,6 +281,12 @@ export class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['workflowRunId'] != null) {
                 formParams.append('workflow_run_id', requestParameters['workflowRunId']);
             }
+            if (requestParameters['tagIds'] != null) {
+                formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
+            }
+            if (requestParameters['idempotencyKey'] != null) {
+                formParams.append('idempotency_key', requestParameters['idempotencyKey']);
+            }
             if (requestParameters['workflowDefinitionId'] != null) {
                 formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId']);
             }
@@ -447,6 +453,9 @@ export class DocumentsApi extends runtime.BaseAPI {
             if (requestParameters['ingestionMode'] != null) {
                 formParams.append('ingestion_mode', requestParameters['ingestionMode']);
             }
+            if (requestParameters['tagIds'] != null) {
+                formParams.append('tag_ids', requestParameters['tagIds'].join(runtime.COLLECTION_FORMATS["csv"]));
+            }
             let urlPath = `/v1/documents/ingest-zip`;
             return {
                 path: urlPath,
@@ -458,7 +467,7 @@ export class DocumentsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZipRaw(requestParameters, initOverrides) {
@@ -469,7 +478,7 @@ export class DocumentsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * Upload a ZIP archive; ingest each member asynchronously via a fan-out.  The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes) plus the artifacts ``skipped`` during classification.  Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Per-member failures (unsupported type, oversized) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
      * Ingest Zip Handler
      */
     ingestZip(requestParameters, initOverrides) {

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse } from '../models/index';
+import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse, ZipIngestionStatusResponse } from '../models/index';
 export interface CancelTemporalWorkflowRequest {
     workflowId: string;
 }
@@ -23,6 +23,9 @@ export interface GetDvWorkflowRequest {
 export interface GetTemporalWorkflowStatusRequest {
     workflowId: string;
 }
+export interface GetZipIngestionStatusRequest {
+    workflowId: string;
+}
 export interface ListDvWorkflowsRequest {
     limit?: number;
     offset?: number;
@@ -118,6 +121,27 @@ export interface SystemJobsApiInterface {
      * Get Temporal Workflow Status Handler
      */
     getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     * @param {string} workflowId
+     * @throws {RequiredError}
+     * @memberof SystemJobsApiInterface
+     */
+    getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * @summary Get Zip Ingestion Status Handler
+     * @param {string} workflowId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemJobsApiInterface
+     */
+    getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
     /**
      * Creates request options for listDvWorkflows without sending the request
      * @param {number} [limit] Number of items per page
@@ -202,6 +226,20 @@ export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobs
      * Get Temporal Workflow Status Handler
      */
     getTemporalWorkflowStatus(requestParameters: GetTemporalWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TemporalWorkflowStatusResponse>;
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     */
+    getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
     /**
      * Creates request options for listDvWorkflows without sending the request
      */

package/dist/esm/apis/SystemJobsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedResponseWorkflowSummaryResponseFromJSON, TemporalWorkflowStatusResponseFromJSON, WorkflowActionResponseFromJSON, WorkflowCancelResponseFromJSON, WorkflowDetailResponseFromJSON, } from '../models/index';
+import { PaginatedResponseWorkflowSummaryResponseFromJSON, TemporalWorkflowStatusResponseFromJSON, WorkflowActionResponseFromJSON, WorkflowCancelResponseFromJSON, WorkflowDetailResponseFromJSON, ZipIngestionStatusResponseFromJSON, } from '../models/index';
 /**
  *
  */
@@ -218,6 +218,54 @@ export class SystemJobsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     */
+    getZipIngestionStatusRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['workflowId'] == null) {
+                throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getZipIngestionStatus().');
+            }
+            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}`;
+                }
+            }
+            let urlPath = `/v1/system-jobs/zip-ingestions/{workflow_id}`;
+            urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getZipIngestionStatusRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ZipIngestionStatusResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute. The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this returns 404.
+     * Get Zip Ingestion Status Handler
+     */
+    getZipIngestionStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getZipIngestionStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for listDvWorkflows without sending the request
      */

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

@@ -151,6 +151,12 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     fileMd5?: string;
+    /**
+     * Opt-in create key. A repeat ingest with the same key at the same (parent, name) replays this document instead of colliding — makes a ZIP fan-out member retry idempotent.
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    idempotencyKey?: string | null;
 }
 export declare const DocumentVersionMetadataPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/DocumentVersionMetadata.js

@@ -49,6 +49,7 @@ export function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator)
         'quotaPageCount': json['quota_page_count'] == null ? undefined : json['quota_page_count'],
         'quotaIdempotencyKey': json['quota_idempotency_key'] == null ? undefined : json['quota_idempotency_key'],
         'fileMd5': json['file_md5'] == null ? undefined : json['file_md5'],
+        'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
     };
 }
 export function DocumentVersionMetadataToJSON(json) {
@@ -79,5 +80,6 @@ export function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator =
         'quota_page_count': value['quotaPageCount'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
+        'idempotency_key': value['idempotencyKey'],
     };
 }