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

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, references:)
+        def self.new(entry:, references:)
         end
 
         sig do
@@ -65,6 +65,7 @@ module OnebusawaySDK
         end
 
         class Entry < OnebusawaySDK::BaseModel
+          # Indicates if riders can arrive on this transit vehicle.
           sig { returns(T::Boolean) }
           def arrival_enabled
           end
@@ -73,6 +74,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
@@ -81,6 +83,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
@@ -89,6 +92,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
@@ -97,6 +102,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
@@ -105,6 +112,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
@@ -113,6 +122,7 @@ module OnebusawaySDK
           def predicted_departure_time=(_)
           end
 
+          # The ID of the route for the arriving vehicle.
           sig { returns(String) }
           def route_id
           end
@@ -121,6 +131,7 @@ module OnebusawaySDK
           def route_id=(_)
           end
 
+          # Scheduled arrival time, in milliseconds since Unix epoch.
           sig { returns(Integer) }
           def scheduled_arrival_time
           end
@@ -129,6 +140,7 @@ module OnebusawaySDK
           def scheduled_arrival_time=(_)
           end
 
+          # Scheduled departure time, in milliseconds since Unix epoch.
           sig { returns(Integer) }
           def scheduled_departure_time
           end
@@ -137,6 +149,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
@@ -145,6 +159,7 @@ module OnebusawaySDK
           def service_date=(_)
           end
 
+          # The ID of the stop the vehicle is arriving at.
           sig { returns(String) }
           def stop_id
           end
@@ -153,6 +168,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
@@ -161,6 +178,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
@@ -169,6 +187,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
@@ -177,6 +197,7 @@ module OnebusawaySDK
           def trip_headsign=(_)
           end
 
+          # The ID of the trip for the arriving vehicle.
           sig { returns(String) }
           def trip_id
           end
@@ -185,6 +206,7 @@ module OnebusawaySDK
           def trip_id=(_)
           end
 
+          # ID of the transit vehicle serving this trip.
           sig { returns(String) }
           def vehicle_id
           end
@@ -193,6 +215,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
@@ -201,6 +224,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
@@ -209,6 +233,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
@@ -217,6 +242,7 @@ module OnebusawaySDK
           def frequency=(_)
           end
 
+          # Historical occupancy information of the transit vehicle.
           sig { returns(T.nilable(String)) }
           def historical_occupancy
           end
@@ -225,6 +251,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
@@ -233,6 +260,7 @@ module OnebusawaySDK
           def last_update_time=(_)
           end
 
+          # Current occupancy status of the transit vehicle.
           sig { returns(T.nilable(String)) }
           def occupancy_status
           end
@@ -241,6 +269,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
@@ -249,6 +278,7 @@ module OnebusawaySDK
           def predicted=(_)
           end
 
+          # Interval for predicted arrival time, if available.
           sig { returns(T.nilable(String)) }
           def predicted_arrival_interval
           end
@@ -257,6 +287,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
@@ -265,6 +296,7 @@ module OnebusawaySDK
           def predicted_departure_interval=(_)
           end
 
+          # Predicted occupancy status of the transit vehicle.
           sig { returns(T.nilable(String)) }
           def predicted_occupancy
           end
@@ -273,6 +305,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
@@ -281,6 +315,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
@@ -289,6 +325,7 @@ module OnebusawaySDK
           def route_short_name=(_)
           end
 
+          # Interval for scheduled arrival time.
           sig { returns(T.nilable(String)) }
           def scheduled_arrival_interval
           end
@@ -297,6 +334,7 @@ module OnebusawaySDK
           def scheduled_arrival_interval=(_)
           end
 
+          # Interval for scheduled departure time.
           sig { returns(T.nilable(String)) }
           def scheduled_departure_interval
           end
@@ -305,6 +343,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
@@ -313,6 +352,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
@@ -321,6 +361,7 @@ module OnebusawaySDK
           def situation_ids=(_)
           end
 
+          # Current status of the arrival.
           sig { returns(T.nilable(String)) }
           def status
           end
@@ -329,6 +370,7 @@ module OnebusawaySDK
           def status=(_)
           end
 
+          # Trip-specific status for the arriving transit vehicle.
           sig { returns(T.nilable(OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus)) }
           def trip_status
           end
@@ -377,9 +419,9 @@ module OnebusawaySDK
               status: String,
               trip_status: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             arrival_enabled:,
             block_trip_sequence:,
             departure_enabled:,
@@ -462,6 +504,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
@@ -470,6 +513,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
@@ -478,6 +522,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
@@ -486,6 +531,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
@@ -494,6 +540,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
@@ -502,6 +550,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
@@ -510,6 +559,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
@@ -518,6 +568,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Capacity of the transit vehicle in terms of occupancy.
             sig { returns(Integer) }
             def occupancy_capacity
             end
@@ -526,6 +577,7 @@ module OnebusawaySDK
             def occupancy_capacity=(_)
             end
 
+            # Current count of occupants in the transit vehicle.
             sig { returns(Integer) }
             def occupancy_count
             end
@@ -534,6 +586,7 @@ module OnebusawaySDK
             def occupancy_count=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(String) }
             def occupancy_status
             end
@@ -542,6 +595,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Current journey phase of the trip.
             sig { returns(String) }
             def phase
             end
@@ -550,6 +604,7 @@ module OnebusawaySDK
             def phase=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T::Boolean) }
             def predicted
             end
@@ -558,6 +613,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
@@ -566,6 +622,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
@@ -574,6 +632,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # Current status modifiers for the trip.
             sig { returns(String) }
             def status
             end
@@ -582,6 +641,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Total length of the trip, in meters.
             sig { returns(Float) }
             def total_distance_along_trip
             end
@@ -590,6 +650,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
@@ -598,6 +660,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
@@ -606,6 +669,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Last known location of the transit vehicle.
             sig do
               returns(
                 T.nilable(
@@ -627,6 +691,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
@@ -635,6 +700,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
@@ -643,6 +709,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
@@ -651,6 +719,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
@@ -659,6 +728,7 @@ module OnebusawaySDK
             def orientation=(_)
             end
 
+            # Current position of the transit vehicle.
             sig do
               returns(
                 T.nilable(OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse::Data::Entry::TripStatus::Position)
@@ -674,6 +744,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
@@ -682,6 +754,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
@@ -690,6 +763,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
@@ -698,6 +772,7 @@ module OnebusawaySDK
             def vehicle_id=(_)
             end
 
+            # Trip-specific status for the arriving transit vehicle.
             sig do
               params(
                 active_trip_id: String,
@@ -728,9 +803,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:,
@@ -799,6 +874,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
@@ -807,6 +883,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the last known location of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -815,8 +892,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}) }
@@ -825,6 +903,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
@@ -833,6 +912,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the current position of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -841,8 +921,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/block_retrieve_params.rbi

@@ -6,8 +6,11 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
-      sig { params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything]))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: OnebusawaySDK::RequestOptions}) }

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::BlockRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::BlockRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::BlockRetrieveResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::BlockRetrieveResponse::Data::Entry,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, references:)
+        def self.new(entry:, references:)
         end
 
         sig do
@@ -89,9 +89,9 @@ module OnebusawaySDK
               id: String,
               configurations: T::Array[OnebusawaySDK::Models::BlockRetrieveResponse::Data::Entry::Configuration]
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(id:, configurations:)
+          def self.new(id:, configurations:)
           end
 
           sig do
@@ -140,9 +140,9 @@ module OnebusawaySDK
                 trips: T::Array[OnebusawaySDK::Models::BlockRetrieveResponse::Data::Entry::Configuration::Trip],
                 inactive_service_ids: T::Array[String]
               )
-                .void
+                .returns(T.attached_class)
             end
-            def initialize(active_service_ids:, trips:, inactive_service_ids: nil)
+            def self.new(active_service_ids:, trips:, inactive_service_ids: nil)
             end
 
             sig do
@@ -209,9 +209,9 @@ module OnebusawaySDK
                   distance_along_block: Float,
                   trip_id: String
                 )
-                  .void
+                  .returns(T.attached_class)
               end
-              def initialize(accumulated_slack_time:, block_stop_times:, distance_along_block:, trip_id:)
+              def self.new(accumulated_slack_time:, block_stop_times:, distance_along_block:, trip_id:)
               end
 
               sig do
@@ -279,9 +279,9 @@ module OnebusawaySDK
                     distance_along_block: Float,
                     stop_time: OnebusawaySDK::Models::BlockRetrieveResponse::Data::Entry::Configuration::Trip::BlockStopTime::StopTime
                   )
-                    .void
+                    .returns(T.attached_class)
                 end
-                def initialize(accumulated_slack_time:, block_sequence:, distance_along_block:, stop_time:)
+                def self.new(accumulated_slack_time:, block_sequence:, distance_along_block:, stop_time:)
                 end
 
                 sig do
@@ -347,15 +347,9 @@ module OnebusawaySDK
                       drop_off_type: Integer,
                       pickup_type: Integer
                     )
-                      .void
+                      .returns(T.attached_class)
                   end
-                  def initialize(
-                    arrival_time:,
-                    departure_time:,
-                    stop_id:,
-                    drop_off_type: nil,
-                    pickup_type: nil
-                  )
+                  def self.new(arrival_time:, departure_time:, stop_id:, drop_off_type: nil, pickup_type: nil)
                   end
 
                   sig do

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

@@ -6,8 +6,11 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
-      sig { params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything]))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: OnebusawaySDK::RequestOptions}) }