import {z} from 'zod' export type GetApiV2LoadsArgs = {loadNumber: string}; export type GetApiV2LoadsOptions = {baseUrl?: string | undefined, httpBasic?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const loadStatus = z.enum(["DRAFT", "CUSTOMER_CONFIRMED", "COVERED", "DISPATCHED", "AT_PICKUP", "IN_TRANSIT", "AT_DELIVERY", "DELIVERED", "POD_COLLECTED", "PAID", "CANCELED", "ERROR", "ARCHIVED"]); export const stopCustomData = z.record(z.string(), z.unknown()).nullable(); export const routeStop = z.object({sequenceNumber: z.number().int(), externalId: z.string().nullable().optional(), activityType: z.enum(["PICKUP", "DELIVERY"]), address: z.object({name: z.string().nullable().optional(), company: z.string().nullable().optional(), street1: z.string().nullable().optional(), street2: z.string().nullable().optional(), city: z.string().optional(), stateOrProvince: z.string().optional(), postalCode: z.string().nullable().optional(), country: z.string().optional()}), timezone: z.string().nullable().optional(), stopNotes: z.string().nullable().optional(), facilityCode: z.string().nullable().optional(), scheduleTypes: z.array(z.enum(["APPOINTMENT", "FIRST_COME_FIRST_SERVE"])).optional(), expectedStopWindowStart: z.string().nullable().optional(), expectedStopWindowEnd: z.string().nullable().optional(), expectedDropWindowStart: z.string().nullable().optional(), expectedDropWindowEnd: z.string().nullable().optional(), actualArrivalTime: z.string().nullable().optional(), actualDepartureTime: z.string().nullable().optional(), mustArriveByDate: z.string().nullable().optional(), customData: stopCustomData.nullable().optional()}); export const commodityItem = z.object({quantity: z.number().int().optional(), description: z.string().nullable().optional(), totalWeightLbs: z.number().nullable().optional(), lengthInches: z.number().int().nullable().optional(), widthInches: z.number().int().nullable().optional(), heightInches: z.number().int().nullable().optional(), freightClass: z.string().nullable().optional(), nmfc: z.string().nullable().optional(), density: z.number().nullable().optional(), pickupSequence: z.number().int().nullable().optional(), deliverySequence: z.number().int().nullable().optional()}); export const loadReferenceNumberName = z.enum(["BILLED_DATE", "BOOKING_NUMBER", "BOL_NUMBER", "CONSIGNEE_NUMBER", "CONSIGNEE_REF_NUMBER", "CONTAINER_NUMBER", "CONTROL_NUMBER", "CUSTOMER_REF_NUMBER", "DAT_POSTING_ID", "PICKUP_NUMBER", "PO_NUMBER", "POSTING_GROUP_ID", "PRO_NUMBER", "RELEASED_DATE", "REQUIRED_DOCS", "SHIPMENT_NUMBER", "SHIPPER_NUMBER", "TMS_LOAD_STATUS", "TMS_SHIPMENT_STATUS", "TRAILER_NUMBER", "TRUCK_NUMBER", "OTHER"]); export const trackingEventContact = z.object({id: z.string().optional(), name: z.string().optional(), phone: z.string().optional(), phoneExtension: z.string().optional(), email: z.string().optional()}); export const trackingEvent = z.object({nextSequence: z.number().int().optional(), nextEtaUtc: z.string().optional(), eventType: z.enum(["DELAYED", "INFO", "PICKED_UP", "PING", "COVERED", "DISPATCHED"]), eventSource: z.enum(["4KITES", "CARRIER_API", "HIGHWAY", "MACROPOINT", "P44", "PHONE_EMAIL", "SMC3", "TEXT", "TMS", "TRUCKER_TOOLS", "OTHER"]), eventUtc: z.string(), isLocalTime: z.boolean().optional(), city: z.string().optional(), country: z.string().optional(), stateOrProvince: z.string().optional(), postalCode: z.string().optional(), latitude: z.number().optional(), longitude: z.number().optional(), temperatureF: z.number().optional(), notes: z.string().optional(), dispatcher: trackingEventContact.optional(), driver: trackingEventContact.optional()}); export const externalTrackingStatusCode = z.enum(["READY", "WAITING", "FAILED", "COMPLETED"]); export const loadCustomer = z.object({name: z.string(), customerId: z.string().nullable().optional(), customerContact: z.string().nullable().optional()}); export const accessorialsEnum = z.string(); export const packageType = z.enum(["PALLET", "PIECE", "CARTON", "TOTE", "SKID", "CRATE", "BOX", "DRUM", "CASE", "BUNDLE", "OTHER", "FLOOR_LOADED", "ROLL", "SHEET"]); export const loadItemUnit = z.object({unitType: packageType, quantity: z.number()}); export const loadItem = z.object({quantity: z.number().int(), packagingUnit: loadItemUnit.optional(), handlingUnit: loadItemUnit.optional(), description: z.string().optional(), totalWeightLbs: z.number(), lengthInches: z.number().int().optional(), widthInches: z.number().int().optional(), heightInches: z.number().int().optional(), freightClass: z.enum(["50", "55", "60", "65", "70", "77.5", "85", "92.5", "100", "110", "125", "150", "175", "200", "250", "300", "400", "500"]).optional(), nmfc: z.string().optional(), density: z.number().optional(), pickupSequence: z.number().int().optional(), deliverySequence: z.number().int().optional()}); export const loadService = z.enum(["HOTSHOT", "PARTIAL", "STANDARD", "TIME_CRITICAL", "VOLUME"]); export const customer = z.object({customerId: z.string().optional(), name: z.string()}); export const loadShipment = z.object({loadShipmentRef: z.string(), loadShipmentInternalRef: z.string().optional(), shipmentRef: z.string().optional(), status: z.enum(["DRAFT", "CUSTOMER_CONFIRMED", "COVERED", "DISPATCHED", "AT_PICKUP", "IN_TRANSIT", "AT_DELIVERY", "DELIVERED", "POD_COLLECTED", "PAID", "CANCELED", "ERROR", "ARCHIVED"]).optional(), referenceNumbers: z.array(z.object({name: loadReferenceNumberName, value: z.string()})).optional(), accessorials: z.array(accessorialsEnum).optional(), notes: z.array(z.object({timestamp: z.string(), text: z.string(), author: z.string()})).optional(), route: z.object({loadSequence: z.number().int(), sequence: z.number().int(), externalId: z.string().optional(), facilityCode: z.string().nullable().optional(), stopActivity: z.enum(["PICKUP", "DELIVERY"]), address: z.object({company: z.string().optional(), locationName: z.string().optional(), street1: z.string(), street2: z.string().optional(), city: z.string(), stateOrProvince: z.string(), postalCode: z.string(), country: z.string()}), notes: z.string().optional(), expectedArrivalWindowStart: z.string().optional(), expectedArrivalWindowEnd: z.string().optional(), actualArrivalTime: z.string().optional(), actualCompletionTime: z.string().optional(), expectedDropWindowStart: z.string().optional(), expectedDropWindowEnd: z.string().optional(), mustArriveByDate: z.string().optional(), isLocalTime: z.boolean().optional(), schedulingType: z.enum(["APPT", "FCFS"]).optional(), handlingType: z.enum(["DT", "L"]).optional(), customData: stopCustomData.optional()}).optional(), items: z.array(loadItem).optional(), minTemperatureF: z.number().optional(), maxTemperatureF: z.number().optional(), service: loadService.optional(), customer: customer.optional()}); export const loadV2Response = z.object({brokerageLoadId: z.string(), brokerageLoadInternalId: z.string().nullable().optional(), status: loadStatus, mode: z.enum(["DRAYAGE", "EXPEDITE", "FTL", "LTL", "PARTIAL", "null"]).nullable().optional(), loadType: z.enum(["CONTRACT", "DEDICATED", "PROJECT", "SPOT", "null"]).nullable().optional(), route: z.array(routeStop), totalMiles: z.number().nullable().optional(), equipment: z.string().nullable().optional(), equipmentDescription: z.string().nullable().optional(), accessorials: z.array(z.string()), weight: z.object({value: z.number().optional(), unit: z.enum(["LB", "KG"]).optional()}).nullable().optional(), dimensions: z.object({lengthInches: z.number().int().optional(), widthInches: z.number().int().optional(), heightInches: z.number().int().optional()}).nullable().optional(), minimumTemperature: z.object({value: z.number().optional(), unit: z.enum(["F", "C"]).optional()}).nullable().optional(), maximumTemperature: z.object({value: z.number().optional(), unit: z.enum(["F", "C"]).optional()}).nullable().optional(), tarpSize: z.string().nullable().optional(), minimumBulkHeadTemperature: z.object({value: z.number().optional(), unit: z.string().optional()}).nullable().optional(), maximumBulkHeadTemperature: z.object({value: z.number().optional(), unit: z.string().optional()}).nullable().optional(), commodity: z.string().nullable().optional(), commodityItems: z.array(commodityItem).nullable().optional(), service: z.enum(["HOTSHOT", "PARTIAL", "STANDARD", "TIME_CRITICAL", "VOLUME", "null"]).nullable().optional(), highValueAmount: z.number().nullable().optional(), targetRate: z.number().nullable().optional(), maxRate: z.number().nullable().optional(), totalRate: z.number().nullable().optional(), totalCarrierRate: z.number().nullable().optional(), bidExpiration: z.string().nullable().optional(), bidCustomValues: z.array(z.object({name: z.string().optional(), value: z.string().optional()})).optional(), isPostedToDAT: z.boolean(), isPostedToHighway: z.boolean().nullable().optional(), customerName: z.string().nullable().optional(), customerId: z.string().nullable().optional(), referenceNumbers: z.array(z.object({name: loadReferenceNumberName, value: z.string()})), trackingEvents: z.array(trackingEvent), externalTrackingStatus: z.object({source: z.enum(["MACROPOINT", "P44", "OTHER"]), message: z.string(), code: externalTrackingStatusCode, updatedAt: z.string()}).nullable().optional(), notes: z.array(z.object({timestamp: z.string().optional(), text: z.string().optional(), author: z.string().optional()})), customers: z.array(loadCustomer), loadShipments: z.array(loadShipment), podCollectionStatus: z.enum(["NOT_STARTED", "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"]), lastLocationUpdate: z.string().nullable().optional(), groupExternalId: z.string().nullable().optional(), createdAt: z.string(), updatedAt: z.string()}); 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 }; /** * Get load by load number * * GET /v2/loads */ export const getApiV2Loads = async (args: GetApiV2LoadsArgs, options?: GetApiV2LoadsOptions) => { const {baseUrl = "https://api.prod.goaugment.com", fetch: fetchFn = fetch, httpBasic} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.loadNumber != null) query.append("loadNumber", String(args.loadNumber)) if (httpBasic !== undefined) headers.set('authorization', `Basic ${btoa(`${httpBasic.username}:${httpBasic.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/loads${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(loadV2Response, await res.json()) };