import {z} from 'zod' export type GetApiOrdersPlansPlanIdArgs = {plan_id: string}; export type GetApiOrdersPlansPlanIdOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const locationGeometryResponse = z.object({type: z.string(), coordinates: z.array(z.unknown())}); export const driverLocation = z.object({geometry: locationGeometryResponse, bearing: z.number(), accuracy: z.number(), speed: z.number(), recorded_at: z.string()}); export const orderListEstimate = z.object({start_at: z.string().nullable().optional(), start_by: z.string().nullable().optional(), arrive_at: z.string().nullable().optional(), distance: z.number().int().nullable().optional(), duration: z.number().int().nullable().optional(), initial_arrive_at: z.string().nullable().optional(), current_worker_location: z.union([driverLocation, z.unknown()]).optional()}); export const routeListOrder = z.object({order_handle: z.string(), status: z.enum(["completed", "cancelled", "disabled", "ongoing", "unplanned", "assigned", "planned", "dispatched", "summarizing"]), planning_failure_reason: z.string().nullable().optional(), type: z.string().nullable().optional(), type_index: z.number().int().nullable().optional(), started_at: z.string().nullable().optional(), completed_at: z.string().nullable().optional(), cancelled_at: z.string().nullable().optional(), expected_service_time: z.number().int().nullable().optional(), estimate: z.union([orderListEstimate, z.unknown()]).optional(), actual_service_time: z.number().int().nullable().optional(), tracked_service_time: z.number().int().nullable().optional(), distance: z.number().int().nullable().optional(), duration: z.number().int().nullable().optional()}); export const source = z.object({source: z.string().nullable().optional(), timestamp: z.string().nullable().optional(), "ip-address": z.string().nullable().optional(), device_id: z.string().nullable().optional(), driver_handle: z.string().nullable().optional(), user_id: z.string().nullable().optional(), email: z.string().nullable().optional()}); export const region = z.object({country: z.string(), city: z.string().nullable().optional(), state: z.string().nullable().optional()}); export const routeListEstimate = z.object({start_by: z.string().nullable().optional(), distance: z.number().int(), duration: z.number().int()}); export const planRoute = z.object({route_handle: z.string(), status: z.enum(["planned", "assigned", "tracking", "completed", "summarizing"]), version: z.number().int(), created_at: z.string(), embed_url: z.string(), orders: z.array(routeListOrder), created_by: z.union([source, z.unknown()]).optional(), ops_group_handle: z.string().optional(), track_mode: z.enum(["full_shift", "on_shift", "pre_shift", "null"]).nullable().optional(), plan_mode: z.enum(["on_demand", "scheduled", "manual"]), started_at: z.string().nullable().optional(), assigned_at: z.string().nullable().optional(), planned_at: z.string(), completed_at: z.string().nullable().optional(), device_id: z.string().nullable().optional(), driver_handle: z.string().nullable().optional(), worker_handle: z.string().nullable().optional(), metadata: z.record(z.string(), z.unknown()).nullable().optional(), region: z.union([region, z.unknown()]).optional(), distance: z.number().int().nullable().optional(), duration: z.number().int().nullable().optional(), estimate: z.union([routeListEstimate, z.unknown()]).optional(), plan_id: z.string(), device_switch_mode: z.unknown(), candidate_devices: z.array(z.string()).nullable().optional(), completion_source: z.string().nullable().optional(), scheduled_start_at: z.string().nullable().optional()}); export const orderObjectMini = z.object({order_handle: z.string(), status: z.enum(["completed", "cancelled", "disabled", "ongoing", "unplanned", "assigned", "planned", "dispatched", "summarizing"]), type: z.string().nullable().optional(), type_index: z.number().int().nullable().optional(), plan_mode: z.string().nullable().optional(), planning_failure_reason: z.string().nullable().optional()}); export const planSummaryOrders = z.object({total: z.number().int(), planned: z.number().int(), unplanned: z.number().int(), assigned: z.number().int(), completed: z.number().int(), cancelled: z.number().int()}); export const planSummaryEstimate = z.object({distance: z.number().int(), duration: z.number().int()}); export const planSummary = z.object({orders: planSummaryOrders, estimate: planSummaryEstimate, distance: z.number().int(), duration: z.number().int(), routes: z.number().int(), drivers: z.number().int()}); export const getPlanResponse = z.object({plan_id: z.string(), sequence_number: z.number().int(), routes: z.array(planRoute).optional(), unplanned_orders: z.array(orderObjectMini).optional(), status: z.enum(["failed", "completed", "planning"]), started_at: z.string(), created_at: z.string(), ops_group_handle: z.string(), fulfillment_date: z.string(), failure_reason: z.string().optional(), summary: planSummary}); 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 Plan * * GET /orders/plans/{plan_id} * * Also accepts auth: TokenAuth */ export const getApiOrdersPlansPlanId = async (args: GetApiOrdersPlansPlanIdArgs, options?: GetApiOrdersPlansPlanIdOptions) => { const {baseUrl = "https://v3.api.hypertrack.com", fetch: fetchFn = fetch, BasicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/orders/plans/${encodeURIComponent(String(args.plan_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(getPlanResponse, await res.json()) };