import {z} from 'zod' export type GetApiUsageDataArgs = {limit?: number | undefined, before?: number | undefined, after?: number | undefined, linkid?: number | undefined, linkids?: string | undefined, tagids?: string | undefined, timestart?: number | undefined, timeend?: number | undefined, islive?: boolean | undefined, getdeviceinfo?: boolean | undefined, getplaninfo?: boolean | undefined, getprofileinfo?: boolean | undefined, getcountryinfo?: boolean | undefined, getlocationinfo?: boolean | undefined, startafter?: number | undefined, higherthanid?: number | undefined, simcardids?: string | undefined, tagid?: number | undefined, tagname?: string | undefined}; export type GetApiUsageDataOptions = {baseUrl?: string | undefined, apiKeyAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const successProperty = z.boolean(); export const paginationLinks = z.object({path: z.string().optional(), base: z.string().optional(), next: z.string().optional()}); export const usageDataRecord = z.object({linkid: z.number().int().optional(), record_id: z.number().int().optional(), session_begin: z.string().optional(), timestamp: z.string().optional(), bytes: z.number().int().optional(), imeisv: z.string().optional(), imei: z.string().optional(), cellid: z.number().int().optional(), lac: z.number().int().optional(), radio_access_technology: z.string().optional(), network_name: z.string().optional(), sim: z.string().optional(), simcardid: z.number().int().optional(), data_plan_id: z.number().int().optional(), tags: z.array(z.string()).optional(), country: z.string().optional(), profile_name: z.string().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional()}); export const usageDataListResponse = z.object({success: successProperty.optional(), limit: z.number().int().optional(), size: z.number().int().optional(), continues: z.boolean().optional(), lastid: z.number().int().optional(), links: paginationLinks.optional(), data: z.array(usageDataRecord).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 }; /** * List recent data usage records * * GET /usage/data/ */ export const getApiUsageData = async (args: GetApiUsageDataArgs, options?: GetApiUsageDataOptions) => { const {baseUrl = "https://dashboard.hologram.io/api/1", fetch: fetchFn = fetch, apiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.before != null) query.append("before", String(args.before)) if (args.after != null) query.append("after", String(args.after)) if (args.linkid != null) query.append("linkid", String(args.linkid)) if (args.linkids != null) query.append("linkids", String(args.linkids)) if (args.tagids != null) query.append("tagids", String(args.tagids)) if (args.timestart != null) query.append("timestart", String(args.timestart)) if (args.timeend != null) query.append("timeend", String(args.timeend)) if (args.islive != null) query.append("islive", String(args.islive)) if (args.getdeviceinfo != null) query.append("getdeviceinfo", String(args.getdeviceinfo)) if (args.getplaninfo != null) query.append("getplaninfo", String(args.getplaninfo)) if (args.getprofileinfo != null) query.append("getprofileinfo", String(args.getprofileinfo)) if (args.getcountryinfo != null) query.append("getcountryinfo", String(args.getcountryinfo)) if (args.getlocationinfo != null) query.append("getlocationinfo", String(args.getlocationinfo)) if (args.startafter != null) query.append("startafter", String(args.startafter)) if (args.higherthanid != null) query.append("higherthanid", String(args.higherthanid)) if (args.simcardids != null) query.append("simcardids", String(args.simcardids)) if (args.tagid != null) query.append("tagid", String(args.tagid)) if (args.tagname != null) query.append("tagname", String(args.tagname)) if (apiKeyAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${apiKeyAuth.username}:${apiKeyAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/usage/data/${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(usageDataListResponse, await res.json()) };