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

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::TripsForRouteListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::TripsForRouteListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::TripsForRouteListResponse::Data}) }
@@ -56,9 +56,9 @@ module OnebusawaySDK
             list: T::Array[OnebusawaySDK::Models::TripsForRouteListResponse::Data::List],
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(limit_exceeded:, list:, references:)
+        def self.new(limit_exceeded:, list:, references:)
         end
 
         sig do
@@ -138,9 +138,9 @@ module OnebusawaySDK
               service_date: Integer,
               situation_ids: T::Array[String]
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(schedule:, status:, trip_id:, frequency: nil, service_date: nil, situation_ids: nil)
+          def self.new(schedule:, status:, trip_id:, frequency: nil, service_date: nil, situation_ids: nil)
           end
 
           sig do
@@ -211,9 +211,9 @@ module OnebusawaySDK
                 time_zone: String,
                 frequency: T.nilable(String)
               )
-                .void
+                .returns(T.attached_class)
             end
-            def initialize(next_trip_id:, previous_trip_id:, stop_times:, time_zone:, frequency: nil)
+            def self.new(next_trip_id:, previous_trip_id:, stop_times:, time_zone:, frequency: nil)
             end
 
             sig do
@@ -289,9 +289,9 @@ module OnebusawaySDK
                   stop_headsign: String,
                   stop_id: String
                 )
-                  .void
+                  .returns(T.attached_class)
               end
-              def initialize(
+              def self.new(
                 arrival_time: nil,
                 departure_time: nil,
                 distance_along_trip: nil,
@@ -320,6 +320,7 @@ module OnebusawaySDK
           end
 
           class Status < OnebusawaySDK::BaseModel
+            # Trip ID of the trip the vehicle is actively serving.
             sig { returns(String) }
             def active_trip_id
             end
@@ -328,6 +329,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
@@ -336,6 +338,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
@@ -344,6 +347,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
@@ -352,6 +356,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
@@ -360,6 +366,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
@@ -368,6 +375,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
@@ -376,6 +384,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Capacity of the transit vehicle in terms of occupancy.
             sig { returns(Integer) }
             def occupancy_capacity
             end
@@ -384,6 +393,7 @@ module OnebusawaySDK
             def occupancy_capacity=(_)
             end
 
+            # Current count of occupants in the transit vehicle.
             sig { returns(Integer) }
             def occupancy_count
             end
@@ -392,6 +402,7 @@ module OnebusawaySDK
             def occupancy_count=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(String) }
             def occupancy_status
             end
@@ -400,6 +411,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Current journey phase of the trip.
             sig { returns(String) }
             def phase
             end
@@ -408,6 +420,7 @@ module OnebusawaySDK
             def phase=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T::Boolean) }
             def predicted
             end
@@ -416,6 +429,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
@@ -424,6 +438,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
@@ -432,6 +448,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # Current status modifiers for the trip.
             sig { returns(String) }
             def status
             end
@@ -440,6 +457,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Total length of the trip, in meters.
             sig { returns(Float) }
             def total_distance_along_trip
             end
@@ -448,6 +466,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
@@ -456,6 +476,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
@@ -464,6 +485,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Last known location of the transit vehicle.
             sig do
               returns(
                 T.nilable(OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::LastKnownLocation)
@@ -479,6 +501,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
@@ -487,6 +510,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
@@ -495,6 +519,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
@@ -503,6 +529,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
@@ -511,6 +538,7 @@ module OnebusawaySDK
             def orientation=(_)
             end
 
+            # Current position of the transit vehicle.
             sig { returns(T.nilable(OnebusawaySDK::Models::TripsForRouteListResponse::Data::List::Status::Position)) }
             def position
             end
@@ -522,6 +550,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
@@ -530,6 +560,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
@@ -538,6 +569,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
@@ -576,9 +608,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:,
@@ -647,6 +679,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
@@ -655,6 +688,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the last known location of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -663,8 +697,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}) }
@@ -673,6 +708,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
@@ -681,6 +717,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the current position of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -689,8 +726,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/vehicles_for_agency_list_params.rbi

@@ -6,6 +6,7 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # Specific time for querying the status (timestamp format)
       sig { returns(T.nilable(String)) }
       def time
       end
@@ -22,9 +23,9 @@ module OnebusawaySDK
             T::Hash[Symbol, T.anything]
           )
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(time: nil, request_options: {})
+      def self.new(time: nil, request_options: {})
       end
 
       sig { override.returns({time: String, request_options: OnebusawaySDK::RequestOptions}) }

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data}) }
@@ -56,9 +56,9 @@ module OnebusawaySDK
             list: T::Array[OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List],
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(limit_exceeded:, list:, references:)
+        def self.new(limit_exceeded:, list:, references:)
         end
 
         sig do
@@ -183,9 +183,9 @@ module OnebusawaySDK
               phase: String,
               status: String
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             last_location_update_time:,
             last_update_time:,
             location:,
@@ -238,8 +238,8 @@ module OnebusawaySDK
             def lon=(_)
             end
 
-            sig { params(lat: Float, lon: Float).void }
-            def initialize(lat: nil, lon: nil)
+            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}) }
@@ -248,6 +248,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
@@ -256,6 +257,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
@@ -264,6 +266,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
@@ -272,6 +275,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
@@ -280,6 +284,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
@@ -288,6 +294,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
@@ -296,6 +303,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
@@ -304,6 +312,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Capacity of the transit vehicle in terms of occupancy.
             sig { returns(Integer) }
             def occupancy_capacity
             end
@@ -312,6 +321,7 @@ module OnebusawaySDK
             def occupancy_capacity=(_)
             end
 
+            # Current count of occupants in the transit vehicle.
             sig { returns(Integer) }
             def occupancy_count
             end
@@ -320,6 +330,7 @@ module OnebusawaySDK
             def occupancy_count=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(String) }
             def occupancy_status
             end
@@ -328,6 +339,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Current journey phase of the trip.
             sig { returns(String) }
             def phase
             end
@@ -336,6 +348,7 @@ module OnebusawaySDK
             def phase=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T::Boolean) }
             def predicted
             end
@@ -344,6 +357,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
@@ -352,6 +366,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
@@ -360,6 +376,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # Current status modifiers for the trip.
             sig { returns(String) }
             def status
             end
@@ -368,6 +385,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Total length of the trip, in meters.
             sig { returns(Float) }
             def total_distance_along_trip
             end
@@ -376,6 +394,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
@@ -384,6 +404,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
@@ -392,6 +413,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Last known location of the transit vehicle.
             sig do
               returns(
                 T.nilable(OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::LastKnownLocation)
@@ -407,6 +429,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
@@ -415,6 +438,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
@@ -423,6 +447,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
@@ -431,6 +457,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
@@ -439,6 +466,7 @@ module OnebusawaySDK
             def orientation=(_)
             end
 
+            # Current position of the transit vehicle.
             sig { returns(T.nilable(OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::Position)) }
             def position
             end
@@ -450,6 +478,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
@@ -458,6 +488,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
@@ -466,6 +497,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
@@ -504,9 +536,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:,
@@ -575,6 +607,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
@@ -583,6 +616,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the last known location of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -591,8 +625,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}) }
@@ -601,6 +636,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
@@ -609,6 +645,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the current position of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -617,8 +654,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}) }