@knowledge-stack/ksapi 3.7.0 → 3.8.0

package/dist/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/models/EmailParty.js

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

package/docs/EmailMetadata.md

@@ -1,57 +0,0 @@
-
-# EmailMetadata
-
-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.
-
-## Properties
-
-Name | Type
------------- | -------------
-`subject` | string
-`sender` | [EmailParty](EmailParty.md)
-`to` | [Array<EmailParty>](EmailParty.md)
-`cc` | [Array<EmailParty>](EmailParty.md)
-`bcc` | [Array<EmailParty>](EmailParty.md)
-`sentAt` | string
-`messageId` | string
-`inReplyTo` | string
-`references` | Array<string>
-`conversationTopic` | string
-`threadRootId` | string
-`rawHeaders` | string
-
-## Example
-
-```typescript
-import type { EmailMetadata } from '@knowledge-stack/ksapi'
-
-// TODO: Update the object below with actual values
-const example = {
-  "subject": null,
-  "sender": null,
-  "to": null,
-  "cc": null,
-  "bcc": null,
-  "sentAt": null,
-  "messageId": null,
-  "inReplyTo": null,
-  "references": null,
-  "conversationTopic": null,
-  "threadRootId": null,
-  "rawHeaders": null,
-} satisfies EmailMetadata
-
-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 EmailMetadata
-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/EmailParty.md

@@ -1,37 +0,0 @@
-
-# EmailParty
-
-One email participant.
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`address` | string
-
-## Example
-
-```typescript
-import type { EmailParty } from '@knowledge-stack/ksapi'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "address": null,
-} satisfies EmailParty
-
-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 EmailParty
-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/EmailMetadata.ts

@@ -1,183 +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 { EmailParty } from './EmailParty';
-import {
-    EmailPartyFromJSON,
-    EmailPartyFromJSONTyped,
-    EmailPartyToJSON,
-    EmailPartyToJSONTyped,
-} 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 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 function instanceOfEmailMetadata(value: object): value is EmailMetadata {
-    return true;
-}
-
-export function EmailMetadataFromJSON(json: any): EmailMetadata {
-    return EmailMetadataFromJSONTyped(json, false);
-}
-
-export function EmailMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailMetadata {
-    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'] as Array<any>).map(EmailPartyFromJSON)),
-        'cc': json['cc'] == null ? undefined : ((json['cc'] as Array<any>).map(EmailPartyFromJSON)),
-        'bcc': json['bcc'] == null ? undefined : ((json['bcc'] as Array<any>).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: any): EmailMetadata {
-    return EmailMetadataToJSONTyped(json, false);
-}
-
-export function EmailMetadataToJSONTyped(value?: EmailMetadata | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'subject': value['subject'],
-        'sender': EmailPartyToJSON(value['sender']),
-        'to': value['to'] == null ? undefined : ((value['to'] as Array<any>).map(EmailPartyToJSON)),
-        'cc': value['cc'] == null ? undefined : ((value['cc'] as Array<any>).map(EmailPartyToJSON)),
-        'bcc': value['bcc'] == null ? undefined : ((value['bcc'] as Array<any>).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/src/models/EmailParty.ts

@@ -1,91 +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';
-/**
- * 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 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 function instanceOfEmailParty(value: object): value is EmailParty {
-    if (!('address' in value) || value['address'] === undefined) return false;
-    return true;
-}
-
-export function EmailPartyFromJSON(json: any): EmailParty {
-    return EmailPartyFromJSONTyped(json, false);
-}
-
-export function EmailPartyFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailParty {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'name': json['name'] == null ? undefined : json['name'],
-        'address': json['address'],
-    };
-}
-
-export function EmailPartyToJSON(json: any): EmailParty {
-    return EmailPartyToJSONTyped(json, false);
-}
-
-export function EmailPartyToJSONTyped(value?: EmailParty | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'name': value['name'],
-        'address': value['address'],
-    };
-}
-