@vercel/sdk/src/models/revokekmssigningkeyop.ts

<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>

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

import * as z from "zod/v3";
import { remap as remap$ } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import * as types from "../types/primitives.js";
import { SDKValidationError } from "./sdkvalidationerror.js";

export type RevokeKmsSigningKeyRequest = {
  /**
   * The ID of the issuer.
   */
  issuerId: string;
  /**
   * The ID of the signing key to revoke immediately. The key must already be scheduled for revocation.
   */
  keyId: string;
  /**
   * The Team identifier to perform the request on behalf of.
   */
  teamId?: string | undefined;
  /**
   * The Team slug to perform the request on behalf of.
   */
  slug?: string | undefined;
};

export const RevokeKmsSigningKeyAlgorithm = {
  Es256: "ES256",
  Es384: "ES384",
  Es512: "ES512",
  EdDSA: "EdDSA",
  Ps256: "PS256",
  Ps384: "PS384",
  Ps512: "PS512",
  Rs256: "RS256",
  Rs384: "RS384",
  Rs512: "RS512",
} as const;
export type RevokeKmsSigningKeyAlgorithm = ClosedEnum<
  typeof RevokeKmsSigningKeyAlgorithm
>;

export const RevokeKmsSigningKeyOrigin = {
  External: "external",
  Vercel: "vercel",
} as const;
export type RevokeKmsSigningKeyOrigin = ClosedEnum<
  typeof RevokeKmsSigningKeyOrigin
>;

export const RevokeKmsSigningKeyStatus = {
  Active: "active",
  Pending: "pending",
  Revoking: "revoking",
} as const;
export type RevokeKmsSigningKeyStatus = ClosedEnum<
  typeof RevokeKmsSigningKeyStatus
>;

export type RevokeKmsSigningKeyPublicKey = {
  kty?: string | undefined;
  kid?: string | undefined;
  alg?: string | undefined;
  use?: string | undefined;
  keyOps?: Array<string> | undefined;
  /**
   * The X.509 certificate chain (RFC 7517 §4.7). Each entry is the base64 DER (not base64url) of a certificate. For keys minted with a stored certificate this holds the single self-signed cert as `[x5c]`.
   */
  x5c?: Array<string> | undefined;
  /**
   * The base64url SHA-256 thumbprint of the DER certificate in `x5c[0]` (RFC 7517 §4.9).
   */
  x5tNumberS256?: string | undefined;
};

export type RevokeKmsSigningKeySigningKeys = {
  /**
   * The server-minted, unique record identifier. Use this to address the key on the activate / certificate endpoints.
   */
  keyId: string;
  /**
   * The caller-supplied key id (imported keys only), used as the JWT/JWKS `kid`. Not unique across an issuer's keys; omitted for generated keys.
   */
  importKeyId?: string | undefined;
  issuerId: string;
  algorithm: string;
  status: RevokeKmsSigningKeyStatus;
  publicKey?: RevokeKmsSigningKeyPublicKey | undefined;
  publicKeyFingerprint?: string | undefined;
  /**
   * The public key in SPKI PEM form, ready to render. Present whenever the key has public key material. Derived from `publicKey`; the embedded certificate members (`x5c`/`x5t#S256`) do not affect it.
   */
  publicKeyPem?: string | undefined;
  /**
   * The stored X.509 certificate (from `publicKey.x5c[0]`) in PEM form, ready to render. Present only for keys created with a stored certificate; omitted for keys created before certificates were stored.
   */
  certificatePem?: string | undefined;
  createdAt: string;
  updatedAt: string;
  revokeAt?: string | undefined;
  activateAt?: string | undefined;
  /**
   * When the key became the active signer. Present for active and revoking keys (and absent for pending keys and rows predating this field).
   */
  activatedAt?: string | undefined;
};

export type RevokeKmsSigningKeyPolicies2 = {
  kind: "connex-grant";
  clientId: string;
  tokenClaims?: { [k: string]: any } | undefined;
  createdAt: string;
  updatedAt: string;
};

export type RevokeKmsSigningKeyPolicies1 = {
  kind: "project-grant";
  teamId: string;
  projectId: string;
  /**
   * Environments whose OIDC tokens this grant authorizes. Each entry is either a system environment slug (`production`, `preview`, `development`) or a custom environment ID (prefixed `env_`). Custom environments are matched against the token's `custom_environment_id` claim (the stable ID); system environments against its `environment` claim.
   */
  environments: Array<string>;
  tokenClaims?: { [k: string]: any } | undefined;
  createdAt: string;
  updatedAt: string;
};

export type RevokeKmsSigningKeyPolicies =
  | RevokeKmsSigningKeyPolicies1
  | RevokeKmsSigningKeyPolicies2;

export type RevokeKmsSigningKeyResponseBody = {
  id: string;
  ownerId: string;
  name: string;
  algorithm: RevokeKmsSigningKeyAlgorithm;
  origin: RevokeKmsSigningKeyOrigin;
  managedBy?: string | undefined;
  claimsSchema?: { [k: string]: any } | undefined;
  createdAt: string;
  updatedAt: string;
  signingKeys: Array<RevokeKmsSigningKeySigningKeys>;
  policies: Array<RevokeKmsSigningKeyPolicies1 | RevokeKmsSigningKeyPolicies2>;
};

/** @internal */
export type RevokeKmsSigningKeyRequest$Outbound = {
  issuerId: string;
  keyId: string;
  teamId?: string | undefined;
  slug?: string | undefined;
};

/** @internal */
export const RevokeKmsSigningKeyRequest$outboundSchema: z.ZodType<
  RevokeKmsSigningKeyRequest$Outbound,
  z.ZodTypeDef,
  RevokeKmsSigningKeyRequest
> = z.object({
  issuerId: z.string(),
  keyId: z.string(),
  teamId: z.string().optional(),
  slug: z.string().optional(),
});

export function revokeKmsSigningKeyRequestToJSON(
  revokeKmsSigningKeyRequest: RevokeKmsSigningKeyRequest,
): string {
  return JSON.stringify(
    RevokeKmsSigningKeyRequest$outboundSchema.parse(revokeKmsSigningKeyRequest),
  );
}

/** @internal */
export const RevokeKmsSigningKeyAlgorithm$inboundSchema: z.ZodNativeEnum<
  typeof RevokeKmsSigningKeyAlgorithm
> = z.nativeEnum(RevokeKmsSigningKeyAlgorithm);

/** @internal */
export const RevokeKmsSigningKeyOrigin$inboundSchema: z.ZodNativeEnum<
  typeof RevokeKmsSigningKeyOrigin
> = z.nativeEnum(RevokeKmsSigningKeyOrigin);

/** @internal */
export const RevokeKmsSigningKeyStatus$inboundSchema: z.ZodNativeEnum<
  typeof RevokeKmsSigningKeyStatus
> = z.nativeEnum(RevokeKmsSigningKeyStatus);

/** @internal */
export const RevokeKmsSigningKeyPublicKey$inboundSchema: z.ZodType<
  RevokeKmsSigningKeyPublicKey,
  z.ZodTypeDef,
  unknown
> = z.object({
  kty: types.optional(types.string()),
  kid: types.optional(types.string()),
  alg: types.optional(types.string()),
  use: types.optional(types.string()),
  key_ops: types.optional(z.array(types.string())),
  x5c: types.optional(z.array(types.string())),
  "x5t#S256": types.optional(types.string()),
}).transform((v) => {
  return remap$(v, {
    "key_ops": "keyOps",
    "x5t#S256": "x5tNumberS256",
  });
});

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

/** @internal */
export const RevokeKmsSigningKeySigningKeys$inboundSchema: z.ZodType<
  RevokeKmsSigningKeySigningKeys,
  z.ZodTypeDef,
  unknown
> = z.object({
  keyId: types.string(),
  importKeyId: types.optional(types.string()),
  issuerId: types.string(),
  algorithm: types.string(),
  status: RevokeKmsSigningKeyStatus$inboundSchema,
  publicKey: types.optional(
    z.lazy(() => RevokeKmsSigningKeyPublicKey$inboundSchema),
  ),
  publicKeyFingerprint: types.optional(types.string()),
  publicKeyPem: types.optional(types.string()),
  certificatePem: types.optional(types.string()),
  createdAt: types.string(),
  updatedAt: types.string(),
  revokeAt: types.optional(types.string()),
  activateAt: types.optional(types.string()),
  activatedAt: types.optional(types.string()),
});

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

/** @internal */
export const RevokeKmsSigningKeyPolicies2$inboundSchema: z.ZodType<
  RevokeKmsSigningKeyPolicies2,
  z.ZodTypeDef,
  unknown
> = z.object({
  kind: types.literal("connex-grant"),
  clientId: types.string(),
  tokenClaims: types.optional(z.record(z.any())),
  createdAt: types.string(),
  updatedAt: types.string(),
});

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

/** @internal */
export const RevokeKmsSigningKeyPolicies1$inboundSchema: z.ZodType<
  RevokeKmsSigningKeyPolicies1,
  z.ZodTypeDef,
  unknown
> = z.object({
  kind: types.literal("project-grant"),
  teamId: types.string(),
  projectId: types.string(),
  environments: z.array(types.string()),
  tokenClaims: types.optional(z.record(z.any())),
  createdAt: types.string(),
  updatedAt: types.string(),
});

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

/** @internal */
export const RevokeKmsSigningKeyPolicies$inboundSchema: z.ZodType<
  RevokeKmsSigningKeyPolicies,
  z.ZodTypeDef,
  unknown
> = z.union([
  z.lazy(() => RevokeKmsSigningKeyPolicies1$inboundSchema),
  z.lazy(() => RevokeKmsSigningKeyPolicies2$inboundSchema),
]);

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

/** @internal */
export const RevokeKmsSigningKeyResponseBody$inboundSchema: z.ZodType<
  RevokeKmsSigningKeyResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: types.string(),
  ownerId: types.string(),
  name: types.string(),
  algorithm: RevokeKmsSigningKeyAlgorithm$inboundSchema,
  origin: RevokeKmsSigningKeyOrigin$inboundSchema,
  managedBy: types.optional(types.string()),
  claimsSchema: types.optional(z.record(z.any())),
  createdAt: types.string(),
  updatedAt: types.string(),
  signingKeys: z.array(
    z.lazy(() => RevokeKmsSigningKeySigningKeys$inboundSchema),
  ),
  policies: z.array(
    z.union([
      z.lazy(() => RevokeKmsSigningKeyPolicies1$inboundSchema),
      z.lazy(() => RevokeKmsSigningKeyPolicies2$inboundSchema),
    ]),
  ),
});

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