@knowledge-stack/ksapi 1.145.1 → 1.147.0

package/src/models/ZipFileResult.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';
+/**
+ * Per-file outcome from a ZIP ingestion batch.
+ * @export
+ * @interface ZipFileResult
+ */
+export interface ZipFileResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    zipPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    documentVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    workflowId?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ZipFileResult
+     */
+    skipped?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ZipFileResult
+     */
+    error?: string | null;
+}
+export const ZipFileResultPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the ZipFileResult interface.
+ */
+export function instanceOfZipFileResult(value: object): value is ZipFileResult {
+    if (!('zipPath' in value) || value['zipPath'] === undefined) return false;
+    return true;
+}
+
+export function ZipFileResultFromJSON(json: any): ZipFileResult {
+    return ZipFileResultFromJSONTyped(json, false);
+}
+
+export function ZipFileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZipFileResult {
+    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'],
+        'skipped': json['skipped'] == null ? undefined : json['skipped'],
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+
+export function ZipFileResultToJSON(json: any): ZipFileResult {
+    return ZipFileResultToJSONTyped(json, false);
+}
+
+export function ZipFileResultToJSONTyped(value?: ZipFileResult | 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'],
+        'skipped': value['skipped'],
+        'error': value['error'],
+    };
+}
+

package/src/models/index.ts

@@ -141,6 +141,7 @@ export * from './IdpType';
 export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
+export * from './IngestZipResponse';
 export * from './IngestionMode';
 export * from './Input';
 export * from './InputOrigin';
@@ -359,3 +360,4 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './ZipFileResult';