UNPKG

@unkey/api

Version:

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

53 lines 2.61 kB
import * as z from "zod/v3"; import * as components from "../components/index.js"; import { UnkeyError } from "./unkeyerror.js"; /** * Error response when the requested resource has been soft-deleted and is no longer available. This occurs when: * * @remarks * - The resource has been marked as deleted but still exists in the database * - The resource is intentionally unavailable but could potentially be restored * - The resource cannot be restored through the API or dashboard * * To resolve this error, contact support if you need the resource restored. */ export type GoneErrorResponseData = { /** * 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 requested resource has been soft-deleted and is no longer available. This occurs when: * * @remarks * - The resource has been marked as deleted but still exists in the database * - The resource is intentionally unavailable but could potentially be restored * - The resource cannot be restored through the API or dashboard * * To resolve this error, contact support if you need the resource restored. */ export declare class GoneErrorResponse 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$: GoneErrorResponseData; constructor(err: GoneErrorResponseData, httpMeta: { response: Response; request: Request; body: string; }); } /** @internal */ export declare const GoneErrorResponse$inboundSchema: z.ZodType<GoneErrorResponse, z.ZodTypeDef, unknown>; //# sourceMappingURL=goneerrorresponse.d.ts.map