@unkey/api/src/models/components/v2permissionslistpermissionsresponsebody.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 { Meta, Meta$inboundSchema } from "./meta.js";
import { Pagination, Pagination$inboundSchema } from "./pagination.js";
import { Permission, Permission$inboundSchema } from "./permission.js";

export type V2PermissionsListPermissionsResponseBody = {
  /**
   * 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: Meta;
  /**
   * Array of permission objects with complete configuration details.
   */
  data: Array<Permission>;
  /**
   * Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
   */
  pagination?: Pagination | undefined;
};

/** @internal */
export const V2PermissionsListPermissionsResponseBody$inboundSchema: z.ZodType<
  V2PermissionsListPermissionsResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  meta: Meta$inboundSchema,
  data: z.array(Permission$inboundSchema),
  pagination: Pagination$inboundSchema.optional(),
});

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