import {z} from 'zod' export type GetApiV1UsageSummaryArgs = {to?: string | undefined, from?: string | undefined, accountIds?: (Array | null) | undefined, checkTypes?: (Array<'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'URL' | 'DNS' | 'SSL' | 'GRPC' | 'TRACEROUTE'> | null) | undefined, 'x-checkly-account'?: string | undefined}; export type GetApiV1UsageSummaryOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const usageV1SummaryPeriod = z.object({from: z.string(), to: z.string()}); export const usageV1Credits = z.object({used: z.number().gte(0).nullable(), percentOfBudget: z.number().gte(0).nullable()}); export const usageV1CheckRunMeter = z.object({meterType: z.literal("CHECK_RUN"), measures: z.object({totalRuns: z.number().int().gte(0), finalRuns: z.number().int().gte(0), retryRuns: z.number().int().gte(0), cancelledRuns: z.number().int().gte(0), multiStepRequests: z.number().int().gte(0), playwrightBillableDurationMs: z.number().int().gte(0), degradedRuns: z.number().int().gte(0), failedRuns: z.number().int().gte(0), errorRuns: z.number().int().gte(0), abortedRuns: z.number().int().gte(0), overMaxResponseTimeRuns: z.number().int().gte(0), standardBillableUnits: z.number().int().gte(0), premiumBillableUnits: z.number().int().gte(0)})}); export const usageV1AiInvocationMeter = z.object({meterType: z.literal("AI_INVOCATION"), measures: z.object({invocations: z.number().int().gte(0), durationMs: z.number().int().gte(0)})}); export const usageV1Meter = z.discriminatedUnion("meterType", [usageV1CheckRunMeter, usageV1AiInvocationMeter]); export const usageV1Metrics = z.object({credits: usageV1Credits, meters: z.array(usageV1Meter)}); export const usageV1ProjectionWindow = z.object({usage: usageV1Metrics, projectedAnnualPercentOfBudget: z.number().gte(0).nullable(), projectedCreditsAtContractEnd: z.number().gte(0).nullable(), projectedPercentAtContractEnd: z.number().gte(0).nullable(), projectedWeeksUntilExhausted: z.number().gte(0).nullable()}); export const usageV1Projections = z.object({weeksSinceStart: z.number().int().gte(0), weeksRemaining: z.number().int().gte(0), remainingCredits: z.number().nullable(), windows: z.object({sinceStart: usageV1ProjectionWindow, last30Days: usageV1ProjectionWindow, last7Days: usageV1ProjectionWindow, last1Day: usageV1ProjectionWindow})}); export const usageV1SummaryResponse = z.object({usageTermsId: z.string().nullable(), period: usageV1SummaryPeriod, totals: usageV1Metrics, projections: usageV1Projections}); 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 }; /** * Get organization usage totals and projections. * * GET /v1/usage/summary */ export const getApiV1UsageSummary = async (args: GetApiV1UsageSummaryArgs, options?: GetApiV1UsageSummaryOptions) => { 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.to != null) query.append("to", String(args.to)) if (args.from != null) query.append("from", String(args.from)) for (const item of args.accountIds ?? []) query.append("accountIds", String(item)) for (const item of args.checkTypes ?? []) query.append("checkTypes", String(item)) 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/usage/summary${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(usageV1SummaryResponse, await res.json()) };