@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>
194 lines • 8.38 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 CreateCheckRequestBody = {
/**
* The name of the check being created
*/
name: string;
/**
* Path of the page that is being checked
*/
path?: string | undefined;
/**
* Whether the check should block a deployment from succeeding
*/
blocking: boolean;
/**
* URL to display for further details
*/
detailsUrl?: string | undefined;
/**
* An identifier that can be used as an external reference
*/
externalId?: string | undefined;
/**
* Whether a user should be able to request for the check to be rerun if it fails
*/
rerequestable?: boolean | undefined;
};
export type CreateCheckRequest = {
/**
* The deployment to create the check for.
*/
deploymentId: 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: CreateCheckRequestBody;
};
export declare const CreateCheckStatus: {
readonly Completed: "completed";
readonly Registered: "registered";
readonly Running: "running";
};
export type CreateCheckStatus = ClosedEnum<typeof CreateCheckStatus>;
export declare const CreateCheckConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Stale: "stale";
readonly Succeeded: "succeeded";
};
export type CreateCheckConclusion = ClosedEnum<typeof CreateCheckConclusion>;
export declare const CreateCheckSource: {
readonly WebVitals: "web-vitals";
};
export type CreateCheckSource = ClosedEnum<typeof CreateCheckSource>;
export type CreateCheckFCP = {
value: number | null;
previousValue?: number | undefined;
source: CreateCheckSource;
};
export declare const CreateCheckChecksSource: {
readonly WebVitals: "web-vitals";
};
export type CreateCheckChecksSource = ClosedEnum<typeof CreateCheckChecksSource>;
export type CreateCheckLCP = {
value: number | null;
previousValue?: number | undefined;
source: CreateCheckChecksSource;
};
export declare const CreateCheckChecksResponseSource: {
readonly WebVitals: "web-vitals";
};
export type CreateCheckChecksResponseSource = ClosedEnum<typeof CreateCheckChecksResponseSource>;
export type CreateCheckCLS = {
value: number | null;
previousValue?: number | undefined;
source: CreateCheckChecksResponseSource;
};
export declare const CreateCheckChecksResponse200Source: {
readonly WebVitals: "web-vitals";
};
export type CreateCheckChecksResponse200Source = ClosedEnum<typeof CreateCheckChecksResponse200Source>;
export type CreateCheckTBT = {
value: number | null;
previousValue?: number | undefined;
source: CreateCheckChecksResponse200Source;
};
export declare const CreateCheckChecksResponse200ApplicationJSONSource: {
readonly WebVitals: "web-vitals";
};
export type CreateCheckChecksResponse200ApplicationJSONSource = ClosedEnum<typeof CreateCheckChecksResponse200ApplicationJSONSource>;
export type CreateCheckVirtualExperienceScore = {
value: number | null;
previousValue?: number | undefined;
source: CreateCheckChecksResponse200ApplicationJSONSource;
};
export type CreateCheckMetrics = {
fcp: CreateCheckFCP;
lcp: CreateCheckLCP;
cls: CreateCheckCLS;
tbt: CreateCheckTBT;
virtualExperienceScore?: CreateCheckVirtualExperienceScore | undefined;
};
export type CreateCheckOutput = {
metrics?: CreateCheckMetrics | undefined;
};
export type CreateCheckResponseBody = {
id: string;
name: string;
createdAt: number;
updatedAt: number;
deploymentId: string;
status: CreateCheckStatus;
conclusion?: CreateCheckConclusion | undefined;
externalId?: string | undefined;
output?: CreateCheckOutput | undefined;
completedAt?: number | undefined;
path?: string | undefined;
blocking: boolean;
detailsUrl?: string | undefined;
integrationId: string;
startedAt?: number | undefined;
rerequestable?: boolean | undefined;
};
/** @internal */
export type CreateCheckRequestBody$Outbound = {
name: string;
path?: string | undefined;
blocking: boolean;
detailsUrl?: string | undefined;
externalId?: string | undefined;
rerequestable?: boolean | undefined;
};
/** @internal */
export declare const CreateCheckRequestBody$outboundSchema: z.ZodType<CreateCheckRequestBody$Outbound, z.ZodTypeDef, CreateCheckRequestBody>;
export declare function createCheckRequestBodyToJSON(createCheckRequestBody: CreateCheckRequestBody): string;
/** @internal */
export type CreateCheckRequest$Outbound = {
deploymentId: string;
teamId?: string | undefined;
slug?: string | undefined;
RequestBody: CreateCheckRequestBody$Outbound;
};
/** @internal */
export declare const CreateCheckRequest$outboundSchema: z.ZodType<CreateCheckRequest$Outbound, z.ZodTypeDef, CreateCheckRequest>;
export declare function createCheckRequestToJSON(createCheckRequest: CreateCheckRequest): string;
/** @internal */
export declare const CreateCheckStatus$inboundSchema: z.ZodNativeEnum<typeof CreateCheckStatus>;
/** @internal */
export declare const CreateCheckConclusion$inboundSchema: z.ZodNativeEnum<typeof CreateCheckConclusion>;
/** @internal */
export declare const CreateCheckSource$inboundSchema: z.ZodNativeEnum<typeof CreateCheckSource>;
/** @internal */
export declare const CreateCheckFCP$inboundSchema: z.ZodType<CreateCheckFCP, z.ZodTypeDef, unknown>;
export declare function createCheckFCPFromJSON(jsonString: string): SafeParseResult<CreateCheckFCP, SDKValidationError>;
/** @internal */
export declare const CreateCheckChecksSource$inboundSchema: z.ZodNativeEnum<typeof CreateCheckChecksSource>;
/** @internal */
export declare const CreateCheckLCP$inboundSchema: z.ZodType<CreateCheckLCP, z.ZodTypeDef, unknown>;
export declare function createCheckLCPFromJSON(jsonString: string): SafeParseResult<CreateCheckLCP, SDKValidationError>;
/** @internal */
export declare const CreateCheckChecksResponseSource$inboundSchema: z.ZodNativeEnum<typeof CreateCheckChecksResponseSource>;
/** @internal */
export declare const CreateCheckCLS$inboundSchema: z.ZodType<CreateCheckCLS, z.ZodTypeDef, unknown>;
export declare function createCheckCLSFromJSON(jsonString: string): SafeParseResult<CreateCheckCLS, SDKValidationError>;
/** @internal */
export declare const CreateCheckChecksResponse200Source$inboundSchema: z.ZodNativeEnum<typeof CreateCheckChecksResponse200Source>;
/** @internal */
export declare const CreateCheckTBT$inboundSchema: z.ZodType<CreateCheckTBT, z.ZodTypeDef, unknown>;
export declare function createCheckTBTFromJSON(jsonString: string): SafeParseResult<CreateCheckTBT, SDKValidationError>;
/** @internal */
export declare const CreateCheckChecksResponse200ApplicationJSONSource$inboundSchema: z.ZodNativeEnum<typeof CreateCheckChecksResponse200ApplicationJSONSource>;
/** @internal */
export declare const CreateCheckVirtualExperienceScore$inboundSchema: z.ZodType<CreateCheckVirtualExperienceScore, z.ZodTypeDef, unknown>;
export declare function createCheckVirtualExperienceScoreFromJSON(jsonString: string): SafeParseResult<CreateCheckVirtualExperienceScore, SDKValidationError>;
/** @internal */
export declare const CreateCheckMetrics$inboundSchema: z.ZodType<CreateCheckMetrics, z.ZodTypeDef, unknown>;
export declare function createCheckMetricsFromJSON(jsonString: string): SafeParseResult<CreateCheckMetrics, SDKValidationError>;
/** @internal */
export declare const CreateCheckOutput$inboundSchema: z.ZodType<CreateCheckOutput, z.ZodTypeDef, unknown>;
export declare function createCheckOutputFromJSON(jsonString: string): SafeParseResult<CreateCheckOutput, SDKValidationError>;
/** @internal */
export declare const CreateCheckResponseBody$inboundSchema: z.ZodType<CreateCheckResponseBody, z.ZodTypeDef, unknown>;
export declare function createCheckResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateCheckResponseBody, SDKValidationError>;
//# sourceMappingURL=createcheckop.d.ts.map