@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>
289 lines • 13.2 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 ListCheckRunsRequest = {
projectIdOrName: string;
/**
* The ID of the resource that will be updated.
*/
checkId: 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 ListCheckRunsRunsRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type ListCheckRunsRunsRequires = ClosedEnum<typeof ListCheckRunsRunsRequires>;
export declare const ListCheckRunsRunsBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type ListCheckRunsRunsBlocks = ClosedEnum<typeof ListCheckRunsRunsBlocks>;
export declare const ListCheckRunsRunsStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type ListCheckRunsRunsStatus = ClosedEnum<typeof ListCheckRunsRunsStatus>;
export declare const RunsConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type RunsConclusion = ClosedEnum<typeof RunsConclusion>;
export declare const ListCheckRunsSourceOrigin: {
readonly Platform: "platform";
};
export type ListCheckRunsSourceOrigin = ClosedEnum<typeof ListCheckRunsSourceOrigin>;
/**
* CI sentinel — check run `source` only (no parent check).
*/
export type ListCheckRunsSourceChecksV22 = {
subKind: "vercel-ci-sentinel";
origin: ListCheckRunsSourceOrigin;
};
export declare const ListCheckRunsSourceChecksV2ResponseOrigin: {
readonly Config: "config";
};
export type ListCheckRunsSourceChecksV2ResponseOrigin = ClosedEnum<typeof ListCheckRunsSourceChecksV2ResponseOrigin>;
/**
* Config-driven CI task — check run `source` only (no parent check).
*/
export type ListCheckRunsSourceChecksV21 = {
subKind: "vercel-ci";
origin: ListCheckRunsSourceChecksV2ResponseOrigin;
invocationId: string;
jobDefinitionId: string;
};
export type ListCheckRunsRunsSource = ListCheckRunsSourceChecksV21 | ListCheckRunsSourceChecksV22;
/**
* Vercel CI check run without a parent `check` (no `checkId` field).
*/
export type Runs2 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: ListCheckRunsRunsRequires | undefined;
blocks?: ListCheckRunsRunsBlocks | undefined;
targets?: Array<string> | undefined;
status: ListCheckRunsRunsStatus;
conclusion?: RunsConclusion | 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: ListCheckRunsSourceChecksV21 | ListCheckRunsSourceChecksV22;
};
export declare const RunsRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type RunsRequires = ClosedEnum<typeof RunsRequires>;
export declare const RunsBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type RunsBlocks = ClosedEnum<typeof RunsBlocks>;
export declare const RunsStatus: {
readonly Completed: "completed";
readonly Queued: "queued";
readonly Running: "running";
};
export type RunsStatus = ClosedEnum<typeof RunsStatus>;
export declare const ListCheckRunsRunsConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Succeeded: "succeeded";
readonly Timeout: "timeout";
};
export type ListCheckRunsRunsConclusion = ClosedEnum<typeof ListCheckRunsRunsConclusion>;
export declare const ListCheckRunsSourceChecksV2SubKind: {
readonly VercelNativeCheck: "vercel-native-check";
};
export type ListCheckRunsSourceChecksV2SubKind = ClosedEnum<typeof ListCheckRunsSourceChecksV2SubKind>;
export declare const ListCheckRunsSourceChecksV2Origin: {
readonly Api: "api";
readonly Platform: "platform";
};
export type ListCheckRunsSourceChecksV2Origin = ClosedEnum<typeof ListCheckRunsSourceChecksV2Origin>;
/**
* Native Vercel checks — check definition and check run `source`.
*/
export type ListCheckRunsSource4 = {
subKind?: ListCheckRunsSourceChecksV2SubKind | undefined;
origin?: ListCheckRunsSourceChecksV2Origin | undefined;
};
export declare const ListCheckRunsSourceChecksV2ResponseKind: {
readonly GitProvider: "git-provider";
};
export type ListCheckRunsSourceChecksV2ResponseKind = ClosedEnum<typeof ListCheckRunsSourceChecksV2ResponseKind>;
export declare const ListCheckRunsSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type ListCheckRunsSourceProvider = ClosedEnum<typeof ListCheckRunsSourceProvider>;
export type ListCheckRunsSource3 = {
kind: ListCheckRunsSourceChecksV2ResponseKind;
provider: ListCheckRunsSourceProvider;
externalCheckName: string;
};
export declare const ListCheckRunsSourceChecksV2Kind: {
readonly Webhook: "webhook";
};
export type ListCheckRunsSourceChecksV2Kind = ClosedEnum<typeof ListCheckRunsSourceChecksV2Kind>;
export type ListCheckRunsSource2 = {
kind: ListCheckRunsSourceChecksV2Kind;
webhookId?: string | undefined;
};
export declare const ListCheckRunsSourceKind: {
readonly Integration: "integration";
};
export type ListCheckRunsSourceKind = ClosedEnum<typeof ListCheckRunsSourceKind>;
export type ListCheckRunsSource1 = {
kind: ListCheckRunsSourceKind;
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type RunsSource = ListCheckRunsSource1 | ListCheckRunsSource3 | ListCheckRunsSource2 | ListCheckRunsSource4;
/**
* Check run backed by a project-level `check` definition.
*/
export type Runs1 = {
id: string;
name: string;
ownerId: string;
deploymentId: string;
projectId?: string | undefined;
requires?: RunsRequires | undefined;
blocks?: RunsBlocks | undefined;
targets?: Array<string> | undefined;
status: RunsStatus;
conclusion?: ListCheckRunsRunsConclusion | 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: ListCheckRunsSource1 | ListCheckRunsSource3 | ListCheckRunsSource2 | ListCheckRunsSource4;
};
export type Runs = Runs1 | Runs2;
export type ListCheckRunsResponseBody = {
runs: Array<Runs1 | Runs2>;
};
/** @internal */
export type ListCheckRunsRequest$Outbound = {
projectIdOrName: string;
checkId: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const ListCheckRunsRequest$outboundSchema: z.ZodType<ListCheckRunsRequest$Outbound, z.ZodTypeDef, ListCheckRunsRequest>;
export declare function listCheckRunsRequestToJSON(listCheckRunsRequest: ListCheckRunsRequest): string;
/** @internal */
export declare const ListCheckRunsRunsRequires$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsRunsRequires>;
/** @internal */
export declare const ListCheckRunsRunsBlocks$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsRunsBlocks>;
/** @internal */
export declare const ListCheckRunsRunsStatus$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsRunsStatus>;
/** @internal */
export declare const RunsConclusion$inboundSchema: z.ZodNativeEnum<typeof RunsConclusion>;
/** @internal */
export declare const ListCheckRunsSourceOrigin$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceOrigin>;
/** @internal */
export declare const ListCheckRunsSourceChecksV22$inboundSchema: z.ZodType<ListCheckRunsSourceChecksV22, z.ZodTypeDef, unknown>;
export declare function listCheckRunsSourceChecksV22FromJSON(jsonString: string): SafeParseResult<ListCheckRunsSourceChecksV22, SDKValidationError>;
/** @internal */
export declare const ListCheckRunsSourceChecksV2ResponseOrigin$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceChecksV2ResponseOrigin>;
/** @internal */
export declare const ListCheckRunsSourceChecksV21$inboundSchema: z.ZodType<ListCheckRunsSourceChecksV21, z.ZodTypeDef, unknown>;
export declare function listCheckRunsSourceChecksV21FromJSON(jsonString: string): SafeParseResult<ListCheckRunsSourceChecksV21, SDKValidationError>;
/** @internal */
export declare const ListCheckRunsRunsSource$inboundSchema: z.ZodType<ListCheckRunsRunsSource, z.ZodTypeDef, unknown>;
export declare function listCheckRunsRunsSourceFromJSON(jsonString: string): SafeParseResult<ListCheckRunsRunsSource, SDKValidationError>;
/** @internal */
export declare const Runs2$inboundSchema: z.ZodType<Runs2, z.ZodTypeDef, unknown>;
export declare function runs2FromJSON(jsonString: string): SafeParseResult<Runs2, SDKValidationError>;
/** @internal */
export declare const RunsRequires$inboundSchema: z.ZodNativeEnum<typeof RunsRequires>;
/** @internal */
export declare const RunsBlocks$inboundSchema: z.ZodNativeEnum<typeof RunsBlocks>;
/** @internal */
export declare const RunsStatus$inboundSchema: z.ZodNativeEnum<typeof RunsStatus>;
/** @internal */
export declare const ListCheckRunsRunsConclusion$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsRunsConclusion>;
/** @internal */
export declare const ListCheckRunsSourceChecksV2SubKind$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceChecksV2SubKind>;
/** @internal */
export declare const ListCheckRunsSourceChecksV2Origin$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceChecksV2Origin>;
/** @internal */
export declare const ListCheckRunsSource4$inboundSchema: z.ZodType<ListCheckRunsSource4, z.ZodTypeDef, unknown>;
export declare function listCheckRunsSource4FromJSON(jsonString: string): SafeParseResult<ListCheckRunsSource4, SDKValidationError>;
/** @internal */
export declare const ListCheckRunsSourceChecksV2ResponseKind$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceChecksV2ResponseKind>;
/** @internal */
export declare const ListCheckRunsSourceProvider$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceProvider>;
/** @internal */
export declare const ListCheckRunsSource3$inboundSchema: z.ZodType<ListCheckRunsSource3, z.ZodTypeDef, unknown>;
export declare function listCheckRunsSource3FromJSON(jsonString: string): SafeParseResult<ListCheckRunsSource3, SDKValidationError>;
/** @internal */
export declare const ListCheckRunsSourceChecksV2Kind$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceChecksV2Kind>;
/** @internal */
export declare const ListCheckRunsSource2$inboundSchema: z.ZodType<ListCheckRunsSource2, z.ZodTypeDef, unknown>;
export declare function listCheckRunsSource2FromJSON(jsonString: string): SafeParseResult<ListCheckRunsSource2, SDKValidationError>;
/** @internal */
export declare const ListCheckRunsSourceKind$inboundSchema: z.ZodNativeEnum<typeof ListCheckRunsSourceKind>;
/** @internal */
export declare const ListCheckRunsSource1$inboundSchema: z.ZodType<ListCheckRunsSource1, z.ZodTypeDef, unknown>;
export declare function listCheckRunsSource1FromJSON(jsonString: string): SafeParseResult<ListCheckRunsSource1, SDKValidationError>;
/** @internal */
export declare const RunsSource$inboundSchema: z.ZodType<RunsSource, z.ZodTypeDef, unknown>;
export declare function runsSourceFromJSON(jsonString: string): SafeParseResult<RunsSource, SDKValidationError>;
/** @internal */
export declare const Runs1$inboundSchema: z.ZodType<Runs1, z.ZodTypeDef, unknown>;
export declare function runs1FromJSON(jsonString: string): SafeParseResult<Runs1, SDKValidationError>;
/** @internal */
export declare const Runs$inboundSchema: z.ZodType<Runs, z.ZodTypeDef, unknown>;
export declare function runsFromJSON(jsonString: string): SafeParseResult<Runs, SDKValidationError>;
/** @internal */
export declare const ListCheckRunsResponseBody$inboundSchema: z.ZodType<ListCheckRunsResponseBody, z.ZodTypeDef, unknown>;
export declare function listCheckRunsResponseBodyFromJSON(jsonString: string): SafeParseResult<ListCheckRunsResponseBody, SDKValidationError>;
//# sourceMappingURL=listcheckrunsop.d.ts.map