# frozen_string_literal: true

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
      #
      # @overload retrieve(route_id, date: nil, request_options: {})
      #
      # @param route_id [String] The route id to request the schedule for
      #
      # @param date [Date] The date for which you want to request a schedule in the format YYYY-MM-DD (opti
      #
      # @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::ScheduleForRouteRetrieveParams.dump_request(params)
        @client.request(
          method: :get,
          path: ["api/where/schedule-for-route/%1$s.json", route_id],
          query: parsed,
          model: OnebusawaySDK::Models::ScheduleForRouteRetrieveResponse,
          options: options
        )
      end

      # @api private
      #
      # @param client [OnebusawaySDK::Client]
      def initialize(client:)
        @client = client
      end
    end
  end
end