Class: OnebusawaySDK::Resources::Route

Inherits:

Object

• Object
• OnebusawaySDK::Resources::Route

Defined in:

lib/onebusaway_sdk/resources/route.rb

Instance Method Summary

• #initialize(client:) ⇒ Route constructor private

  A new instance of Route.

• #retrieve(route_id, request_options: {}) ⇒ OnebusawaySDK::Models::RouteRetrieveResponse

  Retrieve information for a specific route identified by its unique ID.

Constructor Details

#initialize(client:) ⇒ Route

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 Route.

Parameters:

• client (OnebusawaySDK::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(route_id, request_options: {}) ⇒ OnebusawaySDK::Models::RouteRetrieveResponse

Retrieve information for a specific route identified by its unique ID.

Parameters:

• route_id (String) —

  The ID of the route.

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

Returns:

• (OnebusawaySDK::Models::RouteRetrieveResponse)

See Also:

• Models::RouteRetrieveParams

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

def retrieve(route_id, params = {})
  @client.request(
    method: :get,
    path: ["api/where/route/%1$s.json", route_id],
    model: OnebusawaySDK::Models::RouteRetrieveResponse,
    options: params[:request_options]
  )
end