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

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::StopRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::StopRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::StopRetrieveResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::StopRetrieveResponse::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
               location_type: Integer,
               wheelchair_boarding: String
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             id:,
             lat:,
             lon:,

data/rbi/lib/onebusaway-sdk/models/stops_for_agency_list_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/stops_for_agency_list_response.rbi

@@ -45,9 +45,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
@@ -167,9 +167,9 @@ module OnebusawaySDK
             location_type: Integer,
             wheelchair_boarding: String
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           id:,
           lat:,
           lon:,

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

@@ -22,6 +22,7 @@ module OnebusawaySDK
       def lon=(_)
       end
 
+      # An alternative to radius to set the search bounding box (optional)
       sig { returns(T.nilable(Float)) }
       def lat_span
       end
@@ -30,6 +31,7 @@ module OnebusawaySDK
       def lat_span=(_)
       end
 
+      # An alternative to radius to set the search bounding box (optional)
       sig { returns(T.nilable(Float)) }
       def lon_span
       end
@@ -38,6 +40,7 @@ module OnebusawaySDK
       def lon_span=(_)
       end
 
+      # A search query string to filter the results
       sig { returns(T.nilable(String)) }
       def query
       end
@@ -46,6 +49,7 @@ module OnebusawaySDK
       def query=(_)
       end
 
+      # The radius in meters to search within
       sig { returns(T.nilable(Float)) }
       def radius
       end
@@ -64,9 +68,9 @@ module OnebusawaySDK
           radius: Float,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, radius: nil, request_options: {})
+      def self.new(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, radius: nil, request_options: {})
       end
 
       sig do

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::StopsForLocationListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::StopsForLocationListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::StopsForLocationListResponse::Data}) }
@@ -65,9 +65,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
@@ -187,9 +187,9 @@ module OnebusawaySDK
               location_type: Integer,
               wheelchair_boarding: String
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(
+          def self.new(
             id:,
             lat:,
             lon:,

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

@@ -6,6 +6,7 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # Include polyline elements in the response (default true)
       sig { returns(T.nilable(T::Boolean)) }
       def include_polylines
       end
@@ -14,6 +15,7 @@ module OnebusawaySDK
       def include_polylines=(_)
       end
 
+      # Specify service date (YYYY-MM-DD or epoch) (default today)
       sig { returns(T.nilable(String)) }
       def time
       end
@@ -28,9 +30,9 @@ module OnebusawaySDK
           time: String,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(include_polylines: nil, time: nil, request_options: {})
+      def self.new(include_polylines: nil, time: nil, request_options: {})
       end
 
       sig do

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::StopsForRouteListResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::StopsForRouteListResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::StopsForRouteListResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::StopsForRouteListResponse::Data::Entry,
             references: OnebusawaySDK::Models::References
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(entry:, references:)
+        def self.new(entry:, references:)
         end
 
         sig do
@@ -110,9 +110,9 @@ module OnebusawaySDK
               stop_groupings: T::Array[OnebusawaySDK::Models::StopsForRouteListResponse::Data::Entry::StopGrouping],
               stop_ids: T::Array[String]
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(polylines: nil, route_id: nil, stop_groupings: nil, stop_ids: nil)
+          def self.new(polylines: nil, route_id: nil, stop_groupings: nil, stop_ids: nil)
           end
 
           sig do
@@ -154,8 +154,8 @@ module OnebusawaySDK
             def points=(_)
             end
 
-            sig { params(length: Integer, levels: String, points: String).void }
-            def initialize(length: nil, levels: nil, points: nil)
+            sig { params(length: Integer, levels: String, points: String).returns(T.attached_class) }
+            def self.new(length: nil, levels: nil, points: nil)
             end
 
             sig { override.returns({length: Integer, levels: String, points: String}) }
@@ -213,9 +213,9 @@ module OnebusawaySDK
                 polylines: T::Array[OnebusawaySDK::Models::StopsForRouteListResponse::Data::Entry::StopGrouping::Polyline],
                 stop_ids: T::Array[String]
               )
-                .void
+                .returns(T.attached_class)
             end
-            def initialize(id: nil, name: nil, polylines: nil, stop_ids: nil)
+            def self.new(id: nil, name: nil, polylines: nil, stop_ids: nil)
             end
 
             sig do
@@ -257,8 +257,8 @@ module OnebusawaySDK
               def type=(_)
               end
 
-              sig { params(name: String, names: T::Array[String], type: String).void }
-              def initialize(name: nil, names: nil, type: nil)
+              sig { params(name: String, names: T::Array[String], type: String).returns(T.attached_class) }
+              def self.new(name: nil, names: nil, type: nil)
               end
 
               sig { override.returns({name: String, names: T::Array[String], type: String}) }
@@ -291,8 +291,8 @@ module OnebusawaySDK
               def points=(_)
               end
 
-              sig { params(length: Integer, levels: String, points: String).void }
-              def initialize(length: nil, levels: nil, points: nil)
+              sig { params(length: Integer, levels: String, points: String).returns(T.attached_class) }
+              def self.new(length: nil, levels: nil, points: nil)
               end
 
               sig { override.returns({length: Integer, levels: String, points: String}) }

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

@@ -6,6 +6,8 @@ module OnebusawaySDK
       extend OnebusawaySDK::RequestParameters::Converter
       include OnebusawaySDK::RequestParameters
 
+      # Whether to include the full schedule element in the tripDetails section
+      #   (defaults to true).
       sig { returns(T.nilable(T::Boolean)) }
       def include_schedule
       end
@@ -14,6 +16,8 @@ module OnebusawaySDK
       def include_schedule=(_)
       end
 
+      # Whether to include the full status element 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
 
+      # Whether to include the full trip element in the references section (defaults to
+      #   true).
       sig { returns(T.nilable(T::Boolean)) }
       def include_trip
       end
@@ -30,6 +36,7 @@ module OnebusawaySDK
       def include_trip=(_)
       end
 
+      # Service date for the trip as Unix time in milliseconds (optional).
       sig { returns(T.nilable(Integer)) }
       def service_date
       end
@@ -38,6 +45,7 @@ module OnebusawaySDK
       def service_date=(_)
       end
 
+      # Time parameter to query the system at a specific time (optional).
       sig { returns(T.nilable(Integer)) }
       def time
       end
@@ -55,9 +63,9 @@ module OnebusawaySDK
           time: Integer,
           request_options: T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         include_schedule: nil,
         include_status: nil,
         include_trip: nil,

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

@@ -14,8 +14,8 @@ module OnebusawaySDK
       def data=(_)
       end
 
-      sig { params(data: OnebusawaySDK::Models::TripDetailRetrieveResponse::Data).void }
-      def initialize(data:)
+      sig { params(data: OnebusawaySDK::Models::TripDetailRetrieveResponse::Data).returns(T.attached_class) }
+      def self.new(data:)
       end
 
       sig { override.returns({data: OnebusawaySDK::Models::TripDetailRetrieveResponse::Data}) }
@@ -47,9 +47,9 @@ module OnebusawaySDK
             entry: OnebusawaySDK::Models::TripDetailRetrieveResponse::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::TripDetailRetrieveResponse::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
@@ -208,9 +201,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
@@ -286,9 +279,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,
@@ -317,6 +310,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
@@ -325,6 +319,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
@@ -333,6 +328,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
@@ -341,6 +337,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
@@ -349,6 +346,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
@@ -357,6 +356,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
@@ -365,6 +365,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
@@ -373,6 +374,7 @@ module OnebusawaySDK
             def last_update_time=(_)
             end
 
+            # Capacity of the transit vehicle in terms of occupancy.
             sig { returns(Integer) }
             def occupancy_capacity
             end
@@ -381,6 +383,7 @@ module OnebusawaySDK
             def occupancy_capacity=(_)
             end
 
+            # Current count of occupants in the transit vehicle.
             sig { returns(Integer) }
             def occupancy_count
             end
@@ -389,6 +392,7 @@ module OnebusawaySDK
             def occupancy_count=(_)
             end
 
+            # Current occupancy status of the transit vehicle.
             sig { returns(String) }
             def occupancy_status
             end
@@ -397,6 +401,7 @@ module OnebusawaySDK
             def occupancy_status=(_)
             end
 
+            # Current journey phase of the trip.
             sig { returns(String) }
             def phase
             end
@@ -405,6 +410,7 @@ module OnebusawaySDK
             def phase=(_)
             end
 
+            # Indicates if real-time arrival info is available for this trip.
             sig { returns(T::Boolean) }
             def predicted
             end
@@ -413,6 +419,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
@@ -421,6 +428,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
@@ -429,6 +438,7 @@ module OnebusawaySDK
             def service_date=(_)
             end
 
+            # Current status modifiers for the trip.
             sig { returns(String) }
             def status
             end
@@ -437,6 +447,7 @@ module OnebusawaySDK
             def status=(_)
             end
 
+            # Total length of the trip, in meters.
             sig { returns(Float) }
             def total_distance_along_trip
             end
@@ -445,6 +456,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
@@ -453,6 +466,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
@@ -461,6 +475,7 @@ module OnebusawaySDK
             def frequency=(_)
             end
 
+            # Last known location of the transit vehicle.
             sig do
               returns(
                 T.nilable(OnebusawaySDK::Models::TripDetailRetrieveResponse::Data::Entry::Status::LastKnownLocation)
@@ -476,6 +491,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
@@ -484,6 +500,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
@@ -492,6 +509,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
@@ -500,6 +519,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
@@ -508,6 +528,7 @@ module OnebusawaySDK
             def orientation=(_)
             end
 
+            # Current position of the transit vehicle.
             sig { returns(T.nilable(OnebusawaySDK::Models::TripDetailRetrieveResponse::Data::Entry::Status::Position)) }
             def position
             end
@@ -519,6 +540,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
@@ -527,6 +550,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
@@ -535,6 +559,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
@@ -573,9 +598,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:,
@@ -644,6 +669,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
@@ -652,6 +678,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the last known location of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -660,8 +687,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}) }
@@ -670,6 +698,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
@@ -678,6 +707,7 @@ module OnebusawaySDK
               def lat=(_)
               end
 
+              # Longitude of the current position of the transit vehicle.
               sig { returns(T.nilable(Float)) }
               def lon
               end
@@ -686,8 +716,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}) }