Search
Preparing search index...
The search index is not available
blizzard.js
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
blizzard.js
wow
WoW
Class WoW
Hierarchy
Blizzard
WoW
Implements
WoWClient
Index
Constructors
constructor
Properties
account
Character
Profile
account
Collections
account
Profile
achievement
achievement
Category
auction
House
axios
azerite
Essence
azerite
Essence
Search
character
Achievements
character
Appearance
character
Collections
character
Encounters
character
Equipment
character
Hunter
Pets
character
Media
character
Mythic
Keystone
characterPVP
character
Professions
character
Profile
character
Quests
character
Reputations
character
Soulbinds
character
Specializations
character
Statistics
character
Titles
conduit
connected
Realm
connected
Realm
Search
covenant
creature
creature
Family
creature
Search
creature
Type
defaults
guild
guild
Crest
item
item
Search
journal
media
Search
modified
Crafting
mount
mount
Search
mythic
Keystone
mythic
Keystone
Affix
mythic
Keystone
Leaderboard
mythic
Raid
Leaderboard
pet
playable
Class
playable
Race
playable
Specialization
power
Type
profession
pvp
Season
pvp
Tier
quest
realm
realm
Search
recipe
region
reputation
soulbind
spell
spell
Search
talent
tech
Talent
title
token
ua
version
Methods
create
Client
Resource
Request
get
Application
Token
get
Client
Resource
prepare
Resource
Request
refresh
Application
Token
set
Application
Token
validate
Application
Token
Constructors
constructor
new
WoW
(
args
:
ClientOptions
)
:
WoW
Parameters
args:
ClientOptions
Returns
WoW
Properties
account
Character
Profile
account
Character
Profile
:
(
args
:
AccountCharacterProfileOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
AccountCharacterProfileOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
AccountCharacterProfileOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
account
Collections
account
Collections
:
(
args
:
undefined
|
null
|
AccountCollectionsOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
AccountCollectionsOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
AccountCollectionsOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
account
Profile
account
Profile
:
(
args
:
any
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
any
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
any
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
achievement
achievement
:
(
args
:
undefined
|
null
|
AchievementOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
AchievementOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
AchievementOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
achievement
Category
achievement
Category
:
(
args
:
undefined
|
null
|
AchievementCategoryOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
AchievementCategoryOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
AchievementCategoryOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
auction
House
auction
House
:
(
args
:
AuctionHouseOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
AuctionHouseOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
AuctionHouseOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
axios
axios
:
AxiosInstance
= ...
azerite
Essence
azerite
Essence
:
(
args
:
undefined
|
null
|
AzeriteEssenceOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
AzeriteEssenceOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
AzeriteEssenceOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
azerite
Essence
Search
azerite
Essence
Search
:
(
args
:
SearchOptions
&
{
id
:
number
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
id
:
number
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
id
:
number
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Achievements
character
Achievements
:
(
args
:
CharacterOptions
&
{
stats
?:
boolean
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
stats
?:
boolean
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
stats
?:
boolean
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Appearance
character
Appearance
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Collections
character
Collections
:
(
args
:
CharacterOptions
&
{
resource
?:
"mounts"
|
"pets"
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
resource
?:
"mounts"
|
"pets"
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
resource
?:
"mounts"
|
"pets"
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Encounters
character
Encounters
:
(
args
:
CharacterOptions
&
{
resource
?:
"dungeons"
|
"raids"
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
resource
?:
"dungeons"
|
"raids"
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
resource
?:
"dungeons"
|
"raids"
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Equipment
character
Equipment
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Hunter
Pets
character
Hunter
Pets
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Media
character
Media
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Mythic
Keystone
character
Mythic
Keystone
:
(
args
:
CharacterOptions
&
{
season
?:
number
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
season
?:
number
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
season
?:
number
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
characterPVP
characterPVP
:
(
args
:
CharacterOptions
&
{
bracket
?:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
bracket
?:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
bracket
?:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Professions
character
Professions
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Profile
character
Profile
:
(
args
:
CharacterOptions
&
{
status
?:
boolean
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
status
?:
boolean
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
status
?:
boolean
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Quests
character
Quests
:
(
args
:
CharacterOptions
&
{
completed
?:
boolean
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
&
{
completed
?:
boolean
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
&
{
completed
?:
boolean
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Reputations
character
Reputations
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Soulbinds
character
Soulbinds
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Specializations
character
Specializations
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Statistics
character
Statistics
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
character
Titles
character
Titles
:
(
args
:
CharacterOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CharacterOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CharacterOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
conduit
conduit
:
(
args
:
undefined
|
null
|
ConduitOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
ConduitOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
ConduitOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
connected
Realm
connected
Realm
:
(
args
:
undefined
|
null
|
ConnectedRealmOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
ConnectedRealmOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
ConnectedRealmOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
connected
Realm
Search
connected
Realm
Search
:
(
args
:
SearchOptions
&
{
status
:
"UP"
|
"DOWN"
;
timezone
?:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
status
:
"UP"
|
"DOWN"
;
timezone
?:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
status
:
"UP"
|
"DOWN"
;
timezone
?:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
covenant
covenant
:
(
args
:
undefined
|
null
|
CovenantOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
CovenantOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
CovenantOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
creature
creature
:
(
args
:
CreatureOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
CreatureOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
CreatureOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
creature
Family
creature
Family
:
(
args
:
undefined
|
null
|
CreatureFamilyOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
CreatureFamilyOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
CreatureFamilyOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
creature
Search
creature
Search
:
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
creature
Type
creature
Type
:
(
args
:
undefined
|
null
|
CreatureTypeOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
CreatureTypeOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
CreatureTypeOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
defaults
defaults
:
{
key
:
string
;
locale
:
Locales
;
origin
:
Origins
;
secret
:
string
;
token
?:
string
}
Type declaration
key
:
string
locale
:
Locales
origin
:
Origins
secret
:
string
Optional
token
?:
string
guild
guild
:
(
args
:
GuildOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
GuildOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
GuildOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
guild
Crest
guild
Crest
:
(
args
:
undefined
|
null
|
GuildCrestOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
GuildCrestOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
GuildCrestOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
item
item
:
(
args
:
ItemOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
ItemOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
ItemOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
item
Search
item
Search
:
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
journal
journal
:
(
args
:
JournalOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
JournalOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
JournalOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
media
Search
media
Search
:
(
args
:
SearchOptions
&
{
tag
:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
tag
:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
tag
:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
modified
Crafting
modified
Crafting
:
(
args
:
undefined
|
null
|
ModifiedCraftingOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
ModifiedCraftingOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
ModifiedCraftingOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
mount
mount
:
(
args
:
undefined
|
null
|
MountOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
MountOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
MountOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
mount
Search
mount
Search
:
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
mythic
Keystone
mythic
Keystone
:
(
args
:
undefined
|
null
|
MythicKeystoneOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
MythicKeystoneOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
MythicKeystoneOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
mythic
Keystone
Affix
mythic
Keystone
Affix
:
(
args
:
undefined
|
null
|
MythicKeystoneAffixOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
MythicKeystoneAffixOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
MythicKeystoneAffixOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
mythic
Keystone
Leaderboard
mythic
Keystone
Leaderboard
:
(
args
:
MythicKeystoneLeaderboardOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
MythicKeystoneLeaderboardOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
MythicKeystoneLeaderboardOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
mythic
Raid
Leaderboard
mythic
Raid
Leaderboard
:
(
args
:
MythicRaidLeaderboardOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
MythicRaidLeaderboardOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
MythicRaidLeaderboardOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
pet
pet
:
(
args
:
undefined
|
null
|
PetOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PetOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PetOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
playable
Class
playable
Class
:
(
args
:
undefined
|
null
|
PlayableClassOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PlayableClassOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PlayableClassOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
playable
Race
playable
Race
:
(
args
:
undefined
|
null
|
PlayableRaceOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PlayableRaceOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PlayableRaceOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
playable
Specialization
playable
Specialization
:
(
args
:
undefined
|
null
|
PlayableSpecializationOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PlayableSpecializationOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PlayableSpecializationOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
power
Type
power
Type
:
(
args
:
undefined
|
null
|
PowerTypeOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PowerTypeOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PowerTypeOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
profession
profession
:
(
args
:
undefined
|
null
|
ProfessionOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
ProfessionOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
ProfessionOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
pvp
Season
pvp
Season
:
(
args
:
undefined
|
null
|
PVPSeasonOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PVPSeasonOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PVPSeasonOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
pvp
Tier
pvp
Tier
:
(
args
:
undefined
|
null
|
PVPTierOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
PVPTierOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
PVPTierOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
quest
quest
:
(
args
:
undefined
|
null
|
QuestOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
QuestOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
QuestOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
realm
realm
:
(
args
:
undefined
|
null
|
RealmOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
RealmOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
RealmOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
realm
Search
realm
Search
:
(
args
:
SearchOptions
&
{
timezone
?:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
timezone
?:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
timezone
?:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
recipe
recipe
:
(
args
:
RecipeOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
RecipeOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
RecipeOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
region
region
:
(
args
:
undefined
|
null
|
RegionOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
RegionOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
RegionOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
reputation
reputation
:
(
args
:
ReputationOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
ReputationOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
ReputationOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
soulbind
soulbind
:
(
args
:
undefined
|
null
|
SoulbindOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
SoulbindOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
SoulbindOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
spell
spell
:
(
args
:
SpellOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SpellOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SpellOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
spell
Search
spell
Search
:
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
SearchOptions
&
{
locale
:
Locales
;
name
:
string
}
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
talent
talent
:
(
args
:
undefined
|
null
|
TalentOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
TalentOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
TalentOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
tech
Talent
tech
Talent
:
(
args
:
undefined
|
null
|
TechTalentOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
TechTalentOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
TechTalentOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
title
title
:
(
args
:
undefined
|
null
|
TitleOptions
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
undefined
|
null
|
TitleOptions
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
undefined
|
null
|
TitleOptions
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
token
token
:
(
args
:
any
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
= ...
Type declaration
(
args
:
any
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
any
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
ua
ua
:
string
= ...
version
version
:
string
= '4.2.0'
Methods
create
Client
Resource
Request
create
Client
Resource
Request
<
T
>
(
fn
:
ResourceInterface
<
T
,
any
>
)
:
(
args
:
T
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
Type parameters
T =
any
Parameters
fn:
ResourceInterface
<
T
,
any
>
Returns
(
args
:
T
, headers
?:
Headers
)
=>
ResourceResponse
<
any
>
(
args
:
T
, headers
?:
Headers
)
:
ResourceResponse
<
any
>
Parameters
args:
T
Optional
headers:
Headers
Returns
ResourceResponse
<
any
>
get
Application
Token
get
Application
Token
(
args
?:
{
key
?:
string
;
origin
?:
string
;
secret
?:
string
}
)
:
Promise
<
AxiosResponse
<
AccessToken
,
any
>
>
Parameters
Optional
args:
{
key
?:
string
;
origin
?:
string
;
secret
?:
string
}
Optional
key
?:
string
Optional
origin
?:
string
Optional
secret
?:
string
Returns
Promise
<
AxiosResponse
<
AccessToken
,
any
>
>
get
Client
Resource
get
Client
Resource
<
T
>
(
url
:
string
, config
?:
AxiosRequestConfig
<
any
>
)
:
Promise
<
AxiosResponse
<
T
,
any
>
>
Type parameters
T
Parameters
url:
string
Optional
config:
AxiosRequestConfig
<
any
>
Returns
Promise
<
AxiosResponse
<
T
,
any
>
>
prepare
Resource
Request
prepare
Resource
Request
(
resource
:
Resource
<
{}
>
, args
?:
Partial
<
ClientOptions
>
, headers
?:
Headers
)
:
[
string
,
AxiosRequestConfig
<
any
>
]
Parameters
resource:
Resource
<
{}
>
Optional
args:
Partial
<
ClientOptions
>
Optional
headers:
Headers
Returns
[
string
,
AxiosRequestConfig
<
any
>
]
refresh
Application
Token
refresh
Application
Token
(
args
?:
{
key
?:
string
;
origin
?:
string
;
secret
?:
string
}
)
:
Promise
<
AxiosResponse
<
AccessToken
,
any
>
>
Parameters
Optional
args:
{
key
?:
string
;
origin
?:
string
;
secret
?:
string
}
Optional
key
?:
string
Optional
origin
?:
string
Optional
secret
?:
string
Returns
Promise
<
AxiosResponse
<
AccessToken
,
any
>
>
set
Application
Token
set
Application
Token
(
token
:
string
)
:
void
Parameters
token:
string
Returns
void
validate
Application
Token
validate
Application
Token
(
args
?:
{
origin
?:
string
;
token
?:
string
}
)
:
Promise
<
AxiosResponse
<
{
authorities
:
{
authority
:
string
}
[]
;
client_id
:
string
;
exp
:
number
;
scope
?:
string
[]
}
,
any
>
>
Parameters
Optional
args:
{
origin
?:
string
;
token
?:
string
}
Optional
origin
?:
string
Optional
token
?:
string
Returns
Promise
<
AxiosResponse
<
{
authorities
:
{
authority
:
string
}
[]
;
client_id
:
string
;
exp
:
number
;
scope
?:
string
[]
}
,
any
>
>
Exports
core
d3
hs
sc2
wow
classic
WoW
constructor
account
Character
Profile
account
Collections
account
Profile
achievement
achievement
Category
auction
House
axios
azerite
Essence
azerite
Essence
Search
character
Achievements
character
Appearance
character
Collections
character
Encounters
character
Equipment
character
Hunter
Pets
character
Media
character
Mythic
Keystone
characterPVP
character
Professions
character
Profile
character
Quests
character
Reputations
character
Soulbinds
character
Specializations
character
Statistics
character
Titles
conduit
connected
Realm
connected
Realm
Search
covenant
creature
creature
Family
creature
Search
creature
Type
defaults
guild
guild
Crest
item
item
Search
journal
media
Search
modified
Crafting
mount
mount
Search
mythic
Keystone
mythic
Keystone
Affix
mythic
Keystone
Leaderboard
mythic
Raid
Leaderboard
pet
playable
Class
playable
Race
playable
Specialization
power
Type
profession
pvp
Season
pvp
Tier
quest
realm
realm
Search
recipe
region
reputation
soulbind
spell
spell
Search
talent
tech
Talent
title
token
ua
version
create
Client
Resource
Request
get
Application
Token
get
Client
Resource
prepare
Resource
Request
refresh
Application
Token
set
Application
Token
validate
Application
Token
Generated using
TypeDoc