@blizzard-api/wow 3.0.6 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (224) hide show
  1. package/dist/account-profile/index.d.ts +2 -0
  2. package/dist/account-profile/index.js +104 -0
  3. package/dist/account-profile/index.js.map +1 -0
  4. package/dist/achievements/index.d.ts +2 -0
  5. package/dist/achievements/index.js +61 -0
  6. package/dist/achievements/index.js.map +1 -0
  7. package/dist/auction-house/index.d.ts +2 -0
  8. package/dist/auction-house/index.js +27 -0
  9. package/dist/auction-house/index.js.map +1 -0
  10. package/dist/azerite-essence/index.d.ts +2 -0
  11. package/dist/azerite-essence/index.js +54 -0
  12. package/dist/azerite-essence/index.js.map +1 -0
  13. package/dist/character-achievements/index.d.ts +2 -0
  14. package/dist/character-achievements/index.js +28 -0
  15. package/dist/character-achievements/index.js.map +1 -0
  16. package/dist/character-appearance/index.d.ts +2 -0
  17. package/dist/character-appearance/index.js +16 -0
  18. package/dist/character-appearance/index.js.map +1 -0
  19. package/dist/character-collections/index.d.ts +2 -0
  20. package/dist/character-collections/index.js +72 -0
  21. package/dist/character-collections/index.js.map +1 -0
  22. package/dist/character-encounters/index.d.ts +2 -0
  23. package/dist/character-encounters/index.js +39 -0
  24. package/dist/character-encounters/index.js.map +1 -0
  25. package/dist/character-equipment/index.d.ts +2 -0
  26. package/dist/character-equipment/index.js +16 -0
  27. package/dist/character-equipment/index.js.map +1 -0
  28. package/dist/character-hunter-pets/index.d.ts +2 -0
  29. package/dist/character-hunter-pets/index.js +17 -0
  30. package/dist/character-hunter-pets/index.js.map +1 -0
  31. package/dist/character-media/index.d.ts +2 -0
  32. package/dist/character-media/index.js +16 -0
  33. package/dist/character-media/index.js.map +1 -0
  34. package/dist/character-mythic-keystone-profile/index.d.ts +2 -0
  35. package/dist/character-mythic-keystone-profile/index.js +30 -0
  36. package/dist/character-mythic-keystone-profile/index.js.map +1 -0
  37. package/dist/character-professions/index.d.ts +2 -0
  38. package/dist/character-professions/index.js +16 -0
  39. package/dist/character-professions/index.js.map +1 -0
  40. package/dist/character-profile/index.d.ts +2 -0
  41. package/dist/character-profile/index.js +39 -0
  42. package/dist/character-profile/index.js.map +1 -0
  43. package/dist/character-pvp/index.d.ts +2 -0
  44. package/dist/character-pvp/index.js +28 -0
  45. package/dist/character-pvp/index.js.map +1 -0
  46. package/dist/character-quests/index.d.ts +2 -0
  47. package/dist/character-quests/index.js +27 -0
  48. package/dist/character-quests/index.js.map +1 -0
  49. package/dist/character-reputations/index.d.ts +2 -0
  50. package/dist/character-reputations/index.js +16 -0
  51. package/dist/character-reputations/index.js.map +1 -0
  52. package/dist/character-soulbinds/index.d.ts +2 -0
  53. package/dist/character-soulbinds/index.js +16 -0
  54. package/dist/character-soulbinds/index.js.map +1 -0
  55. package/dist/character-specializations/index.d.ts +2 -0
  56. package/dist/character-specializations/index.js +16 -0
  57. package/dist/character-specializations/index.js.map +1 -0
  58. package/dist/character-statistics/index.d.ts +2 -0
  59. package/dist/character-statistics/index.js +16 -0
  60. package/dist/character-statistics/index.js.map +1 -0
  61. package/dist/character-titles/index.d.ts +2 -0
  62. package/dist/character-titles/index.js +16 -0
  63. package/dist/character-titles/index.js.map +1 -0
  64. package/dist/connected-realm/index.d.ts +2 -0
  65. package/dist/connected-realm/index.js +44 -0
  66. package/dist/connected-realm/index.js.map +1 -0
  67. package/dist/covenant/index.d.ts +2 -0
  68. package/dist/covenant/index.js +80 -0
  69. package/dist/covenant/index.js.map +1 -0
  70. package/dist/creature/index.d.ts +2 -0
  71. package/dist/creature/index.js +97 -0
  72. package/dist/creature/index.js.map +1 -0
  73. package/dist/guild/index.d.ts +2 -0
  74. package/dist/guild/index.js +50 -0
  75. package/dist/guild/index.js.map +1 -0
  76. package/dist/guild-crest/index.d.ts +2 -0
  77. package/dist/guild-crest/index.js +38 -0
  78. package/dist/guild-crest/index.js.map +1 -0
  79. package/dist/heirloom/index.d.ts +2 -0
  80. package/dist/heirloom/index.js +27 -0
  81. package/dist/heirloom/index.js.map +1 -0
  82. package/dist/housing-decor/index.d.ts +2 -0
  83. package/dist/housing-decor/index.js +155 -0
  84. package/dist/housing-decor/index.js.map +1 -0
  85. package/dist/index--WL1Ol2r.d.ts +192 -0
  86. package/dist/index-0hpJYoWw.d.ts +86 -0
  87. package/dist/index-2xjdPrIp.d.ts +34 -0
  88. package/dist/index-8go905Or2.d.ts +46 -0
  89. package/dist/index-B-v4jmT8.d.ts +120 -0
  90. package/dist/index-BAx6xlRe.d.ts +43 -0
  91. package/dist/index-BJYdOuJB2.d.ts +21 -0
  92. package/dist/index-BM5t9AbX2.d.ts +72 -0
  93. package/dist/index-BOz0BCUN2.d.ts +233 -0
  94. package/dist/index-BUSzkCHP2.d.ts +38 -0
  95. package/dist/index-BWGWNZX7.d.ts +62 -0
  96. package/dist/index-BXawY6VA2.d.ts +150 -0
  97. package/dist/index-B_OrLUY42.d.ts +102 -0
  98. package/dist/index-BcKDDvwF.d.ts +85 -0
  99. package/dist/index-Bd_PavJU.d.ts +56 -0
  100. package/dist/index-BgkVcJkr2.d.ts +60 -0
  101. package/dist/index-BuORTLmA.d.ts +29 -0
  102. package/dist/index-C2BXkcO8.d.ts +36 -0
  103. package/dist/index-C9JT3jCN2.d.ts +77 -0
  104. package/dist/index-CE4iGLJf2.d.ts +128 -0
  105. package/dist/index-CH3CudPP.d.ts +91 -0
  106. package/dist/index-CJSqSpru.d.ts +145 -0
  107. package/dist/index-CP1gTrDv.d.ts +312 -0
  108. package/dist/index-CQXTvcKu2.d.ts +72 -0
  109. package/dist/index-CS_QQdEk.d.ts +22 -0
  110. package/dist/index-CWFif_SP2.d.ts +31 -0
  111. package/dist/index-CZy1t3WK.d.ts +160 -0
  112. package/dist/index-ChVDi11Z.d.ts +54 -0
  113. package/dist/index-CmJhDVVk.d.ts +157 -0
  114. package/dist/index-Cry2-cm82.d.ts +123 -0
  115. package/dist/index-Cto5KQ-A2.d.ts +71 -0
  116. package/dist/index-D9u-Oxk6.d.ts +69 -0
  117. package/dist/index-DDHIN-u0.d.ts +36 -0
  118. package/dist/index-DJZZaqMF.d.ts +66 -0
  119. package/dist/index-DLD2tbdk.d.ts +68 -0
  120. package/dist/index-DScltfEW.d.ts +89 -0
  121. package/dist/index-DZqv9GTd.d.ts +125 -0
  122. package/dist/index-DiU4f1cd2.d.ts +45 -0
  123. package/dist/index-DlkM3Nrw2.d.ts +45 -0
  124. package/dist/index-Do1l3j1C.d.ts +283 -0
  125. package/dist/index-DpfeUoRy.d.ts +149 -0
  126. package/dist/index-DvzdYkdL.d.ts +89 -0
  127. package/dist/index-DwuFoDTp.d.ts +159 -0
  128. package/dist/index-DxEXkR_n.d.ts +81 -0
  129. package/dist/index-Dzfv2QaX.d.ts +65 -0
  130. package/dist/index-J46u_PSy2.d.ts +117 -0
  131. package/dist/index-LhUh1Lk5.d.ts +30 -0
  132. package/dist/index-SfMQ7bBi2.d.ts +86 -0
  133. package/dist/index-Xyv-CG_n.d.ts +160 -0
  134. package/dist/index-ZAJGdEvm.d.ts +102 -0
  135. package/dist/index-fbBIJXcV.d.ts +69 -0
  136. package/dist/index-fn_f7xiC.d.ts +21 -0
  137. package/dist/index-h17WWDmt.d.ts +118 -0
  138. package/dist/index-m4fmIRKg.d.ts +35 -0
  139. package/dist/index.d.ts +69 -4738
  140. package/dist/index.js +68 -2137
  141. package/dist/index.js.map +1 -1
  142. package/dist/item/index.d.ts +2 -0
  143. package/dist/item/index.js +98 -0
  144. package/dist/item/index.js.map +1 -0
  145. package/dist/journal/index.d.ts +2 -0
  146. package/dist/journal/index.js +96 -0
  147. package/dist/journal/index.js.map +1 -0
  148. package/dist/media-search/index.d.ts +2 -0
  149. package/dist/media-search/index.js +22 -0
  150. package/dist/media-search/index.js.map +1 -0
  151. package/dist/modified-crafting/index.d.ts +2 -0
  152. package/dist/modified-crafting/index.js +58 -0
  153. package/dist/modified-crafting/index.js.map +1 -0
  154. package/dist/mount/index.d.ts +2 -0
  155. package/dist/mount/index.js +43 -0
  156. package/dist/mount/index.js.map +1 -0
  157. package/dist/mythic-keystone-affix/index.d.ts +2 -0
  158. package/dist/mythic-keystone-affix/index.js +38 -0
  159. package/dist/mythic-keystone-affix/index.js.map +1 -0
  160. package/dist/mythic-keystone-dungeon/index.d.ts +2 -0
  161. package/dist/mythic-keystone-dungeon/index.js +79 -0
  162. package/dist/mythic-keystone-dungeon/index.js.map +1 -0
  163. package/dist/mythic-keystone-leaderboard/index.d.ts +2 -0
  164. package/dist/mythic-keystone-leaderboard/index.js +30 -0
  165. package/dist/mythic-keystone-leaderboard/index.js.map +1 -0
  166. package/dist/mythic-raid-leaderboard/index.d.ts +2 -0
  167. package/dist/mythic-raid-leaderboard/index.js +18 -0
  168. package/dist/mythic-raid-leaderboard/index.js.map +1 -0
  169. package/dist/pet/index.d.ts +2 -0
  170. package/dist/pet/index.js +70 -0
  171. package/dist/pet/index.js.map +1 -0
  172. package/dist/playable-class/index.d.ts +2 -0
  173. package/dist/playable-class/index.js +49 -0
  174. package/dist/playable-class/index.js.map +1 -0
  175. package/dist/playable-race/index.d.ts +2 -0
  176. package/dist/playable-race/index.js +27 -0
  177. package/dist/playable-race/index.js.map +1 -0
  178. package/dist/playable-specialization/index.d.ts +2 -0
  179. package/dist/playable-specialization/index.js +38 -0
  180. package/dist/playable-specialization/index.js.map +1 -0
  181. package/dist/power-type/index.d.ts +2 -0
  182. package/dist/power-type/index.js +27 -0
  183. package/dist/power-type/index.js.map +1 -0
  184. package/dist/profession/index.d.ts +2 -0
  185. package/dist/profession/index.js +72 -0
  186. package/dist/profession/index.js.map +1 -0
  187. package/dist/pvp-season/index.d.ts +2 -0
  188. package/dist/pvp-season/index.js +61 -0
  189. package/dist/pvp-season/index.js.map +1 -0
  190. package/dist/pvp-tier/index.d.ts +2 -0
  191. package/dist/pvp-tier/index.js +38 -0
  192. package/dist/pvp-tier/index.js.map +1 -0
  193. package/dist/quest/index.d.ts +2 -0
  194. package/dist/quest/index.js +90 -0
  195. package/dist/quest/index.js.map +1 -0
  196. package/dist/realm/index.d.ts +24 -0
  197. package/dist/realm/index.js +43 -0
  198. package/dist/realm/index.js.map +1 -0
  199. package/dist/region/index.d.ts +2 -0
  200. package/dist/region/index.js +27 -0
  201. package/dist/region/index.js.map +1 -0
  202. package/dist/reputations/index.d.ts +2 -0
  203. package/dist/reputations/index.js +48 -0
  204. package/dist/reputations/index.js.map +1 -0
  205. package/dist/spell/index.d.ts +2 -0
  206. package/dist/spell/index.js +44 -0
  207. package/dist/spell/index.js.map +1 -0
  208. package/dist/talent/index.d.ts +2 -0
  209. package/dist/talent/index.js +81 -0
  210. package/dist/talent/index.js.map +1 -0
  211. package/dist/tech-talent/index.d.ts +2 -0
  212. package/dist/tech-talent/index.js +59 -0
  213. package/dist/tech-talent/index.js.map +1 -0
  214. package/dist/title/index.d.ts +2 -0
  215. package/dist/title/index.js +27 -0
  216. package/dist/title/index.js.map +1 -0
  217. package/dist/toy/index.d.ts +2 -0
  218. package/dist/toy/index.js +27 -0
  219. package/dist/toy/index.js.map +1 -0
  220. package/dist/types-Z0ZgMUXA.d.ts +79 -0
  221. package/dist/wow-token/index.d.ts +2 -0
  222. package/dist/wow-token/index.js +16 -0
  223. package/dist/wow-token/index.js.map +1 -0
  224. package/package.json +16 -7
package/dist/index.d.ts CHANGED
@@ -1,4741 +1,60 @@
1
- import { BaseSearchParameters, Character, Color, Faction, Factions, Gender, GenderName, Href, KeyBase, Locales, MediaAsset, NameId, NameIdKey, NullishNameIdKey, Origins, ProtectedResource, Realm, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
1
+ import { a as accountProfileSummary, c as protectedCharacterProfileSummary, d as AccountMountsCollectionSummaryResponse, f as AccountPetsCollectionSummaryResponse, g as ProtectedCharacterProfileSummaryResponse, h as AccountTransmogsCollectionSummaryResponse, i as accountPetsCollectionSummary, l as AccountCollectionsIndexResponse, m as AccountToysCollectionSummaryResponse, n as accountHeirloomsCollectionSummary, o as accountToysCollectionSummary, p as AccountProfileSummaryResponse, r as accountMountsCollectionSummary, s as accountTransmogsCollectionSummary, t as accountCollectionsIndex, u as AccountHeirloomsCollectionSummaryResponse } from "./index--WL1Ol2r.js";
2
+ import { a as achievementMedia, c as AchievementIndexResponse, i as achievementIndex, l as AchievementMediaResponse, n as achievementCategory, o as AchievementCategoryIndexResponse, r as achievementCategoryIndex, s as AchievementCategoryResponse, t as achievement, u as AchievementResponse } from "./index-DpfeUoRy.js";
3
+ import { i as AuctionHouseResponse, n as commodities, r as AuctionHouseCommoditiesResponse, t as auctions } from "./index-D9u-Oxk6.js";
4
+ import { a as AzeriteEssenceIndexResponse, c as AzeriteEssenceSearchParameters, i as azeriteEssenceSearch, l as AzeriteEssenceSearchResponse, n as azeriteEssenceIndex, o as AzeriteEssenceMediaResponse, r as azeriteEssenceMedia, s as AzeriteEssenceResponse, t as azeriteEssence } from "./index-DvzdYkdL.js";
5
+ import { i as CharacterAchievementsSummaryResponse, n as characterAchievementsSummary, r as CharacterAchievementStatisticsResponse, t as characterAchievementStatistics } from "./index-DScltfEW.js";
6
+ import { n as CharacterAppearanceResponse, t as characterAppearanceSummary } from "./index-DJZZaqMF.js";
7
+ import { a as characterToysCollectionSummary, c as CharacterHeirloomsCollectionSummaryResponse, d as CharacterToysCollectionSummaryResponse, f as CharacterTransmogCollectionSummaryResponse, i as characterPetsCollectionSummary, l as CharacterMountsCollectionSummaryResponse, n as characterHeirloomsCollectionSummary, o as characterTransmogCollectionSummary, r as characterMountsCollectionSummary, s as CharacterCollectionsIndexResponse, t as characterCollectionsIndex, u as CharacterPetsCollectionSummaryResponse } from "./index-B-v4jmT8.js";
8
+ import { a as CharacterEncountersSummaryResponse, i as CharacterDungeonsResponse, n as characterEncountersSummary, o as CharacterRaidsResponse, r as characterRaids, t as characterDungeons } from "./index-0hpJYoWw.js";
9
+ import { n as CharacterEquipmentSummaryResponse, t as characterEquipmentSummary } from "./index-Xyv-CG_n.js";
10
+ import { n as CharacterHunterPetsSummaryResponse, t as characterHunterPetsSummary } from "./index-LhUh1Lk5.js";
11
+ import { n as CharacterMediaSummaryResponse, t as characterMediaSummary } from "./index-CS_QQdEk.js";
12
+ import { i as CharacterMythicKeystoneSeasonDetailsResponse, n as characterMythicKeystoneSeasonDetails, r as CharacterMythicKeystoneProfileIndexResponse, t as characterMythicKeystoneProfileIndex } from "./index-Dzfv2QaX.js";
13
+ import { n as CharacterProfessionsSummaryResponse, t as characterProfessionsSummary } from "./index-m4fmIRKg.js";
14
+ import { i as CharacterProfileSummaryResponse, n as characterProfileSummary, r as CharacterProfileStatusResponse, t as characterProfileStatus } from "./index-BcKDDvwF.js";
15
+ import { i as CharacterPvpSummaryResponse, n as characterPvpSummary, r as CharacterPvpBracketStatisticsResponse, t as characterPvpBracketStatistics } from "./index-ChVDi11Z.js";
16
+ import { i as CharacterQuestsResponse, n as characterQuests, r as CharacterCompletedQuestsResponse, t as characterCompletedQuests } from "./index-BuORTLmA.js";
17
+ import { n as CharacterReputationsSummaryResponse, t as characterReputationsSummary } from "./index-C2BXkcO8.js";
18
+ import { n as CharacterSoulbindsResponse, t as characterSoulbinds } from "./index-BAx6xlRe.js";
19
+ import { n as CharacterSpecializationsSummaryResponse, t as characterSpecializationsSummary } from "./index-DLD2tbdk.js";
20
+ import { n as CharacterStatisticsSummaryResponse, t as characterStatisticsSummary } from "./index-fbBIJXcV.js";
21
+ import { n as CharacterTitlesSummaryResponse, t as characterTitlesSummary } from "./index-fn_f7xiC.js";
22
+ import { a as RealmSearchParameters, c as RealmTypeCapitalized, i as RealmResponse, n as RealmIndexResponse, o as RealmSearchResponse, r as RealmLocales, s as RealmTimezone, t as RealmCategory } from "./types-Z0ZgMUXA.js";
23
+ import { a as ConnectedRealmResponse, i as ConnectedRealmIndexResponse, n as connectedRealmIndex, o as ConnectedRealmSearchParameters, r as connectedRealmSearch, s as ConnectedRealmSearchResponse, t as connectedRealm } from "./index-DZqv9GTd.js";
24
+ import { a as covenantMedia, c as ConduitIndexResponse, d as CovenantMediaResponse, f as CovenantResponse, i as covenantIndex, l as ConduitResponse, m as SoulbindResponse, n as conduitIndex, o as soulbind, p as SoulbindIndexResponse, r as covenant, s as soulbindIndex, t as conduit, u as CovenantIndexResponse } from "./index-CmJhDVVk.js";
25
+ import { _ as CreatureTypeResponse, a as creatureFamilyMedia, c as creatureTypeIndex, d as CreatureFamilyMediaResponse, f as CreatureFamilyResponse, g as CreatureTypeIndexResponse, h as CreatureSearchResponse, i as creatureFamilyIndex, l as CreatureDisplayMediaResponse, m as CreatureSearchParameters, n as creatureDisplayMedia, o as creatureSearch, p as CreatureResponse, r as creatureFamily, s as creatureType, t as creature, u as CreatureFamilyIndexResponse } from "./index-DwuFoDTp.js";
26
+ import { a as GuildCrestComponentsIndexResponse, i as GuildCrestBorderEmblemResponse, n as guildCrestComponentsIndex, r as guildCrestEmblem, t as guildCrestBorder } from "./index-BWGWNZX7.js";
27
+ import { a as GuildAchievementsResponse, c as GuildRosterResponse, i as guildRoster, n as guildAchievements, o as GuildActivityResponse, r as guildActivity, s as GuildResponse, t as guild } from "./index-CJSqSpru.js";
28
+ import { i as HeirloomResponse, n as heirloomIndex, r as HeirloomIndexResponse, t as heirloom } from "./index-ZAJGdEvm.js";
29
+ import { C as RoomIndexReponse, S as GenericDecorSearchParameters, T as RoomSearchResponse, _ as FixtureHookResponse, a as fixtureHook, b as FixtureResponse, c as fixtureIndex, d as roomIndex, f as roomSearch, g as FixtureHookIndexResponse, h as DecorSearchResponse, i as fixture, l as fixtureSearch, m as DecorResponse, n as decorIndex, o as fixtureHookIndex, p as DecorIndexResponse, r as decorSearch, s as fixtureHookSearch, t as decor, u as room, v as FixtureHookSearchResponse, w as RoomResponse, x as FixtureSearchResponse, y as FixtureIndexResponse } from "./index-CZy1t3WK.js";
30
+ import { _ as ItemSubClassResponse, a as itemSearch, c as itemSubClass, d as ItemMediaResponse, f as ItemResponse, g as ItemSetResponse, h as ItemSetIndexResponse, i as itemMedia, l as ItemClassIndexResponse, m as ItemSearchResponse, n as itemClass, o as itemSet, p as ItemSearchParameters, r as itemClassIndex, s as itemSetIndex, t as item, u as ItemClassResponse } from "./index-CP1gTrDv.js";
31
+ import { _ as JournalInstanceResponse, a as journalExpansionIndex, c as journalInstanceMedia, d as JournalEncounterSearchParameters, f as JournalEncounterSearchResponse, g as JournalInstanceMediaResponse, h as JournalInstanceIndexResponse, i as journalExpansion, l as JournalEncounterIndexResponse, m as JournalExpansionResponse, n as journalEncounterIndex, o as journalInstance, p as JournalExpansionIndexResponse, r as journalEncounterSearch, s as journalInstanceIndex, t as journalEncounter, u as JournalEncounterResponse } from "./index-Do1l3j1C.js";
32
+ import { n as MediaSearchParameters, r as MediaSearchResponse, t as mediaSearch } from "./index-DDHIN-u0.js";
33
+ import { a as modifiedCraftingReagentSlotTypeIndex, c as ModifiedCraftingIndexResponse, i as modifiedCraftingReagentSlotType, l as ModifiedCraftingReagentSlotTypeIndexResponse, n as modifiedCraftingCategoryIndex, o as ModifiedCraftingCategoryIndexResponse, r as modifiedCraftingIndex, s as ModifiedCraftingCategoryResponse, t as modifiedCraftingCategory, u as ModifiedCraftingReagentSlotTypeResponse } from "./index-DxEXkR_n.js";
34
+ import { a as MountResponse, i as MountIndexResponse, n as mountIndex, o as MountSearchParameters, r as mountSearch, s as MountSearchResponse, t as mount } from "./index-CH3CudPP.js";
35
+ import { a as MythicKeystoneAffixMediaResponse, i as MythicKeystoneAffixIndexResponse, n as mythicKeystoneAffixIndex, o as MythicKeystoneAffixResponse, r as mythicKeystoneAffixMedia, t as mythicKeystoneAffix } from "./index-Bd_PavJU.js";
36
+ import { a as mythicKeystonePeriodIndex, c as MythicKeystoneDungeonIndexResponse, d as MythicKeystonePeriodIndexResponse, f as MythicKeystonePeriodResponse, i as mythicKeystonePeriod, l as MythicKeystoneDungeonResponse, m as MythicKeystoneSeasonResponse, n as mythicKeystoneDungeonIndex, o as mythicKeystoneSeason, p as MythicKeystoneSeasonIndexResponse, r as mythicKeystoneIndex, s as mythicKeystoneSeasonIndex, t as mythicKeystoneDungeon, u as MythicKeystoneIndexResponse } from "./index-h17WWDmt.js";
37
+ import { i as MythicKeystoneLeaderboardResponse, n as mythicKeystoneLeaderboardIndex, r as MythicKeystoneLeaderboardIndexResponse, t as mythicKeystoneLeaderboard } from "./index-CQXTvcKu2.js";
38
+ import { n as MythicRaidLeaderboardResponse, t as mythicRaidLeaderboard } from "./index-8go905Or2.js";
39
+ import { a as petIndex, c as PetAbilityMediaResponse, d as PetMediaResponse, f as PetResponse, i as petAbilityMedia, l as PetAbilityResponse, n as petAbility, o as petMedia, r as petAbilityIndex, s as PetAbilityIndexResponse, t as pet, u as PetIndexResponse } from "./index-J46u_PSy2.js";
40
+ import { a as PlayableClassIndexResponse, c as PvpTalentSlotsResponse, i as pvpTalentSlots, n as playableClassIndex, o as PlayableClassMediaResponse, r as playableClassMedia, s as PlayableClassResponse, t as playableClass } from "./index-BM5t9AbX2.js";
41
+ import { i as PlayableRaceResponse, n as playableRaceIndex, r as PlayableRaceIndexResponse, t as playableRace } from "./index-BUSzkCHP2.js";
42
+ import { a as PlayableSpecializationMediaResponse, i as PlayableSpecializationIndexResponse, n as playableSpecializationIndex, o as PlayableSpecializationResponse, r as playableSpecializationMedia, t as playableSpecialization } from "./index-C9JT3jCN2.js";
43
+ import { i as PowerTypeResponse, n as powerTypeIndex, r as PowerTypeIndexResponse, t as powerType } from "./index-CWFif_SP2.js";
44
+ import { a as recipe, c as ProfessionMediaResponse, d as RecipeMediaResponse, f as RecipeResponse, i as professionSkillTier, l as ProfessionResponse, n as professionIndex, o as recipeMedia, r as professionMedia, s as ProfessionIndexResponse, t as profession, u as ProfessionSkillTierResponse } from "./index-CE4iGLJf2.js";
45
+ import { a as pvpSeasonIndex, c as PvpRewardsIndexResponse, i as pvpSeason, l as PvpSeasonIndexResponse, n as pvpLeaderboardIndex, o as PvpLeaderboardIndexResponse, r as pvpRewardsIndex, s as PvpLeaderboardResponse, t as pvpLeaderboard, u as PvpSeasonResponse } from "./index-Cry2-cm82.js";
46
+ import { a as PvpTierMediaResponse, i as PvpTierIndexResponse, n as pvpTierIndex, o as PvpTierResponse, r as pvpTierMedia, t as pvpTier } from "./index-BgkVcJkr2.js";
47
+ import { a as questCategoryIndex, c as questTypeIndex, d as QuestCategoryIndexResponse, f as QuestCategoryResponse, g as QuestTypeResponse, h as QuestTypeIndexResponse, i as questCategory, l as QuestAreaIndexResponse, m as QuestResponse, n as questArea, o as questIndex, p as QuestIndexResponse, r as questAreaIndex, s as questType, t as quest, u as QuestAreaResponse } from "./index-BXawY6VA2.js";
48
+ import { realm, realmIndex, realmSearch } from "./realm/index.js";
49
+ import { i as RegionResponse, n as regionIndex, r as RegionIndexResponse, t as region } from "./index-2xjdPrIp.js";
50
+ import { a as ReputationFactionIndexResponse, c as ReputationTiersResponse, i as reputationTiersIndex, n as reputationFactionIndex, o as ReputationFactionResponse, r as reputationTiers, s as ReputationTiersIndexResponse, t as reputationFaction } from "./index-SfMQ7bBi2.js";
51
+ import { a as SpellResponse, i as SpellMediaResponse, n as spellMedia, o as SpellSearchParameters, r as spellSearch, s as SpellSearchResponse, t as spell } from "./index-Cto5KQ-A2.js";
52
+ import { a as talentTree, c as PvpTalentIndexResponse, d as TalentResponse, f as TalentTreeIndexResponse, i as talentIndex, l as PvpTalentResponse, m as TalentTreeResponse, n as pvpTalentIndex, o as talentTreeIndex, p as TalentTreeNodesResponse, r as talent, s as talentTreeNodes, t as pvpTalent, u as TalentIndexResponse } from "./index-BOz0BCUN2.js";
53
+ import { a as techTalentTreeIndex, c as TechTalentResponse, i as techTalentTree, l as TechTalentTreeIndexResponse, n as techTalentIndex, o as TechTalentIndexResponse, r as techTalentMedia, s as TechTalentMediaResponse, t as techTalent, u as TechTalentTreeResponse } from "./index-B_OrLUY42.js";
54
+ import { i as TitleResponse, n as titleIndex, r as TitleIndexResponse, t as title } from "./index-DiU4f1cd2.js";
55
+ import { i as ToyResponse, n as toyIndex, r as ToyIndexResponse, t as toy } from "./index-DlkM3Nrw2.js";
56
+ import { n as WowTokenResponse, t as wowToken } from "./index-BJYdOuJB2.js";
2
57
 
3
- //#region src/account-profile/types.d.ts
4
- interface AccountCollectionsIndexResponse {
5
- _links: Links;
6
- heirlooms: Href;
7
- mounts: Href;
8
- pets: Href;
9
- toys: Href;
10
- transmogs: Href;
11
- }
12
- interface AccountHeirloomsCollectionSummaryResponse {
13
- _links: Links;
14
- heirlooms: Array<Heirloom$1>;
15
- }
16
- interface AccountMountsCollectionSummaryResponse {
17
- _links: Links;
18
- mounts: Array<Mount$1>;
19
- }
20
- interface AccountPetsCollectionSummaryResponse {
21
- _links: Links;
22
- pets: Array<Pet$1>;
23
- unlocked_battle_pet_slots: number;
24
- }
25
- interface AccountProfileSummaryResponse {
26
- _links: Links;
27
- collections: Href;
28
- id: number;
29
- wow_accounts?: Array<WowAccount>;
30
- }
31
- interface AccountToysCollectionSummaryResponse {
32
- _links: Links;
33
- toys: Array<Toy$1>;
34
- }
35
- interface AccountTransmogsCollectionSummaryResponse {
36
- _links: Links;
37
- appearance_sets: Array<NameIdKey>;
38
- slots: Array<Slot$1>;
39
- }
40
- interface ProtectedCharacterProfileSummaryResponse {
41
- _links: Links;
42
- bind_position: Position;
43
- character: Realm;
44
- id: number;
45
- money: number;
46
- name: string;
47
- position: Position;
48
- protected_stats: ProtectedStats;
49
- wow_account: number;
50
- }
51
- interface Character$2 {
52
- character: Href;
53
- faction: Faction;
54
- gender: Gender;
55
- id: number;
56
- level: number;
57
- name: string;
58
- playable_class: NameIdKey;
59
- playable_race: NameIdKey;
60
- protected_character: Href;
61
- realm: Realm;
62
- }
63
- interface Heirloom$1 {
64
- heirloom: NameIdKey;
65
- upgrade: {
66
- level: number;
67
- };
68
- }
69
- interface Links {
70
- profile: Href;
71
- self: Href;
72
- user: Href;
73
- }
74
- interface Mount$1 {
75
- is_favorite?: boolean;
76
- mount: NameIdKey;
77
- }
78
- interface Pet$1 {
79
- active_slot?: number;
80
- creature_display?: KeyBase & {
81
- id: number;
82
- };
83
- id: number;
84
- is_active?: boolean;
85
- is_favorite?: boolean;
86
- level: number;
87
- name?: string;
88
- quality: Quality$1;
89
- species: NameIdKey;
90
- stats: Stats$1;
91
- }
92
- interface Position {
93
- facing: number;
94
- map: NameId;
95
- x: number;
96
- y: number;
97
- z: number;
98
- zone: NameId;
99
- }
100
- interface ProtectedStats {
101
- level_gold_gained: number;
102
- level_gold_lost: number;
103
- level_item_value_gained: number;
104
- level_number_deaths: number;
105
- total_gold_gained: number;
106
- total_gold_lost: number;
107
- total_item_value_gained: number;
108
- total_number_deaths: number;
109
- }
110
- interface Quality$1 {
111
- name: string;
112
- type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
113
- }
114
- interface Slot$1 {
115
- appearances: Array<KeyBase & {
116
- id: number;
117
- }>;
118
- slot: Slot$1;
119
- }
120
- interface Slot$1 {
121
- name: string;
122
- type: string;
123
- }
124
- interface Stats$1 {
125
- breed_id: number;
126
- health: number;
127
- power: number;
128
- speed: number;
129
- }
130
- interface Toy$1 {
131
- is_favorite?: boolean;
132
- toy: NameIdKey;
133
- }
134
- interface WowAccount {
135
- characters: Array<Character$2>;
136
- id: number;
137
- }
138
- //#endregion
139
- //#region src/account-profile/account-profile.d.ts
140
- /**
141
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
142
- * @param token The OAuth 2.0 access token to use for authentication.
143
- * @returns an index of collection types for an account.
144
- */
145
- declare function accountCollectionsIndex(token: string): ProtectedResource<AccountCollectionsIndexResponse>;
146
- /**
147
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
148
- * @param token The OAuth 2.0 access token to use for authentication.
149
- * @returns a summary of the heirlooms an account has obtained.
150
- */
151
- declare function accountHeirloomsCollectionSummary(token: string): ProtectedResource<AccountHeirloomsCollectionSummaryResponse>;
152
- /**
153
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
154
- * @param token The OAuth 2.0 access token to use for authentication.
155
- * @returns a summary of the mounts an account has obtained.
156
- */
157
- declare function accountMountsCollectionSummary(token: string): ProtectedResource<AccountMountsCollectionSummaryResponse>;
158
- /**
159
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
160
- * @param token The OAuth 2.0 access token to use for authentication.
161
- * @returns a summary of the battle pets an account has obtained.
162
- */
163
- declare function accountPetsCollectionSummary(token: string): ProtectedResource<AccountPetsCollectionSummaryResponse>;
164
- /**
165
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
166
- * @param token The OAuth 2.0 access token to use for authentication.
167
- * @returns a profile summary for an account.
168
- */
169
- declare function accountProfileSummary(token: string): ProtectedResource<AccountProfileSummaryResponse>;
170
- /**
171
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
172
- * @param token The OAuth 2.0 access token to use for authentication.
173
- * @returns a summary of the toys an account has obtained.
174
- */
175
- declare function accountToysCollectionSummary(token: string): ProtectedResource<AccountToysCollectionSummaryResponse>;
176
- /**
177
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
178
- * @param token The OAuth 2.0 access token to use for authentication.
179
- * @returns a summary of the transmog unlocks an account has obtained.
180
- */
181
- declare function accountTransmogsCollectionSummary(token: string): ProtectedResource<AccountTransmogsCollectionSummaryResponse>;
182
- /**
183
- * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
184
- * @param realmId The realm ID.
185
- * @param characterId The character ID.
186
- * @param token The OAuth 2.0 access token to use for authentication.
187
- * @returns a protected profile summary for a character.
188
- */
189
- declare function protectedCharacterProfileSummary(realmId: number, characterId: number, token: string): ProtectedResource<ProtectedCharacterProfileSummaryResponse>;
190
- //#endregion
191
- //#region src/achievements/types.d.ts
192
- /**
193
- * Interface for a response from the achievement category index endpoint.
194
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
195
- */
196
- interface AchievementCategoryIndexResponse extends ResponseBase {
197
- categories: Array<NameIdKey>;
198
- guild_categories: Array<NameIdKey>;
199
- root_categories: Array<NameIdKey>;
200
- }
201
- /**
202
- * Interface for a response from the achievement category endpoint.
203
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
204
- */
205
- interface AchievementCategoryResponse extends NameId, ResponseBase {
206
- achievements: Array<NameIdKey>;
207
- aggregates_by_faction: {
208
- alliance: {
209
- points: number;
210
- quantity: number;
211
- };
212
- horde: {
213
- points: number;
214
- quantity: number;
215
- };
216
- };
217
- display_order: number;
218
- is_guild_category: boolean;
219
- parent_category?: NameIdKey;
220
- subcategories?: Array<NameIdKey>;
221
- }
222
- /**
223
- * Interface for a response from the achievement index endpoint.
224
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
225
- */
226
- interface AchievementIndexResponse extends ResponseBase {
227
- achievements: Array<NameIdKey>;
228
- }
229
- /**
230
- * Interface for a response from the achievement media endpoint.
231
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
232
- */
233
- interface AchievementMediaResponse extends ResponseBase {
234
- assets: Array<MediaAsset>;
235
- id: number;
236
- }
237
- /**
238
- * Interface for a response from the achievement endpoint.
239
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
240
- */
241
- interface AchievementResponse extends NameId, ResponseBase {
242
- category: NameIdKey;
243
- criteria?: Criteria$2;
244
- description: string;
245
- display_order: number;
246
- guild_reward_items?: Array<NameIdKey>;
247
- is_account_wide: boolean;
248
- media: KeyBase & {
249
- id: number;
250
- };
251
- next_achievement?: NameIdKey;
252
- points: number;
253
- prerequisite_achievement?: NameIdKey;
254
- requirements?: {
255
- faction: Faction;
256
- };
257
- reward_description?: string;
258
- reward_item?: NameIdKey;
259
- }
260
- interface ChildCriteria {
261
- achievement?: NameIdKey;
262
- amount: number;
263
- child_criteria?: Array<ChildCriteria2>;
264
- description: null | string;
265
- faction?: Faction;
266
- id: number;
267
- is_gold?: boolean;
268
- operator?: Operator;
269
- show_progress_bar?: boolean;
270
- }
271
- interface ChildCriteria2 {
272
- achievement?: NameIdKey;
273
- amount: number;
274
- child_criteria?: Array<ChildCriteria3>;
275
- description: null | string;
276
- faction?: Faction;
277
- id: number;
278
- is_gold?: boolean;
279
- operator?: Operator;
280
- show_progress_bar?: boolean;
281
- }
282
- interface ChildCriteria3 {
283
- achievement?: NameIdKey;
284
- amount: number;
285
- description: null | string;
286
- faction?: Faction;
287
- id: number;
288
- is_gold?: boolean;
289
- operator?: Operator;
290
- show_progress_bar?: boolean;
291
- }
292
- interface Criteria$2 {
293
- amount: number;
294
- child_criteria?: Array<ChildCriteria>;
295
- description: null | string;
296
- faction?: Faction;
297
- id: number;
298
- operator?: Operator;
299
- show_progress_bar?: boolean;
300
- }
301
- interface Operator {
302
- name: string;
303
- type: 'AND' | 'COMPLETE_AT_LEAST';
304
- }
305
- //#endregion
306
- //#region src/achievements/achievements.d.ts
307
- /**
308
- * Get an achievement by ID.
309
- * @param achievementId The achievement ID.
310
- * @returns The achievement. See {@link AchievementResponse}.
311
- */
312
- declare function achievement(achievementId: number): Resource<AchievementResponse>;
313
- /**
314
- * Get an achievement category by ID.
315
- * @param achievementCategoryId The achievement category ID.
316
- * @returns The achievement category. See {@link AchievementCategoryResponse}.
317
- */
318
- declare function achievementCategory(achievementCategoryId: number): Resource<AchievementCategoryResponse>;
319
- /**
320
- * Get an achievement category index.
321
- * @returns The achievement category index. See {@link AchievementCategoryIndexResponse}.
322
- */
323
- declare function achievementCategoryIndex(): Resource<AchievementCategoryIndexResponse>;
324
- /**
325
- * Get an achievement index.
326
- * @returns The achievement index. See {@link AchievementIndexResponse}.
327
- */
328
- declare function achievementIndex(): Resource<AchievementIndexResponse>;
329
- /**
330
- * Get achievement media by ID.
331
- * @param achievementId The achievement ID.
332
- * @returns The achievement media. See {@link AchievementMediaResponse}.
333
- */
334
- declare function achievementMedia(achievementId: number): Resource<AchievementMediaResponse>;
335
- //#endregion
336
- //#region src/auction-house/types.d.ts
337
- /**
338
- * Interface for a response from the auction house commodities endpoint.
339
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
340
- */
341
- interface AuctionHouseCommoditiesResponse extends ResponseBase {
342
- auctions: Array<AuctionHouseCommodity>;
343
- }
344
- /**
345
- * Interface for a response from the auction house endpoint.
346
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
347
- */
348
- interface AuctionHouseResponse extends ResponseBase {
349
- auctions: Array<AuctionHousePosting>;
350
- commodities: {
351
- href: string;
352
- };
353
- connected_realm: {
354
- href: string;
355
- };
356
- }
357
- interface AuctionHouseCommodity {
358
- id: number;
359
- item: {
360
- id: number;
361
- };
362
- quantity: number;
363
- time_left: AuctionHouseTimeLeft;
364
- unit_price: number;
365
- }
366
- interface AuctionHousePosting {
367
- bid?: number;
368
- buyout: number;
369
- id: number;
370
- item: {
371
- bonus_lists?: Array<number>;
372
- context?: number;
373
- id: number;
374
- modifiers?: Array<{
375
- type: number;
376
- value: number;
377
- }>;
378
- pet_breed_id?: number;
379
- pet_level?: number;
380
- pet_quality_id?: number;
381
- pet_species_id?: number;
382
- };
383
- quantity: number;
384
- time_left: AuctionHouseTimeLeft;
385
- }
386
- type AuctionHouseTimeLeft = 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
387
- //#endregion
388
- //#region src/auction-house/auction-house.d.ts
389
- /**
390
- * Get auction house data for a connected realm.
391
- * @param connectedRealmId The ID of the connected realm.
392
- * @returns The auction house data. See {@link AuctionHouseResponse}.
393
- */
394
- declare function auctions(connectedRealmId: number): Resource<AuctionHouseResponse>;
395
- /**
396
- * Get auction house data for all connected realms.
397
- * @returns The auction house data. See {@link AuctionHouseResponse}.
398
- */
399
- declare function commodities(): Resource<AuctionHouseCommoditiesResponse>;
400
- //#endregion
401
- //#region src/azerite-essence/types.d.ts
402
- /**
403
- * Interface for a response from the azerite essence index endpoint.
404
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
405
- */
406
- interface AzeriteEssenceIndexResponse extends ResponseBase {
407
- azerite_essences: Array<NameIdKey>;
408
- }
409
- /**
410
- * Interface for a response from the azerite essence media endpoint.
411
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
412
- */
413
- interface AzeriteEssenceMediaResponse extends ResponseBase {
414
- assets: Array<MediaAsset>;
415
- id: number;
416
- }
417
- /**
418
- * Interface for a response from the azerite essence endpoint.
419
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
420
- */
421
- interface AzeriteEssenceResponse extends NameId, ResponseBase {
422
- allowed_specializations: Array<NameIdKey>;
423
- media: Media$15;
424
- powers: Array<Power>;
425
- }
426
- /**
427
- * Interface for search parameters for azerite essences.
428
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
429
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
430
- */
431
- interface AzeriteEssenceSearchParameters extends BaseSearchParameters {
432
- 'allowed_specializations.id'?: number;
433
- }
434
- /**
435
- * Interface for a response item from the azerite essence search endpoint.
436
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
437
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
438
- */
439
- interface AzeriteEssenceSearchResponse extends SearchResponseWithoutResults {
440
- results: Array<AzeriteEssenceSearchResponseItem>;
441
- }
442
- interface AzeriteEssenceSearchResponseItem extends KeyBase {
443
- data: {
444
- allowed_specializations: Array<{
445
- id: number;
446
- name: Record<Locales, string>;
447
- }>;
448
- name: Record<Locales, string>;
449
- };
450
- }
451
- interface Media$15 extends KeyBase {
452
- id: number;
453
- }
454
- interface Power {
455
- id: number;
456
- main_power_spell: NameIdKey;
457
- passive_power_spell: NameIdKey;
458
- rank: number;
459
- }
460
- //#endregion
461
- //#region src/azerite-essence/azerite-essence.d.ts
462
- /**
463
- * Get an azerite essence by ID.
464
- * @param azeriteEssenceId The azerite essence ID.
465
- * @returns The azerite essence. See {@link AzeriteEssenceResponse}.
466
- */
467
- declare function azeriteEssence(azeriteEssenceId: number): Resource<AzeriteEssenceResponse>;
468
- /**
469
- * Get an azerite essence index.
470
- * @returns The azerite essence index. See {@link AzeriteEssenceIndexResponse}.
471
- */
472
- declare function azeriteEssenceIndex(): Resource<AzeriteEssenceIndexResponse>;
473
- /**
474
- * Get azerite essence media by ID.
475
- * @param azeriteEssenceId The azerite essence ID.
476
- * @returns The azerite essence media. See {@link AzeriteEssenceMediaResponse}.
477
- */
478
- declare function azeriteEssenceMedia(azeriteEssenceId: number): Resource<AzeriteEssenceMediaResponse>;
479
- /**
480
- * Search for azerite essences.
481
- * @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
482
- * @returns The search results. See {@link AzeriteEssenceSearchResponse}.
483
- */
484
- declare function azeriteEssenceSearch(options: AzeriteEssenceSearchParameters): Resource<AzeriteEssenceSearchResponse, AzeriteEssenceSearchParameters>;
485
- //#endregion
486
- //#region src/character-achievements/types.d.ts
487
- interface CharacterAchievementsSummaryResponse extends ResponseBase {
488
- achievements: Array<Achievement$1>;
489
- category_progress: Array<CategoryProgress$1>;
490
- character: Character;
491
- recent_events: Array<RecentEvent$1>;
492
- statistics: Href;
493
- total_points: number;
494
- total_quantity: number;
495
- }
496
- interface CharacterAchievementStatisticsResponse extends ResponseBase {
497
- categories: Array<Category$2>;
498
- character: Character;
499
- }
500
- interface Achievement$1 {
501
- achievement: NameIdKey;
502
- completed_timestamp?: number;
503
- criteria?: Criteria$1;
504
- id: number;
505
- }
506
- interface Category$2 {
507
- id?: number;
508
- name: string;
509
- statistics?: Array<Statistic>;
510
- sub_categories?: Array<SubCategory>;
511
- }
512
- interface CategoryProgress$1 {
513
- category: NameIdKey;
514
- points: number;
515
- quantity: number;
516
- }
517
- interface ChildCriterum$1 {
518
- amount?: number;
519
- child_criteria?: Array<ChildCriterum2>;
520
- id: number;
521
- is_completed: boolean;
522
- }
523
- interface ChildCriterum2 {
524
- amount?: number;
525
- child_criteria?: Array<ChildCriterum3>;
526
- id: number;
527
- is_completed: boolean;
528
- }
529
- interface ChildCriterum3 {
530
- amount?: number;
531
- id: number;
532
- is_completed: boolean;
533
- }
534
- interface Criteria$1 {
535
- amount?: number;
536
- child_criteria?: Array<ChildCriterum$1>;
537
- id: number;
538
- is_completed: boolean;
539
- }
540
- interface RecentEvent$1 {
541
- achievement: NameIdKey;
542
- timestamp: number;
543
- }
544
- interface Statistic {
545
- description?: null | string;
546
- id: number;
547
- last_updated_timestamp: number;
548
- name: string;
549
- quantity: number;
550
- }
551
- interface SubCategory {
552
- id: number;
553
- name: string;
554
- statistics: Array<Statistic>;
555
- }
556
- //#endregion
557
- //#region src/character-achievements/character-achievements.d.ts
558
- /**
559
- * @param realmSlug The slug of the realm.
560
- * @param characterName The lowercase name of the character.
561
- * @returns a summary of the achievements a character has completed.
562
- */
563
- declare function characterAchievementsSummary(realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
564
- /**
565
- * @param realmSlug The slug of the realm.
566
- * @param characterName The lowercase name of the character.
567
- * @returns a character's statistics as they pertain to achievements.
568
- */
569
- declare function characterAchievementStatistics(realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
570
- //#endregion
571
- //#region src/character-appearance/types.d.ts
572
- interface CharacterAppearanceResponse extends ResponseBase {
573
- active_spec: NameIdKey;
574
- character: Character;
575
- customizations: Array<Customization>;
576
- faction: Faction;
577
- gender: Gender;
578
- guild_crest: GuildCrest;
579
- items: Array<Item$1>;
580
- playable_class: NameIdKey;
581
- playable_race: NameIdKey;
582
- }
583
- interface BorderEmblem {
584
- color: RGBWithId;
585
- id: number;
586
- media: KeyBase & {
587
- id: number;
588
- };
589
- }
590
- interface Choice {
591
- display_order: number;
592
- id: number;
593
- name?: null | string;
594
- }
595
- interface Customization {
596
- choice: Choice;
597
- option: NameId;
598
- }
599
- interface GuildCrest {
600
- background: {
601
- color: RGBWithId;
602
- };
603
- border: BorderEmblem;
604
- emblem: BorderEmblem;
605
- }
606
- interface Item$1 {
607
- enchant: number;
608
- id: number;
609
- internal_slot_id: number;
610
- item_appearance_modifier_id?: number;
611
- secondary_id?: number;
612
- secondary_item_appearance_modifier_id?: number;
613
- secondary_subclass?: number;
614
- slot: {
615
- name: string;
616
- type: string;
617
- };
618
- subclass?: number;
619
- }
620
- interface RGBWithId {
621
- id: number;
622
- rgba: Color;
623
- }
624
- //#endregion
625
- //#region src/character-appearance/character-appearance.d.ts
626
- /**
627
- * @param realmSlug The slug of the realm.
628
- * @param characterName The lowercase name of the character.
629
- * @returns a summary of a character's appearance settings.
630
- */
631
- declare function characterAppearanceSummary(realmSlug: string, characterName: string): Resource<CharacterAppearanceResponse>;
632
- //#endregion
633
- //#region src/character-collections/types.d.ts
634
- interface CharacterCollectionsIndexResponse extends ResponseBase {
635
- character: Character;
636
- decors: Href;
637
- heirlooms: Href;
638
- mounts: Href;
639
- pets: Href;
640
- toys: Href;
641
- transmogs: Href;
642
- }
643
- interface CharacterHeirloomsCollectionSummaryResponse extends ResponseBase {
644
- heirlooms: Array<Heirloom>;
645
- }
646
- interface CharacterMountsCollectionSummaryResponse extends ResponseBase {
647
- mounts: Array<Mount>;
648
- }
649
- interface CharacterPetsCollectionSummaryResponse extends ResponseBase {
650
- pets: Array<Pet>;
651
- unlocked_battle_pet_slots: number;
652
- }
653
- interface CharacterToysCollectionSummaryResponse extends ResponseBase {
654
- toys: Array<Toy>;
655
- }
656
- interface CharacterTransmogCollectionSummaryResponse extends ResponseBase {
657
- appearance_sets: Array<NameIdKey>;
658
- slots: Array<Slot>;
659
- }
660
- interface Heirloom {
661
- heirloom: NameIdKey;
662
- upgrade: {
663
- level: number;
664
- };
665
- }
666
- interface Mount {
667
- is_character_specific?: boolean;
668
- is_favorite?: boolean;
669
- is_useable: boolean;
670
- mount: NameIdKey;
671
- }
672
- interface Pet {
673
- active_slot?: number;
674
- creature_display?: KeyBase & {
675
- id: number;
676
- };
677
- id: number;
678
- is_active?: boolean;
679
- is_favorite?: boolean;
680
- level: number;
681
- name?: string;
682
- quality: Quality;
683
- species: NameIdKey;
684
- stats: Stats;
685
- }
686
- interface Quality {
687
- name: string;
688
- type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
689
- }
690
- interface Slot {
691
- appearances: Array<KeyBase & {
692
- id: number;
693
- }>;
694
- slot: SlotSlot;
695
- }
696
- interface SlotSlot {
697
- name: string;
698
- type: string;
699
- }
700
- interface Stats {
701
- breed_id: number;
702
- health: number;
703
- power: number;
704
- speed: number;
705
- }
706
- interface Toy {
707
- is_favorite?: boolean;
708
- toy: NameIdKey;
709
- }
710
- //#endregion
711
- //#region src/character-collections/character-collections.d.ts
712
- /**
713
- * @param realmSlug The slug of the realm.
714
- * @param characterName The lowercase name of the character.
715
- * @returns an index of collection types for a character.
716
- */
717
- declare function characterCollectionsIndex(realmSlug: string, characterName: string): Resource<CharacterCollectionsIndexResponse>;
718
- /**
719
- * @param realmSlug The slug of the realm.
720
- * @param characterName The lowercase name of the character.
721
- * @returns a summary of the heirlooms a character has obtained.
722
- */
723
- declare function characterHeirloomsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterHeirloomsCollectionSummaryResponse>;
724
- /**
725
- * @param realmSlug The slug of the realm.
726
- * @param characterName The lowercase name of the character.
727
- * @returns a summary of the mounts a character has obtained.
728
- */
729
- declare function characterMountsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterMountsCollectionSummaryResponse>;
730
- /**
731
- * @param realmSlug The slug of the realm.
732
- * @param characterName The lowercase name of the character.
733
- * @returns a summary of the battle pets a character has obtained.
734
- */
735
- declare function characterPetsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterPetsCollectionSummaryResponse>;
736
- /**
737
- * @param realmSlug The slug of the realm.
738
- * @param characterName The lowercase name of the character.
739
- * @returns a summary of the toys a character has obtained.
740
- */
741
- declare function characterToysCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterToysCollectionSummaryResponse>;
742
- /**
743
- * @param realmSlug The slug of the realm.
744
- * @param characterName The lowercase name of the character.
745
- * @returns a summary of the transmog unlocks a character has obtained.
746
- */
747
- declare function characterTransmogCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterTransmogCollectionSummaryResponse>;
748
- //#endregion
749
- //#region src/character-encounters/types.d.ts
750
- interface CharacterDungeonsResponse extends ResponseBase {
751
- expansions: Array<ExpansionWithDungeonInstances>;
752
- }
753
- interface CharacterEncountersSummaryResponse extends ResponseBase {
754
- character: Character;
755
- dungeons: Href;
756
- raids: Href;
757
- }
758
- interface CharacterRaidsResponse extends ResponseBase {
759
- character: Character;
760
- expansions: Array<ExpansionWithRaidInstances>;
761
- }
762
- interface DungeonDifficulties {
763
- name?: string;
764
- type?: 'HEROIC' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
765
- }
766
- interface DungeonInstance {
767
- instance: NameIdKey;
768
- modes: Array<DungeonMode>;
769
- }
770
- interface DungeonMode {
771
- difficulty: DungeonDifficulties;
772
- progress: Progress;
773
- status: Status;
774
- }
775
- interface Encounter {
776
- completed_count: number;
777
- encounter: NameIdKey;
778
- last_kill_timestamp: number;
779
- }
780
- interface ExpansionWithDungeonInstances {
781
- expansion: NameIdKey;
782
- instances: Array<DungeonInstance>;
783
- }
784
- interface ExpansionWithRaidInstances {
785
- expansion: NameIdKey;
786
- instances: Array<RaidInstance>;
787
- }
788
- interface Progress {
789
- completed_count: number;
790
- encounters: Array<Encounter>;
791
- total_count: number;
792
- }
793
- interface RaidDifficulties {
794
- name: string;
795
- type: 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
796
- }
797
- interface RaidInstance {
798
- instance: NameIdKey;
799
- modes: Array<RaidMode>;
800
- }
801
- interface RaidMode {
802
- difficulty: RaidDifficulties;
803
- progress: Progress;
804
- status: Status;
805
- }
806
- interface Status {
807
- name: string;
808
- type: 'COMPLETE' | 'IN_PROGRESS';
809
- }
810
- //#endregion
811
- //#region src/character-encounters/character-encounters.d.ts
812
- /**
813
- * @param realmSlug The slug of the realm.
814
- * @param characterName The lowercase name of the character.
815
- * @returns a summary of a character's completed dungeons.
816
- */
817
- declare function characterDungeons(realmSlug: string, characterName: string): Resource<CharacterDungeonsResponse>;
818
- /**
819
- * @param realmSlug The slug of the realm.
820
- * @param characterName The lowercase name of the character.
821
- * @returns a summary of a character's encounters.
822
- */
823
- declare function characterEncountersSummary(realmSlug: string, characterName: string): Resource<CharacterEncountersSummaryResponse>;
824
- /**
825
- * @param realmSlug The slug of the realm.
826
- * @param characterName The lowercase name of the character.
827
- * @returns a summary of a character's completed raids.
828
- */
829
- declare function characterRaids(realmSlug: string, characterName: string): Resource<CharacterRaidsResponse>;
830
- //#endregion
831
- //#region src/character-equipment/types.d.ts
832
- interface CharacterEquipmentSummaryResponse extends ResponseBase {
833
- character: Character;
834
- equipped_item_sets?: Array<Set>;
835
- equipped_items: Array<EquippedItem>;
836
- }
837
- interface Armor$1 {
838
- display: NameDescription;
839
- value: number;
840
- }
841
- interface Damage$2 {
842
- damage_class: NameType;
843
- display_string: string;
844
- max_value: number;
845
- min_value: number;
846
- }
847
- interface DisplayStrings {
848
- copper: string;
849
- gold: string;
850
- header: string;
851
- silver: string;
852
- }
853
- interface DisplayStringValue {
854
- display_string: string;
855
- value: number;
856
- }
857
- interface Effect$1 {
858
- display_string: string;
859
- is_active?: boolean;
860
- required_count: number;
861
- }
862
- interface Enchantment {
863
- display_string: string;
864
- enchantment_id: number;
865
- enchantment_slot: EnchantmentSlot;
866
- source_item?: NameIdKey;
867
- }
868
- interface EnchantmentSlot {
869
- id: number;
870
- type: string;
871
- }
872
- interface EquippedItem {
873
- armor?: Armor$1;
874
- binding: NameType;
875
- bonus_list?: Array<number>;
876
- context: number;
877
- description?: string;
878
- durability?: DisplayStringValue;
879
- enchantments?: Array<Enchantment>;
880
- inventory_type: NameType;
881
- is_subclass_hidden?: boolean;
882
- item: KeyBase & {
883
- id: number;
884
- };
885
- item_class: NameIdKey;
886
- item_subclass: NameIdKey;
887
- level: DisplayStringValue;
888
- limit_category?: string;
889
- media: KeyBase & {
890
- id: number;
891
- };
892
- modified_appearance_id?: number;
893
- modified_crafting_stat?: Array<ModifiedCraftingStat>;
894
- name: string;
895
- name_description?: NameDescription;
896
- quality: NameType;
897
- quantity: number;
898
- requirements?: Requirements$3;
899
- sell_price?: SellPrice;
900
- set?: Set;
901
- slot: NameType;
902
- sockets?: Array<Socket$1>;
903
- spells?: Array<Spell$1>;
904
- stats?: Array<Stat$2>;
905
- transmog?: Transmog;
906
- unique_equipped?: string;
907
- weapon?: Weapon$2;
908
- }
909
- interface ItemElement {
910
- is_equipped?: boolean;
911
- item: NameIdKey;
912
- }
913
- interface ModifiedCraftingStat {
914
- id: number;
915
- name: string;
916
- type: string;
917
- }
918
- interface NameDescription {
919
- color: Color;
920
- display_string: string;
921
- }
922
- interface NameType {
923
- name: string;
924
- type: string;
925
- }
926
- interface PlayableClasses {
927
- display_string: string;
928
- links: Array<NameIdKey>;
929
- }
930
- interface Requirements$3 {
931
- level: DisplayStringValue;
932
- playable_classes?: PlayableClasses;
933
- }
934
- interface SellPrice {
935
- display_strings: DisplayStrings;
936
- value: number;
937
- }
938
- interface Set {
939
- display_string: string;
940
- effects: Array<Effect$1>;
941
- item_set: NameIdKey;
942
- items: Array<ItemElement>;
943
- }
944
- interface Socket$1 {
945
- context?: number;
946
- display_color?: Color;
947
- display_string?: string;
948
- item?: NameIdKey;
949
- media?: KeyBase & {
950
- id: number;
951
- };
952
- socket_type: NameType;
953
- }
954
- interface Spell$1 {
955
- description: string;
956
- display_color?: Color;
957
- spell: NameIdKey;
958
- }
959
- interface Stat$2 {
960
- display: NameDescription;
961
- is_equip_bonus?: boolean;
962
- is_negated?: boolean;
963
- type: NameType;
964
- value: number;
965
- }
966
- interface Transmog {
967
- display_string: string;
968
- item: NameIdKey;
969
- item_modified_appearance_id: number;
970
- second_item?: NameIdKey;
971
- second_item_modified_appearance_id?: number;
972
- }
973
- interface Weapon$2 {
974
- attack_speed: DisplayStringValue;
975
- damage: Damage$2;
976
- dps: DisplayStringValue;
977
- }
978
- //#endregion
979
- //#region src/character-equipment/character-equipment.d.ts
980
- /**
981
- * @param realmSlug The slug of the realm.
982
- * @param characterName The lowercase name of the character.
983
- * @returns a summary of the items equipped by a character.
984
- */
985
- declare function characterEquipmentSummary(realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
986
- //#endregion
987
- //#region src/character-hunter-pets/types.d.ts
988
- interface CharacterHunterPetsSummaryResponse extends ResponseBase {
989
- character: Character;
990
- hunter_pets: Array<HunterPet>;
991
- }
992
- interface HunterPet {
993
- creature: NameIdKey;
994
- creature_display: KeyBase & {
995
- id: number;
996
- };
997
- is_active?: boolean;
998
- is_summoned?: boolean;
999
- level: number;
1000
- name: string;
1001
- slot: number;
1002
- }
1003
- //#endregion
1004
- //#region src/character-hunter-pets/character-hunter-pets.d.ts
1005
- /**
1006
- * If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
1007
- * @param realmSlug The slug of the realm.
1008
- * @param characterName The lowercase name of the character.
1009
- * @returns a summary of the character's hunter pets.
1010
- */
1011
- declare function characterHunterPetsSummary(realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
1012
- //#endregion
1013
- //#region src/character-media/types.d.ts
1014
- interface CharacterMediaSummaryResponse extends ResponseBase {
1015
- assets: Array<Asset$1>;
1016
- character: Character;
1017
- }
1018
- interface Asset$1 {
1019
- key: string;
1020
- value: string;
1021
- }
1022
- //#endregion
1023
- //#region src/character-media/character-media.d.ts
1024
- /**
1025
- * @param realmSlug The slug of the realm.
1026
- * @param characterName The lowercase name of the character.
1027
- * @returns a summary of the media assets available for a character (such as an avatar render).
1028
- */
1029
- declare function characterMediaSummary(realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
1030
- //#endregion
1031
- //#region src/character-mythic-keystone-profile/types.d.ts
1032
- interface CharacterMythicKeystoneProfileIndexResponse extends ResponseBase {
1033
- character: Character;
1034
- current_period: CurrentPeriod;
1035
- seasons: Array<KeyBase & {
1036
- id: number;
1037
- }>;
1038
- }
1039
- interface CharacterMythicKeystoneSeasonDetailsResponse extends ResponseBase {
1040
- best_runs: Array<BestRun>;
1041
- character: Character;
1042
- mythic_rating: MythicRating;
1043
- season: KeyBase & {
1044
- id: number;
1045
- };
1046
- }
1047
- interface BestRun {
1048
- completed_timestamp: number;
1049
- dungeon: NameIdKey;
1050
- duration: number;
1051
- is_completed_within_time: boolean;
1052
- keystone_affixes: Array<NameIdKey>;
1053
- keystone_level: number;
1054
- members: Array<Member$2>;
1055
- mythic_rating: MythicRating;
1056
- }
1057
- interface CurrentPeriod {
1058
- period: KeyBase & {
1059
- id: number;
1060
- };
1061
- }
1062
- interface Member$2 {
1063
- character: NameId & {
1064
- realm: Realm;
1065
- };
1066
- equipped_item_level: number;
1067
- race: NameIdKey;
1068
- specialization: NameIdKey;
1069
- }
1070
- interface MythicRating {
1071
- color: Color;
1072
- rating: number;
1073
- }
1074
- //#endregion
1075
- //#region src/character-mythic-keystone-profile/character-mythic-keystone-profile.d.ts
1076
- /**
1077
- * @param realmSlug The slug of the realm.
1078
- * @param characterName The lowercase name of the character.
1079
- * @returns Returns the Mythic Keystone season details for a character. Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
1080
- */
1081
- declare function characterMythicKeystoneProfileIndex(realmSlug: string, characterName: string): Resource<CharacterMythicKeystoneProfileIndexResponse>;
1082
- /**
1083
- * Returns the Mythic Keystone season details for a character.
1084
- * Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
1085
- * @param realmSlug The slug of the realm.
1086
- * @param characterName The lowercase name of the character.
1087
- * @param seasonId The ID of the season.
1088
- * @returns the Mythic Keystone season details for a character.
1089
- */
1090
- declare function characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): Resource<CharacterMythicKeystoneSeasonDetailsResponse>;
1091
- //#endregion
1092
- //#region src/character-professions/types.d.ts
1093
- interface CharacterProfessionsSummaryResponse extends ResponseBase {
1094
- character: Character;
1095
- primaries: Array<Primary>;
1096
- secondaries: Array<Secondary>;
1097
- }
1098
- interface Primary {
1099
- profession: NameIdKey;
1100
- tiers: Array<Tier$1>;
1101
- }
1102
- interface Secondary {
1103
- max_skill_points?: number;
1104
- profession: NameIdKey;
1105
- skill_points?: number;
1106
- tiers?: Array<Tier$1>;
1107
- }
1108
- interface Tier$1 {
1109
- known_recipes?: Array<NameIdKey>;
1110
- max_skill_points: number;
1111
- skill_points: number;
1112
- tier: NameId;
1113
- }
1114
- //#endregion
1115
- //#region src/character-professions/character-professions.d.ts
1116
- /**
1117
- * @param realmSlug The slug of the realm.
1118
- * @param characterName The lowercase name of the character.
1119
- * @returns a summary of the professions for a character.
1120
- */
1121
- declare function characterProfessionsSummary(realmSlug: string, characterName: string): Resource<CharacterProfessionsSummaryResponse>;
1122
- //#endregion
1123
- //#region src/character-profile/types.d.ts
1124
- interface CharacterProfileStatusResponse extends ResponseBase {
1125
- id: number;
1126
- is_valid: boolean;
1127
- }
1128
- interface CharacterProfileSummaryResponse extends ResponseBase {
1129
- achievement_points: number;
1130
- achievements: Href;
1131
- achievements_statistics: Href;
1132
- active_spec: NameIdKey;
1133
- active_title?: NameIdKey & {
1134
- display_string: string;
1135
- };
1136
- appearance: Href;
1137
- average_item_level: number;
1138
- character_class: NameIdKey;
1139
- collections: Href;
1140
- covenant_progress: CovenantProgress;
1141
- encounters: Href;
1142
- equipment: Href;
1143
- equipped_item_level: number;
1144
- experience: number;
1145
- faction: Faction;
1146
- gender: Gender;
1147
- guild?: Guild$2;
1148
- houses?: Array<Href>;
1149
- hunter_pets: Href;
1150
- id: number;
1151
- is_remix: boolean;
1152
- last_login_timestamp: number;
1153
- level: number;
1154
- media: Href;
1155
- mythic_keystone_profile: Href;
1156
- name: string;
1157
- name_search: string;
1158
- professions: Href;
1159
- pvp_summary: Href;
1160
- quests: Href;
1161
- race: NameIdKey;
1162
- realm: Realm;
1163
- reputations: Href;
1164
- specializations: Href;
1165
- statistics: Href;
1166
- titles: Href;
1167
- }
1168
- interface CovenantProgress {
1169
- chosen_covenant: NameIdKey;
1170
- renown_level: number;
1171
- soulbinds: Href;
1172
- }
1173
- interface Guild$2 extends NameIdKey {
1174
- faction: Faction;
1175
- realm: Realm;
1176
- }
1177
- //#endregion
1178
- //#region src/character-profile/character-profile.d.ts
1179
- /**
1180
- * Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
1181
- * - an HTTP 404 Not Found error is returned
1182
- * - the is_valid value is false
1183
- * - the returned character ID doesn't match the previously recorded value for the character
1184
- *
1185
- * The following example illustrates how to use this endpoint:
1186
- *
1187
- * 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
1188
- * 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
1189
- * 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
1190
- * 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
1191
- * @param realmSlug The slug of the realm.
1192
- * @param characterName The lowercase name of the character.
1193
- * @returns the status of the character profile for a character.
1194
- */
1195
- declare function characterProfileStatus(realmSlug: string, characterName: string): Resource<CharacterProfileStatusResponse>;
1196
- /**
1197
- * Returns a summary of the character profile for a character.
1198
- * @param realmSlug The slug of the realm.
1199
- * @param characterName The lowercase name of the character.
1200
- * @returns a summary of the character profile for a character.
1201
- */
1202
- declare function characterProfileSummary(realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
1203
- //#endregion
1204
- //#region src/character-pvp/types.d.ts
1205
- interface CharacterPvpBracketStatisticsResponse extends ResponseBase {
1206
- bracket: Bracket$2;
1207
- character: Character;
1208
- faction: Faction;
1209
- rating: number;
1210
- season: KeyBase & {
1211
- id: number;
1212
- };
1213
- season_match_statistics: MatchStatistics;
1214
- tier: KeyBase & {
1215
- id: number;
1216
- };
1217
- weekly_match_statistics: MatchStatistics;
1218
- }
1219
- interface CharacterPvpSummaryResponse extends ResponseBase {
1220
- character: Character;
1221
- honor_level: number;
1222
- honorable_kills: number;
1223
- pvp_map_statistics: Array<PvpMapStatistic>;
1224
- }
1225
- interface Bracket$2 {
1226
- id: number;
1227
- type: string;
1228
- }
1229
- interface MatchStatistics {
1230
- lost: number;
1231
- played: number;
1232
- won: number;
1233
- }
1234
- interface PvpMapStatistic {
1235
- match_statistics: MatchStatistics;
1236
- world_map: NameId;
1237
- }
1238
- //#endregion
1239
- //#region src/character-pvp/character-pvp.d.ts
1240
- /**
1241
- * @param realmSlug The slug of the realm.
1242
- * @param characterName The lowercase name of the character.
1243
- * @param bracketId The ID of the PvP bracket.
1244
- * @returns a PvP bracket statistics for a character.
1245
- */
1246
- declare function characterPvpBracketStatistics(realmSlug: string, characterName: string, bracketId: '2v2' | '3v3' | 'rbg' | `shuffle-${string}-${string}`): Resource<CharacterPvpBracketStatisticsResponse>;
1247
- /**
1248
- * @param realmSlug The slug of the realm.
1249
- * @param characterName The lowercase name of the character.
1250
- * @returns a PvP summary for a character.
1251
- */
1252
- declare function characterPvpSummary(realmSlug: string, characterName: string): Resource<CharacterPvpSummaryResponse>;
1253
- //#endregion
1254
- //#region src/character-quests/types.d.ts
1255
- interface CharacterCompletedQuestsResponse extends ResponseBase {
1256
- character: Character;
1257
- quests: Array<NameIdKey>;
1258
- }
1259
- interface CharacterQuestsResponse extends ResponseBase {
1260
- character: Character;
1261
- completed: Href;
1262
- in_progress: Array<NameIdKey>;
1263
- }
1264
- //#endregion
1265
- //#region src/character-quests/character-quests.d.ts
1266
- /**
1267
- * @param realmSlug The slug of the realm.
1268
- * @param characterName The lowercase name of the character.
1269
- * @returns a list of quests that a character has completed.
1270
- */
1271
- declare function characterCompletedQuests(realmSlug: string, characterName: string): Resource<CharacterCompletedQuestsResponse>;
1272
- /**
1273
- * @param realmSlug The slug of the realm.
1274
- * @param characterName The lowercase name of the character.
1275
- * @returns a character's active quests as well as a link to the character's completed quests.
1276
- */
1277
- declare function characterQuests(realmSlug: string, characterName: string): Resource<CharacterQuestsResponse>;
1278
- //#endregion
1279
- //#region src/character-reputations/types.d.ts
1280
- interface CharacterReputationsSummaryResponse extends ResponseBase {
1281
- character: Character;
1282
- reputations: Array<Reputation$1>;
1283
- }
1284
- interface Paragon {
1285
- max: number;
1286
- raw: number;
1287
- value: number;
1288
- }
1289
- interface Reputation$1 {
1290
- faction: NameIdKey;
1291
- paragon?: Paragon;
1292
- standing: Standing;
1293
- }
1294
- interface Standing {
1295
- max: number;
1296
- name: string;
1297
- raw: number;
1298
- renown_level?: number;
1299
- tier?: number;
1300
- value: number;
1301
- }
1302
- //#endregion
1303
- //#region src/character-reputations/character-reputations.d.ts
1304
- /**
1305
- * @param realmSlug The slug of the realm.
1306
- * @param characterName The lowercase name of the character.
1307
- * @returns a summary of a character's reputations.
1308
- */
1309
- declare function characterReputationsSummary(realmSlug: string, characterName: string): Resource<CharacterReputationsSummaryResponse>;
1310
- //#endregion
1311
- //#region src/character-soulbinds/types.d.ts
1312
- interface CharacterSoulbindsResponse extends ResponseBase {
1313
- character: Character;
1314
- chosen_covenant: NameIdKey;
1315
- renown_level: number;
1316
- soulbinds: Array<Soulbind>;
1317
- }
1318
- interface ConduitSocket {
1319
- socket: Socket;
1320
- type: TypeClass;
1321
- }
1322
- interface Socket {
1323
- conduit: NameIdKey;
1324
- rank: number;
1325
- }
1326
- interface Soulbind {
1327
- is_active?: boolean;
1328
- soulbind: NameIdKey;
1329
- traits: Array<Trait>;
1330
- }
1331
- interface Trait {
1332
- conduit_socket?: ConduitSocket;
1333
- display_order: number;
1334
- tier: number;
1335
- trait?: NameIdKey;
1336
- }
1337
- interface TypeClass {
1338
- name: string;
1339
- type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
1340
- }
1341
- //#endregion
1342
- //#region src/character-soulbinds/character-soulbinds.d.ts
1343
- /**
1344
- * @param realmSlug The slug of the realm.
1345
- * @param characterName The lowercase name of the character.
1346
- * @returns a character's soulbinds.
1347
- */
1348
- declare function characterSoulbinds(realmSlug: string, characterName: string): Resource<CharacterSoulbindsResponse>;
1349
- //#endregion
1350
- //#region src/character-specializations/types.d.ts
1351
- interface CharacterSpecializationsSummaryResponse extends ResponseBase {
1352
- active_hero_talent_tree: NameIdKey;
1353
- active_specialization: NameIdKey;
1354
- character: Character;
1355
- specializations: Array<Specialization$1>;
1356
- }
1357
- interface Loadout {
1358
- is_active: boolean;
1359
- selected_class_talent_tree: KeyBase & {
1360
- name: string;
1361
- };
1362
- selected_class_talents: Array<SelectedTalent>;
1363
- selected_hero_talent_tree: NameIdKey;
1364
- selected_hero_talents: Array<SelectedTalent>;
1365
- selected_spec_talent_tree: KeyBase & {
1366
- name: string;
1367
- };
1368
- selected_spec_talents?: Array<SelectedTalent>;
1369
- talent_loadout_code: string;
1370
- }
1371
- interface PvpTalentSlot {
1372
- selected: Selected;
1373
- slot_number: number;
1374
- }
1375
- interface Selected {
1376
- spell_tooltip: SpellTooltip$3;
1377
- talent: KeyBase & {
1378
- id: number;
1379
- name?: string;
1380
- };
1381
- }
1382
- interface SelectedTalent {
1383
- default_points?: number;
1384
- id: number;
1385
- rank: number;
1386
- tooltip?: Selected;
1387
- }
1388
- interface Specialization$1 {
1389
- glyphs?: Array<NameIdKey>;
1390
- loadouts: Array<Loadout>;
1391
- pvp_talent_slots?: Array<PvpTalentSlot>;
1392
- specialization: NameIdKey;
1393
- }
1394
- interface SpellTooltip$3 {
1395
- cast_time?: string;
1396
- cooldown?: string;
1397
- description?: string;
1398
- power_cost?: string;
1399
- range?: string;
1400
- spell: KeyBase & {
1401
- id: number;
1402
- name?: string;
1403
- };
1404
- }
1405
- //#endregion
1406
- //#region src/character-specializations/character-specializations.d.ts
1407
- /**
1408
- * @param realmSlug The slug of the realm.
1409
- * @param characterName The lowercase name of the character.
1410
- * @returns a summary of a character's specializations.
1411
- */
1412
- declare function characterSpecializationsSummary(realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
1413
- //#endregion
1414
- //#region src/character-statistics/types.d.ts
1415
- interface CharacterStatisticsSummaryResponse extends ResponseBase {
1416
- agility: BaseEffectiveStat;
1417
- armor: BaseEffectiveStat;
1418
- attack_power: number;
1419
- avoidance: Rating;
1420
- block: RatingWithValue;
1421
- bonus_armor: number;
1422
- character: Character;
1423
- dodge: RatingWithValue;
1424
- health: number;
1425
- intellect: BaseEffectiveStat;
1426
- lifesteal: RatingWithValue;
1427
- main_hand_damage_max: number;
1428
- main_hand_damage_min: number;
1429
- main_hand_dps: number;
1430
- main_hand_speed: number;
1431
- mana_regen: number;
1432
- mana_regen_combat: number;
1433
- mastery: RatingWithValue;
1434
- melee_crit: RatingWithValue;
1435
- melee_haste: RatingWithValue;
1436
- off_hand_damage_max: number;
1437
- off_hand_damage_min: number;
1438
- off_hand_dps: number;
1439
- off_hand_speed: number;
1440
- parry: RatingWithValue;
1441
- power: number;
1442
- power_type: NameIdKey;
1443
- ranged_crit: RatingWithValue;
1444
- ranged_haste: RatingWithValue;
1445
- speed: Rating;
1446
- spell_crit: RatingWithValue;
1447
- spell_haste: RatingWithValue;
1448
- spell_penetration: number;
1449
- spell_power: number;
1450
- stamina: BaseEffectiveStat;
1451
- strength: BaseEffectiveStat;
1452
- versatility: number;
1453
- versatility_damage_done_bonus: number;
1454
- versatility_damage_taken_bonus: number;
1455
- versatility_healing_done_bonus: number;
1456
- }
1457
- interface BaseEffectiveStat {
1458
- base: number;
1459
- effective: number;
1460
- }
1461
- interface Rating {
1462
- rating_bonus: number;
1463
- rating_normalized: number;
1464
- }
1465
- interface RatingWithValue {
1466
- rating_bonus: number;
1467
- rating_normalized: number;
1468
- value: number;
1469
- }
1470
- //#endregion
1471
- //#region src/character-statistics/character-statistics.d.ts
1472
- /**
1473
- * @param realmSlug The slug of the realm.
1474
- * @param characterName The lowercase name of the character.
1475
- * @returns a statistics summary for a character.
1476
- */
1477
- declare function characterStatisticsSummary(realmSlug: string, characterName: string): Resource<CharacterStatisticsSummaryResponse>;
1478
- //#endregion
1479
- //#region src/character-titles/types.d.ts
1480
- interface CharacterTitlesSummaryResponse extends ResponseBase {
1481
- active_title?: NameIdKey & {
1482
- display_string: string;
1483
- };
1484
- character: Character;
1485
- titles: Array<NameIdKey>;
1486
- }
1487
- //#endregion
1488
- //#region src/character-titles/character-titles.d.ts
1489
- /**
1490
- * @param realmSlug The slug of the realm.
1491
- * @param characterName The lowercase name of the character.
1492
- * @returns a summary of titles a character has obtained.
1493
- */
1494
- declare function characterTitlesSummary(realmSlug: string, characterName: string): Resource<CharacterTitlesSummaryResponse>;
1495
- //#endregion
1496
- //#region src/realm/types.d.ts
1497
- /**
1498
- * The category of a realm.
1499
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1500
- */
1501
- type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'Latin America' | 'Oceanic' | 'PS' | 'Russian' | 'Spanish' | 'United States' | '한국';
1502
- /**
1503
- * The response for a realm index.
1504
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1505
- */
1506
- interface RealmIndexResponse extends ResponseBase {
1507
- realms: Array<Realm>;
1508
- }
1509
- type RealmLocales = 'deDE' | 'enGB' | 'enUS' | 'esES' | 'esMX' | 'frFR' | 'itIT' | 'koKR' | 'ptBR' | 'ptPT' | 'ruRU' | 'zhCN' | 'zhTW';
1510
- /**
1511
- * The response for a realm.
1512
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1513
- */
1514
- interface RealmResponse extends NameId, ResponseBase {
1515
- category: RealmCategory;
1516
- connected_realm: Href;
1517
- is_tournament: boolean;
1518
- locale: RealmLocales;
1519
- region: NameIdKey;
1520
- slug: string;
1521
- timezone: RealmTimezone;
1522
- type: {
1523
- name: string;
1524
- type: RealmTypeCapitalized;
1525
- };
1526
- }
1527
- /**
1528
- * The search parameters for realms.
1529
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1530
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1531
- */
1532
- interface RealmSearchParameters extends BaseSearchParameters {
1533
- timezone?: RealmTimezone;
1534
- }
1535
- /**
1536
- * The response for a realm search.
1537
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1538
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1539
- */
1540
- interface RealmSearchResponse extends SearchResponseWithoutResults {
1541
- results: Array<RealmSearchResponseItem>;
1542
- }
1543
- /**
1544
- * The timezone of a realm.
1545
- */
1546
- type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
1547
- /**
1548
- * The type of a realm, capitalized and shortened).
1549
- */
1550
- type RealmTypeCapitalized = 'NORMAL' | 'RP';
1551
- interface RealmSearchResponseItem extends KeyBase {
1552
- data: {
1553
- category: Record<Locales, string>;
1554
- id: number;
1555
- is_tournament: boolean;
1556
- locale: RealmLocales;
1557
- name: Record<Locales, string>;
1558
- region: {
1559
- id: number;
1560
- name: Record<Locales, string>;
1561
- };
1562
- slug: string;
1563
- timezone: RealmTimezone;
1564
- type: {
1565
- name: Record<Locales, string>;
1566
- type: RealmTypeCapitalized;
1567
- };
1568
- };
1569
- }
1570
- //#endregion
1571
- //#region src/connected-realm/types.d.ts
1572
- /**
1573
- * Connected Realm Index API response.
1574
- * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
1575
- */
1576
- interface ConnectedRealmIndexResponse extends ResponseBase {
1577
- connected_realms: Array<Href>;
1578
- }
1579
- /**
1580
- * Connected Realm API response.
1581
- * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
1582
- */
1583
- interface ConnectedRealmResponse extends ResponseBase {
1584
- auctions: Href;
1585
- has_queue: boolean;
1586
- id: number;
1587
- mythic_leaderboards: Href;
1588
- population: {
1589
- name: string;
1590
- type: RealmPopulationCapitalized;
1591
- };
1592
- realm_locked_status?: RealmLockedStatus;
1593
- realms: Array<Realm$4>;
1594
- status: {
1595
- name: string;
1596
- type: RealmStatusCapitalized;
1597
- };
1598
- }
1599
- /**
1600
- * Connected Realm Search API parameters.
1601
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1602
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1603
- */
1604
- interface ConnectedRealmSearchParameters extends BaseSearchParameters {
1605
- 'realms.timezone'?: RealmTimezone;
1606
- 'status.type'?: RealmStatusCapitalized;
1607
- }
1608
- /**
1609
- * Connected Realm Search API response item.
1610
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1611
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1612
- */
1613
- interface ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
1614
- results: Array<ConnectedRealmSearchResponseItem>;
1615
- }
1616
- interface ConnectedRealmSearchResponseItem extends KeyBase {
1617
- data: {
1618
- has_queue: boolean;
1619
- id: number;
1620
- population: SearchRealmPopulation;
1621
- realms: Array<SearchRealm>;
1622
- status: SearchRealmStatus;
1623
- };
1624
- }
1625
- interface Realm$4 {
1626
- category: RealmCategory;
1627
- connected_realm: Href;
1628
- id: number;
1629
- is_tournament: boolean;
1630
- locale: RealmLocales;
1631
- name: string;
1632
- region: NameIdKey;
1633
- slug: string;
1634
- timezone: RealmTimezone;
1635
- type: {
1636
- name: string;
1637
- type: RealmTypeCapitalized;
1638
- };
1639
- }
1640
- interface RealmLockedStatus {
1641
- is_locked_for_new_characters: boolean;
1642
- is_locked_for_pct: boolean;
1643
- }
1644
- type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
1645
- type RealmStatusCapitalized = 'DOWN' | 'UP';
1646
- interface SearchRealm {
1647
- category: Record<Locales, string>;
1648
- id: number;
1649
- is_tournament: boolean;
1650
- locale: RealmLocales;
1651
- name: Record<Locales, string>;
1652
- region: {
1653
- id: number;
1654
- name: Record<Locales, string>;
1655
- };
1656
- slug: string;
1657
- timezone: RealmTimezone;
1658
- type: {
1659
- name: Record<Locales, string>;
1660
- type: RealmTypeCapitalized;
1661
- };
1662
- }
1663
- interface SearchRealmPopulation {
1664
- name: Record<Locales, string>;
1665
- type: RealmPopulationCapitalized;
1666
- }
1667
- interface SearchRealmStatus {
1668
- name: Record<Locales, string>;
1669
- type: RealmStatusCapitalized;
1670
- }
1671
- //#endregion
1672
- //#region src/connected-realm/connected-realm.d.ts
1673
- /**
1674
- * Get a connected realm by ID.
1675
- * @param connectedRealmId The connected realm ID.
1676
- * @returns The connected realm. See {@link ConnectedRealmResponse}.
1677
- */
1678
- declare function connectedRealm(connectedRealmId: number): Resource<ConnectedRealmResponse>;
1679
- /**
1680
- * Get a connected realm index.
1681
- * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
1682
- */
1683
- declare function connectedRealmIndex(): Resource<ConnectedRealmIndexResponse>;
1684
- /**
1685
- * Search for connected realms.
1686
- * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
1687
- * @returns The search results. See {@link ConnectedRealmSearchResponse}.
1688
- */
1689
- declare function connectedRealmSearch(options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
1690
- //#endregion
1691
- //#region src/covenant/types.d.ts
1692
- /**
1693
- * Interface for a response from the conduit index endpoint.
1694
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1695
- */
1696
- interface ConduitIndexResponse extends ResponseBase {
1697
- conduits: Array<NameIdKey>;
1698
- }
1699
- /**
1700
- * Interface for a response from the conduit endpoint.
1701
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1702
- */
1703
- interface ConduitResponse extends ResponseBase {
1704
- id: number;
1705
- item: NameIdKey;
1706
- name: string;
1707
- ranks: Array<Rank$1>;
1708
- socket_type: SocketType;
1709
- }
1710
- /**
1711
- * Interface for a response from the covenant index endpoint.
1712
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1713
- */
1714
- interface CovenantIndexResponse extends ResponseBase {
1715
- covenants: Array<NameIdKey>;
1716
- }
1717
- /**
1718
- * Interface for a response from the covenant media endpoint.
1719
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1720
- */
1721
- interface CovenantMediaResponse extends ResponseBase {
1722
- assets?: Array<MediaAsset>;
1723
- }
1724
- /**
1725
- * Interface for a response from the covenant endpoint.
1726
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1727
- */
1728
- interface CovenantResponse extends ResponseBase {
1729
- class_abilities?: Array<ClassAbility>;
1730
- description: string;
1731
- id: number;
1732
- media?: Media$14;
1733
- name: string;
1734
- renown_rewards: Array<RenownReward>;
1735
- signature_ability?: SignatureAbility;
1736
- soulbinds?: Array<NameIdKey>;
1737
- }
1738
- /**
1739
- * Interface for a response from the soulbind index endpoint.
1740
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1741
- */
1742
- interface SoulbindIndexResponse extends ResponseBase {
1743
- soulbinds: Array<NameIdKey>;
1744
- }
1745
- /**
1746
- * Interface for a response from the soulbind endpoint.
1747
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1748
- */
1749
- interface SoulbindResponse extends ResponseBase {
1750
- covenant: NameIdKey;
1751
- creature: NameIdKey;
1752
- follower: NameId;
1753
- id: number;
1754
- name: string;
1755
- talent_tree: NameIdKey;
1756
- }
1757
- interface ClassAbility {
1758
- id: number;
1759
- playable_class: NameIdKey;
1760
- spell_tooltip: ClassAbilitySpellTooltip;
1761
- }
1762
- interface ClassAbilitySpellTooltip {
1763
- cast_time: string;
1764
- cooldown?: string;
1765
- description: string;
1766
- power_cost?: null | string;
1767
- range?: string;
1768
- spell: NameIdKey;
1769
- }
1770
- interface Media$14 extends KeyBase {
1771
- id: number;
1772
- }
1773
- interface Rank$1 {
1774
- id: number;
1775
- spell_tooltip: SpellTooltip$2;
1776
- tier: number;
1777
- }
1778
- interface RenownReward {
1779
- level: number;
1780
- reward: NameIdKey;
1781
- }
1782
- interface SignatureAbility {
1783
- id: number;
1784
- spell_tooltip: SignatureAbilitySpellTooltip;
1785
- }
1786
- interface SignatureAbilitySpellTooltip {
1787
- cast_time: string;
1788
- cooldown?: string;
1789
- description: string;
1790
- range?: string;
1791
- spell: NameIdKey;
1792
- }
1793
- interface SocketType {
1794
- name: string;
1795
- type: string;
1796
- }
1797
- interface SpellTooltip$2 {
1798
- cast_time: string;
1799
- description: string;
1800
- spell: NameIdKey;
1801
- }
1802
- //#endregion
1803
- //#region src/covenant/covenant.d.ts
1804
- /**
1805
- * Get a conduit by ID.
1806
- * @param conduitId The conduit ID.
1807
- * @returns The conduit. See {@link ConduitResponse}.
1808
- */
1809
- declare function conduit(conduitId: number): Resource<ConduitResponse>;
1810
- /**
1811
- * Get a conduit index.
1812
- * @returns The conduit index. See {@link ConduitIndexResponse}.
1813
- */
1814
- declare function conduitIndex(): Resource<ConduitIndexResponse>;
1815
- /**
1816
- * Get a covenant by ID.
1817
- * @param covenantId The covenant ID.
1818
- * @returns The covenant. See {@link CovenantResponse}.
1819
- */
1820
- declare function covenant(covenantId: number): Resource<CovenantResponse>;
1821
- /**
1822
- * Get a covenant index.
1823
- * @returns The covenant index. See {@link CovenantIndexResponse}.
1824
- */
1825
- declare function covenantIndex(): Resource<CovenantIndexResponse>;
1826
- /**
1827
- * Get covenant media by ID.
1828
- * @param covenantId The covenant ID.
1829
- * @returns The covenant media. See {@link CovenantMediaResponse}.
1830
- */
1831
- declare function covenantMedia(covenantId: number): Resource<CovenantMediaResponse>;
1832
- /**
1833
- * Get a soulbind by ID.
1834
- * @param soulbindId The soulbind ID.
1835
- * @returns The soulbind. See {@link SoulbindResponse}.
1836
- */
1837
- declare function soulbind(soulbindId: number): Resource<SoulbindResponse>;
1838
- /**
1839
- * Get a soulbind index.
1840
- * @returns The soulbind index. See {@link SoulbindIndexResponse}.
1841
- */
1842
- declare function soulbindIndex(): Resource<SoulbindIndexResponse>;
1843
- //#endregion
1844
- //#region src/creature/types.d.ts
1845
- /**
1846
- * The response for creature display media.
1847
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1848
- */
1849
- interface CreatureDisplayMediaResponse extends ResponseBase {
1850
- assets: Array<DisplayMediaAsset>;
1851
- id: number;
1852
- }
1853
- /**
1854
- * The response for a creature family index.
1855
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1856
- */
1857
- interface CreatureFamilyIndexResponse extends ResponseBase {
1858
- creature_families: Array<NameIdKey>;
1859
- }
1860
- /**
1861
- * The response for creature family media.
1862
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1863
- */
1864
- interface CreatureFamilyMediaResponse extends ResponseBase {
1865
- assets: Array<MediaAsset>;
1866
- id: number;
1867
- }
1868
- /**
1869
- * The response for a creature family.
1870
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1871
- */
1872
- interface CreatureFamilyResponse extends ResponseBase {
1873
- id: number;
1874
- media: Media$13;
1875
- name: string;
1876
- specialization: NameIdKey;
1877
- }
1878
- /**
1879
- * The response for a creature.
1880
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1881
- */
1882
- interface CreatureResponse extends ResponseBase {
1883
- creature_displays: Array<CreatureDisplay$2>;
1884
- family: NameIdKey;
1885
- id: number;
1886
- is_tameable: boolean;
1887
- name: string;
1888
- type: NameIdKey;
1889
- }
1890
- /**
1891
- * The search parameters for a creature.
1892
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1893
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1894
- */
1895
- interface CreatureSearchParameters extends BaseSearchParameters {
1896
- locale: Locales;
1897
- name: string;
1898
- }
1899
- /**
1900
- * The response for a creature search.
1901
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1902
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1903
- */
1904
- interface CreatureSearchResponse extends SearchResponseWithoutResults {
1905
- results: Array<CreatureSearchResponseItem>;
1906
- }
1907
- /**
1908
- * The response for a creature type index.
1909
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1910
- */
1911
- interface CreatureTypeIndexResponse extends ResponseBase {
1912
- creature_types: Array<NameIdKey>;
1913
- }
1914
- /**
1915
- * The response for a creature type.
1916
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1917
- */
1918
- interface CreatureTypeResponse extends ResponseBase {
1919
- id: number;
1920
- name: string;
1921
- }
1922
- interface CreatureDisplay$2 extends KeyBase {
1923
- id: number;
1924
- }
1925
- interface CreatureSearchResponseItem extends KeyBase {
1926
- data: {
1927
- creature_displays: Array<{
1928
- id: number;
1929
- }>;
1930
- family?: {
1931
- id: number;
1932
- name: Record<Locales, string>;
1933
- };
1934
- id: number;
1935
- is_tameable: boolean;
1936
- name: Record<Locales, string | undefined>;
1937
- type: {
1938
- id: number;
1939
- name: Record<Locales, string>;
1940
- };
1941
- };
1942
- }
1943
- interface DisplayMediaAsset {
1944
- key: string;
1945
- value: string;
1946
- }
1947
- interface Media$13 extends KeyBase {
1948
- id: number;
1949
- }
1950
- //#endregion
1951
- //#region src/creature/creature.d.ts
1952
- /**
1953
- * Get a creature by ID.
1954
- * @param creatureId The creature ID.
1955
- * @returns The creature. See {@link CreatureResponse}.
1956
- */
1957
- declare function creature(creatureId: number): Resource<CreatureResponse>;
1958
- /**
1959
- * Get creature display media by ID.
1960
- * @param creatureDisplayId The creature display ID.
1961
- * @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
1962
- */
1963
- declare function creatureDisplayMedia(creatureDisplayId: number): Resource<CreatureDisplayMediaResponse>;
1964
- /**
1965
- * Get a creature family by ID.
1966
- * @param creatureFamilyId The creature family ID.
1967
- * @returns The creature family. See {@link CreatureFamilyResponse}.
1968
- */
1969
- declare function creatureFamily(creatureFamilyId: number): Resource<CreatureFamilyResponse>;
1970
- /**
1971
- * Get a creature family index.
1972
- * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
1973
- */
1974
- declare function creatureFamilyIndex(): Resource<CreatureFamilyIndexResponse>;
1975
- /**
1976
- * Get creature family media by ID.
1977
- * @param creatureFamilyId The creature family ID.
1978
- * @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
1979
- */
1980
- declare function creatureFamilyMedia(creatureFamilyId: number): Resource<CreatureFamilyMediaResponse>;
1981
- /**
1982
- * Search for creatures.
1983
- * @param options The creature search parameters. See {@link CreatureSearchParameters}.
1984
- * @returns The creature search results. See {@link CreatureSearchResponse}.
1985
- */
1986
- declare function creatureSearch(options: CreatureSearchParameters): Resource<CreatureSearchResponse, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
1987
- /**
1988
- * Get a creature type by ID.
1989
- * @param creatureTypeId The creature type ID.
1990
- * @returns The creature type. See {@link CreatureTypeResponse}.
1991
- */
1992
- declare function creatureType(creatureTypeId: number): Resource<CreatureTypeResponse>;
1993
- /**
1994
- * Get a creature type index.
1995
- * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
1996
- */
1997
- declare function creatureTypeIndex(): Resource<CreatureTypeIndexResponse>;
1998
- //#endregion
1999
- //#region src/guild-crest/types.d.ts
2000
- /**
2001
- * The response for a guild crest border or emblem.
2002
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2003
- */
2004
- interface GuildCrestBorderEmblemResponse extends ResponseBase {
2005
- assets: Array<GuildCrestAsset>;
2006
- id: number;
2007
- }
2008
- /**
2009
- * The response for the guild crest components index.
2010
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2011
- */
2012
- interface GuildCrestComponentsIndexResponse extends ResponseBase {
2013
- borders: Array<Border$1>;
2014
- colors: Colors;
2015
- emblems: Array<Border$1>;
2016
- }
2017
- interface Background {
2018
- id: number;
2019
- rgba: Color;
2020
- }
2021
- interface Border$1 {
2022
- id: number;
2023
- media: Media$12;
2024
- }
2025
- interface Colors {
2026
- backgrounds: Array<Background>;
2027
- borders: Array<Background>;
2028
- emblems: Array<Background>;
2029
- }
2030
- interface GuildCrestAsset {
2031
- key: string;
2032
- value: string;
2033
- }
2034
- interface Media$12 extends KeyBase {
2035
- id: number;
2036
- }
2037
- //#endregion
2038
- //#region src/guild-crest/guild-crest.d.ts
2039
- /**
2040
- * Get a guild crest border by ID.
2041
- * @param borderId The guild crest border ID.
2042
- * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
2043
- */
2044
- declare function guildCrestBorder(borderId: number): Resource<GuildCrestBorderEmblemResponse>;
2045
- /**
2046
- * Get the guild crest components index.
2047
- * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
2048
- */
2049
- declare function guildCrestComponentsIndex(): Resource<GuildCrestComponentsIndexResponse>;
2050
- /**
2051
- * Get a guild crest emblem by ID.
2052
- * @param emblemId The guild crest emblem ID.
2053
- * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
2054
- */
2055
- declare function guildCrestEmblem(emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
2056
- //#endregion
2057
- //#region src/guild/types.d.ts
2058
- interface GuildAchievementsResponse extends ResponseBase {
2059
- achievements: Array<Achievement>;
2060
- category_progress: Array<CategoryProgress>;
2061
- guild: Guild$1;
2062
- recent_events: Array<RecentEvent>;
2063
- total_points: number;
2064
- total_quantity: number;
2065
- }
2066
- interface GuildActivityResponse extends ResponseBase {
2067
- activities: Array<ActivityElement>;
2068
- guild: Guild$1;
2069
- }
2070
- interface GuildResponse extends ResponseBase {
2071
- achievement_points: number;
2072
- achievements: Href;
2073
- activity: Href;
2074
- created_timestamp: number;
2075
- crest: Crest;
2076
- faction: Faction;
2077
- id: number;
2078
- member_count: number;
2079
- name: string;
2080
- name_search: string;
2081
- realm: Realm;
2082
- roster: Href;
2083
- }
2084
- interface GuildRosterResponse extends ResponseBase {
2085
- guild: Guild$1;
2086
- members: Array<Member$1>;
2087
- }
2088
- interface Achievement {
2089
- achievement: NameIdKey;
2090
- completed_timestamp?: number;
2091
- criteria?: Criteria;
2092
- id: number;
2093
- }
2094
- interface ActivityElement {
2095
- activity: {
2096
- type: string;
2097
- };
2098
- character_achievement?: CharacterAchievement;
2099
- encounter_completed?: EncounterActivity;
2100
- timestamp: number;
2101
- }
2102
- interface Border {
2103
- color: RgbWithId;
2104
- id: number;
2105
- media: KeyBase & {
2106
- id: number;
2107
- };
2108
- }
2109
- interface CategoryProgress {
2110
- category: NameIdKey;
2111
- points: number;
2112
- quantity: number;
2113
- }
2114
- interface CharacterAchievement {
2115
- achievement: NameIdKey;
2116
- character: Character;
2117
- }
2118
- interface ChildCriterum {
2119
- amount: number;
2120
- id: number;
2121
- is_completed: boolean;
2122
- }
2123
- interface Crest {
2124
- background: {
2125
- color: RgbWithId;
2126
- };
2127
- border: Border;
2128
- emblem: Border;
2129
- }
2130
- interface Criteria {
2131
- amount?: number;
2132
- child_criteria?: Array<ChildCriterum>;
2133
- id: number;
2134
- is_completed: boolean;
2135
- }
2136
- interface EncounterActivity {
2137
- encounter: NameIdKey;
2138
- mode: {
2139
- name: string;
2140
- type: ModeType$1;
2141
- };
2142
- }
2143
- interface Guild$1 extends NameIdKey {
2144
- faction: Faction;
2145
- realm: Realm;
2146
- }
2147
- interface Member$1 {
2148
- character: RosterMemberCharacter;
2149
- rank: number;
2150
- }
2151
- type ModeType$1 = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
2152
- interface Playable extends KeyBase {
2153
- id: number;
2154
- }
2155
- interface RecentEvent {
2156
- achievement: NameIdKey;
2157
- timestamp: number;
2158
- }
2159
- interface RgbWithId {
2160
- id: number;
2161
- rgba: Color;
2162
- }
2163
- interface RosterMemberCharacter extends Character {
2164
- faction: {
2165
- type: Factions;
2166
- };
2167
- level: number;
2168
- playable_class: Playable;
2169
- playable_race: Playable;
2170
- }
2171
- //#endregion
2172
- //#region src/guild/guild.d.ts
2173
- /**
2174
- * @param realmSlug The slug of the realm.
2175
- * @param nameSlug The lowercase name of the guild.
2176
- * @returns a single guild by its name and realm.
2177
- */
2178
- declare function guild(realmSlug: string, nameSlug: string): Resource<GuildResponse>;
2179
- /**
2180
- * @param realmSlug The slug of the realm.
2181
- * @param nameSlug The lowercase name of the guild.
2182
- * @returns a single guild's achievements by name and realm.
2183
- */
2184
- declare function guildAchievements(realmSlug: string, nameSlug: string): Resource<GuildAchievementsResponse>;
2185
- /**
2186
- * @param realmSlug The slug of the realm.
2187
- * @param nameSlug The lowercase name of the guild.
2188
- * @returns a single guild's activity by name and realm.
2189
- */
2190
- declare function guildActivity(realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
2191
- /**
2192
- * @param realmSlug The slug of the realm.
2193
- * @param nameSlug The lowercase name of the guild.
2194
- * @returns a single guild's roster by its name and realm.
2195
- */
2196
- declare function guildRoster(realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
2197
- //#endregion
2198
- //#region src/heirloom/types.d.ts
2199
- /**
2200
- * The response for the heirloom index.
2201
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2202
- */
2203
- interface HeirloomIndexResponse extends ResponseBase {
2204
- heirlooms: Array<NameIdKey>;
2205
- }
2206
- /**
2207
- * The response for a heirloom.
2208
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2209
- */
2210
- interface HeirloomResponse extends ResponseBase {
2211
- id: number;
2212
- item: NameIdKey;
2213
- media: Media$11;
2214
- source: Source$3;
2215
- source_description: string;
2216
- upgrades: Array<Upgrade>;
2217
- }
2218
- interface AttackSpeedClass {
2219
- display_string: string;
2220
- value: number;
2221
- }
2222
- interface Damage$1 {
2223
- damage_class: Source$3;
2224
- display_string: string;
2225
- max_value: number;
2226
- min_value: number;
2227
- }
2228
- interface Display$1 {
2229
- color: Color;
2230
- display_string: string;
2231
- }
2232
- interface Media$11 extends KeyBase {
2233
- id: number;
2234
- }
2235
- interface Requirements$2 {
2236
- level: RequirementsLevel;
2237
- }
2238
- interface RequirementsLevel {
2239
- display_string: string;
2240
- }
2241
- interface Source$3 {
2242
- name: string;
2243
- type: string;
2244
- }
2245
- interface Stat$1 {
2246
- display: Display$1;
2247
- is_equip_bonus?: boolean;
2248
- type: Source$3;
2249
- value: number;
2250
- }
2251
- interface Upgrade {
2252
- item: UpgradeItem;
2253
- level: number;
2254
- }
2255
- interface UpgradeItem {
2256
- binding: Source$3;
2257
- bonus_list: Array<number>;
2258
- context: number;
2259
- inventory_type: Source$3;
2260
- item: Media$11;
2261
- item_class: NameIdKey;
2262
- item_subclass: NameIdKey;
2263
- level: AttackSpeedClass;
2264
- media: Media$11;
2265
- name: string;
2266
- quality: Source$3;
2267
- requirements: Requirements$2;
2268
- stats: Array<Stat$1>;
2269
- upgrades: Upgrades;
2270
- weapon: Weapon$1;
2271
- }
2272
- interface Upgrades {
2273
- display_string: string;
2274
- max_value: number;
2275
- value: number;
2276
- }
2277
- interface Weapon$1 {
2278
- attack_speed: AttackSpeedClass;
2279
- damage: Damage$1;
2280
- dps: AttackSpeedClass;
2281
- }
2282
- //#endregion
2283
- //#region src/heirloom/heirloom.d.ts
2284
- /**
2285
- * Get a heirloom by ID.
2286
- * @param heirloomId The heirloom ID.
2287
- * @returns The heirloom. See {@link HeirloomResponse}.
2288
- */
2289
- declare function heirloom(heirloomId: number): Resource<HeirloomResponse>;
2290
- /**
2291
- * Get the heirloom index.
2292
- * @returns The heirloom index. See {@link HeirloomIndexResponse}.
2293
- */
2294
- declare function heirloomIndex(): Resource<HeirloomIndexResponse>;
2295
- //#endregion
2296
- //#region src/item/types.d.ts
2297
- /**
2298
- * The response for an item class index.
2299
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2300
- */
2301
- interface ItemClassIndexResponse extends ResponseBase {
2302
- item_classes: Array<NameIdKey>;
2303
- }
2304
- /**
2305
- * The response for an item class.
2306
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2307
- */
2308
- interface ItemClassResponse extends ResponseBase {
2309
- class_id: number;
2310
- item_subclasses: Array<NameIdKey>;
2311
- name: string;
2312
- }
2313
- /**
2314
- * The response for an item media.
2315
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2316
- */
2317
- interface ItemMediaResponse extends ResponseBase {
2318
- assets: Array<MediaAsset>;
2319
- id: number;
2320
- }
2321
- /**
2322
- * The response for an item.
2323
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2324
- */
2325
- interface ItemResponse extends NameId, ResponseBase {
2326
- appearances?: Array<KeyBase & {
2327
- id: number;
2328
- }>;
2329
- description?: string;
2330
- inventory_type: InventoryTypeName;
2331
- is_equippable: boolean;
2332
- is_stackable: boolean;
2333
- item_class: NameIdKey;
2334
- item_subclass: NameIdKey;
2335
- level: number;
2336
- max_count: number;
2337
- media: Media$10;
2338
- preview_item: PreviewItem;
2339
- purchase_price: number;
2340
- purchase_quantity: number;
2341
- quality: ItemQuality;
2342
- required_level: number;
2343
- sell_price: number;
2344
- }
2345
- /**
2346
- * The parameters for an item search.
2347
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2348
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
2349
- */
2350
- interface ItemSearchParameters extends BaseSearchParameters {
2351
- locale: Locales;
2352
- name: string;
2353
- }
2354
- /**
2355
- * The response for an item search.
2356
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2357
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
2358
- */
2359
- interface ItemSearchResponse extends SearchResponseWithoutResults {
2360
- results: Array<ItemSearchResponseItem>;
2361
- }
2362
- /**
2363
- * The response for an item set index.
2364
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2365
- */
2366
- interface ItemSetIndexResponse extends ResponseBase {
2367
- item_sets: Array<NameIdKey>;
2368
- }
2369
- /**
2370
- * The response for an item set.
2371
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2372
- */
2373
- interface ItemSetResponse extends ResponseBase {
2374
- effects: Array<Effect>;
2375
- id: number;
2376
- items: Array<NameIdKey>;
2377
- name: string;
2378
- }
2379
- /**
2380
- * The response for an item subclass.
2381
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2382
- */
2383
- interface ItemSubClassResponse extends ResponseBase {
2384
- class_id: number;
2385
- display_name: string;
2386
- hide_subclass_in_tooltips?: boolean;
2387
- subclass_id: number;
2388
- verbose_name?: string;
2389
- }
2390
- interface Armor {
2391
- display: Display;
2392
- value: number;
2393
- }
2394
- interface Damage {
2395
- damage_class: {
2396
- name: string;
2397
- type: string;
2398
- };
2399
- display_string: string;
2400
- max_value: number;
2401
- min_value: number;
2402
- }
2403
- interface Display {
2404
- color: Color;
2405
- display_string: string;
2406
- }
2407
- interface Durability {
2408
- display_string: string;
2409
- value: number;
2410
- }
2411
- interface Effect {
2412
- display_string: string;
2413
- required_count: number;
2414
- }
2415
- type InventoryType = 'BACK' | 'CHEST' | 'FEET' | 'FINGER' | 'HAND' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'SHOULDER' | 'THROWN' | 'TRINKET' | 'WAIST' | 'WRIST' | 'RANGED' | 'TWOHWEAPON' | 'WEAPON' | 'WEAPONMAINHAND' | 'WEAPONOFFHAND' | 'BAG' | 'NON_EQUIP' | 'SHIRT' | 'TABARD';
2416
- interface InventoryTypeName {
2417
- name: string;
2418
- type: InventoryType;
2419
- }
2420
- interface InventoryTypeNameFromSearch {
2421
- name: Record<Locales, string>;
2422
- type: InventoryType;
2423
- }
2424
- interface ItemQuality {
2425
- name: string;
2426
- type: ItemQualityType;
2427
- }
2428
- interface ItemQualityFromSearch {
2429
- name: Record<Locales, string>;
2430
- type: ItemQualityType;
2431
- }
2432
- type ItemQualityType = 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
2433
- interface ItemSearchResponseItem extends KeyBase {
2434
- data: {
2435
- appearances?: Array<{
2436
- id: number;
2437
- }>;
2438
- id: number;
2439
- inventory_type: InventoryTypeNameFromSearch;
2440
- is_equippable: boolean;
2441
- is_stackable: boolean;
2442
- item_class: {
2443
- id: number;
2444
- name: Record<Locales, string>;
2445
- };
2446
- item_subclass: {
2447
- id: number;
2448
- name: Record<Locales, string>;
2449
- };
2450
- level: number;
2451
- max_count: number;
2452
- media: {
2453
- id: number;
2454
- };
2455
- name: Record<Locales, string | undefined>;
2456
- purchase_price: number;
2457
- purchase_quantity: number;
2458
- quality: ItemQualityFromSearch;
2459
- required_level: number;
2460
- sell_price: number;
2461
- };
2462
- }
2463
- interface Media$10 extends KeyBase {
2464
- id: number;
2465
- }
2466
- interface PreviewItem {
2467
- armor?: Armor;
2468
- binding?: {
2469
- name: string;
2470
- type: string;
2471
- };
2472
- bonus_list?: Array<number>;
2473
- container_slots?: Durability;
2474
- context?: number;
2475
- crafting_reagent?: string;
2476
- description?: string;
2477
- durability?: Durability;
2478
- inventory_type: InventoryTypeName;
2479
- is_subclass_hidden?: boolean;
2480
- item: Media$10;
2481
- item_class: NameIdKey;
2482
- item_subclass: NameIdKey;
2483
- level?: Durability;
2484
- media: Media$10;
2485
- name: string;
2486
- quality: ItemQuality;
2487
- recipe?: Recipe;
2488
- requirements?: Requirements$1;
2489
- sell_price?: number;
2490
- shield_block?: Armor;
2491
- spells?: Array<Spell>;
2492
- stats?: Array<Stat>;
2493
- unique_equipped?: string;
2494
- weapon?: Weapon;
2495
- }
2496
- interface Recipe {
2497
- item: RecipeItem;
2498
- reagents: Array<NameIdKey & {
2499
- quantity: number;
2500
- }>;
2501
- reagents_display_string: string;
2502
- }
2503
- interface RecipeItem {
2504
- armor?: Armor;
2505
- binding: {
2506
- name: string;
2507
- type: string;
2508
- };
2509
- durability: Durability;
2510
- inventory_type: InventoryTypeName;
2511
- item: Media$10;
2512
- item_class: NameIdKey;
2513
- item_subclass: NameIdKey;
2514
- level: Durability;
2515
- media: Media$10;
2516
- name: string;
2517
- quality: ItemQuality;
2518
- requirements: Requirements$1;
2519
- sell_price: {
2520
- display_strings: RecipeItemDisplayStrings;
2521
- value: number;
2522
- };
2523
- stats: Array<Stat>;
2524
- weapon?: Weapon;
2525
- }
2526
- interface RecipeItemDisplayStrings {
2527
- copper: string;
2528
- gold: string;
2529
- header: string;
2530
- silver: string;
2531
- }
2532
- interface Requirements$1 {
2533
- level: Durability;
2534
- }
2535
- interface Spell {
2536
- description: string;
2537
- spell: NameIdKey;
2538
- }
2539
- interface Stat {
2540
- display: Display;
2541
- is_negated?: boolean;
2542
- type: {
2543
- name: string;
2544
- type: StatTypeCapitalized;
2545
- };
2546
- value: number;
2547
- }
2548
- type StatTypeCapitalized = 'AGILITY' | 'ARCANE_RESISTANCE' | 'CRIT_RATING' | 'FIRE_RESISTANCE' | 'FROST_RESISTANCE' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'NATURE_RESISTANCE' | 'SHADOW_RESISTANCE' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
2549
- interface Weapon {
2550
- attack_speed: Durability;
2551
- damage: Damage;
2552
- dps: Durability;
2553
- }
2554
- //#endregion
2555
- //#region src/item/item.d.ts
2556
- /**
2557
- * Get an item by ID.
2558
- * @param itemId The item ID.
2559
- * @returns The item. See {@link ItemResponse}.
2560
- */
2561
- declare function item(itemId: number): Resource<ItemResponse>;
2562
- /**
2563
- * Get an item class by ID.
2564
- * @param itemClassId The item class ID.
2565
- * @returns The item class. See {@link ItemClassResponse}.
2566
- */
2567
- declare function itemClass(itemClassId: number): Resource<ItemClassResponse>;
2568
- /**
2569
- * Get an item class index.
2570
- * @returns The item class index. See {@link ItemClassIndexResponse}.
2571
- */
2572
- declare function itemClassIndex(): Resource<ItemClassIndexResponse>;
2573
- /**
2574
- * Get item media by ID.
2575
- * @param itemId The item ID.
2576
- * @returns The item media. See {@link ItemMediaResponse}.
2577
- */
2578
- declare function itemMedia(itemId: number): Resource<ItemMediaResponse>;
2579
- /**
2580
- * Search for items.
2581
- * @param options The search parameters. See {@link ItemSearchParameters}.
2582
- * @returns The search results. See {@link ItemSearchResponse}.
2583
- */
2584
- declare function itemSearch(options: ItemSearchParameters): Resource<ItemSearchResponse, Omit<ItemSearchParameters, 'locale' | 'name'>>;
2585
- /**
2586
- * Get an item set by ID.
2587
- * @param itemSetId The item set ID.
2588
- * @returns The item set. See {@link ItemSetResponse}.
2589
- */
2590
- declare function itemSet(itemSetId: number): Resource<ItemSetResponse>;
2591
- /**
2592
- * Get an item set index.
2593
- * @returns The item set index. See {@link ItemSetIndexResponse}.
2594
- */
2595
- declare function itemSetIndex(): Resource<ItemSetIndexResponse>;
2596
- /**
2597
- * Get an item subclass by ID.
2598
- * @param itemClassId The item class ID.
2599
- * @param itemSubclassId The item subclass ID.
2600
- * @returns The item subclass. See {@link ItemSubClassResponse}.
2601
- */
2602
- declare function itemSubClass(itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
2603
- //#endregion
2604
- //#region src/journal/types.d.ts
2605
- /**
2606
- * The response for a journal encounter index.
2607
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2608
- */
2609
- interface JournalEncounterIndexResponse extends ResponseBase {
2610
- encounters: Array<NullishNameIdKey>;
2611
- }
2612
- /**
2613
- * The response for a journal encounter.
2614
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2615
- */
2616
- interface JournalEncounterResponse extends NameId, ResponseBase {
2617
- category: Category$1;
2618
- creatures?: Array<Creature>;
2619
- description?: string;
2620
- faction?: Faction;
2621
- instance: KeyBase & {
2622
- id: number;
2623
- name?: string;
2624
- };
2625
- items?: Array<Item>;
2626
- modes?: Array<Mode>;
2627
- sections?: Array<JournalSection>;
2628
- }
2629
- /**
2630
- * The parameters for a journal encounter search.
2631
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2632
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
2633
- */
2634
- interface JournalEncounterSearchParameters extends BaseSearchParameters {
2635
- instanceName: string;
2636
- locale: Locales;
2637
- }
2638
- /**
2639
- * The response for a journal encounter search.
2640
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2641
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
2642
- */
2643
- interface JournalEncounterSearchResponse extends SearchResponseWithoutResults {
2644
- results: Array<JournalEncounterSearchResponseItem>;
2645
- }
2646
- /**
2647
- * The response for a journal expansion index.
2648
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2649
- */
2650
- interface JournalExpansionIndexResponse extends ResponseBase {
2651
- tiers: Array<NameIdKey>;
2652
- }
2653
- /**
2654
- * The response for a journal expansion.
2655
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2656
- */
2657
- interface JournalExpansionResponse extends NameId, ResponseBase {
2658
- dungeons: Array<NameIdKey>;
2659
- raids: Array<NameIdKey>;
2660
- world_bosses?: Array<NameIdKey>;
2661
- }
2662
- /**
2663
- * The response for a journal instance index.
2664
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2665
- */
2666
- interface JournalInstanceIndexResponse extends ResponseBase {
2667
- instances: Array<NameIdKey>;
2668
- }
2669
- /**
2670
- * The response for journal instance media.
2671
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2672
- */
2673
- interface JournalInstanceMediaResponse extends ResponseBase {
2674
- assets: Array<Asset>;
2675
- }
2676
- /**
2677
- * The response for a journal instance.
2678
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2679
- */
2680
- interface JournalInstanceResponse extends NameId, ResponseBase {
2681
- area?: NameId;
2682
- category: Category$1;
2683
- description?: string;
2684
- encounters: Array<NameIdKey>;
2685
- expansion?: NameIdKey;
2686
- location?: NameId;
2687
- map?: NameId;
2688
- media: Media$9;
2689
- minimum_level?: number;
2690
- modes?: Array<ModeElement>;
2691
- order_index?: number;
2692
- }
2693
- interface Asset {
2694
- key: string;
2695
- value: string;
2696
- }
2697
- interface Category$1 {
2698
- type?: EncounterCategory;
2699
- }
2700
- interface Creature extends NameId {
2701
- creature_display: CreatureDisplay$1;
2702
- description?: string;
2703
- }
2704
- interface CreatureDisplay$1 extends KeyBase {
2705
- id: number;
2706
- }
2707
- type EncounterCategory = 'DUNGEON' | 'EVENT' | 'RAID' | 'WORLD_BOSS';
2708
- type EncounterMode = 'HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
2709
- interface Item {
2710
- id: number;
2711
- item: NameIdKey;
2712
- }
2713
- interface JournalEncounterSearchCreature {
2714
- creature_display: {
2715
- id: number;
2716
- };
2717
- id: number;
2718
- name: Record<Locales, string>;
2719
- }
2720
- interface JournalEncounterSearchItem {
2721
- id: number;
2722
- item: {
2723
- id: number;
2724
- name: Record<Locales, string>;
2725
- };
2726
- }
2727
- interface JournalEncounterSearchResponseItem extends KeyBase {
2728
- data: {
2729
- category: Category$1;
2730
- creatures: Array<JournalEncounterSearchCreature>;
2731
- id: number;
2732
- instance: {
2733
- id: number;
2734
- name?: Record<Locales, string>;
2735
- };
2736
- items?: Array<JournalEncounterSearchItem>;
2737
- modes?: Array<{
2738
- name: Record<Locales, string>;
2739
- type: EncounterMode;
2740
- }>;
2741
- name: Record<Locales, string>;
2742
- sections?: Array<JournalSection>;
2743
- };
2744
- }
2745
- interface JournalSection {
2746
- body_text?: null | string;
2747
- creature_display?: CreatureDisplay$1;
2748
- id: number;
2749
- sections?: Array<JournalSubSection>;
2750
- spell?: KeyBase & {
2751
- id: number;
2752
- name?: string;
2753
- };
2754
- title?: null | string;
2755
- }
2756
- interface JournalSubSection {
2757
- body_text?: null | string;
2758
- creature_display?: CreatureDisplay$1;
2759
- id: number;
2760
- sections?: Array<JournalSubSection2>;
2761
- spell?: KeyBase & {
2762
- id: number;
2763
- name?: string;
2764
- };
2765
- title?: string;
2766
- }
2767
- interface JournalSubSection2 {
2768
- body_text?: null | string;
2769
- creature_display?: CreatureDisplay$1;
2770
- id: number;
2771
- sections?: Array<JournalSubSection3>;
2772
- spell?: KeyBase & {
2773
- id: number;
2774
- name?: string;
2775
- };
2776
- title?: string;
2777
- }
2778
- interface JournalSubSection3 {
2779
- body_text?: null | string;
2780
- creature_display?: CreatureDisplay$1;
2781
- id: number;
2782
- sections?: Array<JournalSubSection4>;
2783
- spell?: KeyBase & {
2784
- id: number;
2785
- name?: string;
2786
- };
2787
- title?: string;
2788
- }
2789
- interface JournalSubSection4 {
2790
- body_text?: null | string;
2791
- creature_display?: CreatureDisplay$1;
2792
- id: number;
2793
- sections?: Array<JournalSubSection5>;
2794
- spell?: KeyBase & {
2795
- id: number;
2796
- name?: string;
2797
- };
2798
- title?: string;
2799
- }
2800
- interface JournalSubSection5 {
2801
- body_text?: null | string;
2802
- creature_display?: CreatureDisplay$1;
2803
- id: number;
2804
- sections?: Array<JournalSubSection6>;
2805
- spell?: KeyBase & {
2806
- id: number;
2807
- name?: string;
2808
- };
2809
- title?: string;
2810
- }
2811
- interface JournalSubSection6 {
2812
- body_text?: null | string;
2813
- creature_display?: CreatureDisplay$1;
2814
- id: number;
2815
- spell?: KeyBase & {
2816
- id: number;
2817
- name?: string;
2818
- };
2819
- title?: string;
2820
- }
2821
- interface Media$9 extends KeyBase {
2822
- id: number;
2823
- }
2824
- interface Mode {
2825
- name: string;
2826
- type: ModeType;
2827
- }
2828
- interface ModeElement {
2829
- is_timewalking?: boolean;
2830
- is_tracked: boolean;
2831
- mode: Mode;
2832
- players: number;
2833
- }
2834
- type ModeType = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
2835
- //#endregion
2836
- //#region src/journal/journal.d.ts
2837
- /**
2838
- * Get a journal encounter by ID.
2839
- * @param journalEncounterId The journal encounter ID.
2840
- * @returns The journal encounter. See {@link JournalEncounterResponse}.
2841
- */
2842
- declare function journalEncounter(journalEncounterId: number): Resource<JournalEncounterResponse>;
2843
- /**
2844
- * Get the journal encounter index.
2845
- * @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
2846
- */
2847
- declare function journalEncounterIndex(): Resource<JournalEncounterIndexResponse>;
2848
- /**
2849
- * Search for journal encounters.
2850
- * @param options The search parameters. See {@link JournalEncounterSearchParameters}.
2851
- * @returns The search results. See {@link JournalEncounterSearchResponse}.
2852
- */
2853
- declare function journalEncounterSearch(options: JournalEncounterSearchParameters): Resource<JournalEncounterSearchResponse, Omit<JournalEncounterSearchParameters, 'instanceName' | 'locale'>>;
2854
- /**
2855
- * Get a journal expansion by ID.
2856
- * @param journalExpansionId The journal expansion ID.
2857
- * @returns The journal expansion. See {@link JournalExpansionResponse}.
2858
- */
2859
- declare function journalExpansion(journalExpansionId: number): Resource<JournalExpansionResponse>;
2860
- /**
2861
- * Get the journal expansion index.
2862
- * @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
2863
- */
2864
- declare function journalExpansionIndex(): Resource<JournalExpansionIndexResponse>;
2865
- /**
2866
- * Get a journal instance by ID.
2867
- * @param journalInstanceId The journal instance ID.
2868
- * @returns The journal instance. See {@link JournalInstanceResponse}.
2869
- */
2870
- declare function journalInstance(journalInstanceId: number): Resource<JournalInstanceResponse>;
2871
- /**
2872
- * Get the journal instance index.
2873
- * @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
2874
- */
2875
- declare function journalInstanceIndex(): Resource<JournalInstanceIndexResponse>;
2876
- /**
2877
- * Get journal instance media by ID.
2878
- * @param journalInstanceId The journal instance ID.
2879
- * @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
2880
- */
2881
- declare function journalInstanceMedia(journalInstanceId: number): Resource<JournalInstanceMediaResponse>;
2882
- //#endregion
2883
- //#region src/media-search/types.d.ts
2884
- /**
2885
- * The search parameters for media.
2886
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2887
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
2888
- */
2889
- interface MediaSearchParameters extends BaseSearchParameters {
2890
- tags?: string;
2891
- }
2892
- /**
2893
- * The response for a media search.
2894
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2895
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
2896
- */
2897
- interface MediaSearchResponse extends SearchResponseWithoutResults {
2898
- results: Array<MediaSearchResponseItem>;
2899
- }
2900
- interface MediaSearchResponseItem extends KeyBase {
2901
- data: {
2902
- assets?: Array<MediaAsset>;
2903
- id?: number;
2904
- };
2905
- }
2906
- //#endregion
2907
- //#region src/media-search/media-search.d.ts
2908
- /**
2909
- * Search for media.
2910
- * @param options The search parameters. See {@link MediaSearchParameters}.
2911
- * @returns The search results. See {@link MediaSearchResponse}.
2912
- */
2913
- declare function mediaSearch(options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
2914
- //#endregion
2915
- //#region src/modified-crafting/types.d.ts
2916
- /**
2917
- * The response for a modified crafting category index.
2918
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2919
- */
2920
- interface ModifiedCraftingCategoryIndexResponse extends ResponseBase {
2921
- categories: Array<KeyBase & {
2922
- id: number;
2923
- name?: null | string;
2924
- }>;
2925
- }
2926
- /**
2927
- * The response for a modified crafting category.
2928
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2929
- */
2930
- interface ModifiedCraftingCategoryResponse extends ResponseBase {
2931
- id: number;
2932
- name?: string;
2933
- }
2934
- /**
2935
- * The response for a modified crafting index.
2936
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2937
- */
2938
- interface ModifiedCraftingIndexResponse extends ResponseBase {
2939
- categories: Href;
2940
- slot_types: Href;
2941
- }
2942
- /**
2943
- * The response for a modified crafting reagent slot type index.
2944
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2945
- */
2946
- interface ModifiedCraftingReagentSlotTypeIndexResponse extends ResponseBase {
2947
- slot_types: Array<SlotType>;
2948
- }
2949
- /**
2950
- * The response for a modified crafting reagent slot type.
2951
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2952
- */
2953
- interface ModifiedCraftingReagentSlotTypeResponse extends ResponseBase {
2954
- compatible_categories: Array<NameIdKey>;
2955
- description: string;
2956
- id: number;
2957
- }
2958
- interface SlotType extends KeyBase {
2959
- id: number;
2960
- name?: null | string;
2961
- }
2962
- //#endregion
2963
- //#region src/modified-crafting/modified-crafting.d.ts
2964
- /**
2965
- * Get a modified crafting category by ID.
2966
- * @param modifiedCraftingCategoryId The modified crafting category ID.
2967
- * @returns The modified crafting category. See {@link ModifiedCraftingCategoryResponse}.
2968
- */
2969
- declare function modifiedCraftingCategory(modifiedCraftingCategoryId: number): Resource<ModifiedCraftingCategoryResponse>;
2970
- /**
2971
- * Get a modified crafting category index.
2972
- * @returns The modified crafting category index. See {@link ModifiedCraftingCategoryIndexResponse}.
2973
- */
2974
- declare function modifiedCraftingCategoryIndex(): Resource<ModifiedCraftingCategoryIndexResponse>;
2975
- /**
2976
- * Get a modified crafting index.
2977
- * @returns The modified crafting index. See {@link ModifiedCraftingIndexResponse}.
2978
- */
2979
- declare function modifiedCraftingIndex(): Resource<ModifiedCraftingIndexResponse>;
2980
- /**
2981
- * Get a modified crafting reagent slot type by ID.
2982
- * @param modifiedCraftingReagentSlotTypeId The modified crafting reagent slot type ID.
2983
- * @returns The modified crafting reagent slot type. See {@link ModifiedCraftingReagentSlotTypeResponse}.
2984
- */
2985
- declare function modifiedCraftingReagentSlotType(modifiedCraftingReagentSlotTypeId: number): Resource<ModifiedCraftingReagentSlotTypeResponse>;
2986
- /**
2987
- * Get a modified crafting reagent slot type index.
2988
- * @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
2989
- */
2990
- declare function modifiedCraftingReagentSlotTypeIndex(): Resource<ModifiedCraftingReagentSlotTypeIndexResponse>;
2991
- //#endregion
2992
- //#region src/mount/types.d.ts
2993
- /**
2994
- * The response for a mount index.
2995
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
2996
- */
2997
- interface MountIndexResponse extends ResponseBase {
2998
- mounts: Array<NullishNameIdKey>;
2999
- }
3000
- /**
3001
- * The response for a mount.
3002
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3003
- */
3004
- interface MountResponse extends ResponseBase {
3005
- creature_displays: Array<CreatureDisplay>;
3006
- description: null | string;
3007
- faction?: Faction;
3008
- id: number;
3009
- name: string;
3010
- requirements?: {
3011
- classes?: Array<NameIdKey>;
3012
- faction?: Faction;
3013
- races?: Array<NameIdKey>;
3014
- };
3015
- should_exclude_if_uncollected?: boolean;
3016
- source?: Source$2;
3017
- }
3018
- /**
3019
- * The search parameters for mounts.
3020
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3021
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
3022
- */
3023
- interface MountSearchParameters extends BaseSearchParameters {
3024
- locale: Locales;
3025
- name: string;
3026
- }
3027
- /**
3028
- * The response for a mount search.
3029
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3030
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
3031
- */
3032
- interface MountSearchResponse extends SearchResponseWithoutResults {
3033
- results: Array<MountSearchResponseItem>;
3034
- }
3035
- interface CreatureDisplay extends KeyBase {
3036
- id: number;
3037
- }
3038
- interface MountSearchResponseItem extends KeyBase {
3039
- data: {
3040
- creature_displays: Array<{
3041
- id: number;
3042
- }>;
3043
- faction?: {
3044
- name: Record<Locales, string>;
3045
- type: Factions;
3046
- };
3047
- id: number;
3048
- name: Record<Locales, string>;
3049
- source: {
3050
- name: Record<Locales, string>;
3051
- type: string;
3052
- };
3053
- };
3054
- }
3055
- interface Source$2 {
3056
- name: string;
3057
- type: string;
3058
- }
3059
- //#endregion
3060
- //#region src/mount/mount.d.ts
3061
- /**
3062
- * Get a mount by ID.
3063
- * @param mountId The mount ID.
3064
- * @returns The mount. See {@link MountResponse}.
3065
- */
3066
- declare function mount(mountId: number): Resource<MountResponse>;
3067
- /**
3068
- * Get a mount index.
3069
- * @returns The mount index. See {@link MountIndexResponse}.
3070
- */
3071
- declare function mountIndex(): Resource<MountIndexResponse>;
3072
- /**
3073
- * Get a mount search.
3074
- * @param options The search parameters. See {@link MountSearchParameters}.
3075
- * @returns The search results. See {@link MountSearchResponse}.
3076
- */
3077
- declare function mountSearch(options: MountSearchParameters): Resource<MountSearchResponse, Omit<MountSearchParameters, 'locale' | 'name'>>;
3078
- //#endregion
3079
- //#region src/mythic-keystone-affix/types.d.ts
3080
- /**
3081
- * The response for a Mythic Keystone affix index.
3082
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3083
- */
3084
- interface MythicKeystoneAffixIndexResponse extends ResponseBase {
3085
- affixes: Array<KeyBase & {
3086
- id: number;
3087
- name: null | string;
3088
- }>;
3089
- }
3090
- /**
3091
- * The response for a Mythic Keystone affix media.
3092
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3093
- */
3094
- interface MythicKeystoneAffixMediaResponse extends ResponseBase {
3095
- assets?: Array<MediaAsset>;
3096
- id: number;
3097
- }
3098
- /**
3099
- * The response for a Mythic Keystone affix.
3100
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3101
- */
3102
- interface MythicKeystoneAffixResponse extends ResponseBase {
3103
- description: null | string;
3104
- id: number;
3105
- media: Media$8;
3106
- name: null | string;
3107
- }
3108
- interface Media$8 extends KeyBase {
3109
- id: number;
3110
- }
3111
- //#endregion
3112
- //#region src/mythic-keystone-affix/mythic-keystone-affix.d.ts
3113
- /**
3114
- * Get a list of all Mythic Keystone affixes.
3115
- * @param mythicKeystoneAffixId The ID of the Mythic Keystone affix.
3116
- * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
3117
- */
3118
- declare function mythicKeystoneAffix(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixResponse>;
3119
- /**
3120
- * Get a list of all Mythic Keystone affixes.
3121
- * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
3122
- */
3123
- declare function mythicKeystoneAffixIndex(): Resource<MythicKeystoneAffixIndexResponse>;
3124
- /**
3125
- * Get a list of all Mythic Keystone affix media.
3126
- * @param mythicKeystoneAffixId The ID of the Mythic Keystone affix.
3127
- * @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
3128
- */
3129
- declare function mythicKeystoneAffixMedia(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixMediaResponse>;
3130
- //#endregion
3131
- //#region src/mythic-keystone-dungeon/types.d.ts
3132
- /**
3133
- * The response for a Mythic Keystone dungeon index.
3134
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3135
- */
3136
- interface MythicKeystoneDungeonIndexResponse extends ResponseBase {
3137
- dungeons: Array<NameIdKey>;
3138
- }
3139
- /**
3140
- * The response for a Mythic Keystone dungeon.
3141
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3142
- */
3143
- interface MythicKeystoneDungeonResponse extends NameId, ResponseBase {
3144
- dungeon: NameIdKey;
3145
- is_tracked: boolean;
3146
- keystone_upgrades: Array<KeystoneUpgrade>;
3147
- map: NameId;
3148
- zone: Zone;
3149
- }
3150
- /**
3151
- * The response for a Mythic Keystone index.
3152
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3153
- */
3154
- interface MythicKeystoneIndexResponse extends ResponseBase {
3155
- dungeons: Href;
3156
- seasons: Href;
3157
- }
3158
- /**
3159
- * The response for a Mythic Keystone period index.
3160
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3161
- */
3162
- interface MythicKeystonePeriodIndexResponse extends ResponseBase {
3163
- current_period: Period;
3164
- periods: Array<Period>;
3165
- }
3166
- /**
3167
- * The response for a Mythic Keystone period.
3168
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3169
- */
3170
- interface MythicKeystonePeriodResponse extends ResponseBase {
3171
- end_timestamp: number;
3172
- id: number;
3173
- start_timestamp: number;
3174
- }
3175
- /**
3176
- * The response for a Mythic Keystone season index.
3177
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3178
- */
3179
- interface MythicKeystoneSeasonIndexResponse extends ResponseBase {
3180
- current_season: Period;
3181
- seasons: Array<Period>;
3182
- }
3183
- /**
3184
- * The response for a Mythic Keystone season.
3185
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3186
- */
3187
- interface MythicKeystoneSeasonResponse extends ResponseBase {
3188
- end_timestamp: number;
3189
- id: number;
3190
- periods: Array<Period>;
3191
- season_name: null | string;
3192
- start_timestamp: number;
3193
- }
3194
- interface KeystoneUpgrade {
3195
- qualifying_duration: number;
3196
- upgrade_level: number;
3197
- }
3198
- interface Period extends KeyBase {
3199
- id: number;
3200
- }
3201
- interface Zone {
3202
- slug: string;
3203
- }
3204
- //#endregion
3205
- //#region src/mythic-keystone-dungeon/mythic-keystone-dungeon.d.ts
3206
- /**
3207
- * Get a Mythic Keystone dungeon by ID.
3208
- * @param mythicKeystoneDungeonId The Mythic Keystone dungeon ID.
3209
- * @returns The Mythic Keystone dungeon. See {@link MythicKeystoneDungeonResponse}.
3210
- */
3211
- declare function mythicKeystoneDungeon(mythicKeystoneDungeonId: number): Resource<MythicKeystoneDungeonResponse>;
3212
- /**
3213
- * Get a Mythic Keystone dungeon index.
3214
- * @returns The Mythic Keystone dungeon index. See {@link MythicKeystoneDungeonIndexResponse}.
3215
- */
3216
- declare function mythicKeystoneDungeonIndex(): Resource<MythicKeystoneDungeonIndexResponse>;
3217
- /**
3218
- * Get a Mythic Keystone index.
3219
- * @returns The Mythic Keystone index. See {@link MythicKeystoneIndexResponse}.
3220
- */
3221
- declare function mythicKeystoneIndex(): Resource<MythicKeystoneIndexResponse>;
3222
- /**
3223
- * Get a Mythic Keystone period by ID.
3224
- * @param mythicKeystonePeriodId The Mythic Keystone period ID.
3225
- * @returns The Mythic Keystone period. See {@link MythicKeystonePeriodResponse}.
3226
- */
3227
- declare function mythicKeystonePeriod(mythicKeystonePeriodId: number): Resource<MythicKeystonePeriodResponse>;
3228
- /**
3229
- * Get a Mythic Keystone period index.
3230
- * @returns The Mythic Keystone period index. See {@link MythicKeystonePeriodIndexResponse}.
3231
- */
3232
- declare function mythicKeystonePeriodIndex(): Resource<MythicKeystonePeriodIndexResponse>;
3233
- /**
3234
- * Get a Mythic Keystone season by ID.
3235
- * @param mythicKeystoneSeasonId The Mythic Keystone season ID.
3236
- * @returns The Mythic Keystone season. See {@link MythicKeystoneSeasonResponse}.
3237
- */
3238
- declare function mythicKeystoneSeason(mythicKeystoneSeasonId: number): Resource<MythicKeystoneSeasonResponse>;
3239
- /**
3240
- * Get a Mythic Keystone season index.
3241
- * @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
3242
- */
3243
- declare function mythicKeystoneSeasonIndex(): Resource<MythicKeystoneSeasonIndexResponse>;
3244
- //#endregion
3245
- //#region src/mythic-keystone-leaderboard/types.d.ts
3246
- /**
3247
- * The response for a Mythic Keystone leaderboard index.
3248
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3249
- */
3250
- interface MythicKeystoneLeaderboardIndexResponse extends ResponseBase {
3251
- current_leaderboards: Array<NameIdKey>;
3252
- }
3253
- /**
3254
- * The response for a Mythic Keystone leaderboard.
3255
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3256
- */
3257
- interface MythicKeystoneLeaderboardResponse extends ResponseBase {
3258
- connected_realm: Href;
3259
- keystone_affixes: Array<KeystoneAffixElement>;
3260
- leading_groups: Array<LeadingGroup>;
3261
- map: NameId;
3262
- map_challenge_mode_id: number;
3263
- name: string;
3264
- period: number;
3265
- period_end_timestamp: number;
3266
- period_start_timestamp: number;
3267
- }
3268
- interface KeystoneAffixElement {
3269
- keystone_affix: NameIdKey;
3270
- starting_level: number;
3271
- }
3272
- interface LeadingGroup {
3273
- completed_timestamp: number;
3274
- duration: number;
3275
- keystone_level: number;
3276
- members: Array<Member>;
3277
- ranking: number;
3278
- }
3279
- interface Member {
3280
- faction: {
3281
- type: Factions;
3282
- };
3283
- profile: Profile;
3284
- specialization: Specialization;
3285
- }
3286
- interface Profile extends NameId {
3287
- realm: Realm$3;
3288
- }
3289
- interface Realm$3 extends KeyBase {
3290
- id: number;
3291
- slug: string;
3292
- }
3293
- interface Specialization extends KeyBase {
3294
- id: number;
3295
- }
3296
- //#endregion
3297
- //#region src/mythic-keystone-leaderboard/mythic-keystone-leaderboard.d.ts
3298
- /**
3299
- * Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
3300
- * @param connectedRealmId The connected realm ID.
3301
- * @param dungeonId The dungeon ID.
3302
- * @param period The period ID.
3303
- * @returns The Mythic Keystone leaderboard. See {@link MythicKeystoneLeaderboardResponse}.
3304
- */
3305
- declare function mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId: number, period: number): Resource<MythicKeystoneLeaderboardResponse>;
3306
- /**
3307
- * Get a Mythic Keystone leaderboard index by connected realm ID.
3308
- * @param connectedRealmId The connected realm ID.
3309
- * @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
3310
- */
3311
- declare function mythicKeystoneLeaderboardIndex(connectedRealmId: number): Resource<MythicKeystoneLeaderboardIndexResponse>;
3312
- //#endregion
3313
- //#region src/mythic-raid-leaderboard/types.d.ts
3314
- /**
3315
- * The response for a Mythic Raid leaderboard.
3316
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3317
- */
3318
- interface MythicRaidLeaderboardResponse extends ResponseBase {
3319
- criteria_type: string;
3320
- entries: Array<Entry$1>;
3321
- journal_instance: JournalInstance;
3322
- slug: string;
3323
- }
3324
- interface Entry$1 {
3325
- faction: {
3326
- type: Factions;
3327
- };
3328
- guild: Guild;
3329
- rank: number;
3330
- region: Origins;
3331
- timestamp: number;
3332
- }
3333
- interface Guild extends NameId {
3334
- realm: Realm$2;
3335
- }
3336
- interface JournalInstance extends KeyBase {
3337
- id: number;
3338
- name: null | string;
3339
- }
3340
- interface Realm$2 {
3341
- id: number;
3342
- name: null | string;
3343
- slug: string;
3344
- }
3345
- //#endregion
3346
- //#region src/mythic-raid-leaderboard/mythic-raid-leaderboard.d.ts
3347
- /**
3348
- * Get a Mythic Raid leaderboard by raid and faction.
3349
- * @param raid The slug of the raid.
3350
- * @param faction The faction. Either 'alliance' or 'horde'.
3351
- * @returns The Mythic Raid leaderboard. See {@link MythicRaidLeaderboardResponse}.
3352
- */
3353
- declare function mythicRaidLeaderboard(raid: string, faction: Lowercase<Factions>): Resource<MythicRaidLeaderboardResponse>;
3354
- //#endregion
3355
- //#region src/pet/types.d.ts
3356
- /**
3357
- * The response for a pet ability index.
3358
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3359
- */
3360
- interface PetAbilityIndexResponse extends ResponseBase {
3361
- abilities: Array<NullishNameIdKey>;
3362
- }
3363
- /**
3364
- * The response for a pet ability media.
3365
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3366
- */
3367
- interface PetAbilityMediaResponse extends ResponseBase {
3368
- assets: Array<MediaAsset>;
3369
- id: number;
3370
- }
3371
- /**
3372
- * The response for a pet ability.
3373
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3374
- */
3375
- interface PetAbilityResponse extends NameId, ResponseBase {
3376
- battle_pet_type: BattlePetType;
3377
- cooldown?: number;
3378
- media: Media$7;
3379
- rounds: number;
3380
- }
3381
- /**
3382
- * The response for a pet index.
3383
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3384
- */
3385
- interface PetIndexResponse extends ResponseBase {
3386
- pets: Array<NullishNameIdKey>;
3387
- }
3388
- /**
3389
- * The response for a pet search.
3390
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3391
- */
3392
- interface PetMediaResponse extends ResponseBase {
3393
- assets: Array<MediaAsset>;
3394
- id: number;
3395
- }
3396
- /**
3397
- * The response for a pet.
3398
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3399
- */
3400
- interface PetResponse extends NameId, ResponseBase {
3401
- abilities?: Array<Ability>;
3402
- battle_pet_type: BattlePetType;
3403
- creature: NameIdKey;
3404
- description: null | string;
3405
- icon: string;
3406
- is_alliance_only: boolean;
3407
- is_battlepet: boolean;
3408
- is_capturable: boolean;
3409
- is_horde_only: boolean;
3410
- is_random_creature_display: boolean;
3411
- is_tradable: boolean;
3412
- media: Media$7;
3413
- should_exclude_if_uncollected?: boolean;
3414
- source?: Source$1;
3415
- }
3416
- interface Ability {
3417
- ability: NameIdKey;
3418
- required_level: number;
3419
- slot: number;
3420
- }
3421
- interface BattlePetType extends NameId {
3422
- type: string;
3423
- }
3424
- interface Media$7 extends KeyBase {
3425
- id: number;
3426
- }
3427
- interface Source$1 {
3428
- name: string;
3429
- type: string;
3430
- }
3431
- //#endregion
3432
- //#region src/pet/pet.d.ts
3433
- /**
3434
- * Get a pet by ID.
3435
- * @param petId The pet ID.
3436
- * @returns The pet. See {@link PetResponse}.
3437
- */
3438
- declare function pet(petId: number): Resource<PetResponse>;
3439
- /**
3440
- * Get a pet ability by ID.
3441
- * @param petAbilityId The pet ability ID.
3442
- * @returns The pet ability. See {@link PetAbilityResponse}.
3443
- */
3444
- declare function petAbility(petAbilityId: number): Resource<PetAbilityResponse>;
3445
- /**
3446
- * Get a pet ability index.
3447
- * @returns The pet ability index. See {@link PetAbilityIndexResponse}.
3448
- */
3449
- declare function petAbilityIndex(): Resource<PetAbilityIndexResponse>;
3450
- /**
3451
- * Get a pet ability media by ID.
3452
- * @param petAbilityId The pet ability ID.
3453
- * @returns The pet ability media. See {@link PetAbilityMediaResponse}.
3454
- */
3455
- declare function petAbilityMedia(petAbilityId: number): Resource<PetAbilityMediaResponse>;
3456
- /**
3457
- * Get a pet index.
3458
- * @returns The pet index. See {@link PetIndexResponse}.
3459
- */
3460
- declare function petIndex(): Resource<PetIndexResponse>;
3461
- /**
3462
- * Get a pet media by ID.
3463
- * @param petId The pet ID.
3464
- * @returns The pet media. See {@link PetMediaResponse}.
3465
- */
3466
- declare function petMedia(petId: number): Resource<PetMediaResponse>;
3467
- //#endregion
3468
- //#region src/playable-class/types.d.ts
3469
- /**
3470
- * The response for a playable class index.
3471
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3472
- */
3473
- interface PlayableClassIndexResponse extends ResponseBase {
3474
- classes: Array<NameIdKey>;
3475
- }
3476
- /**
3477
- * The response for playable class media.
3478
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3479
- */
3480
- interface PlayableClassMediaResponse extends ResponseBase {
3481
- assets: Array<MediaAsset>;
3482
- id: number;
3483
- }
3484
- /**
3485
- * The response for a playable class.
3486
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3487
- */
3488
- interface PlayableClassResponse extends NameId, ResponseBase {
3489
- gender_name: GenderName;
3490
- media: Media$6;
3491
- playable_races: Array<NameIdKey>;
3492
- power_type: NameIdKey;
3493
- pvp_talent_slots: Href;
3494
- specializations: Array<NameIdKey>;
3495
- }
3496
- /**
3497
- * The response for a playable class's PvP talent slots.
3498
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3499
- */
3500
- interface PvpTalentSlotsResponse extends ResponseBase {
3501
- talent_slots: Array<TalentSlot>;
3502
- }
3503
- interface Media$6 extends KeyBase {
3504
- id: number;
3505
- }
3506
- interface TalentSlot {
3507
- slot_number: number;
3508
- unlock_player_level: number;
3509
- }
3510
- //#endregion
3511
- //#region src/playable-class/playable-class.d.ts
3512
- /**
3513
- * Get a playable class by ID.
3514
- * @param playableClassId The playable class ID.
3515
- * @returns The playable class. See {@link PlayableClassResponse}.
3516
- */
3517
- declare function playableClass(playableClassId: number): Resource<PlayableClassResponse>;
3518
- /**
3519
- * Get a playable class index.
3520
- * @returns The playable class index. See {@link PlayableClassIndexResponse}.
3521
- */
3522
- declare function playableClassIndex(): Resource<PlayableClassIndexResponse>;
3523
- /**
3524
- * Get playable class media by ID.
3525
- * @param playableClassId The playable class ID.
3526
- * @returns The playable class media. See {@link PlayableClassMediaResponse}.
3527
- */
3528
- declare function playableClassMedia(playableClassId: number): Resource<PlayableClassMediaResponse>;
3529
- /**
3530
- * Get a playable class's PvP talent slots by ID.
3531
- * @param playableClassId The playable class ID.
3532
- * @returns The playable class's PvP talent slots. See {@link PvpTalentSlotsResponse}.
3533
- */
3534
- declare function pvpTalentSlots(playableClassId: number): Resource<PvpTalentSlotsResponse>;
3535
- //#endregion
3536
- //#region src/playable-race/types.d.ts
3537
- /**
3538
- * The playable race index response.
3539
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3540
- */
3541
- interface PlayableRaceIndexResponse extends ResponseBase {
3542
- races: Array<NameIdKey>;
3543
- }
3544
- /**
3545
- * The playable race response.
3546
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3547
- */
3548
- interface PlayableRaceResponse extends NameId, ResponseBase {
3549
- faction: Faction;
3550
- gender_name: GenderName;
3551
- is_allied_race: boolean;
3552
- is_selectable: boolean;
3553
- playable_classes: Array<NameIdKey>;
3554
- racial_spells: Array<NameIdKey>;
3555
- }
3556
- //#endregion
3557
- //#region src/playable-race/playable-race.d.ts
3558
- /**
3559
- * Get a playable race by ID.
3560
- * @param playableRaceId The playable race ID.
3561
- * @returns The playable race. See {@link PlayableRaceResponse}.
3562
- */
3563
- declare function playableRace(playableRaceId: number): Resource<PlayableRaceResponse>;
3564
- /**
3565
- * Get a playable race index.
3566
- * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
3567
- */
3568
- declare function playableRaceIndex(): Resource<PlayableRaceIndexResponse>;
3569
- //#endregion
3570
- //#region src/playable-specialization/types.d.ts
3571
- /**
3572
- * The response for a playable specialization index.
3573
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3574
- */
3575
- interface PlayableSpecializationIndexResponse extends ResponseBase {
3576
- character_specializations: Array<NameIdKey>;
3577
- pet_specializations: Array<NameIdKey>;
3578
- }
3579
- /**
3580
- * The response for a playable specialization media.
3581
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3582
- */
3583
- interface PlayableSpecializationMediaResponse extends ResponseBase {
3584
- assets: Array<MediaAsset>;
3585
- id: number;
3586
- }
3587
- /**
3588
- * The response for a playable specialization.
3589
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3590
- */
3591
- interface PlayableSpecializationResponse extends NameId, ResponseBase {
3592
- gender_description: GenderName;
3593
- hero_talent_trees: Array<NullishNameIdKey>;
3594
- media: Media$5;
3595
- playable_class: NameIdKey;
3596
- power_type: NameIdKey;
3597
- primary_stat_type: PrimaryStatType;
3598
- pvp_talents: Array<PvpTalent>;
3599
- role: PrimaryStatType;
3600
- spec_talent_tree: SpecTalentTree$1;
3601
- }
3602
- interface Media$5 extends KeyBase {
3603
- id: number;
3604
- }
3605
- interface PrimaryStatType {
3606
- name: string;
3607
- type: string;
3608
- }
3609
- interface PvpTalent {
3610
- spell_tooltip: SpellTooltip$1;
3611
- talent: NameIdKey;
3612
- }
3613
- interface SpecTalentTree$1 extends KeyBase {
3614
- name: string;
3615
- }
3616
- interface SpellTooltip$1 {
3617
- cast_time: string;
3618
- cooldown?: string;
3619
- description: string;
3620
- power_cost?: null | string;
3621
- range?: string;
3622
- }
3623
- //#endregion
3624
- //#region src/playable-specialization/playable-specialization.d.ts
3625
- /**
3626
- * Get a playable specialization by ID.
3627
- * @param specializationId The playable specialization ID.
3628
- * @returns The playable specialization. See {@link PlayableSpecializationResponse}.
3629
- */
3630
- declare function playableSpecialization(specializationId: number): Resource<PlayableSpecializationResponse>;
3631
- /**
3632
- * Get a playable specialization index.
3633
- * @returns The playable specialization index. See {@link PlayableSpecializationIndexResponse}.
3634
- */
3635
- declare function playableSpecializationIndex(): Resource<PlayableSpecializationIndexResponse>;
3636
- /**
3637
- * Get a playable specialization media by ID.
3638
- * @param specializationId The playable specialization ID.
3639
- * @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
3640
- */
3641
- declare function playableSpecializationMedia(specializationId: number): Resource<PlayableSpecializationMediaResponse>;
3642
- //#endregion
3643
- //#region src/power-type/types.d.ts
3644
- /**
3645
- * The response for a power type index.
3646
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3647
- */
3648
- interface PowerTypeIndexResponse extends ResponseBase {
3649
- power_types: Array<NameIdKey>;
3650
- }
3651
- /**
3652
- * The response for a power type.
3653
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3654
- */
3655
- interface PowerTypeResponse extends NameId, ResponseBase {}
3656
- //#endregion
3657
- //#region src/power-type/power-type.d.ts
3658
- /**
3659
- * Get a power type by ID.
3660
- * @param powerTypeId The power type ID.
3661
- * @returns The power type. See {@link PowerTypeResponse}.
3662
- */
3663
- declare function powerType(powerTypeId: number): Resource<PowerTypeResponse>;
3664
- /**
3665
- * Get a power type index.
3666
- * @returns The power type index. See {@link PowerTypeIndexResponse}.
3667
- */
3668
- declare function powerTypeIndex(): Resource<PowerTypeIndexResponse>;
3669
- //#endregion
3670
- //#region src/profession/types.d.ts
3671
- /**
3672
- * The response for a profession index.
3673
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3674
- */
3675
- interface ProfessionIndexResponse extends ResponseBase {
3676
- professions: Array<NameIdKey>;
3677
- }
3678
- /**
3679
- * The response for a profession media.
3680
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3681
- */
3682
- interface ProfessionMediaResponse extends ResponseBase {
3683
- assets: Array<MediaAsset>;
3684
- id: number;
3685
- }
3686
- /**
3687
- * The response for a profession.
3688
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3689
- */
3690
- interface ProfessionResponse extends NameId, ResponseBase {
3691
- description: string;
3692
- media: Media$4;
3693
- skill_tiers: Array<NameIdKey>;
3694
- type: Type;
3695
- }
3696
- /**
3697
- * The response for a profession skill tier.
3698
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3699
- */
3700
- interface ProfessionSkillTierResponse extends NameId, ResponseBase {
3701
- categories: Array<Category>;
3702
- maximum_skill_level: number;
3703
- minimum_skill_level: number;
3704
- }
3705
- /**
3706
- * The response for a recipe media.
3707
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3708
- */
3709
- interface RecipeMediaResponse extends ResponseBase {
3710
- assets: Array<MediaAsset>;
3711
- id: number;
3712
- }
3713
- /**
3714
- * The response for a recipe.
3715
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3716
- */
3717
- interface RecipeResponse extends NameId, ResponseBase {
3718
- alliance_crafted_item?: NameIdKey;
3719
- crafted_item?: NameIdKey;
3720
- crafted_quantity?: CraftedQuantity;
3721
- description?: string;
3722
- horde_crafted_item?: NameIdKey;
3723
- media: Media$4;
3724
- modified_crafting_slots?: Array<ModifiedCraftSlot>;
3725
- rank?: number;
3726
- reagents?: Array<Reagent>;
3727
- }
3728
- interface Category {
3729
- name: string;
3730
- recipes: Array<NullishNameIdKey>;
3731
- }
3732
- interface CraftedQuantity {
3733
- maximum?: number;
3734
- minimum?: number;
3735
- value?: number;
3736
- }
3737
- interface Media$4 extends KeyBase {
3738
- id: number;
3739
- }
3740
- interface ModifiedCraftSlot {
3741
- display_order: number;
3742
- slot_type: KeyBase & {
3743
- id: number;
3744
- name?: string;
3745
- };
3746
- }
3747
- interface Reagent {
3748
- quantity: number;
3749
- reagent: NameIdKey;
3750
- }
3751
- interface Type {
3752
- name: string;
3753
- type: string;
3754
- }
3755
- //#endregion
3756
- //#region src/profession/profession.d.ts
3757
- /**
3758
- * Get a profession by ID.
3759
- * @param professionId The profession ID.
3760
- * @returns The profession. See {@link ProfessionResponse}.
3761
- */
3762
- declare function profession(professionId: number): Resource<ProfessionResponse>;
3763
- /**
3764
- * Get a profession index.
3765
- * @returns The profession index. See {@link ProfessionIndexResponse}.
3766
- */
3767
- declare function professionIndex(): Resource<ProfessionIndexResponse>;
3768
- /**
3769
- * Get profession media by ID.
3770
- * @param professionId The profession ID.
3771
- * @returns The profession media. See {@link ProfessionMediaResponse}.
3772
- */
3773
- declare function professionMedia(professionId: number): Resource<ProfessionMediaResponse>;
3774
- /**
3775
- * Get a profession's skill tier by ID.
3776
- * @param professionId The profession ID.
3777
- * @param skillTierId The skill tier ID.
3778
- * @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
3779
- */
3780
- declare function professionSkillTier(professionId: number, skillTierId: number): Resource<ProfessionSkillTierResponse>;
3781
- /**
3782
- * Get a recipe by ID.
3783
- * @param recipeId The recipe ID.
3784
- * @returns The recipe. See {@link RecipeResponse}.
3785
- */
3786
- declare function recipe(recipeId: number): Resource<RecipeResponse>;
3787
- /**
3788
- * Get recipe media by ID.
3789
- * @param recipeId The recipe ID.
3790
- * @returns The recipe media. See {@link RecipeMediaResponse}.
3791
- */
3792
- declare function recipeMedia(recipeId: number): Resource<RecipeMediaResponse>;
3793
- //#endregion
3794
- //#region src/pvp-season/types.d.ts
3795
- /**
3796
- * The response for a PvP leaderboard index.
3797
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3798
- */
3799
- interface PvpLeaderboardIndexResponse extends ResponseBase {
3800
- leaderboards: Array<KeyBase & {
3801
- id?: number;
3802
- name: string;
3803
- }>;
3804
- season: Season;
3805
- }
3806
- /**
3807
- * The response for a PvP leaderboard.
3808
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3809
- */
3810
- interface PvpLeaderboardResponse extends ResponseBase {
3811
- bracket: Bracket$1;
3812
- entries: Array<Entry>;
3813
- name: string;
3814
- season: Season;
3815
- }
3816
- /**
3817
- * The response for PvP rewards index.
3818
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3819
- */
3820
- interface PvpRewardsIndexResponse extends ResponseBase {
3821
- rewards: Array<Reward>;
3822
- season: Season;
3823
- }
3824
- /**
3825
- * The response for a PvP season index.
3826
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3827
- */
3828
- interface PvpSeasonIndexResponse extends ResponseBase {
3829
- current_season: Season;
3830
- seasons: Array<Season>;
3831
- }
3832
- /**
3833
- * The response for a PvP season.
3834
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3835
- */
3836
- interface PvpSeasonResponse extends ResponseBase {
3837
- id: number;
3838
- leaderboards: Href;
3839
- rewards: Href;
3840
- season_end_timestamp?: number;
3841
- season_name?: null | string;
3842
- season_start_timestamp: number;
3843
- }
3844
- interface Bracket$1 {
3845
- id: number;
3846
- type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'BLITZ' | 'SHUFFLE';
3847
- }
3848
- interface Character$1 extends NameId {
3849
- realm: Realm$1;
3850
- }
3851
- interface Entry {
3852
- character: Character$1;
3853
- faction: {
3854
- type: Factions;
3855
- };
3856
- rank: number;
3857
- rating: number;
3858
- season_match_statistics: SeasonMatchStatistics;
3859
- tier: Season;
3860
- }
3861
- interface Realm$1 extends KeyBase {
3862
- id: number;
3863
- slug: string;
3864
- }
3865
- interface Reward {
3866
- achievement: NameIdKey;
3867
- bracket: Bracket$1;
3868
- faction?: Faction;
3869
- rating_cutoff: number;
3870
- specialization?: NameIdKey;
3871
- }
3872
- interface Season extends KeyBase {
3873
- id: number;
3874
- }
3875
- interface SeasonMatchStatistics {
3876
- lost: number;
3877
- played: number;
3878
- won: number;
3879
- }
3880
- //#endregion
3881
- //#region src/pvp-season/pvp-season.d.ts
3882
- /**
3883
- * Get a PvP leaderboard by PvP season ID and bracket.
3884
- * @param pvpSeasonId The PvP season ID.
3885
- * @param bracket The PvP bracket.
3886
- * @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
3887
- */
3888
- declare function pvpLeaderboard(pvpSeasonId: number, bracket: string): Resource<PvpLeaderboardResponse>;
3889
- /**
3890
- * Get a PvP leaderboard index by PvP season ID.
3891
- * @param pvpSeasonId The PvP season ID.
3892
- * @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
3893
- */
3894
- declare function pvpLeaderboardIndex(pvpSeasonId: number): Resource<PvpLeaderboardIndexResponse>;
3895
- /**
3896
- * Get a PvP reward index by PvP season ID.
3897
- * @param pvpSeasonId The PvP season ID.
3898
- * @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
3899
- */
3900
- declare function pvpRewardsIndex(pvpSeasonId: number): Resource<PvpRewardsIndexResponse>;
3901
- /**
3902
- * Get a PvP season by ID.
3903
- * @param pvpSeasonId The PvP season ID.
3904
- * @returns The PvP season. See {@link PvpSeasonResponse}.
3905
- */
3906
- declare function pvpSeason(pvpSeasonId: number): Resource<PvpSeasonResponse>;
3907
- /**
3908
- * Get a PvP season index.
3909
- * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
3910
- */
3911
- declare function pvpSeasonIndex(): Resource<PvpSeasonIndexResponse>;
3912
- //#endregion
3913
- //#region src/pvp-tier/types.d.ts
3914
- /**
3915
- * The response for a PvP tier index.
3916
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3917
- */
3918
- interface PvpTierIndexResponse extends ResponseBase {
3919
- tiers: Array<NullishNameIdKey>;
3920
- }
3921
- /**
3922
- * The response for a PvP tier media.
3923
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3924
- */
3925
- interface PvpTierMediaResponse extends ResponseBase {
3926
- assets: Array<MediaAsset>;
3927
- id: number;
3928
- }
3929
- /**
3930
- * The response for a PvP tier.
3931
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3932
- */
3933
- interface PvpTierResponse extends ResponseBase {
3934
- bracket: Bracket;
3935
- id: number;
3936
- max_rating: number;
3937
- media: Media$3;
3938
- min_rating: number;
3939
- name: null | string;
3940
- rating_type: number;
3941
- }
3942
- interface Bracket {
3943
- id: number;
3944
- type: string;
3945
- }
3946
- interface Media$3 extends KeyBase {
3947
- id: number;
3948
- }
3949
- //#endregion
3950
- //#region src/pvp-tier/pvp-tier.d.ts
3951
- /**
3952
- * Get a PvP tier by ID.
3953
- * @param pvpTierId The PvP tier ID.
3954
- * @returns The PvP tier. See {@link PvpTierResponse}.
3955
- */
3956
- declare function pvpTier(pvpTierId: number): Resource<PvpTierResponse>;
3957
- /**
3958
- * Get a PvP tier index.
3959
- * @returns The PvP tier index. See {@link PvpTierIndexResponse}.
3960
- */
3961
- declare function pvpTierIndex(): Resource<PvpTierIndexResponse>;
3962
- /**
3963
- * Get PvP tier media by ID.
3964
- * @param pvpTierId The PvP tier ID.
3965
- * @returns The PvP tier media. See {@link PvpTierMediaResponse}.
3966
- */
3967
- declare function pvpTierMedia(pvpTierId: number): Resource<PvpTierMediaResponse>;
3968
- //#endregion
3969
- //#region src/quest/types.d.ts
3970
- /**
3971
- * The response for a quest area index.
3972
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3973
- */
3974
- interface QuestAreaIndexResponse extends ResponseBase {
3975
- areas: Array<NullishNameIdKey>;
3976
- }
3977
- /**
3978
- * The response for a quest area.
3979
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3980
- */
3981
- interface QuestAreaResponse extends ResponseBase {
3982
- area: string;
3983
- id: number;
3984
- quests: Array<NameIdKey>;
3985
- }
3986
- /**
3987
- * The response for a quest category index.
3988
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3989
- */
3990
- interface QuestCategoryIndexResponse extends ResponseBase {
3991
- categories: Array<NameIdKey>;
3992
- }
3993
- /**
3994
- * The response for a quest category.
3995
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
3996
- */
3997
- interface QuestCategoryResponse extends ResponseBase {
3998
- category: string;
3999
- id: number;
4000
- quests: Array<NameIdKey>;
4001
- }
4002
- /**
4003
- * The response for a quest index.
4004
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4005
- */
4006
- interface QuestIndexResponse extends ResponseBase {
4007
- areas: Href;
4008
- categories: Href;
4009
- types: Href;
4010
- }
4011
- /**
4012
- * The response for a quest.
4013
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4014
- */
4015
- interface QuestResponse extends ResponseBase {
4016
- area?: NameIdKey;
4017
- category: NameIdKey;
4018
- description: string;
4019
- id: number;
4020
- requirements: Requirements;
4021
- rewards: Rewards;
4022
- title: string;
4023
- }
4024
- /**
4025
- * The response for a quest type index.
4026
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4027
- */
4028
- interface QuestTypeIndexResponse extends ResponseBase {
4029
- types: Array<NameIdKey>;
4030
- }
4031
- /**
4032
- * The response for a quest type.
4033
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4034
- */
4035
- interface QuestTypeResponse extends ResponseBase {
4036
- id: number;
4037
- quests: Array<NameIdKey>;
4038
- type: string;
4039
- }
4040
- interface Money {
4041
- units: Units;
4042
- value: number;
4043
- }
4044
- interface Reputation {
4045
- reward: NameIdKey;
4046
- value: number;
4047
- }
4048
- interface ReputationRequirement {
4049
- faction: NameIdKey;
4050
- min_reputation: number;
4051
- }
4052
- interface Requirements {
4053
- faction: Faction;
4054
- max_character_level: number;
4055
- min_character_level: number;
4056
- reputations: Array<ReputationRequirement>;
4057
- }
4058
- interface Rewards {
4059
- experience: number;
4060
- money: Money;
4061
- reputations: Array<Reputation>;
4062
- }
4063
- interface Units {
4064
- copper: number;
4065
- gold: number;
4066
- silver: number;
4067
- }
4068
- //#endregion
4069
- //#region src/quest/quest.d.ts
4070
- /**
4071
- * Get a quest by ID.
4072
- * @param questId The quest ID.
4073
- * @returns The quest. See {@link QuestResponse}.
4074
- */
4075
- declare function quest(questId: number): Resource<QuestResponse>;
4076
- /**
4077
- * Get a quest area by ID.
4078
- * @param questAreaId The quest area ID.
4079
- * @returns The quest area. See {@link QuestAreaResponse}.
4080
- */
4081
- declare function questArea(questAreaId: number): Resource<QuestAreaResponse>;
4082
- /**
4083
- * Get a quest area index.
4084
- * @returns The quest area index. See {@link QuestAreaIndexResponse}.
4085
- */
4086
- declare function questAreaIndex(): Resource<QuestAreaIndexResponse>;
4087
- /**
4088
- * Get a quest category by ID.
4089
- * @param questCategoryId The quest category ID.
4090
- * @returns The quest category. See {@link QuestCategoryResponse}.
4091
- */
4092
- declare function questCategory(questCategoryId: number): Resource<QuestCategoryResponse>;
4093
- /**
4094
- * Get a quest category index.
4095
- * @returns The quest category index. See {@link QuestCategoryIndexResponse}.
4096
- */
4097
- declare function questCategoryIndex(): Resource<QuestCategoryIndexResponse>;
4098
- /**
4099
- * Get a quest index.
4100
- * @returns The quest index. See {@link QuestIndexResponse}.
4101
- */
4102
- declare function questIndex(): Resource<QuestIndexResponse>;
4103
- /**
4104
- * Get a quest type by ID.
4105
- * @param questTypeId The quest type ID.
4106
- * @returns The quest type. See {@link QuestTypeResponse}.
4107
- */
4108
- declare function questType(questTypeId: number): Resource<QuestTypeResponse>;
4109
- /**
4110
- * Get a quest type index.
4111
- * @returns The quest type index. See {@link QuestTypeIndexResponse}.
4112
- */
4113
- declare function questTypeIndex(): Resource<QuestTypeIndexResponse>;
4114
- //#endregion
4115
- //#region src/realm/realm.d.ts
4116
- /**
4117
- * Get a realm by slug.
4118
- * @param realmSlug The realm slug.
4119
- * @returns The realm. See {@link RealmResponse}.
4120
- */
4121
- declare function realm(realmSlug: string): Resource<RealmResponse>;
4122
- /**
4123
- * Get a realm index.
4124
- * @returns The realm index. See {@link RealmIndexResponse}.
4125
- */
4126
- declare function realmIndex(): Resource<RealmIndexResponse>;
4127
- /**
4128
- * Search for realms.
4129
- * @param options The search parameters. See {@link RealmSearchParameters}.
4130
- * @returns The search results. See {@link RealmSearchResponse}.
4131
- */
4132
- declare function realmSearch(options: RealmSearchParameters): Resource<RealmSearchResponse, RealmSearchParameters>;
4133
- //#endregion
4134
- //#region src/region/types.d.ts
4135
- /**
4136
- * The response for a region index.
4137
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4138
- */
4139
- interface RegionIndexResponse extends ResponseBase {
4140
- regions: Array<Href>;
4141
- }
4142
- /**
4143
- * The response for a region.
4144
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4145
- */
4146
- interface RegionResponse extends NameId, ResponseBase {
4147
- patch_string: string;
4148
- tag: string;
4149
- }
4150
- //#endregion
4151
- //#region src/region/region.d.ts
4152
- /**
4153
- * Get a region by ID.
4154
- * @param regionId The region ID.
4155
- * @returns The region. See {@link RegionResponse}.
4156
- */
4157
- declare function region(regionId: number): Resource<RegionResponse>;
4158
- /**
4159
- * Get a region index.
4160
- * @returns The region index. See {@link RegionIndexResponse}.
4161
- */
4162
- declare function regionIndex(): Resource<RegionIndexResponse>;
4163
- //#endregion
4164
- //#region src/reputations/types.d.ts
4165
- /**
4166
- * The response for a reputation faction index.
4167
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4168
- */
4169
- interface ReputationFactionIndexResponse extends ResponseBase {
4170
- factions: Array<NullishNameIdKey>;
4171
- root_factions: Array<NameIdKey>;
4172
- }
4173
- /**
4174
- * The response for a reputation faction.
4175
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4176
- */
4177
- interface ReputationFactionResponse extends ResponseBase {
4178
- can_paragon?: boolean;
4179
- description?: string;
4180
- factions?: Array<NameIdKey>;
4181
- header_shows_bar?: boolean;
4182
- id: number;
4183
- is_header?: boolean;
4184
- is_renown?: boolean;
4185
- name: string;
4186
- player_faction?: Faction;
4187
- renown_tiers?: Array<RenownTier>;
4188
- reputation_tiers?: ReputationTier;
4189
- }
4190
- /**
4191
- * The response for a reputation tier index.
4192
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4193
- */
4194
- interface ReputationTiersIndexResponse extends ResponseBase {
4195
- reputation_tiers: Array<ReputationTier>;
4196
- }
4197
- /**
4198
- * The response for a reputation tier.
4199
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4200
- */
4201
- interface ReputationTiersResponse extends ResponseBase {
4202
- faction?: NameIdKey;
4203
- id: number;
4204
- tiers: Array<Tier>;
4205
- }
4206
- interface RenownTier {
4207
- level: number;
4208
- name: string;
4209
- rewards: Array<NameIdKey>;
4210
- }
4211
- interface ReputationTier extends KeyBase {
4212
- id: number;
4213
- name?: string;
4214
- }
4215
- interface Tier {
4216
- id: number;
4217
- max_value: number;
4218
- min_value: number;
4219
- name: string;
4220
- }
4221
- //#endregion
4222
- //#region src/reputations/reputations.d.ts
4223
- /**
4224
- * Get a reputation faction by ID.
4225
- * @param reputationFactionId The reputation faction ID.
4226
- * @returns The reputation faction. See {@link ReputationFactionResponse}.
4227
- */
4228
- declare function reputationFaction(reputationFactionId: number): Resource<ReputationFactionResponse>;
4229
- /**
4230
- * Get a reputation faction index.
4231
- * @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
4232
- */
4233
- declare function reputationFactionIndex(): Resource<ReputationFactionIndexResponse>;
4234
- /**
4235
- * Get a reputation tier by ID.
4236
- * @param reputationTiersId The reputation tier ID.
4237
- * @returns The reputation tier. See {@link ReputationTiersResponse}.
4238
- */
4239
- declare function reputationTiers(reputationTiersId: number): Resource<ReputationTiersResponse>;
4240
- /**
4241
- * Get a reputation tier index.
4242
- * @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
4243
- */
4244
- declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
4245
- //#endregion
4246
- //#region src/spell/types.d.ts
4247
- /**
4248
- * The response for a spell media.
4249
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4250
- */
4251
- interface SpellMediaResponse extends ResponseBase {
4252
- assets: Array<MediaAsset>;
4253
- id: number;
4254
- }
4255
- /**
4256
- * The response for a spell.
4257
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4258
- */
4259
- interface SpellResponse extends NameId, ResponseBase {
4260
- description: null | string;
4261
- media: Media$2;
4262
- }
4263
- /**
4264
- * The search parameters for spells.
4265
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4266
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
4267
- */
4268
- interface SpellSearchParameters extends BaseSearchParameters {
4269
- locale: Locales;
4270
- name: string;
4271
- }
4272
- /**
4273
- * The response for a spell search.
4274
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4275
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
4276
- */
4277
- interface SpellSearchResponse extends SearchResponseWithoutResults {
4278
- results: Array<SpellSearchResponseItem>;
4279
- }
4280
- interface Media$2 extends KeyBase {
4281
- id: number;
4282
- }
4283
- interface SpellSearchResponseItem extends KeyBase {
4284
- data: {
4285
- id: number;
4286
- media: {
4287
- id: number;
4288
- };
4289
- name: Record<Locales, string>;
4290
- };
4291
- }
4292
- //#endregion
4293
- //#region src/spell/spell.d.ts
4294
- /**
4295
- * Get a spell by ID.
4296
- * @param spellId The spell ID.
4297
- * @returns The spell. See {@link SpellResponse}.
4298
- */
4299
- declare function spell(spellId: number): Resource<SpellResponse>;
4300
- /**
4301
- * Get spell media by ID.
4302
- * @param spellId The spell ID.
4303
- * @returns The spell media. See {@link SpellMediaResponse}.
4304
- */
4305
- declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
4306
- /**
4307
- * Get a spell search.
4308
- * @param options The spell search options. See {@link SpellSearchParameters}.
4309
- * @returns The spell search. See {@link SpellSearchResponse}.
4310
- */
4311
- declare function spellSearch(options: SpellSearchParameters): Resource<SpellSearchResponse, Omit<SpellSearchParameters, 'locale' | 'name'>>;
4312
- //#endregion
4313
- //#region src/talent/types.d.ts
4314
- /**
4315
- * The response for a pvp talent index.
4316
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4317
- */
4318
- interface PvpTalentIndexResponse extends ResponseBase {
4319
- pvp_talents: Array<NameIdKey>;
4320
- }
4321
- /**
4322
- * The response for a pvp talent.
4323
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4324
- */
4325
- interface PvpTalentResponse extends ResponseBase {
4326
- compatible_slots: Array<number>;
4327
- description: string;
4328
- id: number;
4329
- overrides_spell?: NameIdKey;
4330
- playable_specialization: NameIdKey;
4331
- spell: NameIdKey;
4332
- unlock_player_level: number;
4333
- }
4334
- /**
4335
- * The response for a talent index.
4336
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4337
- */
4338
- interface TalentIndexResponse extends ResponseBase {
4339
- talents: Array<NullishNameIdKey>;
4340
- }
4341
- /**
4342
- * The response for a talent.
4343
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4344
- */
4345
- interface TalentResponse extends ResponseBase {
4346
- id: number;
4347
- overrides_spell?: NameIdKey;
4348
- playable_class?: KeyBase & {
4349
- id: number;
4350
- name?: string;
4351
- };
4352
- playable_specialization?: NameIdKey;
4353
- rank_descriptions?: Array<RankDescription>;
4354
- spell?: NameIdKey;
4355
- }
4356
- /**
4357
- * The response for a talent tree index.
4358
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4359
- */
4360
- interface TalentTreeIndexResponse extends ResponseBase {
4361
- class_talent_trees: Array<TalentTree$1>;
4362
- hero_talent_trees: Array<NameIdKey>;
4363
- spec_talent_trees: Array<TalentTree$1>;
4364
- }
4365
- /**
4366
- * The response for a talent tree nodes.
4367
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4368
- */
4369
- interface TalentTreeNodesResponse extends ResponseBase {
4370
- id: number;
4371
- spec_talent_trees: Array<SpecTalentTree>;
4372
- talent_nodes: Array<TalentNode>;
4373
- }
4374
- /**
4375
- * The response for a talent tree.
4376
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4377
- */
4378
- interface TalentTreeResponse extends NameId, ResponseBase {
4379
- class_talent_nodes: Array<ClassTalentNode>;
4380
- hero_talent_trees: Array<HeroTalentTree>;
4381
- media: KeyBase;
4382
- playable_class: NameIdKey;
4383
- playable_specialization: NameIdKey;
4384
- restriction_lines: Array<RestrictionLine>;
4385
- spec_talent_nodes: Array<SpecTalentNode>;
4386
- }
4387
- interface ChoiceOfTooltip {
4388
- spell_tooltip: PurpleSpellTooltip;
4389
- talent: NameIdKey;
4390
- }
4391
- interface ClassTalentNode {
4392
- display_col: number;
4393
- display_row: number;
4394
- id: number;
4395
- locked_by?: Array<number>;
4396
- node_type: NodeType;
4397
- ranks: Array<ClassTalentNodeRank>;
4398
- raw_position_x: number;
4399
- raw_position_y: number;
4400
- unlocks?: Array<number>;
4401
- }
4402
- interface ClassTalentNodeRank {
4403
- choice_of_tooltips?: Array<Tooltip>;
4404
- default_points?: number;
4405
- rank: number;
4406
- tooltip?: Tooltip;
4407
- }
4408
- interface HeroTalentTree extends NameId {
4409
- hero_talent_nodes: Array<HeroTalentTreeNode>;
4410
- media: KeyBase & {
4411
- id: number;
4412
- };
4413
- playable_class: NameIdKey;
4414
- playable_specializations: Array<NameIdKey>;
4415
- }
4416
- interface HeroTalentTreeNode {
4417
- display_col: number;
4418
- display_row: number;
4419
- id: number;
4420
- locked_by?: Array<number>;
4421
- node_type: {
4422
- id: number;
4423
- type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
4424
- };
4425
- ranks: Array<Rank>;
4426
- raw_position_x: number;
4427
- raw_position_y: number;
4428
- unlocks?: Array<number>;
4429
- }
4430
- interface NodeType {
4431
- id: number;
4432
- type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
4433
- }
4434
- interface PurpleSpellTooltip {
4435
- cast_time: string;
4436
- description: string;
4437
- spell: NameIdKey;
4438
- }
4439
- interface Rank {
4440
- choice_of_tooltips?: Array<Tooltip>;
4441
- default_points?: number;
4442
- rank: number;
4443
- tooltip?: Tooltip;
4444
- }
4445
- interface RankDescription {
4446
- description: null | string;
4447
- rank: number;
4448
- }
4449
- interface RestrictionLine {
4450
- is_for_class: boolean;
4451
- required_points: number;
4452
- restricted_row: number;
4453
- }
4454
- interface SpecTalentNode {
4455
- display_col: number;
4456
- display_row: number;
4457
- id: number;
4458
- locked_by?: Array<number>;
4459
- node_type: NodeType;
4460
- ranks: Array<SpecTalentNodeRank>;
4461
- raw_position_x: number;
4462
- raw_position_y: number;
4463
- unlocks?: Array<number>;
4464
- }
4465
- interface SpecTalentNodeRank {
4466
- choice_of_tooltips?: Array<ChoiceOfTooltip>;
4467
- rank: number;
4468
- tooltip?: Tooltip;
4469
- }
4470
- interface SpecTalentTree extends KeyBase {
4471
- name: string;
4472
- }
4473
- interface TalentNode {
4474
- display_col: number;
4475
- display_row: number;
4476
- id: number;
4477
- locked_by?: Array<number>;
4478
- node_type: NodeType;
4479
- ranks: Array<Rank>;
4480
- raw_position_x: number;
4481
- raw_position_y: number;
4482
- unlocks?: Array<number>;
4483
- }
4484
- interface TalentTree$1 extends KeyBase {
4485
- name: string;
4486
- }
4487
- interface Tooltip {
4488
- spell_tooltip: TooltipSpellTooltip;
4489
- talent: NameIdKey;
4490
- }
4491
- interface TooltipSpellTooltip {
4492
- cast_time: string;
4493
- cooldown?: string;
4494
- description: string;
4495
- power_cost?: string;
4496
- range?: string;
4497
- spell: NameIdKey;
4498
- }
4499
- //#endregion
4500
- //#region src/talent/talent.d.ts
4501
- /**
4502
- * Get a PvP talent by ID.
4503
- * @param pvpTalentId The PvP talent ID.
4504
- * @returns The PvP talent. See {@link PvpTalentResponse}.
4505
- */
4506
- declare function pvpTalent(pvpTalentId: number): Resource<PvpTalentResponse>;
4507
- /**
4508
- * Get a PvP talent index.
4509
- * @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
4510
- */
4511
- declare function pvpTalentIndex(): Resource<PvpTalentIndexResponse>;
4512
- /**
4513
- * Get a talent by ID.
4514
- * @param talentId The talent ID.
4515
- * @returns The talent. See {@link TalentResponse}.
4516
- */
4517
- declare function talent(talentId: number): Resource<TalentResponse>;
4518
- /**
4519
- * Get a talent index.
4520
- * @returns The talent index. See {@link TalentIndexResponse}.
4521
- */
4522
- declare function talentIndex(): Resource<TalentIndexResponse>;
4523
- /**
4524
- * Get a talent tree by ID.
4525
- * @param talentTreeId The talent tree ID.
4526
- * @param specId The playable specialization ID.
4527
- * @returns The talent tree. See {@link TalentTreeResponse}.
4528
- */
4529
- declare function talentTree(talentTreeId: number, specId: number): Resource<TalentTreeResponse>;
4530
- /**
4531
- * Get a talent tree index.
4532
- * @returns The talent tree index. See {@link TalentTreeIndexResponse}.
4533
- */
4534
- declare function talentTreeIndex(): Resource<TalentTreeIndexResponse>;
4535
- /**
4536
- * Get talent tree nodes by talent tree ID.
4537
- * @param talentTreeId The talent tree ID.
4538
- * @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
4539
- */
4540
- declare function talentTreeNodes(talentTreeId: number): Resource<TalentTreeNodesResponse>;
4541
- //#endregion
4542
- //#region src/tech-talent/types.d.ts
4543
- /**
4544
- * The response for a tech talent index.
4545
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4546
- */
4547
- interface TechTalentIndexResponse extends ResponseBase {
4548
- talents: Array<NameIdKey>;
4549
- }
4550
- /**
4551
- * The response for a tech talent media.
4552
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4553
- */
4554
- interface TechTalentMediaResponse extends ResponseBase {
4555
- assets: Array<MediaAsset>;
4556
- }
4557
- /**
4558
- * The response for a tech talent.
4559
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4560
- */
4561
- interface TechTalentResponse extends NameId, ResponseBase {
4562
- description?: string;
4563
- display_order: number;
4564
- media: Media$1;
4565
- prerequisite_talent?: NameIdKey;
4566
- socket_type?: {
4567
- name: string;
4568
- type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
4569
- };
4570
- spell_tooltip?: SpellTooltip;
4571
- talent_tree: KeyBase & {
4572
- id: number;
4573
- name?: string;
4574
- };
4575
- tier: number;
4576
- }
4577
- /**
4578
- * The response for a tech talent tree index.
4579
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4580
- */
4581
- interface TechTalentTreeIndexResponse extends ResponseBase {
4582
- talent_trees: Array<TalentTree>;
4583
- }
4584
- /**
4585
- * The response for a tech talent tree.
4586
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4587
- */
4588
- interface TechTalentTreeResponse extends ResponseBase {
4589
- id: number;
4590
- max_tiers: number;
4591
- playable_class?: NameIdKey;
4592
- talents: Array<NameIdKey>;
4593
- }
4594
- interface Media$1 extends KeyBase {
4595
- id: number;
4596
- }
4597
- interface SpellTooltip {
4598
- cast_time: string;
4599
- cooldown?: string;
4600
- description: null | string;
4601
- power_cost?: null | string;
4602
- range?: string;
4603
- spell: NullishNameIdKey;
4604
- }
4605
- interface TalentTree extends KeyBase {
4606
- id: number;
4607
- name?: string;
4608
- }
4609
- //#endregion
4610
- //#region src/tech-talent/tech-talent.d.ts
4611
- /**
4612
- * Get a tech talent by ID.
4613
- * @param techTalentId The tech talent ID.
4614
- * @returns The tech talent. See {@link TechTalentResponse}.
4615
- */
4616
- declare function techTalent(techTalentId: number): Resource<TechTalentResponse>;
4617
- /**
4618
- * Get a tech talent index.
4619
- * @returns The tech talent index. See {@link TechTalentIndexResponse}.
4620
- */
4621
- declare function techTalentIndex(): Resource<TechTalentIndexResponse>;
4622
- /**
4623
- * Get tech talent media by ID.
4624
- * @param techTalentId The tech talent ID.
4625
- * @returns The tech talent media. See {@link TechTalentMediaResponse}.
4626
- */
4627
- declare function techTalentMedia(techTalentId: number): Resource<TechTalentMediaResponse>;
4628
- /**
4629
- * Get a tech talent tree by ID.
4630
- * @param techTalentTreeId The tech talent tree ID.
4631
- * @returns The tech talent tree. See {@link TechTalentTreeResponse}.
4632
- */
4633
- declare function techTalentTree(techTalentTreeId: number): Resource<TechTalentTreeResponse>;
4634
- /**
4635
- * Get a tech talent tree index.
4636
- * @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
4637
- */
4638
- declare function techTalentTreeIndex(): Resource<TechTalentTreeIndexResponse>;
4639
- //#endregion
4640
- //#region src/title/types.d.ts
4641
- /**
4642
- * The response for a title index.
4643
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4644
- */
4645
- interface TitleIndexResponse extends ResponseBase {
4646
- titles: Array<NameIdKey>;
4647
- }
4648
- /**
4649
- * The response for a title.
4650
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4651
- */
4652
- interface TitleResponse extends NameId, ResponseBase {
4653
- gender_name: GenderName;
4654
- source?: TitleSource;
4655
- }
4656
- interface TitleSource {
4657
- achievements?: Array<NameIdKey>;
4658
- quests?: Array<NameIdKey>;
4659
- type: {
4660
- name: string;
4661
- type: 'ACHIEVEMENT';
4662
- } | {
4663
- name: string;
4664
- type: 'QUEST';
4665
- };
4666
- }
4667
- //#endregion
4668
- //#region src/title/title.d.ts
4669
- /**
4670
- * Get a title by ID.
4671
- * @param titleId The title ID.
4672
- * @returns The title. See {@link TitleResponse}.
4673
- */
4674
- declare function title(titleId: number): Resource<TitleResponse>;
4675
- /**
4676
- * Get a title index.
4677
- * @returns The title index. See {@link TitleIndexResponse}.
4678
- */
4679
- declare function titleIndex(): Resource<TitleIndexResponse>;
4680
- //#endregion
4681
- //#region src/toy/types.d.ts
4682
- /**
4683
- * The response for a toy index.
4684
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4685
- */
4686
- interface ToyIndexResponse extends ResponseBase {
4687
- toys: Array<NameIdKey>;
4688
- }
4689
- /**
4690
- * The response for a toy.
4691
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4692
- */
4693
- interface ToyResponse extends ResponseBase {
4694
- id: number;
4695
- item: NameIdKey;
4696
- media: Media;
4697
- should_exclude_if_uncollected?: boolean;
4698
- source: Source;
4699
- source_description?: string;
4700
- }
4701
- interface Media extends KeyBase {
4702
- id: number;
4703
- }
4704
- interface Source {
4705
- name: string;
4706
- type: string;
4707
- }
4708
- //#endregion
4709
- //#region src/toy/toy.d.ts
4710
- /**
4711
- * Get a toy by ID.
4712
- * @param toyId The toy ID.
4713
- * @returns The toy. See {@link ToyResponse}.
4714
- */
4715
- declare function toy(toyId: number): Resource<ToyResponse>;
4716
- /**
4717
- * Get a toy index.
4718
- * @returns The toy index. See {@link ToyIndexResponse}.
4719
- */
4720
- declare function toyIndex(): Resource<ToyIndexResponse>;
4721
- //#endregion
4722
- //#region src/wow-token/types.d.ts
4723
- /**
4724
- * The response for a WoW token.
4725
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
4726
- */
4727
- interface WowTokenResponse extends ResponseBase {
4728
- last_updated_timestamp: number;
4729
- price: number;
4730
- }
4731
- //#endregion
4732
- //#region src/wow-token/wow-token.d.ts
4733
- /**
4734
- * Get the current WoW token price.
4735
- * @returns The WoW token price. See {@link WowTokenResponse}.
4736
- */
4737
- declare function wowToken(): Resource<WowTokenResponse>;
4738
- //#endregion
4739
58
  //#region src/index.d.ts
4740
59
  /**
4741
60
  * The Blizzard API for World of Warcraft.
@@ -4817,6 +136,18 @@ declare const wow: {
4817
136
  guildCrestEmblem: typeof guildCrestEmblem;
4818
137
  heirloom: typeof heirloom;
4819
138
  heirloomIndex: typeof heirloomIndex;
139
+ decor: typeof decor;
140
+ decorIndex: typeof decorIndex;
141
+ decorSearch: typeof decorSearch;
142
+ fixture: typeof fixture;
143
+ fixtureHook: typeof fixtureHook;
144
+ fixtureHookIndex: typeof fixtureHookIndex;
145
+ fixtureHookSearch: typeof fixtureHookSearch;
146
+ fixtureIndex: typeof fixtureIndex;
147
+ fixtureSearch: typeof fixtureSearch;
148
+ room: typeof room;
149
+ roomIndex: typeof roomIndex;
150
+ roomSearch: typeof roomSearch;
4820
151
  item: typeof item;
4821
152
  itemClass: typeof itemClass;
4822
153
  itemClassIndex: typeof itemClassIndex;
@@ -4924,5 +255,5 @@ declare const wow: {
4924
255
  wowToken: typeof wowToken;
4925
256
  };
4926
257
  //#endregion
4927
- export { AccountCollectionsIndexResponse, AccountHeirloomsCollectionSummaryResponse, AccountMountsCollectionSummaryResponse, AccountPetsCollectionSummaryResponse, AccountProfileSummaryResponse, AccountToysCollectionSummaryResponse, AccountTransmogsCollectionSummaryResponse, AchievementCategoryIndexResponse, AchievementCategoryResponse, AchievementIndexResponse, AchievementMediaResponse, AchievementResponse, AuctionHouseCommoditiesResponse, AuctionHouseResponse, AzeriteEssenceIndexResponse, AzeriteEssenceMediaResponse, AzeriteEssenceResponse, AzeriteEssenceSearchParameters, AzeriteEssenceSearchResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterAppearanceResponse, CharacterCollectionsIndexResponse, CharacterCompletedQuestsResponse, CharacterDungeonsResponse, CharacterEncountersSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHeirloomsCollectionSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse, CharacterMountsCollectionSummaryResponse, CharacterMythicKeystoneProfileIndexResponse, CharacterMythicKeystoneSeasonDetailsResponse, CharacterPetsCollectionSummaryResponse, CharacterProfessionsSummaryResponse, CharacterProfileStatusResponse, CharacterProfileSummaryResponse, CharacterPvpBracketStatisticsResponse, CharacterPvpSummaryResponse, CharacterQuestsResponse, CharacterRaidsResponse, CharacterReputationsSummaryResponse, CharacterSoulbindsResponse, CharacterSpecializationsSummaryResponse, CharacterStatisticsSummaryResponse, CharacterTitlesSummaryResponse, CharacterToysCollectionSummaryResponse, CharacterTransmogCollectionSummaryResponse, ConduitIndexResponse, ConduitResponse, ConnectedRealmIndexResponse, ConnectedRealmResponse, ConnectedRealmSearchParameters, ConnectedRealmSearchResponse, CovenantIndexResponse, CovenantMediaResponse, CovenantResponse, CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponse, CreatureTypeIndexResponse, CreatureTypeResponse, GuildAchievementsResponse, GuildActivityResponse, GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse, GuildResponse, GuildRosterResponse, HeirloomIndexResponse, HeirloomResponse, ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponse, ItemSetIndexResponse, ItemSetResponse, ItemSubClassResponse, JournalEncounterIndexResponse, JournalEncounterResponse, JournalEncounterSearchParameters, JournalEncounterSearchResponse, JournalExpansionIndexResponse, JournalExpansionResponse, JournalInstanceIndexResponse, JournalInstanceMediaResponse, JournalInstanceResponse, MediaSearchParameters, MediaSearchResponse, ModifiedCraftingCategoryIndexResponse, ModifiedCraftingCategoryResponse, ModifiedCraftingIndexResponse, ModifiedCraftingReagentSlotTypeIndexResponse, ModifiedCraftingReagentSlotTypeResponse, MountIndexResponse, MountResponse, MountSearchParameters, MountSearchResponse, MythicKeystoneAffixIndexResponse, MythicKeystoneAffixMediaResponse, MythicKeystoneAffixResponse, MythicKeystoneDungeonIndexResponse, MythicKeystoneDungeonResponse, MythicKeystoneIndexResponse, MythicKeystoneLeaderboardIndexResponse, MythicKeystoneLeaderboardResponse, MythicKeystonePeriodIndexResponse, MythicKeystonePeriodResponse, MythicKeystoneSeasonIndexResponse, MythicKeystoneSeasonResponse, MythicRaidLeaderboardResponse, PetAbilityIndexResponse, PetAbilityMediaResponse, PetAbilityResponse, PetIndexResponse, PetMediaResponse, PetResponse, PlayableClassIndexResponse, PlayableClassMediaResponse, PlayableClassResponse, PlayableRaceIndexResponse, PlayableRaceResponse, PlayableSpecializationIndexResponse, PlayableSpecializationMediaResponse, PlayableSpecializationResponse, PowerTypeIndexResponse, PowerTypeResponse, ProfessionIndexResponse, ProfessionMediaResponse, ProfessionResponse, ProfessionSkillTierResponse, ProtectedCharacterProfileSummaryResponse, PvpLeaderboardIndexResponse, PvpLeaderboardResponse, PvpRewardsIndexResponse, PvpSeasonIndexResponse, PvpSeasonResponse, PvpTalentIndexResponse, PvpTalentResponse, PvpTalentSlotsResponse, PvpTierIndexResponse, PvpTierMediaResponse, PvpTierResponse, QuestAreaIndexResponse, QuestAreaResponse, QuestCategoryIndexResponse, QuestCategoryResponse, QuestIndexResponse, QuestResponse, QuestTypeIndexResponse, QuestTypeResponse, RealmCategory, RealmIndexResponse, RealmLocales, RealmResponse, RealmSearchParameters, RealmSearchResponse, RealmTimezone, RealmTypeCapitalized, RecipeMediaResponse, RecipeResponse, RegionIndexResponse, RegionResponse, ReputationFactionIndexResponse, ReputationFactionResponse, ReputationTiersIndexResponse, ReputationTiersResponse, SoulbindIndexResponse, SoulbindResponse, SpellMediaResponse, SpellResponse, SpellSearchParameters, SpellSearchResponse, TalentIndexResponse, TalentResponse, TalentTreeIndexResponse, TalentTreeNodesResponse, TalentTreeResponse, TechTalentIndexResponse, TechTalentMediaResponse, TechTalentResponse, TechTalentTreeIndexResponse, TechTalentTreeResponse, TitleIndexResponse, TitleResponse, ToyIndexResponse, ToyResponse, WowTokenResponse, accountCollectionsIndex, accountHeirloomsCollectionSummary, accountMountsCollectionSummary, accountPetsCollectionSummary, accountProfileSummary, accountToysCollectionSummary, accountTransmogsCollectionSummary, achievement, achievementCategory, achievementCategoryIndex, achievementIndex, achievementMedia, auctions, azeriteEssence, azeriteEssenceIndex, azeriteEssenceMedia, azeriteEssenceSearch, characterAchievementStatistics, characterAchievementsSummary, characterAppearanceSummary, characterCollectionsIndex, characterCompletedQuests, characterDungeons, characterEncountersSummary, characterEquipmentSummary, characterHeirloomsCollectionSummary, characterHunterPetsSummary, characterMediaSummary, characterMountsCollectionSummary, characterMythicKeystoneProfileIndex, characterMythicKeystoneSeasonDetails, characterPetsCollectionSummary, characterProfessionsSummary, characterProfileStatus, characterProfileSummary, characterPvpBracketStatistics, characterPvpSummary, characterQuests, characterRaids, characterReputationsSummary, characterSoulbinds, characterSpecializationsSummary, characterStatisticsSummary, characterTitlesSummary, characterToysCollectionSummary, characterTransmogCollectionSummary, commodities, conduit, conduitIndex, connectedRealm, connectedRealmIndex, connectedRealmSearch, covenant, covenantIndex, covenantMedia, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, wow as default, wow, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, heirloom, heirloomIndex, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass, journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia, mediaSearch, modifiedCraftingCategory, modifiedCraftingCategoryIndex, modifiedCraftingIndex, modifiedCraftingReagentSlotType, modifiedCraftingReagentSlotTypeIndex, mount, mountIndex, mountSearch, mythicKeystoneAffix, mythicKeystoneAffixIndex, mythicKeystoneAffixMedia, mythicKeystoneDungeon, mythicKeystoneDungeonIndex, mythicKeystoneIndex, mythicKeystoneLeaderboard, mythicKeystoneLeaderboardIndex, mythicKeystonePeriod, mythicKeystonePeriodIndex, mythicKeystoneSeason, mythicKeystoneSeasonIndex, mythicRaidLeaderboard, pet, petAbility, petAbilityIndex, petAbilityMedia, petIndex, petMedia, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, playableSpecialization, playableSpecializationIndex, playableSpecializationMedia, powerType, powerTypeIndex, profession, professionIndex, professionMedia, professionSkillTier, protectedCharacterProfileSummary, pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, pvpTalent, pvpTalentIndex, pvpTalentSlots, pvpTier, pvpTierIndex, pvpTierMedia, quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex, realm, realmIndex, realmSearch, recipe, recipeMedia, region, regionIndex, reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex, soulbind, soulbindIndex, spell, spellMedia, spellSearch, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes, techTalent, techTalentIndex, techTalentMedia, techTalentTree, techTalentTreeIndex, title, titleIndex, toy, toyIndex, wowToken };
258
+ export { AccountCollectionsIndexResponse, AccountHeirloomsCollectionSummaryResponse, AccountMountsCollectionSummaryResponse, AccountPetsCollectionSummaryResponse, AccountProfileSummaryResponse, AccountToysCollectionSummaryResponse, AccountTransmogsCollectionSummaryResponse, AchievementCategoryIndexResponse, AchievementCategoryResponse, AchievementIndexResponse, AchievementMediaResponse, AchievementResponse, AuctionHouseCommoditiesResponse, AuctionHouseResponse, AzeriteEssenceIndexResponse, AzeriteEssenceMediaResponse, AzeriteEssenceResponse, AzeriteEssenceSearchParameters, AzeriteEssenceSearchResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterAppearanceResponse, CharacterCollectionsIndexResponse, CharacterCompletedQuestsResponse, CharacterDungeonsResponse, CharacterEncountersSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHeirloomsCollectionSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse, CharacterMountsCollectionSummaryResponse, CharacterMythicKeystoneProfileIndexResponse, CharacterMythicKeystoneSeasonDetailsResponse, CharacterPetsCollectionSummaryResponse, CharacterProfessionsSummaryResponse, CharacterProfileStatusResponse, CharacterProfileSummaryResponse, CharacterPvpBracketStatisticsResponse, CharacterPvpSummaryResponse, CharacterQuestsResponse, CharacterRaidsResponse, CharacterReputationsSummaryResponse, CharacterSoulbindsResponse, CharacterSpecializationsSummaryResponse, CharacterStatisticsSummaryResponse, CharacterTitlesSummaryResponse, CharacterToysCollectionSummaryResponse, CharacterTransmogCollectionSummaryResponse, ConduitIndexResponse, ConduitResponse, ConnectedRealmIndexResponse, ConnectedRealmResponse, ConnectedRealmSearchParameters, ConnectedRealmSearchResponse, CovenantIndexResponse, CovenantMediaResponse, CovenantResponse, CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponse, CreatureTypeIndexResponse, CreatureTypeResponse, DecorIndexResponse, DecorResponse, DecorSearchResponse, FixtureHookIndexResponse, FixtureHookResponse, FixtureHookSearchResponse, FixtureIndexResponse, FixtureResponse, FixtureSearchResponse, GenericDecorSearchParameters, GuildAchievementsResponse, GuildActivityResponse, GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse, GuildResponse, GuildRosterResponse, HeirloomIndexResponse, HeirloomResponse, ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponse, ItemSetIndexResponse, ItemSetResponse, ItemSubClassResponse, JournalEncounterIndexResponse, JournalEncounterResponse, JournalEncounterSearchParameters, JournalEncounterSearchResponse, JournalExpansionIndexResponse, JournalExpansionResponse, JournalInstanceIndexResponse, JournalInstanceMediaResponse, JournalInstanceResponse, MediaSearchParameters, MediaSearchResponse, ModifiedCraftingCategoryIndexResponse, ModifiedCraftingCategoryResponse, ModifiedCraftingIndexResponse, ModifiedCraftingReagentSlotTypeIndexResponse, ModifiedCraftingReagentSlotTypeResponse, MountIndexResponse, MountResponse, MountSearchParameters, MountSearchResponse, MythicKeystoneAffixIndexResponse, MythicKeystoneAffixMediaResponse, MythicKeystoneAffixResponse, MythicKeystoneDungeonIndexResponse, MythicKeystoneDungeonResponse, MythicKeystoneIndexResponse, MythicKeystoneLeaderboardIndexResponse, MythicKeystoneLeaderboardResponse, MythicKeystonePeriodIndexResponse, MythicKeystonePeriodResponse, MythicKeystoneSeasonIndexResponse, MythicKeystoneSeasonResponse, MythicRaidLeaderboardResponse, PetAbilityIndexResponse, PetAbilityMediaResponse, PetAbilityResponse, PetIndexResponse, PetMediaResponse, PetResponse, PlayableClassIndexResponse, PlayableClassMediaResponse, PlayableClassResponse, PlayableRaceIndexResponse, PlayableRaceResponse, PlayableSpecializationIndexResponse, PlayableSpecializationMediaResponse, PlayableSpecializationResponse, PowerTypeIndexResponse, PowerTypeResponse, ProfessionIndexResponse, ProfessionMediaResponse, ProfessionResponse, ProfessionSkillTierResponse, ProtectedCharacterProfileSummaryResponse, PvpLeaderboardIndexResponse, PvpLeaderboardResponse, PvpRewardsIndexResponse, PvpSeasonIndexResponse, PvpSeasonResponse, PvpTalentIndexResponse, PvpTalentResponse, PvpTalentSlotsResponse, PvpTierIndexResponse, PvpTierMediaResponse, PvpTierResponse, QuestAreaIndexResponse, QuestAreaResponse, QuestCategoryIndexResponse, QuestCategoryResponse, QuestIndexResponse, QuestResponse, QuestTypeIndexResponse, QuestTypeResponse, RealmCategory, RealmIndexResponse, RealmLocales, RealmResponse, RealmSearchParameters, RealmSearchResponse, RealmTimezone, RealmTypeCapitalized, RecipeMediaResponse, RecipeResponse, RegionIndexResponse, RegionResponse, ReputationFactionIndexResponse, ReputationFactionResponse, ReputationTiersIndexResponse, ReputationTiersResponse, RoomIndexReponse, RoomResponse, RoomSearchResponse, SoulbindIndexResponse, SoulbindResponse, SpellMediaResponse, SpellResponse, SpellSearchParameters, SpellSearchResponse, TalentIndexResponse, TalentResponse, TalentTreeIndexResponse, TalentTreeNodesResponse, TalentTreeResponse, TechTalentIndexResponse, TechTalentMediaResponse, TechTalentResponse, TechTalentTreeIndexResponse, TechTalentTreeResponse, TitleIndexResponse, TitleResponse, ToyIndexResponse, ToyResponse, WowTokenResponse, accountCollectionsIndex, accountHeirloomsCollectionSummary, accountMountsCollectionSummary, accountPetsCollectionSummary, accountProfileSummary, accountToysCollectionSummary, accountTransmogsCollectionSummary, achievement, achievementCategory, achievementCategoryIndex, achievementIndex, achievementMedia, auctions, azeriteEssence, azeriteEssenceIndex, azeriteEssenceMedia, azeriteEssenceSearch, characterAchievementStatistics, characterAchievementsSummary, characterAppearanceSummary, characterCollectionsIndex, characterCompletedQuests, characterDungeons, characterEncountersSummary, characterEquipmentSummary, characterHeirloomsCollectionSummary, characterHunterPetsSummary, characterMediaSummary, characterMountsCollectionSummary, characterMythicKeystoneProfileIndex, characterMythicKeystoneSeasonDetails, characterPetsCollectionSummary, characterProfessionsSummary, characterProfileStatus, characterProfileSummary, characterPvpBracketStatistics, characterPvpSummary, characterQuests, characterRaids, characterReputationsSummary, characterSoulbinds, characterSpecializationsSummary, characterStatisticsSummary, characterTitlesSummary, characterToysCollectionSummary, characterTransmogCollectionSummary, commodities, conduit, conduitIndex, connectedRealm, connectedRealmIndex, connectedRealmSearch, covenant, covenantIndex, covenantMedia, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, decor, decorIndex, decorSearch, wow as default, wow, fixture, fixtureHook, fixtureHookIndex, fixtureHookSearch, fixtureIndex, fixtureSearch, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, heirloom, heirloomIndex, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass, journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia, mediaSearch, modifiedCraftingCategory, modifiedCraftingCategoryIndex, modifiedCraftingIndex, modifiedCraftingReagentSlotType, modifiedCraftingReagentSlotTypeIndex, mount, mountIndex, mountSearch, mythicKeystoneAffix, mythicKeystoneAffixIndex, mythicKeystoneAffixMedia, mythicKeystoneDungeon, mythicKeystoneDungeonIndex, mythicKeystoneIndex, mythicKeystoneLeaderboard, mythicKeystoneLeaderboardIndex, mythicKeystonePeriod, mythicKeystonePeriodIndex, mythicKeystoneSeason, mythicKeystoneSeasonIndex, mythicRaidLeaderboard, pet, petAbility, petAbilityIndex, petAbilityMedia, petIndex, petMedia, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, playableSpecialization, playableSpecializationIndex, playableSpecializationMedia, powerType, powerTypeIndex, profession, professionIndex, professionMedia, professionSkillTier, protectedCharacterProfileSummary, pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, pvpTalent, pvpTalentIndex, pvpTalentSlots, pvpTier, pvpTierIndex, pvpTierMedia, quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex, realm, realmIndex, realmSearch, recipe, recipeMedia, region, regionIndex, reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex, room, roomIndex, roomSearch, soulbind, soulbindIndex, spell, spellMedia, spellSearch, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes, techTalent, techTalentIndex, techTalentMedia, techTalentTree, techTalentTreeIndex, title, titleIndex, toy, toyIndex, wowToken };
4928
259
  //# sourceMappingURL=index.d.ts.map