onebusaway-sdk 0.1.0.pre.alpha.206 → 0.1.0.pre.alpha.207

data/rbi/lib/onebusaway-sdk/models/arrival_and_departure_list_response.rbi

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data::Entry,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, references:)
+        def self.new(entry:, references:)
         end
 
         sig do
@@ -88,9 +88,9 @@ module OnebusawaySDK
             params(
               arrivals_and_departures: T::Array[OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data::Entry::ArrivalsAndDeparture]
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(arrivals_and_departures:)
+          def self.new(arrivals_and_departures:)
           end
 
           sig do
@@ -105,6 +105,7 @@ module OnebusawaySDK
           end
 
           class ArrivalsAndDeparture < OnebusawaySDK::BaseModel
+            # Indicates if riders can arrive on this transit vehicle.
             sig { returns(T::Boolean) }
             def arrival_enabled
             end
@@ -113,6 +114,7 @@ module OnebusawaySDK
             def arrival_enabled=(_)
             end
 
+            # Index of this arrival’s trip into the sequence of trips for the active block.
             sig { returns(Integer) }
             def block_trip_sequence
             end
@@ -121,6 +123,7 @@ module OnebusawaySDK
             def block_trip_sequence=(_)
             end
 
+            # Indicates if riders can depart from this transit vehicle.
             sig { returns(T::Boolean) }
             def departure_enabled
             end
@@ -129,6 +132,8 @@ module OnebusawaySDK
             def departure_enabled=(_)
             end
 
+            # Number of stops between the arriving transit vehicle and the current stop
+            #   (excluding the current stop).
             sig { returns(Integer) }
             def number_of_stops_away
             end
@@ -137,6 +142,8 @@ module OnebusawaySDK
             def number_of_stops_away=(_)
             end
 
+            # Predicted arrival time, in milliseconds since Unix epoch (zero if no real-time
+            #   available).
             sig { returns(Integer) }
             def predicted_arrival_time
             end
@@ -145,6 +152,8 @@ module OnebusawaySDK
             def predicted_arrival_time=(_)
             end
 
+            # Predicted departure time, in milliseconds since Unix epoch (zero if no real-time
+            #   available).
             sig { returns(Integer) }
             def predicted_departure_time
             end
@@ -153,6 +162,7 @@ module OnebusawaySDK
             def predicted_departure_time=(_)
             end
 
+            # The ID of the route for the arriving vehicle.
             sig { returns(String) }
             def route_id
             end
@@ -161,6 +171,7 @@ module OnebusawaySDK
             def route_id=(_)
             end
 
+            # Scheduled arrival time, in milliseconds since Unix epoch.
             sig { returns(Integer) }
             def scheduled_arrival_time
             end
@@ -169,6 +180,7 @@ module OnebusawaySDK
             def scheduled_arrival_time=(_)
             end
 
+            # Scheduled departure time, in milliseconds since Unix epoch.
             sig { returns(Integer) }
             def scheduled_departure_time
             end
@@ -177,6 +189,8 @@ module OnebusawaySDK
             def scheduled_departure_time=(_)
             end
 
+            # Time, in milliseconds since the Unix epoch, of midnight for the start of the
+            #   service date for the trip.
             sig { returns(Integer) }
             def service_date
             end
@@ -185,6 +199,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # The ID of the stop the vehicle is arriving at.
             sig { returns(String) }
             def stop_id
             end
@@ -193,6 +208,8 @@ module OnebusawaySDK
             def stop_id=(_)
             end
 
+            # Index of the stop into the sequence of stops that make up the trip for this
+            #   arrival.
             sig { returns(Integer) }
             def stop_sequence
             end
@@ -201,6 +218,7 @@ module OnebusawaySDK
             def stop_sequence=(_)
             end
 
+            # Total number of stops visited on the trip for this arrival.
             sig { returns(Integer) }
             def total_stops_in_trip
             end
@@ -209,6 +227,8 @@ module OnebusawaySDK
             def total_stops_in_trip=(_)
             end
 
+            # Optional trip headsign that potentially overrides the trip headsign in the
+            #   referenced trip element.
             sig { returns(String) }
             def trip_headsign
             end
@@ -217,6 +237,7 @@ module OnebusawaySDK
             def trip_headsign=(_)
             end
 
+            # The ID of the trip for the arriving vehicle.
             sig { returns(String) }
             def trip_id
             end
@@ -225,6 +246,7 @@ module OnebusawaySDK
             def trip_id=(_)
             end
 
+            # ID of the transit vehicle serving this trip.
             sig { returns(String) }
             def vehicle_id
             end
@@ -233,6 +255,7 @@ module OnebusawaySDK
             def vehicle_id=(_)
             end
 
+            # The actual track information of the arriving transit vehicle.
             sig { returns(T.nilable(String)) }
             def actual_track
             end
@@ -241,6 +264,7 @@ module OnebusawaySDK
             def actual_track=(_)
             end
 
+            # Distance of the arriving transit vehicle from the stop, in meters.
             sig { returns(T.nilable(Float)) }
             def distance_from_stop
             end
@@ -249,6 +273,7 @@ module OnebusawaySDK
             def distance_from_stop=(_)
             end
 
+            # Information about frequency-based scheduling, if applicable to the trip.
             sig { returns(T.nilable(String)) }
             def frequency
             end
@@ -257,6 +282,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Historical occupancy information of the transit vehicle.
             sig { returns(T.nilable(String)) }
             def historical_occupancy
             end
@@ -265,6 +291,7 @@ module OnebusawaySDK
             def historical_occupancy=(_)
             end
 
+            # Timestamp of the last update time for this arrival.
             sig { returns(T.nilable(Integer)) }
             def last_update_time
             end
@@ -273,6 +300,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(T.nilable(String)) }
             def occupancy_status
             end
@@ -281,6 +309,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T.nilable(T::Boolean)) }
             def predicted
             end
@@ -289,6 +318,7 @@ module OnebusawaySDK
             def predicted=(_)
             end
 
+            # Interval for predicted arrival time, if available.
             sig { returns(T.nilable(String)) }
             def predicted_arrival_interval
             end
@@ -297,6 +327,7 @@ module OnebusawaySDK
             def predicted_arrival_interval=(_)
             end
 
+            # Interval for predicted departure time, if available.
             sig { returns(T.nilable(String)) }
             def predicted_departure_interval
             end
@@ -305,6 +336,7 @@ module OnebusawaySDK
             def predicted_departure_interval=(_)
             end
 
+            # Predicted occupancy status of the transit vehicle.
             sig { returns(T.nilable(String)) }
             def predicted_occupancy
             end
@@ -313,6 +345,8 @@ module OnebusawaySDK
             def predicted_occupancy=(_)
             end
 
+            # Optional route long name that potentially overrides the route long name in the
+            #   referenced route element.
             sig { returns(T.nilable(String)) }
             def route_long_name
             end
@@ -321,6 +355,8 @@ module OnebusawaySDK
             def route_long_name=(_)
             end
 
+            # Optional route short name that potentially overrides the route short name in the
+            #   referenced route element.
             sig { returns(T.nilable(String)) }
             def route_short_name
             end
@@ -329,6 +365,7 @@ module OnebusawaySDK
             def route_short_name=(_)
             end
 
+            # Interval for scheduled arrival time.
             sig { returns(T.nilable(String)) }
             def scheduled_arrival_interval
             end
@@ -337,6 +374,7 @@ module OnebusawaySDK
             def scheduled_arrival_interval=(_)
             end
 
+            # Interval for scheduled departure time.
             sig { returns(T.nilable(String)) }
             def scheduled_departure_interval
             end
@@ -345,6 +383,7 @@ module OnebusawaySDK
             def scheduled_departure_interval=(_)
             end
 
+            # Scheduled track information of the arriving transit vehicle.
             sig { returns(T.nilable(String)) }
             def scheduled_track
             end
@@ -353,6 +392,7 @@ module OnebusawaySDK
             def scheduled_track=(_)
             end
 
+            # References to situation elements (if any) applicable to this arrival.
             sig { returns(T.nilable(T::Array[String])) }
             def situation_ids
             end
@@ -361,6 +401,7 @@ module OnebusawaySDK
             def situation_ids=(_)
             end
 
+            # Current status of the arrival.
             sig { returns(T.nilable(String)) }
             def status
             end
@@ -369,6 +410,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Trip-specific status for the arriving transit vehicle.
             sig do
               returns(
                 T.nilable(
@@ -427,9 +469,9 @@ module OnebusawaySDK
                 status: String,
                 trip_status: OnebusawaySDK::Models::ArrivalAndDepartureListResponse::Data::Entry::ArrivalsAndDeparture::TripStatus
               )
-                .void
+                .returns(T.attached_class)
             end
-            def initialize(
+            def self.new(
               arrival_enabled:,
               block_trip_sequence:,
               departure_enabled:,
@@ -512,6 +554,7 @@ module OnebusawaySDK
             end
 
             class TripStatus < OnebusawaySDK::BaseModel
+              # Trip ID of the trip the vehicle is actively serving.
               sig { returns(String) }
               def active_trip_id
               end
@@ -520,6 +563,7 @@ module OnebusawaySDK
               def active_trip_id=(_)
               end
 
+              # Index of the active trip into the sequence of trips for the active block.
               sig { returns(Integer) }
               def block_trip_sequence
               end
@@ -528,6 +572,7 @@ module OnebusawaySDK
               def block_trip_sequence=(_)
               end
 
+              # ID of the closest stop to the current location of the transit vehicle.
               sig { returns(String) }
               def closest_stop
               end
@@ -536,6 +581,7 @@ module OnebusawaySDK
               def closest_stop=(_)
               end
 
+              # Distance, in meters, the transit vehicle has progressed along the active trip.
               sig { returns(Float) }
               def distance_along_trip
               end
@@ -544,6 +590,8 @@ module OnebusawaySDK
               def distance_along_trip=(_)
               end
 
+              # Last known distance along the trip received in real-time from the transit
+              #   vehicle.
               sig { returns(Float) }
               def last_known_distance_along_trip
               end
@@ -552,6 +600,7 @@ module OnebusawaySDK
               def last_known_distance_along_trip=(_)
               end
 
+              # Timestamp of the last known real-time location update from the transit vehicle.
               sig { returns(Integer) }
               def last_location_update_time
               end
@@ -560,6 +609,7 @@ module OnebusawaySDK
               def last_location_update_time=(_)
               end
 
+              # Timestamp of the last known real-time update from the transit vehicle.
               sig { returns(Integer) }
               def last_update_time
               end
@@ -568,6 +618,7 @@ module OnebusawaySDK
               def last_update_time=(_)
               end
 
+              # Capacity of the transit vehicle in terms of occupancy.
               sig { returns(Integer) }
               def occupancy_capacity
               end
@@ -576,6 +627,7 @@ module OnebusawaySDK
               def occupancy_capacity=(_)
               end
 
+              # Current count of occupants in the transit vehicle.
               sig { returns(Integer) }
               def occupancy_count
               end
@@ -584,6 +636,7 @@ module OnebusawaySDK
               def occupancy_count=(_)
               end
 
+              # Current occupancy status of the transit vehicle.
               sig { returns(String) }
               def occupancy_status
               end
@@ -592,6 +645,7 @@ module OnebusawaySDK
               def occupancy_status=(_)
               end
 
+              # Current journey phase of the trip.
               sig { returns(String) }
               def phase
               end
@@ -600,6 +654,7 @@ module OnebusawaySDK
               def phase=(_)
               end
 
+              # Indicates if real-time arrival info is available for this trip.
               sig { returns(T::Boolean) }
               def predicted
               end
@@ -608,6 +663,7 @@ module OnebusawaySDK
               def predicted=(_)
               end
 
+              # Deviation from the schedule in seconds (positive for late, negative for early).
               sig { returns(Integer) }
               def schedule_deviation
               end
@@ -616,6 +672,8 @@ module OnebusawaySDK
               def schedule_deviation=(_)
               end
 
+              # Time, in milliseconds since the Unix epoch, of midnight for the start of the
+              #   service date for the trip.
               sig { returns(Integer) }
               def service_date
               end
@@ -624,6 +682,7 @@ module OnebusawaySDK
               def service_date=(_)
               end
 
+              # Current status modifiers for the trip.
               sig { returns(String) }
               def status
               end
@@ -632,6 +691,7 @@ module OnebusawaySDK
               def status=(_)
               end
 
+              # Total length of the trip, in meters.
               sig { returns(Float) }
               def total_distance_along_trip
               end
@@ -640,6 +700,8 @@ module OnebusawaySDK
               def total_distance_along_trip=(_)
               end
 
+              # Time offset from the closest stop to the current position of the transit vehicle
+              #   (in seconds).
               sig { returns(T.nilable(Integer)) }
               def closest_stop_time_offset
               end
@@ -648,6 +710,7 @@ module OnebusawaySDK
               def closest_stop_time_offset=(_)
               end
 
+              # Information about frequency-based scheduling, if applicable to the trip.
               sig { returns(T.nilable(String)) }
               def frequency
               end
@@ -656,6 +719,7 @@ module OnebusawaySDK
               def frequency=(_)
               end
 
+              # Last known location of the transit vehicle.
               sig do
                 returns(
                   T.nilable(
@@ -677,6 +741,7 @@ module OnebusawaySDK
               def last_known_location=(_)
               end
 
+              # Last known orientation value received in real-time from the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def last_known_orientation
               end
@@ -685,6 +750,7 @@ module OnebusawaySDK
               def last_known_orientation=(_)
               end
 
+              # ID of the next stop the transit vehicle is scheduled to arrive at.
               sig { returns(T.nilable(String)) }
               def next_stop
               end
@@ -693,6 +759,8 @@ module OnebusawaySDK
               def next_stop=(_)
               end
 
+              # Time offset from the next stop to the current position of the transit vehicle
+              #   (in seconds).
               sig { returns(T.nilable(Integer)) }
               def next_stop_time_offset
               end
@@ -701,6 +769,7 @@ module OnebusawaySDK
               def next_stop_time_offset=(_)
               end
 
+              # Orientation of the transit vehicle, represented as an angle in degrees.
               sig { returns(T.nilable(Float)) }
               def orientation
               end
@@ -709,6 +778,7 @@ module OnebusawaySDK
               def orientation=(_)
               end
 
+              # Current position of the transit vehicle.
               sig do
                 returns(
                   T.nilable(
@@ -730,6 +800,8 @@ module OnebusawaySDK
               def position=(_)
               end
 
+              # Distance, in meters, the transit vehicle is scheduled to have progressed along
+              #   the active trip.
               sig { returns(T.nilable(Float)) }
               def scheduled_distance_along_trip
               end
@@ -738,6 +810,7 @@ module OnebusawaySDK
               def scheduled_distance_along_trip=(_)
               end
 
+              # References to situation elements (if any) applicable to this trip.
               sig { returns(T.nilable(T::Array[String])) }
               def situation_ids
               end
@@ -746,6 +819,7 @@ module OnebusawaySDK
               def situation_ids=(_)
               end
 
+              # ID of the transit vehicle currently serving the trip.
               sig { returns(T.nilable(String)) }
               def vehicle_id
               end
@@ -754,6 +828,7 @@ module OnebusawaySDK
               def vehicle_id=(_)
               end
 
+              # Trip-specific status for the arriving transit vehicle.
               sig do
                 params(
                   active_trip_id: String,
@@ -784,9 +859,9 @@ module OnebusawaySDK
                   situation_ids: T::Array[String],
                   vehicle_id: String
                 )
-                  .void
+                  .returns(T.attached_class)
               end
-              def initialize(
+              def self.new(
                 active_trip_id:,
                 block_trip_sequence:,
                 closest_stop:,
@@ -855,6 +930,7 @@ module OnebusawaySDK
               end
 
               class LastKnownLocation < OnebusawaySDK::BaseModel
+                # Latitude of the last known location of the transit vehicle.
                 sig { returns(T.nilable(Float)) }
                 def lat
                 end
@@ -863,6 +939,7 @@ module OnebusawaySDK
                 def lat=(_)
                 end
 
+                # Longitude of the last known location of the transit vehicle.
                 sig { returns(T.nilable(Float)) }
                 def lon
                 end
@@ -871,8 +948,9 @@ module OnebusawaySDK
                 def lon=(_)
                 end
 
-                sig { params(lat: Float, lon: Float).void }
-                def initialize(lat: nil, lon: nil)
+                # Last known location of the transit vehicle.
+                sig { params(lat: Float, lon: Float).returns(T.attached_class) }
+                def self.new(lat: nil, lon: nil)
                 end
 
                 sig { override.returns({lat: Float, lon: Float}) }
@@ -881,6 +959,7 @@ module OnebusawaySDK
               end
 
               class Position < OnebusawaySDK::BaseModel
+                # Latitude of the current position of the transit vehicle.
                 sig { returns(T.nilable(Float)) }
                 def lat
                 end
@@ -889,6 +968,7 @@ module OnebusawaySDK
                 def lat=(_)
                 end
 
+                # Longitude of the current position of the transit vehicle.
                 sig { returns(T.nilable(Float)) }
                 def lon
                 end
@@ -897,8 +977,9 @@ module OnebusawaySDK
                 def lon=(_)
                 end
 
-                sig { params(lat: Float, lon: Float).void }
-                def initialize(lat: nil, lon: nil)
+                # Current position of the transit vehicle.
+                sig { params(lat: Float, lon: Float).returns(T.attached_class) }
+                def self.new(lat: nil, lon: nil)
                 end
 
                 sig { override.returns({lat: Float, lon: Float}) }

data/rbi/lib/onebusaway-sdk/models/arrival_and_departure_retrieve_params.rbi

@@ -55,16 +55,9 @@ module OnebusawaySDK
           vehicle_id: String,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
-        service_date:,
-        trip_id:,
-        stop_sequence: nil,
-        time: nil,
-        vehicle_id: nil,
-        request_options: {}
-      )
+      def self.new(service_date:, trip_id:, stop_sequence: nil, time: nil, vehicle_id: nil, request_options: {})
       end
 
       sig do