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

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

@@ -1,36 +1,51 @@
 # typed: strong
 
 module OnebusawaySDK
+  # @api private
   class PooledNetRequester
     RequestShape = T.type_alias do
       {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float}
     end
 
-    sig { params(url: URI::Generic).returns(Net::HTTP) }
-    def self.connect(url)
-    end
+    class << self
+      # @api private
+      sig { params(url: URI::Generic).returns(Net::HTTP) }
+      def connect(url)
+      end
 
-    sig { params(conn: Net::HTTP, deadline: Float).void }
-    def self.calibrate_socket_timeout(conn, deadline)
-    end
+      # @api private
+      sig { params(conn: Net::HTTP, deadline: Float).void }
+      def calibrate_socket_timeout(conn, deadline)
+      end
 
-    sig { params(request: OnebusawaySDK::PooledNetRequester::RequestShape).returns(Net::HTTPGenericRequest) }
-    def self.build_request(request)
+      # @api private
+      sig do
+        params(
+          request: OnebusawaySDK::PooledNetRequester::RequestShape,
+          blk: T.proc.params(arg0: String).void
+        )
+          .returns(Net::HTTPGenericRequest)
+      end
+      def build_request(request, &blk)
+      end
     end
 
-    sig { params(url: URI::Generic, blk: T.proc.params(arg0: Net::HTTP).void).void }
-    private def with_pool(url, &blk)
+    # @api private
+    sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void }
+    private def with_pool(url, deadline:, &blk)
     end
 
+    # @api private
     sig do
       params(request: OnebusawaySDK::PooledNetRequester::RequestShape)
-        .returns([Net::HTTPResponse, T::Enumerable[String]])
+        .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
     end
     def execute(request)
     end
 
-    sig { void }
-    def initialize
+    # @api private
+    sig { params(size: Integer).returns(T.attached_class) }
+    def self.new(size: Etc.nprocessors)
     end
   end
 end

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

@@ -1,9 +1,9 @@
 # typed: strong
 
 module OnebusawaySDK
+  # @api private
   module RequestParameters
-    abstract!
-
+    # Options to specify HTTP behaviour for this request.
     sig { returns(T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])) }
     def request_options
     end
@@ -15,18 +15,28 @@ module OnebusawaySDK
     def request_options=(_)
     end
 
+    # @api private
     module Converter
+      # @api private
       sig { params(params: T.anything).returns([T.anything, T::Hash[Symbol, T.anything]]) }
       def dump_request(params)
       end
     end
   end
 
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  #   or override those provided at the client level.
+  #
+  #   When making a request, you can pass an actual {RequestOptions} instance, or
+  #   simply pass a Hash with symbol keys matching the attributes on this class.
   class RequestOptions < OnebusawaySDK::BaseModel
+    # @api private
     sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
     def self.validate!(opts)
     end
 
+    # Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
     sig { returns(T.nilable(String)) }
     def idempotency_key
     end
@@ -35,6 +45,8 @@ module OnebusawaySDK
     def idempotency_key=(_)
     end
 
+    # Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
     sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
     def extra_query
     end
@@ -46,6 +58,8 @@ module OnebusawaySDK
     def extra_query=(_)
     end
 
+    # Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
     sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
     def extra_headers
     end
@@ -57,6 +71,8 @@ module OnebusawaySDK
     def extra_headers=(_)
     end
 
+    # Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
     sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
     def extra_body
     end
@@ -65,6 +81,7 @@ module OnebusawaySDK
     def extra_body=(_)
     end
 
+    # Maximum number of retries to attempt after a failed initial request.
     sig { returns(T.nilable(Integer)) }
     def max_retries
     end
@@ -73,6 +90,7 @@ module OnebusawaySDK
     def max_retries=(_)
     end
 
+    # Request timeout in seconds.
     sig { returns(T.nilable(Float)) }
     def timeout
     end
@@ -80,5 +98,10 @@ module OnebusawaySDK
     sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) }
     def timeout=(_)
     end
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
+    def self.new(values = {})
+    end
   end
 end

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

@@ -3,6 +3,8 @@
 module OnebusawaySDK
   module Resources
     class AgenciesWithCoverage
+      # Returns a list of all transit agencies currently supported by OneBusAway along
+      #   with the center of their coverage area.
       sig do
         params(request_options: T.nilable(T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])))
           .returns(OnebusawaySDK::Models::AgenciesWithCoverageListResponse)
@@ -10,8 +12,8 @@ module OnebusawaySDK
       def list(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/agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Agency
+      # Retrieve information for a specific transit agency identified by its unique ID.
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::AgencyRetrieveResponse)
       end
-      def retrieve(agency_id, request_options: {})
+      def retrieve(
+        # The ID of the transit 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/arrival_and_departure.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class ArrivalAndDeparture
+      # arrival-and-departure-for-stop
       sig do
         params(
           stop_id: String,
@@ -26,6 +27,7 @@ module OnebusawaySDK
       )
       end
 
+      # arrivals-and-departures-for-stop
       sig do
         params(
           stop_id: String,
@@ -36,11 +38,20 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::ArrivalAndDepartureListResponse)
       end
-      def list(stop_id, minutes_after: nil, minutes_before: nil, time: nil, request_options: {})
+      def list(
+        stop_id,
+        # Include vehicles arriving or departing in the next n minutes.
+        minutes_after: nil,
+        # Include vehicles having arrived or departed in the previous n minutes.
+        minutes_before: nil,
+        # The specific time for querying the system status.
+        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/block.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Block
+      # Get details of a specific block by ID
       sig do
         params(
           block_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::BlockRetrieveResponse)
       end
-      def retrieve(block_id, request_options: {})
+      def retrieve(
+        # ID of the block
+        block_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/config.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Config
+      # config
       sig do
         params(request_options: T.nilable(T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])))
           .returns(OnebusawaySDK::Models::ConfigRetrieveResponse)
@@ -10,8 +11,8 @@ module OnebusawaySDK
       def retrieve(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/current_time.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class CurrentTime
+      # current-time
       sig do
         params(request_options: T.nilable(T.any(OnebusawaySDK::RequestOptions, T::Hash[Symbol, T.anything])))
           .returns(OnebusawaySDK::Models::CurrentTimeRetrieveResponse)
@@ -10,8 +11,8 @@ module OnebusawaySDK
       def retrieve(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/report_problem_with_stop.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class ReportProblemWithStop
+      # Submit a user-generated problem report for a stop
       sig do
         params(
           stop_id: String,
@@ -16,18 +17,24 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::ResponseWrapper)
       end
       def retrieve(
+        # The ID of the stop
         stop_id,
+        # A string code identifying the nature of the problem
         code: nil,
+        # Additional comment text supplied by the user describing the problem
         user_comment: nil,
+        # The reporting user’s current latitude
         user_lat: nil,
+        # The reporting user’s location accuracy, in meters
         user_location_accuracy: nil,
+        # The reporting user’s current longitude
         user_lon: 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/report_problem_with_trip.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class ReportProblemWithTrip
+      # Submit a user-generated problem report for a particular trip.
       sig do
         params(
           trip_id: String,
@@ -21,23 +22,34 @@ module OnebusawaySDK
           .returns(OnebusawaySDK::Models::ResponseWrapper)
       end
       def retrieve(
+        # The ID of the trip
         trip_id,
+        # A string code identifying the nature of the problem
         code: nil,
+        # The service date of the trip
         service_date: nil,
+        # A stop ID indicating where the user is experiencing the problem
         stop_id: nil,
+        # Additional comment text supplied by the user describing the problem
         user_comment: nil,
+        # The reporting user’s current latitude
         user_lat: nil,
+        # The reporting user’s location accuracy, in meters
         user_location_accuracy: nil,
+        # The reporting user’s current longitude
         user_lon: nil,
+        # Indicator if the user is on the transit vehicle experiencing the problem
         user_on_vehicle: nil,
+        # The vehicle number, as reported by the user
         user_vehicle_number: nil,
+        # The vehicle actively serving the trip
         vehicle_id: 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/route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Route
+      # Retrieve information for a specific route identified by its unique ID.
       sig do
         params(
           route_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::RouteRetrieveResponse)
       end
-      def retrieve(route_id, request_options: {})
+      def retrieve(
+        # The ID of the route.
+        route_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/route_ids_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class RouteIDsForAgency
+      # Get route IDs for a specific agency
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::RouteIDsForAgencyListResponse)
       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/routes_for_agency.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class RoutesForAgency
+      # Retrieve the list of all routes for a particular agency by id
       sig do
         params(
           agency_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::RoutesForAgencyListResponse)
       end
-      def list(agency_id, request_options: {})
+      def list(
+        # The 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/routes_for_location.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class RoutesForLocation
+      # routes-for-location
       sig do
         params(
           lat: Float,
@@ -18,8 +19,8 @@ module OnebusawaySDK
       def list(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, 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/schedule_for_route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class ScheduleForRoute
+      # Retrieve the full schedule for a route on a particular day
       sig do
         params(
           route_id: String,
@@ -11,11 +12,18 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse)
       end
-      def retrieve(route_id, date: nil, request_options: {})
+      def retrieve(
+        # The route id to request the schedule for
+        route_id,
+        # The date for which you want to request a schedule in the format YYYY-MM-DD
+        #   (optional, defaults to current date)
+        date: 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/schedule_for_stop.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class ScheduleForStop
+      # Get schedule for a specific stop
       sig do
         params(
           stop_id: String,
@@ -11,11 +12,18 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::ScheduleForStopRetrieveResponse)
       end
-      def retrieve(stop_id, date: nil, request_options: {})
+      def retrieve(
+        # The stop id to request the schedule for, encoded directly in the URL
+        stop_id,
+        # The date for which you want to request a schedule in the format YYYY-MM-DD
+        #   (optional, defaults to the current date)
+        date: 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/search_for_route.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class SearchForRoute
+      # Search for a route based on its name.
       sig do
         params(
           input: String,
@@ -11,11 +12,17 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::SearchForRouteListResponse)
       end
-      def list(input:, max_count: nil, request_options: {})
+      def list(
+        # The string to search for.
+        input:,
+        # The max number of results to return. Defaults to 20.
+        max_count: 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/search_for_stop.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class SearchForStop
+      # Search for a stop based on its name.
       sig do
         params(
           input: String,
@@ -11,11 +12,17 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::SearchForStopListResponse)
       end
-      def list(input:, max_count: nil, request_options: {})
+      def list(
+        # The string to search for.
+        input:,
+        # The max number of results to return. Defaults to 20.
+        max_count: 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/shape.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Shape
+      # Retrieve a shape (the path traveled by a transit vehicle) by ID.
       sig do
         params(
           shape_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::ShapeRetrieveResponse)
       end
-      def retrieve(shape_id, request_options: {})
+      def retrieve(
+        # The shape ID, encoded directly in the URL
+        shape_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/stop.rbi

@@ -3,6 +3,7 @@
 module OnebusawaySDK
   module Resources
     class Stop
+      # Get details of a specific stop
       sig do
         params(
           stop_id: String,
@@ -10,11 +11,15 @@ module OnebusawaySDK
         )
           .returns(OnebusawaySDK::Models::StopRetrieveResponse)
       end
-      def retrieve(stop_id, request_options: {})
+      def retrieve(
+        # ID of the stop
+        stop_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