@caitlyn-ai/sdk 0.0.0-stage → 0.0.2

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

@@ -0,0 +1,659 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
+import { CaitlynServiceException as __BaseException } from "./CaitlynServiceException";
+import type { FieldError } from "./models_0";
+/**
+ * An unexpected server failure. Not retried by the SDKs.
+ * @public
+ */
+export declare class InternalError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "InternalError";
+    readonly $fault: "server";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalError, __BaseException>);
+}
+/**
+ * The record does not exist, or the caller may not see it. The two are deliberately the same, so
+ * identifiers cannot be probed.
+ * @public
+ */
+export declare class NotFoundError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "NotFoundError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotFoundError, __BaseException>);
+}
+/**
+ * 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.
+ * @public
+ */
+export declare class PermissionDeniedError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "PermissionDeniedError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PermissionDeniedError, __BaseException>);
+}
+/**
+ * `If-Match` does not match the resource's current ETag: it changed since the caller read it.
+ * @public
+ */
+export declare class PreconditionFailedError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "PreconditionFailedError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PreconditionFailedError, __BaseException>);
+}
+/**
+ * The update sent no `If-Match` header; read the resource and send its ETag.
+ * @public
+ */
+export declare class PreconditionRequiredError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "PreconditionRequiredError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PreconditionRequiredError, __BaseException>);
+}
+/**
+ * A dependency is briefly unavailable, or the request's audit event could not be recorded; wait for
+ * `Retry-After` and try again.
+ * @public
+ */
+export declare class ServiceUnavailableError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "ServiceUnavailableError";
+    readonly $fault: "server";
+    $retryable: {};
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * Seconds to wait before trying again, from the `Retry-After` header.
+     * @public
+     */
+    retryAfterSeconds?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceUnavailableError, __BaseException>);
+}
+/**
+ * Too many requests; wait for `Retry-After` and try again.
+ * @public
+ */
+export declare class TooManyRequestsError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "TooManyRequestsError";
+    readonly $fault: "client";
+    $retryable: {
+        throttling: boolean;
+    };
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * Seconds to wait before trying again, from the `Retry-After` header.
+     * @public
+     */
+    retryAfterSeconds?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TooManyRequestsError, __BaseException>);
+}
+/**
+ * No credential was sent, or it is expired or not valid.
+ * @public
+ */
+export declare class UnauthenticatedError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "UnauthenticatedError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthenticatedError, __BaseException>);
+}
+/**
+ * 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.
+ * @public
+ */
+export declare class ValidationError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "ValidationError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationError, __BaseException>);
+}
+/**
+ * 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.
+ * @public
+ */
+export declare class ConflictError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "ConflictError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictError, __BaseException>);
+}
+/**
+ * The body, a file or the send `context` is over its documented limit.
+ * @public
+ */
+export declare class PayloadTooLargeError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "PayloadTooLargeError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PayloadTooLargeError, __BaseException>);
+}
+/**
+ * The idempotency key was already used with a different request body.
+ * @public
+ */
+export declare class UnprocessableContentError extends __BaseException {
+    static readonly shapeId: string;
+    readonly name: "UnprocessableContentError";
+    readonly $fault: "client";
+    /**
+     * A stable URI for the code: its page in the public error reference,
+     * `https://build.caitlyn.ai/errors/\{code\}`.
+     * @public
+     */
+    type: string;
+    /**
+     * A short, human-readable summary of the problem, the same for every occurrence of the code.
+     * @public
+     */
+    title: string;
+    /**
+     * The HTTP status code, repeated from the response.
+     * @public
+     */
+    status: number;
+    /**
+     * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
+     * renamed; callers match on it.
+     * @public
+     */
+    code: string;
+    /**
+     * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
+     * storage keys or another person's data.
+     * @public
+     */
+    detail?: string | undefined;
+    /**
+     * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
+     * support.
+     * @public
+     */
+    requestId: string;
+    /**
+     * Field-level problems, one per member or parameter at fault. Present only on 400
+     * `VALIDATION_FAILED`.
+     * @public
+     */
+    errors?: FieldError[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnprocessableContentError, __BaseException>);
+}