UNPKG

ws-dottie

Version:

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

246 lines 11.6 kB
/** * @fileoverview WSF Terminals API Output Schemas * * This module provides Zod schemas for validating output data from the WSF * Terminals API endpoints. */ import { z } from "../../../../shared/zod"; import { type Bulletin } from "../../terminalBulletins/shared/terminalBulletins.output"; import { type DispGISZoomLoc } from "../../terminalLocations/shared/terminalLocations.output"; import { type DepartingSpace, type SpaceForArrivalTerminal } from "../../terminalSailingSpace/shared/terminalSailingSpace.output"; import { type TransitLink } from "../../terminalTransports/shared/terminalTransports.output"; import { type WaitTime } from "../../terminalWaitTimes/shared/terminalWaitTimes.output"; export type { Bulletin, DispGISZoomLoc, SpaceForArrivalTerminal, DepartingSpace, TransitLink, WaitTime, }; /** * TerminalVerbose schema * * This operation retrieves highly detailed information pertaining to terminals. It should be used if you need to reduce the "chattiness" of your application and don't mind receiving a larger payload of data. TerminalID, or unique terminal identifier, may be optionally passed to retrieve a specific terminal. */ export declare const terminalVerboseSchema: z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodObject<{ TerminalID: z.ZodNumber; TerminalSubjectID: z.ZodNumber; RegionID: z.ZodNumber; TerminalName: z.ZodNullable<z.ZodString>; TerminalAbbrev: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNumber; OverheadPassengerLoading: z.ZodBoolean; Elevator: z.ZodBoolean; WaitingRoom: z.ZodBoolean; FoodService: z.ZodBoolean; Restroom: z.ZodBoolean; }, z.core.$strip>, z.ZodObject<{ Bulletins: z.ZodArray<z.ZodObject<{ BulletinTitle: z.ZodNullable<z.ZodString>; BulletinText: z.ZodNullable<z.ZodString>; BulletinSortSeq: z.ZodNumber; BulletinLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>; BulletinLastUpdatedSortable: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>>, z.ZodObject<{ Latitude: z.ZodNullable<z.ZodNumber>; Longitude: z.ZodNullable<z.ZodNumber>; AddressLineOne: z.ZodNullable<z.ZodString>; AddressLineTwo: z.ZodNullable<z.ZodString>; City: z.ZodNullable<z.ZodString>; State: z.ZodNullable<z.ZodString>; ZipCode: z.ZodNullable<z.ZodString>; Country: z.ZodNullable<z.ZodString>; MapLink: z.ZodNullable<z.ZodString>; Directions: z.ZodNullable<z.ZodString>; DispGISZoomLoc: z.ZodNullable<z.ZodArray<z.ZodObject<{ ZoomLevel: z.ZodNumber; Latitude: z.ZodNullable<z.ZodNumber>; Longitude: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>>; }, z.core.$strip>>, z.ZodObject<{ DepartingSpaces: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{ Departure: z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>; IsCancelled: z.ZodBoolean; VesselID: z.ZodNumber; VesselName: z.ZodNullable<z.ZodString>; MaxSpaceCount: z.ZodNumber; SpaceForArrivalTerminals: z.ZodNullable<z.ZodArray<z.ZodObject<{ TerminalID: z.ZodNumber; TerminalName: z.ZodNullable<z.ZodString>; VesselID: z.ZodNumber; VesselName: z.ZodNullable<z.ZodString>; DisplayReservableSpace: z.ZodBoolean; ReservableSpaceCount: z.ZodNullable<z.ZodNumber>; ReservableSpaceHexColor: z.ZodNullable<z.ZodString>; DisplayDriveUpSpace: z.ZodBoolean; DriveUpSpaceCount: z.ZodNullable<z.ZodNumber>; DriveUpSpaceHexColor: z.ZodNullable<z.ZodString>; MaxSpaceCount: z.ZodNumber; ArrivalTerminalIDs: z.ZodNullable<z.ZodArray<z.ZodNumber>>; }, z.core.$strip>>>; }, z.core.$strip>>>>; IsNoFareCollected: z.ZodNullable<z.ZodBoolean>; NoFareCollectedMsg: z.ZodNullable<z.ZodString>; }, z.core.$strip>>, z.ZodObject<{ ParkingInfo: z.ZodNullable<z.ZodString>; ParkingShuttleInfo: z.ZodNullable<z.ZodString>; AirportInfo: z.ZodNullable<z.ZodString>; AirportShuttleInfo: z.ZodNullable<z.ZodString>; MotorcycleInfo: z.ZodNullable<z.ZodString>; TruckInfo: z.ZodNullable<z.ZodString>; BikeInfo: z.ZodNullable<z.ZodString>; TrainInfo: z.ZodNullable<z.ZodString>; TaxiInfo: z.ZodNullable<z.ZodString>; HovInfo: z.ZodNullable<z.ZodString>; TransitLinks: z.ZodNullable<z.ZodArray<z.ZodObject<{ LinkURL: z.ZodNullable<z.ZodString>; LinkName: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>>; }, z.core.$strip>>, z.ZodObject<{ WaitTimes: z.ZodNullable<z.ZodArray<z.ZodObject<{ RouteID: z.ZodNullable<z.ZodNumber>; RouteName: z.ZodNullable<z.ZodString>; WaitTimeNotes: z.ZodNullable<z.ZodString>; WaitTimeLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>; WaitTimeIVRNotes: z.ZodNullable<z.ZodString>; }, z.core.$strip>>>; }, z.core.$strip>>, z.ZodObject<{ RealtimeIntroMsg: z.ZodNullable<z.ZodString>; AdditionalInfo: z.ZodNullable<z.ZodString>; LostAndFoundInfo: z.ZodNullable<z.ZodString>; SecurityInfo: z.ZodNullable<z.ZodString>; ConstructionInfo: z.ZodNullable<z.ZodString>; FoodServiceInfo: z.ZodNullable<z.ZodString>; AdaInfo: z.ZodNullable<z.ZodString>; FareDiscountInfo: z.ZodNullable<z.ZodString>; TallySystemInfo: z.ZodNullable<z.ZodString>; ChamberOfCommerce: z.ZodNullable<z.ZodObject<{ LinkURL: z.ZodNullable<z.ZodString>; LinkName: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNullable<z.ZodInt>; }, z.core.$strip>>; FacInfo: z.ZodNullable<z.ZodString>; ResourceStatus: z.ZodNullable<z.ZodString>; TypeDesc: z.ZodNullable<z.ZodString>; REALTIME_SHUTOFF_FLAG: z.ZodBoolean; REALTIME_SHUTOFF_MESSAGE: z.ZodNullable<z.ZodString>; VisitorLinks: z.ZodNullable<z.ZodArray<z.ZodObject<{ LinkURL: z.ZodNullable<z.ZodString>; LinkName: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>>; }, z.core.$strip>>; export type TerminalVerbose = z.infer<typeof terminalVerboseSchema>; /** * GetAllTerminalVerboseDetails schema * * Returns all terminal verbose details. */ export declare const getAllTerminalVerboseSchema: z.ZodArray<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodObject<{ TerminalID: z.ZodNumber; TerminalSubjectID: z.ZodNumber; RegionID: z.ZodNumber; TerminalName: z.ZodNullable<z.ZodString>; TerminalAbbrev: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNumber; OverheadPassengerLoading: z.ZodBoolean; Elevator: z.ZodBoolean; WaitingRoom: z.ZodBoolean; FoodService: z.ZodBoolean; Restroom: z.ZodBoolean; }, z.core.$strip>, z.ZodObject<{ Bulletins: z.ZodArray<z.ZodObject<{ BulletinTitle: z.ZodNullable<z.ZodString>; BulletinText: z.ZodNullable<z.ZodString>; BulletinSortSeq: z.ZodNumber; BulletinLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>; BulletinLastUpdatedSortable: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>>, z.ZodObject<{ Latitude: z.ZodNullable<z.ZodNumber>; Longitude: z.ZodNullable<z.ZodNumber>; AddressLineOne: z.ZodNullable<z.ZodString>; AddressLineTwo: z.ZodNullable<z.ZodString>; City: z.ZodNullable<z.ZodString>; State: z.ZodNullable<z.ZodString>; ZipCode: z.ZodNullable<z.ZodString>; Country: z.ZodNullable<z.ZodString>; MapLink: z.ZodNullable<z.ZodString>; Directions: z.ZodNullable<z.ZodString>; DispGISZoomLoc: z.ZodNullable<z.ZodArray<z.ZodObject<{ ZoomLevel: z.ZodNumber; Latitude: z.ZodNullable<z.ZodNumber>; Longitude: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>>; }, z.core.$strip>>, z.ZodObject<{ DepartingSpaces: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{ Departure: z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>; IsCancelled: z.ZodBoolean; VesselID: z.ZodNumber; VesselName: z.ZodNullable<z.ZodString>; MaxSpaceCount: z.ZodNumber; SpaceForArrivalTerminals: z.ZodNullable<z.ZodArray<z.ZodObject<{ TerminalID: z.ZodNumber; TerminalName: z.ZodNullable<z.ZodString>; VesselID: z.ZodNumber; VesselName: z.ZodNullable<z.ZodString>; DisplayReservableSpace: z.ZodBoolean; ReservableSpaceCount: z.ZodNullable<z.ZodNumber>; ReservableSpaceHexColor: z.ZodNullable<z.ZodString>; DisplayDriveUpSpace: z.ZodBoolean; DriveUpSpaceCount: z.ZodNullable<z.ZodNumber>; DriveUpSpaceHexColor: z.ZodNullable<z.ZodString>; MaxSpaceCount: z.ZodNumber; ArrivalTerminalIDs: z.ZodNullable<z.ZodArray<z.ZodNumber>>; }, z.core.$strip>>>; }, z.core.$strip>>>>; IsNoFareCollected: z.ZodNullable<z.ZodBoolean>; NoFareCollectedMsg: z.ZodNullable<z.ZodString>; }, z.core.$strip>>, z.ZodObject<{ ParkingInfo: z.ZodNullable<z.ZodString>; ParkingShuttleInfo: z.ZodNullable<z.ZodString>; AirportInfo: z.ZodNullable<z.ZodString>; AirportShuttleInfo: z.ZodNullable<z.ZodString>; MotorcycleInfo: z.ZodNullable<z.ZodString>; TruckInfo: z.ZodNullable<z.ZodString>; BikeInfo: z.ZodNullable<z.ZodString>; TrainInfo: z.ZodNullable<z.ZodString>; TaxiInfo: z.ZodNullable<z.ZodString>; HovInfo: z.ZodNullable<z.ZodString>; TransitLinks: z.ZodNullable<z.ZodArray<z.ZodObject<{ LinkURL: z.ZodNullable<z.ZodString>; LinkName: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>>; }, z.core.$strip>>, z.ZodObject<{ WaitTimes: z.ZodNullable<z.ZodArray<z.ZodObject<{ RouteID: z.ZodNullable<z.ZodNumber>; RouteName: z.ZodNullable<z.ZodString>; WaitTimeNotes: z.ZodNullable<z.ZodString>; WaitTimeLastUpdated: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<Date, string>>>; WaitTimeIVRNotes: z.ZodNullable<z.ZodString>; }, z.core.$strip>>>; }, z.core.$strip>>, z.ZodObject<{ RealtimeIntroMsg: z.ZodNullable<z.ZodString>; AdditionalInfo: z.ZodNullable<z.ZodString>; LostAndFoundInfo: z.ZodNullable<z.ZodString>; SecurityInfo: z.ZodNullable<z.ZodString>; ConstructionInfo: z.ZodNullable<z.ZodString>; FoodServiceInfo: z.ZodNullable<z.ZodString>; AdaInfo: z.ZodNullable<z.ZodString>; FareDiscountInfo: z.ZodNullable<z.ZodString>; TallySystemInfo: z.ZodNullable<z.ZodString>; ChamberOfCommerce: z.ZodNullable<z.ZodObject<{ LinkURL: z.ZodNullable<z.ZodString>; LinkName: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNullable<z.ZodInt>; }, z.core.$strip>>; FacInfo: z.ZodNullable<z.ZodString>; ResourceStatus: z.ZodNullable<z.ZodString>; TypeDesc: z.ZodNullable<z.ZodString>; REALTIME_SHUTOFF_FLAG: z.ZodBoolean; REALTIME_SHUTOFF_MESSAGE: z.ZodNullable<z.ZodString>; VisitorLinks: z.ZodNullable<z.ZodArray<z.ZodObject<{ LinkURL: z.ZodNullable<z.ZodString>; LinkName: z.ZodNullable<z.ZodString>; SortSeq: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>>; }, z.core.$strip>>>; export type GetAllTerminalVerbose = z.infer<typeof getAllTerminalVerboseSchema>; //# sourceMappingURL=terminalVerbose.output.d.ts.map