class BlizzardApi::Wow::PvpSeason

This class allows access to World of Warcraft PvP seasons

@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.pvp_season

Public Instance Methods

leaderboard(season_id, brackets, **options) click to toggle source

Returns the leaderboard for a given season and bracket

@!macro request_options @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/pvp_season.rb, line 31
def leaderboard(season_id, brackets, **options)
  api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/#{brackets}", **default_options.merge(options)
end
leaderboards(season_id, **options) click to toggle source

Returns a index of pvp leaderboard for a season

@!macro request_options @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/pvp_season.rb, line 20
def leaderboards(season_id, **options)
  api_request "#{endpoint_uri}/#{season_id}/pvp-leaderboard/index", **default_options.merge(options)
end
rewards(season_id, **options) click to toggle source

Returns a list of pvp rewards for a season

@!macro request_options

@!macro response

# File lib/blizzard_api/wow/game_data/pvp_season.rb, line 41
def rewards(season_id, **options)
  api_request "#{endpoint_uri}/#{season_id}/pvp-reward/index", **default_options.merge(options)
end

Protected Instance Methods

endpoint_setup() click to toggle source
# File lib/blizzard_api/wow/game_data/pvp_season.rb, line 47
def endpoint_setup
  @endpoint = 'pvp-season'
  @namespace = :dynamic
  @collection = 'power_types'
  @ttl = CACHE_TRIMESTER
end