Class: BlizzardApi::Wow::Pet

Inherits:
GenericDataEndpoint show all
Defined in:
lib/blizzard_api/wow/game_data/pet.rb

Overview

This class allows access to World of Warcraft pet data

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

api_instance = BlizzardApi::Wow.pet

See Also:

Constant Summary

Constants inherited from Request

Request::CACHE_DAY, Request::CACHE_HOUR, Request::CACHE_TRIMESTER

Constants included from ApiStandards

ApiStandards::BASE_URLS

Instance Attribute Summary

Attributes inherited from Request

#mode, #region

Instance Method Summary collapse

Methods inherited from GenericDataEndpoint

#get, #index, setup

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

This class inherits a constructor from BlizzardApi::Wow::Request

Instance Method Details

#abilities(**options) ⇒ Hash

Fetch all pet abilities

in the configuration module

Parameters:

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



33
34
35
 
# File 'lib/blizzard_api/wow/game_data/pet.rb', line 33

def abilities(**options)
  api_request "#{endpoint_uri('ability')}/index", **default_options.merge(options)
end

#ability(id, **options) ⇒ Hash

Fetch a pet ability

in the configuration module

Parameters:

  • id (Integer) —

    Pet id

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



45
46
47
 
# File 'lib/blizzard_api/wow/game_data/pet.rb', line 45

def ability(id, **options)
  api_request "#{endpoint_uri('ability')}/#{id}", **default_options.merge(options)
end

#ability_media(id, **options) ⇒ Hash

Fetch media for one of the pet abilities listed by the #abilities using its id

in the configuration module

Parameters:

  • id (Integer) —

    Pet ability id

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



57
58
59
 
# File 'lib/blizzard_api/wow/game_data/pet.rb', line 57

def ability_media(id, **options)
  api_request "#{base_url(:media)}/pet-ability/#{id}", **default_options.merge(options)
end

#media(id, **options) ⇒ Hash

Fetch media for one of the pets listed by the GenericDataEndpoint#index using its id

in the configuration module

Parameters:

  • id (Integer) —

    Pet id

  • options (Hash) —

    You can specify some options

Options Hash (**options):

  • :locale (String) —

    Overrides the default locale for a single call

  • :namespace (String) —

    Overrides the default namespace for a single call

  • :access_token (String) —

    Overrides the access_token for a single call

  • :ignore_cache (Boolean) —

    If set to true the request will not use the cache

  • :ttl (Integer) —

    Override the default time (in seconds) a request should be cached

  • :since (DateTime) —

    Adds the If-modified-since headers. Will always ignore cache when set.

Returns:

  • (Hash) —

    API Response. The actual type of the returned object depends on the format option



23
24
25
 
# File 'lib/blizzard_api/wow/game_data/pet.rb', line 23

def media(id, **options)
  api_request "#{base_url(:media)}/pet/#{id}", **default_options.merge(options)
end