import {z} from 'zod' export type GetApiApiV1TrackingShipiumTrackingIdArgs = {shipiumTrackingId: string, excludeEvents?: boolean | undefined}; export type GetApiApiV1TrackingShipiumTrackingIdOptions = {baseUrl?: string | undefined, oauth2Scheme?: string | undefined, fetch?: typeof fetch | undefined}; export const trackingEventDto = z.object({carrierDescription: z.string().optional(), shipmentStatus: z.enum(["Registered", "Label Printed", "In Transit", "Out For Delivery", "Delivered", "Exception", "Return to Sender: In Transit", "Return to Sender: Out For Delivery", "Return to Sender: Delivered", "Return to Sender: Exception"]).optional(), eventDate: z.string().optional(), postalCode: z.string().optional(), country: z.string().optional(), city: z.string().optional(), region: z.string().optional()}); export const trackingDto = z.object({shipiumTrackingId: z.string().optional(), shipiumShipmentId: z.string().optional(), partnerShipmentId: z.string().optional(), shipiumTenantId: z.string().optional(), partnerTenantId: z.string().optional(), carrierId: z.string().optional(), carrierTrackingId: z.string().optional(), carrierServiceMethodId: z.string().optional(), shipmentStatus: z.enum(["Registered", "Label Printed", "In Transit", "Out For Delivery", "Delivered", "Exception", "Return to Sender: In Transit", "Return to Sender: Out For Delivery", "Return to Sender: Delivered", "Return to Sender: Exception"]).optional(), shippedDateTime: z.string().optional(), deliveredAtDateTime: z.string().optional(), carrierEstimatedDeliveryDate: z.string().optional(), originalCarrierEstimatedDeliveryDate: z.string().optional(), partnerReferenceId: z.string().optional(), partnerReferenceId2: z.string().optional(), carrierTrackingLink: z.string().optional(), trackingEvents: z.array(trackingEventDto).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 }; /** * Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId * * GET /api/v1/tracking/{shipiumTrackingId} */ export const getApiApiV1TrackingShipiumTrackingId = async (args: GetApiApiV1TrackingShipiumTrackingIdArgs, options?: GetApiApiV1TrackingShipiumTrackingIdOptions) => { const {baseUrl = "https://api.shipium.com", fetch: fetchFn = fetch, oauth2Scheme} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.excludeEvents != null) query.append("excludeEvents", String(args.excludeEvents)) if (oauth2Scheme !== undefined) headers.set('authorization', `Bearer ${oauth2Scheme}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/tracking/${encodeURIComponent(String(args.shipiumTrackingId))}${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(trackingDto, await res.json()) };