Class: BlizzardApi::Wow::Covenant

Inherits:
GenericDataEndpoint show all
Defined in:
lib/blizzard_api_rb/wow/game_data/covenant.rb

Overview

This class allows access to World of Warcraft azerite essences

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

api_instance = BlizzardApi::Wow.azerite_essence

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

#conduit(id, **options) ⇒ Hash

Fetch a conduit by its id

in the configuration module

Parameters:

  • id —

    Conduit 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



67
68
69
 
# File 'lib/blizzard_api_rb/wow/game_data/covenant.rb', line 67

def conduit(id, **options)
  api_request "#{base_url(:game_data)}/covenant/conduit/#{id}", **default_options.merge(options)
end

#conduits(**options) ⇒ Hash

Fetch all conduits

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



55
56
57
 
# File 'lib/blizzard_api_rb/wow/game_data/covenant.rb', line 55

def conduits(**options)
  api_request "#{base_url(:game_data)}/covenant/conduit/index", **default_options.merge(options)
end

#media(id, **options) ⇒ Hash

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

in the configuration module

Parameters:

  • id (Integer) —

    Covenant 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_rb/wow/game_data/covenant.rb', line 23

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

#soulbind(id, **options) ⇒ Hash

Fetch a soulbind by its id

in the configuration module

Parameters:

  • id —

    Soulbind 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_rb/wow/game_data/covenant.rb', line 45

def soulbind(id, **options)
  api_request "#{base_url(:game_data)}/covenant/soulbind/#{id}", **default_options.merge(options)
end

#soulbinds(**options) ⇒ Hash

Fetch all soulbinds

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_rb/wow/game_data/covenant.rb', line 33

def soulbinds(**options)
  api_request "#{base_url(:game_data)}/covenant/soulbind/index", **default_options.merge(options)
end