@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>
284 lines • 15.7 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export type ListDeploymentCheckRunsRequest = {
deploymentId: 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 declare const ListDeploymentCheckRunsRunsChecksV2Requires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type ListDeploymentCheckRunsRunsChecksV2Requires = ClosedEnum<typeof ListDeploymentCheckRunsRunsChecksV2Requires>;
export declare const ListDeploymentCheckRunsRunsChecksV2Blocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type ListDeploymentCheckRunsRunsChecksV2Blocks = ClosedEnum<typeof ListDeploymentCheckRunsRunsChecksV2Blocks>;
export declare const ListDeploymentCheckRunsRunsChecksV2Status: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type ListDeploymentCheckRunsRunsChecksV2Status = ClosedEnum<typeof ListDeploymentCheckRunsRunsChecksV2Status>;
export declare const ListDeploymentCheckRunsRunsChecksV2Conclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type ListDeploymentCheckRunsRunsChecksV2Conclusion = ClosedEnum<typeof ListDeploymentCheckRunsRunsChecksV2Conclusion>;
export declare const ListDeploymentCheckRunsSourceChecksV2ResponseOrigin: {
readonly Platform: "platform";
};
export type ListDeploymentCheckRunsSourceChecksV2ResponseOrigin = ClosedEnum<typeof ListDeploymentCheckRunsSourceChecksV2ResponseOrigin>;
/**
* CI sentinel — check run `source` only (no parent check).
*/
export type ListDeploymentCheckRunsSourceChecksV22 = {
subKind: "vercel-ci-sentinel";
origin: ListDeploymentCheckRunsSourceChecksV2ResponseOrigin;
};
export declare const ListDeploymentCheckRunsSourceChecksV2Origin: {
readonly Config: "config";
};
export type ListDeploymentCheckRunsSourceChecksV2Origin = ClosedEnum<typeof ListDeploymentCheckRunsSourceChecksV2Origin>;
/**
* Config-driven CI task — check run `source` only (no parent check).
*/
export type ListDeploymentCheckRunsSourceChecksV21 = {
subKind: "vercel-ci";
origin: ListDeploymentCheckRunsSourceChecksV2Origin;
invocationId: string;
jobDefinitionId: string;
};
export type ListDeploymentCheckRunsRunsChecksV2Source = ListDeploymentCheckRunsSourceChecksV21 | ListDeploymentCheckRunsSourceChecksV22;
/**
* Vercel CI check run without a parent `check` (no `checkId` field).
*/
export type ListDeploymentCheckRunsRuns2 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: ListDeploymentCheckRunsRunsChecksV2Requires | undefined;
blocks?: ListDeploymentCheckRunsRunsChecksV2Blocks | undefined;
targets?: Array<string> | undefined;
status: ListDeploymentCheckRunsRunsChecksV2Status;
conclusion?: ListDeploymentCheckRunsRunsChecksV2Conclusion | undefined;
conclusionText?: string | undefined;
externalId?: string | undefined;
externalUrl?: string | undefined;
output?: {
[k: string]: any;
} | undefined;
timeout: number;
createdAt: number;
updatedAt: number;
completedAt?: number | undefined;
source: ListDeploymentCheckRunsSourceChecksV21 | ListDeploymentCheckRunsSourceChecksV22;
};
export declare const ListDeploymentCheckRunsRunsRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type ListDeploymentCheckRunsRunsRequires = ClosedEnum<typeof ListDeploymentCheckRunsRunsRequires>;
export declare const ListDeploymentCheckRunsRunsBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type ListDeploymentCheckRunsRunsBlocks = ClosedEnum<typeof ListDeploymentCheckRunsRunsBlocks>;
export declare const ListDeploymentCheckRunsRunsStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type ListDeploymentCheckRunsRunsStatus = ClosedEnum<typeof ListDeploymentCheckRunsRunsStatus>;
export declare const ListDeploymentCheckRunsRunsConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type ListDeploymentCheckRunsRunsConclusion = ClosedEnum<typeof ListDeploymentCheckRunsRunsConclusion>;
export declare const ListDeploymentCheckRunsSourceSubKind: {
readonly VercelNativeCheck: "vercel-native-check";
};
export type ListDeploymentCheckRunsSourceSubKind = ClosedEnum<typeof ListDeploymentCheckRunsSourceSubKind>;
export declare const ListDeploymentCheckRunsSourceOrigin: {
readonly Api: "api";
readonly Platform: "platform";
};
export type ListDeploymentCheckRunsSourceOrigin = ClosedEnum<typeof ListDeploymentCheckRunsSourceOrigin>;
/**
* Native Vercel checks — check definition and check run `source`.
*/
export type ListDeploymentCheckRunsSource4 = {
subKind?: ListDeploymentCheckRunsSourceSubKind | undefined;
origin?: ListDeploymentCheckRunsSourceOrigin | undefined;
};
export declare const ListDeploymentCheckRunsSourceChecksV2ResponseKind: {
readonly GitProvider: "git-provider";
};
export type ListDeploymentCheckRunsSourceChecksV2ResponseKind = ClosedEnum<typeof ListDeploymentCheckRunsSourceChecksV2ResponseKind>;
export declare const ListDeploymentCheckRunsSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type ListDeploymentCheckRunsSourceProvider = ClosedEnum<typeof ListDeploymentCheckRunsSourceProvider>;
export type ListDeploymentCheckRunsSource3 = {
kind: ListDeploymentCheckRunsSourceChecksV2ResponseKind;
provider: ListDeploymentCheckRunsSourceProvider;
externalCheckName: string;
};
export declare const ListDeploymentCheckRunsSourceChecksV2Kind: {
readonly Webhook: "webhook";
};
export type ListDeploymentCheckRunsSourceChecksV2Kind = ClosedEnum<typeof ListDeploymentCheckRunsSourceChecksV2Kind>;
export type ListDeploymentCheckRunsSource2 = {
kind: ListDeploymentCheckRunsSourceChecksV2Kind;
webhookId?: string | undefined;
};
export declare const ListDeploymentCheckRunsSourceKind: {
readonly Integration: "integration";
};
export type ListDeploymentCheckRunsSourceKind = ClosedEnum<typeof ListDeploymentCheckRunsSourceKind>;
export type ListDeploymentCheckRunsSource1 = {
kind: ListDeploymentCheckRunsSourceKind;
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type ListDeploymentCheckRunsRunsSource = ListDeploymentCheckRunsSource1 | ListDeploymentCheckRunsSource3 | ListDeploymentCheckRunsSource2 | ListDeploymentCheckRunsSource4;
/**
* Check run backed by a project-level `check` definition.
*/
export type ListDeploymentCheckRunsRuns1 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: ListDeploymentCheckRunsRunsRequires | undefined;
blocks?: ListDeploymentCheckRunsRunsBlocks | undefined;
targets?: Array<string> | undefined;
status: ListDeploymentCheckRunsRunsStatus;
conclusion?: ListDeploymentCheckRunsRunsConclusion | undefined;
conclusionText?: string | undefined;
externalId?: string | undefined;
externalUrl?: string | undefined;
output?: {
[k: string]: any;
} | undefined;
timeout: number;
createdAt: number;
updatedAt: number;
completedAt?: number | undefined;
checkId: string;
source: ListDeploymentCheckRunsSource1 | ListDeploymentCheckRunsSource3 | ListDeploymentCheckRunsSource2 | ListDeploymentCheckRunsSource4;
};
export type ListDeploymentCheckRunsRuns = ListDeploymentCheckRunsRuns1 | ListDeploymentCheckRunsRuns2;
export type ListDeploymentCheckRunsResponseBody = {
runs: Array<ListDeploymentCheckRunsRuns1 | ListDeploymentCheckRunsRuns2>;
};
/** @internal */
export type ListDeploymentCheckRunsRequest$Outbound = {
deploymentId: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const ListDeploymentCheckRunsRequest$outboundSchema: z.ZodType<ListDeploymentCheckRunsRequest$Outbound, z.ZodTypeDef, ListDeploymentCheckRunsRequest>;
export declare function listDeploymentCheckRunsRequestToJSON(listDeploymentCheckRunsRequest: ListDeploymentCheckRunsRequest): string;
/** @internal */
export declare const ListDeploymentCheckRunsRunsChecksV2Requires$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsChecksV2Requires>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsChecksV2Blocks$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsChecksV2Blocks>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsChecksV2Status$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsChecksV2Status>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsChecksV2Conclusion$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsChecksV2Conclusion>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceChecksV2ResponseOrigin$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceChecksV2ResponseOrigin>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceChecksV22$inboundSchema: z.ZodType<ListDeploymentCheckRunsSourceChecksV22, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsSourceChecksV22FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsSourceChecksV22, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceChecksV2Origin$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceChecksV2Origin>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceChecksV21$inboundSchema: z.ZodType<ListDeploymentCheckRunsSourceChecksV21, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsSourceChecksV21FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsSourceChecksV21, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsChecksV2Source$inboundSchema: z.ZodType<ListDeploymentCheckRunsRunsChecksV2Source, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsRunsChecksV2SourceFromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsRunsChecksV2Source, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsRuns2$inboundSchema: z.ZodType<ListDeploymentCheckRunsRuns2, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsRuns2FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsRuns2, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsRequires$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsRequires>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsBlocks$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsBlocks>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsStatus$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsStatus>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsConclusion$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsRunsConclusion>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceSubKind$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceSubKind>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceOrigin$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceOrigin>;
/** @internal */
export declare const ListDeploymentCheckRunsSource4$inboundSchema: z.ZodType<ListDeploymentCheckRunsSource4, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsSource4FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsSource4, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceChecksV2ResponseKind$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceChecksV2ResponseKind>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceProvider$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceProvider>;
/** @internal */
export declare const ListDeploymentCheckRunsSource3$inboundSchema: z.ZodType<ListDeploymentCheckRunsSource3, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsSource3FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsSource3, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceChecksV2Kind$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceChecksV2Kind>;
/** @internal */
export declare const ListDeploymentCheckRunsSource2$inboundSchema: z.ZodType<ListDeploymentCheckRunsSource2, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsSource2FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsSource2, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsSourceKind$inboundSchema: z.ZodNativeEnum<typeof ListDeploymentCheckRunsSourceKind>;
/** @internal */
export declare const ListDeploymentCheckRunsSource1$inboundSchema: z.ZodType<ListDeploymentCheckRunsSource1, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsSource1FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsSource1, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsRunsSource$inboundSchema: z.ZodType<ListDeploymentCheckRunsRunsSource, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsRunsSourceFromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsRunsSource, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsRuns1$inboundSchema: z.ZodType<ListDeploymentCheckRunsRuns1, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsRuns1FromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsRuns1, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsRuns$inboundSchema: z.ZodType<ListDeploymentCheckRunsRuns, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsRunsFromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsRuns, SDKValidationError>;
/** @internal */
export declare const ListDeploymentCheckRunsResponseBody$inboundSchema: z.ZodType<ListDeploymentCheckRunsResponseBody, z.ZodTypeDef, unknown>;
export declare function listDeploymentCheckRunsResponseBodyFromJSON(jsonString: string): SafeParseResult<ListDeploymentCheckRunsResponseBody, SDKValidationError>;
//# sourceMappingURL=listdeploymentcheckrunsop.d.ts.map