import {z} from 'zod' export type GetApiV1AnalyticsTcpChecksIdArgs = {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<'total' | 'dns' | 'connection' | 'data' | 'availability' | 'retries' | 'total_avg' | 'total_max' | 'total_median' | 'total_min' | 'total_p50' | 'total_p90' | 'total_p95' | 'total_p99' | 'total_stddev' | 'total_sum' | 'dns_avg' | 'dns_max' | 'dns_median' | 'dns_min' | 'dns_p50' | 'dns_p90' | 'dns_p95' | 'dns_p99' | 'dns_stddev' | 'dns_sum' | 'connection_avg' | 'connection_max' | 'connection_median' | 'connection_min' | 'connection_p50' | 'connection_p90' | 'connection_p95' | 'connection_p99' | 'connection_stddev' | 'connection_sum' | 'data_avg' | 'data_max' | 'data_median' | 'data_min' | 'data_p50' | 'data_p90' | 'data_p95' | 'data_p99' | 'data_stddev' | 'data_sum'>, limit?: number | undefined, page?: number | undefined, 'x-checkly-account'?: string | undefined}; export type GetApiV1AnalyticsTcpChecksIdOptions = {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 analyticsTcpCheckMetadata = z.object({total: analyticsMetricMetadata.optional(), dns: analyticsMetricMetadata.optional(), connection: analyticsMetricMetadata.optional(), data: analyticsMetricMetadata.optional(), availability: analyticsMetricMetadata.optional(), retries: analyticsMetricMetadata.optional(), total_avg: analyticsMetricMetadata.optional(), total_max: analyticsMetricMetadata.optional(), total_median: analyticsMetricMetadata.optional(), total_min: analyticsMetricMetadata.optional(), total_p50: analyticsMetricMetadata.optional(), total_p90: analyticsMetricMetadata.optional(), total_p95: analyticsMetricMetadata.optional(), total_p99: analyticsMetricMetadata.optional(), total_stddev: analyticsMetricMetadata.optional(), total_sum: analyticsMetricMetadata.optional(), dns_avg: analyticsMetricMetadata.optional(), dns_max: analyticsMetricMetadata.optional(), dns_median: analyticsMetricMetadata.optional(), dns_min: analyticsMetricMetadata.optional(), dns_p50: analyticsMetricMetadata.optional(), dns_p90: analyticsMetricMetadata.optional(), dns_p95: analyticsMetricMetadata.optional(), dns_p99: analyticsMetricMetadata.optional(), dns_stddev: analyticsMetricMetadata.optional(), dns_sum: analyticsMetricMetadata.optional(), connection_avg: analyticsMetricMetadata.optional(), connection_max: analyticsMetricMetadata.optional(), connection_median: analyticsMetricMetadata.optional(), connection_min: analyticsMetricMetadata.optional(), connection_p50: analyticsMetricMetadata.optional(), connection_p90: analyticsMetricMetadata.optional(), connection_p95: analyticsMetricMetadata.optional(), connection_p99: analyticsMetricMetadata.optional(), connection_stddev: analyticsMetricMetadata.optional(), connection_sum: analyticsMetricMetadata.optional(), data_avg: analyticsMetricMetadata.optional(), data_max: analyticsMetricMetadata.optional(), data_median: analyticsMetricMetadata.optional(), data_min: analyticsMetricMetadata.optional(), data_p50: analyticsMetricMetadata.optional(), data_p90: analyticsMetricMetadata.optional(), data_p95: analyticsMetricMetadata.optional(), data_p99: analyticsMetricMetadata.optional(), data_stddev: analyticsMetricMetadata.optional(), data_sum: analyticsMetricMetadata.optional()}); export const analyticsTcpCheckResponse = 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: analyticsTcpCheckMetadata.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 }; /** * TCP checks * * GET /v1/analytics/tcp-checks/{id} */ export const getApiV1AnalyticsTcpChecksId = async (args: GetApiV1AnalyticsTcpChecksIdArgs, options?: GetApiV1AnalyticsTcpChecksIdOptions) => { 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/tcp-checks/${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(analyticsTcpCheckResponse, await res.json()) };