@caitlyn-ai/sdk 0.0.2 → 0.1.0

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

@@ -1,183 +0,0 @@
-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;
-        };
-    };
-}

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

@@ -1,202 +0,0 @@
-import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { UpdateDraftVersionInput, UpdateDraftVersionOutput } from "../models/models_0";
-/**
- * @public
- */
-export type { __MetadataBearer };
-/**
- * @public
- *
- * The input for {@link UpdateDraftVersionCommand}.
- */
-export interface UpdateDraftVersionCommandInput extends UpdateDraftVersionInput {
-}
-/**
- * @public
- *
- * The output of {@link UpdateDraftVersionCommand}.
- */
-export interface UpdateDraftVersionCommandOutput extends UpdateDraftVersionOutput, __MetadataBearer {
-}
-declare const UpdateDraftVersionCommand_base: {
-    new (input: UpdateDraftVersionCommandInput): import("@smithy/core/client").CommandImpl<UpdateDraftVersionCommandInput, UpdateDraftVersionCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
-    new (input: UpdateDraftVersionCommandInput): import("@smithy/core/client").CommandImpl<UpdateDraftVersionCommandInput, UpdateDraftVersionCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
-};
-/**
- * Edits the draft with a partial update of its configuration; `If-Match` is required.
- *
- * Members that are absent stay unchanged, nested objects are merged and lists are replaced whole.
- * To return a member to its default, name it in `clear`; naming a member that is not clearable, or
- * one the same request also sets, is refused with 400 `VALIDATION_FAILED`. Returns the whole draft
- * and its new ETag.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CaitlynClient, UpdateDraftVersionCommand } from "@caitlyn-ai/sdk"; // ES Modules import
- * // const { CaitlynClient, UpdateDraftVersionCommand } = 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 = { // UpdateDraftVersionInput
- *   agentId: "STRING_VALUE", // required
- *   ifMatch: "STRING_VALUE", // required
- *   identity: "STRING_VALUE",
- *   instructions: "STRING_VALUE",
- *   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,
- *   clear: [ // ClearableDraftFieldList
- *     "identity",
- *   ],
- * };
- * const command = new UpdateDraftVersionCommand(input);
- * const response = await client.send(command);
- * // { // UpdateDraftVersionOutput
- * //   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 UpdateDraftVersionCommandInput - {@link UpdateDraftVersionCommandInput}
- * @returns {@link UpdateDraftVersionCommandOutput}
- * @see {@link UpdateDraftVersionCommandInput} for command's `input` shape.
- * @see {@link UpdateDraftVersionCommandOutput} 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 PreconditionFailedError} (client fault)
- *  `If-Match` does not match the resource's current ETag: it changed since the caller read it.
- *
- * @throws {@link PreconditionRequiredError} (client fault)
- *  The update sent no `If-Match` header; read the resource and send its ETag.
- *
- * @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 Change the instructions and clear the identity
- * ```javascript
- * //
- * const input = {
- *   agentId: "GHT7YRWXPL",
- *   clear: [
- *     "identity"
- *   ],
- *   ifMatch: `"draft-41"`,
- *   instructions: "Answer leave and pay questions. Quote the policy clause you relied on."
- * };
- * const command = new UpdateDraftVersionCommand(input);
- * const response = await client.send(command);
- * /* response is
- * {
- *   agentId: "GHT7YRWXPL",
- *   configuration: {
- *     instructions: "Answer leave and pay questions. Quote the policy clause you relied on.",
- *     model: "claude-sonnet-5-5"
- *   },
- *   createdAt: "2026-11-02T03:04:05.000Z",
- *   etag: `"draft-42"`,
- *   matchesProduction: false,
- *   name: "draft"
- * }
- * *\/
- * ```
- *
- * @example The draft changed since it was read
- * ```javascript
- * //
- * const input = {
- *   agentId: "GHT7YRWXPL",
- *   ifMatch: `"draft-40"`,
- *   instructions: "Answer leave questions."
- * };
- * const command = new UpdateDraftVersionCommand(input);
- * const response = await client.send(command);
- * /* response is
- * { /* metadata only *\/ }
- * *\/
- * ```
- *
- * @public
- */
-export declare class UpdateDraftVersionCommand extends UpdateDraftVersionCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: UpdateDraftVersionInput;
-            output: UpdateDraftVersionOutput;
-        };
-        sdk: {
-            input: UpdateDraftVersionCommandInput;
-            output: UpdateDraftVersionCommandOutput;
-        };
-    };
-}

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

@@ -1,7 +0,0 @@
-export * from "./CreateDocumentCommand";
-export * from "./CreateUploadCommand";
-export * from "./GetAgentVersionCommand";
-export * from "./ListDocumentsCommand";
-export * from "./ResumeConversationStreamCommand";
-export * from "./SendMessageCommand";
-export * from "./UpdateDraftVersionCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -1,32 +0,0 @@
-import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
-/**
- * @public
- */
-export interface ClientInputEndpointParameters {
-    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
-}
-/**
- * @public
- */
-export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
-    defaultSigningName: string;
-};
-/**
- * @internal
- */
-export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
-/**
- * @internal
- */
-export declare const commonParams: {
-    readonly endpoint: {
-        readonly type: "builtInParams";
-        readonly name: "endpoint";
-    };
-};
-/**
- * @internal
- */
-export interface EndpointParameters extends __EndpointParameters {
-    endpoint?: string | undefined;
-}

package/dist-types/endpoint/bdd.d.ts

@@ -1,2 +0,0 @@
-import { BinaryDecisionDiagram } from "@smithy/core/endpoints";
-export declare const bdd: BinaryDecisionDiagram;

package/dist-types/endpoint/endpointResolver.d.ts

@@ -1,8 +0,0 @@
-import type { EndpointV2, Logger } from "@smithy/types";
-import type { EndpointParameters } from "./EndpointParameters";
-/**
- * @internal
- */
-export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
-    logger?: Logger;
-}) => EndpointV2;

package/dist-types/extensionConfiguration.d.ts

@@ -1,8 +0,0 @@
-import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
-import type { DefaultExtensionConfiguration } from "@smithy/types";
-import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
-/**
- * @internal
- */
-export interface CaitlynExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, HttpAuthExtensionConfiguration {
-}

package/dist-types/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * The Caitlyn v3 API.
- *
- * Every request is made to a workspace's own hostname, which names the workspace, and carries a
- * short-lived Caitlyn bearer token, however the caller signed in. The `session` sign-in mode (the
- * browser cookie) is handled by the SDKs' runtime and is not modelled per operation.
- *
- * @packageDocumentation
- */
-export * from "./CaitlynClient";
-export * from "./Caitlyn";
-export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
-export type { RuntimeExtension } from "./runtimeExtensions";
-export type { CaitlynExtensionConfiguration } from "./extensionConfiguration";
-export * from "./commands";
-export { Command as $Command } from "@smithy/core/client";
-export * from "./pagination";
-export * from "./schemas/schemas_0";
-export * from "./models/enums";
-export * from "./models/errors";
-export * from "./models/models_0";
-export { CaitlynServiceException } from "./models/CaitlynServiceException";

package/dist-types/models/CaitlynServiceException.d.ts

@@ -1,15 +0,0 @@
-import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
-export type { __ServiceExceptionOptions };
-export { __ServiceException };
-/**
- * @public
- *
- * Base exception class for all service exceptions from Caitlyn service.
- */
-export declare class CaitlynServiceException extends __ServiceException {
-    static readonly shapeId: string;
-    /**
-     * @internal
-     */
-    constructor(options: __ServiceExceptionOptions);
-}

package/dist-types/models/enums.d.ts

@@ -1,148 +0,0 @@
-/**
- * @public
- * @enum
- */
-export declare const ClearableDraftField: {
-    /**
-     * The agent's identity statement.
-     */
-    readonly IDENTITY: "identity";
-};
-/**
- * @public
- */
-export type ClearableDraftField = (typeof ClearableDraftField)[keyof typeof ClearableDraftField];
-/**
- * @public
- * @enum
- */
-export declare const VersionSource: {
-    /**
-     * Created from an imported agent file.
-     */
-    readonly IMPORT: "import";
-    /**
-     * Carried over from the version model before v3.
-     */
-    readonly MIGRATION: "migration";
-    /**
-     * Pinned from the draft, without changing production.
-     */
-    readonly PIN: "pin";
-    /**
-     * Published, which also made it production.
-     */
-    readonly PUBLISH: "publish";
-};
-/**
- * @public
- */
-export type VersionSource = (typeof VersionSource)[keyof typeof VersionSource];
-/**
- * @public
- * @enum
- */
-export declare const DocumentStatus: {
-    /**
-     * Being deleted.
-     */
-    readonly DELETING: "deleting";
-    /**
-     * The document's content could not be processed. Final.
-     */
-    readonly FAILED: "failed";
-    /**
-     * Searchable. Final.
-     */
-    readonly INDEXED: "indexed";
-    /**
-     * Searchable, but some enrichments did not complete; see `partialFailures`. Final.
-     */
-    readonly PARTIALLY_INDEXED: "partially_indexed";
-    /**
-     * Created; processing has not started.
-     */
-    readonly PENDING: "pending";
-    /**
-     * Being processed. `stage` says what the server is doing.
-     */
-    readonly PROCESSING: "processing";
-};
-/**
- * @public
- */
-export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
-/**
- * @public
- * @enum
- */
-export declare const OperationKind: {
-    /**
-     * A document's ingestion: reading, enriching and indexing its content.
-     */
-    readonly DOCUMENT_INGESTION: "document_ingestion";
-};
-/**
- * @public
- */
-export type OperationKind = (typeof OperationKind)[keyof typeof OperationKind];
-/**
- * @public
- * @enum
- */
-export declare const OperationStatus: {
-    /**
-     * Cancelled before it finished. Final.
-     */
-    readonly CANCELLED: "cancelled";
-    /**
-     * The core work failed; see `error`. Final.
-     */
-    readonly FAILED: "failed";
-    /**
-     * Waiting to start.
-     */
-    readonly QUEUED: "queued";
-    /**
-     * Running.
-     */
-    readonly RUNNING: "running";
-    /**
-     * Finished with no failures. Final.
-     */
-    readonly SUCCEEDED: "succeeded";
-    /**
-     * Finished, but some enrichments did not complete; see `partialFailures`. Final.
-     */
-    readonly SUCCEEDED_WITH_FAILURES: "succeeded_with_failures";
-};
-/**
- * @public
- */
-export type OperationStatus = (typeof OperationStatus)[keyof typeof OperationStatus];
-/**
- * @public
- * @enum
- */
-export declare const UploadStatus: {
-    /**
-     * Reserved; the bytes have not arrived.
-     */
-    readonly AWAITING_BYTES: "awaiting_bytes";
-    /**
-     * Used by an operation. Final.
-     */
-    readonly CONSUMED: "consumed";
-    /**
-     * Not used before `expiresAt`. Final.
-     */
-    readonly EXPIRED: "expired";
-    /**
-     * The bytes arrived and matched the checksum.
-     */
-    readonly RECEIVED: "received";
-};
-/**
- * @public
- */
-export type UploadStatus = (typeof UploadStatus)[keyof typeof UploadStatus];