@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.5 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 GetDeploymentCheckRunRequest = {
deploymentId: string;
/**
* The ID of the resource that will be updated.
*/
checkRunId: 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 GetDeploymentCheckRunResponseBodyChecksV2Requires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type GetDeploymentCheckRunResponseBodyChecksV2Requires = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Requires>;
export declare const GetDeploymentCheckRunResponseBodyChecksV2Blocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type GetDeploymentCheckRunResponseBodyChecksV2Blocks = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Blocks>;
export declare const GetDeploymentCheckRunResponseBodyChecksV2Status: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type GetDeploymentCheckRunResponseBodyChecksV2Status = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Status>;
export declare const GetDeploymentCheckRunResponseBodyChecksV2Conclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type GetDeploymentCheckRunResponseBodyChecksV2Conclusion = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Conclusion>;
export declare const GetDeploymentCheckRunSourceChecksV2ResponseOrigin: {
readonly Platform: "platform";
};
export type GetDeploymentCheckRunSourceChecksV2ResponseOrigin = ClosedEnum<typeof GetDeploymentCheckRunSourceChecksV2ResponseOrigin>;
/**
* CI sentinel — check run `source` only (no parent check).
*/
export type GetDeploymentCheckRunSourceChecksV22 = {
subKind: "vercel-ci-sentinel";
origin: GetDeploymentCheckRunSourceChecksV2ResponseOrigin;
};
export declare const GetDeploymentCheckRunSourceChecksV2Origin: {
readonly Config: "config";
};
export type GetDeploymentCheckRunSourceChecksV2Origin = ClosedEnum<typeof GetDeploymentCheckRunSourceChecksV2Origin>;
/**
* Config-driven CI task — check run `source` only (no parent check).
*/
export type GetDeploymentCheckRunSourceChecksV21 = {
subKind: "vercel-ci";
origin: GetDeploymentCheckRunSourceChecksV2Origin;
invocationId: string;
invocationAttempt?: number | undefined;
jobDefinitionId: string;
};
export type GetDeploymentCheckRunResponseBodyChecksV2Source = GetDeploymentCheckRunSourceChecksV21 | GetDeploymentCheckRunSourceChecksV22;
/**
* Vercel CI check run without a parent `check` (no `checkId` field).
*/
export type GetDeploymentCheckRunResponseBody2 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: GetDeploymentCheckRunResponseBodyChecksV2Requires | undefined;
blocks?: GetDeploymentCheckRunResponseBodyChecksV2Blocks | undefined;
targets?: Array<string> | undefined;
status: GetDeploymentCheckRunResponseBodyChecksV2Status;
conclusion?: GetDeploymentCheckRunResponseBodyChecksV2Conclusion | 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: GetDeploymentCheckRunSourceChecksV21 | GetDeploymentCheckRunSourceChecksV22;
};
export declare const GetDeploymentCheckRunResponseBodyRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type GetDeploymentCheckRunResponseBodyRequires = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyRequires>;
export declare const GetDeploymentCheckRunResponseBodyBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type GetDeploymentCheckRunResponseBodyBlocks = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyBlocks>;
export declare const GetDeploymentCheckRunResponseBodyStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type GetDeploymentCheckRunResponseBodyStatus = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyStatus>;
export declare const GetDeploymentCheckRunResponseBodyConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type GetDeploymentCheckRunResponseBodyConclusion = ClosedEnum<typeof GetDeploymentCheckRunResponseBodyConclusion>;
export declare const GetDeploymentCheckRunSourceSubKind: {
readonly VercelNativeCheck: "vercel-native-check";
};
export type GetDeploymentCheckRunSourceSubKind = ClosedEnum<typeof GetDeploymentCheckRunSourceSubKind>;
export declare const GetDeploymentCheckRunSourceOrigin: {
readonly Api: "api";
readonly Platform: "platform";
};
export type GetDeploymentCheckRunSourceOrigin = ClosedEnum<typeof GetDeploymentCheckRunSourceOrigin>;
/**
* Native Vercel checks — check definition and check run `source`.
*/
export type Source4 = {
subKind?: GetDeploymentCheckRunSourceSubKind | undefined;
origin?: GetDeploymentCheckRunSourceOrigin | undefined;
};
export declare const GetDeploymentCheckRunSourceChecksV2ResponseKind: {
readonly GitProvider: "git-provider";
};
export type GetDeploymentCheckRunSourceChecksV2ResponseKind = ClosedEnum<typeof GetDeploymentCheckRunSourceChecksV2ResponseKind>;
export declare const GetDeploymentCheckRunSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type GetDeploymentCheckRunSourceProvider = ClosedEnum<typeof GetDeploymentCheckRunSourceProvider>;
export type GetDeploymentCheckRunSource3 = {
kind: GetDeploymentCheckRunSourceChecksV2ResponseKind;
provider: GetDeploymentCheckRunSourceProvider;
externalCheckName: string;
};
export declare const GetDeploymentCheckRunSourceChecksV2Kind: {
readonly Webhook: "webhook";
};
export type GetDeploymentCheckRunSourceChecksV2Kind = ClosedEnum<typeof GetDeploymentCheckRunSourceChecksV2Kind>;
export type GetDeploymentCheckRunSource2 = {
kind: GetDeploymentCheckRunSourceChecksV2Kind;
webhookId?: string | undefined;
};
export declare const GetDeploymentCheckRunSourceKind: {
readonly Integration: "integration";
};
export type GetDeploymentCheckRunSourceKind = ClosedEnum<typeof GetDeploymentCheckRunSourceKind>;
export type GetDeploymentCheckRunSource1 = {
kind: GetDeploymentCheckRunSourceKind;
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type GetDeploymentCheckRunResponseBodySource = GetDeploymentCheckRunSource1 | GetDeploymentCheckRunSource3 | GetDeploymentCheckRunSource2 | Source4;
/**
* Check run backed by a project-level `check` definition.
*/
export type GetDeploymentCheckRunResponseBody1 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: GetDeploymentCheckRunResponseBodyRequires | undefined;
blocks?: GetDeploymentCheckRunResponseBodyBlocks | undefined;
targets?: Array<string> | undefined;
status: GetDeploymentCheckRunResponseBodyStatus;
conclusion?: GetDeploymentCheckRunResponseBodyConclusion | 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: GetDeploymentCheckRunSource1 | GetDeploymentCheckRunSource3 | GetDeploymentCheckRunSource2 | Source4;
};
export type GetDeploymentCheckRunResponseBody = GetDeploymentCheckRunResponseBody1 | GetDeploymentCheckRunResponseBody2;
/** @internal */
export type GetDeploymentCheckRunRequest$Outbound = {
deploymentId: string;
checkRunId: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetDeploymentCheckRunRequest$outboundSchema: z.ZodType<GetDeploymentCheckRunRequest$Outbound, z.ZodTypeDef, GetDeploymentCheckRunRequest>;
export declare function getDeploymentCheckRunRequestToJSON(getDeploymentCheckRunRequest: GetDeploymentCheckRunRequest): string;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyChecksV2Requires$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Requires>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyChecksV2Blocks$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Blocks>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyChecksV2Status$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Status>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyChecksV2Conclusion$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyChecksV2Conclusion>;
/** @internal */
export declare const GetDeploymentCheckRunSourceChecksV2ResponseOrigin$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceChecksV2ResponseOrigin>;
/** @internal */
export declare const GetDeploymentCheckRunSourceChecksV22$inboundSchema: z.ZodType<GetDeploymentCheckRunSourceChecksV22, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunSourceChecksV22FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunSourceChecksV22, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunSourceChecksV2Origin$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceChecksV2Origin>;
/** @internal */
export declare const GetDeploymentCheckRunSourceChecksV21$inboundSchema: z.ZodType<GetDeploymentCheckRunSourceChecksV21, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunSourceChecksV21FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunSourceChecksV21, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyChecksV2Source$inboundSchema: z.ZodType<GetDeploymentCheckRunResponseBodyChecksV2Source, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunResponseBodyChecksV2SourceFromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunResponseBodyChecksV2Source, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBody2$inboundSchema: z.ZodType<GetDeploymentCheckRunResponseBody2, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunResponseBody2FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunResponseBody2, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyRequires$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyRequires>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyBlocks$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyBlocks>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyStatus$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyStatus>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodyConclusion$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunResponseBodyConclusion>;
/** @internal */
export declare const GetDeploymentCheckRunSourceSubKind$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceSubKind>;
/** @internal */
export declare const GetDeploymentCheckRunSourceOrigin$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceOrigin>;
/** @internal */
export declare const Source4$inboundSchema: z.ZodType<Source4, z.ZodTypeDef, unknown>;
export declare function source4FromJSON(jsonString: string): SafeParseResult<Source4, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunSourceChecksV2ResponseKind$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceChecksV2ResponseKind>;
/** @internal */
export declare const GetDeploymentCheckRunSourceProvider$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceProvider>;
/** @internal */
export declare const GetDeploymentCheckRunSource3$inboundSchema: z.ZodType<GetDeploymentCheckRunSource3, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunSource3FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunSource3, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunSourceChecksV2Kind$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceChecksV2Kind>;
/** @internal */
export declare const GetDeploymentCheckRunSource2$inboundSchema: z.ZodType<GetDeploymentCheckRunSource2, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunSource2FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunSource2, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunSourceKind$inboundSchema: z.ZodNativeEnum<typeof GetDeploymentCheckRunSourceKind>;
/** @internal */
export declare const GetDeploymentCheckRunSource1$inboundSchema: z.ZodType<GetDeploymentCheckRunSource1, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunSource1FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunSource1, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBodySource$inboundSchema: z.ZodType<GetDeploymentCheckRunResponseBodySource, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunResponseBodySourceFromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunResponseBodySource, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBody1$inboundSchema: z.ZodType<GetDeploymentCheckRunResponseBody1, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunResponseBody1FromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunResponseBody1, SDKValidationError>;
/** @internal */
export declare const GetDeploymentCheckRunResponseBody$inboundSchema: z.ZodType<GetDeploymentCheckRunResponseBody, z.ZodTypeDef, unknown>;
export declare function getDeploymentCheckRunResponseBodyFromJSON(jsonString: string): SafeParseResult<GetDeploymentCheckRunResponseBody, SDKValidationError>;
//# sourceMappingURL=getdeploymentcheckrunop.d.ts.map