Class: OnebusawaySDK::Resources::Stop

Inherits:

Object

• Object
• OnebusawaySDK::Resources::Stop

Defined in:

lib/onebusaway_sdk/resources/stop.rb

Instance Method Summary

• #initialize(client:) ⇒ Stop constructor private

  A new instance of Stop.

• #retrieve(stop_id, request_options: {}) ⇒ OnebusawaySDK::Models::StopRetrieveResponse

  Get details of a specific stop.

Constructor Details

#initialize(client:) ⇒ Stop

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

Parameters:

• client (OnebusawaySDK::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(stop_id, request_options: {}) ⇒ OnebusawaySDK::Models::StopRetrieveResponse

Get details of a specific stop

Parameters:

• stop_id (String) —

  ID of the stop

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

Returns:

• (OnebusawaySDK::Models::StopRetrieveResponse)

See Also:

• Models::StopRetrieveParams

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

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