@unkey/api/dist/esm/models/components/verifykeyratelimitdata.d.ts

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

import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export type VerifyKeyRatelimitData = {
    /**
     * Whether the rate limit was exceeded.
     */
    exceeded: boolean;
    /**
     * Unique identifier for this rate limit configuration.
     */
    id: string;
    /**
     * Human-readable name for this rate limit.
     */
    name: string;
    /**
     * Maximum requests allowed within the time window.
     */
    limit: number;
    /**
     * Rate limit window duration in milliseconds.
     */
    duration: number;
    /**
     * Rate limit reset duration in milliseconds.
     */
    reset: number;
    /**
     * Rate limit remaining requests within the time window.
     */
    remaining: number;
    /**
     * Whether this rate limit should be automatically applied when verifying keys.
     *
     * @remarks
     * When true, we will automatically apply this limit during verification without it being explicitly listed.
     */
    autoApply: boolean;
};
/** @internal */
export declare const VerifyKeyRatelimitData$inboundSchema: z.ZodType<VerifyKeyRatelimitData, z.ZodTypeDef, unknown>;
export declare function verifyKeyRatelimitDataFromJSON(jsonString: string): SafeParseResult<VerifyKeyRatelimitData, SDKValidationError>;
//# sourceMappingURL=verifykeyratelimitdata.d.ts.map