@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
52 lines • 2.25 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export type RatelimitLimitResponseData = {
/**
* The maximum number of requests allowed.
*/
limit: number;
/**
* The number of requests remaining in the current window.
*/
remaining: number;
/**
* The time in milliseconds when the rate limit will reset.
*/
reset: number;
/**
* Whether the request passed the ratelimit. If false, the request must be blocked.
*/
success: boolean;
/**
* The override that was used. May be empty
*/
overrideId?: string | undefined;
};
/** @internal */
export declare const RatelimitLimitResponseData$inboundSchema: z.ZodType<RatelimitLimitResponseData, z.ZodTypeDef, unknown>;
/** @internal */
export type RatelimitLimitResponseData$Outbound = {
limit: number;
remaining: number;
reset: number;
success: boolean;
overrideId?: string | undefined;
};
/** @internal */
export declare const RatelimitLimitResponseData$outboundSchema: z.ZodType<RatelimitLimitResponseData$Outbound, z.ZodTypeDef, RatelimitLimitResponseData>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace RatelimitLimitResponseData$ {
/** @deprecated use `RatelimitLimitResponseData$inboundSchema` instead. */
const inboundSchema: z.ZodType<RatelimitLimitResponseData, z.ZodTypeDef, unknown>;
/** @deprecated use `RatelimitLimitResponseData$outboundSchema` instead. */
const outboundSchema: z.ZodType<RatelimitLimitResponseData$Outbound, z.ZodTypeDef, RatelimitLimitResponseData>;
/** @deprecated use `RatelimitLimitResponseData$Outbound` instead. */
type Outbound = RatelimitLimitResponseData$Outbound;
}
export declare function ratelimitLimitResponseDataToJSON(ratelimitLimitResponseData: RatelimitLimitResponseData): string;
export declare function ratelimitLimitResponseDataFromJSON(jsonString: string): SafeParseResult<RatelimitLimitResponseData, SDKValidationError>;
//# sourceMappingURL=ratelimitlimitresponsedata.d.ts.map