@knowledge-stack/ksapi 3.7.0 → 3.8.0

package/src/models/IngestDocumentResponse.ts

@@ -37,24 +37,6 @@ export interface IngestDocumentResponse {
      * @memberof IngestDocumentResponse
      */
     documentVersionId: string;
-    /**
-     * Folder created to hold this upload and its members. Set for email uploads, which always nest inside their own folder; null for every other type, which ingest directly into path_part_id.
-     * @type {string}
-     * @memberof IngestDocumentResponse
-     */
-    folderId?: string | null;
-    /**
-     * Members found on an email upload, each becoming its own document beside the email: the attachments of a single message, or the messages of an .mbox archive (whose own attachments are then expanded one level deeper). Always 0 for non-email uploads. Null for a .pst, whose members are enumerated only by the worker fan-out — poll attachment_workflow_id for per-member outcomes.
-     * @type {number}
-     * @memberof IngestDocumentResponse
-     */
-    attachmentCount?: number | null;
-    /**
-     * Fan-out workflow ingesting the members. Poll GET /v1/system-jobs/zip-ingestions/{id} for per-member outcomes. Null when the upload had no ingestible members.
-     * @type {string}
-     * @memberof IngestDocumentResponse
-     */
-    attachmentWorkflowId?: string | null;
 }
 export const IngestDocumentResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -97,9 +79,6 @@ export function IngestDocumentResponseFromJSONTyped(json: any, ignoreDiscriminat
         'workflowId': json['workflow_id'],
         'documentId': json['document_id'],
         'documentVersionId': json['document_version_id'],
-        'folderId': json['folder_id'] == null ? undefined : json['folder_id'],
-        'attachmentCount': json['attachment_count'] == null ? undefined : json['attachment_count'],
-        'attachmentWorkflowId': json['attachment_workflow_id'] == null ? undefined : json['attachment_workflow_id'],
     };
 }
 
@@ -117,9 +96,6 @@ export function IngestDocumentResponseToJSONTyped(value?: IngestDocumentResponse
         'workflow_id': value['workflowId'],
         'document_id': value['documentId'],
         'document_version_id': value['documentVersionId'],
-        'folder_id': value['folderId'],
-        'attachment_count': value['attachmentCount'],
-        'attachment_workflow_id': value['attachmentWorkflowId'],
     };
 }
 

package/src/models/PipelineState.ts

@@ -20,6 +20,13 @@ import {
     PipelineStatusToJSON,
     PipelineStatusToJSONTyped,
 } from './PipelineStatus';
+import type { ImageTaxonomy } from './ImageTaxonomy';
+import {
+    ImageTaxonomyFromJSON,
+    ImageTaxonomyFromJSONTyped,
+    ImageTaxonomyToJSON,
+    ImageTaxonomyToJSONTyped,
+} from './ImageTaxonomy';
 import type { IngestionMode } from './IngestionMode';
 import {
     IngestionModeFromJSON,
@@ -60,7 +67,7 @@ export interface PipelineState {
      */
     lastStateUpdateTimestamp?: Date | null;
     /**
-     * Name of the last activity that executed (e.g., 'document_preparation')
+     * Name of the last activity that executed (e.g., 'pdf_preparation_activity')
      * @type {string}
      * @memberof PipelineState
      */
@@ -101,6 +108,12 @@ export interface PipelineState {
      * @memberof PipelineState
      */
     chunkType?: ChunkType;
+    /**
+     * 
+     * @type {ImageTaxonomy}
+     * @memberof PipelineState
+     */
+    secondaryTaxonomy?: ImageTaxonomy;
 }
 
 
@@ -150,6 +163,7 @@ export function PipelineStateFromJSONTyped(json: any, ignoreDiscriminator: boole
         'pageDpi': json['page_dpi'] == null ? undefined : json['page_dpi'],
         'ingestionMode': json['ingestion_mode'] == null ? undefined : IngestionModeFromJSON(json['ingestion_mode']),
         'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
+        'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : ImageTaxonomyFromJSON(json['secondary_taxonomy']),
     };
 }
 
@@ -174,6 +188,7 @@ export function PipelineStateToJSONTyped(value?: PipelineState | null, ignoreDis
         'page_dpi': value['pageDpi'],
         'ingestion_mode': IngestionModeToJSON(value['ingestionMode']),
         'chunk_type': ChunkTypeToJSON(value['chunkType']),
+        'secondary_taxonomy': ImageTaxonomyToJSON(value['secondaryTaxonomy']),
     };
 }
 

package/src/models/UploadFormat.ts

@@ -31,6 +31,12 @@ export interface UploadFormat {
      * @memberof UploadFormat
      */
     contentType: string;
+    /**
+     * Largest file of this format the buffered uploads accept (new document, new version, ZIP member, workflow-run file). A new audio/video document uses the resumable upload, capped at upload.max_media_bytes
+     * @type {number}
+     * @memberof UploadFormat
+     */
+    maxBytes: number;
 }
 export const UploadFormatPropertyValidationAttributesMap: {
     [property: string]: {
@@ -56,6 +62,7 @@ export const UploadFormatPropertyValidationAttributesMap: {
 export function instanceOfUploadFormat(value: object): value is UploadFormat {
     if (!('extension' in value) || value['extension'] === undefined) return false;
     if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    if (!('maxBytes' in value) || value['maxBytes'] === undefined) return false;
     return true;
 }
 
@@ -71,6 +78,7 @@ export function UploadFormatFromJSONTyped(json: any, ignoreDiscriminator: boolea
         
         'extension': json['extension'],
         'contentType': json['content_type'],
+        'maxBytes': json['max_bytes'],
     };
 }
 
@@ -87,6 +95,7 @@ export function UploadFormatToJSONTyped(value?: UploadFormat | null, ignoreDiscr
         
         'extension': value['extension'],
         'content_type': value['contentType'],
+        'max_bytes': value['maxBytes'],
     };
 }
 

package/src/models/index.ts

@@ -134,8 +134,6 @@ export * from './DocxParagraphAnchorInput';
 export * from './DocxParagraphAnchorOutput';
 export * from './DownloadArtifact';
 export * from './EditMemoryChunkRequest';
-export * from './EmailMetadata';
-export * from './EmailParty';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
 export * from './EnrichedCitation';

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

@@ -1,119 +0,0 @@
-/**
- * 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 type { EmailParty } from './EmailParty';
-/**
- * Structured headers of an ingested email (EMAIL document type only).
- *
- * Populated by ``document_preparation_activity`` from the same parse that
- * renders the message body, so the stored metadata and the rendered document
- * cannot disagree. Null on a multi-message archive: its messages are ingested
- * as their own documents, and each carries its own block.
- * @export
- * @interface EmailMetadata
- */
-export interface EmailMetadata {
-    /**
-     * Message subject
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    subject?: string;
-    /**
-     * Sender; null if unparseable
-     * @type {EmailParty}
-     * @memberof EmailMetadata
-     */
-    sender?: EmailParty | null;
-    /**
-     * To recipients
-     * @type {Array<EmailParty>}
-     * @memberof EmailMetadata
-     */
-    to?: Array<EmailParty>;
-    /**
-     * Cc recipients
-     * @type {Array<EmailParty>}
-     * @memberof EmailMetadata
-     */
-    cc?: Array<EmailParty>;
-    /**
-     * Bcc recipients. Present only when the source file carries them — a sending MTA strips Bcc, so it survives in the sender's own copy (a .msg exported from Sent Items) but never in a received .eml.
-     * @type {Array<EmailParty>}
-     * @memberof EmailMetadata
-     */
-    bcc?: Array<EmailParty>;
-    /**
-     * Date header, as written
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    sentAt?: string;
-    /**
-     * RFC 5322 Message-ID
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    messageId?: string;
-    /**
-     * Message-ID being replied to
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    inReplyTo?: string;
-    /**
-     * Reply chain, oldest first
-     * @type {Array<string>}
-     * @memberof EmailMetadata
-     */
-    references?: Array<string>;
-    /**
-     * Outlook PidTagConversationTopic (.msg only)
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    conversationTopic?: string;
-    /**
-     * Message-ID that started the thread — the first References entry, or this message's own id. Group by this to reconstruct a thread.
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    threadRootId?: string;
-    /**
-     * The verbatim header block, so a header this schema does not model stays recoverable without re-reading the source file.
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    rawHeaders?: string;
-}
-export declare const EmailMetadataPropertyValidationAttributesMap: {
-    [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 EmailMetadata interface.
- */
-export declare function instanceOfEmailMetadata(value: object): value is EmailMetadata;
-export declare function EmailMetadataFromJSON(json: any): EmailMetadata;
-export declare function EmailMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailMetadata;
-export declare function EmailMetadataToJSON(json: any): EmailMetadata;
-export declare function EmailMetadataToJSONTyped(value?: EmailMetadata | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EmailMetadata.js

@@ -1,65 +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 { EmailPartyFromJSON, EmailPartyToJSON, } from './EmailParty';
-export const EmailMetadataPropertyValidationAttributesMap = {};
-/**
- * Check if a given object implements the EmailMetadata interface.
- */
-export function instanceOfEmailMetadata(value) {
-    return true;
-}
-export function EmailMetadataFromJSON(json) {
-    return EmailMetadataFromJSONTyped(json, false);
-}
-export function EmailMetadataFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'subject': json['subject'] == null ? undefined : json['subject'],
-        'sender': json['sender'] == null ? undefined : EmailPartyFromJSON(json['sender']),
-        'to': json['to'] == null ? undefined : (json['to'].map(EmailPartyFromJSON)),
-        'cc': json['cc'] == null ? undefined : (json['cc'].map(EmailPartyFromJSON)),
-        'bcc': json['bcc'] == null ? undefined : (json['bcc'].map(EmailPartyFromJSON)),
-        'sentAt': json['sent_at'] == null ? undefined : json['sent_at'],
-        'messageId': json['message_id'] == null ? undefined : json['message_id'],
-        'inReplyTo': json['in_reply_to'] == null ? undefined : json['in_reply_to'],
-        'references': json['references'] == null ? undefined : json['references'],
-        'conversationTopic': json['conversation_topic'] == null ? undefined : json['conversation_topic'],
-        'threadRootId': json['thread_root_id'] == null ? undefined : json['thread_root_id'],
-        'rawHeaders': json['raw_headers'] == null ? undefined : json['raw_headers'],
-    };
-}
-export function EmailMetadataToJSON(json) {
-    return EmailMetadataToJSONTyped(json, false);
-}
-export function EmailMetadataToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'subject': value['subject'],
-        'sender': EmailPartyToJSON(value['sender']),
-        'to': value['to'] == null ? undefined : (value['to'].map(EmailPartyToJSON)),
-        'cc': value['cc'] == null ? undefined : (value['cc'].map(EmailPartyToJSON)),
-        'bcc': value['bcc'] == null ? undefined : (value['bcc'].map(EmailPartyToJSON)),
-        'sent_at': value['sentAt'],
-        'message_id': value['messageId'],
-        'in_reply_to': value['inReplyTo'],
-        'references': value['references'],
-        'conversation_topic': value['conversationTopic'],
-        'thread_root_id': value['threadRootId'],
-        'raw_headers': value['rawHeaders'],
-    };
-}

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

@@ -1,53 +0,0 @@
-/**
- * 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.
- */
-/**
- * One email participant.
- * @export
- * @interface EmailParty
- */
-export interface EmailParty {
-    /**
-     * Display name; empty if unnamed
-     * @type {string}
-     * @memberof EmailParty
-     */
-    name?: string;
-    /**
-     * Email address
-     * @type {string}
-     * @memberof EmailParty
-     */
-    address: string;
-}
-export declare const EmailPartyPropertyValidationAttributesMap: {
-    [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 EmailParty interface.
- */
-export declare function instanceOfEmailParty(value: object): value is EmailParty;
-export declare function EmailPartyFromJSON(json: any): EmailParty;
-export declare function EmailPartyFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailParty;
-export declare function EmailPartyToJSON(json: any): EmailParty;
-export declare function EmailPartyToJSONTyped(value?: EmailParty | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EmailParty.js

@@ -1,46 +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.
- */
-export const EmailPartyPropertyValidationAttributesMap = {};
-/**
- * Check if a given object implements the EmailParty interface.
- */
-export function instanceOfEmailParty(value) {
-    if (!('address' in value) || value['address'] === undefined)
-        return false;
-    return true;
-}
-export function EmailPartyFromJSON(json) {
-    return EmailPartyFromJSONTyped(json, false);
-}
-export function EmailPartyFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'name': json['name'] == null ? undefined : json['name'],
-        'address': json['address'],
-    };
-}
-export function EmailPartyToJSON(json) {
-    return EmailPartyToJSONTyped(json, false);
-}
-export function EmailPartyToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'name': value['name'],
-        'address': value['address'],
-    };
-}

package/dist/models/EmailMetadata.d.ts

@@ -1,119 +0,0 @@
-/**
- * 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 type { EmailParty } from './EmailParty';
-/**
- * Structured headers of an ingested email (EMAIL document type only).
- *
- * Populated by ``document_preparation_activity`` from the same parse that
- * renders the message body, so the stored metadata and the rendered document
- * cannot disagree. Null on a multi-message archive: its messages are ingested
- * as their own documents, and each carries its own block.
- * @export
- * @interface EmailMetadata
- */
-export interface EmailMetadata {
-    /**
-     * Message subject
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    subject?: string;
-    /**
-     * Sender; null if unparseable
-     * @type {EmailParty}
-     * @memberof EmailMetadata
-     */
-    sender?: EmailParty | null;
-    /**
-     * To recipients
-     * @type {Array<EmailParty>}
-     * @memberof EmailMetadata
-     */
-    to?: Array<EmailParty>;
-    /**
-     * Cc recipients
-     * @type {Array<EmailParty>}
-     * @memberof EmailMetadata
-     */
-    cc?: Array<EmailParty>;
-    /**
-     * Bcc recipients. Present only when the source file carries them — a sending MTA strips Bcc, so it survives in the sender's own copy (a .msg exported from Sent Items) but never in a received .eml.
-     * @type {Array<EmailParty>}
-     * @memberof EmailMetadata
-     */
-    bcc?: Array<EmailParty>;
-    /**
-     * Date header, as written
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    sentAt?: string;
-    /**
-     * RFC 5322 Message-ID
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    messageId?: string;
-    /**
-     * Message-ID being replied to
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    inReplyTo?: string;
-    /**
-     * Reply chain, oldest first
-     * @type {Array<string>}
-     * @memberof EmailMetadata
-     */
-    references?: Array<string>;
-    /**
-     * Outlook PidTagConversationTopic (.msg only)
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    conversationTopic?: string;
-    /**
-     * Message-ID that started the thread — the first References entry, or this message's own id. Group by this to reconstruct a thread.
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    threadRootId?: string;
-    /**
-     * The verbatim header block, so a header this schema does not model stays recoverable without re-reading the source file.
-     * @type {string}
-     * @memberof EmailMetadata
-     */
-    rawHeaders?: string;
-}
-export declare const EmailMetadataPropertyValidationAttributesMap: {
-    [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 EmailMetadata interface.
- */
-export declare function instanceOfEmailMetadata(value: object): value is EmailMetadata;
-export declare function EmailMetadataFromJSON(json: any): EmailMetadata;
-export declare function EmailMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailMetadata;
-export declare function EmailMetadataToJSON(json: any): EmailMetadata;
-export declare function EmailMetadataToJSONTyped(value?: EmailMetadata | null, ignoreDiscriminator?: boolean): any;

package/dist/models/EmailMetadata.js

@@ -1,73 +0,0 @@
-"use strict";
-/* 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmailMetadataPropertyValidationAttributesMap = void 0;
-exports.instanceOfEmailMetadata = instanceOfEmailMetadata;
-exports.EmailMetadataFromJSON = EmailMetadataFromJSON;
-exports.EmailMetadataFromJSONTyped = EmailMetadataFromJSONTyped;
-exports.EmailMetadataToJSON = EmailMetadataToJSON;
-exports.EmailMetadataToJSONTyped = EmailMetadataToJSONTyped;
-const EmailParty_1 = require("./EmailParty");
-exports.EmailMetadataPropertyValidationAttributesMap = {};
-/**
- * Check if a given object implements the EmailMetadata interface.
- */
-function instanceOfEmailMetadata(value) {
-    return true;
-}
-function EmailMetadataFromJSON(json) {
-    return EmailMetadataFromJSONTyped(json, false);
-}
-function EmailMetadataFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'subject': json['subject'] == null ? undefined : json['subject'],
-        'sender': json['sender'] == null ? undefined : (0, EmailParty_1.EmailPartyFromJSON)(json['sender']),
-        'to': json['to'] == null ? undefined : (json['to'].map(EmailParty_1.EmailPartyFromJSON)),
-        'cc': json['cc'] == null ? undefined : (json['cc'].map(EmailParty_1.EmailPartyFromJSON)),
-        'bcc': json['bcc'] == null ? undefined : (json['bcc'].map(EmailParty_1.EmailPartyFromJSON)),
-        'sentAt': json['sent_at'] == null ? undefined : json['sent_at'],
-        'messageId': json['message_id'] == null ? undefined : json['message_id'],
-        'inReplyTo': json['in_reply_to'] == null ? undefined : json['in_reply_to'],
-        'references': json['references'] == null ? undefined : json['references'],
-        'conversationTopic': json['conversation_topic'] == null ? undefined : json['conversation_topic'],
-        'threadRootId': json['thread_root_id'] == null ? undefined : json['thread_root_id'],
-        'rawHeaders': json['raw_headers'] == null ? undefined : json['raw_headers'],
-    };
-}
-function EmailMetadataToJSON(json) {
-    return EmailMetadataToJSONTyped(json, false);
-}
-function EmailMetadataToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'subject': value['subject'],
-        'sender': (0, EmailParty_1.EmailPartyToJSON)(value['sender']),
-        'to': value['to'] == null ? undefined : (value['to'].map(EmailParty_1.EmailPartyToJSON)),
-        'cc': value['cc'] == null ? undefined : (value['cc'].map(EmailParty_1.EmailPartyToJSON)),
-        'bcc': value['bcc'] == null ? undefined : (value['bcc'].map(EmailParty_1.EmailPartyToJSON)),
-        'sent_at': value['sentAt'],
-        'message_id': value['messageId'],
-        'in_reply_to': value['inReplyTo'],
-        'references': value['references'],
-        'conversation_topic': value['conversationTopic'],
-        'thread_root_id': value['threadRootId'],
-        'raw_headers': value['rawHeaders'],
-    };
-}