@unkey/api/src/models/components/v2ratelimitmultilimitresponsedata.ts

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

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";
import { safeParse } from "../../lib/schemas.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import {
  V2RatelimitMultiLimitCheck,
  V2RatelimitMultiLimitCheck$inboundSchema,
} 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 const V2RatelimitMultiLimitResponseData$inboundSchema: z.ZodType<
  V2RatelimitMultiLimitResponseData,
  z.ZodTypeDef,
  unknown
> = z.object({
  passed: z.boolean(),
  limits: z.array(V2RatelimitMultiLimitCheck$inboundSchema),
});

export function v2RatelimitMultiLimitResponseDataFromJSON(
  jsonString: string,
): SafeParseResult<V2RatelimitMultiLimitResponseData, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => V2RatelimitMultiLimitResponseData$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'V2RatelimitMultiLimitResponseData' from JSON`,
  );
}