@caitlyn-ai/sdk 0.0.0-stage → 0.0.1

package/dist-types/commands/GetAgentVersionCommand.d.ts

@@ -0,0 +1,177 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetAgentVersionInput, GetAgentVersionOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link GetAgentVersionCommand}.
+ */
+export interface GetAgentVersionCommandInput extends GetAgentVersionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetAgentVersionCommand}.
+ */
+export interface GetAgentVersionCommandOutput extends GetAgentVersionOutput, __MetadataBearer {
+}
+declare const GetAgentVersionCommand_base: {
+    new (input: GetAgentVersionCommandInput): import("@smithy/core/client").CommandImpl<GetAgentVersionCommandInput, GetAgentVersionCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: GetAgentVersionCommandInput): import("@smithy/core/client").CommandImpl<GetAgentVersionCommandInput, GetAgentVersionCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Gets one version of an agent, with its full configuration and its ETag.
+ *
+ * `version` is `draft`, `production` or the name of a pinned or published version. Production is
+ * readable by everyone with access to the agent; the draft and pinned versions only by the people
+ * and groups on the agent's version access grant, and anyone else gets 404.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CaitlynClient, GetAgentVersionCommand } from "@caitlyn-ai/sdk"; // ES Modules import
+ * // const { CaitlynClient, GetAgentVersionCommand } = require("@caitlyn-ai/sdk"); // CommonJS import
+ * // import type { CaitlynClientConfig } from "@caitlyn-ai/sdk";
+ * const config = {}; // type is CaitlynClientConfig
+ * const client = new CaitlynClient(config);
+ * const input = { // GetAgentVersionInput
+ *   agentId: "STRING_VALUE", // required
+ *   version: "STRING_VALUE", // required
+ * };
+ * const command = new GetAgentVersionCommand(input);
+ * const response = await client.send(command);
+ * // { // GetAgentVersionOutput
+ * //   requestId: "STRING_VALUE",
+ * //   apiVersion: "STRING_VALUE",
+ * //   etag: "STRING_VALUE", // required
+ * //   agentId: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   source: "pin" || "publish" || "migration" || "import",
+ * //   basedOn: "STRING_VALUE",
+ * //   matchesProduction: true || false,
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   note: "STRING_VALUE",
+ * //   configuration: { // AgentConfiguration
+ * //     identity: "STRING_VALUE",
+ * //     instructions: "STRING_VALUE", // required
+ * //     model: "STRING_VALUE",
+ * //     knowledgeBases: [ // KnowledgeBaseBindingList
+ * //       { // KnowledgeBaseBinding
+ * //         knowledgeBaseId: "STRING_VALUE", // required
+ * //         numberOfResults: Number("int"),
+ * //         minimumScore: Number("float"),
+ * //       },
+ * //     ],
+ * //     attachments: { // AttachmentSettings
+ * //       enabled: true || false,
+ * //       maxFiles: Number("int"),
+ * //     },
+ * //     contentSafety: { // ContentSafety
+ * //       guardrailId: "STRING_VALUE",
+ * //     },
+ * //     deniedDocuments: true || false,
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetAgentVersionCommandInput - {@link GetAgentVersionCommandInput}
+ * @returns {@link GetAgentVersionCommandOutput}
+ * @see {@link GetAgentVersionCommandInput} for command's `input` shape.
+ * @see {@link GetAgentVersionCommandOutput} for command's `response` shape.
+ * @see {@link CaitlynClientResolvedConfig | config} for CaitlynClient's `config` shape.
+ *
+ * @throws {@link NotFoundError} (client fault)
+ *  The record does not exist, or the caller may not see it. The two are deliberately the same, so
+ * identifiers cannot be probed.
+ *
+ * @throws {@link InternalError} (server fault)
+ *  An unexpected server failure. Not retried by the SDKs.
+ *
+ * @throws {@link PermissionDeniedError} (client fault)
+ *  The caller may not call this operation: it lacks the permission, its credential type may not
+ * call it, or the operation is served only on the organisation's primary workspace. Decided before
+ * any record is read. A record the caller may not see is 404 instead.
+ *
+ * @throws {@link ServiceUnavailableError} (server fault)
+ *  A dependency is briefly unavailable, or the request's audit event could not be recorded; wait for
+ * `Retry-After` and try again.
+ *
+ * @throws {@link TooManyRequestsError} (client fault)
+ *  Too many requests; wait for `Retry-After` and try again.
+ *
+ * @throws {@link UnauthenticatedError} (client fault)
+ *  No credential was sent, or it is expired or not valid.
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  The request is malformed: a member is missing, the wrong type or out of range; it has a member,
+ * filter or sort field the operation does not define; or its cursor is not valid for this list.
+ *
+ * @throws {@link CaitlynServiceException}
+ * <p>Base exception class for all service exceptions from Caitlyn service.</p>
+ *
+ *
+ * @example Read the draft before editing it
+ * ```javascript
+ * //
+ * const input = {
+ *   agentId: "GHT7YRWXPL",
+ *   version: "draft"
+ * };
+ * const command = new GetAgentVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   agentId: "GHT7YRWXPL",
+ *   configuration: {
+ *     identity: "You are the HR assistant for Harbour Freight staff.",
+ *     instructions: "Answer leave and pay questions from the HR policy knowledge base.",
+ *     knowledgeBases: [
+ *       {
+ *         knowledgeBaseId: "KB4T7YQ2WL",
+ *         minimumScore: 0.3,
+ *         numberOfResults: 8
+ *       }
+ *     ],
+ *     model: "claude-sonnet-5-5"
+ *   },
+ *   createdAt: "2026-11-02T03:04:05.000Z",
+ *   etag: `"draft-41"`,
+ *   matchesProduction: false,
+ *   name: "draft"
+ * }
+ * *\/
+ * ```
+ *
+ * @example A version name that does not exist, or that the caller may not see
+ * ```javascript
+ * //
+ * const input = {
+ *   agentId: "GHT7YRWXPL",
+ *   version: "v99"
+ * };
+ * const command = new GetAgentVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetAgentVersionCommand extends GetAgentVersionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetAgentVersionInput;
+            output: GetAgentVersionOutput;
+        };
+        sdk: {
+            input: GetAgentVersionCommandInput;
+            output: GetAgentVersionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListDocumentsCommand.d.ts

@@ -0,0 +1,176 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListDocumentsInput, ListDocumentsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListDocumentsCommand}.
+ */
+export interface ListDocumentsCommandInput extends ListDocumentsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDocumentsCommand}.
+ */
+export interface ListDocumentsCommandOutput extends ListDocumentsOutput, __MetadataBearer {
+}
+declare const ListDocumentsCommand_base: {
+    new (input: ListDocumentsCommandInput): import("@smithy/core/client").CommandImpl<ListDocumentsCommandInput, ListDocumentsCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListDocumentsCommandInput): import("@smithy/core/client").CommandImpl<ListDocumentsCommandInput, ListDocumentsCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Lists the documents in a knowledge base, one page at a time.
+ *
+ * Documents are returned in a stable order that does not change between pages. Filters combine
+ * with AND. Unlike v2, an unknown filter is refused with 400 `UNKNOWN_FILTER` instead of being
+ * ignored, and the list can be sorted by `name`, `updatedAt` (when the document last changed) and
+ * `byteSize` on the server; v2 sorts on the client only.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CaitlynClient, ListDocumentsCommand } from "@caitlyn-ai/sdk"; // ES Modules import
+ * // const { CaitlynClient, ListDocumentsCommand } = require("@caitlyn-ai/sdk"); // CommonJS import
+ * // import type { CaitlynClientConfig } from "@caitlyn-ai/sdk";
+ * const config = {}; // type is CaitlynClientConfig
+ * const client = new CaitlynClient(config);
+ * const input = { // ListDocumentsInput
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   limit: Number("int"),
+ *   cursor: "STRING_VALUE",
+ *   sort: "STRING_VALUE",
+ *   folder: "STRING_VALUE",
+ *   status: "pending" || "processing" || "indexed" || "partially_indexed" || "failed" || "deleting",
+ *   namePrefix: "STRING_VALUE",
+ * };
+ * const command = new ListDocumentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDocumentsOutput
+ * //   requestId: "STRING_VALUE",
+ * //   apiVersion: "STRING_VALUE",
+ * //   items: [ // DocumentList // required
+ * //     { // Document
+ * //       id: "STRING_VALUE", // required
+ * //       knowledgeBaseId: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       folder: "STRING_VALUE", // required
+ * //       status: "pending" || "processing" || "indexed" || "partially_indexed" || "failed" || "deleting", // required
+ * //       stage: "STRING_VALUE",
+ * //       contentType: "STRING_VALUE",
+ * //       byteSize: Number("long"),
+ * //       sha256: "STRING_VALUE",
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       updatedAt: new Date("TIMESTAMP"), // required
+ * //       partialFailures: [ // PartialFailureList
+ * //         { // PartialFailure
+ * //           targetId: "STRING_VALUE",
+ * //           code: "STRING_VALUE", // required
+ * //           detail: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * //   nextCursor: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDocumentsCommandInput - {@link ListDocumentsCommandInput}
+ * @returns {@link ListDocumentsCommandOutput}
+ * @see {@link ListDocumentsCommandInput} for command's `input` shape.
+ * @see {@link ListDocumentsCommandOutput} for command's `response` shape.
+ * @see {@link CaitlynClientResolvedConfig | config} for CaitlynClient's `config` shape.
+ *
+ * @throws {@link NotFoundError} (client fault)
+ *  The record does not exist, or the caller may not see it. The two are deliberately the same, so
+ * identifiers cannot be probed.
+ *
+ * @throws {@link InternalError} (server fault)
+ *  An unexpected server failure. Not retried by the SDKs.
+ *
+ * @throws {@link PermissionDeniedError} (client fault)
+ *  The caller may not call this operation: it lacks the permission, its credential type may not
+ * call it, or the operation is served only on the organisation's primary workspace. Decided before
+ * any record is read. A record the caller may not see is 404 instead.
+ *
+ * @throws {@link ServiceUnavailableError} (server fault)
+ *  A dependency is briefly unavailable, or the request's audit event could not be recorded; wait for
+ * `Retry-After` and try again.
+ *
+ * @throws {@link TooManyRequestsError} (client fault)
+ *  Too many requests; wait for `Retry-After` and try again.
+ *
+ * @throws {@link UnauthenticatedError} (client fault)
+ *  No credential was sent, or it is expired or not valid.
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  The request is malformed: a member is missing, the wrong type or out of range; it has a member,
+ * filter or sort field the operation does not define; or its cursor is not valid for this list.
+ *
+ * @throws {@link CaitlynServiceException}
+ * <p>Base exception class for all service exceptions from Caitlyn service.</p>
+ *
+ *
+ * @example List the HR folder's documents that finished indexing
+ * ```javascript
+ * //
+ * const input = {
+ *   folder: "hr/",
+ *   knowledgeBaseId: "KB4T7YQ2WL",
+ *   limit: 2,
+ *   status: "indexed"
+ * };
+ * const command = new ListDocumentsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   items: [
+ *     {
+ *       byteSize: 482113,
+ *       contentType: "application/pdf",
+ *       createdAt: "2026-10-01T22:10:00.000Z",
+ *       folder: "hr/",
+ *       id: "doc-3b7f9e21",
+ *       knowledgeBaseId: "KB4T7YQ2WL",
+ *       name: "Leave policy",
+ *       status: "indexed",
+ *       updatedAt: "2026-10-01T22:14:31.000Z"
+ *     }
+ *   ],
+ *   nextCursor: "c1.MEUCIQDl8z"
+ * }
+ * *\/
+ * ```
+ *
+ * @example A knowledge base that does not exist, or that the caller may not see
+ * ```javascript
+ * //
+ * const input = {
+ *   knowledgeBaseId: "KBNOPE0000"
+ * };
+ * const command = new ListDocumentsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListDocumentsCommand extends ListDocumentsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDocumentsInput;
+            output: ListDocumentsOutput;
+        };
+        sdk: {
+            input: ListDocumentsCommandInput;
+            output: ListDocumentsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ResumeConversationStreamCommand.d.ts

@@ -0,0 +1,146 @@
+import type { MetadataBearer as __MetadataBearer, StreamingBlobPayloadOutputTypes } from "@smithy/types";
+import type { ResumeConversationStreamInput, ResumeConversationStreamOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ResumeConversationStreamCommand}.
+ */
+export interface ResumeConversationStreamCommandInput extends ResumeConversationStreamInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ResumeConversationStreamCommand}.
+ */
+export interface ResumeConversationStreamCommandOutput extends Omit<ResumeConversationStreamOutput, "events">, __MetadataBearer {
+    events: StreamingBlobPayloadOutputTypes;
+}
+declare const ResumeConversationStreamCommand_base: {
+    new (input: ResumeConversationStreamCommandInput): import("@smithy/core/client").CommandImpl<ResumeConversationStreamCommandInput, ResumeConversationStreamCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ResumeConversationStreamCommandInput): import("@smithy/core/client").CommandImpl<ResumeConversationStreamCommandInput, ResumeConversationStreamCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Re-attaches to the answer that is being written, from the event after `Last-Event-ID`.
+ *
+ * Used by the SDKs after a dropped connection; callers rarely need it directly. When no answer is
+ * being written, the stream ends at once.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CaitlynClient, ResumeConversationStreamCommand } from "@caitlyn-ai/sdk"; // ES Modules import
+ * // const { CaitlynClient, ResumeConversationStreamCommand } = require("@caitlyn-ai/sdk"); // CommonJS import
+ * // import type { CaitlynClientConfig } from "@caitlyn-ai/sdk";
+ * const config = {}; // type is CaitlynClientConfig
+ * const client = new CaitlynClient(config);
+ * const input = { // ResumeConversationStreamInput
+ *   conversationId: "STRING_VALUE", // required
+ *   lastEventId: "STRING_VALUE",
+ * };
+ * const command = new ResumeConversationStreamCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * // { // ResumeConversationStreamOutput
+ * //   requestId: "STRING_VALUE",
+ * //   apiVersion: "STRING_VALUE",
+ * //   events: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes // required
+ * // };
+ *
+ * ```
+ *
+ * @param ResumeConversationStreamCommandInput - {@link ResumeConversationStreamCommandInput}
+ * @returns {@link ResumeConversationStreamCommandOutput}
+ * @see {@link ResumeConversationStreamCommandInput} for command's `input` shape.
+ * @see {@link ResumeConversationStreamCommandOutput} for command's `response` shape.
+ * @see {@link CaitlynClientResolvedConfig | config} for CaitlynClient's `config` shape.
+ *
+ * @throws {@link NotFoundError} (client fault)
+ *  The record does not exist, or the caller may not see it. The two are deliberately the same, so
+ * identifiers cannot be probed.
+ *
+ * @throws {@link InternalError} (server fault)
+ *  An unexpected server failure. Not retried by the SDKs.
+ *
+ * @throws {@link PermissionDeniedError} (client fault)
+ *  The caller may not call this operation: it lacks the permission, its credential type may not
+ * call it, or the operation is served only on the organisation's primary workspace. Decided before
+ * any record is read. A record the caller may not see is 404 instead.
+ *
+ * @throws {@link ServiceUnavailableError} (server fault)
+ *  A dependency is briefly unavailable, or the request's audit event could not be recorded; wait for
+ * `Retry-After` and try again.
+ *
+ * @throws {@link TooManyRequestsError} (client fault)
+ *  Too many requests; wait for `Retry-After` and try again.
+ *
+ * @throws {@link UnauthenticatedError} (client fault)
+ *  No credential was sent, or it is expired or not valid.
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  The request is malformed: a member is missing, the wrong type or out of range; it has a member,
+ * filter or sort field the operation does not define; or its cursor is not valid for this list.
+ *
+ * @throws {@link CaitlynServiceException}
+ * <p>Base exception class for all service exceptions from Caitlyn service.</p>
+ *
+ *
+ * @example Resume after a dropped connection
+ * ```javascript
+ * // The answer arrives as a stream of events; the example shows only the request.
+ * const input = {
+ *   conversationId: "0193a6f2-7c4e-7b1a-9d2e-3f5a8c1b0e47",
+ *   lastEventId: "0193a6f2-9b10-7c3d-8e44-1f2a3b4c5d6e"
+ * };
+ * const command = new ResumeConversationStreamCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @example A conversation that does not exist, or that the caller may not see
+ * ```javascript
+ * //
+ * const input = {
+ *   conversationId: "0193a6f2-0000-7000-8000-000000000000"
+ * };
+ * const command = new ResumeConversationStreamCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ResumeConversationStreamCommand extends ResumeConversationStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ResumeConversationStreamInput;
+            output: ResumeConversationStreamOutput;
+        };
+        sdk: {
+            input: ResumeConversationStreamCommandInput;
+            output: ResumeConversationStreamCommandOutput;
+        };
+    };
+}

package/dist-types/commands/SendMessageCommand.d.ts

@@ -0,0 +1,183 @@
+import type { MetadataBearer as __MetadataBearer, StreamingBlobPayloadOutputTypes } from "@smithy/types";
+import type { SendMessageInput, SendMessageOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link SendMessageCommand}.
+ */
+export interface SendMessageCommandInput extends SendMessageInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendMessageCommand}.
+ */
+export interface SendMessageCommandOutput extends Omit<SendMessageOutput, "events">, __MetadataBearer {
+    events: StreamingBlobPayloadOutputTypes;
+}
+declare const SendMessageCommand_base: {
+    new (input: SendMessageCommandInput): import("@smithy/core/client").CommandImpl<SendMessageCommandInput, SendMessageCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: SendMessageCommandInput): import("@smithy/core/client").CommandImpl<SendMessageCommandInput, SendMessageCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Sends a message and streams the answer as server-sent events.
+ *
+ * The stream ends with exactly one `message.completed` or `message.failed`. If the connection
+ * drops, the SDK re-attaches with `ResumeConversationStream` and `Last-Event-ID`, so no event is
+ * lost or repeated. Not retried automatically: a send that fails before the stream starts is
+ * reported to the caller.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CaitlynClient, SendMessageCommand } from "@caitlyn-ai/sdk"; // ES Modules import
+ * // const { CaitlynClient, SendMessageCommand } = require("@caitlyn-ai/sdk"); // CommonJS import
+ * // import type { CaitlynClientConfig } from "@caitlyn-ai/sdk";
+ * const config = {}; // type is CaitlynClientConfig
+ * const client = new CaitlynClient(config);
+ * const input = { // SendMessageInput
+ *   conversationId: "STRING_VALUE", // required
+ *   message: "STRING_VALUE", // required
+ *   context: [ // ContextItemList
+ *     { // ContextItem
+ *       type: "STRING_VALUE", // required
+ *       label: "STRING_VALUE", // required
+ *       uri: "STRING_VALUE",
+ *       data: "DOCUMENT_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new SendMessageCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * // { // SendMessageOutput
+ * //   requestId: "STRING_VALUE",
+ * //   apiVersion: "STRING_VALUE",
+ * //   events: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes // required
+ * // };
+ *
+ * ```
+ *
+ * @param SendMessageCommandInput - {@link SendMessageCommandInput}
+ * @returns {@link SendMessageCommandOutput}
+ * @see {@link SendMessageCommandInput} for command's `input` shape.
+ * @see {@link SendMessageCommandOutput} for command's `response` shape.
+ * @see {@link CaitlynClientResolvedConfig | config} for CaitlynClient's `config` shape.
+ *
+ * @throws {@link ConflictError} (client fault)
+ *  The resource's state does not allow the request, a unique name is taken, or a request with the
+ * same idempotency key is still in progress.
+ *
+ * @throws {@link NotFoundError} (client fault)
+ *  The record does not exist, or the caller may not see it. The two are deliberately the same, so
+ * identifiers cannot be probed.
+ *
+ * @throws {@link PayloadTooLargeError} (client fault)
+ *  The body, a file or the send `context` is over its documented limit.
+ *
+ * @throws {@link InternalError} (server fault)
+ *  An unexpected server failure. Not retried by the SDKs.
+ *
+ * @throws {@link PermissionDeniedError} (client fault)
+ *  The caller may not call this operation: it lacks the permission, its credential type may not
+ * call it, or the operation is served only on the organisation's primary workspace. Decided before
+ * any record is read. A record the caller may not see is 404 instead.
+ *
+ * @throws {@link ServiceUnavailableError} (server fault)
+ *  A dependency is briefly unavailable, or the request's audit event could not be recorded; wait for
+ * `Retry-After` and try again.
+ *
+ * @throws {@link TooManyRequestsError} (client fault)
+ *  Too many requests; wait for `Retry-After` and try again.
+ *
+ * @throws {@link UnauthenticatedError} (client fault)
+ *  No credential was sent, or it is expired or not valid.
+ *
+ * @throws {@link ValidationError} (client fault)
+ *  The request is malformed: a member is missing, the wrong type or out of range; it has a member,
+ * filter or sort field the operation does not define; or its cursor is not valid for this list.
+ *
+ * @throws {@link CaitlynServiceException}
+ * <p>Base exception class for all service exceptions from Caitlyn service.</p>
+ *
+ *
+ * @example Ask a question
+ * ```javascript
+ * // The answer arrives as a stream of events; the example shows only the request.
+ * const input = {
+ *   conversationId: "0193a6f2-7c4e-7b1a-9d2e-3f5a8c1b0e47",
+ *   message: "How much annual leave do part-time staff get?"
+ * };
+ * const command = new SendMessageCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @example A conversation that does not exist, or that the caller may not see
+ * ```javascript
+ * //
+ * const input = {
+ *   conversationId: "0193a6f2-0000-7000-8000-000000000000",
+ *   message: "Hello"
+ * };
+ * const command = new SendMessageCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @example An answer is already being written
+ * ```javascript
+ * //
+ * const input = {
+ *   conversationId: "0193a6f2-7c4e-7b1a-9d2e-3f5a8c1b0e47",
+ *   message: "And for casual staff?"
+ * };
+ * const command = new SendMessageCommand(input);
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.events.transformToByteArray();
+ * // const str = await response.events.transformToString();
+ * // response.events.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class SendMessageCommand extends SendMessageCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SendMessageInput;
+            output: SendMessageOutput;
+        };
+        sdk: {
+            input: SendMessageCommandInput;
+            output: SendMessageCommandOutput;
+        };
+    };
+}