Class: BlizzardApi::Wow::Reputation

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

Overview

This class allows access to World of Warcraft reputation

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

api_instance = BlizzardApi::Wow.reputation

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

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

#faction(id, **options) ⇒ Hash

Return data about a reputation faction

in the configuration module

Parameters:

  • id (Integer) —

    Reputation faction 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



48
49
50
 
# File 'lib/blizzard_api/wow/game_data/reputation.rb', line 48

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

#factions(**options) ⇒ Hash

Return a list of reputation factions

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



37
38
39
 
# File 'lib/blizzard_api/wow/game_data/reputation.rb', line 37

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

#get ⇒ Hash

This method overrides the inherited default behavior to prevent high server load and fetch time

in the configuration module

Returns:

  • (Hash) —

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

Raises:



27
28
29
 
# File 'lib/blizzard_api/wow/game_data/reputation.rb', line 27

def get
  raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
end

#index ⇒ Hash

This method overrides the inherited default behavior to prevent high server load and fetch time

in the configuration module

Returns:

  • (Hash) —

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

Raises:



19
20
21
 
# File 'lib/blizzard_api/wow/game_data/reputation.rb', line 19

def index
  raise BlizzardApi::ApiException, 'This endpoint does not have an index method'
end

#tier(id, **options) ⇒ Hash

Return data about a reputation tier

in the configuration module

Parameters:

  • id (Integer) —

    Reputation tier 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



69
70
71
 
# File 'lib/blizzard_api/wow/game_data/reputation.rb', line 69

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

#tiers(**options) ⇒ Hash

Return a list of reputation tiers

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



58
59
60
 
# File 'lib/blizzard_api/wow/game_data/reputation.rb', line 58

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