import {z} from 'zod' export type GetApiV1CheckResultsCheckIdCheckResultIdArgs = {checkId: string, checkResultId: string, 'x-checkly-account'?: string | undefined}; export type GetApiV1CheckResultsCheckIdCheckResultIdOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const checkResultFreeformObject = z.record(z.string(), z.unknown()); export const checkResultAPI = z.object({assertions: z.array(checkResultFreeformObject).nullable().optional(), request: z.object({method: z.string().optional(), url: z.string().optional(), data: z.string().optional(), headers: checkResultFreeformObject.optional(), params: checkResultFreeformObject.optional()}).optional(), response: z.object({status: z.number().optional(), statusText: z.string().optional(), body: z.string().optional(), bodyEncoding: z.literal("base64").optional(), headers: z.record(z.string(), z.unknown()).nullable().optional(), timings: z.record(z.string(), z.unknown()).nullable().optional(), timingPhases: z.record(z.string(), z.unknown()).nullable().optional()}).optional(), requestError: z.string().nullable().optional(), jobLog: z.record(z.string(), z.unknown()).nullable().optional(), jobAssets: z.array(z.unknown()).nullable().optional(), pcapDataUrl: z.string().nullable().optional()}).nullable(); export const checkResultBrowser = z.object({type: z.string().optional(), traceSummary: z.record(z.string(), z.unknown()).optional(), pages: z.array(checkResultFreeformObject).optional(), playwrightTestVideos: z.array(z.string()).optional(), errors: z.array(z.unknown()).optional(), endTime: z.number().optional(), startTime: z.number().optional(), runtimeVersion: z.string().optional(), jobLog: z.array(z.unknown()).nullable().optional(), jobAssets: z.array(z.unknown()).nullable().optional(), playwrightTestTraces: z.array(z.string()).optional(), playwrightTestJsonReportFile: z.string().optional()}).nullable(); export const multiStepResultBrowser = z.object({errors: z.array(z.unknown()).optional(), endTime: z.number().optional(), startTime: z.number().optional(), runtimeVersion: z.string().optional(), jobLog: z.array(z.unknown()).nullable().optional(), jobAssets: z.array(z.unknown()).nullable().optional(), playwrightTestTraces: z.array(z.string()).optional(), playwrightTestJsonReportFile: z.string().optional()}).nullable(); export const agenticAssertion = z.object({condition: z.string().optional(), passed: z.boolean().optional(), actual: z.string().optional(), expected: z.string().optional()}); export const agenticSuggestion = z.object({summary: z.string().optional(), prompt: z.string().optional(), promptReplacement: z.string().optional(), secrets: z.array(z.string()).optional(), category: z.enum(["credentials", "endpoint", "configuration"]).optional()}); export const agenticStep = z.object({type: z.enum(["tool_call", "tool_result", "message"]).optional(), name: z.string().optional(), input: z.record(z.string(), z.unknown()).optional(), output: z.string().optional(), timestamp: z.string().optional(), sequenceNumber: z.number().int().optional()}); export const checkResultAgentic = z.object({summary: z.string().nullable().optional(), prompt: z.string().nullable().optional(), assertions: z.array(agenticAssertion).nullable().optional(), suggestions: z.array(agenticSuggestion).nullable().optional(), steps: z.array(agenticStep).nullable().optional(), errors: z.array(checkResultFreeformObject).nullable().optional(), artifactManifest: z.record(z.string(), z.unknown()).nullable().optional()}).nullable(); export const checkResultPlaywrightTraceFile = z.object({url: z.string().optional(), name: z.string().optional(), filename: z.string().optional()}).and(z.record(z.string(), z.unknown())); export const checkResultPlaywright = z.object({errors: z.array(checkResultFreeformObject).nullable().optional(), playwrightTraceFiles: z.array(checkResultPlaywrightTraceFile).nullable().optional(), jobLog: z.array(z.unknown()).nullable().optional(), jobAssets: z.array(z.unknown()).nullable().optional(), playwrightTestVideos: z.array(z.string()).nullable().optional(), playwrightTestTraces: z.array(z.string()).nullable().optional(), playwrightTestJsonReportFile: z.string().nullable().optional()}).nullable(); export const checkResultTraceroute = z.object({totalHops: z.number().optional(), destinationReached: z.boolean().optional(), finalHopLatency: z.record(z.string(), z.unknown()).nullable().optional(), timingPhases: z.record(z.string(), z.unknown()).nullable().optional(), requestError: z.string().nullable().optional(), request: z.record(z.string(), z.unknown()).nullable().optional(), assertions: z.array(checkResultFreeformObject).nullable().optional(), response: z.object({hostname: z.string().optional(), resolvedIp: z.string().optional(), totalHops: z.number().optional(), destinationReached: z.boolean().optional(), truncationReason: z.string().optional(), finalHopLatency: z.record(z.string(), z.unknown()).nullable().optional(), hops: z.array(checkResultFreeformObject).nullable().optional(), protocol: z.string().optional(), probeProtocol: z.string().optional()}).nullable().optional()}).nullable(); export const checkResultGrpc = z.object({grpcStatusCode: z.number().optional(), healthStatus: z.number().nullable().optional(), timingPhases: z.record(z.string(), z.unknown()).nullable().optional(), requestError: z.string().nullable().optional(), request: z.record(z.string(), z.unknown()).nullable().optional(), assertions: z.array(checkResultFreeformObject).nullable().optional(), response: z.object({grpcMode: z.string().optional(), host: z.string().optional(), resolvedIp: z.string().optional(), port: z.number().optional(), grpcMethod: z.string().optional(), responseMessage: z.string().optional(), grpcStatusCode: z.number().optional(), grpcStatusMessage: z.string().optional(), healthStatus: z.number().nullable().optional(), healthStatusLabel: z.string().optional(), metadata: z.array(checkResultFreeformObject).nullable().optional(), discoveredMethods: z.array(z.string()).nullable().optional(), requestError: z.string().nullable().optional(), timingPhases: z.record(z.string(), z.unknown()).nullable().optional()}).nullable().optional()}).nullable(); export const checkResultSsl = z.object({tlsVersion: z.string().optional(), cipherSuite: z.string().optional(), daysUntilExpiry: z.number().optional(), handshakeTimeMs: z.number().optional(), chainTrusted: z.boolean().optional(), hostnameVerified: z.boolean().optional(), baselineVerdict: z.string().optional(), baselineGrade: z.string().optional(), failureCategory: z.string().nullable().optional(), requestError: z.string().nullable().optional(), request: z.record(z.string(), z.unknown()).nullable().optional(), assertions: z.array(checkResultFreeformObject).nullable().optional(), response: z.object({resolvedIp: z.string().optional(), protocol: z.string().optional(), cipherSuite: z.string().optional(), handshakeTimeMs: z.number().optional(), hostnameVerified: z.boolean().optional(), chainTrusted: z.boolean().optional(), daysUntilExpiry: z.number().optional(), ocspStapled: z.boolean().optional(), ocspStatus: z.string().optional(), chainTrustReason: z.string().optional(), chainTrustDetail: z.string().optional(), incompleteChain: z.boolean().optional(), missingIntermediate: z.string().optional(), securityBaseline: z.record(z.string(), z.unknown()).nullable().optional(), certificate: z.record(z.string(), z.unknown()).nullable().optional(), chain: z.array(checkResultFreeformObject).nullable().optional()}).nullable().optional()}).nullable(); export const checkResult = z.object({id: z.string().optional(), name: z.string().optional(), checkId: z.string().optional(), hasFailures: z.boolean().optional(), hasErrors: z.boolean().optional(), isDegraded: z.boolean().nullable().optional(), isCancelled: z.boolean().optional(), overMaxResponseTime: z.boolean().nullable().optional(), runLocation: z.string().optional(), startedAt: z.string().nullable().optional(), stoppedAt: z.string().nullable().optional(), created_at: z.string().optional(), responseTime: z.number().optional(), apiCheckResult: checkResultAPI.optional(), browserCheckResult: checkResultBrowser.optional(), multiStepCheckResult: multiStepResultBrowser.optional(), agenticCheckResult: checkResultAgentic.optional(), playwrightCheckResult: checkResultPlaywright.optional(), tracerouteCheckResult: checkResultTraceroute.optional(), grpcCheckResult: checkResultGrpc.optional(), sslCheckResult: checkResultSsl.optional(), checkRunId: z.number().optional(), attempts: z.number().optional(), resultType: z.enum(["FINAL", "ATTEMPT", "ALL"]), sequenceId: z.string().nullable().optional(), traceId: z.string().nullable(), errorGroupIds: z.array(z.string()).nullable().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Retrieve a check result * * GET /v1/check-results/{checkId}/{checkResultId} */ export const getApiV1CheckResultsCheckIdCheckResultId = async (args: GetApiV1CheckResultsCheckIdCheckResultIdArgs, options?: GetApiV1CheckResultsCheckIdCheckResultIdOptions) => { const {baseUrl = "https://api.checklyhq.com", fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['x-checkly-account'] != null) headers.set("x-checkly-account", String(args['x-checkly-account'])) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/check-results/${encodeURIComponent(String(args.checkId))}/${encodeURIComponent(String(args.checkResultId))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(checkResult, await res.json()) };