UNPKG

ws-dottie

Version:

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

78 lines 4.78 kB
/** * @fileoverview WSF Schedule API Input Schemas for Routes * * This module provides Zod schemas for validating input parameters for the WSF * Schedule API endpoints related to route operations. */ import { z } from "../../../../shared/zod"; /** * Schema for Routes input parameters * * This operation retrieves the most basic / brief information pertaining to routes. If only a trip date is included in the URL string, all routes available for that date of travel are returned. If a trip date, departing terminal and arriving terminal are included then routes in the resultset are filtered to match accordingly. Valid departing and arriving terminals may be found using `/terminalsandmates`. Similarly, a valid trip date may be determined using `/validdaterange`. Please format the trip date input as `'YYYY-MM-DD'` (eg. `'2014-04-01'` for a trip date occurring on April 1, 2014). */ export declare const routesByTripDateInputSchema: z.ZodObject<{ TripDate: z.ZodString; DepartingTerminalID: z.ZodOptional<z.ZodNumber>; ArrivingTerminalID: z.ZodOptional<z.ZodNumber>; }, z.core.$strip>; export type RoutesByTripDateInput = z.infer<typeof routesByTripDateInputSchema>; /** * Schema for RoutesHavingServiceDisruptions input parameters * * This operation retrieves the most basic / brief information for routes currently associated with service disruptions. A valid trip date may be determined using `/validdaterange`. Please format the trip date input as `'YYYY-MM-DD'` (eg. `'2014-04-01'` for a trip date occurring on April 1, 2014). */ export declare const routesHavingServiceDisruptionsByTripDateInputSchema: z.ZodObject<{ TripDate: z.ZodString; }, z.core.$strip>; export type RoutesHavingServiceDisruptionsByTripDateInput = z.infer<typeof routesHavingServiceDisruptionsByTripDateInputSchema>; /** * Schema for RouteDetails input parameters * * This operation retrieves highly detailed information pertaining to routes. If only a trip date is included in the URL string, all routes available for that date of travel are returned. If a trip date, departing terminal and arriving terminal are included then routes in the resultset are filtered to match accordingly. Along the same lines, including only a trip date and route will filter the resultset to a single route. Valid departing and arriving terminals may be found using `/terminalsandmates` while valid routes may be found using `/routes`. Similarly, a valid trip date may be determined using `/validdaterange`. Please format the trip date input as `'YYYY-MM-DD'` (eg. `'2014-04-01'` for a trip date occurring on April 1, 2014). */ export declare const routeDetailsSchema: z.ZodObject<{ TripDate: z.ZodString; DepartingTerminalID: z.ZodOptional<z.ZodNumber>; ArrivingTerminalID: z.ZodOptional<z.ZodNumber>; RouteID: z.ZodOptional<z.ZodNumber>; }, z.core.$strip>; export type RouteDetailsInput = z.infer<typeof routeDetailsSchema>; /** * Schema for RouteDetailsByTripDate input parameters * * This operation retrieves highly detailed information pertaining to routes for a specific trip date. */ export declare const routeDetailsByTripDateInputSchema: z.ZodObject<{ TripDate: z.ZodString; }, z.core.$strip>; export type RouteDetailsByTripDateInput = z.infer<typeof routeDetailsByTripDateInputSchema>; /** * Schema for RouteDetailsByTripDateAndRouteId input parameters * * This operation retrieves highly detailed information pertaining to a specific route for a specific trip date. */ export declare const routeDetailsByTripDateAndRouteIdInputSchema: z.ZodObject<{ TripDate: z.ZodString; RouteID: z.ZodNumber; }, z.core.$strip>; export type RouteDetailsByTripDateAndRouteIdInput = z.infer<typeof routeDetailsByTripDateAndRouteIdInputSchema>; /** * Schema for RouteDetailsByTripDateAndTerminals input parameters * * This operation retrieves highly detailed information pertaining to routes for a specific trip date and terminal combination. */ export declare const routeDetailsByTripDateAndTerminalsInputSchema: z.ZodObject<{ TripDate: z.ZodString; DepartingTerminalID: z.ZodNumber; ArrivingTerminalID: z.ZodNumber; }, z.core.$strip>; export type RouteDetailsByTripDateAndTerminalsInput = z.infer<typeof routeDetailsByTripDateAndTerminalsInputSchema>; /** * Schema for RoutesByTerminals input parameters * * This operation retrieves routes for a specific trip date and terminal combination. */ export declare const routesByTripDateAndTerminalsInputSchema: z.ZodObject<{ TripDate: z.ZodString; DepartingTerminalID: z.ZodNumber; ArrivingTerminalID: z.ZodNumber; }, z.core.$strip>; export type RoutesByTripDateAndTerminalsInput = z.infer<typeof routesByTripDateAndTerminalsInputSchema>; //# sourceMappingURL=routes.input.d.ts.map