@vercel/sdk/src/models/getkmsissuerop.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 GetKmsIssuerRequest = {
  /**
   * The ID of the issuer.
   */
  issuerId: 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 GetKmsIssuerAlgorithm = {
  Es256: "ES256",
  Es384: "ES384",
  Es512: "ES512",
  EdDSA: "EdDSA",
  Ps256: "PS256",
  Ps384: "PS384",
  Ps512: "PS512",
  Rs256: "RS256",
  Rs384: "RS384",
  Rs512: "RS512",
} as const;
export type GetKmsIssuerAlgorithm = ClosedEnum<typeof GetKmsIssuerAlgorithm>;

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

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

export type GetKmsIssuerPublicKey = {
  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 GetKmsIssuerSigningKeys = {
  /**
   * 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: GetKmsIssuerStatus;
  publicKey?: GetKmsIssuerPublicKey | 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 GetKmsIssuerPolicies2 = {
  kind: "connex-grant";
  clientId: string;
  tokenClaims?: { [k: string]: any } | undefined;
  createdAt: string;
  updatedAt: string;
};

export type GetKmsIssuerPolicies1 = {
  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 GetKmsIssuerPolicies =
  | GetKmsIssuerPolicies1
  | GetKmsIssuerPolicies2;

export type GetKmsIssuerResponseBody = {
  id: string;
  ownerId: string;
  name: string;
  algorithm: GetKmsIssuerAlgorithm;
  origin: GetKmsIssuerOrigin;
  managedBy?: string | undefined;
  claimsSchema?: { [k: string]: any } | undefined;
  createdAt: string;
  updatedAt: string;
  signingKeys: Array<GetKmsIssuerSigningKeys>;
  policies: Array<GetKmsIssuerPolicies1 | GetKmsIssuerPolicies2>;
};

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

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

export function getKmsIssuerRequestToJSON(
  getKmsIssuerRequest: GetKmsIssuerRequest,
): string {
  return JSON.stringify(
    GetKmsIssuerRequest$outboundSchema.parse(getKmsIssuerRequest),
  );
}

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

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

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

/** @internal */
export const GetKmsIssuerPublicKey$inboundSchema: z.ZodType<
  GetKmsIssuerPublicKey,
  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 getKmsIssuerPublicKeyFromJSON(
  jsonString: string,
): SafeParseResult<GetKmsIssuerPublicKey, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetKmsIssuerPublicKey$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetKmsIssuerPublicKey' from JSON`,
  );
}

/** @internal */
export const GetKmsIssuerSigningKeys$inboundSchema: z.ZodType<
  GetKmsIssuerSigningKeys,
  z.ZodTypeDef,
  unknown
> = z.object({
  keyId: types.string(),
  importKeyId: types.optional(types.string()),
  issuerId: types.string(),
  algorithm: types.string(),
  status: GetKmsIssuerStatus$inboundSchema,
  publicKey: types.optional(z.lazy(() => GetKmsIssuerPublicKey$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 getKmsIssuerSigningKeysFromJSON(
  jsonString: string,
): SafeParseResult<GetKmsIssuerSigningKeys, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetKmsIssuerSigningKeys$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetKmsIssuerSigningKeys' from JSON`,
  );
}

/** @internal */
export const GetKmsIssuerPolicies2$inboundSchema: z.ZodType<
  GetKmsIssuerPolicies2,
  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 getKmsIssuerPolicies2FromJSON(
  jsonString: string,
): SafeParseResult<GetKmsIssuerPolicies2, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetKmsIssuerPolicies2$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetKmsIssuerPolicies2' from JSON`,
  );
}

/** @internal */
export const GetKmsIssuerPolicies1$inboundSchema: z.ZodType<
  GetKmsIssuerPolicies1,
  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 getKmsIssuerPolicies1FromJSON(
  jsonString: string,
): SafeParseResult<GetKmsIssuerPolicies1, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetKmsIssuerPolicies1$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetKmsIssuerPolicies1' from JSON`,
  );
}

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

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

/** @internal */
export const GetKmsIssuerResponseBody$inboundSchema: z.ZodType<
  GetKmsIssuerResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: types.string(),
  ownerId: types.string(),
  name: types.string(),
  algorithm: GetKmsIssuerAlgorithm$inboundSchema,
  origin: GetKmsIssuerOrigin$inboundSchema,
  managedBy: types.optional(types.string()),
  claimsSchema: types.optional(z.record(z.any())),
  createdAt: types.string(),
  updatedAt: types.string(),
  signingKeys: z.array(z.lazy(() => GetKmsIssuerSigningKeys$inboundSchema)),
  policies: z.array(
    z.union([
      z.lazy(() => GetKmsIssuerPolicies1$inboundSchema),
      z.lazy(() => GetKmsIssuerPolicies2$inboundSchema),
    ]),
  ),
});

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