@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>
159 lines • 6.88 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 GetCheckRequest = {
/**
* The deployment to get the check for.
*/
deploymentId: string;
/**
* The check to fetch
*/
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 GetCheckStatus: {
readonly Completed: "completed";
readonly Registered: "registered";
readonly Running: "running";
};
export type GetCheckStatus = ClosedEnum<typeof GetCheckStatus>;
export declare const GetCheckConclusion: {
readonly Canceled: "canceled";
readonly Failed: "failed";
readonly Neutral: "neutral";
readonly Skipped: "skipped";
readonly Stale: "stale";
readonly Succeeded: "succeeded";
};
export type GetCheckConclusion = ClosedEnum<typeof GetCheckConclusion>;
export declare const GetCheckSource: {
readonly WebVitals: "web-vitals";
};
export type GetCheckSource = ClosedEnum<typeof GetCheckSource>;
export type GetCheckFCP = {
value: number | null;
previousValue?: number | undefined;
source: GetCheckSource;
};
export declare const GetCheckChecksSource: {
readonly WebVitals: "web-vitals";
};
export type GetCheckChecksSource = ClosedEnum<typeof GetCheckChecksSource>;
export type GetCheckLCP = {
value: number | null;
previousValue?: number | undefined;
source: GetCheckChecksSource;
};
export declare const GetCheckChecksResponseSource: {
readonly WebVitals: "web-vitals";
};
export type GetCheckChecksResponseSource = ClosedEnum<typeof GetCheckChecksResponseSource>;
export type GetCheckCLS = {
value: number | null;
previousValue?: number | undefined;
source: GetCheckChecksResponseSource;
};
export declare const GetCheckChecksResponse200Source: {
readonly WebVitals: "web-vitals";
};
export type GetCheckChecksResponse200Source = ClosedEnum<typeof GetCheckChecksResponse200Source>;
export type GetCheckTBT = {
value: number | null;
previousValue?: number | undefined;
source: GetCheckChecksResponse200Source;
};
export declare const GetCheckChecksResponse200ApplicationJSONSource: {
readonly WebVitals: "web-vitals";
};
export type GetCheckChecksResponse200ApplicationJSONSource = ClosedEnum<typeof GetCheckChecksResponse200ApplicationJSONSource>;
export type GetCheckVirtualExperienceScore = {
value: number | null;
previousValue?: number | undefined;
source: GetCheckChecksResponse200ApplicationJSONSource;
};
export type GetCheckMetrics = {
fcp: GetCheckFCP;
lcp: GetCheckLCP;
cls: GetCheckCLS;
tbt: GetCheckTBT;
virtualExperienceScore?: GetCheckVirtualExperienceScore | undefined;
};
export type GetCheckOutput = {
metrics?: GetCheckMetrics | undefined;
};
export type GetCheckResponseBody = {
id: string;
name: string;
createdAt: number;
updatedAt: number;
deploymentId: string;
status: GetCheckStatus;
conclusion?: GetCheckConclusion | undefined;
externalId?: string | undefined;
output?: GetCheckOutput | undefined;
completedAt?: number | undefined;
path?: string | undefined;
blocking: boolean;
detailsUrl?: string | undefined;
integrationId: string;
startedAt?: number | undefined;
rerequestable?: boolean | undefined;
};
/** @internal */
export type GetCheckRequest$Outbound = {
deploymentId: string;
checkId: string;
teamId?: string | undefined;
slug?: string | undefined;
};
/** @internal */
export declare const GetCheckRequest$outboundSchema: z.ZodType<GetCheckRequest$Outbound, z.ZodTypeDef, GetCheckRequest>;
export declare function getCheckRequestToJSON(getCheckRequest: GetCheckRequest): string;
/** @internal */
export declare const GetCheckStatus$inboundSchema: z.ZodNativeEnum<typeof GetCheckStatus>;
/** @internal */
export declare const GetCheckConclusion$inboundSchema: z.ZodNativeEnum<typeof GetCheckConclusion>;
/** @internal */
export declare const GetCheckSource$inboundSchema: z.ZodNativeEnum<typeof GetCheckSource>;
/** @internal */
export declare const GetCheckFCP$inboundSchema: z.ZodType<GetCheckFCP, z.ZodTypeDef, unknown>;
export declare function getCheckFCPFromJSON(jsonString: string): SafeParseResult<GetCheckFCP, SDKValidationError>;
/** @internal */
export declare const GetCheckChecksSource$inboundSchema: z.ZodNativeEnum<typeof GetCheckChecksSource>;
/** @internal */
export declare const GetCheckLCP$inboundSchema: z.ZodType<GetCheckLCP, z.ZodTypeDef, unknown>;
export declare function getCheckLCPFromJSON(jsonString: string): SafeParseResult<GetCheckLCP, SDKValidationError>;
/** @internal */
export declare const GetCheckChecksResponseSource$inboundSchema: z.ZodNativeEnum<typeof GetCheckChecksResponseSource>;
/** @internal */
export declare const GetCheckCLS$inboundSchema: z.ZodType<GetCheckCLS, z.ZodTypeDef, unknown>;
export declare function getCheckCLSFromJSON(jsonString: string): SafeParseResult<GetCheckCLS, SDKValidationError>;
/** @internal */
export declare const GetCheckChecksResponse200Source$inboundSchema: z.ZodNativeEnum<typeof GetCheckChecksResponse200Source>;
/** @internal */
export declare const GetCheckTBT$inboundSchema: z.ZodType<GetCheckTBT, z.ZodTypeDef, unknown>;
export declare function getCheckTBTFromJSON(jsonString: string): SafeParseResult<GetCheckTBT, SDKValidationError>;
/** @internal */
export declare const GetCheckChecksResponse200ApplicationJSONSource$inboundSchema: z.ZodNativeEnum<typeof GetCheckChecksResponse200ApplicationJSONSource>;
/** @internal */
export declare const GetCheckVirtualExperienceScore$inboundSchema: z.ZodType<GetCheckVirtualExperienceScore, z.ZodTypeDef, unknown>;
export declare function getCheckVirtualExperienceScoreFromJSON(jsonString: string): SafeParseResult<GetCheckVirtualExperienceScore, SDKValidationError>;
/** @internal */
export declare const GetCheckMetrics$inboundSchema: z.ZodType<GetCheckMetrics, z.ZodTypeDef, unknown>;
export declare function getCheckMetricsFromJSON(jsonString: string): SafeParseResult<GetCheckMetrics, SDKValidationError>;
/** @internal */
export declare const GetCheckOutput$inboundSchema: z.ZodType<GetCheckOutput, z.ZodTypeDef, unknown>;
export declare function getCheckOutputFromJSON(jsonString: string): SafeParseResult<GetCheckOutput, SDKValidationError>;
/** @internal */
export declare const GetCheckResponseBody$inboundSchema: z.ZodType<GetCheckResponseBody, z.ZodTypeDef, unknown>;
export declare function getCheckResponseBodyFromJSON(jsonString: string): SafeParseResult<GetCheckResponseBody, SDKValidationError>;
//# sourceMappingURL=getcheckop.d.ts.map