@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>
329 lines • 18.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 declare const UpdateDeploymentCheckRunStatus: {
readonly Queued: "queued";
readonly Running: "running";
readonly Completed: "completed";
};
export type UpdateDeploymentCheckRunStatus = ClosedEnum<typeof UpdateDeploymentCheckRunStatus>;
export type Output = {};
export declare const Conclusion: {
readonly Canceled: "canceled";
readonly Skipped: "skipped";
readonly Timeout: "timeout";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Succeeded: "succeeded";
};
export type Conclusion = ClosedEnum<typeof Conclusion>;
export type UpdateDeploymentCheckRunRequestBody = {
externalId?: string | undefined;
externalUrl?: string | undefined;
status?: UpdateDeploymentCheckRunStatus | undefined;
output?: Output | undefined;
completedAt?: number | undefined;
conclusion?: Conclusion | undefined;
conclusionText?: string | undefined;
};
export type UpdateDeploymentCheckRunRequest = {
deploymentId: string;
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;
requestBody?: UpdateDeploymentCheckRunRequestBody | undefined;
};
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Requires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type UpdateDeploymentCheckRunResponseBodyChecksV2Requires = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Requires>;
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Blocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type UpdateDeploymentCheckRunResponseBodyChecksV2Blocks = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Blocks>;
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Status: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type UpdateDeploymentCheckRunResponseBodyChecksV2Status = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Status>;
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Conclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type UpdateDeploymentCheckRunResponseBodyChecksV2Conclusion = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Conclusion>;
export declare const UpdateDeploymentCheckRunSourceChecksV2ResponseOrigin: {
readonly Platform: "platform";
};
export type UpdateDeploymentCheckRunSourceChecksV2ResponseOrigin = ClosedEnum<typeof UpdateDeploymentCheckRunSourceChecksV2ResponseOrigin>;
/**
* CI sentinel — check run `source` only (no parent check).
*/
export type UpdateDeploymentCheckRunSourceChecksV22 = {
subKind: "vercel-ci-sentinel";
origin: UpdateDeploymentCheckRunSourceChecksV2ResponseOrigin;
};
export declare const UpdateDeploymentCheckRunSourceChecksV2Origin: {
readonly Config: "config";
};
export type UpdateDeploymentCheckRunSourceChecksV2Origin = ClosedEnum<typeof UpdateDeploymentCheckRunSourceChecksV2Origin>;
/**
* Config-driven CI task — check run `source` only (no parent check).
*/
export type UpdateDeploymentCheckRunSourceChecksV21 = {
subKind: "vercel-ci";
origin: UpdateDeploymentCheckRunSourceChecksV2Origin;
invocationId: string;
jobDefinitionId: string;
};
export type UpdateDeploymentCheckRunResponseBodyChecksV2Source = UpdateDeploymentCheckRunSourceChecksV21 | UpdateDeploymentCheckRunSourceChecksV22;
/**
* Vercel CI check run without a parent `check` (no `checkId` field).
*/
export type UpdateDeploymentCheckRunResponseBody2 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: UpdateDeploymentCheckRunResponseBodyChecksV2Requires | undefined;
blocks?: UpdateDeploymentCheckRunResponseBodyChecksV2Blocks | undefined;
targets?: Array<string> | undefined;
status: UpdateDeploymentCheckRunResponseBodyChecksV2Status;
conclusion?: UpdateDeploymentCheckRunResponseBodyChecksV2Conclusion | 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: UpdateDeploymentCheckRunSourceChecksV21 | UpdateDeploymentCheckRunSourceChecksV22;
};
export declare const UpdateDeploymentCheckRunResponseBodyRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type UpdateDeploymentCheckRunResponseBodyRequires = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyRequires>;
export declare const UpdateDeploymentCheckRunResponseBodyBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type UpdateDeploymentCheckRunResponseBodyBlocks = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyBlocks>;
export declare const UpdateDeploymentCheckRunResponseBodyStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type UpdateDeploymentCheckRunResponseBodyStatus = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyStatus>;
export declare const UpdateDeploymentCheckRunResponseBodyConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type UpdateDeploymentCheckRunResponseBodyConclusion = ClosedEnum<typeof UpdateDeploymentCheckRunResponseBodyConclusion>;
export declare const UpdateDeploymentCheckRunSourceSubKind: {
readonly VercelNativeCheck: "vercel-native-check";
};
export type UpdateDeploymentCheckRunSourceSubKind = ClosedEnum<typeof UpdateDeploymentCheckRunSourceSubKind>;
export declare const UpdateDeploymentCheckRunSourceOrigin: {
readonly Api: "api";
readonly Platform: "platform";
};
export type UpdateDeploymentCheckRunSourceOrigin = ClosedEnum<typeof UpdateDeploymentCheckRunSourceOrigin>;
/**
* Native Vercel checks — check definition and check run `source`.
*/
export type UpdateDeploymentCheckRunSource4 = {
subKind?: UpdateDeploymentCheckRunSourceSubKind | undefined;
origin?: UpdateDeploymentCheckRunSourceOrigin | undefined;
};
export declare const UpdateDeploymentCheckRunSourceChecksV2ResponseKind: {
readonly GitProvider: "git-provider";
};
export type UpdateDeploymentCheckRunSourceChecksV2ResponseKind = ClosedEnum<typeof UpdateDeploymentCheckRunSourceChecksV2ResponseKind>;
export declare const UpdateDeploymentCheckRunSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type UpdateDeploymentCheckRunSourceProvider = ClosedEnum<typeof UpdateDeploymentCheckRunSourceProvider>;
export type UpdateDeploymentCheckRunSource3 = {
kind: UpdateDeploymentCheckRunSourceChecksV2ResponseKind;
provider: UpdateDeploymentCheckRunSourceProvider;
externalCheckName: string;
};
export declare const UpdateDeploymentCheckRunSourceChecksV2Kind: {
readonly Webhook: "webhook";
};
export type UpdateDeploymentCheckRunSourceChecksV2Kind = ClosedEnum<typeof UpdateDeploymentCheckRunSourceChecksV2Kind>;
export type UpdateDeploymentCheckRunSource2 = {
kind: UpdateDeploymentCheckRunSourceChecksV2Kind;
webhookId?: string | undefined;
};
export declare const UpdateDeploymentCheckRunSourceKind: {
readonly Integration: "integration";
};
export type UpdateDeploymentCheckRunSourceKind = ClosedEnum<typeof UpdateDeploymentCheckRunSourceKind>;
export type UpdateDeploymentCheckRunSource1 = {
kind: UpdateDeploymentCheckRunSourceKind;
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type UpdateDeploymentCheckRunResponseBodySource = UpdateDeploymentCheckRunSource1 | UpdateDeploymentCheckRunSource3 | UpdateDeploymentCheckRunSource2 | UpdateDeploymentCheckRunSource4;
/**
* Check run backed by a project-level `check` definition.
*/
export type UpdateDeploymentCheckRunResponseBody1 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: UpdateDeploymentCheckRunResponseBodyRequires | undefined;
blocks?: UpdateDeploymentCheckRunResponseBodyBlocks | undefined;
targets?: Array<string> | undefined;
status: UpdateDeploymentCheckRunResponseBodyStatus;
conclusion?: UpdateDeploymentCheckRunResponseBodyConclusion | 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: UpdateDeploymentCheckRunSource1 | UpdateDeploymentCheckRunSource3 | UpdateDeploymentCheckRunSource2 | UpdateDeploymentCheckRunSource4;
};
export type UpdateDeploymentCheckRunResponseBody = UpdateDeploymentCheckRunResponseBody1 | UpdateDeploymentCheckRunResponseBody2;
/** @internal */
export declare const UpdateDeploymentCheckRunStatus$outboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunStatus>;
/** @internal */
export type Output$Outbound = {};
/** @internal */
export declare const Output$outboundSchema: z.ZodType<Output$Outbound, z.ZodTypeDef, Output>;
export declare function outputToJSON(output: Output): string;
/** @internal */
export declare const Conclusion$outboundSchema: z.ZodNativeEnum<typeof Conclusion>;
/** @internal */
export type UpdateDeploymentCheckRunRequestBody$Outbound = {
externalId?: string | undefined;
externalUrl?: string | undefined;
status?: string | undefined;
output?: Output$Outbound | undefined;
completedAt?: number | undefined;
conclusion?: string | undefined;
conclusionText?: string | undefined;
};
/** @internal */
export declare const UpdateDeploymentCheckRunRequestBody$outboundSchema: z.ZodType<UpdateDeploymentCheckRunRequestBody$Outbound, z.ZodTypeDef, UpdateDeploymentCheckRunRequestBody>;
export declare function updateDeploymentCheckRunRequestBodyToJSON(updateDeploymentCheckRunRequestBody: UpdateDeploymentCheckRunRequestBody): string;
/** @internal */
export type UpdateDeploymentCheckRunRequest$Outbound = {
deploymentId: string;
checkRunId: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody?: UpdateDeploymentCheckRunRequestBody$Outbound | undefined;
};
/** @internal */
export declare const UpdateDeploymentCheckRunRequest$outboundSchema: z.ZodType<UpdateDeploymentCheckRunRequest$Outbound, z.ZodTypeDef, UpdateDeploymentCheckRunRequest>;
export declare function updateDeploymentCheckRunRequestToJSON(updateDeploymentCheckRunRequest: UpdateDeploymentCheckRunRequest): string;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Requires$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Requires>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Blocks$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Blocks>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Status$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Status>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Conclusion$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyChecksV2Conclusion>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceChecksV2ResponseOrigin$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceChecksV2ResponseOrigin>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceChecksV22$inboundSchema: z.ZodType<UpdateDeploymentCheckRunSourceChecksV22, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunSourceChecksV22FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunSourceChecksV22, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceChecksV2Origin$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceChecksV2Origin>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceChecksV21$inboundSchema: z.ZodType<UpdateDeploymentCheckRunSourceChecksV21, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunSourceChecksV21FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunSourceChecksV21, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyChecksV2Source$inboundSchema: z.ZodType<UpdateDeploymentCheckRunResponseBodyChecksV2Source, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunResponseBodyChecksV2SourceFromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunResponseBodyChecksV2Source, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBody2$inboundSchema: z.ZodType<UpdateDeploymentCheckRunResponseBody2, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunResponseBody2FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunResponseBody2, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyRequires$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyRequires>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyBlocks$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyBlocks>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyStatus$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyStatus>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodyConclusion$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunResponseBodyConclusion>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceSubKind$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceSubKind>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceOrigin$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceOrigin>;
/** @internal */
export declare const UpdateDeploymentCheckRunSource4$inboundSchema: z.ZodType<UpdateDeploymentCheckRunSource4, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunSource4FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunSource4, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceChecksV2ResponseKind$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceChecksV2ResponseKind>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceProvider$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceProvider>;
/** @internal */
export declare const UpdateDeploymentCheckRunSource3$inboundSchema: z.ZodType<UpdateDeploymentCheckRunSource3, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunSource3FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunSource3, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceChecksV2Kind$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceChecksV2Kind>;
/** @internal */
export declare const UpdateDeploymentCheckRunSource2$inboundSchema: z.ZodType<UpdateDeploymentCheckRunSource2, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunSource2FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunSource2, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunSourceKind$inboundSchema: z.ZodNativeEnum<typeof UpdateDeploymentCheckRunSourceKind>;
/** @internal */
export declare const UpdateDeploymentCheckRunSource1$inboundSchema: z.ZodType<UpdateDeploymentCheckRunSource1, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunSource1FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunSource1, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBodySource$inboundSchema: z.ZodType<UpdateDeploymentCheckRunResponseBodySource, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunResponseBodySourceFromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunResponseBodySource, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBody1$inboundSchema: z.ZodType<UpdateDeploymentCheckRunResponseBody1, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunResponseBody1FromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunResponseBody1, SDKValidationError>;
/** @internal */
export declare const UpdateDeploymentCheckRunResponseBody$inboundSchema: z.ZodType<UpdateDeploymentCheckRunResponseBody, z.ZodTypeDef, unknown>;
export declare function updateDeploymentCheckRunResponseBodyFromJSON(jsonString: string): SafeParseResult<UpdateDeploymentCheckRunResponseBody, SDKValidationError>;
//# sourceMappingURL=updatedeploymentcheckrunop.d.ts.map