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

data/lib/onebusaway_sdk/resources/arrival_and_departure.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ArrivalAndDeparture
+      # arrival-and-departure-for-stop
+      #
+      # @overload retrieve(stop_id, service_date:, trip_id:, stop_sequence: nil, time: nil, vehicle_id: nil, request_options: {})
+      #
+      # @param stop_id [String]
+      # @param service_date [Integer]
+      # @param trip_id [String]
+      # @param stop_sequence [Integer]
+      # @param time [Integer]
+      # @param vehicle_id [String]
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse]
+      #
+      # @see OnebusawaySDK::Models::ArrivalAndDepartureRetrieveParams
+      def retrieve(stop_id, params)
+        parsed, options = OnebusawaySDK::ArrivalAndDepartureRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/arrival-and-departure-for-stop/%1$s.json", stop_id],
+          query: parsed.transform_keys(
+            service_date: "serviceDate",
+            trip_id: "tripId",
+            stop_sequence: "stopSequence",
+            vehicle_id: "vehicleId"
+          ),
+          model: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse,
+          options: options
+        )
+      end
+
+      # arrivals-and-departures-for-stop
+      #
+      # @overload list(stop_id, minutes_after: nil, minutes_before: nil, time: nil, request_options: {})
+      #
+      # @param stop_id [String]
+      #
+      # @param minutes_after [Integer] Include vehicles arriving or departing in the next n minutes.
+      #
+      # @param minutes_before [Integer] Include vehicles having arrived or departed in the previous n minutes.
+      #
+      # @param time [Time] The specific time for querying the system status.
+      #
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OnebusawaySDK::Models::ArrivalAndDepartureListResponse]
+      #
+      # @see OnebusawaySDK::Models::ArrivalAndDepartureListParams
+      def list(stop_id, params = {})
+        parsed, options = OnebusawaySDK::ArrivalAndDepartureListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/arrivals-and-departures-for-stop/%1$s.json", stop_id],
+          query: parsed.transform_keys(minutes_after: "minutesAfter", minutes_before: "minutesBefore"),
+          model: OnebusawaySDK::Models::ArrivalAndDepartureListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OnebusawaySDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/block.rb

@@ -5,25 +5,27 @@ module OnebusawaySDK
     class Block
       # Get details of a specific block by ID
       #
-      # @param block_id [String] ID of the block
+      # @overload retrieve(block_id, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::BlockRetrieveParams, Hash{Symbol=>Object}] .
+      # @param block_id [String] ID of the block
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::BlockRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::BlockRetrieveParams
       def retrieve(block_id, params = {})
         @client.request(
           method: :get,
-          path: ["api/where/block/%0s.json", block_id],
+          path: ["api/where/block/%1$s.json", block_id],
           model: OnebusawaySDK::Models::BlockRetrieveResponse,
           options: params[:request_options]
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/config.rb

@@ -5,12 +5,13 @@ module OnebusawaySDK
     class Config
       # config
       #
-      # @param params [OnebusawaySDK::Models::ConfigRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(request_options: {})
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::ConfigRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::ConfigRetrieveParams
       def retrieve(params = {})
         @client.request(
           method: :get,
@@ -20,8 +21,9 @@ module OnebusawaySDK
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/current_time.rb

@@ -5,12 +5,13 @@ module OnebusawaySDK
     class CurrentTime
       # current-time
       #
-      # @param params [OnebusawaySDK::Models::CurrentTimeRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(request_options: {})
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::CurrentTimeRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::CurrentTimeRetrieveParams
       def retrieve(params = {})
         @client.request(
           method: :get,
@@ -20,8 +21,9 @@ module OnebusawaySDK
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway_sdk/resources/report_problem_with_stop.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ReportProblemWithStop
+      # Submit a user-generated problem report for a stop
+      #
+      # @overload retrieve(stop_id, code: nil, user_comment: nil, user_lat: nil, user_location_accuracy: nil, user_lon: nil, request_options: {})
+      #
+      # @param stop_id [String] The ID of the stop
+      #
+      # @param code [Symbol, OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code] A string code identifying the nature of the problem
+      #
+      # @param user_comment [String] Additional comment text supplied by the user describing the problem
+      #
+      # @param user_lat [Float] The reporting user’s current latitude
+      #
+      # @param user_location_accuracy [Float] The reporting user’s location accuracy, in meters
+      #
+      # @param user_lon [Float] The reporting user’s current longitude
+      #
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OnebusawaySDK::ResponseWrapper]
+      #
+      # @see OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams
+      def retrieve(stop_id, params = {})
+        parsed, options = OnebusawaySDK::ReportProblemWithStopRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/report-problem-with-stop/%1$s.json", stop_id],
+          query: parsed.transform_keys(
+            user_comment: "userComment",
+            user_lat: "userLat",
+            user_location_accuracy: "userLocationAccuracy",
+            user_lon: "userLon"
+          ),
+          model: OnebusawaySDK::ResponseWrapper,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OnebusawaySDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/resources/report_problem_with_trip.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class ReportProblemWithTrip
+      # Submit a user-generated problem report for a particular trip.
+      #
+      # @overload retrieve(trip_id, code: nil, service_date: nil, stop_id: nil, user_comment: nil, user_lat: nil, user_location_accuracy: nil, user_lon: nil, user_on_vehicle: nil, user_vehicle_number: nil, vehicle_id: nil, request_options: {})
+      #
+      # @param trip_id [String] The ID of the trip
+      #
+      # @param code [Symbol, OnebusawaySDK::ReportProblemWithTripRetrieveParams::Code] A string code identifying the nature of the problem
+      #
+      # @param service_date [Integer] The service date of the trip
+      #
+      # @param stop_id [String] A stop ID indicating where the user is experiencing the problem
+      #
+      # @param user_comment [String] Additional comment text supplied by the user describing the problem
+      #
+      # @param user_lat [Float] The reporting user’s current latitude
+      #
+      # @param user_location_accuracy [Float] The reporting user’s location accuracy, in meters
+      #
+      # @param user_lon [Float] The reporting user’s current longitude
+      #
+      # @param user_on_vehicle [Boolean] Indicator if the user is on the transit vehicle experiencing the problem
+      #
+      # @param user_vehicle_number [String] The vehicle number, as reported by the user
+      #
+      # @param vehicle_id [String] The vehicle actively serving the trip
+      #
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OnebusawaySDK::ResponseWrapper]
+      #
+      # @see OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams
+      def retrieve(trip_id, params = {})
+        parsed, options = OnebusawaySDK::ReportProblemWithTripRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/where/report-problem-with-trip/%1$s.json", trip_id],
+          query: parsed.transform_keys(
+            service_date: "serviceDate",
+            stop_id: "stopID",
+            user_comment: "userComment",
+            user_lat: "userLat",
+            user_location_accuracy: "userLocationAccuracy",
+            user_lon: "userLon",
+            user_on_vehicle: "userOnVehicle",
+            user_vehicle_number: "userVehicleNumber",
+            vehicle_id: "vehicleID"
+          ),
+          model: OnebusawaySDK::ResponseWrapper,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OnebusawaySDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/route.rb

@@ -5,25 +5,27 @@ module OnebusawaySDK
     class Route
       # Retrieve information for a specific route identified by its unique ID.
       #
-      # @param route_id [String] The ID of the route.
+      # @overload retrieve(route_id, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::RouteRetrieveParams, Hash{Symbol=>Object}] .
+      # @param route_id [String] The ID of the route.
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::RouteRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::RouteRetrieveParams
       def retrieve(route_id, params = {})
         @client.request(
           method: :get,
-          path: ["api/where/route/%0s.json", route_id],
+          path: ["api/where/route/%1$s.json", route_id],
           model: OnebusawaySDK::Models::RouteRetrieveResponse,
           options: params[:request_options]
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/route_ids_for_agency.rb

@@ -5,25 +5,27 @@ module OnebusawaySDK
     class RouteIDsForAgency
       # Get route IDs for a specific agency
       #
-      # @param agency_id [String] ID of the agency
+      # @overload list(agency_id, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::RouteIDsForAgencyListParams, Hash{Symbol=>Object}] .
+      # @param agency_id [String] ID of the agency
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::RouteIDsForAgencyListResponse]
       #
+      # @see OnebusawaySDK::Models::RouteIDsForAgencyListParams
       def list(agency_id, params = {})
         @client.request(
           method: :get,
-          path: ["api/where/route-ids-for-agency/%0s.json", agency_id],
+          path: ["api/where/route-ids-for-agency/%1$s.json", agency_id],
           model: OnebusawaySDK::Models::RouteIDsForAgencyListResponse,
           options: params[:request_options]
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/routes_for_agency.rb

@@ -5,25 +5,27 @@ module OnebusawaySDK
     class RoutesForAgency
       # Retrieve the list of all routes for a particular agency by id
       #
-      # @param agency_id [String] The id of the agency
+      # @overload list(agency_id, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::RoutesForAgencyListParams, Hash{Symbol=>Object}] .
+      # @param agency_id [String] The id of the agency
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::RoutesForAgencyListResponse]
       #
+      # @see OnebusawaySDK::Models::RoutesForAgencyListParams
       def list(agency_id, params = {})
         @client.request(
           method: :get,
-          path: ["api/where/routes-for-agency/%0s.json", agency_id],
+          path: ["api/where/routes-for-agency/%1$s.json", agency_id],
           model: OnebusawaySDK::Models::RoutesForAgencyListResponse,
           options: params[:request_options]
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/onebusaway_sdk/resources/routes_for_location.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Resources
+    class RoutesForLocation
+      # routes-for-location
+      #
+      # @overload list(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, radius: nil, request_options: {})
+      #
+      # @param lat [Float]
+      # @param lon [Float]
+      # @param lat_span [Float]
+      # @param lon_span [Float]
+      # @param query [String]
+      # @param radius [Float]
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OnebusawaySDK::Models::RoutesForLocationListResponse]
+      #
+      # @see OnebusawaySDK::Models::RoutesForLocationListParams
+      def list(params)
+        parsed, options = OnebusawaySDK::RoutesForLocationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/where/routes-for-location.json",
+          query: parsed.transform_keys(lat_span: "latSpan", lon_span: "lonSpan"),
+          model: OnebusawaySDK::Models::RoutesForLocationListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OnebusawaySDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/schedule_for_route.rb

@@ -3,32 +3,36 @@
 module OnebusawaySDK
   module Resources
     class ScheduleForRoute
+      # Some parameter documentations has been truncated, see
+      # {OnebusawaySDK::Models::ScheduleForRouteRetrieveParams} for more details.
+      #
       # Retrieve the full schedule for a route on a particular day
       #
-      # @param route_id [String] The route id to request the schedule for
+      # @overload retrieve(route_id, date: nil, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::ScheduleForRouteRetrieveParams, Hash{Symbol=>Object}] .
+      # @param route_id [String] The route id to request the schedule for
       #
-      #   @option params [Date] :date The date for which you want to request a schedule in the format YYYY-MM-DD
-      #     (optional, defaults to current date)
+      # @param date [Date] The date for which you want to request a schedule in the format YYYY-MM-DD (opti
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::ScheduleForRouteRetrieveParams
       def retrieve(route_id, params = {})
-        parsed, options = OnebusawaySDK::Models::ScheduleForRouteRetrieveParams.dump_request(params)
+        parsed, options = OnebusawaySDK::ScheduleForRouteRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["api/where/schedule-for-route/%0s.json", route_id],
+          path: ["api/where/schedule-for-route/%1$s.json", route_id],
           query: parsed,
           model: OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse,
           options: options
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/schedule_for_stop.rb

@@ -3,32 +3,36 @@
 module OnebusawaySDK
   module Resources
     class ScheduleForStop
+      # Some parameter documentations has been truncated, see
+      # {OnebusawaySDK::Models::ScheduleForStopRetrieveParams} for more details.
+      #
       # Get schedule for a specific stop
       #
-      # @param stop_id [String] The stop id to request the schedule for, encoded directly in the URL
+      # @overload retrieve(stop_id, date: nil, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::ScheduleForStopRetrieveParams, Hash{Symbol=>Object}] .
+      # @param stop_id [String] The stop id to request the schedule for, encoded directly in the URL
       #
-      #   @option params [Date] :date The date for which you want to request a schedule in the format YYYY-MM-DD
-      #     (optional, defaults to the current date)
+      # @param date [Date] The date for which you want to request a schedule in the format YYYY-MM-DD (opti
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::ScheduleForStopRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::ScheduleForStopRetrieveParams
       def retrieve(stop_id, params = {})
-        parsed, options = OnebusawaySDK::Models::ScheduleForStopRetrieveParams.dump_request(params)
+        parsed, options = OnebusawaySDK::ScheduleForStopRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["api/where/schedule-for-stop/%0s.json", stop_id],
+          path: ["api/where/schedule-for-stop/%1$s.json", stop_id],
           query: parsed,
           model: OnebusawaySDK::Models::ScheduleForStopRetrieveResponse,
           options: options
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/search_for_route.rb

@@ -5,29 +5,31 @@ module OnebusawaySDK
     class SearchForRoute
       # Search for a route based on its name.
       #
-      # @param params [OnebusawaySDK::Models::SearchForRouteListParams, Hash{Symbol=>Object}] .
+      # @overload list(input:, max_count: nil, request_options: {})
       #
-      #   @option params [String] :input The string to search for.
+      # @param input [String] The string to search for.
       #
-      #   @option params [Integer] :max_count The max number of results to return. Defaults to 20.
+      # @param max_count [Integer] The max number of results to return. Defaults to 20.
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::SearchForRouteListResponse]
       #
+      # @see OnebusawaySDK::Models::SearchForRouteListParams
       def list(params)
-        parsed, options = OnebusawaySDK::Models::SearchForRouteListParams.dump_request(params)
+        parsed, options = OnebusawaySDK::SearchForRouteListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/where/search/route.json",
-          query: parsed,
+          query: parsed.transform_keys(max_count: "maxCount"),
           model: OnebusawaySDK::Models::SearchForRouteListResponse,
           options: options
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/search_for_stop.rb

@@ -5,29 +5,31 @@ module OnebusawaySDK
     class SearchForStop
       # Search for a stop based on its name.
       #
-      # @param params [OnebusawaySDK::Models::SearchForStopListParams, Hash{Symbol=>Object}] .
+      # @overload list(input:, max_count: nil, request_options: {})
       #
-      #   @option params [String] :input The string to search for.
+      # @param input [String] The string to search for.
       #
-      #   @option params [Integer] :max_count The max number of results to return. Defaults to 20.
+      # @param max_count [Integer] The max number of results to return. Defaults to 20.
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::SearchForStopListResponse]
       #
+      # @see OnebusawaySDK::Models::SearchForStopListParams
       def list(params)
-        parsed, options = OnebusawaySDK::Models::SearchForStopListParams.dump_request(params)
+        parsed, options = OnebusawaySDK::SearchForStopListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/where/search/stop.json",
-          query: parsed,
+          query: parsed.transform_keys(max_count: "maxCount"),
           model: OnebusawaySDK::Models::SearchForStopListResponse,
           options: options
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/shape.rb

@@ -5,25 +5,27 @@ module OnebusawaySDK
     class Shape
       # Retrieve a shape (the path traveled by a transit vehicle) by ID.
       #
-      # @param shape_id [String] The shape ID, encoded directly in the URL
+      # @overload retrieve(shape_id, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::ShapeRetrieveParams, Hash{Symbol=>Object}] .
+      # @param shape_id [String] The shape ID, encoded directly in the URL
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::ShapeRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::ShapeRetrieveParams
       def retrieve(shape_id, params = {})
         @client.request(
           method: :get,
-          path: ["api/where/shape/%0s.json", shape_id],
+          path: ["api/where/shape/%1$s.json", shape_id],
           model: OnebusawaySDK::Models::ShapeRetrieveResponse,
           options: params[:request_options]
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end

data/lib/{onebusaway-sdk → onebusaway_sdk}/resources/stop.rb

@@ -5,25 +5,27 @@ module OnebusawaySDK
     class Stop
       # Get details of a specific stop
       #
-      # @param stop_id [String] ID of the stop
+      # @overload retrieve(stop_id, request_options: {})
       #
-      # @param params [OnebusawaySDK::Models::StopRetrieveParams, Hash{Symbol=>Object}] .
+      # @param stop_id [String] ID of the stop
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::StopRetrieveResponse]
       #
+      # @see OnebusawaySDK::Models::StopRetrieveParams
       def retrieve(stop_id, params = {})
         @client.request(
           method: :get,
-          path: ["api/where/stop/%0s.json", stop_id],
+          path: ["api/where/stop/%1$s.json", stop_id],
           model: OnebusawaySDK::Models::StopRetrieveResponse,
           options: params[:request_options]
         )
       end
 
-      # @param client [OnebusawaySDK::Client]
+      # @api private
       #
+      # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client
       end