import {z} from 'zod' export type GetApiV1TrackersCarrierNameTrackingNumberArgs = {carrier_name: 'allied_express' | 'allied_express_local' | 'amazon_shipping' | 'aramex' | 'asendia_us' | 'australiapost' | 'boxknight' | 'bpost' | 'canadapost' | 'canpar' | 'chronopost' | 'colissimo' | 'dhl_express' | 'dhl_parcel_de' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'fedex_ws' | 'generic' | 'geodis' | 'hay_post' | 'laposte' | 'locate2u' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'seko' | 'sendle' | 'tge' | 'tnt' | 'ups' | 'usps' | 'usps_international' | 'usps_wt' | 'usps_wt_international' | 'zoom2u', hub?: string | undefined, tracking_number: string}; export type GetApiV1TrackersCarrierNameTrackingNumberOptions = {baseUrl: string, TokenBasic?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const trackingInfo = z.object({carrier_tracking_link: z.string().nullable().optional(), customer_name: z.string().nullable().optional(), expected_delivery: z.string().nullable().optional(), note: z.string().nullable().optional(), order_date: z.string().nullable().optional(), order_id: z.string().nullable().optional(), package_weight: z.string().nullable().optional(), package_weight_unit: z.string().nullable().optional(), shipment_package_count: z.string().nullable().optional(), shipment_pickup_date: z.string().nullable().optional(), shipment_delivery_date: z.string().nullable().optional(), shipment_service: z.string().nullable().optional(), shipment_origin_country: z.string().nullable().optional(), shipment_origin_postal_code: z.string().nullable().optional(), shipment_destination_country: z.string().nullable().optional(), shipment_destination_postal_code: z.string().nullable().optional(), shipping_date: z.string().nullable().optional(), signed_by: z.string().nullable().optional(), source: z.string().nullable().optional()}); export const trackingEvent = z.object({date: z.string().optional(), description: z.string().optional(), location: z.string().optional(), code: z.string().nullable().optional(), time: z.string().nullable().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional()}); export const message = z.object({message: z.string().optional(), code: z.string().optional(), details: z.record(z.string(), z.unknown()).optional(), carrier_name: z.string().optional(), carrier_id: z.string().optional()}); export const trackingStatus = z.object({id: z.string().optional(), carrier_name: z.string(), carrier_id: z.string(), tracking_number: z.string(), info: trackingInfo.nullable().optional(), events: z.array(trackingEvent).nullable().optional(), delivered: z.boolean().optional(), test_mode: z.boolean(), status: z.enum(["pending", "unknown", "on_hold", "delivered", "in_transit", "delivery_delayed", "out_for_delivery", "ready_for_pickup", "delivery_failed"]).optional(), estimated_delivery: z.string().optional(), meta: z.record(z.string(), z.unknown()).nullable().optional(), object_type: z.string().optional(), metadata: z.record(z.string(), z.unknown()).optional(), messages: z.array(message).optional(), delivery_image_url: z.string().nullable().optional(), signature_image_url: z.string().nullable().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 }; /** * Create a package tracker * * GET /v1/trackers/{carrier_name}/{tracking_number} * * Also accepts auth: Token, OAuth2, JWT */ export const getApiV1TrackersCarrierNameTrackingNumber = async (args: GetApiV1TrackersCarrierNameTrackingNumberArgs, options: GetApiV1TrackersCarrierNameTrackingNumberOptions) => { const {baseUrl, fetch: fetchFn = fetch, TokenBasic} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.carrier_name != null) query.append("carrier_name", String(args.carrier_name)) if (args.hub != null) query.append("hub", String(args.hub)) if (TokenBasic !== undefined) headers.set('authorization', `Basic ${btoa(`${TokenBasic.username}:${TokenBasic.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/trackers/${encodeURIComponent(String(args.carrier_name))}/${encodeURIComponent(String(args.tracking_number))}${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(trackingStatus, await res.json()) };