@aui.io/aui-client 1.2.41 → 3.0.0

package/dist/esm/api/types/AgentVersionPublishResponse.d.mts

@@ -0,0 +1,35 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * Returns the now-live (published) version.
+ *
+ * ``publish`` is the single verb that makes a version the agent's live one:
+ * it freezes a draft first, or just re-activates an already-published version
+ * (roll back / switch).
+ */
+export interface AgentVersionPublishResponse {
+    /** Version id */
+    id: string;
+    /** Owning agent id */
+    agent_id: string;
+    version_number: number;
+    version_revision_number: number;
+    /** Canonical tag, e.g. 'v3.2' */
+    version_tag: string;
+    status: AgentVersionPublishResponse.Status;
+    /** Lineage: cloned from */
+    parent_version_id?: string;
+    label?: string;
+    tags?: string[];
+    notes?: string;
+    stats?: Apollo.VersionStats;
+    created_at: string;
+    published_at?: string;
+}
+export declare namespace AgentVersionPublishResponse {
+    const Status: {
+        readonly Draft: "draft";
+        readonly Published: "published";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/AgentVersionPublishResponse.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var AgentVersionPublishResponse;
+(function (AgentVersionPublishResponse) {
+    AgentVersionPublishResponse.Status = {
+        Draft: "draft",
+        Published: "published",
+        Archived: "archived",
+    };
+})(AgentVersionPublishResponse || (AgentVersionPublishResponse = {}));

package/dist/esm/api/types/AgentVersionPullResponse.d.mts

@@ -0,0 +1,14 @@
+/**
+ * A version's config bundle — full parity with agent-settings, clients
+ * already know this shape (per the original push/pull design).
+ */
+export interface AgentVersionPullResponse {
+    return_type?: string;
+    agent_id: string;
+    version_id: string;
+    version_tag: string;
+    /** Parsed agent-settings bundle */
+    bundle: Record<string, unknown>;
+    /** Cache-metadata expiry for this payload */
+    expires_at: string;
+}

package/dist/esm/api/types/AgentVersionPushResponse.d.mts

@@ -0,0 +1,16 @@
+/**
+ * Result of a push. ``gcs_key`` (raw storage path) is not exposed.
+ */
+export interface AgentVersionPushResponse {
+    agent_id: string;
+    version_id: string;
+    new_version_revision_number: number;
+    new_version_tag: string;
+    /** Id of the newly committed revision */
+    revision_id: string;
+    /** Hex-encoded SHA-256 of the canonical bundle bytes */
+    sha256: string;
+    size: number;
+    created_at: string;
+    commit_message?: string;
+}

package/dist/esm/api/types/AgentVersionUpdateResponse.d.mts

@@ -0,0 +1,31 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * Returns the updated version.
+ */
+export interface AgentVersionUpdateResponse {
+    /** Version id */
+    id: string;
+    /** Owning agent id */
+    agent_id: string;
+    version_number: number;
+    version_revision_number: number;
+    /** Canonical tag, e.g. 'v3.2' */
+    version_tag: string;
+    status: AgentVersionUpdateResponse.Status;
+    /** Lineage: cloned from */
+    parent_version_id?: string;
+    label?: string;
+    tags?: string[];
+    notes?: string;
+    stats?: Apollo.VersionStats;
+    created_at: string;
+    published_at?: string;
+}
+export declare namespace AgentVersionUpdateResponse {
+    const Status: {
+        readonly Draft: "draft";
+        readonly Published: "published";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/AgentVersionUpdateResponse.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var AgentVersionUpdateResponse;
+(function (AgentVersionUpdateResponse) {
+    AgentVersionUpdateResponse.Status = {
+        Draft: "draft",
+        Published: "published",
+        Archived: "archived",
+    };
+})(AgentVersionUpdateResponse || (AgentVersionUpdateResponse = {}));

package/dist/esm/api/types/ErrorBody.d.mts

@@ -0,0 +1,18 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * The error body an end user receives when interacting with Apollo.
+ *
+ * ``code`` is the stable, machine-readable branch point clients switch on.
+ * ``message`` is human-readable and explicitly NOT part of the contract --
+ * it may change at any time and must never be parsed.
+ */
+export interface ErrorBody {
+    /** Stable, namespaced machine code clients branch on (e.g. "not_found" or "agents.not_found"). THE branch point -- open/extensible, append-only. */
+    code: string;
+    /** Human-readable explanation. NOT part of the contract; may change anytime. Clients must never parse or branch on this. */
+    message: string;
+    /** Trace id for support correlation. */
+    request_id?: string;
+    /** Optional structured sub-errors (e.g. per-field validation failures). */
+    details?: Apollo.ErrorDetail[];
+}

package/dist/esm/api/types/ErrorDetail.d.mts

@@ -0,0 +1,7 @@
+/**
+ * A single structured sub-error (e.g. one field's validation failure).
+ */
+export interface ErrorDetail {
+    field?: string;
+    message: string;
+}

package/dist/esm/api/types/ErrorEnvelope.d.mts

@@ -0,0 +1,25 @@
+/**
+ * type=error — either a locally-generated error (seq -1) or a forwarded IA error.
+ */
+export interface ErrorEnvelope {
+    type?: "error";
+    data?: ErrorEnvelope.Data;
+    /** Monotonic sequence for gap detection / replay. Locally-generated errors use -1. */
+    seq: number;
+}
+export declare namespace ErrorEnvelope {
+    type Data = 
+    /**
+     * Locally generated (bad frame, wallet-gate denial, relay loss). */
+    {
+        error: string;
+        code?: number | undefined;
+    }
+    /**
+     * Forwarded IA error payload. */
+     | {
+        message?: string | undefined;
+        status_code?: number | undefined;
+        error_code?: string | undefined;
+    };
+}

package/dist/esm/api/types/ErrorResponse.d.mts

@@ -0,0 +1,7 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * The single envelope every Apollo error response conforms to.
+ */
+export interface ErrorResponse {
+    error: Apollo.ErrorBody;
+}

package/dist/esm/api/types/ErrorStreamEvent.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A recoverable error raised while processing the turn.
+ */
+export interface ErrorStreamEvent {
+    /** Monotonic sequence number; echo the last seen value via Last-Event-ID to resume. */
+    seq: number;
+    /** Error payload (message and, when available, a status code). */
+    data: Record<string, unknown>;
+}

package/dist/esm/api/types/EventEnvelope.d.mts

@@ -0,0 +1,10 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * type=event — a raw IA event forwarded per the allow-list.
+ */
+export interface EventEnvelope {
+    type?: "event";
+    data?: Apollo.IaEvent;
+    /** Monotonic sequence for gap detection / replay. Locally-generated errors use -1. */
+    seq: number;
+}

package/dist/esm/api/types/EventEnvelopeBase.d.mts

@@ -0,0 +1,15 @@
+export interface EventEnvelopeBase {
+    /** Monotonic sequence for gap detection / replay. Locally-generated errors use -1. */
+    seq: number;
+    type: EventEnvelopeBase.Type;
+    data?: unknown;
+}
+export declare namespace EventEnvelopeBase {
+    const Type: {
+        readonly Thread: "thread";
+        readonly Message: "message";
+        readonly Event: "event";
+        readonly Error: "error";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/esm/api/types/EventEnvelopeBase.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var EventEnvelopeBase;
+(function (EventEnvelopeBase) {
+    EventEnvelopeBase.Type = {
+        Thread: "thread",
+        Message: "message",
+        Event: "event",
+        Error: "error",
+    };
+})(EventEnvelopeBase || (EventEnvelopeBase = {}));

package/dist/esm/api/types/ExternalAgent.d.mts

@@ -0,0 +1,17 @@
+/**
+ * The published Agent shape.
+ */
+export interface ExternalAgent {
+    /** Agent id */
+    id: string;
+    /** Owning project id */
+    project_id: string;
+    /** Agent name */
+    name: string;
+    /** Tag of the currently deployed version; None until deployed */
+    live_version_id?: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Last update timestamp */
+    updated_at: string;
+}

package/dist/esm/api/types/ExternalAgentCreateResponse.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Returns the created agent.
+ */
+export interface ExternalAgentCreateResponse {
+    /** Agent id */
+    id: string;
+    /** Owning project id */
+    project_id: string;
+    /** Agent name */
+    name: string;
+    /** Tag of the currently deployed version; None until deployed */
+    live_version_id?: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Last update timestamp */
+    updated_at: string;
+}

package/dist/esm/api/types/ExternalAgentListFilters.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Query filters for listing agents in a project.
+ */
+export interface ExternalAgentListFilters {
+    /** Case-insensitive substring match on name */
+    name?: string;
+}

package/dist/esm/api/types/ExternalAgentUpdateResponse.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Returns the updated agent.
+ */
+export interface ExternalAgentUpdateResponse {
+    /** Agent id */
+    id: string;
+    /** Owning project id */
+    project_id: string;
+    /** Agent name */
+    name: string;
+    /** Tag of the currently deployed version; None until deployed */
+    live_version_id?: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Last update timestamp */
+    updated_at: string;
+}

package/dist/esm/api/types/ExternalPageAgentVersion.d.mts

@@ -0,0 +1,6 @@
+import type * as Apollo from "../index.mjs";
+export interface ExternalPageAgentVersion {
+    results: Apollo.AgentVersion[];
+    meta: Apollo.ExternalPageMeta;
+    links: Apollo.ExternalPageLinks;
+}

package/dist/esm/api/types/ExternalPageExternalAgent.d.mts

@@ -0,0 +1,6 @@
+import type * as Apollo from "../index.mjs";
+export interface ExternalPageExternalAgent {
+    results: Apollo.ExternalAgent[];
+    meta: Apollo.ExternalPageMeta;
+    links: Apollo.ExternalPageLinks;
+}

package/dist/esm/api/types/ExternalPageLinks.d.mts

@@ -0,0 +1,4 @@
+export interface ExternalPageLinks {
+    next?: string;
+    prev?: string;
+}

package/dist/esm/api/types/ExternalPageMeta.d.mts

@@ -0,0 +1,5 @@
+export interface ExternalPageMeta {
+    has_more: boolean;
+    after_cursor?: string;
+    before_cursor?: string;
+}

package/dist/esm/api/types/ExternalPageProject.d.mts

@@ -0,0 +1,6 @@
+import type * as Apollo from "../index.mjs";
+export interface ExternalPageProject {
+    results: Apollo.Project[];
+    meta: Apollo.ExternalPageMeta;
+    links: Apollo.ExternalPageLinks;
+}

package/dist/esm/api/types/ExternalPageThreadListItem.d.mts

@@ -0,0 +1,6 @@
+import type * as Apollo from "../index.mjs";
+export interface ExternalPageThreadListItem {
+    results: Apollo.ThreadListItem[];
+    meta: Apollo.ExternalPageMeta;
+    links: Apollo.ExternalPageLinks;
+}

package/dist/esm/api/types/GatewayHeaders.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Gateway-enriched upgrade-request headers.
+ */
+export interface GatewayHeaders {
+    /** Tenant scope. Absence closes the socket with 1008. */
+    "x-aui-organization-id": string;
+    /** Billing task-origin hint (e.g. playground / production). */
+    "x-aui-source"?: string;
+    /** Acting (logged-in) user; attributes an auto-created thread. */
+    "x-aui-user-id"?: string;
+    /** Shared gateway↔apollo service key (infra contract; not set by end clients). */
+    "x-api-key"?: string;
+}

package/dist/esm/api/types/HttpValidationError.d.mts

@@ -1,4 +1,4 @@
 import type * as Apollo from "../index.mjs";
 export interface HttpValidationError {
-    errors?: Apollo.ValidationError[];
+    detail?: Apollo.ValidationError[];
 }

package/dist/esm/api/types/IaEvent.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Raw IA event. Forwarded only when channel.event_name is in the active allow-list.
+ */
+export interface IaEvent {
+    channel?: IaEvent.Channel;
+    scope?: Record<string, unknown>;
+    /** Event-specific payload. */
+    data?: unknown;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace IaEvent {
+    interface Channel {
+        /** Default stream: thread-message-text-content-updated (token delta), thread-message-text-content-completed. Simulator adds user-message-text-content-completed and simulation-request-*. ?events=all|verbose adds the full pillar/workflow set. */
+        event_name?: string;
+    }
+}

package/dist/esm/api/types/InitiateThreadResponse.d.mts

@@ -0,0 +1,6 @@
+export interface InitiateThreadResponse {
+    /** Thread the opener landed on (new or continued). */
+    thread_id: string;
+    /** Provider message id for the sent opener. */
+    message_sid: string;
+}

package/dist/esm/api/types/Message.d.mts

@@ -1,14 +1,19 @@
 import type * as Apollo from "../index.mjs";
+/**
+ * One message in a thread transcript (the published, scrubbed shape).
+ */
 export interface Message {
+    /** Interaction id (or message id for interaction-less messages). */
     id: string;
-    created_at: string;
-    text: string;
-    sender: Apollo.MessageContactParty;
-    receiver: Apollo.MessageContactParty;
-    cards: Apollo.Card[];
+    /** ISO-8601. */
+    created_at?: string;
+    text?: string;
+    sender?: Apollo.MessageParty;
+    receiver?: Apollo.MessageParty;
+    cards?: Apollo.MessageCard[];
     welcome_message?: string;
-    followup_suggestions: string[];
-    executed_workflows?: string[];
+    followup_suggestions?: string[];
     url?: string;
-    trace_info?: Apollo.TraceInfo;
+    input_tokens?: number;
+    output_tokens?: number;
 }

package/dist/esm/api/types/MessageCard.d.mts

@@ -0,0 +1,7 @@
+export interface MessageCard {
+    name?: string;
+    category?: string;
+    rendered_jsx?: string;
+    is_recommended?: boolean;
+    index?: number;
+}

package/dist/esm/api/types/MessageEnvelope.d.mts

@@ -0,0 +1,15 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * type=message — the terminal agent reply (external Message + optional trace_info).
+ */
+export interface MessageEnvelope {
+    type?: "message";
+    data?: MessageEnvelope.Data;
+    /** Monotonic sequence for gap detection / replay. Locally-generated errors use -1. */
+    seq: number;
+}
+export declare namespace MessageEnvelope {
+    interface Data extends Apollo.Message {
+        trace_info?: Apollo.Trace;
+    }
+}

package/dist/esm/api/types/MessageParty.d.mts

@@ -0,0 +1,4 @@
+export interface MessageParty {
+    id?: string;
+    type?: string;
+}

package/dist/esm/api/types/MessageStreamEvent.d.mts

@@ -0,0 +1,9 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * Terminal event of a turn: the completed agent reply.
+ */
+export interface MessageStreamEvent {
+    /** Monotonic sequence number; echo the last seen value via Last-Event-ID to resume. */
+    seq: number;
+    data: Apollo.Message;
+}

package/dist/esm/api/types/Project.d.mts

@@ -0,0 +1,13 @@
+/**
+ * The published Project shape (SDK entity: ``Project``).
+ */
+export interface Project {
+    /** Project id */
+    id: string;
+    /** Project name */
+    name: string;
+    /** Creation timestamp */
+    created_at: string;
+    /** Last update timestamp */
+    updated_at: string;
+}

package/dist/esm/api/types/ResumeRequest.d.mts

@@ -0,0 +1,5 @@
+export interface ResumeRequest {
+    type: "resume";
+    /** Replay buffered envelopes with seq > resume_after for the active thread. */
+    resume_after: number;
+}

package/dist/esm/api/types/SendMessageRequest.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Send-message contract. ``agent_id`` is required; org comes from the gateway
+ * header, not the body. ``thread_id`` is optional: present -> append to that
+ * thread; absent -> a new thread is auto-created and its id returned.
+ */
+export interface SendMessageRequest {
+    agent_id: string;
+    text: string;
+    user_id: string;
+    thread_id?: string;
+    /** Signed image URL for vision input; forwarded to IA as body.image.signed_url. */
+    image_url?: string;
+}

package/dist/esm/api/types/SendMessageResponse.d.mts

@@ -0,0 +1,10 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * Send/rerun reply plus the resolved thread id — the one the interaction landed
+ * on (newly created when the request omitted ``thread_id``).
+ */
+export interface SendMessageResponse {
+    /** Thread the interaction belongs to */
+    thread_id: string;
+    message: Apollo.Message;
+}

package/dist/esm/api/types/SimulatorCommand.d.mts

@@ -0,0 +1,21 @@
+export interface SimulatorCommand {
+    type: SimulatorCommand.Type;
+    /** IA SimulationRequest payload, relayed verbatim. For `start`, must carry `task_id` (used for the wallet gate, replay buffer, and billing). */
+    data?: SimulatorCommand.Data;
+}
+export declare namespace SimulatorCommand {
+    const Type: {
+        readonly Start: "start";
+        readonly Cancel: "cancel";
+        readonly ForceCancel: "force-cancel";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+    /**
+     * IA SimulationRequest payload, relayed verbatim. For `start`, must carry `task_id` (used for the wallet gate, replay buffer, and billing).
+     */
+    interface Data {
+        task_id?: string;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
+}

package/dist/esm/api/types/SimulatorCommand.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var SimulatorCommand;
+(function (SimulatorCommand) {
+    SimulatorCommand.Type = {
+        Start: "start",
+        Cancel: "cancel",
+        ForceCancel: "force-cancel",
+    };
+})(SimulatorCommand || (SimulatorCommand = {}));

package/dist/esm/api/types/SubmitMessageRequest.d.mts

@@ -0,0 +1,26 @@
+export interface SubmitMessageRequest {
+    type: "message";
+    /** Target agent (required, billable). */
+    agent_id: string;
+    /** Present → append to this thread; absent → auto-create one and announce it. */
+    thread_id?: string;
+    /** End-user ref for an auto-created thread. */
+    user_id?: string;
+    text?: string;
+    /** Signed image URL for vision input. */
+    image_url?: string;
+    context?: SubmitMessageRequest.Context;
+    /** Arbitrary variables forwarded to IA. */
+    agent_variables?: Record<string, unknown>;
+    /** Per-turn agent override (version pin / inline settings). See the REST agent override model. */
+    agent?: Record<string, unknown>;
+    /** Optional agent-settings bundle forwarded to IA under external_context.agent_settings_bundle. */
+    agent_settings_bundle?: Record<string, unknown>;
+}
+export declare namespace SubmitMessageRequest {
+    interface Context {
+        /** Originating page URL. */
+        url?: string;
+        welcome_message?: string;
+    }
+}

package/dist/esm/api/types/Thread.d.mts

@@ -0,0 +1,12 @@
+export interface Thread {
+    /** Thread id */
+    id: string;
+    /** End-user this thread belongs to, if any */
+    user_id?: string;
+    /** Thread title */
+    title: string;
+    /** Agent's opening message */
+    welcome_message?: string;
+    /** Suggested follow-up prompts */
+    followup_suggestions?: string[];
+}

package/dist/esm/api/types/ThreadEnvelope.d.mts

@@ -0,0 +1,11 @@
+export interface ThreadEnvelope {
+    type?: "thread";
+    data?: ThreadEnvelope.Data;
+    /** Monotonic sequence for gap detection / replay. Locally-generated errors use -1. */
+    seq: number;
+}
+export declare namespace ThreadEnvelope {
+    interface Data {
+        thread_id: string;
+    }
+}

package/dist/esm/api/types/ThreadListFilters.d.mts

@@ -0,0 +1,25 @@
+/**
+ * Query params for ``GET /management/v1/threads`` — the thread-filter DSL.
+ *
+ * The full grammar is modeled and shape-validated here; malformed values 422 at
+ * the boundary. Translation to intelligent-agent, and rejection of the filters it
+ * doesn't serve, lives in ``mapping.internal_thread_filters_from_external``.
+ */
+export interface ThreadListFilters {
+    /** Filter by project (account) id */
+    project_id?: string;
+    /** Filter by end-user id */
+    user_id?: string;
+    /** Filter by caller-supplied external id */
+    external_id?: string;
+    /** RFC3339 timestamp(s); two values = a [start, end] range */
+    created?: string[];
+    /** Filter by activated tool code(s) */
+    tool?: string[];
+    /** Rule 'code', or 'code:fired|blocked|passed' */
+    rule?: string[];
+    /** 'key:value', 'key:*', or 'key' with >,<,>=,<= */
+    param?: string[];
+    /** Filter by agent id(s) */
+    agent_id?: string[];
+}

package/dist/esm/api/types/ThreadListItem.d.mts

@@ -0,0 +1,8 @@
+export interface ThreadListItem {
+    /** Thread id */
+    id: string;
+    /** Thread title */
+    title?: string;
+    /** Creation timestamp (ISO-8601) */
+    created_at?: string;
+}

package/dist/esm/api/types/ThreadStreamEvent.d.mts

@@ -0,0 +1,8 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * First event of a stream: the resolved thread id (a client can't read
+ * response headers mid-stream). Unsequenced — it replays on every resume.
+ */
+export interface ThreadStreamEvent {
+    data: Apollo.ThreadStreamEventData;
+}

package/dist/esm/api/types/ThreadStreamEventData.d.mts

@@ -0,0 +1,4 @@
+export interface ThreadStreamEventData {
+    /** Thread the turn runs on (newly created when the request omitted it). */
+    thread_id: string;
+}