UNPKG

@vercel/sdk

Version:

<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>

226 lines (208 loc) 7.24 kB
/* * 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 ActivateKmsSigningKeyRequestBody = { /** * How many hours after activation the previously-active key should stop being used. Defaults to a 1 hour grace period so already-issued tokens keep verifying. */ revokePreviousAfterHours?: number | undefined; }; export type ActivateKmsSigningKeyRequest = { /** * The ID of the issuer. */ issuerId: string; /** * The ID of the pending signing key to activate. */ 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; requestBody?: ActivateKmsSigningKeyRequestBody | undefined; }; export const ActivateKmsSigningKeyStatus = { Active: "active", Pending: "pending", Revoking: "revoking", } as const; export type ActivateKmsSigningKeyStatus = ClosedEnum< typeof ActivateKmsSigningKeyStatus >; export type ActivateKmsSigningKeyPublicKey = { 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 ActivateKmsSigningKeyResponseBody = { /** * 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: ActivateKmsSigningKeyStatus; publicKey?: ActivateKmsSigningKeyPublicKey | 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; }; /** @internal */ export type ActivateKmsSigningKeyRequestBody$Outbound = { revokePreviousAfterHours?: number | undefined; }; /** @internal */ export const ActivateKmsSigningKeyRequestBody$outboundSchema: z.ZodType< ActivateKmsSigningKeyRequestBody$Outbound, z.ZodTypeDef, ActivateKmsSigningKeyRequestBody > = z.object({ revokePreviousAfterHours: z.number().optional(), }); export function activateKmsSigningKeyRequestBodyToJSON( activateKmsSigningKeyRequestBody: ActivateKmsSigningKeyRequestBody, ): string { return JSON.stringify( ActivateKmsSigningKeyRequestBody$outboundSchema.parse( activateKmsSigningKeyRequestBody, ), ); } /** @internal */ export type ActivateKmsSigningKeyRequest$Outbound = { issuerId: string; keyId: string; teamId?: string | undefined; slug?: string | undefined; RequestBody?: ActivateKmsSigningKeyRequestBody$Outbound | undefined; }; /** @internal */ export const ActivateKmsSigningKeyRequest$outboundSchema: z.ZodType< ActivateKmsSigningKeyRequest$Outbound, z.ZodTypeDef, ActivateKmsSigningKeyRequest > = z.object({ issuerId: z.string(), keyId: z.string(), teamId: z.string().optional(), slug: z.string().optional(), requestBody: z.lazy(() => ActivateKmsSigningKeyRequestBody$outboundSchema) .optional(), }).transform((v) => { return remap$(v, { requestBody: "RequestBody", }); }); export function activateKmsSigningKeyRequestToJSON( activateKmsSigningKeyRequest: ActivateKmsSigningKeyRequest, ): string { return JSON.stringify( ActivateKmsSigningKeyRequest$outboundSchema.parse( activateKmsSigningKeyRequest, ), ); } /** @internal */ export const ActivateKmsSigningKeyStatus$inboundSchema: z.ZodNativeEnum< typeof ActivateKmsSigningKeyStatus > = z.nativeEnum(ActivateKmsSigningKeyStatus); /** @internal */ export const ActivateKmsSigningKeyPublicKey$inboundSchema: z.ZodType< ActivateKmsSigningKeyPublicKey, 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 activateKmsSigningKeyPublicKeyFromJSON( jsonString: string, ): SafeParseResult<ActivateKmsSigningKeyPublicKey, SDKValidationError> { return safeParse( jsonString, (x) => ActivateKmsSigningKeyPublicKey$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ActivateKmsSigningKeyPublicKey' from JSON`, ); } /** @internal */ export const ActivateKmsSigningKeyResponseBody$inboundSchema: z.ZodType< ActivateKmsSigningKeyResponseBody, z.ZodTypeDef, unknown > = z.object({ keyId: types.string(), importKeyId: types.optional(types.string()), issuerId: types.string(), algorithm: types.string(), status: ActivateKmsSigningKeyStatus$inboundSchema, publicKey: types.optional( z.lazy(() => ActivateKmsSigningKeyPublicKey$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 activateKmsSigningKeyResponseBodyFromJSON( jsonString: string, ): SafeParseResult<ActivateKmsSigningKeyResponseBody, SDKValidationError> { return safeParse( jsonString, (x) => ActivateKmsSigningKeyResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ActivateKmsSigningKeyResponseBody' from JSON`, ); }