@knowledge-stack/ksapi 2.4.3 → 2.6.0

package/src/models/EmailMetadata.ts

@@ -0,0 +1,183 @@
+/* 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

@@ -0,0 +1,91 @@
+/* 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'],
+    };
+}
+

package/src/models/EventResponse.ts

@@ -69,6 +69,12 @@ export interface EventResponse {
      * @memberof EventResponse
      */
     actorUserId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EventResponse
+     */
+    actorOnBehalfOf?: string | null;
     /**
      * 
      * @type {{ [key: string]: any; }}
@@ -158,6 +164,7 @@ export function EventResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'kind': json['kind'],
         'ts': (new Date(json['ts'])),
         'actorUserId': json['actor_user_id'],
+        'actorOnBehalfOf': json['actor_on_behalf_of'] == null ? undefined : json['actor_on_behalf_of'],
         'payload': json['payload'],
         'actor': json['actor'] == null ? undefined : UserInfoFromJSON(json['actor']),
         'subjectName': json['subject_name'] == null ? undefined : json['subject_name'],
@@ -184,6 +191,7 @@ export function EventResponseToJSONTyped(value?: EventResponse | null, ignoreDis
         'kind': value['kind'],
         'ts': value['ts'].toISOString(),
         'actor_user_id': value['actorUserId'],
+        'actor_on_behalf_of': value['actorOnBehalfOf'],
         'payload': value['payload'],
         'actor': UserInfoToJSON(value['actor']),
         'subject_name': value['subjectName'],

package/src/models/ImageTaxonomy.ts

@@ -19,6 +19,7 @@
  */
 export const ImageTaxonomy = {
     Picture: 'picture',
+    Slide: 'slide',
     Flowchart: 'flowchart'
 } as const;
 export type ImageTaxonomy = typeof ImageTaxonomy[keyof typeof ImageTaxonomy];

package/src/models/IngestDocumentResponse.ts

@@ -37,6 +37,24 @@ 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]: {
@@ -79,6 +97,9 @@ 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'],
     };
 }
 
@@ -96,6 +117,9 @@ 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/SegmentSpan.ts

@@ -16,8 +16,9 @@ import { mapValues } from '../runtime';
 /**
  * One ASR segment's span inside a media chunk (media chunks only).
  * 
- * Field names are deliberately compact — a media document stores hundreds
- * of chunks x up to ~15 spans each in ``chunk_metadata`` JSONB.
+ * Field names are deliberately compact — a media document stores hundreds of
+ * chunks x tens of spans each in ``chunk_metadata`` JSONB. Measured worst
+ * case is a 4-hour Mandarin recording: 175 chunks x ~33 spans, ~190 KB total.
  * @export
  * @interface SegmentSpan
  */
@@ -40,6 +41,12 @@ export interface SegmentSpan {
      * @memberof SegmentSpan
      */
     c: number;
+    /**
+     * Speaker label for this segment, 0-indexed within the recording. It identifies turns, not people — there is no voiceprint enrollment, so label 0 in one meeting is unrelated to label 0 in another. None when the ASR provider does not diarize.
+     * @type {number}
+     * @memberof SegmentSpan
+     */
+    k?: number | null;
 }
 export const SegmentSpanPropertyValidationAttributesMap: {
     [property: string]: {
@@ -82,6 +89,7 @@ export function SegmentSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean
         's': json['s'],
         'e': json['e'],
         'c': json['c'],
+        'k': json['k'] == null ? undefined : json['k'],
     };
 }
 
@@ -99,6 +107,7 @@ export function SegmentSpanToJSONTyped(value?: SegmentSpan | null, ignoreDiscrim
         's': value['s'],
         'e': value['e'],
         'c': value['c'],
+        'k': value['k'],
     };
 }
 

package/src/models/index.ts

@@ -2,6 +2,8 @@
 /* eslint-disable */
 export * from './AcceptDisclaimerRequest';
 export * from './AcceptInviteResponse';
+export * from './AcceptTenantInvitationRequest';
+export * from './AcceptTenantInvitationResponse';
 export * from './AccessCheckResponse';
 export * from './ActivateSkillVersionRequest';
 export * from './AddMemberRequest';
@@ -129,6 +131,8 @@ 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';