Class: OnebusawaySDK::Resources::RoutesForAgency

Inherits:

Object

• Object
• OnebusawaySDK::Resources::RoutesForAgency

Defined in:

lib/onebusaway_sdk/resources/routes_for_agency.rb

Instance Method Summary

• #initialize(client:) ⇒ RoutesForAgency constructor private

  A new instance of RoutesForAgency.

• #list(agency_id, request_options: {}) ⇒ OnebusawaySDK::Models::RoutesForAgencyListResponse

  Retrieve the list of all routes for a particular agency by id.

Constructor Details

#initialize(client:) ⇒ RoutesForAgency

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of RoutesForAgency.

Parameters:

• client (OnebusawaySDK::Client)

# File 'lib/onebusaway_sdk/resources/routes_for_agency.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#list(agency_id, request_options: {}) ⇒ OnebusawaySDK::Models::RoutesForAgencyListResponse

Retrieve the list of all routes for a particular agency by id

Parameters:

• agency_id (String) —

  The id of the agency

• request_options (OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (OnebusawaySDK::Models::RoutesForAgencyListResponse)

See Also:

• Models::RoutesForAgencyListParams

# File 'lib/onebusaway_sdk/resources/routes_for_agency.rb', line 17

def list(agency_id, params = {})
  @client.request(
    method: :get,
    path: ["api/where/routes-for-agency/%1$s.json", agency_id],
    model: OnebusawaySDK::Models::RoutesForAgencyListResponse,
    options: params[:request_options]
  )
end