@knowledge-stack/ksapi 1.149.1 → 1.151.0

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

@@ -225,7 +225,6 @@ export * from './PixelRegion';
 export * from './Polygon';
 export * from './PolygonReference';
 export * from './ProposeMemoryChunkRequest';
-export * from './ProposedMemoryChunkResponse';
 export * from './ReasoningPart';
 export * from './ReferenceType';
 export * from './ReorderPathPartRequest';
@@ -363,3 +362,5 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './ZipFileResult';
+export * from './ZipIngestionStatusResponse';
+export * from './ZipMemberStatusResponse';

package/docs/ProposedMemoryChunkResponse.md

@@ -1,48 +0,0 @@
-
-# ProposedMemoryChunkResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`chunkId` | string
-`scope` | [MemoryScope](MemoryScope.md)
-`ownerPathPartId` | string
-`kind` | [MemoryKind](MemoryKind.md)
-`rationale` | string
-`body` | string
-`proposerTenantUserId` | string
-`runId` | string
-
-## Example
-
-```typescript
-import type { ProposedMemoryChunkResponse } from '@knowledge-stack/ksapi'
-
-// TODO: Update the object below with actual values
-const example = {
-  "chunkId": null,
-  "scope": null,
-  "ownerPathPartId": null,
-  "kind": null,
-  "rationale": null,
-  "body": null,
-  "proposerTenantUserId": null,
-  "runId": null,
-} satisfies ProposedMemoryChunkResponse
-
-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 ProposedMemoryChunkResponse
-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/src/models/ProposedMemoryChunkResponse.ts

@@ -1,163 +0,0 @@
-/* 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 { MemoryScope } from './MemoryScope';
-import {
-    MemoryScopeFromJSON,
-    MemoryScopeFromJSONTyped,
-    MemoryScopeToJSON,
-    MemoryScopeToJSONTyped,
-} from './MemoryScope';
-import type { MemoryKind } from './MemoryKind';
-import {
-    MemoryKindFromJSON,
-    MemoryKindFromJSONTyped,
-    MemoryKindToJSON,
-    MemoryKindToJSONTyped,
-} from './MemoryKind';
-
-/**
- * 
- * @export
- * @interface ProposedMemoryChunkResponse
- */
-export interface ProposedMemoryChunkResponse {
-    /**
-     * 
-     * @type {string}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    chunkId: string;
-    /**
-     * 
-     * @type {MemoryScope}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    scope: MemoryScope;
-    /**
-     * 
-     * @type {string}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    ownerPathPartId: string;
-    /**
-     * 
-     * @type {MemoryKind}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    kind: MemoryKind;
-    /**
-     * 
-     * @type {string}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    rationale: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    body: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    proposerTenantUserId: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ProposedMemoryChunkResponse
-     */
-    runId: string | null;
-}
-
-
-export const ProposedMemoryChunkResponsePropertyValidationAttributesMap: {
-    [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 ProposedMemoryChunkResponse interface.
- */
-export function instanceOfProposedMemoryChunkResponse(value: object): value is ProposedMemoryChunkResponse {
-    if (!('chunkId' in value) || value['chunkId'] === undefined) return false;
-    if (!('scope' in value) || value['scope'] === undefined) return false;
-    if (!('ownerPathPartId' in value) || value['ownerPathPartId'] === undefined) return false;
-    if (!('kind' in value) || value['kind'] === undefined) return false;
-    if (!('rationale' in value) || value['rationale'] === undefined) return false;
-    if (!('body' in value) || value['body'] === undefined) return false;
-    if (!('proposerTenantUserId' in value) || value['proposerTenantUserId'] === undefined) return false;
-    if (!('runId' in value) || value['runId'] === undefined) return false;
-    return true;
-}
-
-export function ProposedMemoryChunkResponseFromJSON(json: any): ProposedMemoryChunkResponse {
-    return ProposedMemoryChunkResponseFromJSONTyped(json, false);
-}
-
-export function ProposedMemoryChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProposedMemoryChunkResponse {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'chunkId': json['chunk_id'],
-        'scope': MemoryScopeFromJSON(json['scope']),
-        'ownerPathPartId': json['owner_path_part_id'],
-        'kind': MemoryKindFromJSON(json['kind']),
-        'rationale': json['rationale'],
-        'body': json['body'],
-        'proposerTenantUserId': json['proposer_tenant_user_id'],
-        'runId': json['run_id'],
-    };
-}
-
-export function ProposedMemoryChunkResponseToJSON(json: any): ProposedMemoryChunkResponse {
-    return ProposedMemoryChunkResponseToJSONTyped(json, false);
-}
-
-export function ProposedMemoryChunkResponseToJSONTyped(value?: ProposedMemoryChunkResponse | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'chunk_id': value['chunkId'],
-        'scope': MemoryScopeToJSON(value['scope']),
-        'owner_path_part_id': value['ownerPathPartId'],
-        'kind': MemoryKindToJSON(value['kind']),
-        'rationale': value['rationale'],
-        'body': value['body'],
-        'proposer_tenant_user_id': value['proposerTenantUserId'],
-        'run_id': value['runId'],
-    };
-}
-