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>

544 lines 22.7 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 * as types from "../types/primitives.js"; import { smartUnion } from "../types/smartUnion.js"; import { Pagination$inboundSchema } from "./pagination.js"; export const GetDeploymentsReadyState = { Blocked: "BLOCKED", Building: "BUILDING", Canceled: "CANCELED", Deleted: "DELETED", Error: "ERROR", Initializing: "INITIALIZING", Queued: "QUEUED", Ready: "READY", }; /** * The source of the deployment. */ export const GetDeploymentsSource = { ApiTriggerGitDeploy: "api-trigger-git-deploy", Cli: "cli", CloneRepo: "clone/repo", Drop: "drop", Git: "git", GitDeployHook: "git-deploy-hook", Import: "import", ImportRepo: "import/repo", Redeploy: "redeploy", V0Web: "v0-web", }; /** * In which state is the deployment. */ export const GetDeploymentsState = { Blocked: "BLOCKED", Building: "BUILDING", Canceled: "CANCELED", Deleted: "DELETED", Error: "ERROR", Initializing: "INITIALIZING", Queued: "QUEUED", Ready: "READY", }; /** * The type of the deployment. */ export const GetDeploymentsType = { Lambdas: "LAMBDAS", }; /** * Principal type of the deployment creator. Defaults to `"user"` if absent (legacy deployments created before principal attribution was recorded). */ export const GetDeploymentsDeploymentsType = { App: "app", Integration: "integration", System: "system", User: "user", }; /** * On which environment has the deployment been deployed to. */ export const GetDeploymentsTarget = { Production: "production", Staging: "staging", }; /** * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of gradually transitioning production traffic - PROMOTED: has seen production traffic */ export const GetDeploymentsReadySubstate = { Promoted: "PROMOTED", Rolling: "ROLLING", Staged: "STAGED", }; /** * State of all registered checks */ export const GetDeploymentsChecksState = { Completed: "completed", Registered: "registered", Running: "running", }; /** * Conclusion for checks */ export const GetDeploymentsChecksConclusion = { Canceled: "canceled", Failed: "failed", Skipped: "skipped", Succeeded: "succeeded", }; export const GetDeploymentsDeploymentsResponseState = { Failed: "failed", Pending: "pending", Succeeded: "succeeded", }; /** * Indicates if the deployment encountered an out-of-memory error. */ export const GetDeploymentsOomReport = { OutOfMemory: "out-of-memory", }; /** * Current provisioning state */ export const GetDeploymentsDeploymentsState = { Complete: "COMPLETE", Pending: "PENDING", Timeout: "TIMEOUT", }; export const GetDeploymentsFramework = { ActixWeb: "actix-web", Angular: "angular", Ash: "ash", Astro: "astro", Axum: "axum", Blitzjs: "blitzjs", Brunch: "brunch", Bun: "bun", Container: "container", CreateReactApp: "create-react-app", Django: "django", Docusaurus: "docusaurus", Docusaurus2: "docusaurus-2", Dojo: "dojo", Eleventy: "eleventy", Elysia: "elysia", Ember: "ember", Eve: "eve", Express: "express", FactoryEve: "factory-eve", Fastapi: "fastapi", Fasthtml: "fasthtml", Fastify: "fastify", Flask: "flask", Gatsby: "gatsby", Go: "go", Gridsome: "gridsome", H3: "h3", Hexo: "hexo", Hono: "hono", Hugo: "hugo", Hydrogen: "hydrogen", IonicAngular: "ionic-angular", IonicReact: "ionic-react", Jekyll: "jekyll", Koa: "koa", Mastra: "mastra", Middleman: "middleman", Nestjs: "nestjs", Nextjs: "nextjs", Nitro: "nitro", Node: "node", Nuxtjs: "nuxtjs", Parcel: "parcel", Polymer: "polymer", Preact: "preact", Python: "python", ReactRouter: "react-router", Redwoodjs: "redwoodjs", Remix: "remix", Ruby: "ruby", Rust: "rust", Saber: "saber", Sanity: "sanity", SanityV2: "sanity-v2", Sapper: "sapper", Scully: "scully", Services: "services", Solidstart: "solidstart", Solidstart1: "solidstart-1", Stencil: "stencil", Storybook: "storybook", Svelte: "svelte", Sveltekit: "sveltekit", Sveltekit1: "sveltekit-1", TanstackStart: "tanstack-start", TanstackStartLovable: "tanstack-start-lovable", Umijs: "umijs", Vite: "vite", Vitepress: "vitepress", Vue: "vue", Vuepress: "vuepress", Xmcp: "xmcp", Zola: "zola", }; export const GetDeploymentsNodeVersion = { TenDotX: "10.x", TwelveDotX: "12.x", FourteenDotX: "14.x", SixteenDotX: "16.x", EighteenDotX: "18.x", TwentyDotX: "20.x", TwentyTwoDotX: "22.x", TwentyFourDotX: "24.x", EightDot10DotX: "8.10.x", }; /** * Whether the value is an opaque identifier or a URL. */ export const GetDeploymentsDeploymentsResponseType = { Id: "id", Url: "url", }; /** * The NSNB decision code for the seat block. TODO: We should consolidate block types. */ export const GetDeploymentsBlockCode = { CommitAuthorRequired: "COMMIT_AUTHOR_REQUIRED", TeamAccessRequired: "TEAM_ACCESS_REQUIRED", }; /** * The git provider type associated with gitUserId. */ export const GetDeploymentsGitProvider = { Bitbucket: "bitbucket", Github: "github", Gitlab: "gitlab", }; /** @internal */ export const GetDeploymentsRequest$outboundSchema = z.object({ app: z.string().optional(), from: z.number().optional(), limit: z.number().optional(), projectId: z.string().optional(), projectIds: z.array(z.string()).optional(), target: z.string().optional(), to: z.number().optional(), users: z.string().optional(), since: z.number().optional(), until: z.number().optional(), state: z.string().optional(), rollbackCandidate: z.boolean().optional(), branch: z.string().optional(), sha: z.string().optional(), teamId: z.string().optional(), slug: z.string().optional(), }); export function getDeploymentsRequestToJSON(getDeploymentsRequest) { return JSON.stringify(GetDeploymentsRequest$outboundSchema.parse(getDeploymentsRequest)); } /** @internal */ export const GetDeploymentsReadyState$inboundSchema = z.nativeEnum(GetDeploymentsReadyState); /** @internal */ export const GetDeploymentsSource$inboundSchema = z.nativeEnum(GetDeploymentsSource); /** @internal */ export const GetDeploymentsState$inboundSchema = z.nativeEnum(GetDeploymentsState); /** @internal */ export const GetDeploymentsType$inboundSchema = z.nativeEnum(GetDeploymentsType); /** @internal */ export const GetDeploymentsDeploymentsType$inboundSchema = z.nativeEnum(GetDeploymentsDeploymentsType); /** @internal */ export const GetDeploymentsCreator$inboundSchema = z.object({ uid: types.string(), type: types.optional(GetDeploymentsDeploymentsType$inboundSchema), email: types.optional(types.string()), username: types.optional(types.string()), githubLogin: types.optional(types.string()), gitlabLogin: types.optional(types.string()), }); export function getDeploymentsCreatorFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsCreator$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsCreator' from JSON`); } /** @internal */ export const GetDeploymentsTarget$inboundSchema = z.nativeEnum(GetDeploymentsTarget); /** @internal */ export const GetDeploymentsAliasError$inboundSchema = z.object({ code: types.string(), message: types.string(), }); export function getDeploymentsAliasErrorFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsAliasError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsAliasError' from JSON`); } /** @internal */ export const GetDeploymentsAliasAssigned$inboundSchema = smartUnion([types.number(), types.boolean()]); export function getDeploymentsAliasAssignedFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsAliasAssigned$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsAliasAssigned' from JSON`); } /** @internal */ export const GetDeploymentsReadySubstate$inboundSchema = z.nativeEnum(GetDeploymentsReadySubstate); /** @internal */ export const GetDeploymentsChecksState$inboundSchema = z.nativeEnum(GetDeploymentsChecksState); /** @internal */ export const GetDeploymentsChecksConclusion$inboundSchema = z.nativeEnum(GetDeploymentsChecksConclusion); /** @internal */ export const GetDeploymentsDeploymentsResponseState$inboundSchema = z.nativeEnum(GetDeploymentsDeploymentsResponseState); /** @internal */ export const GetDeploymentsDeploymentAlias$inboundSchema = z.object({ state: GetDeploymentsDeploymentsResponseState$inboundSchema, startedAt: types.number(), completedAt: types.optional(types.number()), }); export function getDeploymentsDeploymentAliasFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsDeploymentAlias$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsDeploymentAlias' from JSON`); } /** @internal */ export const GetDeploymentsChecks$inboundSchema = z.object({ "deployment-alias": z.lazy(() => GetDeploymentsDeploymentAlias$inboundSchema), }).transform((v) => { return remap$(v, { "deployment-alias": "deploymentAlias", }); }); export function getDeploymentsChecksFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsChecks$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsChecks' from JSON`); } /** @internal */ export const GetDeploymentsOomReport$inboundSchema = z.nativeEnum(GetDeploymentsOomReport); /** @internal */ export const GetDeploymentsDeploymentsState$inboundSchema = z.nativeEnum(GetDeploymentsDeploymentsState); /** @internal */ export const GetDeploymentsManualProvisioning$inboundSchema = z.object({ state: GetDeploymentsDeploymentsState$inboundSchema, completedAt: types.optional(types.number()), }); export function getDeploymentsManualProvisioningFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsManualProvisioning$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsManualProvisioning' from JSON`); } /** @internal */ export const GetDeploymentsFramework$inboundSchema = z.nativeEnum(GetDeploymentsFramework); /** @internal */ export const GetDeploymentsNodeVersion$inboundSchema = z.nativeEnum(GetDeploymentsNodeVersion); /** @internal */ export const GetDeploymentsSpeedInsights$inboundSchema = z.object({ id: types.string(), enabledAt: types.optional(types.number()), disabledAt: types.optional(types.number()), canceledAt: types.optional(types.number()), hasData: types.optional(types.boolean()), dataReceivedAt: types.optional(types.number()), paidAt: types.optional(types.number()), }); export function getDeploymentsSpeedInsightsFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsSpeedInsights$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsSpeedInsights' from JSON`); } /** @internal */ export const GetDeploymentsWebAnalytics$inboundSchema = z.object({ id: types.string(), disabledAt: types.optional(types.number()), canceledAt: types.optional(types.number()), enabledAt: types.optional(types.number()), hasData: types.optional(types.literal(true)), }); export function getDeploymentsWebAnalyticsFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsWebAnalytics$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsWebAnalytics' from JSON`); } /** @internal */ export const GetDeploymentsGitComments$inboundSchema = z.object({ onPullRequest: types.boolean(), onCommit: types.boolean(), }); export function getDeploymentsGitCommentsFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsGitComments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsGitComments' from JSON`); } /** @internal */ export const GetDeploymentsProjectSettings$inboundSchema = z.object({ framework: z.nullable(GetDeploymentsFramework$inboundSchema).optional(), gitForkProtection: types.optional(types.boolean()), customerSupportCodeVisibility: types.optional(types.boolean()), gitLFS: types.optional(types.boolean()), devCommand: z.nullable(types.string()).optional(), installCommand: z.nullable(types.string()).optional(), buildCommand: z.nullable(types.string()).optional(), nodeVersion: types.optional(GetDeploymentsNodeVersion$inboundSchema), outputDirectory: z.nullable(types.string()).optional(), rootDirectory: z.nullable(types.string()).optional(), sourceFilesOutsideRootDirectory: types.optional(types.boolean()), commandForIgnoringBuildStep: z.nullable(types.string()).optional(), createdAt: types.optional(types.number()), speedInsights: types.optional(z.lazy(() => GetDeploymentsSpeedInsights$inboundSchema)), webAnalytics: types.optional(z.lazy(() => GetDeploymentsWebAnalytics$inboundSchema)), skipGitConnectDuringLink: types.optional(types.boolean()), gitComments: types.optional(z.lazy(() => GetDeploymentsGitComments$inboundSchema)), }); export function getDeploymentsProjectSettingsFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsProjectSettings$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsProjectSettings' from JSON`); } /** @internal */ export const GetDeploymentsDeploymentsSource$inboundSchema = z.object({ name: types.string(), }); export function getDeploymentsDeploymentsSourceFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsDeploymentsSource$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsDeploymentsSource' from JSON`); } /** @internal */ export const GetDeploymentsDeploymentsResponseType$inboundSchema = z.nativeEnum(GetDeploymentsDeploymentsResponseType); /** @internal */ export const GetDeploymentsOrigin$inboundSchema = z.object({ type: GetDeploymentsDeploymentsResponseType$inboundSchema, value: types.string(), }); export function getDeploymentsOriginFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsOrigin$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsOrigin' from JSON`); } /** @internal */ export const GetDeploymentsDeploymentsCreator$inboundSchema = z.object({ name: types.string(), avatar: types.optional(types.string()), }); export function getDeploymentsDeploymentsCreatorFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsDeploymentsCreator$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsDeploymentsCreator' from JSON`); } /** @internal */ export const GetDeploymentsPlatform$inboundSchema = z.object({ source: z.lazy(() => GetDeploymentsDeploymentsSource$inboundSchema), origin: z.lazy(() => GetDeploymentsOrigin$inboundSchema), creator: z.lazy(() => GetDeploymentsDeploymentsCreator$inboundSchema), meta: types.optional(z.record(types.string())), }); export function getDeploymentsPlatformFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsPlatform$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsPlatform' from JSON`); } /** @internal */ export const GetDeploymentsCustomEnvironment$inboundSchema = z.object({ id: types.string(), slug: types.optional(types.string()), }); export function getDeploymentsCustomEnvironmentFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsCustomEnvironment$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsCustomEnvironment' from JSON`); } /** @internal */ export const GetDeploymentsBlockCode$inboundSchema = z.nativeEnum(GetDeploymentsBlockCode); /** @internal */ export const GetDeploymentsGitUserId$inboundSchema = smartUnion([types.string(), types.number()]); export function getDeploymentsGitUserIdFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsGitUserId$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsGitUserId' from JSON`); } /** @internal */ export const GetDeploymentsGitProvider$inboundSchema = z.nativeEnum(GetDeploymentsGitProvider); /** @internal */ export const GetDeploymentsSeatBlock$inboundSchema = z.object({ blockCode: GetDeploymentsBlockCode$inboundSchema, userId: types.optional(types.string()), isVerified: types.optional(types.boolean()), gitUserId: types.optional(smartUnion([types.string(), types.number()])), gitProvider: types.optional(GetDeploymentsGitProvider$inboundSchema), }); export function getDeploymentsSeatBlockFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsSeatBlock$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsSeatBlock' from JSON`); } /** @internal */ export const GetDeploymentsCommitMeta$inboundSchema = z.object({ email: types.optional(types.string()), name: types.optional(types.string()), isVerified: types.optional(types.boolean()), }); export function getDeploymentsCommitMetaFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsCommitMeta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsCommitMeta' from JSON`); } /** @internal */ export const GetDeploymentsId$inboundSchema = smartUnion([types.string(), types.number()]); export function getDeploymentsIdFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsId$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsId' from JSON`); } /** @internal */ export const GetDeploymentsGitUser$inboundSchema = z.object({ id: smartUnion([types.string(), types.number()]), login: types.string(), type: types.optional(types.string()), provider: types.optional(types.string()), }); export function getDeploymentsGitUserFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsGitUser$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsGitUser' from JSON`); } /** @internal */ export const GetDeploymentsVercelUser$inboundSchema = z.object({ id: types.string(), username: types.string(), teamRoles: types.optional(z.array(types.string())), }); export function getDeploymentsVercelUserFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsVercelUser$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsVercelUser' from JSON`); } /** @internal */ export const GetDeploymentsAttribution$inboundSchema = z.object({ commitMeta: types.optional(z.lazy(() => GetDeploymentsCommitMeta$inboundSchema)), gitUser: types.optional(z.lazy(() => GetDeploymentsGitUser$inboundSchema)), vercelUser: types.optional(z.lazy(() => GetDeploymentsVercelUser$inboundSchema)), }); export function getDeploymentsAttributionFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsAttribution$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsAttribution' from JSON`); } /** @internal */ export const Deployments$inboundSchema = z.object({ createdAt: types.number(), readyState: GetDeploymentsReadyState$inboundSchema, uid: types.string(), name: types.string(), projectId: types.string(), url: types.string(), created: types.number(), defaultRoute: types.optional(types.string()), deleted: types.optional(types.number()), undeleted: types.optional(types.number()), softDeletedByRetention: types.optional(types.boolean()), source: types.optional(GetDeploymentsSource$inboundSchema), state: types.optional(GetDeploymentsState$inboundSchema), type: GetDeploymentsType$inboundSchema, creator: z.lazy(() => GetDeploymentsCreator$inboundSchema), meta: types.optional(z.record(types.string())), target: z.nullable(GetDeploymentsTarget$inboundSchema).optional(), aliasError: z.nullable(z.lazy(() => GetDeploymentsAliasError$inboundSchema)) .optional(), aliasAssigned: z.nullable(smartUnion([types.number(), types.boolean()])) .optional(), buildingAt: types.optional(types.number()), ready: types.optional(types.number()), readySubstate: types.optional(GetDeploymentsReadySubstate$inboundSchema), checksState: types.optional(GetDeploymentsChecksState$inboundSchema), checksConclusion: types.optional(GetDeploymentsChecksConclusion$inboundSchema), checks: types.optional(z.lazy(() => GetDeploymentsChecks$inboundSchema)), inspectorUrl: types.nullable(types.string()), errorCode: types.optional(types.string()), errorMessage: z.nullable(types.string()).optional(), oomReport: types.optional(GetDeploymentsOomReport$inboundSchema), isRollbackCandidate: z.nullable(types.boolean()).optional(), prebuilt: types.optional(types.boolean()), manualProvisioning: types.optional(z.lazy(() => GetDeploymentsManualProvisioning$inboundSchema)), projectSettings: types.optional(z.lazy(() => GetDeploymentsProjectSettings$inboundSchema)), connectBuildsEnabled: types.optional(types.boolean()), connectConfigurationId: types.optional(types.string()), passiveConnectConfigurationId: types.optional(types.string()), expiration: types.optional(types.number()), proposedExpiration: types.optional(types.number()), platform: types.optional(z.lazy(() => GetDeploymentsPlatform$inboundSchema)), customEnvironment: types.optional(z.lazy(() => GetDeploymentsCustomEnvironment$inboundSchema)), seatBlock: types.optional(z.lazy(() => GetDeploymentsSeatBlock$inboundSchema)), attribution: types.optional(z.lazy(() => GetDeploymentsAttribution$inboundSchema)), }); export function deploymentsFromJSON(jsonString) { return safeParse(jsonString, (x) => Deployments$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Deployments' from JSON`); } /** @internal */ export const GetDeploymentsResponseBody$inboundSchema = z.object({ pagination: Pagination$inboundSchema, deployments: z.array(z.lazy(() => Deployments$inboundSchema)), }); export function getDeploymentsResponseBodyFromJSON(jsonString) { return safeParse(jsonString, (x) => GetDeploymentsResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetDeploymentsResponseBody' from JSON`); } //# sourceMappingURL=getdeploymentsop.js.map