@unkey/api/dist/esm/models/errors/forbiddenerrorresponse.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 provided credentials are valid but lack sufficient permissions for the requested operation. This occurs when:
 *
 * @remarks
 * - The root key doesn't have the required permissions for this endpoint
 * - The operation requires elevated privileges that the current key lacks
 * - Access to the requested resource is restricted based on workspace settings
 *
 * To resolve this error, ensure your root key has the necessary permissions or contact your workspace administrator.
 */
export type ForbiddenErrorResponseData = {
    /**
     * 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 provided credentials are valid but lack sufficient permissions for the requested operation. This occurs when:
 *
 * @remarks
 * - The root key doesn't have the required permissions for this endpoint
 * - The operation requires elevated privileges that the current key lacks
 * - Access to the requested resource is restricted based on workspace settings
 *
 * To resolve this error, ensure your root key has the necessary permissions or contact your workspace administrator.
 */
export declare class ForbiddenErrorResponse 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$: ForbiddenErrorResponseData;
    constructor(err: ForbiddenErrorResponseData, httpMeta: {
        response: Response;
        request: Request;
        body: string;
    });
}
/** @internal */
export declare const ForbiddenErrorResponse$inboundSchema: z.ZodType<ForbiddenErrorResponse, z.ZodTypeDef, unknown>;
//# sourceMappingURL=forbiddenerrorresponse.d.ts.map