@aui.io/aui-client 3.1.2 → 3.2.0

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

@@ -9,7 +9,7 @@ export declare namespace Messaging {
 }
 export declare class Messaging {
     protected readonly _options: Messaging.Options;
-    constructor(_options?: Messaging.Options);
+    constructor(_options: Messaging.Options);
     /**
      * Send a message; auto-create the thread when ``thread_id`` is omitted. For a live
      * token stream use ``POST /messages/stream`` (SSE). The resolved thread id is
@@ -28,7 +28,6 @@ export declare class Messaging {
      *
      * @example
      *     await client.messaging.sendMessage({
-     *         agent_id: "agent_id",
      *         text: "text",
      *         user_id: "user_id"
      *     })
@@ -36,19 +35,18 @@ export declare class Messaging {
     sendMessage(request: Apollo.SendMessageRequest, requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<Apollo.SendMessageResponse>;
     private __sendMessage;
     /**
-     * Send a message and stream tokens over Server-Sent Events. Auto-creates the
-     * thread when ``thread_id`` is omitted — the resolved id arrives as the first
-     * ``thread`` event (an SSE client can't read response headers). Resume a dropped
-     * stream with the standard ``Last-Event-ID`` header: buffered frames replay, no
-     * fresh turn. FastAPI owns the wire format, keep-alive pings, and OpenAPI docs.
+     * Send a message and stream the reply token-by-token over Server-Sent
+     * Events. The thread is created automatically when ``thread_id`` is omitted —
+     * the resolved id arrives as the first ``thread`` event. Resume a dropped
+     * stream with the standard ``Last-Event-ID`` header: missed events replay
+     * without running the turn again.
      */
     streamMessage(request: Apollo.StreamMessageRequest, requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<core.Stream<Apollo.StreamMessageResponse>>;
     private __streamMessage;
     /**
-     * Regenerate ``interaction_id`` on the thread against the live version, then
-     * replay ``text`` onto the clone. The acting user is optional — absent for the
-     * agent-scoped publishable-key flow, where IA attributes the thread's own user.
-     * ``thread_id`` in the response is the clone's id, not the original.
+     * Regenerate ``interaction_id`` on the thread against the agent's live
+     * version, then replay ``text`` onto the resulting new thread. The response's
+     * ``thread_id`` is the new thread's id, not the original.
      *
      * @param {string} threadId
      * @param {Apollo.RerunMessageRequest} request
@@ -64,7 +62,6 @@ export declare class Messaging {
      *
      * @example
      *     await client.messaging.rerun("threadId", {
-     *         agent_id: "agent_id",
      *         interaction_id: "interaction_id",
      *         text: "text"
      *     })
@@ -72,7 +69,7 @@ export declare class Messaging {
     rerun(threadId: string, request: Apollo.RerunMessageRequest, requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<Apollo.SendMessageResponse>;
     private __rerun;
     /**
-     * The thread transcript, scoped to the key's agent.
+     * The thread's full transcript, in chronological order.
      *
      * @param {string} threadId
      * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
@@ -110,7 +107,7 @@ export declare class Messaging {
     threadTrace(threadId: string, requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<Apollo.Trace[]>;
     private __threadTrace;
     /**
-     * One interaction's trace, resolved directly by interaction id.
+     * The reasoning trace of a single interaction, resolved by its id.
      *
      * @param {string} interactionId
      * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,4 +125,44 @@ export declare class Messaging {
      */
     interactionTrace(interactionId: string, requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<Apollo.Trace>;
     private __interactionTrace;
+    /**
+     * Generate suggested follow-up prompts from a context you provide —
+     * useful for offering the end user quick next questions.
+     *
+     * @param {Apollo.GenerateFollowupSuggestionsRequest} request
+     * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.BadRequestError}
+     * @throws {@link Apollo.UnauthorizedError}
+     * @throws {@link Apollo.ForbiddenError}
+     * @throws {@link Apollo.NotFoundError}
+     * @throws {@link Apollo.ConflictError}
+     * @throws {@link Apollo.UnprocessableEntityError}
+     * @throws {@link Apollo.InternalServerError}
+     *
+     * @example
+     *     await client.messaging.generateFollowupSuggestions()
+     */
+    generateFollowupSuggestions(request?: Apollo.GenerateFollowupSuggestionsRequest, requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<Apollo.GenerateFollowupSuggestionsResponse>;
+    private __generateFollowupSuggestions;
+    /**
+     * The welcome message of the agent's live version — what to show before
+     * the first user message.
+     *
+     * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.BadRequestError}
+     * @throws {@link Apollo.UnauthorizedError}
+     * @throws {@link Apollo.ForbiddenError}
+     * @throws {@link Apollo.NotFoundError}
+     * @throws {@link Apollo.ConflictError}
+     * @throws {@link Apollo.UnprocessableEntityError}
+     * @throws {@link Apollo.InternalServerError}
+     *
+     * @example
+     *     await client.messaging.getWelcomeMessage()
+     */
+    getWelcomeMessage(requestOptions?: Messaging.RequestOptions): core.HttpResponsePromise<Apollo.AgentVersionWelcomeMessageResponse>;
+    private __getWelcomeMessage;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -50,7 +50,7 @@ const environments = __importStar(require("../../../../environments.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 const Apollo = __importStar(require("../../../index.js"));
 class Messaging {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -71,7 +71,6 @@ class Messaging {
      *
      * @example
      *     await client.messaging.sendMessage({
-     *         agent_id: "agent_id",
      *         text: "text",
      *         user_id: "user_id"
      *     })
@@ -81,20 +80,23 @@ class Messaging {
     }
     __sendMessage(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, "messaging/v1/messages"),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "messaging/v1/messages"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -142,22 +144,26 @@ class Messaging {
         });
     }
     /**
-     * Send a message and stream tokens over Server-Sent Events. Auto-creates the
-     * thread when ``thread_id`` is omitted — the resolved id arrives as the first
-     * ``thread`` event (an SSE client can't read response headers). Resume a dropped
-     * stream with the standard ``Last-Event-ID`` header: buffered frames replay, no
-     * fresh turn. FastAPI owns the wire format, keep-alive pings, and OpenAPI docs.
+     * Send a message and stream the reply token-by-token over Server-Sent
+     * Events. The thread is created automatically when ``thread_id`` is omitted —
+     * the resolved id arrives as the first ``thread`` event. Resume a dropped
+     * stream with the standard ``Last-Event-ID`` header: missed events replay
+     * without running the turn again.
      */
     streamMessage(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__streamMessage(request, requestOptions));
     }
     __streamMessage(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const { "Last-Event-ID": lastEventId, body: _body } = request;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "Last-Event-ID": lastEventId != null ? lastEventId : undefined }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "Last-Event-ID": lastEventId != null ? lastEventId : undefined,
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, "messaging/v1/messages/stream"),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "messaging/v1/messages/stream"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -165,10 +171,10 @@ class Messaging {
                 requestType: "json",
                 body: _body,
                 responseType: "sse",
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -227,10 +233,9 @@ class Messaging {
         });
     }
     /**
-     * Regenerate ``interaction_id`` on the thread against the live version, then
-     * replay ``text`` onto the clone. The acting user is optional — absent for the
-     * agent-scoped publishable-key flow, where IA attributes the thread's own user.
-     * ``thread_id`` in the response is the clone's id, not the original.
+     * Regenerate ``interaction_id`` on the thread against the agent's live
+     * version, then replay ``text`` onto the resulting new thread. The response's
+     * ``thread_id`` is the new thread's id, not the original.
      *
      * @param {string} threadId
      * @param {Apollo.RerunMessageRequest} request
@@ -246,7 +251,6 @@ class Messaging {
      *
      * @example
      *     await client.messaging.rerun("threadId", {
-     *         agent_id: "agent_id",
      *         interaction_id: "interaction_id",
      *         text: "text"
      *     })
@@ -256,20 +260,23 @@ class Messaging {
     }
     __rerun(threadId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `messaging/v1/threads/${core.url.encodePathParam(threadId)}/rerun`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `messaging/v1/threads/${core.url.encodePathParam(threadId)}/rerun`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -317,7 +324,7 @@ class Messaging {
         });
     }
     /**
-     * The thread transcript, scoped to the key's agent.
+     * The thread's full transcript, in chronological order.
      *
      * @param {string} threadId
      * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
@@ -338,17 +345,20 @@ class Messaging {
     }
     __listMessages(threadId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `messaging/v1/threads/${core.url.encodePathParam(threadId)}/messages`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `messaging/v1/threads/${core.url.encodePathParam(threadId)}/messages`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -417,17 +427,20 @@ class Messaging {
     }
     __threadTrace(threadId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `messaging/v1/threads/${core.url.encodePathParam(threadId)}/trace`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `messaging/v1/threads/${core.url.encodePathParam(threadId)}/trace`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -475,7 +488,7 @@ class Messaging {
         });
     }
     /**
-     * One interaction's trace, resolved directly by interaction id.
+     * The reasoning trace of a single interaction, resolved by its id.
      *
      * @param {string} interactionId
      * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
@@ -496,17 +509,20 @@ class Messaging {
     }
     __interactionTrace(interactionId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `messaging/v1/interactions/${core.url.encodePathParam(interactionId)}/trace`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `messaging/v1/interactions/${core.url.encodePathParam(interactionId)}/trace`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -553,5 +569,188 @@ class Messaging {
             }
         });
     }
+    /**
+     * Generate suggested follow-up prompts from a context you provide —
+     * useful for offering the end user quick next questions.
+     *
+     * @param {Apollo.GenerateFollowupSuggestionsRequest} request
+     * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.BadRequestError}
+     * @throws {@link Apollo.UnauthorizedError}
+     * @throws {@link Apollo.ForbiddenError}
+     * @throws {@link Apollo.NotFoundError}
+     * @throws {@link Apollo.ConflictError}
+     * @throws {@link Apollo.UnprocessableEntityError}
+     * @throws {@link Apollo.InternalServerError}
+     *
+     * @example
+     *     await client.messaging.generateFollowupSuggestions()
+     */
+    generateFollowupSuggestions(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__generateFollowupSuggestions(request, requestOptions));
+    }
+    __generateFollowupSuggestions() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "messaging/v1/followup-suggestions"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Apollo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Apollo.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Apollo.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Apollo.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Apollo.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Apollo.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ApolloError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ApolloError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ApolloTimeoutError("Timeout exceeded when calling POST /messaging/v1/followup-suggestions.");
+                case "unknown":
+                    throw new errors.ApolloError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * The welcome message of the agent's live version — what to show before
+     * the first user message.
+     *
+     * @param {Messaging.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.BadRequestError}
+     * @throws {@link Apollo.UnauthorizedError}
+     * @throws {@link Apollo.ForbiddenError}
+     * @throws {@link Apollo.NotFoundError}
+     * @throws {@link Apollo.ConflictError}
+     * @throws {@link Apollo.UnprocessableEntityError}
+     * @throws {@link Apollo.InternalServerError}
+     *
+     * @example
+     *     await client.messaging.getWelcomeMessage()
+     */
+    getWelcomeMessage(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getWelcomeMessage(requestOptions));
+    }
+    __getWelcomeMessage(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "messaging/v1/welcome-message"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: _response.body,
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Apollo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Apollo.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Apollo.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Apollo.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Apollo.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Apollo.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ApolloError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ApolloError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /messaging/v1/welcome-message.");
+                case "unknown":
+                    throw new errors.ApolloError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bearer = yield core.Supplier.get(this._options.token);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
+        });
+    }
 }
 exports.Messaging = Messaging;

package/dist/cjs/api/resources/messaging/client/requests/GenerateFollowupSuggestionsRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {}
+ */
+export interface GenerateFollowupSuggestionsRequest {
+    /** Context the suggestions are generated from. */
+    context?: Record<string, unknown>;
+    created_by?: string;
+}

package/dist/cjs/api/resources/messaging/client/requests/RerunMessageRequest.d.ts

@@ -1,15 +1,15 @@
 /**
  * @example
  *     {
- *         agent_id: "agent_id",
  *         interaction_id: "interaction_id",
  *         text: "text"
  *     }
  */
 export interface RerunMessageRequest {
-    agent_id: string;
     interaction_id: string;
     text: string;
+    /** End user to attribute the rerun to; omitted, the thread's original user is kept. */
+    user_id?: string;
     /** Signed image URL on the replayed message. */
     image_url?: string;
     version_id?: string;

package/dist/cjs/api/resources/messaging/client/requests/StreamMessageRequest.d.ts

@@ -4,7 +4,6 @@ import type * as Apollo from "../../../../index.js";
  *     {
  *         "Last-Event-ID": "Last-Event-ID",
  *         body: {
- *             agent_id: "agent_id",
  *             text: "text",
  *             user_id: "user_id"
  *         }

package/dist/cjs/api/resources/messaging/client/requests/index.d.ts

@@ -1,2 +1,3 @@
+export type { GenerateFollowupSuggestionsRequest } from "./GenerateFollowupSuggestionsRequest.js";
 export type { RerunMessageRequest } from "./RerunMessageRequest.js";
 export type { StreamMessageRequest } from "./StreamMessageRequest.js";