import {z} from 'zod' export type GetApiV2UsageTermsIdProjectionsArgs = {id: string, asOf?: string | undefined, 'x-checkly-account'?: string | undefined}; export type GetApiV2UsageTermsIdProjectionsOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const usageV2ProjectionWindow = z.object({period: z.object({from: z.string(), to: z.string()}).nullable(), observedDays: z.number().int().gte(0), creditsUsed: z.number().gte(0).nullable(), averageDailyCredits: z.number().gte(0).nullable(), projectedAnnualPercentOfBudget: z.number().gte(0).nullable(), projectedCreditsAtContractEnd: z.number().gte(0).nullable(), projectedRemainingCredits: z.number().nullable(), projectedPercentAtContractEnd: z.number().gte(0).nullable(), projectedWeeksUntilExhausted: z.number().gte(0).nullable()}); export const usageV2ProjectionsResponse = z.object({usageTermsId: z.string(), asOf: z.string(), period: z.object({from: z.string(), to: z.string()}).nullable(), weeksSinceStart: z.number().int().gte(0), weeksRemaining: z.number().int().gte(0), creditsUsed: z.number().gte(0).nullable(), remainingCredits: z.number().nullable(), budgetedDailyCredits: z.number().gte(0).nullable(), windows: z.object({sinceStart: usageV2ProjectionWindow, last30Days: usageV2ProjectionWindow, last7Days: usageV2ProjectionWindow, last1Day: usageV2ProjectionWindow})}); 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 usage projections * * GET /v2/usage/terms/{id}/projections */ export const getApiV2UsageTermsIdProjections = async (args: GetApiV2UsageTermsIdProjectionsArgs, options?: GetApiV2UsageTermsIdProjectionsOptions) => { 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.asOf != null) query.append("asOf", String(args.asOf)) 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(/\/+$/, '')}/v2/usage/terms/${encodeURIComponent(String(args.id))}/projections${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(usageV2ProjectionsResponse, await res.json()) };