import {z} from 'zod' export type GetApiV1AnalyticsSslIdArgs = {id: string, from?: string | undefined, to?: string | undefined, quickRange?: ('last24Hours' | 'last7Days' | 'last30Days' | 'thisWeek' | 'thisMonth' | 'lastWeek' | 'lastMonth') | undefined, aggregationInterval?: number | undefined, filterByStatus?: (Array<'success' | 'failure'>) | undefined, groupBy?: 'runLocation' | undefined, metrics: Array<'handshakeTimeMs' | 'daysUntilExpiry' | 'tlsVersion' | 'cipherSuite' | 'hostnameVerified' | 'chainTrusted' | 'ocspStapled' | 'keySizeBits' | 'baselineVerdict' | 'baselineGrade' | 'availability' | 'retries' | 'handshakeTimeMs_avg' | 'handshakeTimeMs_max' | 'handshakeTimeMs_median' | 'handshakeTimeMs_min' | 'handshakeTimeMs_p50' | 'handshakeTimeMs_p90' | 'handshakeTimeMs_p95' | 'handshakeTimeMs_p99' | 'handshakeTimeMs_stddev' | 'handshakeTimeMs_sum' | 'daysUntilExpiry_avg' | 'daysUntilExpiry_max' | 'daysUntilExpiry_median' | 'daysUntilExpiry_min' | 'daysUntilExpiry_p50' | 'daysUntilExpiry_p90' | 'daysUntilExpiry_p95' | 'daysUntilExpiry_p99' | 'daysUntilExpiry_stddev' | 'daysUntilExpiry_sum' | 'tlsVersion_avg' | 'tlsVersion_max' | 'tlsVersion_median' | 'tlsVersion_min' | 'tlsVersion_p50' | 'tlsVersion_p90' | 'tlsVersion_p95' | 'tlsVersion_p99' | 'tlsVersion_stddev' | 'tlsVersion_sum' | 'cipherSuite_avg' | 'cipherSuite_max' | 'cipherSuite_median' | 'cipherSuite_min' | 'cipherSuite_p50' | 'cipherSuite_p90' | 'cipherSuite_p95' | 'cipherSuite_p99' | 'cipherSuite_stddev' | 'cipherSuite_sum' | 'hostnameVerified_avg' | 'hostnameVerified_max' | 'hostnameVerified_median' | 'hostnameVerified_min' | 'hostnameVerified_p50' | 'hostnameVerified_p90' | 'hostnameVerified_p95' | 'hostnameVerified_p99' | 'hostnameVerified_stddev' | 'hostnameVerified_sum' | 'chainTrusted_avg' | 'chainTrusted_max' | 'chainTrusted_median' | 'chainTrusted_min' | 'chainTrusted_p50' | 'chainTrusted_p90' | 'chainTrusted_p95' | 'chainTrusted_p99' | 'chainTrusted_stddev' | 'chainTrusted_sum' | 'ocspStapled_avg' | 'ocspStapled_max' | 'ocspStapled_median' | 'ocspStapled_min' | 'ocspStapled_p50' | 'ocspStapled_p90' | 'ocspStapled_p95' | 'ocspStapled_p99' | 'ocspStapled_stddev' | 'ocspStapled_sum' | 'keySizeBits_avg' | 'keySizeBits_max' | 'keySizeBits_median' | 'keySizeBits_min' | 'keySizeBits_p50' | 'keySizeBits_p90' | 'keySizeBits_p95' | 'keySizeBits_p99' | 'keySizeBits_stddev' | 'keySizeBits_sum' | 'baselineVerdict_avg' | 'baselineVerdict_max' | 'baselineVerdict_median' | 'baselineVerdict_min' | 'baselineVerdict_p50' | 'baselineVerdict_p90' | 'baselineVerdict_p95' | 'baselineVerdict_p99' | 'baselineVerdict_stddev' | 'baselineVerdict_sum' | 'baselineGrade_avg' | 'baselineGrade_max' | 'baselineGrade_median' | 'baselineGrade_min' | 'baselineGrade_p50' | 'baselineGrade_p90' | 'baselineGrade_p95' | 'baselineGrade_p99' | 'baselineGrade_stddev' | 'baselineGrade_sum'>, limit?: number | undefined, page?: number | undefined, 'x-checkly-account'?: string | undefined}; export type GetApiV1AnalyticsSslIdOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const analyticsSeriesRow = z.record(z.string(), z.unknown()); export const analyticsSeriesData = z.union([z.array(analyticsSeriesRow), analyticsSeriesRow]); export const analyticsSeriesEntry = z.object({data: analyticsSeriesData}).and(z.record(z.string(), z.unknown())); export const analyticsPagination = z.object({page: z.number().optional(), limit: z.number().optional()}); export const analyticsMetricMetadata = z.object({unit: z.enum(["milliseconds", "score", "count", "percentage"]).optional(), label: z.string().optional(), aggregation: z.enum(["avg", "max", "median", "min", "p50", "p90", "p95", "p99", "stddev", "sum"]).optional()}); export const analyticsSslMonitorMetadata = z.object({handshakeTimeMs: analyticsMetricMetadata.optional(), daysUntilExpiry: analyticsMetricMetadata.optional(), tlsVersion: analyticsMetricMetadata.optional(), cipherSuite: analyticsMetricMetadata.optional(), hostnameVerified: analyticsMetricMetadata.optional(), chainTrusted: analyticsMetricMetadata.optional(), ocspStapled: analyticsMetricMetadata.optional(), keySizeBits: analyticsMetricMetadata.optional(), baselineVerdict: analyticsMetricMetadata.optional(), baselineGrade: analyticsMetricMetadata.optional(), availability: analyticsMetricMetadata.optional(), retries: analyticsMetricMetadata.optional(), handshakeTimeMs_avg: analyticsMetricMetadata.optional(), handshakeTimeMs_max: analyticsMetricMetadata.optional(), handshakeTimeMs_median: analyticsMetricMetadata.optional(), handshakeTimeMs_min: analyticsMetricMetadata.optional(), handshakeTimeMs_p50: analyticsMetricMetadata.optional(), handshakeTimeMs_p90: analyticsMetricMetadata.optional(), handshakeTimeMs_p95: analyticsMetricMetadata.optional(), handshakeTimeMs_p99: analyticsMetricMetadata.optional(), handshakeTimeMs_stddev: analyticsMetricMetadata.optional(), handshakeTimeMs_sum: analyticsMetricMetadata.optional(), daysUntilExpiry_avg: analyticsMetricMetadata.optional(), daysUntilExpiry_max: analyticsMetricMetadata.optional(), daysUntilExpiry_median: analyticsMetricMetadata.optional(), daysUntilExpiry_min: analyticsMetricMetadata.optional(), daysUntilExpiry_p50: analyticsMetricMetadata.optional(), daysUntilExpiry_p90: analyticsMetricMetadata.optional(), daysUntilExpiry_p95: analyticsMetricMetadata.optional(), daysUntilExpiry_p99: analyticsMetricMetadata.optional(), daysUntilExpiry_stddev: analyticsMetricMetadata.optional(), daysUntilExpiry_sum: analyticsMetricMetadata.optional(), tlsVersion_avg: analyticsMetricMetadata.optional(), tlsVersion_max: analyticsMetricMetadata.optional(), tlsVersion_median: analyticsMetricMetadata.optional(), tlsVersion_min: analyticsMetricMetadata.optional(), tlsVersion_p50: analyticsMetricMetadata.optional(), tlsVersion_p90: analyticsMetricMetadata.optional(), tlsVersion_p95: analyticsMetricMetadata.optional(), tlsVersion_p99: analyticsMetricMetadata.optional(), tlsVersion_stddev: analyticsMetricMetadata.optional(), tlsVersion_sum: analyticsMetricMetadata.optional(), cipherSuite_avg: analyticsMetricMetadata.optional(), cipherSuite_max: analyticsMetricMetadata.optional(), cipherSuite_median: analyticsMetricMetadata.optional(), cipherSuite_min: analyticsMetricMetadata.optional(), cipherSuite_p50: analyticsMetricMetadata.optional(), cipherSuite_p90: analyticsMetricMetadata.optional(), cipherSuite_p95: analyticsMetricMetadata.optional(), cipherSuite_p99: analyticsMetricMetadata.optional(), cipherSuite_stddev: analyticsMetricMetadata.optional(), cipherSuite_sum: analyticsMetricMetadata.optional(), hostnameVerified_avg: analyticsMetricMetadata.optional(), hostnameVerified_max: analyticsMetricMetadata.optional(), hostnameVerified_median: analyticsMetricMetadata.optional(), hostnameVerified_min: analyticsMetricMetadata.optional(), hostnameVerified_p50: analyticsMetricMetadata.optional(), hostnameVerified_p90: analyticsMetricMetadata.optional(), hostnameVerified_p95: analyticsMetricMetadata.optional(), hostnameVerified_p99: analyticsMetricMetadata.optional(), hostnameVerified_stddev: analyticsMetricMetadata.optional(), hostnameVerified_sum: analyticsMetricMetadata.optional(), chainTrusted_avg: analyticsMetricMetadata.optional(), chainTrusted_max: analyticsMetricMetadata.optional(), chainTrusted_median: analyticsMetricMetadata.optional(), chainTrusted_min: analyticsMetricMetadata.optional(), chainTrusted_p50: analyticsMetricMetadata.optional(), chainTrusted_p90: analyticsMetricMetadata.optional(), chainTrusted_p95: analyticsMetricMetadata.optional(), chainTrusted_p99: analyticsMetricMetadata.optional(), chainTrusted_stddev: analyticsMetricMetadata.optional(), chainTrusted_sum: analyticsMetricMetadata.optional(), ocspStapled_avg: analyticsMetricMetadata.optional(), ocspStapled_max: analyticsMetricMetadata.optional(), ocspStapled_median: analyticsMetricMetadata.optional(), ocspStapled_min: analyticsMetricMetadata.optional(), ocspStapled_p50: analyticsMetricMetadata.optional(), ocspStapled_p90: analyticsMetricMetadata.optional(), ocspStapled_p95: analyticsMetricMetadata.optional(), ocspStapled_p99: analyticsMetricMetadata.optional(), ocspStapled_stddev: analyticsMetricMetadata.optional(), ocspStapled_sum: analyticsMetricMetadata.optional(), keySizeBits_avg: analyticsMetricMetadata.optional(), keySizeBits_max: analyticsMetricMetadata.optional(), keySizeBits_median: analyticsMetricMetadata.optional(), keySizeBits_min: analyticsMetricMetadata.optional(), keySizeBits_p50: analyticsMetricMetadata.optional(), keySizeBits_p90: analyticsMetricMetadata.optional(), keySizeBits_p95: analyticsMetricMetadata.optional(), keySizeBits_p99: analyticsMetricMetadata.optional(), keySizeBits_stddev: analyticsMetricMetadata.optional(), keySizeBits_sum: analyticsMetricMetadata.optional(), baselineVerdict_avg: analyticsMetricMetadata.optional(), baselineVerdict_max: analyticsMetricMetadata.optional(), baselineVerdict_median: analyticsMetricMetadata.optional(), baselineVerdict_min: analyticsMetricMetadata.optional(), baselineVerdict_p50: analyticsMetricMetadata.optional(), baselineVerdict_p90: analyticsMetricMetadata.optional(), baselineVerdict_p95: analyticsMetricMetadata.optional(), baselineVerdict_p99: analyticsMetricMetadata.optional(), baselineVerdict_stddev: analyticsMetricMetadata.optional(), baselineVerdict_sum: analyticsMetricMetadata.optional(), baselineGrade_avg: analyticsMetricMetadata.optional(), baselineGrade_max: analyticsMetricMetadata.optional(), baselineGrade_median: analyticsMetricMetadata.optional(), baselineGrade_min: analyticsMetricMetadata.optional(), baselineGrade_p50: analyticsMetricMetadata.optional(), baselineGrade_p90: analyticsMetricMetadata.optional(), baselineGrade_p95: analyticsMetricMetadata.optional(), baselineGrade_p99: analyticsMetricMetadata.optional(), baselineGrade_stddev: analyticsMetricMetadata.optional(), baselineGrade_sum: analyticsMetricMetadata.optional()}); export const analyticsSslMonitorResponse = z.object({checkId: z.string().optional(), name: z.string().optional(), checkType: z.enum(["AGENTIC", "API", "BROWSER", "HEARTBEAT", "ICMP", "MULTI_STEP", "TCP", "PLAYWRIGHT", "TRACEROUTE", "URL", "DNS", "SSL", "GRPC"]).optional(), activated: z.boolean().optional(), muted: z.boolean().optional(), frequency: z.number().optional(), from: z.string().optional(), to: z.string().optional(), tags: z.array(z.string()).optional(), series: z.array(analyticsSeriesEntry).optional(), pagination: analyticsPagination.optional(), metadata: analyticsSslMonitorMetadata.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 }; /** * SSL monitors * * GET /v1/analytics/ssl/{id} */ export const getApiV1AnalyticsSslId = async (args: GetApiV1AnalyticsSslIdArgs, options?: GetApiV1AnalyticsSslIdOptions) => { 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.from != null) query.append("from", String(args.from)) if (args.to != null) query.append("to", String(args.to)) if (args.quickRange != null) query.append("quickRange", String(args.quickRange)) if (args.aggregationInterval != null) query.append("aggregationInterval", String(args.aggregationInterval)) for (const item of args.filterByStatus ?? []) query.append("filterByStatus", String(item)) if (args.groupBy != null) query.append("groupBy", String(args.groupBy)) for (const item of args.metrics ?? []) query.append("metrics", String(item)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.page != null) query.append("page", String(args.page)) 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/analytics/ssl/${encodeURIComponent(String(args.id))}${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(analyticsSslMonitorResponse, await res.json()) };