Module: BWAPI::Client::Locations

Included in:: BWAPI::Client

Defined in:: lib/bwapi/client/locations.rb

Overview

Location module for locations endpoints

Instance Method Summary collapse

#location(id) ⇒ Hash
Request the information for a given location code.
#locations(opts = {}) ⇒ Hash
Locations a location name with candidates.

Instance Method Details

#location(id) ⇒ `Hash`

Request the information for a given location code



8
9
10

# File 'lib/bwapi/client/locations.rb', line 8

def location(id)
  get "locations/#{id}"
end

#locations(opts = {}) ⇒ `Hash`

Locations a location name with candidates

Options Hash (opts):

a (Array) —
list of location types to return
page (Integer) —
number of results to retrieve
pageSize (Integer) —
of the results to retrieve



19
20
21

# File 'lib/bwapi/client/locations.rb', line 19

def locations(opts = {})
  get 'locations', opts
end