@vercel/sdk/src/models/updatekmsissuerop.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 UpdateKmsIssuerRequestBody = {
  /**
   * The name of the issuer.
   */
  name?: string | undefined;
  /**
   * A JSON Schema used to validate the resolved token claims when signing tokens for this issuer. Pass null to remove it.
   */
  claimsSchema?: { [k: string]: any } | null | undefined;
};

export type UpdateKmsIssuerRequest = {
  /**
   * 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;
  requestBody?: UpdateKmsIssuerRequestBody | undefined;
};

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

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

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

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

export type UpdateKmsIssuerPolicies1 = {
  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 UpdateKmsIssuerPolicies =
  | UpdateKmsIssuerPolicies1
  | UpdateKmsIssuerPolicies2;

export type UpdateKmsIssuerResponseBody = {
  id: string;
  ownerId: string;
  name: string;
  algorithm: UpdateKmsIssuerAlgorithm;
  origin: UpdateKmsIssuerOrigin;
  managedBy?: string | undefined;
  claimsSchema?: { [k: string]: any } | undefined;
  createdAt: string;
  updatedAt: string;
  signingKeys: Array<UpdateKmsIssuerSigningKeys>;
  policies: Array<UpdateKmsIssuerPolicies1 | UpdateKmsIssuerPolicies2>;
};

/** @internal */
export type UpdateKmsIssuerRequestBody$Outbound = {
  name?: string | undefined;
  claimsSchema?: { [k: string]: any } | null | undefined;
};

/** @internal */
export const UpdateKmsIssuerRequestBody$outboundSchema: z.ZodType<
  UpdateKmsIssuerRequestBody$Outbound,
  z.ZodTypeDef,
  UpdateKmsIssuerRequestBody
> = z.object({
  name: z.string().optional(),
  claimsSchema: z.nullable(z.record(z.any())).optional(),
});

export function updateKmsIssuerRequestBodyToJSON(
  updateKmsIssuerRequestBody: UpdateKmsIssuerRequestBody,
): string {
  return JSON.stringify(
    UpdateKmsIssuerRequestBody$outboundSchema.parse(updateKmsIssuerRequestBody),
  );
}

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

/** @internal */
export const UpdateKmsIssuerRequest$outboundSchema: z.ZodType<
  UpdateKmsIssuerRequest$Outbound,
  z.ZodTypeDef,
  UpdateKmsIssuerRequest
> = z.object({
  issuerId: z.string(),
  teamId: z.string().optional(),
  slug: z.string().optional(),
  requestBody: z.lazy(() => UpdateKmsIssuerRequestBody$outboundSchema)
    .optional(),
}).transform((v) => {
  return remap$(v, {
    requestBody: "RequestBody",
  });
});

export function updateKmsIssuerRequestToJSON(
  updateKmsIssuerRequest: UpdateKmsIssuerRequest,
): string {
  return JSON.stringify(
    UpdateKmsIssuerRequest$outboundSchema.parse(updateKmsIssuerRequest),
  );
}

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

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

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

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

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

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

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

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

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

/** @internal */
export const UpdateKmsIssuerResponseBody$inboundSchema: z.ZodType<
  UpdateKmsIssuerResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  id: types.string(),
  ownerId: types.string(),
  name: types.string(),
  algorithm: UpdateKmsIssuerAlgorithm$inboundSchema,
  origin: UpdateKmsIssuerOrigin$inboundSchema,
  managedBy: types.optional(types.string()),
  claimsSchema: types.optional(z.record(z.any())),
  createdAt: types.string(),
  updatedAt: types.string(),
  signingKeys: z.array(z.lazy(() => UpdateKmsIssuerSigningKeys$inboundSchema)),
  policies: z.array(
    z.union([
      z.lazy(() => UpdateKmsIssuerPolicies1$inboundSchema),
      z.lazy(() => UpdateKmsIssuerPolicies2$inboundSchema),
    ]),
  ),
});

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