Class: BlizzardApi::Wow::MythicRaidLeaderboard

Inherits:
Request show all
Defined in:
lib/blizzard_api_rb/wow/game_data/mythic_raid_leaderboard.rb

Overview

This class allows access to World of Warcraft mythic raid leaderboard

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

api_instance = BlizzardApi::Wow.mythic_raid_leaderboard

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 Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

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

Instance Method Details

#get(raid, faction, **options) ⇒ Hash

Fetch leaderboard data for given raid and faction

in the configuration module

Parameters:

  • raid (String) —

    Raid slug

  • faction (String) —

    Faction slug

  • options (Hash) —

    a customizable set of options

Options Hash (**options):

  • :completed (Boolean) —

    Should return completed quests

Returns:

  • (Hash) —

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



22
23
24
25
 
# File 'lib/blizzard_api_rb/wow/game_data/mythic_raid_leaderboard.rb', line 22

def get(raid, faction, **options)
  opts = options.merge(namespace: :dynamic, ttl: CACHE_DAY)
  api_request "#{base_url(:game_data)}/leaderboard/hall-of-fame/#{raid}/#{faction}", **opts
end