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

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::TripsForLocationListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::TripsForLocationListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::TripsForLocationListResponse::Data}) }
@@ -23,6 +23,7 @@ module OnebusawaySDK
       end
 
       class Data < OnebusawaySDK::BaseModel
+        # Indicates if the limit of trips has been exceeded
         sig { returns(T::Boolean) }
         def limit_exceeded
         end
@@ -50,6 +51,7 @@ module OnebusawaySDK
         def references=(_)
         end
 
+        # Indicates if the search location is out of range
         sig { returns(T.nilable(T::Boolean)) }
         def out_of_range
         end
@@ -65,9 +67,9 @@ module OnebusawaySDK
             references: OnebusawaySDK::Models::References,
             out_of_range: T::Boolean
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(limit_exceeded:, list:, references:, out_of_range: nil)
+        def self.new(limit_exceeded:, list:, references:, out_of_range: nil)
         end
 
         sig do
@@ -148,9 +150,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
@@ -221,9 +223,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
@@ -299,9 +301,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,
@@ -330,6 +332,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
@@ -338,6 +341,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
@@ -346,6 +350,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
@@ -354,6 +359,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
@@ -362,6 +368,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
@@ -370,6 +378,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
@@ -378,6 +387,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
@@ -386,6 +396,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Capacity of the transit vehicle in terms of occupancy.
             sig { returns(Integer) }
             def occupancy_capacity
             end
@@ -394,6 +405,7 @@ module OnebusawaySDK
             def occupancy_capacity=(_)
             end
 
+            # Current count of occupants in the transit vehicle.
             sig { returns(Integer) }
             def occupancy_count
             end
@@ -402,6 +414,7 @@ module OnebusawaySDK
             def occupancy_count=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(String) }
             def occupancy_status
             end
@@ -410,6 +423,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Current journey phase of the trip.
             sig { returns(String) }
             def phase
             end
@@ -418,6 +432,7 @@ module OnebusawaySDK
             def phase=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T::Boolean) }
             def predicted
             end
@@ -426,6 +441,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
@@ -434,6 +450,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
@@ -442,6 +460,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # Current status modifiers for the trip.
             sig { returns(String) }
             def status
             end
@@ -450,6 +469,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Total length of the trip, in meters.
             sig { returns(Float) }
             def total_distance_along_trip
             end
@@ -458,6 +478,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
@@ -466,6 +488,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
@@ -474,6 +497,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Last known location of the transit vehicle.
             sig do
               returns(
                 T.nilable(OnebusawaySDK::Models::TripsForLocationListResponse::Data::List::Status::LastKnownLocation)
@@ -489,6 +513,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
@@ -497,6 +522,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
@@ -505,6 +531,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
@@ -513,6 +541,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
@@ -521,6 +550,7 @@ module OnebusawaySDK
             def orientation=(_)
             end
 
+            # Current position of the transit vehicle.
             sig { returns(T.nilable(OnebusawaySDK::Models::TripsForLocationListResponse::Data::List::Status::Position)) }
             def position
             end
@@ -532,6 +562,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
@@ -540,6 +572,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
@@ -548,6 +581,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
@@ -586,9 +620,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:,
@@ -657,6 +691,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
@@ -665,6 +700,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the last known location of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -673,8 +709,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}) }
@@ -683,6 +720,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
@@ -691,6 +729,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the current position of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -699,8 +738,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/trips_for_route_list_params.rbi

@@ -6,6 +6,7 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # Determine whether full schedule elements are included. Defaults to false.
       sig { returns(T.nilable(T::Boolean)) }
       def include_schedule
       end
@@ -14,6 +15,8 @@ module OnebusawaySDK
       def include_schedule=(_)
       end
 
+      # Determine whether full tripStatus elements with real-time information are
+      #   included. Defaults to false.
       sig { returns(T.nilable(T::Boolean)) }
       def include_status
       end
@@ -22,6 +25,7 @@ module OnebusawaySDK
       def include_status=(_)
       end
 
+      # Query the system at a specific time. Useful for testing.
       sig { returns(T.nilable(Integer)) }
       def time
       end
@@ -37,9 +41,9 @@ module OnebusawaySDK
           time: Integer,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(include_schedule: nil, include_status: nil, time: nil, request_options: {})
+      def self.new(include_schedule: nil, include_status: nil, time: nil, request_options: {})
       end
 
       sig do