@knowledge-stack/ksapi 1.149.0 → 1.150.0

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. 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
@@ -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. 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
+     */
+    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. 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
+     */
+    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)),
     };
 }
 

package/src/models/ZipIngestionStatusResponse.ts

@@ -0,0 +1,113 @@
+/* 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 { mapValues } from '../runtime';
+import type { ZipMemberStatusResponse } from './ZipMemberStatusResponse';
+import {
+    ZipMemberStatusResponseFromJSON,
+    ZipMemberStatusResponseFromJSONTyped,
+    ZipMemberStatusResponseToJSON,
+    ZipMemberStatusResponseToJSONTyped,
+} from './ZipMemberStatusResponse';
+
+/**
+ * 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``).
+ * @export
+ * @interface ZipIngestionStatusResponse
+ */
+export interface ZipIngestionStatusResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipIngestionStatusResponse
+     */
+    workflowId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipIngestionStatusResponse
+     */
+    temporalStatus: string;
+    /**
+     * 
+     * @type {Array<ZipMemberStatusResponse>}
+     * @memberof ZipIngestionStatusResponse
+     */
+    files: Array<ZipMemberStatusResponse>;
+}
+export const ZipIngestionStatusResponsePropertyValidationAttributesMap: {
+    [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 ZipIngestionStatusResponse interface.
+ */
+export function instanceOfZipIngestionStatusResponse(value: object): value is ZipIngestionStatusResponse {
+    if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
+    if (!('temporalStatus' in value) || value['temporalStatus'] === undefined) return false;
+    if (!('files' in value) || value['files'] === undefined) return false;
+    return true;
+}
+
+export function ZipIngestionStatusResponseFromJSON(json: any): ZipIngestionStatusResponse {
+    return ZipIngestionStatusResponseFromJSONTyped(json, false);
+}
+
+export function ZipIngestionStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipIngestionStatusResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'workflowId': json['workflow_id'],
+        'temporalStatus': json['temporal_status'],
+        'files': ((json['files'] as Array<any>).map(ZipMemberStatusResponseFromJSON)),
+    };
+}
+
+export function ZipIngestionStatusResponseToJSON(json: any): ZipIngestionStatusResponse {
+    return ZipIngestionStatusResponseToJSONTyped(json, false);
+}
+
+export function ZipIngestionStatusResponseToJSONTyped(value?: ZipIngestionStatusResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'workflow_id': value['workflowId'],
+        'temporal_status': value['temporalStatus'],
+        'files': ((value['files'] as Array<any>).map(ZipMemberStatusResponseToJSON)),
+    };
+}
+

package/src/models/ZipMemberStatusResponse.ts

@@ -0,0 +1,123 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * One member's outcome within a ZIP fan-out (from the workflow query).
+ * @export
+ * @interface ZipMemberStatusResponse
+ */
+export interface ZipMemberStatusResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    zipPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    documentId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    documentVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    workflowId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipMemberStatusResponse
+     */
+    error?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ZipMemberStatusResponse
+     */
+    skipped?: boolean;
+}
+export const ZipMemberStatusResponsePropertyValidationAttributesMap: {
+    [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 ZipMemberStatusResponse interface.
+ */
+export function instanceOfZipMemberStatusResponse(value: object): value is ZipMemberStatusResponse {
+    if (!('zipPath' in value) || value['zipPath'] === undefined) return false;
+    return true;
+}
+
+export function ZipMemberStatusResponseFromJSON(json: any): ZipMemberStatusResponse {
+    return ZipMemberStatusResponseFromJSONTyped(json, false);
+}
+
+export function ZipMemberStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipMemberStatusResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'zipPath': json['zip_path'],
+        'documentId': json['document_id'] == null ? undefined : json['document_id'],
+        'documentVersionId': json['document_version_id'] == null ? undefined : json['document_version_id'],
+        'workflowId': json['workflow_id'] == null ? undefined : json['workflow_id'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+    };
+}
+
+export function ZipMemberStatusResponseToJSON(json: any): ZipMemberStatusResponse {
+    return ZipMemberStatusResponseToJSONTyped(json, false);
+}
+
+export function ZipMemberStatusResponseToJSONTyped(value?: ZipMemberStatusResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'zip_path': value['zipPath'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+        'workflow_id': value['workflowId'],
+        'error': value['error'],
+        'skipped': value['skipped'],
+    };
+}
+

package/src/models/index.ts

@@ -363,3 +363,5 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './ZipFileResult';
+export * from './ZipIngestionStatusResponse';
+export * from './ZipMemberStatusResponse';