@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
55 lines • 2.72 kB
TypeScript
import * as z from "zod/v3";
import * as components from "../components/index.js";
import { UnkeyError } from "./unkeyerror.js";
/**
* Error response when a required service is temporarily unavailable. This indicates that the service exists but cannot be reached or is not responding.
*
* @remarks
*
* When you encounter this error:
* - The service is likely experiencing temporary issues
* - Retrying the request after a short delay may succeed
* - If the error persists, the service may be undergoing maintenance
* - Contact Unkey support if the issue continues
*/
export type ServiceUnavailableErrorResponseData = {
/**
* 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 a required service is temporarily unavailable. This indicates that the service exists but cannot be reached or is not responding.
*
* @remarks
*
* When you encounter this error:
* - The service is likely experiencing temporary issues
* - Retrying the request after a short delay may succeed
* - If the error persists, the service may be undergoing maintenance
* - Contact Unkey support if the issue continues
*/
export declare class ServiceUnavailableErrorResponse 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$: ServiceUnavailableErrorResponseData;
constructor(err: ServiceUnavailableErrorResponseData, httpMeta: {
response: Response;
request: Request;
body: string;
});
}
/** @internal */
export declare const ServiceUnavailableErrorResponse$inboundSchema: z.ZodType<ServiceUnavailableErrorResponse, z.ZodTypeDef, unknown>;
//# sourceMappingURL=serviceunavailableerrorresponse.d.ts.map