Module: GogoKit::Client::MetroArea

Includes:
Utils
Included in:
GogoKit::Client
Defined in:
lib/gogokit/client/metro_area.rb

Overview

GogoKit::Client methods for getting metro areas

Instance Method Summary collapse

Methods included from Utils

#object_from_response

Instance Method Details

#get_metro_area(metro_area_id, options = {}) ⇒ GogoKit::MetroArea

Retrieves a metro area by ID

Parameters:

  • metro_area_id (Integer) —

    The ID of the metro area to be retrieved

  • options (Hash) (defaults to: {}) —

    Optional options

Returns:



15
16
17
18
19
20
21
22
23
 
# File 'lib/gogokit/client/metro_area.rb', line 15

def get_metro_area(metro_area_id, options = {})
  root = get_root
  object_from_response(GogoKit::MetroArea,
                       GogoKit::MetroAreaRepresenter,
                       :get,
                       "#{root.links['self'].href}/metro_areas/" \
                       "#{metro_area_id}",
                       options)
end

#get_metro_areas(options = {}) ⇒ GogoKit::PagedResource

Retrieves all metro_areas

Parameters:

  • options (Hash) (defaults to: {}) —

    Optional options

Returns:

See Also:



30
31
32
33
34
35
36
 
# File 'lib/gogokit/client/metro_area.rb', line 30

def get_metro_areas(options = {})
  object_from_response(GogoKit::PagedResource,
                       GogoKit::MetroAreasRepresenter,
                       :get,
                       get_root.links['viagogo:metro_areas'].href,
                       options)
end