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

data/rbi/lib/onebusaway-sdk/resources/stop_ids_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopIDsForAgency
+      # Get stop IDs for a specific agency
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopIDsForAgencyListResponse)
       end
-      def list(agency_id, request_options: {})
+      def list(
+        # ID of the agency
+        agency_id,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/stops_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopsForAgency
+      # Get stops for a specific agency
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopsForAgencyListResponse)
       end
-      def list(agency_id, request_options: {})
+      def list(
+        # ID of the agency
+        agency_id,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/stops_for_location.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopsForLocation
+      # stops-for-location
       sig do
         params(
           lat: Float,
@@ -15,11 +16,23 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopsForLocationListResponse)
       end
-      def list(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, radius: nil, request_options: {})
+      def list(
+        lat:,
+        lon:,
+        # An alternative to radius to set the search bounding box (optional)
+        lat_span: nil,
+        # An alternative to radius to set the search bounding box (optional)
+        lon_span: nil,
+        # A search query string to filter the results
+        query: nil,
+        # The radius in meters to search within
+        radius: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/stops_for_route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class StopsForRoute
+      # Get stops for a specific route
       sig do
         params(
           route_id: String,
@@ -12,11 +13,19 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopsForRouteListResponse)
       end
-      def list(route_id, include_polylines: nil, time: nil, request_options: {})
+      def list(
+        # ID of the route
+        route_id,
+        # Include polyline elements in the response (default true)
+        include_polylines: nil,
+        # Specify service date (YYYY-MM-DD or epoch) (default today)
+        time: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trip.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Trip
+      # Get details of a specific trip
       sig do
         params(
           trip_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::TripRetrieveResponse)
       end
-      def retrieve(trip_id, request_options: {})
+      def retrieve(
+        # ID of the trip
+        trip_id,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trip_details.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripDetails
+      # Retrieve Trip Details
       sig do
         params(
           trip_id: String,
@@ -16,18 +17,27 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::TripDetailRetrieveResponse)
       end
       def retrieve(
+        # ID of the trip to retrieve details for.
         trip_id,
+        # Whether to include the full schedule element in the tripDetails section
+        #   (defaults to true).
         include_schedule: nil,
+        # Whether to include the full status element in the tripDetails section (defaults
+        #   to true).
         include_status: nil,
+        # Whether to include the full trip element in the references section (defaults to
+        #   true).
         include_trip: nil,
+        # Service date for the trip as Unix time in milliseconds (optional).
         service_date: nil,
+        # Time parameter to query the system at a specific time (optional).
         time: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trip_for_vehicle.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripForVehicle
+      # Retrieve trip for a specific vehicle
       sig do
         params(
           vehicle_id: String,
@@ -15,17 +16,25 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::TripForVehicleRetrieveResponse)
       end
       def retrieve(
+        # ID of the vehicle to retrieve trip details for.
         vehicle_id,
+        # Determines whether full <schedule/> element is included in the <tripDetails/>
+        #   section. Defaults to false.
         include_schedule: nil,
+        # Determines whether the full <status/> element is included in the <tripDetails/>
+        #   section. Defaults to true.
         include_status: nil,
+        # Determines whether full <trip/> element is included in the <references/>
+        #   section. Defaults to false.
         include_trip: nil,
+        # Time parameter to query the system at a specific time (optional).
         time: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trips_for_location.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripsForLocation
+      # Retrieve trips for a given location
       sig do
         params(
           lat: Float,
@@ -17,19 +18,28 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::TripsForLocationListResponse)
       end
       def list(
+        # The latitude coordinate of the search center
         lat:,
+        # Latitude span of the search bounding box
         lat_span:,
+        # The longitude coordinate of the search center
         lon:,
+        # Longitude span of the search bounding box
         lon_span:,
+        # Whether to include full schedule elements in the tripDetails section. Defaults
+        #   to false.
         include_schedule: nil,
+        # Whether to include full trip elements in the references section. Defaults to
+        #   false.
         include_trip: nil,
+        # Specific time for the query. Defaults to the current time.
         time: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/trips_for_route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class TripsForRoute
+      # Search for active trips for a specific route.
       sig do
         params(
           route_id: String,
@@ -13,11 +14,22 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::TripsForRouteListResponse)
       end
-      def list(route_id, include_schedule: nil, include_status: nil, time: nil, request_options: {})
+      def list(
+        # The ID of the route.
+        route_id,
+        # Determine whether full schedule elements are included. Defaults to false.
+        include_schedule: nil,
+        # Determine whether full tripStatus elements with real-time information are
+        #   included. Defaults to false.
+        include_status: nil,
+        # Query the system at a specific time. Useful for testing.
+        time: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/resources/vehicles_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class VehiclesForAgency
+      # Get vehicles for a specific agency
       sig do
         params(
           agency_id: String,
@@ -11,11 +12,17 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::VehiclesForAgencyListResponse)
       end
-      def list(agency_id, time: nil, request_options: {})
+      def list(
+        # ID of the agency
+        agency_id,
+        # Specific time for querying the status (timestamp format)
+        time: nil,
+        request_options: {}
+      )
       end
 
-      sig { params(client: OnebusawaySDK::Client).void }
-      def initialize(client:)
+      sig { params(client: OnebusawaySDK::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/onebusaway-sdk/util.rbi

@@ -1,85 +1,121 @@
 # typed: strong
 
 module OnebusawaySDK
+  # @api private
   module Util
+    # @api private
     sig { returns(Float) }
     def self.monotonic_secs
     end
 
-    sig { returns(String) }
-    def self.arch
-    end
+    class << self
+      # @api private
+      sig { returns(String) }
+      def arch
+      end
 
-    sig { returns(String) }
-    def self.os
+      # @api private
+      sig { returns(String) }
+      def os
+      end
     end
 
-    sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
-    def self.primitive?(input)
-    end
+    class << self
+      # @api private
+      sig { params(input: T.anything).returns(T::Boolean) }
+      def primitive?(input)
+      end
 
-    sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
-    def self.coerce_boolean(input)
-    end
+      # @api private
+      sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
+      def coerce_boolean(input)
+      end
 
-    sig { params(input: T.anything).returns(T.nilable(T::Boolean)) }
-    def self.coerce_boolean!(input)
-    end
+      # @api private
+      sig { params(input: T.anything).returns(T.nilable(T::Boolean)) }
+      def coerce_boolean!(input)
+      end
 
-    sig { params(input: T.anything).returns(T.any(Integer, T.anything)) }
-    def self.coerce_integer(input)
-    end
+      # @api private
+      sig { params(input: T.anything).returns(T.any(Integer, T.anything)) }
+      def coerce_integer(input)
+      end
 
-    sig { params(input: T.anything).returns(T.any(Float, T.anything)) }
-    def self.coerce_float(input)
-    end
+      # @api private
+      sig { params(input: T.anything).returns(T.any(Float, T.anything)) }
+      def coerce_float(input)
+      end
 
-    sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) }
-    def self.coerce_hash(input)
+      # @api private
+      sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) }
+      def coerce_hash(input)
+      end
     end
 
     OMIT = T.let(T.anything, T.anything)
 
-    sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) }
-    private_class_method def self.deep_merge_lr(lhs, rhs, concat: false)
-    end
+    class << self
+      # @api private
+      sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) }
+      private def deep_merge_lr(lhs, rhs, concat: false)
+      end
 
-    sig do
-      params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean)
-        .returns(T.anything)
-    end
-    def self.deep_merge(*values, sentinel: nil, concat: false)
-    end
-
-    sig do
-      params(
-        data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything),
-        pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
-        sentinel: T.nilable(T.anything),
-        blk: T.nilable(T.proc.returns(T.anything))
+      # @api private
+      #
+      # Recursively merge one hash with another. If the values at a given key are not
+      #   both hashes, just take the new value.
+      sig do
+        params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean)
+          .returns(T.anything)
+      end
+      def deep_merge(
+        *values,
+        # the value to return if no values are provided.
+        sentinel: nil,
+        # whether to merge sequences by concatenation.
+        concat: false
       )
-        .returns(T.nilable(T.anything))
-    end
-    def self.dig(data, pick, sentinel = nil, &blk)
-    end
+      end
 
-    sig { params(uri: URI::Generic).returns(String) }
-    def self.uri_origin(uri)
+      # @api private
+      sig do
+        params(
+          data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything),
+          pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
+          sentinel: T.nilable(T.anything),
+          blk: T.nilable(T.proc.returns(T.anything))
+        )
+          .returns(T.nilable(T.anything))
+      end
+      def dig(data, pick, sentinel = nil, &blk)
+      end
     end
 
-    sig { params(path: T.any(String, T::Array[String])).returns(String) }
-    def self.interpolate_path(path)
-    end
+    class << self
+      # @api private
+      sig { params(uri: URI::Generic).returns(String) }
+      def uri_origin(uri)
+      end
 
-    sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) }
-    def self.decode_query(query)
+      # @api private
+      sig { params(path: T.any(String, T::Array[String])).returns(String) }
+      def interpolate_path(path)
+      end
     end
 
-    sig do
-      params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
-        .returns(T.nilable(String))
-    end
-    def self.encode_query(query)
+    class << self
+      # @api private
+      sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) }
+      def decode_query(query)
+      end
+
+      # @api private
+      sig do
+        params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
+          .returns(T.nilable(String))
+      end
+      def encode_query(query)
+      end
     end
 
     ParsedUriShape = T.type_alias do
@@ -92,48 +128,143 @@ module OnebusawaySDK
       }
     end
 
-    sig { params(url: T.any(URI::Generic, String)).returns(OnebusawaySDK::Util::ParsedUriShape) }
-    def self.parse_uri(url)
-    end
+    class << self
+      # @api private
+      sig { params(url: T.any(URI::Generic, String)).returns(OnebusawaySDK::Util::ParsedUriShape) }
+      def parse_uri(url)
+      end
 
-    sig { params(parsed: OnebusawaySDK::Util::ParsedUriShape).returns(URI::Generic) }
-    def self.unparse_uri(parsed)
-    end
+      # @api private
+      sig { params(parsed: OnebusawaySDK::Util::ParsedUriShape).returns(URI::Generic) }
+      def unparse_uri(parsed)
+      end
 
-    sig do
-      params(lhs: OnebusawaySDK::Util::ParsedUriShape, rhs: OnebusawaySDK::Util::ParsedUriShape)
-        .returns(URI::Generic)
+      # @api private
+      sig do
+        params(lhs: OnebusawaySDK::Util::ParsedUriShape, rhs: OnebusawaySDK::Util::ParsedUriShape)
+          .returns(URI::Generic)
+      end
+      def join_parsed_uri(lhs, rhs)
+      end
     end
-    def self.join_parsed_uri(lhs, rhs)
+
+    class << self
+      # @api private
+      sig do
+        params(
+          headers: T::Hash[String,
+                           T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))]
+        )
+          .returns(T::Hash[String, String])
+      end
+      def normalized_headers(*headers)
+      end
     end
 
-    sig do
-      params(
-        headers: T::Hash[String,
-                         T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))]
-      )
-        .returns(T::Hash[String, String])
+    # @api private
+    #
+    # An adapter that satisfies the IO interface required by `::IO.copy_stream`
+    class ReadIOAdapter
+      # @api private
+      sig { params(max_len: T.nilable(Integer)).returns(String) }
+      private def read_enum(max_len)
+      end
+
+      # @api private
+      sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) }
+      def read(max_len = nil, out_string = nil)
+      end
+
+      # @api private
+      sig do
+        params(
+          stream: T.any(String, IO, StringIO, T::Enumerable[String]),
+          blk: T.proc.params(arg0: String).void
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(stream, &blk)
+      end
     end
-    def self.normalized_headers(*headers)
+
+    class << self
+      sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) }
+      def string_io(&blk)
+      end
     end
 
-    sig { params(io: StringIO, boundary: String, key: T.any(Symbol, String), val: T.anything).void }
-    private_class_method def self.encode_multipart_formdata(io, boundary:, key:, val:)
+    class << self
+      # @api private
+      sig do
+        params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void
+      end
+      private def encode_multipart_formdata(y, boundary:, key:, val:)
+      end
+
+      # @api private
+      sig { params(body: T.anything).returns([String, T::Enumerable[String]]) }
+      private def encode_multipart_streaming(body)
+      end
+
+      # @api private
+      sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
+      def encode_content(headers, body)
+      end
+
+      # @api private
+      sig do
+        params(
+          headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+          stream: T::Enumerable[String],
+          suppress_error: T::Boolean
+        )
+          .returns(T.anything)
+      end
+      def decode_content(headers, stream:, suppress_error: false)
+      end
     end
 
-    sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
-    def self.encode_content(headers, body)
+    class << self
+      # @api private
+      #
+      # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
+      sig do
+        params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void)
+          .returns(T::Enumerable[T.anything])
+      end
+      def fused_enum(enum, external: false, &close)
+      end
+
+      # @api private
+      sig { params(enum: T.nilable(T::Enumerable[T.anything])).void }
+      def close_fused!(enum)
+      end
+
+      # @api private
+      sig do
+        params(enum: T.nilable(T::Enumerable[T.anything]), blk: T.proc.params(arg0: Enumerator::Yielder).void)
+          .returns(T::Enumerable[T.anything])
+      end
+      def chain_fused(enum, &blk)
+      end
     end
 
-    sig do
-      params(
-        headers: T.any(T::Hash[String, String], Net::HTTPHeader),
-        stream: T::Enumerable[String],
-        suppress_error: T::Boolean
-      )
-        .returns(T.anything)
+    ServerSentEvent = T.type_alias do
+      {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)}
     end
-    def self.decode_content(headers, stream:, suppress_error: false)
+
+    class << self
+      # @api private
+      sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) }
+      def decode_lines(enum)
+      end
+
+      # @api private
+      #
+      # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+      sig { params(lines: T::Enumerable[String]).returns(OnebusawaySDK::Util::ServerSentEvent) }
+      def decode_sse(lines)
+      end
     end
   end
 end

data/rbi/lib/onebusaway-sdk/version.rbi

@@ -1,5 +1,5 @@
 # typed: strong
 
 module OnebusawaySDK
-  VERSION = "0.1.0-alpha.205"
+  VERSION = "0.1.0-alpha.207"
 end