Class: OnebusawaySDK::Resources::ArrivalAndDeparture

Inherits:
Object
  • Object
show all
Defined in:
lib/onebusaway_sdk/resources/arrival_and_departure.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ArrivalAndDeparture

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

Parameters:



68
69
70
 
# File 'lib/onebusaway_sdk/resources/arrival_and_departure.rb', line 68

def initialize(client:)
  @client = client
end

Instance Method Details

#list(stop_id, minutes_after: nil, minutes_before: nil, time: nil, request_options: {}) ⇒ OnebusawaySDK::Models::ArrivalAndDepartureListResponse

arrivals-and-departures-for-stop

Parameters:

  • stop_id (String)
  • minutes_after (Integer) —

    Include vehicles arriving or departing in the next n minutes.

  • minutes_before (Integer) —

    Include vehicles having arrived or departed in the previous n minutes.

  • time (Time) —

    The specific time for querying the system status.

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

Returns:

See Also:



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/onebusaway_sdk/resources/arrival_and_departure.rb', line 54

def list(stop_id, params = {})
  parsed, options = OnebusawaySDK::ArrivalAndDepartureListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["api/where/arrivals-and-departures-for-stop/%1$s.json", stop_id],
    query: parsed.transform_keys(minutes_after: "minutesAfter", minutes_before: "minutesBefore"),
    model: OnebusawaySDK::Models::ArrivalAndDepartureListResponse,
    options: options
  )
end

#retrieve(stop_id, service_date: , trip_id: , stop_sequence: nil, time: nil, vehicle_id: nil, request_options: {}) ⇒ OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse

arrival-and-departure-for-stop

Parameters:

  • stop_id (String)
  • service_date (Integer)
  • trip_id (String)
  • stop_sequence (Integer)
  • time (Integer)
  • vehicle_id (String)
  • request_options (OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/onebusaway_sdk/resources/arrival_and_departure.rb', line 21

def retrieve(stop_id, params)
  parsed, options = OnebusawaySDK::ArrivalAndDepartureRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["api/where/arrival-and-departure-for-stop/%1$s.json", stop_id],
    query: parsed.transform_keys(
      service_date: "serviceDate",
      trip_id: "tripId",
      stop_sequence: "stopSequence",
      vehicle_id: "vehicleId"
    ),
    model: OnebusawaySDK::Models::ArrivalAndDepartureRetrieveResponse,
    options: options
  )
end