@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
25 lines • 1.22 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { V2RatelimitMultiLimitCheck } from "./v2ratelimitmultilimitcheck.js";
/**
* Container for multi-limit rate limit check results
*/
export type V2RatelimitMultiLimitResponseData = {
/**
* Overall success indicator for all rate limit checks. This is true if ALL individual rate limit checks passed (all have success: true), and false if ANY check failed.
*
* @remarks
*
* Use this as a quick indicator to determine if the request should proceed.
*/
passed: boolean;
/**
* Array of individual rate limit check results, one for each rate limit check in the request
*/
limits: Array<V2RatelimitMultiLimitCheck>;
};
/** @internal */
export declare const V2RatelimitMultiLimitResponseData$inboundSchema: z.ZodType<V2RatelimitMultiLimitResponseData, z.ZodTypeDef, unknown>;
export declare function v2RatelimitMultiLimitResponseDataFromJSON(jsonString: string): SafeParseResult<V2RatelimitMultiLimitResponseData, SDKValidationError>;
//# sourceMappingURL=v2ratelimitmultilimitresponsedata.d.ts.map