@knowledge-stack/ksapi 1.149.1 → 1.151.0

package/docs/SystemJobsApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
 | [**dvWorkflowRerun**](SystemJobsApi.md#dvworkflowrerun) | **POST** /v1/system-jobs/document_versions/{workflow_id} | Dv Workflow Rerun Handler |
 | [**getDvWorkflow**](SystemJobsApi.md#getdvworkflow) | **GET** /v1/system-jobs/document_versions/{workflow_id} | Get Dv Workflow Handler |
 | [**getTemporalWorkflowStatus**](SystemJobsApi.md#gettemporalworkflowstatus) | **GET** /v1/system-jobs/{workflow_id} | Get Temporal Workflow Status Handler |
+| [**getZipIngestionStatus**](SystemJobsApi.md#getzipingestionstatus) | **GET** /v1/system-jobs/zip-ingestions/{workflow_id} | Get Zip Ingestion Status Handler |
 | [**listDvWorkflows**](SystemJobsApi.md#listdvworkflows) | **GET** /v1/system-jobs/document_versions | List Dv Workflows Handler |
 
 
@@ -312,6 +313,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getZipIngestionStatus
+
+> ZipIngestionStatusResponse getZipIngestionStatus(workflowId)
+
+Get Zip Ingestion Status Handler
+
+Get a ZIP fan-out\'s live status + per-member outcomes.  Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemJobsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetZipIngestionStatusRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SystemJobsApi(config);
+
+  const body = {
+    // string
+    workflowId: workflowId_example,
+  } satisfies GetZipIngestionStatusRequest;
+
+  try {
+    const data = await api.getZipIngestionStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **workflowId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ZipIngestionStatusResponse**](ZipIngestionStatusResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listDvWorkflows
 
 > PaginatedResponseWorkflowSummaryResponse listDvWorkflows(limit, offset)

package/docs/ZipIngestionStatusResponse.md

@@ -0,0 +1,39 @@
+
+# ZipIngestionStatusResponse
+
+Status of a ZIP fan-out: live Temporal state + per-member outcomes.  ``files`` reflects progress so far — members that have been dispatched (``workflow_id`` set), failed to dispatch (``error`` set), or were skipped as artifacts. Poll until ``temporal_status`` is terminal (e.g. ``COMPLETED``).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`temporalStatus` | string
+`files` | [Array<ZipMemberStatusResponse>](ZipMemberStatusResponse.md)
+
+## Example
+
+```typescript
+import type { ZipIngestionStatusResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "temporalStatus": null,
+  "files": null,
+} satisfies ZipIngestionStatusResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZipIngestionStatusResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ZipMemberStatusResponse.md

@@ -0,0 +1,45 @@
+
+# ZipMemberStatusResponse
+
+One member\'s outcome within a ZIP fan-out (from the workflow query).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zipPath` | string
+`documentId` | string
+`documentVersionId` | string
+`workflowId` | string
+`error` | string
+`skipped` | boolean
+
+## Example
+
+```typescript
+import type { ZipMemberStatusResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "zipPath": null,
+  "documentId": null,
+  "documentVersionId": null,
+  "workflowId": null,
+  "error": null,
+  "skipped": null,
+} satisfies ZipMemberStatusResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZipMemberStatusResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.149.1",
+  "version": "1.151.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DocumentsApi.ts

@@ -94,6 +94,8 @@ export interface IngestDocumentRequest {
     secondaryTaxonomy?: ImageTaxonomy;
     pageDpi?: number;
     workflowRunId?: string | null;
+    tagIds?: Array<string>;
+    idempotencyKey?: string | null;
     workflowDefinitionId?: string | null;
 }
 
@@ -112,6 +114,7 @@ export interface IngestZipRequest {
     file: Blob;
     pathPartId: string;
     ingestionMode?: IngestionMode;
+    tagIds?: Array<string>;
 }
 
 export interface ListDocumentsRequest {
@@ -250,6 +253,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
@@ -267,6 +272,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}
@@ -323,17 +330,19 @@ 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
@@ -341,7 +350,7 @@ export interface 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>;
@@ -730,6 +739,14 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             formParams.append('workflow_run_id', requestParameters['workflowRunId'] as any);
         }
 
+        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'] as any);
+        }
+
         if (requestParameters['workflowDefinitionId'] != null) {
             formParams.append('workflow_definition_id', requestParameters['workflowDefinitionId'] as any);
         }
@@ -931,6 +948,10 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             formParams.append('ingestion_mode', requestParameters['ingestionMode'] as any);
         }
 
+        if (requestParameters['tagIds'] != null) {
+            formParams.append('tag_ids', requestParameters['tagIds']!.join(runtime.COLLECTION_FORMATS["csv"]));
+        }
+
 
         let urlPath = `/v1/documents/ingest-zip`;
 
@@ -944,7 +965,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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
      */
     async ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>> {
@@ -955,7 +976,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * 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
      */
     async ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse> {

package/src/apis/MemoryApi.ts

@@ -21,8 +21,8 @@ import type {
   MemoryChunkResponse,
   MemoryScope,
   PaginatedResponsePendingMemoryChunkResponse,
+  PendingMemoryChunkResponse,
   ProposeMemoryChunkRequest,
-  ProposedMemoryChunkResponse,
 } from '../models/index';
 import {
     ErrorResponseFromJSON,
@@ -37,10 +37,10 @@ import {
     MemoryScopeToJSON,
     PaginatedResponsePendingMemoryChunkResponseFromJSON,
     PaginatedResponsePendingMemoryChunkResponseToJSON,
+    PendingMemoryChunkResponseFromJSON,
+    PendingMemoryChunkResponseToJSON,
     ProposeMemoryChunkRequestFromJSON,
     ProposeMemoryChunkRequestToJSON,
-    ProposedMemoryChunkResponseFromJSON,
-    ProposedMemoryChunkResponseToJSON,
 } from '../models/index';
 
 export interface ApproveMemoryProposalRequest {
@@ -161,12 +161,12 @@ export interface MemoryApiInterface {
      * @throws {RequiredError}
      * @memberof MemoryApiInterface
      */
-    proposeMemoryChunkRaw(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProposedMemoryChunkResponse>>;
+    proposeMemoryChunkRaw(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PendingMemoryChunkResponse>>;
 
     /**
      * Propose Memory Chunk Handler
      */
-    proposeMemoryChunk(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProposedMemoryChunkResponse>;
+    proposeMemoryChunk(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingMemoryChunkResponse>;
 
     /**
      * Creates request options for rejectMemoryProposal without sending the request
@@ -411,17 +411,17 @@ export class MemoryApi extends runtime.BaseAPI implements MemoryApiInterface {
     /**
      * Propose Memory Chunk Handler
      */
-    async proposeMemoryChunkRaw(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProposedMemoryChunkResponse>> {
+    async proposeMemoryChunkRaw(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PendingMemoryChunkResponse>> {
         const requestOptions = await this.proposeMemoryChunkRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => ProposedMemoryChunkResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => PendingMemoryChunkResponseFromJSON(jsonValue));
     }
 
     /**
      * Propose Memory Chunk Handler
      */
-    async proposeMemoryChunk(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProposedMemoryChunkResponse> {
+    async proposeMemoryChunk(requestParameters: ProposeMemoryChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PendingMemoryChunkResponse> {
         const response = await this.proposeMemoryChunkRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/apis/SystemJobsApi.ts

@@ -22,6 +22,7 @@ import type {
   WorkflowActionResponse,
   WorkflowCancelResponse,
   WorkflowDetailResponse,
+  ZipIngestionStatusResponse,
 } from '../models/index';
 import {
     ErrorResponseFromJSON,
@@ -38,6 +39,8 @@ import {
     WorkflowCancelResponseToJSON,
     WorkflowDetailResponseFromJSON,
     WorkflowDetailResponseToJSON,
+    ZipIngestionStatusResponseFromJSON,
+    ZipIngestionStatusResponseToJSON,
 } from '../models/index';
 
 export interface CancelTemporalWorkflowRequest {
@@ -56,6 +59,10 @@ export interface GetTemporalWorkflowStatusRequest {
     workflowId: string;
 }
 
+export interface GetZipIngestionStatusRequest {
+    workflowId: string;
+}
+
 export interface ListDvWorkflowsRequest {
     limit?: number;
     offset?: number;
@@ -164,6 +171,30 @@ export interface SystemJobsApiInterface {
      */
     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 (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
+     * @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 (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
+     * 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
@@ -417,6 +448,61 @@ export class SystemJobsApi extends runtime.BaseAPI implements SystemJobsApiInter
         return await response.value();
     }
 
+    /**
+     * Creates request options for getZipIngestionStatus without sending the request
+     */
+    async getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['workflowId'] == null) {
+            throw new runtime.RequiredError(
+                'workflowId',
+                'Required parameter "workflowId" was null or undefined when calling getZipIngestionStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await 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 (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
+     * Get Zip Ingestion Status Handler
+     */
+    async getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>> {
+        const requestOptions = await this.getZipIngestionStatusRequestOpts(requestParameters);
+        const response = await 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 (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
+     * Get Zip Ingestion Status Handler
+     */
+    async getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse> {
+        const response = await this.getZipIngestionStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listDvWorkflows without sending the request
      */

package/src/models/DocumentVersionMetadata.ts

@@ -170,6 +170,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 const DocumentVersionMetadataPropertyValidationAttributesMap: {
     [property: string]: {
@@ -226,6 +232,7 @@ export function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscrimina
         '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'],
     };
 }
 
@@ -260,6 +267,7 @@ export function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetada
         'quota_page_count': value['quotaPageCount'],
         'quota_idempotency_key': value['quotaIdempotencyKey'],
         'file_md5': value['fileMd5'],
+        'idempotency_key': value['idempotencyKey'],
     };
 }
 

package/src/models/IngestZipResponse.ts

@@ -22,41 +22,28 @@ import {
 } from './ZipFileResult';
 
 /**
- * Aggregate response from a ZIP ingestion batch.
+ * Response from dispatching a ZIP archive to async ingestion.
+ * 
+ * ``workflow_id`` is the fan-out workflow to poll at
+ * ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes;
+ * it is None when the archive held no ingestible members. ``skipped`` are the
+ * artifact/error entries resolved synchronously during classification.
  * @export
  * @interface IngestZipResponse
  */
 export interface IngestZipResponse {
     /**
      * 
-     * @type {Array<ZipFileResult>}
-     * @memberof IngestZipResponse
-     */
-    files: Array<ZipFileResult>;
-    /**
-     * 
-     * @type {number}
+     * @type {string}
      * @memberof IngestZipResponse
      */
-    totalFound: number;
+    workflowId: string | null;
     /**
      * 
-     * @type {number}
-     * @memberof IngestZipResponse
-     */
-    succeeded: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof IngestZipResponse
-     */
-    skipped: number;
-    /**
-     * 
-     * @type {number}
+     * @type {Array<ZipFileResult>}
      * @memberof IngestZipResponse
      */
-    failed: number;
+    skipped: Array<ZipFileResult>;
 }
 export const IngestZipResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -80,11 +67,8 @@ export const IngestZipResponsePropertyValidationAttributesMap: {
  * Check if a given object implements the IngestZipResponse interface.
  */
 export function instanceOfIngestZipResponse(value: object): value is IngestZipResponse {
-    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 (!('workflowId' in value) || value['workflowId'] === undefined) return false;
     if (!('skipped' in value) || value['skipped'] === undefined) return false;
-    if (!('failed' in value) || value['failed'] === undefined) return false;
     return true;
 }
 
@@ -98,11 +82,8 @@ export function IngestZipResponseFromJSONTyped(json: any, ignoreDiscriminator: b
     }
     return {
         
-        'files': ((json['files'] as Array<any>).map(ZipFileResultFromJSON)),
-        'totalFound': json['total_found'],
-        'succeeded': json['succeeded'],
-        'skipped': json['skipped'],
-        'failed': json['failed'],
+        'workflowId': json['workflow_id'],
+        'skipped': ((json['skipped'] as Array<any>).map(ZipFileResultFromJSON)),
     };
 }
 
@@ -117,11 +98,8 @@ export function IngestZipResponseToJSONTyped(value?: IngestZipResponse | null, i
 
     return {
         
-        'files': ((value['files'] as Array<any>).map(ZipFileResultToJSON)),
-        'total_found': value['totalFound'],
-        'succeeded': value['succeeded'],
-        'skipped': value['skipped'],
-        'failed': value['failed'],
+        'workflow_id': value['workflowId'],
+        'skipped': ((value['skipped'] as Array<any>).map(ZipFileResultToJSON)),
     };
 }