@unkey/api/src/models/components/v2permissionsdeletepermissionrequestbody.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";

export type V2PermissionsDeletePermissionRequestBody = {
  /**
   * Specifies which permission to permanently delete from your workspace.
   *
   * @remarks
   *
   * This can be a permission ID or a permission slug.
   *
   * WARNING: Deleting a permission has immediate and irreversible consequences:
   * - All API keys with this permission will lose that access immediately
   * - All roles containing this permission will have it removed
   * - Any verification requests checking for this permission will fail
   * - This action cannot be undone
   *
   * Before deletion, ensure you:
   * - Have updated any keys or roles that depend on this permission
   * - Have migrated to alternative permissions if needed
   * - Have notified affected users about the access changes
   */
  permission: string;
};

/** @internal */
export type V2PermissionsDeletePermissionRequestBody$Outbound = {
  permission: string;
};

/** @internal */
export const V2PermissionsDeletePermissionRequestBody$outboundSchema: z.ZodType<
  V2PermissionsDeletePermissionRequestBody$Outbound,
  z.ZodTypeDef,
  V2PermissionsDeletePermissionRequestBody
> = z.object({
  permission: z.string(),
});

export function v2PermissionsDeletePermissionRequestBodyToJSON(
  v2PermissionsDeletePermissionRequestBody:
    V2PermissionsDeletePermissionRequestBody,
): string {
  return JSON.stringify(
    V2PermissionsDeletePermissionRequestBody$outboundSchema.parse(
      v2PermissionsDeletePermissionRequestBody,
    ),
  );
}