Class: OnebusawaySDK::Resources::Agency

Inherits:

Object

• Object
• OnebusawaySDK::Resources::Agency

Defined in:

lib/onebusaway_sdk/resources/agency.rb

Instance Method Summary

• #initialize(client:) ⇒ Agency constructor private

  A new instance of Agency.

• #retrieve(agency_id, request_options: {}) ⇒ OnebusawaySDK::Models::AgencyRetrieveResponse

  Retrieve information for a specific transit agency identified by its unique ID.

Constructor Details

#initialize(client:) ⇒ Agency

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

Parameters:

• client (OnebusawaySDK::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(agency_id, request_options: {}) ⇒ OnebusawaySDK::Models::AgencyRetrieveResponse

Retrieve information for a specific transit agency identified by its unique ID.

Parameters:

• agency_id (String) —

  The ID of the transit agency.

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

Returns:

• (OnebusawaySDK::Models::AgencyRetrieveResponse)

See Also:

• Models::AgencyRetrieveParams

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

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