@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>
114 lines • 5.21 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 GetProjectCheckRequest = {
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 GetProjectCheckRequires: {
readonly BuildReady: "build-ready";
readonly DeploymentUrl: "deployment-url";
readonly None: "none";
};
export type GetProjectCheckRequires = ClosedEnum<typeof GetProjectCheckRequires>;
export declare const GetProjectCheckSourceProvider: {
readonly Bitbucket: "bitbucket";
readonly Github: "github";
readonly Gitlab: "gitlab";
};
export type GetProjectCheckSourceProvider = ClosedEnum<typeof GetProjectCheckSourceProvider>;
export type GetProjectCheckSource3 = {
kind: "git-provider";
provider: GetProjectCheckSourceProvider;
externalCheckName: string;
};
export type GetProjectCheckSource2 = {
kind: "webhook";
webhookId?: string | undefined;
};
export type GetProjectCheckSource1 = {
kind: "integration";
integrationId: string;
integrationConfigurationId: string;
resourceId?: string | undefined;
externalResourceId?: string | undefined;
};
export type GetProjectCheckSource = GetProjectCheckSource1 | GetProjectCheckSource2 | GetProjectCheckSource3;
export declare const GetProjectCheckBlocks: {
readonly BuildStart: "build-start";
readonly DeploymentAlias: "deployment-alias";
readonly DeploymentPromotion: "deployment-promotion";
readonly DeploymentStart: "deployment-start";
readonly None: "none";
};
export type GetProjectCheckBlocks = ClosedEnum<typeof GetProjectCheckBlocks>;
export declare const GetProjectCheckSourceKind: {
readonly GitProvider: "git-provider";
readonly Integration: "integration";
readonly Vercel: "vercel";
readonly Webhook: "webhook";
};
export type GetProjectCheckSourceKind = ClosedEnum<typeof GetProjectCheckSourceKind>;
export type GetProjectCheckResponseBody = {
id: string;
name: string;
ownerId: string;
projectId: string;
isRerequestable: boolean;
requires: GetProjectCheckRequires;
source: GetProjectCheckSource1 | GetProjectCheckSource2 | GetProjectCheckSource3;
blocks: GetProjectCheckBlocks;
targets: Array<string>;
sourceKind: GetProjectCheckSourceKind;
sourceIntegrationConfigurationId?: string | undefined;
timeout: number;
createdAt: number;
updatedAt: number;
deletedAt?: number | undefined;
};
/** @internal */
export type GetProjectCheckRequest$Outbound = {
projectIdOrName: string;
checkId: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetProjectCheckRequest$outboundSchema: z.ZodType<GetProjectCheckRequest$Outbound, z.ZodTypeDef, GetProjectCheckRequest>;
export declare function getProjectCheckRequestToJSON(getProjectCheckRequest: GetProjectCheckRequest): string;
/** @internal */
export declare const GetProjectCheckRequires$inboundSchema: z.ZodNativeEnum<typeof GetProjectCheckRequires>;
/** @internal */
export declare const GetProjectCheckSourceProvider$inboundSchema: z.ZodNativeEnum<typeof GetProjectCheckSourceProvider>;
/** @internal */
export declare const GetProjectCheckSource3$inboundSchema: z.ZodType<GetProjectCheckSource3, z.ZodTypeDef, unknown>;
export declare function getProjectCheckSource3FromJSON(jsonString: string): SafeParseResult<GetProjectCheckSource3, SDKValidationError>;
/** @internal */
export declare const GetProjectCheckSource2$inboundSchema: z.ZodType<GetProjectCheckSource2, z.ZodTypeDef, unknown>;
export declare function getProjectCheckSource2FromJSON(jsonString: string): SafeParseResult<GetProjectCheckSource2, SDKValidationError>;
/** @internal */
export declare const GetProjectCheckSource1$inboundSchema: z.ZodType<GetProjectCheckSource1, z.ZodTypeDef, unknown>;
export declare function getProjectCheckSource1FromJSON(jsonString: string): SafeParseResult<GetProjectCheckSource1, SDKValidationError>;
/** @internal */
export declare const GetProjectCheckSource$inboundSchema: z.ZodType<GetProjectCheckSource, z.ZodTypeDef, unknown>;
export declare function getProjectCheckSourceFromJSON(jsonString: string): SafeParseResult<GetProjectCheckSource, SDKValidationError>;
/** @internal */
export declare const GetProjectCheckBlocks$inboundSchema: z.ZodNativeEnum<typeof GetProjectCheckBlocks>;
/** @internal */
export declare const GetProjectCheckSourceKind$inboundSchema: z.ZodNativeEnum<typeof GetProjectCheckSourceKind>;
/** @internal */
export declare const GetProjectCheckResponseBody$inboundSchema: z.ZodType<GetProjectCheckResponseBody, z.ZodTypeDef, unknown>;
export declare function getProjectCheckResponseBodyFromJSON(jsonString: string): SafeParseResult<GetProjectCheckResponseBody, SDKValidationError>;
//# sourceMappingURL=getprojectcheckop.d.ts.map