module BWAPI::Client::Locations

Location module for locations endpoints

Public Instance Methods

location(id) click to toggle source

Request the information for a given location code

@return [Hash] Information about the location

# File lib/bwapi/client/locations.rb, line 8
def location(id)
  get "locations/#{id}"
end
locations(opts = {}) click to toggle source

Locations a location name with candidates

@param opts [String] prefix that the location starts with @option opts [Array] a list of location types to return @option opts [Integer] page number of results to retrieve @option opts [Integer] pageSize of the results to retrieve @return [Hash] The list of matching locations

# File lib/bwapi/client/locations.rb, line 19
def locations(opts = {})
  get 'locations', opts
end