import {z} from 'zod' export type GetApiDevicesArgs = {orgid?: number | undefined, limit?: number | undefined, startafter?: number | undefined, slim?: boolean | undefined, withlocation?: boolean | undefined, states?: string | undefined, ids?: string | undefined, tagid?: number | undefined, tagids?: string | undefined, tagname?: string | undefined, name?: string | undefined, imei?: string | undefined, linkid?: number | undefined, linkids?: string | undefined, planid?: number | undefined, iccid?: string | undefined, iccids?: string | undefined, sim?: string | undefined, sims?: string | undefined, imsi?: string | undefined, msisdn?: string | undefined, simcardid?: number | undefined, eid?: string | undefined, eids?: string | undefined, eidrange?: string | undefined, showHidden?: number | undefined, phone?: string | undefined, tunnelable?: number | undefined}; export type GetApiDevicesOptions = {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 networkState = z.enum(["INACTIVE", "INACTIVE-TESTED", "FACTORY-PENDING", "FACTORY", "LIVE-PENDING", "LIVE", "FROZEN", "FROZEN-PENDING", "DEAD", "DEAD-PENDING", "PAUSED-SYS", "PAUSED-PENDING-SYS", "PAUSED-USER", "PAUSED-PENDING-USER", "TEST-ACTIVATE", "TEST-ACTIVATE-PENDING", "TEST-AUTOACTIVATE", "TEST-AUTOACTIVATE-PENDING", "TEST-HIBERNATE", "TEST-HIBERNATE-PENDING"]); export const profileState = z.enum(["AVAILABLE", "DOWNLOAD_PENDING", "DOWNLOADED", "ENABLE_PENDING", "ENABLED", "DISABLE_PENDING", "DISABLED", "DELETE_PENDING", "ASSIGNED", "UNAVAILABLE"]); export const euiccSpec = z.enum(["Not supported", "SGP.02", "SGP.22", "SGP.32", "Unknown"]); export const asyncChangeRequestObject = z.object({id: z.number().int().optional(), parent_id: z.number().int().nullable().optional(), orgid: z.number().int().nullable().optional(), userid: z.number().int().nullable().optional(), request_type: z.enum(["plan_change", "euicc_audit", "sim_configuration_update", "configure_sim", "sim_state_pause", "sim_state_unpause", "sim_state_activation"]).optional(), reference_type: z.enum(["device", "link", "simcard", "sim_configuration"]).optional(), reference_id: z.number().int().optional(), state: z.enum(["initialized", "in_progress"]).optional(), start_time: z.string().optional(), update_time: z.string().optional(), metadata: z.object({}).nullable().optional()}); export const cellularLinkInDevice = z.object({id: z.number().int().optional(), deviceid: z.number().int().optional(), orgid: z.number().int().optional(), sim: z.string().optional(), msisdn: z.string().optional(), imsi: z.number().int().optional(), state: networkState.optional(), profile_state: profileState.optional(), profile_name: z.string().nullable().optional(), apn: z.string().optional(), zone: z.number().int().optional(), overagelimit: z.number().int().optional(), carrier: z.number().int().optional(), whencreated: z.string().optional(), whenexpires: z.string().optional(), rsp_type_id: z.number().int().nullable().optional(), rsp_type_display_name: z.string().nullable().optional(), euicc_spec: euiccSpec.nullable().optional(), async_change_requests: z.array(asyncChangeRequestObject).optional()}); export const deviceObject = z.object({id: z.number().int().optional(), name: z.string().optional(), orgid: z.number().int().optional(), type: z.string().optional(), whencreated: z.string().optional(), tags: z.array(z.string()).optional(), links: z.object({cellular: z.array(cellularLinkInDevice).optional()}).optional(), eid: z.string().nullable().optional(), imei: z.string().optional(), imei_sv: z.string().optional(), tunnelable: z.union([z.literal(0), z.literal(1)]).optional(), hidden: z.union([z.literal(0), z.literal(1)]).optional(), phonenumber: z.string().optional(), phonenumber_cost: z.string().optional(), simcardid: z.number().int().optional(), intended_network_state: networkState.optional(), intended_plan_id: z.number().int().nullable().optional(), intended_zone: z.string().nullable().optional(), intended_plan_name: z.string().nullable().optional(), intended_plan_data: z.number().int().nullable().optional(), rsp_type_id: z.number().int().nullable().optional(), rsp_type_display_name: z.string().nullable().optional(), euicc_spec: euiccSpec.nullable().optional(), sim_format: z.string().nullable().optional(), whenclaimed: z.string().nullable().optional(), euicc_tested: z.string().optional(), is_hyper: z.boolean().optional(), model: z.string().optional(), manufacturer: z.string().optional(), preflight_starttime: z.string().nullable().optional(), preflight_scheduled_endtime: z.string().nullable().optional(), async_change_requests: z.array(asyncChangeRequestObject).optional()}); export const listDevicesResponse = 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(deviceObject).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 SIMs (devices) * * GET /devices */ export const getApiDevices = async (args: GetApiDevicesArgs, options?: GetApiDevicesOptions) => { 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.orgid != null) query.append("orgid", String(args.orgid)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.startafter != null) query.append("startafter", String(args.startafter)) if (args.slim != null) query.append("slim", String(args.slim)) if (args.withlocation != null) query.append("withlocation", String(args.withlocation)) if (args.states != null) query.append("states", String(args.states)) if (args.ids != null) query.append("ids", String(args.ids)) if (args.tagid != null) query.append("tagid", String(args.tagid)) if (args.tagids != null) query.append("tagids", String(args.tagids)) if (args.tagname != null) query.append("tagname", String(args.tagname)) if (args.name != null) query.append("name", String(args.name)) if (args.imei != null) query.append("imei", String(args.imei)) if (args.linkid != null) query.append("linkid", String(args.linkid)) if (args.linkids != null) query.append("linkids", String(args.linkids)) if (args.planid != null) query.append("planid", String(args.planid)) if (args.iccid != null) query.append("iccid", String(args.iccid)) if (args.iccids != null) query.append("iccids", String(args.iccids)) if (args.sim != null) query.append("sim", String(args.sim)) if (args.sims != null) query.append("sims", String(args.sims)) if (args.imsi != null) query.append("imsi", String(args.imsi)) if (args.msisdn != null) query.append("msisdn", String(args.msisdn)) if (args.simcardid != null) query.append("simcardid", String(args.simcardid)) if (args.eid != null) query.append("eid", String(args.eid)) if (args.eids != null) query.append("eids", String(args.eids)) if (args.eidrange != null) query.append("eidrange", String(args.eidrange)) if (args.showHidden != null) query.append("showHidden", String(args.showHidden)) if (args.phone != null) query.append("phone", String(args.phone)) if (args.tunnelable != null) query.append("tunnelable", String(args.tunnelable)) if (apiKeyAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${apiKeyAuth.username}:${apiKeyAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/devices${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(listDevicesResponse, await res.json()) };