Class: OnebusawaySDK::Resources::Trip

Inherits:

Object

• Object
• OnebusawaySDK::Resources::Trip

Defined in:

lib/onebusaway_sdk/resources/trip.rb

Instance Method Summary

• #initialize(client:) ⇒ Trip constructor private

  A new instance of Trip.

• #retrieve(trip_id, request_options: {}) ⇒ OnebusawaySDK::Models::TripRetrieveResponse

  Get details of a specific trip.

Constructor Details

#initialize(client:) ⇒ Trip

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

Parameters:

• client (OnebusawaySDK::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(trip_id, request_options: {}) ⇒ OnebusawaySDK::Models::TripRetrieveResponse

Get details of a specific trip

Parameters:

• trip_id (String) —

  ID of the trip

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

Returns:

• (OnebusawaySDK::Models::TripRetrieveResponse)

See Also:

• Models::TripRetrieveParams

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

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