class BlizzardApi::Wow::Creature

This class allows access to World of Warcraft creatures

@see develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api

You can get an instance of this class using the default region as follows:

api_instance = BlizzardApi::Wow.creature

Public Instance Methods

complete() click to toggle source
# File lib/blizzard_api/wow/game_data/creature.rb, line 19
def complete
  raise BlizzardApi::ApiException, 'There are too many creatures to fetch complete data'
end
display_media(id, **options) click to toggle source

Fetch media for one of the items listed by the {#types} using its id

@param id [Integer] Creature type id

@!macro request_options @option options [Boolean] :classic If set to true, this method will call the classic version @option options [Boolean] :classic1x If set to true, this method will call the classic era version

@!macro response

# File lib/blizzard_api/wow/game_data/creature.rb, line 99
def display_media(id, **options)
  api_request "#{base_url(:media)}/creature-display/#{id}", **default_options.merge(options)
end
families(**options) click to toggle source

Fetch all creature families

@!macro request_options @option options [Boolean] :classic If set to true, this method will call the classic version @option options [Boolean] :classic1x If set to true, this method will call the classic era version

@!macro response

# File lib/blizzard_api/wow/game_data/creature.rb, line 31
def families(**options)
  api_request "#{endpoint_uri('family')}/index", **default_options.merge(options)
end
family(id, **options) click to toggle source

Fetch all possible data for one of the items listed by the {#families} using its id

@param id [Integer] Creature family id

@!macro request_options @option options [Boolean] :classic If set to true, this method will call the classic version @option options [Boolean] :classic1x If set to true, this method will call the classic era version

@!macro response

# File lib/blizzard_api/wow/game_data/creature.rb, line 45
def family(id, **options)
  api_request "#{endpoint_uri('family')}/#{id}", **default_options.merge(options)
end
family_media(id, **options) click to toggle source

Fetch media for one of the items listed by the {#families} using its id

@param id [Integer] Creature family id

@!macro request_options @option options [Boolean] :classic If set to true, this method will call the classic version @option options [Boolean] :classic1x If set to true, this method will call the classic era version

@!macro response

# File lib/blizzard_api/wow/game_data/creature.rb, line 59
def family_media(id, **options)
  api_request "#{base_url(:media)}/creature-family/#{id}", **default_options.merge(options)
end
index() click to toggle source
# File lib/blizzard_api/wow/game_data/creature.rb, line 15
def index
  raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have an index method'
end
type(id, **options) click to toggle source

Fetch all possible data for one of the items listed by the {#types} using its id

@param id [Integer] Creature type id

@!macro request_options @option options [Boolean] :classic If set to true, this method will call the classic version @option options [Boolean] :classic1x If set to true, this method will call the classic era version

@!macro response

# File lib/blizzard_api/wow/game_data/creature.rb, line 85
def type(id, **options)
  api_request "#{endpoint_uri('type')}/#{id}", **default_options.merge(options)
end
types(**options) click to toggle source

Fetch all creature types

@!macro request_options @option options [Boolean] :classic If set to true, this method will call the classic version @option options [Boolean] :classic1x If set to true, this method will call the classic era version

@!macro response

# File lib/blizzard_api/wow/game_data/creature.rb, line 71
def types(**options)
  api_request "#{endpoint_uri('type')}/index", **default_options.merge(options)
end

Protected Instance Methods

endpoint_setup() click to toggle source
# File lib/blizzard_api/wow/game_data/creature.rb, line 105
def endpoint_setup
  @endpoint = 'creature'
  @namespace = :static
  @collection = 'achievements'
  @ttl = CACHE_TRIMESTER
end