# frozen_string_literal: true
module OnebusawaySDK
module Models
# @see OnebusawaySDK::Resources::ArrivalAndDeparture#retrieve
class ArrivalAndDepartureRetrieveResponse < OnebusawaySDK::Models::ResponseWrapper
# @!attribute data
#
# @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data]
required :data, -> { OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data }
# @!method initialize(data:)
# @param data [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data]
class Data < OnebusawaySDK::Internal::Type::BaseModel
# @!attribute entry
#
# @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry]
required :entry, -> { OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry }
# @!attribute references
#
# @return [OnebusawaySDK::Models::References]
required :references, -> { OnebusawaySDK::References }
# @!method initialize(entry:, references:)
# @param entry [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry]
# @param references [OnebusawaySDK::Models::References]
# @see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data#entry
class Entry < OnebusawaySDK::Internal::Type::BaseModel
# @!attribute arrival_enabled
# Indicates if riders can arrive on this transit vehicle.
#
# @return [Boolean]
required :arrival_enabled, OnebusawaySDK::Internal::Type::Boolean, api_name: :arrivalEnabled
# @!attribute block_trip_sequence
# Index of this arrival’s trip into the sequence of trips for the active block.
#
# @return [Integer]
required :block_trip_sequence, Integer, api_name: :blockTripSequence
# @!attribute departure_enabled
# Indicates if riders can depart from this transit vehicle.
#
# @return [Boolean]
required :departure_enabled, OnebusawaySDK::Internal::Type::Boolean, api_name: :departureEnabled
# @!attribute number_of_stops_away
# Number of stops between the arriving transit vehicle and the current stop
# (excluding the current stop).
#
# @return [Integer]
required :number_of_stops_away, Integer, api_name: :numberOfStopsAway
# @!attribute predicted_arrival_time
# Predicted arrival time, in milliseconds since Unix epoch (zero if no real-time
# available).
#
# @return [Integer]
required :predicted_arrival_time, Integer, api_name: :predictedArrivalTime
# @!attribute predicted_departure_time
# Predicted departure time, in milliseconds since Unix epoch (zero if no real-time
# available).
#
# @return [Integer]
required :predicted_departure_time, Integer, api_name: :predictedDepartureTime
# @!attribute route_id
# The ID of the route for the arriving vehicle.
#
# @return [String]
required :route_id, String, api_name: :routeId
# @!attribute scheduled_arrival_time
# Scheduled arrival time, in milliseconds since Unix epoch.
#
# @return [Integer]
required :scheduled_arrival_time, Integer, api_name: :scheduledArrivalTime
# @!attribute scheduled_departure_time
# Scheduled departure time, in milliseconds since Unix epoch.
#
# @return [Integer]
required :scheduled_departure_time, Integer, api_name: :scheduledDepartureTime
# @!attribute service_date
# Time, in milliseconds since the Unix epoch, of midnight for the start of the
# service date for the trip.
#
# @return [Integer]
required :service_date, Integer, api_name: :serviceDate
# @!attribute stop_id
# The ID of the stop the vehicle is arriving at.
#
# @return [String]
required :stop_id, String, api_name: :stopId
# @!attribute stop_sequence
# Index of the stop into the sequence of stops that make up the trip for this
# arrival.
#
# @return [Integer]
required :stop_sequence, Integer, api_name: :stopSequence
# @!attribute total_stops_in_trip
# Total number of stops visited on the trip for this arrival.
#
# @return [Integer]
required :total_stops_in_trip, Integer, api_name: :totalStopsInTrip
# @!attribute trip_headsign
# Optional trip headsign that potentially overrides the trip headsign in the
# referenced trip element.
#
# @return [String]
required :trip_headsign, String, api_name: :tripHeadsign
# @!attribute trip_id
# The ID of the trip for the arriving vehicle.
#
# @return [String]
required :trip_id, String, api_name: :tripId
# @!attribute vehicle_id
# ID of the transit vehicle serving this trip.
#
# @return [String]
required :vehicle_id, String, api_name: :vehicleId
# @!attribute actual_track
# The actual track information of the arriving transit vehicle.
#
# @return [String, nil]
optional :actual_track, String, api_name: :actualTrack
# @!attribute distance_from_stop
# Distance of the arriving transit vehicle from the stop, in meters.
#
# @return [Float, nil]
optional :distance_from_stop, Float, api_name: :distanceFromStop
# @!attribute frequency
# Information about frequency-based scheduling, if applicable to the trip.
#
# @return [String, nil]
optional :frequency, String
# @!attribute historical_occupancy
# Historical occupancy information of the transit vehicle.
#
# @return [String, nil]
optional :historical_occupancy, String, api_name: :historicalOccupancy
# @!attribute last_update_time
# Timestamp of the last update time for this arrival.
#
# @return [Integer, nil]
optional :last_update_time, Integer, api_name: :lastUpdateTime
# @!attribute occupancy_status
# Current occupancy status of the transit vehicle.
#
# @return [String, nil]
optional :occupancy_status, String, api_name: :occupancyStatus
# @!attribute predicted
# Indicates if real-time arrival info is available for this trip.
#
# @return [Boolean, nil]
optional :predicted, OnebusawaySDK::Internal::Type::Boolean
# @!attribute predicted_arrival_interval
# Interval for predicted arrival time, if available.
#
# @return [String, nil]
optional :predicted_arrival_interval, String, api_name: :predictedArrivalInterval
# @!attribute predicted_departure_interval
# Interval for predicted departure time, if available.
#
# @return [String, nil]
optional :predicted_departure_interval, String, api_name: :predictedDepartureInterval
# @!attribute predicted_occupancy
# Predicted occupancy status of the transit vehicle.
#
# @return [String, nil]
optional :predicted_occupancy, String, api_name: :predictedOccupancy
# @!attribute route_long_name
# Optional route long name that potentially overrides the route long name in the
# referenced route element.
#
# @return [String, nil]
optional :route_long_name, String, api_name: :routeLongName
# @!attribute route_short_name
# Optional route short name that potentially overrides the route short name in the
# referenced route element.
#
# @return [String, nil]
optional :route_short_name, String, api_name: :routeShortName
# @!attribute scheduled_arrival_interval
# Interval for scheduled arrival time.
#
# @return [String, nil]
optional :scheduled_arrival_interval, String, api_name: :scheduledArrivalInterval
# @!attribute scheduled_departure_interval
# Interval for scheduled departure time.
#
# @return [String, nil]
optional :scheduled_departure_interval, String, api_name: :scheduledDepartureInterval
# @!attribute scheduled_track
# Scheduled track information of the arriving transit vehicle.
#
# @return [String, nil]
optional :scheduled_track, String, api_name: :scheduledTrack
# @!attribute situation_ids
# References to situation elements (if any) applicable to this arrival.
#
# @return [Array<String>, nil]
optional :situation_ids, OnebusawaySDK::Internal::Type::ArrayOf[String], api_name: :situationIds
# @!attribute status
# Current status of the arrival.
#
# @return [String, nil]
optional :status, String
# @!attribute trip_status
# Trip-specific status for the arriving transit vehicle.
#
# @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus, nil]
optional :trip_status,
-> { OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus },
api_name: :tripStatus
# @!method initialize(arrival_enabled:, block_trip_sequence:, departure_enabled:, number_of_stops_away:, predicted_arrival_time:, predicted_departure_time:, route_id:, scheduled_arrival_time:, scheduled_departure_time:, service_date:, stop_id:, stop_sequence:, total_stops_in_trip:, trip_headsign:, trip_id:, vehicle_id:, actual_track: nil, distance_from_stop: nil, frequency: nil, historical_occupancy: nil, last_update_time: nil, occupancy_status: nil, predicted: nil, predicted_arrival_interval: nil, predicted_departure_interval: nil, predicted_occupancy: nil, route_long_name: nil, route_short_name: nil, scheduled_arrival_interval: nil, scheduled_departure_interval: nil, scheduled_track: nil, situation_ids: nil, status: nil, trip_status: nil)
# Some parameter documentations has been truncated, see
# {OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry} for
# more details.
#
# @param arrival_enabled [Boolean] Indicates if riders can arrive on this transit vehicle.
#
# @param block_trip_sequence [Integer] Index of this arrival’s trip into the sequence of trips for the active block.
#
# @param departure_enabled [Boolean] Indicates if riders can depart from this transit vehicle.
#
# @param number_of_stops_away [Integer] Number of stops between the arriving transit vehicle and the current stop (exclu
#
# @param predicted_arrival_time [Integer] Predicted arrival time, in milliseconds since Unix epoch (zero if no real-time a
#
# @param predicted_departure_time [Integer] Predicted departure time, in milliseconds since Unix epoch (zero if no real-time
#
# @param route_id [String] The ID of the route for the arriving vehicle.
#
# @param scheduled_arrival_time [Integer] Scheduled arrival time, in milliseconds since Unix epoch.
#
# @param scheduled_departure_time [Integer] Scheduled departure time, in milliseconds since Unix epoch.
#
# @param service_date [Integer] Time, in milliseconds since the Unix epoch, of midnight for the start of the ser
#
# @param stop_id [String] The ID of the stop the vehicle is arriving at.
#
# @param stop_sequence [Integer] Index of the stop into the sequence of stops that make up the trip for this arri
#
# @param total_stops_in_trip [Integer] Total number of stops visited on the trip for this arrival.
#
# @param trip_headsign [String] Optional trip headsign that potentially overrides the trip headsign in the refer
#
# @param trip_id [String] The ID of the trip for the arriving vehicle.
#
# @param vehicle_id [String] ID of the transit vehicle serving this trip.
#
# @param actual_track [String] The actual track information of the arriving transit vehicle.
#
# @param distance_from_stop [Float] Distance of the arriving transit vehicle from the stop, in meters.
#
# @param frequency [String] Information about frequency-based scheduling, if applicable to the trip.
#
# @param historical_occupancy [String] Historical occupancy information of the transit vehicle.
#
# @param last_update_time [Integer] Timestamp of the last update time for this arrival.
#
# @param occupancy_status [String] Current occupancy status of the transit vehicle.
#
# @param predicted [Boolean] Indicates if real-time arrival info is available for this trip.
#
# @param predicted_arrival_interval [String] Interval for predicted arrival time, if available.
#
# @param predicted_departure_interval [String] Interval for predicted departure time, if available.
#
# @param predicted_occupancy [String] Predicted occupancy status of the transit vehicle.
#
# @param route_long_name [String] Optional route long name that potentially overrides the route long name in the r
#
# @param route_short_name [String] Optional route short name that potentially overrides the route short name in the
#
# @param scheduled_arrival_interval [String] Interval for scheduled arrival time.
#
# @param scheduled_departure_interval [String] Interval for scheduled departure time.
#
# @param scheduled_track [String] Scheduled track information of the arriving transit vehicle.
#
# @param situation_ids [Array<String>] References to situation elements (if any) applicable to this arrival.
#
# @param status [String] Current status of the arrival.
#
# @param trip_status [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus] Trip-specific status for the arriving transit vehicle.
# @see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry#trip_status
class TripStatus < OnebusawaySDK::Internal::Type::BaseModel
# @!attribute active_trip_id
# Trip ID of the trip the vehicle is actively serving.
#
# @return [String]
required :active_trip_id, String, api_name: :activeTripId
# @!attribute block_trip_sequence
# Index of the active trip into the sequence of trips for the active block.
#
# @return [Integer]
required :block_trip_sequence, Integer, api_name: :blockTripSequence
# @!attribute closest_stop
# ID of the closest stop to the current location of the transit vehicle.
#
# @return [String]
required :closest_stop, String, api_name: :closestStop
# @!attribute distance_along_trip
# Distance, in meters, the transit vehicle has progressed along the active trip.
#
# @return [Float]
required :distance_along_trip, Float, api_name: :distanceAlongTrip
# @!attribute last_known_distance_along_trip
# Last known distance along the trip received in real-time from the transit
# vehicle.
#
# @return [Float]
required :last_known_distance_along_trip, Float, api_name: :lastKnownDistanceAlongTrip
# @!attribute last_location_update_time
# Timestamp of the last known real-time location update from the transit vehicle.
#
# @return [Integer]
required :last_location_update_time, Integer, api_name: :lastLocationUpdateTime
# @!attribute last_update_time
# Timestamp of the last known real-time update from the transit vehicle.
#
# @return [Integer]
required :last_update_time, Integer, api_name: :lastUpdateTime
# @!attribute occupancy_capacity
# Capacity of the transit vehicle in terms of occupancy.
#
# @return [Integer]
required :occupancy_capacity, Integer, api_name: :occupancyCapacity
# @!attribute occupancy_count
# Current count of occupants in the transit vehicle.
#
# @return [Integer]
required :occupancy_count, Integer, api_name: :occupancyCount
# @!attribute occupancy_status
# Current occupancy status of the transit vehicle.
#
# @return [String]
required :occupancy_status, String, api_name: :occupancyStatus
# @!attribute phase
# Current journey phase of the trip.
#
# @return [String]
required :phase, String
# @!attribute predicted
# Indicates if real-time arrival info is available for this trip.
#
# @return [Boolean]
required :predicted, OnebusawaySDK::Internal::Type::Boolean
# @!attribute schedule_deviation
# Deviation from the schedule in seconds (positive for late, negative for early).
#
# @return [Integer]
required :schedule_deviation, Integer, api_name: :scheduleDeviation
# @!attribute service_date
# Time, in milliseconds since the Unix epoch, of midnight for the start of the
# service date for the trip.
#
# @return [Integer]
required :service_date, Integer, api_name: :serviceDate
# @!attribute status
# Current status modifiers for the trip.
#
# @return [String]
required :status, String
# @!attribute total_distance_along_trip
# Total length of the trip, in meters.
#
# @return [Float]
required :total_distance_along_trip, Float, api_name: :totalDistanceAlongTrip
# @!attribute closest_stop_time_offset
# Time offset from the closest stop to the current position of the transit vehicle
# (in seconds).
#
# @return [Integer, nil]
optional :closest_stop_time_offset, Integer, api_name: :closestStopTimeOffset
# @!attribute frequency
# Information about frequency-based scheduling, if applicable to the trip.
#
# @return [String, nil]
optional :frequency, String
# @!attribute last_known_location
# Last known location of the transit vehicle.
#
# @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::LastKnownLocation, nil]
optional :last_known_location,
-> { OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::LastKnownLocation },
api_name: :lastKnownLocation
# @!attribute last_known_orientation
# Last known orientation value received in real-time from the transit vehicle.
#
# @return [Float, nil]
optional :last_known_orientation, Float, api_name: :lastKnownOrientation
# @!attribute next_stop
# ID of the next stop the transit vehicle is scheduled to arrive at.
#
# @return [String, nil]
optional :next_stop, String, api_name: :nextStop
# @!attribute next_stop_time_offset
# Time offset from the next stop to the current position of the transit vehicle
# (in seconds).
#
# @return [Integer, nil]
optional :next_stop_time_offset, Integer, api_name: :nextStopTimeOffset
# @!attribute orientation
# Orientation of the transit vehicle, represented as an angle in degrees.
#
# @return [Float, nil]
optional :orientation, Float
# @!attribute position
# Current position of the transit vehicle.
#
# @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::Position, nil]
optional :position,
-> { OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::Position }
# @!attribute scheduled_distance_along_trip
# Distance, in meters, the transit vehicle is scheduled to have progressed along
# the active trip.
#
# @return [Float, nil]
optional :scheduled_distance_along_trip, Float, api_name: :scheduledDistanceAlongTrip
# @!attribute situation_ids
# References to situation elements (if any) applicable to this trip.
#
# @return [Array<String>, nil]
optional :situation_ids, OnebusawaySDK::Internal::Type::ArrayOf[String], api_name: :situationIds
# @!attribute vehicle_id
# ID of the transit vehicle currently serving the trip.
#
# @return [String, nil]
optional :vehicle_id, String, api_name: :vehicleId
# @!method initialize(active_trip_id:, block_trip_sequence:, closest_stop:, distance_along_trip:, last_known_distance_along_trip:, last_location_update_time:, last_update_time:, occupancy_capacity:, occupancy_count:, occupancy_status:, phase:, predicted:, schedule_deviation:, service_date:, status:, total_distance_along_trip:, closest_stop_time_offset: nil, frequency: nil, last_known_location: nil, last_known_orientation: nil, next_stop: nil, next_stop_time_offset: nil, orientation: nil, position: nil, scheduled_distance_along_trip: nil, situation_ids: nil, vehicle_id: nil)
# Some parameter documentations has been truncated, see
# {OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus}
# for more details.
#
# Trip-specific status for the arriving transit vehicle.
#
# @param active_trip_id [String] Trip ID of the trip the vehicle is actively serving.
#
# @param block_trip_sequence [Integer] Index of the active trip into the sequence of trips for the active block.
#
# @param closest_stop [String] ID of the closest stop to the current location of the transit vehicle.
#
# @param distance_along_trip [Float] Distance, in meters, the transit vehicle has progressed along the active trip.
#
# @param last_known_distance_along_trip [Float] Last known distance along the trip received in real-time from the transit vehicl
#
# @param last_location_update_time [Integer] Timestamp of the last known real-time location update from the transit vehicle.
#
# @param last_update_time [Integer] Timestamp of the last known real-time update from the transit vehicle.
#
# @param occupancy_capacity [Integer] Capacity of the transit vehicle in terms of occupancy.
#
# @param occupancy_count [Integer] Current count of occupants in the transit vehicle.
#
# @param occupancy_status [String] Current occupancy status of the transit vehicle.
#
# @param phase [String] Current journey phase of the trip.
#
# @param predicted [Boolean] Indicates if real-time arrival info is available for this trip.
#
# @param schedule_deviation [Integer] Deviation from the schedule in seconds (positive for late, negative for early).
#
# @param service_date [Integer] Time, in milliseconds since the Unix epoch, of midnight for the start of the ser
#
# @param status [String] Current status modifiers for the trip.
#
# @param total_distance_along_trip [Float] Total length of the trip, in meters.
#
# @param closest_stop_time_offset [Integer] Time offset from the closest stop to the current position of the transit vehicle
#
# @param frequency [String] Information about frequency-based scheduling, if applicable to the trip.
#
# @param last_known_location [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::LastKnownLocation] Last known location of the transit vehicle.
#
# @param last_known_orientation [Float] Last known orientation value received in real-time from the transit vehicle.
#
# @param next_stop [String] ID of the next stop the transit vehicle is scheduled to arrive at.
#
# @param next_stop_time_offset [Integer] Time offset from the next stop to the current position of the transit vehicle (i
#
# @param orientation [Float] Orientation of the transit vehicle, represented as an angle in degrees.
#
# @param position [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::Position] Current position of the transit vehicle.
#
# @param scheduled_distance_along_trip [Float] Distance, in meters, the transit vehicle is scheduled to have progressed along t
#
# @param situation_ids [Array<String>] References to situation elements (if any) applicable to this trip.
#
# @param vehicle_id [String] ID of the transit vehicle currently serving the trip.
# @see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus#last_known_location
class LastKnownLocation < OnebusawaySDK::Internal::Type::BaseModel
# @!attribute lat
# Latitude of the last known location of the transit vehicle.
#
# @return [Float, nil]
optional :lat, Float
# @!attribute lon
# Longitude of the last known location of the transit vehicle.
#
# @return [Float, nil]
optional :lon, Float
# @!method initialize(lat: nil, lon: nil)
# Last known location of the transit vehicle.
#
# @param lat [Float] Latitude of the last known location of the transit vehicle.
#
# @param lon [Float] Longitude of the last known location of the transit vehicle.
end
# @see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus#position
class Position < OnebusawaySDK::Internal::Type::BaseModel
# @!attribute lat
# Latitude of the current position of the transit vehicle.
#
# @return [Float, nil]
optional :lat, Float
# @!attribute lon
# Longitude of the current position of the transit vehicle.
#
# @return [Float, nil]
optional :lon, Float
# @!method initialize(lat: nil, lon: nil)
# Current position of the transit vehicle.
#
# @param lat [Float] Latitude of the current position of the transit vehicle.
#
# @param lon [Float] Longitude of the current position of the transit vehicle.
end
end
end
end
end
end
end