@unkey/api/dist/commonjs/models/errors/unprocessableentityerrorresponse.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.

import * as z from "zod/v3";
import * as components from "../components/index.js";
import { UnkeyError } from "./unkeyerror.js";
/**
 * Error response when the request is syntactically valid but cannot be processed due to semantic constraints or resource limitations. This occurs when:
 *
 * @remarks
 * - A query exceeds execution time limits
 * - A query uses more memory than allowed
 * - A query scans too many rows
 * - A query result exceeds size limits
 *
 * The request syntax is correct, but the operation cannot be completed due to business rules or resource constraints. Review the error details for specific limitations and adjust your request accordingly.
 */
export type UnprocessableEntityErrorResponseData = {
    /**
     * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
     */
    meta: components.Meta;
    /**
     * Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
     */
    error: components.BaseError;
};
/**
 * Error response when the request is syntactically valid but cannot be processed due to semantic constraints or resource limitations. This occurs when:
 *
 * @remarks
 * - A query exceeds execution time limits
 * - A query uses more memory than allowed
 * - A query scans too many rows
 * - A query result exceeds size limits
 *
 * The request syntax is correct, but the operation cannot be completed due to business rules or resource constraints. Review the error details for specific limitations and adjust your request accordingly.
 */
export declare class UnprocessableEntityErrorResponse extends UnkeyError {
    /**
     * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
     */
    meta: components.Meta;
    /**
     * Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
     */
    error: components.BaseError;
    /** The original data that was passed to this error instance. */
    data$: UnprocessableEntityErrorResponseData;
    constructor(err: UnprocessableEntityErrorResponseData, httpMeta: {
        response: Response;
        request: Request;
        body: string;
    });
}
/** @internal */
export declare const UnprocessableEntityErrorResponse$inboundSchema: z.ZodType<UnprocessableEntityErrorResponse, z.ZodTypeDef, unknown>;
//# sourceMappingURL=unprocessableentityerrorresponse.d.ts.map