@caitlyn-ai/sdk 0.0.0-stage → 0.0.2

package/dist-types/CaitlynClient.d.ts

@@ -0,0 +1,160 @@
+import { type DefaultsMode as __DefaultsMode, type SmithyConfiguration as __SmithyConfiguration, type SmithyResolvedConfiguration as __SmithyResolvedConfiguration, Client as __Client } from "@smithy/core/client";
+import { type EndpointInputConfig, type EndpointRequiredInputConfig, type EndpointRequiredResolvedConfig, type EndpointResolvedConfig } from "@smithy/core/endpoints";
+import { type HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/core/protocols";
+import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/retry";
+import type { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, SdkStreamMixinInjector as __SdkStreamMixinInjector, StreamCollector as __StreamCollector, UrlParser as __UrlParser } from "@smithy/types";
+import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
+import type { CreateDocumentCommandInput, CreateDocumentCommandOutput } from "./commands/CreateDocumentCommand";
+import type { CreateUploadCommandInput, CreateUploadCommandOutput } from "./commands/CreateUploadCommand";
+import type { GetAgentVersionCommandInput, GetAgentVersionCommandOutput } from "./commands/GetAgentVersionCommand";
+import type { ListDocumentsCommandInput, ListDocumentsCommandOutput } from "./commands/ListDocumentsCommand";
+import type { ResumeConversationStreamCommandInput, ResumeConversationStreamCommandOutput } from "./commands/ResumeConversationStreamCommand";
+import type { SendMessageCommandInput, SendMessageCommandOutput } from "./commands/SendMessageCommand";
+import type { UpdateDraftVersionCommandInput, UpdateDraftVersionCommandOutput } from "./commands/UpdateDraftVersionCommand";
+import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
+import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
+export { __Client };
+/**
+ * @public
+ */
+export type ServiceInputTypes = CreateDocumentCommandInput | CreateUploadCommandInput | GetAgentVersionCommandInput | ListDocumentsCommandInput | ResumeConversationStreamCommandInput | SendMessageCommandInput | UpdateDraftVersionCommandInput;
+/**
+ * @public
+ */
+export type ServiceOutputTypes = CreateDocumentCommandOutput | CreateUploadCommandOutput | GetAgentVersionCommandOutput | ListDocumentsCommandOutput | ResumeConversationStreamCommandOutput | SendMessageCommandOutput | UpdateDraftVersionCommandOutput;
+/**
+ * @public
+ */
+export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
+    /**
+     * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
+     */
+    requestHandler?: __HttpHandlerUserInput;
+    /**
+     * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
+     * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
+     * @internal
+     */
+    sha256?: __ChecksumConstructor | __HashConstructor;
+    /**
+     * The function that will be used to convert strings into HTTP endpoints.
+     * @internal
+     */
+    urlParser?: __UrlParser;
+    /**
+     * A function that can calculate the length of a request body.
+     * @internal
+     */
+    bodyLengthChecker?: __BodyLengthCalculator;
+    /**
+     * A function that converts a stream into an array of bytes.
+     * @internal
+     */
+    streamCollector?: __StreamCollector;
+    /**
+     * The function that will be used to convert a base64-encoded string to a byte array.
+     * @internal
+     */
+    base64Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a base64-encoded string.
+     * @internal
+     */
+    base64Encoder?: __Encoder;
+    /**
+     * The function that will be used to convert a UTF8-encoded string to a byte array.
+     * @internal
+     */
+    utf8Decoder?: __Decoder;
+    /**
+     * The function that will be used to convert binary data to a UTF-8 encoded string.
+     * @internal
+     */
+    utf8Encoder?: __Encoder;
+    /**
+     * The runtime environment.
+     * @internal
+     */
+    runtime?: string;
+    /**
+     * Disable dynamically changing the endpoint of the client based on the hostPrefix
+     * trait of an operation.
+     */
+    disableHostPrefix?: boolean;
+    /**
+     * Value for how many times a request will be made at most in case of retry.
+     */
+    maxAttempts?: number | __Provider<number>;
+    /**
+     * Specifies which retry algorithm to use.
+     * Accepted values are "standard" and "adaptive".
+     * @see https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html
+     *
+     */
+    retryMode?: string | __Provider<string>;
+    /**
+     * Optional logger for logging debug/info/warn/error.
+     */
+    logger?: __Logger;
+    /**
+     * Optional extensions
+     */
+    extensions?: RuntimeExtension[];
+    /**
+     * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     */
+    defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
+    /**
+     * The internal function that inject utilities to runtime-specific stream to help users consume the data
+     * @internal
+     */
+    sdkStreamMixin?: __SdkStreamMixinInjector;
+    /**
+     * The SDK package version, sent in the user agent.
+     * @internal
+     */
+    caitlynSdkVersion?: string;
+}
+/**
+ * @public
+ */
+export type CaitlynClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RetryInputConfig & EndpointInputConfig<EndpointParameters> & EndpointRequiredInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
+/**
+ * @public
+ *
+ *  The configuration interface of CaitlynClient class constructor that set the region, credentials and other options.
+ */
+export interface CaitlynClientConfig extends CaitlynClientConfigType {
+}
+/**
+ * @public
+ */
+export type CaitlynClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RetryResolvedConfig & EndpointResolvedConfig<EndpointParameters> & EndpointRequiredResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
+/**
+ * @public
+ *
+ *  The resolved configuration interface of CaitlynClient class. This is resolved and normalized from the {@link CaitlynClientConfig | constructor configuration interface}.
+ */
+export interface CaitlynClientResolvedConfig extends CaitlynClientResolvedConfigType {
+}
+/**
+ * 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.
+ * @public
+ */
+export declare class CaitlynClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CaitlynClientResolvedConfig> {
+    /**
+     * The resolved configuration of CaitlynClient class. This is resolved and normalized from the {@link CaitlynClientConfig | constructor configuration interface}.
+     */
+    readonly config: CaitlynClientResolvedConfig;
+    constructor(...[configuration]: __CheckOptionalClientConfig<CaitlynClientConfig>);
+    /**
+     * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+     * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+     * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+     */
+    destroy(): void;
+}

package/dist-types/auth/httpAuthExtensionConfiguration.d.ts

@@ -0,0 +1,29 @@
+import { type HttpAuthScheme, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
+import type { CaitlynHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
+/**
+ * @internal
+ */
+export interface HttpAuthExtensionConfiguration {
+    setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
+    httpAuthSchemes(): HttpAuthScheme[];
+    setHttpAuthSchemeProvider(httpAuthSchemeProvider: CaitlynHttpAuthSchemeProvider): void;
+    httpAuthSchemeProvider(): CaitlynHttpAuthSchemeProvider;
+    setToken(token: TokenIdentity | TokenIdentityProvider): void;
+    token(): TokenIdentity | TokenIdentityProvider | undefined;
+}
+/**
+ * @internal
+ */
+export type HttpAuthRuntimeConfig = Partial<{
+    httpAuthSchemes: HttpAuthScheme[];
+    httpAuthSchemeProvider: CaitlynHttpAuthSchemeProvider;
+    token: TokenIdentity | TokenIdentityProvider;
+}>;
+/**
+ * @internal
+ */
+export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;

package/dist-types/auth/httpAuthSchemeProvider.d.ts

@@ -0,0 +1,81 @@
+import { type HandlerExecutionContext, type HttpAuthScheme, type HttpAuthSchemeParameters, type HttpAuthSchemeParametersProvider, type HttpAuthSchemeProvider, type Provider, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
+import type { CaitlynClientResolvedConfig } from "../CaitlynClient";
+/**
+ * @internal
+ */
+export interface CaitlynHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
+}
+/**
+ * @internal
+ */
+export interface CaitlynHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<CaitlynClientResolvedConfig, HandlerExecutionContext, CaitlynHttpAuthSchemeParameters, object> {
+}
+/**
+ * @internal
+ */
+export declare const defaultCaitlynHttpAuthSchemeParametersProvider: (config: CaitlynClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<CaitlynHttpAuthSchemeParameters>;
+/**
+ * @internal
+ */
+export interface CaitlynHttpAuthSchemeProvider extends HttpAuthSchemeProvider<CaitlynHttpAuthSchemeParameters> {
+}
+/**
+ * @internal
+ */
+export declare const defaultCaitlynHttpAuthSchemeProvider: CaitlynHttpAuthSchemeProvider;
+/**
+ * @public
+ */
+export interface HttpAuthSchemeInputConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    authSchemePreference?: string[] | Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    httpAuthSchemes?: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    httpAuthSchemeProvider?: CaitlynHttpAuthSchemeProvider;
+    /**
+     * The token used to authenticate requests.
+     */
+    token?: TokenIdentity | TokenIdentityProvider;
+}
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeResolvedConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    readonly authSchemePreference: Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    readonly httpAuthSchemes: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    readonly httpAuthSchemeProvider: CaitlynHttpAuthSchemeProvider;
+    /**
+     * The token used to authenticate requests.
+     */
+    readonly token?: TokenIdentityProvider;
+}
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig) => T & HttpAuthSchemeResolvedConfig;

package/dist-types/commandBuilder.d.ts

@@ -0,0 +1,18 @@
+import type { EndpointParameterInstructions } from "@smithy/types";
+import type { CaitlynClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "./CaitlynClient";
+/**
+ * @internal
+ */
+export declare const command: <I extends ServiceInputTypes, O extends ServiceOutputTypes>(added: EndpointParameterInstructions, plugins: (CommandCtor: any, clientStack: any, config: any, options: any) => import("@smithy/types").Pluggable<any, any>[], op: string, $: import("@smithy/types").StaticOperationSchema, smithyContext?: Record<string, unknown>) => {
+    new (input: I): import("@smithy/core/client").CommandImpl<I, O, CaitlynClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: import("@smithy/types").OptionalParameter<I>): import("@smithy/core/client").CommandImpl<I, O, CaitlynClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): EndpointParameterInstructions;
+};
+/**
+ * @internal
+ */
+export declare const _ep0: EndpointParameterInstructions;
+/**
+ * @internal
+ */
+export declare const _mw0: (Command: any, cs: any, config: any, o: any) => never[];

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

@@ -0,0 +1,190 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateDocumentInput, CreateDocumentOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateDocumentCommand}.
+ */
+export interface CreateDocumentCommandInput extends CreateDocumentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateDocumentCommand}.
+ */
+export interface CreateDocumentCommandOutput extends CreateDocumentOutput, __MetadataBearer {
+}
+declare const CreateDocumentCommand_base: {
+    new (input: CreateDocumentCommandInput): import("@smithy/core/client").CommandImpl<CreateDocumentCommandInput, CreateDocumentCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateDocumentCommandInput): import("@smithy/core/client").CommandImpl<CreateDocumentCommandInput, CreateDocumentCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates a document from an upload; ingestion continues after the response.
+ *
+ * Returns 202 with the document in its initial state and the Operation that tracks ingestion, and
+ * `Location` names the Operation. Needs the files permission, read access to the knowledge base and
+ * access to the folder; it does not need update access to the knowledge base, which is for the
+ * knowledge base's own configuration.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CaitlynClient, CreateDocumentCommand } from "@caitlyn-ai/sdk"; // ES Modules import
+ * // const { CaitlynClient, CreateDocumentCommand } = 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 = { // CreateDocumentInput
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   idempotencyKey: "STRING_VALUE",
+ *   uploadId: "STRING_VALUE", // required
+ *   folder: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ * };
+ * const command = new CreateDocumentCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateDocumentOutput
+ * //   requestId: "STRING_VALUE",
+ * //   apiVersion: "STRING_VALUE",
+ * //   location: "STRING_VALUE",
+ * //   document: { // 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",
+ * //       },
+ * //     ],
+ * //   },
+ * //   operation: { // Operation
+ * //     id: "STRING_VALUE", // required
+ * //     kind: "document_ingestion", // required
+ * //     status: "queued" || "running" || "succeeded" || "succeeded_with_failures" || "failed" || "cancelled", // required
+ * //     createdAt: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateDocumentCommandInput - {@link CreateDocumentCommandInput}
+ * @returns {@link CreateDocumentCommandOutput}
+ * @see {@link CreateDocumentCommandInput} for command's `input` shape.
+ * @see {@link CreateDocumentCommandOutput} 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 UnprocessableContentError} (client fault)
+ *  The idempotency key was already used with a different request body.
+ *
+ * @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 Add an uploaded file to the HR folder
+ * ```javascript
+ * //
+ * const input = {
+ *   folder: "hr/",
+ *   idempotencyKey: "3f0c9a1e-5d2b-4f7a-9c1e-2b8d4a6f0e13",
+ *   knowledgeBaseId: "KB4T7YQ2WL",
+ *   name: "Leave policy",
+ *   uploadId: "0193a6f2-1111-7a2b-8c3d-4e5f60718293"
+ * };
+ * const command = new CreateDocumentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   document: {
+ *     createdAt: "2026-11-10T01:02:03.000Z",
+ *     folder: "hr/",
+ *     id: "doc-3b7f9e21",
+ *     knowledgeBaseId: "KB4T7YQ2WL",
+ *     name: "Leave policy",
+ *     status: "pending",
+ *     updatedAt: "2026-11-10T01:02:03.000Z"
+ *   },
+ *   location: "/api/v3/operations/0193a6f2-2222-7b3c-9d4e-5f6071829304",
+ *   operation: {
+ *     createdAt: "2026-11-10T01:02:03.000Z",
+ *     id: "0193a6f2-2222-7b3c-9d4e-5f6071829304",
+ *     kind: "document_ingestion",
+ *     status: "queued"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @example The upload was already used, or has expired
+ * ```javascript
+ * //
+ * const input = {
+ *   folder: "hr/",
+ *   knowledgeBaseId: "KB4T7YQ2WL",
+ *   uploadId: "0193a6f2-1111-7a2b-8c3d-4e5f60718293"
+ * };
+ * const command = new CreateDocumentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateDocumentCommand extends CreateDocumentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateDocumentInput;
+            output: CreateDocumentOutput;
+        };
+        sdk: {
+            input: CreateDocumentCommandInput;
+            output: CreateDocumentCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,165 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateUploadInput, CreateUploadOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateUploadCommand}.
+ */
+export interface CreateUploadCommandInput extends CreateUploadInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateUploadCommand}.
+ */
+export interface CreateUploadCommandOutput extends CreateUploadOutput, __MetadataBearer {
+}
+declare const CreateUploadCommand_base: {
+    new (input: CreateUploadCommandInput): import("@smithy/core/client").CommandImpl<CreateUploadCommandInput, CreateUploadCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateUploadCommandInput): import("@smithy/core/client").CommandImpl<CreateUploadCommandInput, CreateUploadCommandOutput, import("..").CaitlynClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Reserves a short-lived slot for a file's bytes and returns a presigned URL bound to their
+ * checksum.
+ *
+ * Send the bytes with `uploadMethod` to `uploadUrl`, with every header in `requiredHeaders`,
+ * before `expiresAt`; then pass the upload's `id` to the operation that uses it. The SDKs'
+ * `uploads.create(file)` does all of this.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CaitlynClient, CreateUploadCommand } from "@caitlyn-ai/sdk"; // ES Modules import
+ * // const { CaitlynClient, CreateUploadCommand } = 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 = { // CreateUploadInput
+ *   idempotencyKey: "STRING_VALUE",
+ *   fileName: "STRING_VALUE", // required
+ *   contentType: "STRING_VALUE", // required
+ *   byteSize: Number("long"), // required
+ *   sha256: "STRING_VALUE", // required
+ * };
+ * const command = new CreateUploadCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateUploadOutput
+ * //   requestId: "STRING_VALUE",
+ * //   apiVersion: "STRING_VALUE",
+ * //   location: "STRING_VALUE",
+ * //   id: "STRING_VALUE", // required
+ * //   uploadUrl: "STRING_VALUE", // required
+ * //   uploadMethod: "STRING_VALUE", // required
+ * //   requiredHeaders: { // HeaderMap // required
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   expiresAt: new Date("TIMESTAMP"), // required
+ * //   status: "awaiting_bytes" || "received" || "consumed" || "expired", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateUploadCommandInput - {@link CreateUploadCommandInput}
+ * @returns {@link CreateUploadCommandOutput}
+ * @see {@link CreateUploadCommandInput} for command's `input` shape.
+ * @see {@link CreateUploadCommandOutput} 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 PayloadTooLargeError} (client fault)
+ *  The body, a file or the send `context` is over its documented limit.
+ *
+ * @throws {@link UnprocessableContentError} (client fault)
+ *  The idempotency key was already used with a different request body.
+ *
+ * @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 Reserve an upload for a PDF
+ * ```javascript
+ * //
+ * const input = {
+ *   byteSize: 482113,
+ *   contentType: "application/pdf",
+ *   fileName: "leave-policy.pdf",
+ *   idempotencyKey: "9b1d4e2a-7c3f-4a8e-b5d6-0e1f2a3b4c5d",
+ *   sha256: "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg="
+ * };
+ * const command = new CreateUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   expiresAt: "2026-11-10T01:17:03.000Z",
+ *   id: "0193a6f2-1111-7a2b-8c3d-4e5f60718293",
+ *   location: "/api/v3/uploads/0193a6f2-1111-7a2b-8c3d-4e5f60718293",
+ *   requiredHeaders: {
+ *     Content-Type: "application/pdf"
+ *   },
+ *   status: "awaiting_bytes",
+ *   uploadMethod: "PUT",
+ *   uploadUrl: "https://uploads.example.com/0193a6f2-1111-7a2b-8c3d-4e5f60718293?signature=abc"
+ * }
+ * *\/
+ * ```
+ *
+ * @example A file over the size limit
+ * ```javascript
+ * //
+ * const input = {
+ *   byteSize: 9000000000,
+ *   contentType: "application/zip",
+ *   fileName: "archive.zip",
+ *   sha256: "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg="
+ * };
+ * const command = new CreateUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateUploadCommand extends CreateUploadCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateUploadInput;
+            output: CreateUploadOutput;
+        };
+        sdk: {
+            input: CreateUploadCommandInput;
+            output: CreateUploadCommandOutput;
+        };
+    };
+}