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

data/lib/onebusaway_sdk/models/vehicles_for_agency_list_response.rb

@@ -0,0 +1,404 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::VehiclesForAgency#list
+    class VehiclesForAgencyListResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data]
+
+      class Data < OnebusawaySDK::Internal::Type::BaseModel
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::Internal::Type::Boolean, api_name: :limitExceeded
+
+        # @!attribute list
+        #
+        #   @return [Array<OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List>]
+        required :list,
+                 -> { OnebusawaySDK::Internal::Type::ArrayOf[OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List] }
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::References]
+        required :references, -> { OnebusawaySDK::References }
+
+        # @!method initialize(limit_exceeded:, list:, references:)
+        #   @param limit_exceeded [Boolean]
+        #   @param list [Array<OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List>]
+        #   @param references [OnebusawaySDK::References]
+
+        class List < OnebusawaySDK::Internal::Type::BaseModel
+          # @!attribute last_location_update_time
+          #
+          #   @return [Integer]
+          required :last_location_update_time, Integer, api_name: :lastLocationUpdateTime
+
+          # @!attribute last_update_time
+          #
+          #   @return [Integer]
+          required :last_update_time, Integer, api_name: :lastUpdateTime
+
+          # @!attribute location
+          #
+          #   @return [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::Location]
+          required :location, -> { OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::Location }
+
+          # @!attribute trip_id
+          #
+          #   @return [String]
+          required :trip_id, String, api_name: :tripId
+
+          # @!attribute trip_status
+          #
+          #   @return [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus]
+          required :trip_status,
+                   -> { OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus },
+                   api_name: :tripStatus
+
+          # @!attribute vehicle_id
+          #
+          #   @return [String]
+          required :vehicle_id, String, api_name: :vehicleId
+
+          # @!attribute occupancy_capacity
+          #
+          #   @return [Integer, nil]
+          optional :occupancy_capacity, Integer, api_name: :occupancyCapacity
+
+          # @!attribute occupancy_count
+          #
+          #   @return [Integer, nil]
+          optional :occupancy_count, Integer, api_name: :occupancyCount
+
+          # @!attribute occupancy_status
+          #
+          #   @return [String, nil]
+          optional :occupancy_status, String, api_name: :occupancyStatus
+
+          # @!attribute phase
+          #
+          #   @return [String, nil]
+          optional :phase, String
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!method initialize(last_location_update_time:, last_update_time:, location:, trip_id:, trip_status:, vehicle_id:, occupancy_capacity: nil, occupancy_count: nil, occupancy_status: nil, phase: nil, status: nil)
+          #   @param last_location_update_time [Integer]
+          #   @param last_update_time [Integer]
+          #   @param location [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::Location]
+          #   @param trip_id [String]
+          #   @param trip_status [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus]
+          #   @param vehicle_id [String]
+          #   @param occupancy_capacity [Integer]
+          #   @param occupancy_count [Integer]
+          #   @param occupancy_status [String]
+          #   @param phase [String]
+          #   @param status [String]
+
+          # @see OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List#location
+          class Location < OnebusawaySDK::Internal::Type::BaseModel
+            # @!attribute lat
+            #
+            #   @return [Float, nil]
+            optional :lat, Float
+
+            # @!attribute lon
+            #
+            #   @return [Float, nil]
+            optional :lon, Float
+
+            # @!method initialize(lat: nil, lon: nil)
+            #   @param lat [Float]
+            #   @param lon [Float]
+          end
+
+          # @see OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List#trip_status
+          class TripStatus < OnebusawaySDK::Internal::Type::BaseModel
+            # @!attribute active_trip_id
+            #   Trip ID of the trip the vehicle is actively serving.
+            #
+            #   @return [String]
+            required :active_trip_id, String, api_name: :activeTripId
+
+            # @!attribute block_trip_sequence
+            #   Index of the active trip into the sequence of trips for the active block.
+            #
+            #   @return [Integer]
+            required :block_trip_sequence, Integer, api_name: :blockTripSequence
+
+            # @!attribute closest_stop
+            #   ID of the closest stop to the current location of the transit vehicle.
+            #
+            #   @return [String]
+            required :closest_stop, String, api_name: :closestStop
+
+            # @!attribute distance_along_trip
+            #   Distance, in meters, the transit vehicle has progressed along the active trip.
+            #
+            #   @return [Float]
+            required :distance_along_trip, Float, api_name: :distanceAlongTrip
+
+            # @!attribute last_known_distance_along_trip
+            #   Last known distance along the trip received in real-time from the transit
+            #   vehicle.
+            #
+            #   @return [Float]
+            required :last_known_distance_along_trip, Float, api_name: :lastKnownDistanceAlongTrip
+
+            # @!attribute last_location_update_time
+            #   Timestamp of the last known real-time location update from the transit vehicle.
+            #
+            #   @return [Integer]
+            required :last_location_update_time, Integer, api_name: :lastLocationUpdateTime
+
+            # @!attribute last_update_time
+            #   Timestamp of the last known real-time update from the transit vehicle.
+            #
+            #   @return [Integer]
+            required :last_update_time, Integer, api_name: :lastUpdateTime
+
+            # @!attribute occupancy_capacity
+            #   Capacity of the transit vehicle in terms of occupancy.
+            #
+            #   @return [Integer]
+            required :occupancy_capacity, Integer, api_name: :occupancyCapacity
+
+            # @!attribute occupancy_count
+            #   Current count of occupants in the transit vehicle.
+            #
+            #   @return [Integer]
+            required :occupancy_count, Integer, api_name: :occupancyCount
+
+            # @!attribute occupancy_status
+            #   Current occupancy status of the transit vehicle.
+            #
+            #   @return [String]
+            required :occupancy_status, String, api_name: :occupancyStatus
+
+            # @!attribute phase
+            #   Current journey phase of the trip.
+            #
+            #   @return [String]
+            required :phase, String
+
+            # @!attribute predicted
+            #   Indicates if real-time arrival info is available for this trip.
+            #
+            #   @return [Boolean]
+            required :predicted, OnebusawaySDK::Internal::Type::Boolean
+
+            # @!attribute schedule_deviation
+            #   Deviation from the schedule in seconds (positive for late, negative for early).
+            #
+            #   @return [Integer]
+            required :schedule_deviation, Integer, api_name: :scheduleDeviation
+
+            # @!attribute service_date
+            #   Time, in milliseconds since the Unix epoch, of midnight for the start of the
+            #   service date for the trip.
+            #
+            #   @return [Integer]
+            required :service_date, Integer, api_name: :serviceDate
+
+            # @!attribute status
+            #   Current status modifiers for the trip.
+            #
+            #   @return [String]
+            required :status, String
+
+            # @!attribute total_distance_along_trip
+            #   Total length of the trip, in meters.
+            #
+            #   @return [Float]
+            required :total_distance_along_trip, Float, api_name: :totalDistanceAlongTrip
+
+            # @!attribute closest_stop_time_offset
+            #   Time offset from the closest stop to the current position of the transit vehicle
+            #   (in seconds).
+            #
+            #   @return [Integer, nil]
+            optional :closest_stop_time_offset, Integer, api_name: :closestStopTimeOffset
+
+            # @!attribute frequency
+            #   Information about frequency-based scheduling, if applicable to the trip.
+            #
+            #   @return [String, nil]
+            optional :frequency, String
+
+            # @!attribute last_known_location
+            #   Last known location of the transit vehicle.
+            #
+            #   @return [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::LastKnownLocation, nil]
+            optional :last_known_location,
+                     -> { OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::LastKnownLocation },
+                     api_name: :lastKnownLocation
+
+            # @!attribute last_known_orientation
+            #   Last known orientation value received in real-time from the transit vehicle.
+            #
+            #   @return [Float, nil]
+            optional :last_known_orientation, Float, api_name: :lastKnownOrientation
+
+            # @!attribute next_stop
+            #   ID of the next stop the transit vehicle is scheduled to arrive at.
+            #
+            #   @return [String, nil]
+            optional :next_stop, String, api_name: :nextStop
+
+            # @!attribute next_stop_time_offset
+            #   Time offset from the next stop to the current position of the transit vehicle
+            #   (in seconds).
+            #
+            #   @return [Integer, nil]
+            optional :next_stop_time_offset, Integer, api_name: :nextStopTimeOffset
+
+            # @!attribute orientation
+            #   Orientation of the transit vehicle, represented as an angle in degrees.
+            #
+            #   @return [Float, nil]
+            optional :orientation, Float
+
+            # @!attribute position
+            #   Current position of the transit vehicle.
+            #
+            #   @return [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::Position, nil]
+            optional :position,
+                     -> { OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::Position }
+
+            # @!attribute scheduled_distance_along_trip
+            #   Distance, in meters, the transit vehicle is scheduled to have progressed along
+            #   the active trip.
+            #
+            #   @return [Float, nil]
+            optional :scheduled_distance_along_trip, Float, api_name: :scheduledDistanceAlongTrip
+
+            # @!attribute situation_ids
+            #   References to situation elements (if any) applicable to this trip.
+            #
+            #   @return [Array<String>, nil]
+            optional :situation_ids, OnebusawaySDK::Internal::Type::ArrayOf[String], api_name: :situationIds
+
+            # @!attribute vehicle_id
+            #   ID of the transit vehicle currently serving the trip.
+            #
+            #   @return [String, nil]
+            optional :vehicle_id, String, api_name: :vehicleId
+
+            # @!method initialize(active_trip_id:, block_trip_sequence:, closest_stop:, distance_along_trip:, last_known_distance_along_trip:, last_location_update_time:, last_update_time:, occupancy_capacity:, occupancy_count:, occupancy_status:, phase:, predicted:, schedule_deviation:, service_date:, status:, total_distance_along_trip:, closest_stop_time_offset: nil, frequency: nil, last_known_location: nil, last_known_orientation: nil, next_stop: nil, next_stop_time_offset: nil, orientation: nil, position: nil, scheduled_distance_along_trip: nil, situation_ids: nil, vehicle_id: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus}
+            #   for more details.
+            #
+            #   @param active_trip_id [String] Trip ID of the trip the vehicle is actively serving.
+            #
+            #   @param block_trip_sequence [Integer] Index of the active trip into the sequence of trips for the active block.
+            #
+            #   @param closest_stop [String] ID of the closest stop to the current location of the transit vehicle.
+            #
+            #   @param distance_along_trip [Float] Distance, in meters, the transit vehicle has progressed along the active trip.
+            #
+            #   @param last_known_distance_along_trip [Float] Last known distance along the trip received in real-time from the transit vehicl
+            #
+            #   @param last_location_update_time [Integer] Timestamp of the last known real-time location update from the transit vehicle.
+            #
+            #   @param last_update_time [Integer] Timestamp of the last known real-time update from the transit vehicle.
+            #
+            #   @param occupancy_capacity [Integer] Capacity of the transit vehicle in terms of occupancy.
+            #
+            #   @param occupancy_count [Integer] Current count of occupants in the transit vehicle.
+            #
+            #   @param occupancy_status [String] Current occupancy status of the transit vehicle.
+            #
+            #   @param phase [String] Current journey phase of the trip.
+            #
+            #   @param predicted [Boolean] Indicates if real-time arrival info is available for this trip.
+            #
+            #   @param schedule_deviation [Integer] Deviation from the schedule in seconds (positive for late, negative for early).
+            #
+            #   @param service_date [Integer] Time, in milliseconds since the Unix epoch, of midnight for the start of the ser
+            #
+            #   @param status [String] Current status modifiers for the trip.
+            #
+            #   @param total_distance_along_trip [Float] Total length of the trip, in meters.
+            #
+            #   @param closest_stop_time_offset [Integer] Time offset from the closest stop to the current position of the transit vehicle
+            #
+            #   @param frequency [String] Information about frequency-based scheduling, if applicable to the trip.
+            #
+            #   @param last_known_location [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::LastKnownLocation] Last known location of the transit vehicle.
+            #
+            #   @param last_known_orientation [Float] Last known orientation value received in real-time from the transit vehicle.
+            #
+            #   @param next_stop [String] ID of the next stop the transit vehicle is scheduled to arrive at.
+            #
+            #   @param next_stop_time_offset [Integer] Time offset from the next stop to the current position of the transit vehicle (i
+            #
+            #   @param orientation [Float] Orientation of the transit vehicle, represented as an angle in degrees.
+            #
+            #   @param position [OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus::Position] Current position of the transit vehicle.
+            #
+            #   @param scheduled_distance_along_trip [Float] Distance, in meters, the transit vehicle is scheduled to have progressed along t
+            #
+            #   @param situation_ids [Array<String>] References to situation elements (if any) applicable to this trip.
+            #
+            #   @param vehicle_id [String] ID of the transit vehicle currently serving the trip.
+
+            # @see OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus#last_known_location
+            class LastKnownLocation < OnebusawaySDK::Internal::Type::BaseModel
+              # @!attribute lat
+              #   Latitude of the last known location of the transit vehicle.
+              #
+              #   @return [Float, nil]
+              optional :lat, Float
+
+              # @!attribute lon
+              #   Longitude of the last known location of the transit vehicle.
+              #
+              #   @return [Float, nil]
+              optional :lon, Float
+
+              # @!method initialize(lat: nil, lon: nil)
+              #   Last known location of the transit vehicle.
+              #
+              #   @param lat [Float] Latitude of the last known location of the transit vehicle.
+              #
+              #   @param lon [Float] Longitude of the last known location of the transit vehicle.
+            end
+
+            # @see OnebusawaySDK::Models::VehiclesForAgencyListResponse::Data::List::TripStatus#position
+            class Position < OnebusawaySDK::Internal::Type::BaseModel
+              # @!attribute lat
+              #   Latitude of the current position of the transit vehicle.
+              #
+              #   @return [Float, nil]
+              optional :lat, Float
+
+              # @!attribute lon
+              #   Longitude of the current position of the transit vehicle.
+              #
+              #   @return [Float, nil]
+              optional :lon, Float
+
+              # @!method initialize(lat: nil, lon: nil)
+              #   Current position of the transit vehicle.
+              #
+              #   @param lat [Float] Latitude of the current position of the transit vehicle.
+              #
+              #   @param lon [Float] Longitude of the current position of the transit vehicle.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/models.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  [
+    OnebusawaySDK::Internal::Type::BaseModel,
+    *OnebusawaySDK::Internal::Type::BaseModel.subclasses
+  ].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, OnebusawaySDK::Internal::AnyHash) } }
+  end
+
+  [
+    *OnebusawaySDK::Internal::Type::Enum.included_modules,
+    *OnebusawaySDK::Internal::Type::Union.included_modules
+  ].each do |cls|
+    cls.constants.each do |name|
+      case cls.const_get(name)
+      in true | false
+        cls.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, cls) } }
+        cls.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+      in Integer
+        cls.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, cls) } }
+        cls.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+      in Float
+        cls.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, cls) } }
+        cls.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+      in Symbol
+        cls.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, cls) } }
+        cls.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+      else
+      end
+    end
+  end
+
+  AgenciesWithCoverageListParams = OnebusawaySDK::Models::AgenciesWithCoverageListParams
+
+  AgencyRetrieveParams = OnebusawaySDK::Models::AgencyRetrieveParams
+
+  ArrivalAndDepartureListParams = OnebusawaySDK::Models::ArrivalAndDepartureListParams
+
+  ArrivalAndDepartureRetrieveParams = OnebusawaySDK::Models::ArrivalAndDepartureRetrieveParams
+
+  BlockRetrieveParams = OnebusawaySDK::Models::BlockRetrieveParams
+
+  ConfigRetrieveParams = OnebusawaySDK::Models::ConfigRetrieveParams
+
+  CurrentTimeRetrieveParams = OnebusawaySDK::Models::CurrentTimeRetrieveParams
+
+  References = OnebusawaySDK::Models::References
+
+  ReportProblemWithStopRetrieveParams = OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams
+
+  ReportProblemWithTripRetrieveParams = OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams
+
+  ResponseWrapper = OnebusawaySDK::Models::ResponseWrapper
+
+  RouteIDsForAgencyListParams = OnebusawaySDK::Models::RouteIDsForAgencyListParams
+
+  RouteRetrieveParams = OnebusawaySDK::Models::RouteRetrieveParams
+
+  RoutesForAgencyListParams = OnebusawaySDK::Models::RoutesForAgencyListParams
+
+  RoutesForLocationListParams = OnebusawaySDK::Models::RoutesForLocationListParams
+
+  ScheduleForRouteRetrieveParams = OnebusawaySDK::Models::ScheduleForRouteRetrieveParams
+
+  ScheduleForStopRetrieveParams = OnebusawaySDK::Models::ScheduleForStopRetrieveParams
+
+  SearchForRouteListParams = OnebusawaySDK::Models::SearchForRouteListParams
+
+  SearchForStopListParams = OnebusawaySDK::Models::SearchForStopListParams
+
+  ShapeRetrieveParams = OnebusawaySDK::Models::ShapeRetrieveParams
+
+  StopIDsForAgencyListParams = OnebusawaySDK::Models::StopIDsForAgencyListParams
+
+  StopRetrieveParams = OnebusawaySDK::Models::StopRetrieveParams
+
+  StopsForAgencyListParams = OnebusawaySDK::Models::StopsForAgencyListParams
+
+  StopsForLocationListParams = OnebusawaySDK::Models::StopsForLocationListParams
+
+  StopsForRouteListParams = OnebusawaySDK::Models::StopsForRouteListParams
+
+  TripDetailRetrieveParams = OnebusawaySDK::Models::TripDetailRetrieveParams
+
+  TripForVehicleRetrieveParams = OnebusawaySDK::Models::TripForVehicleRetrieveParams
+
+  TripRetrieveParams = OnebusawaySDK::Models::TripRetrieveParams
+
+  TripsForLocationListParams = OnebusawaySDK::Models::TripsForLocationListParams
+
+  TripsForRouteListParams = OnebusawaySDK::Models::TripsForRouteListParams
+
+  VehiclesForAgencyListParams = OnebusawaySDK::Models::VehiclesForAgencyListParams
+end

data/lib/onebusaway_sdk/request_options.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  # 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::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in OnebusawaySDK::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query,
+             OnebusawaySDK::Internal::Type::HashOf[OnebusawaySDK::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, OnebusawaySDK::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, OnebusawaySDK::Internal::Type::HashOf[OnebusawaySDK::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(OnebusawaySDK::RequestOptions, OnebusawaySDK::Internal::AnyHash) }
+    end
+  end
+end

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

@@ -4,13 +4,15 @@ 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.
+      # with the center of their coverage area.
       #
-      # @param params [OnebusawaySDK::Models::AgenciesWithCoverageListParams, Hash{Symbol=>Object}] .
+      # @overload list(request_options: {})
       #
-      #   @option params [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OnebusawaySDK::Models::AgenciesWithCoverageListResponse]
+      #
+      # @see OnebusawaySDK::Models::AgenciesWithCoverageListParams
       def list(params = {})
         @client.request(
           method: :get,
@@ -20,6 +22,8 @@ module OnebusawaySDK
         )
       end
 
+      # @api private
+      #
       # @param client [OnebusawaySDK::Client]
       def initialize(client:)
         @client = client

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

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