@unkey/api 0.38.0 → 2.0.0-alpha.11

package/src/models/components/v2keyscreatekeyrequestbody.ts

@@ -0,0 +1,224 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  KeyCreditsData,
+  KeyCreditsData$inboundSchema,
+  KeyCreditsData$Outbound,
+  KeyCreditsData$outboundSchema,
+} from "./keycreditsdata.js";
+import {
+  RatelimitRequest,
+  RatelimitRequest$inboundSchema,
+  RatelimitRequest$Outbound,
+  RatelimitRequest$outboundSchema,
+} from "./ratelimitrequest.js";
+
+export type V2KeysCreateKeyRequestBody = {
+  /**
+   * The API namespace this key belongs to.
+   *
+   * @remarks
+   * Keys from different APIs cannot access each other.
+   */
+  apiId: string;
+  /**
+   * Adds a visual identifier to the beginning of the generated key for easier recognition in logs and dashboards.
+   *
+   * @remarks
+   * The prefix becomes part of the actual key string (e.g., `prod_xxxxxxxxx`).
+   * Avoid using sensitive information in prefixes as they may appear in logs and error messages.
+   */
+  prefix?: string | undefined;
+  /**
+   * Sets a human-readable identifier for internal organization and dashboard display.
+   *
+   * @remarks
+   * Never exposed to end users, only visible in management interfaces and API responses.
+   * Avoid generic names like "API Key" when managing multiple keys for the same user or service.
+   */
+  name?: string | undefined;
+  /**
+   * Controls the cryptographic strength of the generated key in bytes.
+   *
+   * @remarks
+   * Higher values increase security but result in longer keys that may be more annoying to handle.
+   * The default 16 bytes provides 2^128 possible combinations, sufficient for most applications.
+   * Consider 32 bytes for highly sensitive APIs, but avoid values above 64 bytes unless specifically required.
+   */
+  byteLength?: number | undefined;
+  /**
+   * Links this key to a user or entity in your system using your own identifier.
+   *
+   * @remarks
+   * Returned during verification to identify the key owner without additional database lookups.
+   * Essential for user-specific analytics, billing, and multi-tenant key management.
+   * Use your primary user ID, organization ID, or tenant ID for best results.
+   * Accepts letters, numbers, underscores, dots, and hyphens for flexible identifier formats.
+   */
+  externalId?: string | undefined;
+  /**
+   * Stores arbitrary JSON metadata returned during key verification for contextual information.
+   *
+   * @remarks
+   * Eliminates additional database lookups during verification, improving performance for stateless services.
+   * Avoid storing sensitive data here as it's returned in verification responses.
+   * Large metadata objects increase verification latency and should stay under 10KB total size.
+   */
+  meta?: { [k: string]: any } | undefined;
+  /**
+   * Assigns existing roles to this key for permission management through role-based access control.
+   *
+   * @remarks
+   * Roles must already exist in your workspace before assignment.
+   * During verification, all permissions from assigned roles are checked against requested permissions.
+   * Roles provide a convenient way to group permissions and apply consistent access patterns across multiple keys.
+   */
+  roles?: Array<string> | undefined;
+  /**
+   * Grants specific permissions directly to this key without requiring role membership.
+   *
+   * @remarks
+   * Wildcard permissions like `documents.*` grant access to all sub-permissions including `documents.read` and `documents.write`.
+   * Direct permissions supplement any permissions inherited from assigned roles.
+   */
+  permissions?: Array<string> | undefined;
+  /**
+   * Sets when this key automatically expires as a Unix timestamp in milliseconds.
+   *
+   * @remarks
+   * Verification fails with code=EXPIRED immediately after this time passes.
+   * Omitting this field creates a permanent key that never expires.
+   *
+   * Avoid setting timestamps in the past as they immediately invalidate the key.
+   * Keys expire based on server time, not client time, which prevents timezone-related issues.
+   * Essential for trial periods, temporary access, and security compliance requiring key rotation.
+   */
+  expires?: number | undefined;
+  /**
+   * Credit configuration and remaining balance for this key.
+   */
+  credits?: KeyCreditsData | undefined;
+  /**
+   * Defines time-based rate limits that protect against abuse by controlling request frequency.
+   *
+   * @remarks
+   * Unlike credits which track total usage, rate limits reset automatically after each window expires.
+   * Multiple rate limits can control different operation types with separate thresholds and windows.
+   * Essential for preventing API abuse while maintaining good performance for legitimate usage.
+   */
+  ratelimits?: Array<RatelimitRequest> | undefined;
+  /**
+   * Controls whether the key is active immediately upon creation.
+   *
+   * @remarks
+   * When set to `false`, the key exists but all verification attempts fail with `code=DISABLED`.
+   * Useful for pre-creating keys that will be activated later or for keys requiring manual approval.
+   * Most keys should be created with `enabled=true` for immediate use.
+   */
+  enabled?: boolean | undefined;
+  /**
+   * Controls whether the plaintext key is stored in an encrypted vault for later retrieval.
+   *
+   * @remarks
+   * When true, allows recovering the actual key value using keys.getKey with decrypt=true.
+   * When false, the key value cannot be retrieved after creation for maximum security.
+   * Only enable for development keys or when key recovery is absolutely necessary.
+   */
+  recoverable?: boolean | undefined;
+};
+
+/** @internal */
+export const V2KeysCreateKeyRequestBody$inboundSchema: z.ZodType<
+  V2KeysCreateKeyRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  apiId: z.string(),
+  prefix: z.string().optional(),
+  name: z.string().optional(),
+  byteLength: z.number().int().default(16),
+  externalId: z.string().optional(),
+  meta: z.record(z.any()).optional(),
+  roles: z.array(z.string()).optional(),
+  permissions: z.array(z.string()).optional(),
+  expires: z.number().int().optional(),
+  credits: KeyCreditsData$inboundSchema.optional(),
+  ratelimits: z.array(RatelimitRequest$inboundSchema).optional(),
+  enabled: z.boolean().default(true),
+  recoverable: z.boolean().default(false),
+});
+
+/** @internal */
+export type V2KeysCreateKeyRequestBody$Outbound = {
+  apiId: string;
+  prefix?: string | undefined;
+  name?: string | undefined;
+  byteLength: number;
+  externalId?: string | undefined;
+  meta?: { [k: string]: any } | undefined;
+  roles?: Array<string> | undefined;
+  permissions?: Array<string> | undefined;
+  expires?: number | undefined;
+  credits?: KeyCreditsData$Outbound | undefined;
+  ratelimits?: Array<RatelimitRequest$Outbound> | undefined;
+  enabled: boolean;
+  recoverable: boolean;
+};
+
+/** @internal */
+export const V2KeysCreateKeyRequestBody$outboundSchema: z.ZodType<
+  V2KeysCreateKeyRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2KeysCreateKeyRequestBody
+> = z.object({
+  apiId: z.string(),
+  prefix: z.string().optional(),
+  name: z.string().optional(),
+  byteLength: z.number().int().default(16),
+  externalId: z.string().optional(),
+  meta: z.record(z.any()).optional(),
+  roles: z.array(z.string()).optional(),
+  permissions: z.array(z.string()).optional(),
+  expires: z.number().int().optional(),
+  credits: KeyCreditsData$outboundSchema.optional(),
+  ratelimits: z.array(RatelimitRequest$outboundSchema).optional(),
+  enabled: z.boolean().default(true),
+  recoverable: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2KeysCreateKeyRequestBody$ {
+  /** @deprecated use `V2KeysCreateKeyRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V2KeysCreateKeyRequestBody$inboundSchema;
+  /** @deprecated use `V2KeysCreateKeyRequestBody$outboundSchema` instead. */
+  export const outboundSchema = V2KeysCreateKeyRequestBody$outboundSchema;
+  /** @deprecated use `V2KeysCreateKeyRequestBody$Outbound` instead. */
+  export type Outbound = V2KeysCreateKeyRequestBody$Outbound;
+}
+
+export function v2KeysCreateKeyRequestBodyToJSON(
+  v2KeysCreateKeyRequestBody: V2KeysCreateKeyRequestBody,
+): string {
+  return JSON.stringify(
+    V2KeysCreateKeyRequestBody$outboundSchema.parse(v2KeysCreateKeyRequestBody),
+  );
+}
+
+export function v2KeysCreateKeyRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2KeysCreateKeyRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2KeysCreateKeyRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2KeysCreateKeyRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2keyscreatekeyresponsebody.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+import {
+  V2KeysCreateKeyResponseData,
+  V2KeysCreateKeyResponseData$inboundSchema,
+  V2KeysCreateKeyResponseData$Outbound,
+  V2KeysCreateKeyResponseData$outboundSchema,
+} from "./v2keyscreatekeyresponsedata.js";
+
+export type V2KeysCreateKeyResponseBody = {
+  /**
+   * 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;
+  data: V2KeysCreateKeyResponseData;
+};
+
+/** @internal */
+export const V2KeysCreateKeyResponseBody$inboundSchema: z.ZodType<
+  V2KeysCreateKeyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2KeysCreateKeyResponseData$inboundSchema,
+});
+
+/** @internal */
+export type V2KeysCreateKeyResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: V2KeysCreateKeyResponseData$Outbound;
+};
+
+/** @internal */
+export const V2KeysCreateKeyResponseBody$outboundSchema: z.ZodType<
+  V2KeysCreateKeyResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2KeysCreateKeyResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: V2KeysCreateKeyResponseData$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2KeysCreateKeyResponseBody$ {
+  /** @deprecated use `V2KeysCreateKeyResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2KeysCreateKeyResponseBody$inboundSchema;
+  /** @deprecated use `V2KeysCreateKeyResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V2KeysCreateKeyResponseBody$outboundSchema;
+  /** @deprecated use `V2KeysCreateKeyResponseBody$Outbound` instead. */
+  export type Outbound = V2KeysCreateKeyResponseBody$Outbound;
+}
+
+export function v2KeysCreateKeyResponseBodyToJSON(
+  v2KeysCreateKeyResponseBody: V2KeysCreateKeyResponseBody,
+): string {
+  return JSON.stringify(
+    V2KeysCreateKeyResponseBody$outboundSchema.parse(
+      v2KeysCreateKeyResponseBody,
+    ),
+  );
+}
+
+export function v2KeysCreateKeyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2KeysCreateKeyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2KeysCreateKeyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2KeysCreateKeyResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2keyscreatekeyresponsedata.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2KeysCreateKeyResponseData = {
+  /**
+   * The unique identifier for this key in Unkey's system. This is NOT the actual API key, but a reference ID used for management operations like updating or deleting the key. Store this ID in your database to reference the key later. This ID is not sensitive and can be logged or displayed in dashboards.
+   */
+  keyId: string;
+  /**
+   * The full generated API key that should be securely provided to your user.
+   *
+   * @remarks
+   * SECURITY WARNING: This is the only time you'll receive the complete key - Unkey only stores a securely hashed version. Never log or store this value in your own systems; provide it directly to your end user via secure channels. After this API call completes, this value cannot be retrieved again (unless created with `recoverable=true`).
+   */
+  key: string;
+};
+
+/** @internal */
+export const V2KeysCreateKeyResponseData$inboundSchema: z.ZodType<
+  V2KeysCreateKeyResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  keyId: z.string(),
+  key: z.string(),
+});
+
+/** @internal */
+export type V2KeysCreateKeyResponseData$Outbound = {
+  keyId: string;
+  key: string;
+};
+
+/** @internal */
+export const V2KeysCreateKeyResponseData$outboundSchema: z.ZodType<
+  V2KeysCreateKeyResponseData$Outbound,
+  z.ZodTypeDef,
+  V2KeysCreateKeyResponseData
+> = z.object({
+  keyId: z.string(),
+  key: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2KeysCreateKeyResponseData$ {
+  /** @deprecated use `V2KeysCreateKeyResponseData$inboundSchema` instead. */
+  export const inboundSchema = V2KeysCreateKeyResponseData$inboundSchema;
+  /** @deprecated use `V2KeysCreateKeyResponseData$outboundSchema` instead. */
+  export const outboundSchema = V2KeysCreateKeyResponseData$outboundSchema;
+  /** @deprecated use `V2KeysCreateKeyResponseData$Outbound` instead. */
+  export type Outbound = V2KeysCreateKeyResponseData$Outbound;
+}
+
+export function v2KeysCreateKeyResponseDataToJSON(
+  v2KeysCreateKeyResponseData: V2KeysCreateKeyResponseData,
+): string {
+  return JSON.stringify(
+    V2KeysCreateKeyResponseData$outboundSchema.parse(
+      v2KeysCreateKeyResponseData,
+    ),
+  );
+}
+
+export function v2KeysCreateKeyResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2KeysCreateKeyResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2KeysCreateKeyResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2KeysCreateKeyResponseData' from JSON`,
+  );
+}

package/src/models/components/v2keysdeletekeyrequestbody.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2KeysDeleteKeyRequestBody = {
+  /**
+   * Specifies which key to delete using the database identifier returned from `createKey`.
+   *
+   * @remarks
+   * Do not confuse this with the actual API key string that users include in requests.
+   * Deletion immediately invalidates the key, causing all future verification attempts to fail with `code=NOT_FOUND`.
+   * Key deletion triggers cache invalidation across all regions but may take up to 30 seconds to fully propagate.
+   */
+  keyId: string;
+  /**
+   * Controls deletion behavior between recoverable soft-deletion and irreversible permanent erasure.
+   *
+   * @remarks
+   * Soft deletion (default) preserves key data for potential recovery through direct database operations.
+   * Permanent deletion completely removes all traces including hash values and metadata with no recovery option.
+   *
+   * Use permanent deletion only for regulatory compliance (GDPR), resolving hash collisions, or when reusing identical key strings.
+   * Permanent deletion cannot be undone and may affect analytics data that references the deleted key.
+   * Most applications should use soft deletion to maintain audit trails and prevent accidental data loss.
+   */
+  permanent?: boolean | undefined;
+};
+
+/** @internal */
+export const V2KeysDeleteKeyRequestBody$inboundSchema: z.ZodType<
+  V2KeysDeleteKeyRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  keyId: z.string(),
+  permanent: z.boolean().default(false),
+});
+
+/** @internal */
+export type V2KeysDeleteKeyRequestBody$Outbound = {
+  keyId: string;
+  permanent: boolean;
+};
+
+/** @internal */
+export const V2KeysDeleteKeyRequestBody$outboundSchema: z.ZodType<
+  V2KeysDeleteKeyRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2KeysDeleteKeyRequestBody
+> = z.object({
+  keyId: z.string(),
+  permanent: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2KeysDeleteKeyRequestBody$ {
+  /** @deprecated use `V2KeysDeleteKeyRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V2KeysDeleteKeyRequestBody$inboundSchema;
+  /** @deprecated use `V2KeysDeleteKeyRequestBody$outboundSchema` instead. */
+  export const outboundSchema = V2KeysDeleteKeyRequestBody$outboundSchema;
+  /** @deprecated use `V2KeysDeleteKeyRequestBody$Outbound` instead. */
+  export type Outbound = V2KeysDeleteKeyRequestBody$Outbound;
+}
+
+export function v2KeysDeleteKeyRequestBodyToJSON(
+  v2KeysDeleteKeyRequestBody: V2KeysDeleteKeyRequestBody,
+): string {
+  return JSON.stringify(
+    V2KeysDeleteKeyRequestBody$outboundSchema.parse(v2KeysDeleteKeyRequestBody),
+  );
+}
+
+export function v2KeysDeleteKeyRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2KeysDeleteKeyRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2KeysDeleteKeyRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2KeysDeleteKeyRequestBody' from JSON`,
+  );
+}

package/src/models/components/v2keysdeletekeyresponsebody.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EmptyResponse,
+  EmptyResponse$inboundSchema,
+  EmptyResponse$Outbound,
+  EmptyResponse$outboundSchema,
+} from "./emptyresponse.js";
+import {
+  Meta,
+  Meta$inboundSchema,
+  Meta$Outbound,
+  Meta$outboundSchema,
+} from "./meta.js";
+
+export type V2KeysDeleteKeyResponseBody = {
+  /**
+   * 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;
+  /**
+   * Empty response object by design. A successful response indicates this operation was successfully executed.
+   */
+  data: EmptyResponse;
+};
+
+/** @internal */
+export const V2KeysDeleteKeyResponseBody$inboundSchema: z.ZodType<
+  V2KeysDeleteKeyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: EmptyResponse$inboundSchema,
+});
+
+/** @internal */
+export type V2KeysDeleteKeyResponseBody$Outbound = {
+  meta: Meta$Outbound;
+  data: EmptyResponse$Outbound;
+};
+
+/** @internal */
+export const V2KeysDeleteKeyResponseBody$outboundSchema: z.ZodType<
+  V2KeysDeleteKeyResponseBody$Outbound,
+  z.ZodTypeDef,
+  V2KeysDeleteKeyResponseBody
+> = z.object({
+  meta: Meta$outboundSchema,
+  data: EmptyResponse$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2KeysDeleteKeyResponseBody$ {
+  /** @deprecated use `V2KeysDeleteKeyResponseBody$inboundSchema` instead. */
+  export const inboundSchema = V2KeysDeleteKeyResponseBody$inboundSchema;
+  /** @deprecated use `V2KeysDeleteKeyResponseBody$outboundSchema` instead. */
+  export const outboundSchema = V2KeysDeleteKeyResponseBody$outboundSchema;
+  /** @deprecated use `V2KeysDeleteKeyResponseBody$Outbound` instead. */
+  export type Outbound = V2KeysDeleteKeyResponseBody$Outbound;
+}
+
+export function v2KeysDeleteKeyResponseBodyToJSON(
+  v2KeysDeleteKeyResponseBody: V2KeysDeleteKeyResponseBody,
+): string {
+  return JSON.stringify(
+    V2KeysDeleteKeyResponseBody$outboundSchema.parse(
+      v2KeysDeleteKeyResponseBody,
+    ),
+  );
+}
+
+export function v2KeysDeleteKeyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2KeysDeleteKeyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2KeysDeleteKeyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2KeysDeleteKeyResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2keysgetkeyrequestbody.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2KeysGetKeyRequestBody = {
+  /**
+   * Specifies which key to retrieve using the database identifier returned from `keys.createKey`.
+   *
+   * @remarks
+   * Do not confuse this with the actual API key string that users include in requests.
+   * Key data includes metadata, permissions, usage statistics, and configuration but never the plaintext key value unless `decrypt=true`.
+   * Find this ID in creation responses, key listings, dashboard, or verification responses.
+   */
+  keyId: string;
+  /**
+   * Controls whether to include the plaintext key value in the response for recovery purposes.
+   *
+   * @remarks
+   * Only works for keys created with `recoverable=true` and requires the `decrypt_key` permission.
+   * Returned keys must be handled securely, never logged, cached, or stored insecurely.
+   *
+   * Use only for legitimate recovery scenarios like user password resets or emergency access.
+   * Most applications should keep this false to maintain security best practices and avoid accidental key exposure.
+   * Decryption requests are audited and may trigger security alerts in enterprise environments.
+   */
+  decrypt?: boolean | undefined;
+};
+
+/** @internal */
+export const V2KeysGetKeyRequestBody$inboundSchema: z.ZodType<
+  V2KeysGetKeyRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  keyId: z.string(),
+  decrypt: z.boolean().default(false),
+});
+
+/** @internal */
+export type V2KeysGetKeyRequestBody$Outbound = {
+  keyId: string;
+  decrypt: boolean;
+};
+
+/** @internal */
+export const V2KeysGetKeyRequestBody$outboundSchema: z.ZodType<
+  V2KeysGetKeyRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2KeysGetKeyRequestBody
+> = z.object({
+  keyId: z.string(),
+  decrypt: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V2KeysGetKeyRequestBody$ {
+  /** @deprecated use `V2KeysGetKeyRequestBody$inboundSchema` instead. */
+  export const inboundSchema = V2KeysGetKeyRequestBody$inboundSchema;
+  /** @deprecated use `V2KeysGetKeyRequestBody$outboundSchema` instead. */
+  export const outboundSchema = V2KeysGetKeyRequestBody$outboundSchema;
+  /** @deprecated use `V2KeysGetKeyRequestBody$Outbound` instead. */
+  export type Outbound = V2KeysGetKeyRequestBody$Outbound;
+}
+
+export function v2KeysGetKeyRequestBodyToJSON(
+  v2KeysGetKeyRequestBody: V2KeysGetKeyRequestBody,
+): string {
+  return JSON.stringify(
+    V2KeysGetKeyRequestBody$outboundSchema.parse(v2KeysGetKeyRequestBody),
+  );
+}
+
+export function v2KeysGetKeyRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2KeysGetKeyRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2KeysGetKeyRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2KeysGetKeyRequestBody' from JSON`,
+  );
+}