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

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

@@ -6,6 +6,8 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # Determines whether full <schedule/> element is included in the <tripDetails/>
+      #   section. Defaults to false.
       sig { returns(T.nilable(T::Boolean)) }
       def include_schedule
       end
@@ -14,6 +16,8 @@ module OnebusawaySDK
       def include_schedule=(_)
       end
 
+      # Determines whether the full <status/> element is included in the <tripDetails/>
+      #   section. Defaults to true.
       sig { returns(T.nilable(T::Boolean)) }
       def include_status
       end
@@ -22,6 +26,8 @@ module OnebusawaySDK
       def include_status=(_)
       end
 
+      # Determines whether full <trip/> element is included in the <references/>
+      #   section. Defaults to false.
       sig { returns(T.nilable(T::Boolean)) }
       def include_trip
       end
@@ -30,6 +36,7 @@ module OnebusawaySDK
       def include_trip=(_)
       end
 
+      # Time parameter to query the system at a specific time (optional).
       sig { returns(T.nilable(Integer)) }
       def time
       end
@@ -46,15 +53,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,
-        include_trip: nil,
-        time: nil,
-        request_options: {}
-      )
+      def self.new(include_schedule: nil, include_status: nil, include_trip: nil, time: nil, request_options: {})
       end
 
       sig do

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, references:)
+        def self.new(entry:, references:)
         end
 
         sig do
@@ -128,16 +128,9 @@ module OnebusawaySDK
               situation_ids: T::Array[String],
               status: OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
-            trip_id:,
-            frequency: nil,
-            schedule: nil,
-            service_date: nil,
-            situation_ids: nil,
-            status: nil
-          )
+          def self.new(trip_id:, frequency: nil, schedule: nil, service_date: nil, situation_ids: nil, status: nil)
           end
 
           sig do
@@ -210,9 +203,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
@@ -288,9 +281,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,
@@ -319,6 +312,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
@@ -327,6 +321,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
@@ -335,6 +330,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
@@ -343,6 +339,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
@@ -351,6 +348,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
@@ -359,6 +358,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
@@ -367,6 +367,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
@@ -375,6 +376,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Capacity of the transit vehicle in terms of occupancy.
             sig { returns(Integer) }
             def occupancy_capacity
             end
@@ -383,6 +385,7 @@ module OnebusawaySDK
             def occupancy_capacity=(_)
             end
 
+            # Current count of occupants in the transit vehicle.
             sig { returns(Integer) }
             def occupancy_count
             end
@@ -391,6 +394,7 @@ module OnebusawaySDK
             def occupancy_count=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(String) }
             def occupancy_status
             end
@@ -399,6 +403,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Current journey phase of the trip.
             sig { returns(String) }
             def phase
             end
@@ -407,6 +412,7 @@ module OnebusawaySDK
             def phase=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T::Boolean) }
             def predicted
             end
@@ -415,6 +421,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
@@ -423,6 +430,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
@@ -431,6 +440,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # Current status modifiers for the trip.
             sig { returns(String) }
             def status
             end
@@ -439,6 +449,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Total length of the trip, in meters.
             sig { returns(Float) }
             def total_distance_along_trip
             end
@@ -447,6 +458,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
@@ -455,6 +468,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
@@ -463,6 +477,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Last known location of the transit vehicle.
             sig do
               returns(
                 T.nilable(OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status::LastKnownLocation)
@@ -478,6 +493,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
@@ -486,6 +502,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
@@ -494,6 +511,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
@@ -502,6 +521,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
@@ -510,6 +530,7 @@ module OnebusawaySDK
             def orientation=(_)
             end
 
+            # Current position of the transit vehicle.
             sig { returns(T.nilable(OnebusawaySDK::Models::TripForVehicleRetrieveResponse::Data::Entry::Status::Position)) }
             def position
             end
@@ -521,6 +542,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
@@ -529,6 +552,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
@@ -537,6 +561,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
@@ -575,9 +600,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:,
@@ -646,6 +671,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
@@ -654,6 +680,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the last known location of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -662,8 +689,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}) }
@@ -672,6 +700,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
@@ -680,6 +709,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the current position of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -688,8 +718,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/trip_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/trip_retrieve_response.rbi

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::TripRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::TripRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::TripRetrieveResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::TripRetrieveResponse::Data::Entry,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, references:)
+        def self.new(entry:, references:)
         end
 
         sig do
@@ -167,9 +167,9 @@ module OnebusawaySDK
               trip_headsign: String,
               trip_short_name: String
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             id:,
             route_id:,
             service_id:,

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

@@ -6,6 +6,7 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # The latitude coordinate of the search center
       sig { returns(Float) }
       def lat
       end
@@ -14,6 +15,7 @@ module OnebusawaySDK
       def lat=(_)
       end
 
+      # Latitude span of the search bounding box
       sig { returns(Float) }
       def lat_span
       end
@@ -22,6 +24,7 @@ module OnebusawaySDK
       def lat_span=(_)
       end
 
+      # The longitude coordinate of the search center
       sig { returns(Float) }
       def lon
       end
@@ -30,6 +33,7 @@ module OnebusawaySDK
       def lon=(_)
       end
 
+      # Longitude span of the search bounding box
       sig { returns(Float) }
       def lon_span
       end
@@ -38,6 +42,8 @@ module OnebusawaySDK
       def lon_span=(_)
       end
 
+      # Whether to include full schedule elements in the tripDetails section. Defaults
+      #   to false.
       sig { returns(T.nilable(T::Boolean)) }
       def include_schedule
       end
@@ -46,6 +52,8 @@ module OnebusawaySDK
       def include_schedule=(_)
       end
 
+      # Whether to include full trip elements in the references section. Defaults to
+      #   false.
       sig { returns(T.nilable(T::Boolean)) }
       def include_trip
       end
@@ -54,6 +62,7 @@ module OnebusawaySDK
       def include_trip=(_)
       end
 
+      # Specific time for the query. Defaults to the current time.
       sig { returns(T.nilable(Integer)) }
       def time
       end
@@ -73,18 +82,9 @@ module OnebusawaySDK
           time: Integer,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
-      end
-      def initialize(
-        lat:,
-        lat_span:,
-        lon:,
-        lon_span:,
-        include_schedule: nil,
-        include_trip: nil,
-        time: nil,
-        request_options: {}
-      )
+          .returns(T.attached_class)
+      end
+      def self.new(lat:, lat_span:, lon:, lon_span:, include_schedule: nil, include_trip: nil, time: nil, request_options: {})
       end
 
       sig do