import {z} from 'zod' export type GetApiTrackingsRequestIdArgs = {request_id: string}; export type GetApiTrackingsRequestIdOptions = {baseUrl: string, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const trackingInputFieldName = z.enum(["destination_country", "postal_code", "email", "phone", "additional_fields.house_number", "additional_fields.bc_code", "additional_fields.address_key", "additional_fields.consignee_info", "additional_fields.customer_token", "additional_fields.vessel", "additional_fields.voyage"]); export const trackingInputRequirements = z.object({required: z.array(trackingInputFieldName).optional(), any_of: z.array(trackingInputFieldName).optional(), conditional: z.array(trackingInputFieldName).optional()}); export const transportMode = z.enum(["parcel", "postal", "express", "road_freight", "air_cargo", "ocean_container"]); export const flightLeg = z.object({flight_number: z.string().optional(), origin: z.string().optional(), destination: z.string().optional(), status: z.string().optional(), scheduled_departure_date: z.string().optional(), scheduled_departure: z.string().optional(), scheduled_arrival: z.string().optional(), actual_departure: z.string().optional(), actual_arrival: z.string().optional(), pieces: z.number().optional(), weight: z.number().optional(), weight_unit: z.string().optional(), volume: z.number().optional(), volume_unit: z.string().optional()}); export const trackingEvent = z.object({state: z.string().optional(), location: z.string().optional(), date: z.string().optional(), event_code: z.string().optional(), station: z.string().optional(), timezone: z.string().optional(), pieces: z.number().optional(), weight: z.number().optional(), weight_unit: z.string().optional(), volume: z.number().optional(), volume_unit: z.string().optional(), flight_number: z.string().optional(), flight_origin: z.string().optional(), flight_destination: z.string().optional(), scheduled_departure_date: z.string().optional(), scheduled_departure: z.string().optional(), scheduled_arrival: z.string().optional(), actual_departure: z.string().optional(), actual_arrival: z.string().optional(), uld_number: z.string().optional(), carrier: z.number().int().optional()}); export const carrier = z.object({slug: z.string().optional(), name: z.string().optional()}); export const shipmentAttribute = z.object({l: z.string().optional(), val: z.string().optional(), code: z.string().optional()}).and(z.record(z.string(), z.unknown())); export const externalTracking = z.object({slug: z.string().optional(), url: z.string().optional(), trackingId: z.string().optional(), method: z.string().optional()}); export const shipment = z.object({trackingId: z.string().optional(), error: z.string().optional(), accepted_fields: z.array(z.enum(["postal_code", "email", "phone"])).optional(), input_requirements: trackingInputRequirements.optional(), status: z.string().optional(), origin: z.string().optional(), destination: z.string().optional(), originCode: z.string().optional(), destinationCode: z.string().optional(), transportMode: transportMode.optional(), fromAirport: z.string().optional(), toAirport: z.string().optional(), fromPort: z.string().optional(), toPort: z.string().optional(), pieces: z.number().optional(), weight: z.number().optional(), weight_unit: z.string().optional(), volume: z.number().optional(), volume_unit: z.string().optional(), flight_legs: z.array(flightLeg).optional(), states: z.array(trackingEvent).optional(), services: z.array(carrier).optional(), detectedCarrier: carrier.optional(), detected: z.array(z.number().int()).optional(), attributes: z.array(shipmentAttribute).optional(), externalTracking: z.array(externalTracking).optional()}).and(z.record(z.string(), z.unknown())); export const deliveryCompletionScope = z.enum(["carrier_acceptance_to_delivery", "airport_to_airport", "airport_to_availability", "port_to_port", "port_to_availability", "port_to_gate_out"]); export const deliveryEstimateRoute = z.object({origin_dimension: z.enum(["city", "admin1", "country", "airport", "port"]).nullable().optional(), origin_key: z.string().nullable().optional(), destination_dimension: z.enum(["city", "admin1", "country", "airport", "port"]).nullable().optional(), destination_key: z.string().nullable().optional(), carrier_specific: z.boolean().optional()}); export const deliveryEstimateRange = z.object({min: z.number().gte(0).optional(), max: z.number().gte(0).optional()}); export const deliveryEstimateRemaining = z.object({mean: z.number().gte(0).nullable().optional(), median: z.number().gte(0).optional(), min: z.number().gte(0).optional(), max: z.number().gte(0).optional()}).nullable(); export const deliveryEstimateWindow = z.object({from: z.string().optional(), to: z.string().optional()}).nullable(); export const deliveryEstimateValues = z.object({mean_days: z.number().gte(0), median_days: z.number().gte(0), typical_days: deliveryEstimateRange, remaining_status: z.enum(["not_requested", "estimated", "insufficient_censored_data", "insufficient_tail_data"]), remaining_days: deliveryEstimateRemaining.optional(), estimated_delivery_at: deliveryEstimateWindow.optional()}); export const deliveryEstimateConfidence = z.object({level: z.enum(["low", "medium", "high"]), score: z.number().gte(0).lte(1), sample_count: z.number().int().gte(8), effective_sample_count: z.number().gte(0), remaining_effective_sample_count: z.number().gte(0).optional(), minimum_remaining_effective_sample_count: z.number().gte(1).optional(), survival_subject_count: z.number().int().gte(0).optional(), survival_completed_count: z.number().int().gte(0).optional(), survival_censored_count: z.number().int().gte(0).optional(), survival_risk_set: z.number().int().gte(0).optional(), survival_minimum_subject_count: z.number().int().gte(1).optional(), survival_minimum_completed_count: z.number().int().gte(1).optional(), survival_cohort_age_days: z.number().gte(0).optional(), survival_minimum_maturation_days: z.number().int().gte(1).optional(), lookback_days: z.number().int().gte(1), last_observation_at: z.string().nullable().optional(), freshness_days: z.number().gte(0).optional(), fallback_level: z.number().int().gte(0)}); export const deliveryEstimateInsufficientData = z.object({code: z.literal("INSUFFICIENT_DATA"), message: z.string(), available_sample_count: z.number().int().gte(0), minimum_sample_count: z.number().int().gte(1)}); export const deliveryEstimateResult = z.object({client_reference: z.string().optional(), carrier_slug: z.string(), transport_mode: transportMode, completion_scope: deliveryCompletionScope, route_scope_used: z.string().optional(), route: deliveryEstimateRoute.optional(), estimate: deliveryEstimateValues.optional(), confidence: deliveryEstimateConfidence.optional(), model: z.object({version: z.string().optional(), unit: z.literal("calendar_days").optional(), histogram_bucket_hours: z.number().int().optional(), remaining_method: z.enum(["kaplan_meier_right_censored_v1", "completed_tail_guard_v1"]).optional()}).optional(), error: deliveryEstimateInsufficientData.optional()}); export const trackingResult = z.object({tracking_number: z.string(), state: z.enum(["processing", "completed"]), from_cache: z.boolean(), shipment: shipment.optional(), delivery_estimate: deliveryEstimateResult.optional()}); export const rejectedShipment = z.object({index: z.number().int(), tracking_number: z.string().optional(), code: z.enum(["INVALID_TRACKING_NUMBER", "DESTINATION_COUNTRY_REQUIRED", "INVALID_ADDITIONAL_FIELDS"]), message: z.string()}); export const webhookRegistration = z.object({url: z.string().optional(), secret: z.string().optional(), signature_header: z.string().optional()}); export const trackingResponse = z.object({request_id: z.string(), status: z.enum(["processing", "completed"]), done: z.boolean(), expires_at: z.string(), results: z.array(trackingResult), rejected: z.array(rejectedShipment).optional(), webhook: webhookRegistration.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 }; /** * Read tracking results * * GET /trackings/{request_id} */ export const getApiTrackingsRequestId = async (args: GetApiTrackingsRequestIdArgs, options: GetApiTrackingsRequestIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/trackings/${encodeURIComponent(String(args.request_id))}${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(trackingResponse, await res.json()) };