@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>
201 lines • 8.89 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 Requires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type Requires = ClosedEnum<typeof Requires>;
export declare const Blocks: {
readonly BuildStart: "build-start";
readonly DeploymentStart: "deployment-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly None: "none";
};
export type Blocks = ClosedEnum<typeof Blocks>;
export declare const SourceProvider: {
readonly Github: "github";
};
export type SourceProvider = ClosedEnum<typeof SourceProvider>;
export type Source3 = {
kind: string;
externalCheckName: string;
provider: SourceProvider;
};
export type Source2 = {
kind: string;
webhookId?: string | undefined;
};
export type Source1 = {
kind?: string | undefined;
externalResourceId?: string | undefined;
};
export type CreateProjectCheckSource = Source3 | Source2 | Source1;
export type CreateProjectCheckRequestBody = {
name: string;
isRerequestable?: boolean | undefined;
requires?: Requires | undefined;
targets?: Array<string> | undefined;
blocks?: Blocks | undefined;
source?: Source3 | Source2 | Source1 | undefined;
timeout?: number | undefined;
};
export type CreateProjectCheckRequest = {
projectIdOrName: 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?: CreateProjectCheckRequestBody | undefined;
};
export declare const CreateProjectCheckRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type CreateProjectCheckRequires = ClosedEnum<typeof CreateProjectCheckRequires>;
export declare const CreateProjectCheckSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type CreateProjectCheckSourceProvider = ClosedEnum<typeof CreateProjectCheckSourceProvider>;
export type CreateProjectCheckSource3 = {
kind: "git-provider";
provider: CreateProjectCheckSourceProvider;
externalCheckName: string;
};
export type CreateProjectCheckSource2 = {
kind: "webhook";
webhookId?: string | undefined;
};
export type CreateProjectCheckSource1 = {
kind: "integration";
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type CreateProjectCheckChecksV2Source = CreateProjectCheckSource1 | CreateProjectCheckSource2 | CreateProjectCheckSource3;
export declare const CreateProjectCheckBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type CreateProjectCheckBlocks = ClosedEnum<typeof CreateProjectCheckBlocks>;
export declare const SourceKind: {
readonly GitProvider: "git-provider";
readonly Integration: "integration";
readonly Vercel: "vercel";
readonly Webhook: "webhook";
};
export type SourceKind = ClosedEnum<typeof SourceKind>;
export type CreateProjectCheckResponseBody = {
id: string;
name: string;
ownerId: string;
projectId: string;
isRerequestable: boolean;
requires: CreateProjectCheckRequires;
source: CreateProjectCheckSource1 | CreateProjectCheckSource2 | CreateProjectCheckSource3;
blocks: CreateProjectCheckBlocks;
targets: Array<string>;
sourceKind: SourceKind;
sourceIntegrationConfigurationId?: string | undefined;
timeout: number;
createdAt: number;
updatedAt: number;
deletedAt?: number | undefined;
};
/** @internal */
export declare const Requires$outboundSchema: z.ZodNativeEnum<typeof Requires>;
/** @internal */
export declare const Blocks$outboundSchema: z.ZodNativeEnum<typeof Blocks>;
/** @internal */
export declare const SourceProvider$outboundSchema: z.ZodNativeEnum<typeof SourceProvider>;
/** @internal */
export type Source3$Outbound = {
kind: string;
externalCheckName: string;
provider: string;
};
/** @internal */
export declare const Source3$outboundSchema: z.ZodType<Source3$Outbound, z.ZodTypeDef, Source3>;
export declare function source3ToJSON(source3: Source3): string;
/** @internal */
export type Source2$Outbound = {
kind: string;
webhookId?: string | undefined;
};
/** @internal */
export declare const Source2$outboundSchema: z.ZodType<Source2$Outbound, z.ZodTypeDef, Source2>;
export declare function source2ToJSON(source2: Source2): string;
/** @internal */
export type Source1$Outbound = {
kind: string;
externalResourceId?: string | undefined;
};
/** @internal */
export declare const Source1$outboundSchema: z.ZodType<Source1$Outbound, z.ZodTypeDef, Source1>;
export declare function source1ToJSON(source1: Source1): string;
/** @internal */
export type CreateProjectCheckSource$Outbound = Source3$Outbound | Source2$Outbound | Source1$Outbound;
/** @internal */
export declare const CreateProjectCheckSource$outboundSchema: z.ZodType<CreateProjectCheckSource$Outbound, z.ZodTypeDef, CreateProjectCheckSource>;
export declare function createProjectCheckSourceToJSON(createProjectCheckSource: CreateProjectCheckSource): string;
/** @internal */
export type CreateProjectCheckRequestBody$Outbound = {
name: string;
isRerequestable?: boolean | undefined;
requires: string;
targets?: Array<string> | undefined;
blocks: string;
source?: Source3$Outbound | Source2$Outbound | Source1$Outbound | undefined;
timeout: number;
};
/** @internal */
export declare const CreateProjectCheckRequestBody$outboundSchema: z.ZodType<CreateProjectCheckRequestBody$Outbound, z.ZodTypeDef, CreateProjectCheckRequestBody>;
export declare function createProjectCheckRequestBodyToJSON(createProjectCheckRequestBody: CreateProjectCheckRequestBody): string;
/** @internal */
export type CreateProjectCheckRequest$Outbound = {
projectIdOrName: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody?: CreateProjectCheckRequestBody$Outbound | undefined;
};
/** @internal */
export declare const CreateProjectCheckRequest$outboundSchema: z.ZodType<CreateProjectCheckRequest$Outbound, z.ZodTypeDef, CreateProjectCheckRequest>;
export declare function createProjectCheckRequestToJSON(createProjectCheckRequest: CreateProjectCheckRequest): string;
/** @internal */
export declare const CreateProjectCheckRequires$inboundSchema: z.ZodNativeEnum<typeof CreateProjectCheckRequires>;
/** @internal */
export declare const CreateProjectCheckSourceProvider$inboundSchema: z.ZodNativeEnum<typeof CreateProjectCheckSourceProvider>;
/** @internal */
export declare const CreateProjectCheckSource3$inboundSchema: z.ZodType<CreateProjectCheckSource3, z.ZodTypeDef, unknown>;
export declare function createProjectCheckSource3FromJSON(jsonString: string): SafeParseResult<CreateProjectCheckSource3, SDKValidationError>;
/** @internal */
export declare const CreateProjectCheckSource2$inboundSchema: z.ZodType<CreateProjectCheckSource2, z.ZodTypeDef, unknown>;
export declare function createProjectCheckSource2FromJSON(jsonString: string): SafeParseResult<CreateProjectCheckSource2, SDKValidationError>;
/** @internal */
export declare const CreateProjectCheckSource1$inboundSchema: z.ZodType<CreateProjectCheckSource1, z.ZodTypeDef, unknown>;
export declare function createProjectCheckSource1FromJSON(jsonString: string): SafeParseResult<CreateProjectCheckSource1, SDKValidationError>;
/** @internal */
export declare const CreateProjectCheckChecksV2Source$inboundSchema: z.ZodType<CreateProjectCheckChecksV2Source, z.ZodTypeDef, unknown>;
export declare function createProjectCheckChecksV2SourceFromJSON(jsonString: string): SafeParseResult<CreateProjectCheckChecksV2Source, SDKValidationError>;
/** @internal */
export declare const CreateProjectCheckBlocks$inboundSchema: z.ZodNativeEnum<typeof CreateProjectCheckBlocks>;
/** @internal */
export declare const SourceKind$inboundSchema: z.ZodNativeEnum<typeof SourceKind>;
/** @internal */
export declare const CreateProjectCheckResponseBody$inboundSchema: z.ZodType<CreateProjectCheckResponseBody, z.ZodTypeDef, unknown>;
export declare function createProjectCheckResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateProjectCheckResponseBody, SDKValidationError>;
//# sourceMappingURL=createprojectcheckop.d.ts.map