@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>
290 lines • 15.3 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 CreateDeploymentCheckRunRequestBody = {
checkId: string;
};
export type CreateDeploymentCheckRunRequest = {
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;
requestBody?: CreateDeploymentCheckRunRequestBody | undefined;
};
export declare const CreateDeploymentCheckRunResponseBodyRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type CreateDeploymentCheckRunResponseBodyRequires = ClosedEnum<typeof CreateDeploymentCheckRunResponseBodyRequires>;
export declare const CreateDeploymentCheckRunResponseBodyBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type CreateDeploymentCheckRunResponseBodyBlocks = ClosedEnum<typeof CreateDeploymentCheckRunResponseBodyBlocks>;
export declare const CreateDeploymentCheckRunResponseBodyStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type CreateDeploymentCheckRunResponseBodyStatus = ClosedEnum<typeof CreateDeploymentCheckRunResponseBodyStatus>;
export declare const ResponseBodyConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type ResponseBodyConclusion = ClosedEnum<typeof ResponseBodyConclusion>;
export declare const CreateDeploymentCheckRunSourceOrigin: {
readonly Platform: "platform";
};
export type CreateDeploymentCheckRunSourceOrigin = ClosedEnum<typeof CreateDeploymentCheckRunSourceOrigin>;
/**
* CI sentinel — check run `source` only (no parent check).
*/
export type CreateDeploymentCheckRunSourceChecksV22 = {
subKind: "vercel-ci-sentinel";
origin: CreateDeploymentCheckRunSourceOrigin;
};
export declare const SourceOrigin: {
readonly Config: "config";
};
export type SourceOrigin = ClosedEnum<typeof SourceOrigin>;
/**
* Config-driven CI task — check run `source` only (no parent check).
*/
export type CreateDeploymentCheckRunSourceChecksV21 = {
subKind: "vercel-ci";
origin: SourceOrigin;
invocationId: string;
jobDefinitionId: string;
};
export type CreateDeploymentCheckRunResponseBodySource = CreateDeploymentCheckRunSourceChecksV21 | CreateDeploymentCheckRunSourceChecksV22;
/**
* Vercel CI check run without a parent `check` (no `checkId` field).
*/
export type CreateDeploymentCheckRunResponseBody2 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: CreateDeploymentCheckRunResponseBodyRequires | undefined;
blocks?: CreateDeploymentCheckRunResponseBodyBlocks | undefined;
targets?: Array<string> | undefined;
status: CreateDeploymentCheckRunResponseBodyStatus;
conclusion?: ResponseBodyConclusion | 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: CreateDeploymentCheckRunSourceChecksV21 | CreateDeploymentCheckRunSourceChecksV22;
};
export declare const ResponseBodyRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type ResponseBodyRequires = ClosedEnum<typeof ResponseBodyRequires>;
export declare const ResponseBodyBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type ResponseBodyBlocks = ClosedEnum<typeof ResponseBodyBlocks>;
export declare const ResponseBodyStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type ResponseBodyStatus = ClosedEnum<typeof ResponseBodyStatus>;
export declare const CreateDeploymentCheckRunResponseBodyConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type CreateDeploymentCheckRunResponseBodyConclusion = ClosedEnum<typeof CreateDeploymentCheckRunResponseBodyConclusion>;
export declare const SubKind: {
readonly VercelNativeCheck: "vercel-native-check";
};
export type SubKind = ClosedEnum<typeof SubKind>;
export declare const CreateDeploymentCheckRunSourceChecksV2Origin: {
readonly Api: "api";
readonly Platform: "platform";
};
export type CreateDeploymentCheckRunSourceChecksV2Origin = ClosedEnum<typeof CreateDeploymentCheckRunSourceChecksV2Origin>;
/**
* Native Vercel checks — check definition and check run `source`.
*/
export type CreateDeploymentCheckRunSource4 = {
subKind?: SubKind | undefined;
origin?: CreateDeploymentCheckRunSourceChecksV2Origin | undefined;
};
export declare const CreateDeploymentCheckRunSourceChecksV2ResponseKind: {
readonly GitProvider: "git-provider";
};
export type CreateDeploymentCheckRunSourceChecksV2ResponseKind = ClosedEnum<typeof CreateDeploymentCheckRunSourceChecksV2ResponseKind>;
export declare const CreateDeploymentCheckRunSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type CreateDeploymentCheckRunSourceProvider = ClosedEnum<typeof CreateDeploymentCheckRunSourceProvider>;
export type CreateDeploymentCheckRunSource3 = {
kind: CreateDeploymentCheckRunSourceChecksV2ResponseKind;
provider: CreateDeploymentCheckRunSourceProvider;
externalCheckName: string;
};
export declare const CreateDeploymentCheckRunSourceChecksV2Kind: {
readonly Webhook: "webhook";
};
export type CreateDeploymentCheckRunSourceChecksV2Kind = ClosedEnum<typeof CreateDeploymentCheckRunSourceChecksV2Kind>;
export type CreateDeploymentCheckRunSource2 = {
kind: CreateDeploymentCheckRunSourceChecksV2Kind;
webhookId?: string | undefined;
};
export declare const CreateDeploymentCheckRunSourceKind: {
readonly Integration: "integration";
};
export type CreateDeploymentCheckRunSourceKind = ClosedEnum<typeof CreateDeploymentCheckRunSourceKind>;
export type CreateDeploymentCheckRunSource1 = {
kind: CreateDeploymentCheckRunSourceKind;
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type ResponseBodySource = CreateDeploymentCheckRunSource1 | CreateDeploymentCheckRunSource3 | CreateDeploymentCheckRunSource2 | CreateDeploymentCheckRunSource4;
/**
* Check run backed by a project-level `check` definition.
*/
export type CreateDeploymentCheckRunResponseBody1 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: ResponseBodyRequires | undefined;
blocks?: ResponseBodyBlocks | undefined;
targets?: Array<string> | undefined;
status: ResponseBodyStatus;
conclusion?: CreateDeploymentCheckRunResponseBodyConclusion | 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: CreateDeploymentCheckRunSource1 | CreateDeploymentCheckRunSource3 | CreateDeploymentCheckRunSource2 | CreateDeploymentCheckRunSource4;
};
export type CreateDeploymentCheckRunResponseBody = CreateDeploymentCheckRunResponseBody1 | CreateDeploymentCheckRunResponseBody2;
/** @internal */
export type CreateDeploymentCheckRunRequestBody$Outbound = {
checkId: string;
};
/** @internal */
export declare const CreateDeploymentCheckRunRequestBody$outboundSchema: z.ZodType<CreateDeploymentCheckRunRequestBody$Outbound, z.ZodTypeDef, CreateDeploymentCheckRunRequestBody>;
export declare function createDeploymentCheckRunRequestBodyToJSON(createDeploymentCheckRunRequestBody: CreateDeploymentCheckRunRequestBody): string;
/** @internal */
export type CreateDeploymentCheckRunRequest$Outbound = {
deploymentId: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody?: CreateDeploymentCheckRunRequestBody$Outbound | undefined;
};
/** @internal */
export declare const CreateDeploymentCheckRunRequest$outboundSchema: z.ZodType<CreateDeploymentCheckRunRequest$Outbound, z.ZodTypeDef, CreateDeploymentCheckRunRequest>;
export declare function createDeploymentCheckRunRequestToJSON(createDeploymentCheckRunRequest: CreateDeploymentCheckRunRequest): string;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBodyRequires$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunResponseBodyRequires>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBodyBlocks$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunResponseBodyBlocks>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBodyStatus$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunResponseBodyStatus>;
/** @internal */
export declare const ResponseBodyConclusion$inboundSchema: z.ZodNativeEnum<typeof ResponseBodyConclusion>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceOrigin$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunSourceOrigin>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceChecksV22$inboundSchema: z.ZodType<CreateDeploymentCheckRunSourceChecksV22, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunSourceChecksV22FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunSourceChecksV22, SDKValidationError>;
/** @internal */
export declare const SourceOrigin$inboundSchema: z.ZodNativeEnum<typeof SourceOrigin>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceChecksV21$inboundSchema: z.ZodType<CreateDeploymentCheckRunSourceChecksV21, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunSourceChecksV21FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunSourceChecksV21, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBodySource$inboundSchema: z.ZodType<CreateDeploymentCheckRunResponseBodySource, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunResponseBodySourceFromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunResponseBodySource, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBody2$inboundSchema: z.ZodType<CreateDeploymentCheckRunResponseBody2, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunResponseBody2FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunResponseBody2, SDKValidationError>;
/** @internal */
export declare const ResponseBodyRequires$inboundSchema: z.ZodNativeEnum<typeof ResponseBodyRequires>;
/** @internal */
export declare const ResponseBodyBlocks$inboundSchema: z.ZodNativeEnum<typeof ResponseBodyBlocks>;
/** @internal */
export declare const ResponseBodyStatus$inboundSchema: z.ZodNativeEnum<typeof ResponseBodyStatus>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBodyConclusion$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunResponseBodyConclusion>;
/** @internal */
export declare const SubKind$inboundSchema: z.ZodNativeEnum<typeof SubKind>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceChecksV2Origin$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunSourceChecksV2Origin>;
/** @internal */
export declare const CreateDeploymentCheckRunSource4$inboundSchema: z.ZodType<CreateDeploymentCheckRunSource4, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunSource4FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunSource4, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceChecksV2ResponseKind$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunSourceChecksV2ResponseKind>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceProvider$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunSourceProvider>;
/** @internal */
export declare const CreateDeploymentCheckRunSource3$inboundSchema: z.ZodType<CreateDeploymentCheckRunSource3, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunSource3FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunSource3, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceChecksV2Kind$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunSourceChecksV2Kind>;
/** @internal */
export declare const CreateDeploymentCheckRunSource2$inboundSchema: z.ZodType<CreateDeploymentCheckRunSource2, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunSource2FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunSource2, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunSourceKind$inboundSchema: z.ZodNativeEnum<typeof CreateDeploymentCheckRunSourceKind>;
/** @internal */
export declare const CreateDeploymentCheckRunSource1$inboundSchema: z.ZodType<CreateDeploymentCheckRunSource1, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunSource1FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunSource1, SDKValidationError>;
/** @internal */
export declare const ResponseBodySource$inboundSchema: z.ZodType<ResponseBodySource, z.ZodTypeDef, unknown>;
export declare function responseBodySourceFromJSON(jsonString: string): SafeParseResult<ResponseBodySource, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBody1$inboundSchema: z.ZodType<CreateDeploymentCheckRunResponseBody1, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunResponseBody1FromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunResponseBody1, SDKValidationError>;
/** @internal */
export declare const CreateDeploymentCheckRunResponseBody$inboundSchema: z.ZodType<CreateDeploymentCheckRunResponseBody, z.ZodTypeDef, unknown>;
export declare function createDeploymentCheckRunResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateDeploymentCheckRunResponseBody, SDKValidationError>;
//# sourceMappingURL=createdeploymentcheckrunop.d.ts.map