UNPKG

@unkey/api

Version:

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

53 lines 2.69 kB
import * as z from "zod/v3"; import * as components from "../components/index.js"; import { UnkeyError } from "./unkeyerror.js"; /** * Error response when one or more conditions specified in the request headers are not met. This typically occurs when: * * @remarks * - Using conditional requests with If-Match or If-None-Match headers * - The resource version doesn't match the expected value * - Optimistic concurrency control detects a conflict * * To resolve this error, fetch the latest version of the resource and retry with updated conditions. */ export type PreconditionFailedErrorResponseData = { /** * 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 one or more conditions specified in the request headers are not met. This typically occurs when: * * @remarks * - Using conditional requests with If-Match or If-None-Match headers * - The resource version doesn't match the expected value * - Optimistic concurrency control detects a conflict * * To resolve this error, fetch the latest version of the resource and retry with updated conditions. */ export declare class PreconditionFailedErrorResponse 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$: PreconditionFailedErrorResponseData; constructor(err: PreconditionFailedErrorResponseData, httpMeta: { response: Response; request: Request; body: string; }); } /** @internal */ export declare const PreconditionFailedErrorResponse$inboundSchema: z.ZodType<PreconditionFailedErrorResponse, z.ZodTypeDef, unknown>; //# sourceMappingURL=preconditionfailederrorresponse.d.ts.map