@aui.io/aui-client 3.2.3 → 3.3.0

package/README.md

@@ -59,8 +59,8 @@ await client.messaging.sendMessage({
   user_id: 'end-user-123',
   text: 'Where is my order?',
   agent_variables: {
-    static: { customer_name: 'Ada' },
-    dynamic: { order_id: 'ORD-1042' },
+    customer_name: 'Ada',
+    order_id: 'ORD-1042',
   },
 });
 ```
@@ -103,6 +103,10 @@ const { suggestions } = await client.messaging.generateFollowupSuggestions({
 | `getWelcomeMessage()` | Return the agent's welcome message. |
 | `generateFollowupSuggestions(request)` | Generate follow-up prompts from a context. |
 
+Message cards carry both a rendered `rendered_jsx` string and a structured
+`json_data` representation (`entity` plus `sub_entities`), so you can either render
+the JSX directly or read the card's fields programmatically.
+
 ### Channels (SMS and WhatsApp)
 
 Start an outbound thread on a channel with `channels.initiateThread`. Pass `'sms'`
@@ -128,13 +132,16 @@ and it works in both Node and the browser.
 const socket = await client.connect();
 await socket.waitForOpen();
 
+// The agent is resolved from your publishable key.
+const { agentId } = await client.getContext();
+
 socket.on('message', (message) => console.log(message));
 socket.on('error', (error) => console.error(error));
 socket.on('close', (event) => console.log('closed', event.code));
 
 socket.sendMessage({
   type: 'message',
-  agent_id: agentId,
+  agent_id: agentId!,
   user_id: 'end-user-123',
   text: 'Hello over WebSocket',
 });
@@ -199,7 +206,7 @@ const usage = await client.projects.getProjectUsage(project.id);
 | `listAgents(projectId, { filters })` | List a project's agents. |
 | `createAgent(projectId, request)` | Create an agent. |
 | `getAgent(agentId)` | Fetch one agent. |
-| `updateAgent(agentId, request)` | Rename an agent. |
+| `updateAgent(agentId, request)` | Rename an agent (re-publishes the live version with the new name). |
 | `deleteAgent(agentId)` | Delete an agent and its versions. |
 | `getAgentUsage(agentId)` | Usage metrics for one agent. |
 
@@ -242,6 +249,8 @@ await client.agentVersions.publishVersion(agentId, draft.id);
 (range), `tool`, `rule`, and `param`. Prefer a filter such as `project_id` over an
 empty object; the unfiltered list sorts every thread in the organization and can be slow.
 
+Listed threads include a `version_tag` indicating the agent version the thread runs on.
+
 ```ts
 const page = await client.threads.listThreads(
   { filters: { project_id: projectId } },

package/dist/cjs/Client.js

@@ -62,8 +62,8 @@ class ApolloClient {
                 "x-organization-api-key": _options === null || _options === void 0 ? void 0 : _options.organizationApiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@aui.io/aui-client",
-                "X-Fern-SDK-Version": "3.2.3",
-                "User-Agent": "@aui.io/aui-client/3.2.3",
+                "X-Fern-SDK-Version": "3.3.0",
+                "User-Agent": "@aui.io/aui-client/3.3.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/agents/client/Client.d.ts

@@ -94,8 +94,8 @@ export declare class Agents {
     deleteAgent(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteAgent;
     /**
-     * Rename an agent. To change which version is live, publish a version
-     * instead.
+     * Rename an agent. re-publishes the published version with the updated name.
+     * To change which version is live, publish a version instead.
      *
      * @param {string} agentId
      * @param {Apollo.AgentUpdateRequest} request

package/dist/cjs/api/resources/agents/client/Client.js

@@ -410,8 +410,8 @@ class Agents {
         });
     }
     /**
-     * Rename an agent. To change which version is live, publish a version
-     * instead.
+     * Rename an agent. re-publishes the published version with the updated name.
+     * To change which version is live, publish a version instead.
      *
      * @param {string} agentId
      * @param {Apollo.AgentUpdateRequest} request

package/dist/cjs/api/types/MessageCardJsonData.d.ts

@@ -0,0 +1,10 @@
+import type * as Apollo from "../index.js";
+/**
+ * Structured, self-contained form of the card — the JSON counterpart to
+ * ``rendered_jsx``. ``entity`` is the card's own flat {code: value} map;
+ * ``sub_entities`` holds its variant groups.
+ */
+export interface MessageCardJsonData {
+    entity?: Record<string, unknown>;
+    sub_entities?: Apollo.MessageCardSubEntity[];
+}

package/dist/cjs/api/types/MessageCardJsonData.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MessageCardSubEntity.d.ts

@@ -0,0 +1,4 @@
+export interface MessageCardSubEntity {
+    name?: string;
+    items?: Record<string, unknown>[];
+}

package/dist/cjs/api/types/MessageCardSubEntity.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ThreadListItem.d.ts

@@ -5,4 +5,6 @@ export interface ThreadListItem {
     title?: string;
     /** Creation timestamp (ISO-8601) */
     created_at?: string;
+    /** Agent version tag the thread runs on */
+    version_tag?: string;
 }

package/dist/cjs/api/types/index.d.ts

@@ -23,6 +23,8 @@ export * from "./HttpValidationError.js";
 export * from "./InitiateThreadResponse.js";
 export * from "./Message.js";
 export * from "./MessageCard.js";
+export * from "./MessageCardJsonData.js";
+export * from "./MessageCardSubEntity.js";
 export * from "./MessageEnvelope.js";
 export * from "./MessageParty.js";
 export * from "./MessageStreamEvent.js";

package/dist/cjs/api/types/index.js

@@ -39,6 +39,8 @@ __exportStar(require("./HttpValidationError.js"), exports);
 __exportStar(require("./InitiateThreadResponse.js"), exports);
 __exportStar(require("./Message.js"), exports);
 __exportStar(require("./MessageCard.js"), exports);
+__exportStar(require("./MessageCardJsonData.js"), exports);
+__exportStar(require("./MessageCardSubEntity.js"), exports);
 __exportStar(require("./MessageEnvelope.js"), exports);
 __exportStar(require("./MessageParty.js"), exports);
 __exportStar(require("./MessageStreamEvent.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.2.3";
+export declare const SDK_VERSION = "3.3.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.2.3";
+exports.SDK_VERSION = "3.3.0";

package/dist/esm/Client.mjs

@@ -26,8 +26,8 @@ export class ApolloClient {
                 "x-organization-api-key": _options === null || _options === void 0 ? void 0 : _options.organizationApiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@aui.io/aui-client",
-                "X-Fern-SDK-Version": "3.2.3",
-                "User-Agent": "@aui.io/aui-client/3.2.3",
+                "X-Fern-SDK-Version": "3.3.0",
+                "User-Agent": "@aui.io/aui-client/3.3.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/agents/client/Client.d.mts

@@ -94,8 +94,8 @@ export declare class Agents {
     deleteAgent(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteAgent;
     /**
-     * Rename an agent. To change which version is live, publish a version
-     * instead.
+     * Rename an agent. re-publishes the published version with the updated name.
+     * To change which version is live, publish a version instead.
      *
      * @param {string} agentId
      * @param {Apollo.AgentUpdateRequest} request

package/dist/esm/api/resources/agents/client/Client.mjs

@@ -374,8 +374,8 @@ export class Agents {
         });
     }
     /**
-     * Rename an agent. To change which version is live, publish a version
-     * instead.
+     * Rename an agent. re-publishes the published version with the updated name.
+     * To change which version is live, publish a version instead.
      *
      * @param {string} agentId
      * @param {Apollo.AgentUpdateRequest} request

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

@@ -0,0 +1,10 @@
+import type * as Apollo from "../index.mjs";
+/**
+ * Structured, self-contained form of the card — the JSON counterpart to
+ * ``rendered_jsx``. ``entity`` is the card's own flat {code: value} map;
+ * ``sub_entities`` holds its variant groups.
+ */
+export interface MessageCardJsonData {
+    entity?: Record<string, unknown>;
+    sub_entities?: Apollo.MessageCardSubEntity[];
+}

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

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,4 @@
+export interface MessageCardSubEntity {
+    name?: string;
+    items?: Record<string, unknown>[];
+}

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

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -5,4 +5,6 @@ export interface ThreadListItem {
     title?: string;
     /** Creation timestamp (ISO-8601) */
     created_at?: string;
+    /** Agent version tag the thread runs on */
+    version_tag?: string;
 }

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

@@ -23,6 +23,8 @@ export * from "./HttpValidationError.mjs";
 export * from "./InitiateThreadResponse.mjs";
 export * from "./Message.mjs";
 export * from "./MessageCard.mjs";
+export * from "./MessageCardJsonData.mjs";
+export * from "./MessageCardSubEntity.mjs";
 export * from "./MessageEnvelope.mjs";
 export * from "./MessageParty.mjs";
 export * from "./MessageStreamEvent.mjs";

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

@@ -23,6 +23,8 @@ export * from "./HttpValidationError.mjs";
 export * from "./InitiateThreadResponse.mjs";
 export * from "./Message.mjs";
 export * from "./MessageCard.mjs";
+export * from "./MessageCardJsonData.mjs";
+export * from "./MessageCardSubEntity.mjs";
 export * from "./MessageEnvelope.mjs";
 export * from "./MessageParty.mjs";
 export * from "./MessageStreamEvent.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.2.3";
+export declare const SDK_VERSION = "3.3.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "3.2.3";
+export const SDK_VERSION = "3.3.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@aui.io/aui-client",
-    "version": "3.2.3",
+    "version": "3.3.0",
     "private": false,
     "repository": "github:aui-io/aui-client-typescript",
     "type": "commonjs",

package/reference.md

@@ -341,8 +341,8 @@ await client.agents.deleteAgent("agentId");
 <dl>
 <dd>
 
-Rename an agent. To change which version is live, publish a version
-instead.
+Rename an agent. re-publishes the published version with the updated name.
+To change which version is live, publish a version instead.
 </dd>
 </dl>
 </dd>