@blizzard-api/wow 0.2.2 → 0.2.3

package/dist/index.d.cts

@@ -1,6 +1,9 @@
 import * as _blizzard_api_core from '@blizzard-api/core';
 import { BaseSearchParameters, Locales, Origins } from '@blizzard-api/core';
 
+/**
+ * Base interface for Blizzard API responses.
+ */
 interface ResponseBase {
     _links: {
         self: {
@@ -8,56 +11,69 @@ interface ResponseBase {
         };
     };
 }
+/**
+ * Base record interface containing key.href property that often appear in Blizzard API responses.
+ */
 interface KeyBase {
     key: {
         href: string;
     };
 }
+/**
+ * Base record interface containing name and id properties that often appear together in Blizzard API responses.
+ */
 interface NameId {
     name: string;
     id: number;
 }
+/**
+ * Base record containing both {@link KeyBase} and {@link NameId} interfaces.
+ */
 interface NameIdKey extends KeyBase, NameId {
 }
+/**
+ * A record containing the RGBA values of a color.
+ */
 interface Color {
     r: number;
     g: number;
     b: number;
     a: number;
 }
+/**
+ * The media asset associated with a character or entity in World of Warcraft.
+ */
 interface MediaAsset$1 {
     key: string;
     value: string;
     file_data_id: number;
 }
+/**
+ * The playable genders in World of Warcraft.
+ */
 interface Gender {
     male: string;
     female: string;
 }
+/**
+ * The playable factions in World of Warcraft.
+ */
 declare const Factions: {
     readonly ALLIANCE: "ALLIANCE";
     readonly HORDE: "HORDE";
 };
+/**
+ * The faction associated with a character or entity in World of Warcraft.
+ */
 interface Faction {
     type: keyof typeof Factions;
     name: Capitalize<Lowercase<keyof typeof Factions>>;
 }
 
-interface MediaSearchParameters extends BaseSearchParameters {
-    tags?: string;
-}
-interface MediaSearchResponseItem extends KeyBase {
-    data: {
-        id: number;
-        assets: Array<MediaAsset>;
-    };
-}
-interface MediaAsset {
-    file_data_id: number;
-    key: string;
-    value: string;
-}
-
+/**
+ * Interface for a response from the achievement category endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AchievementCategoryResponse extends ResponseBase, NameId {
     achievements: Array<NameIdKey>;
     parent_category: NameIdKey;
@@ -74,11 +90,19 @@ interface AchievementCategoryResponse extends ResponseBase, NameId {
     };
     display_order: number;
 }
+/**
+ * Interface for a response from the achievement category index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AchievementCategoryIndexResponse extends ResponseBase {
     categories: Array<NameIdKey>;
     root_categories: Array<NameIdKey>;
     guild_categories: Array<NameIdKey>;
 }
+/**
+ * Interface for a response from the achievement endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AchievementResponse extends ResponseBase, NameId {
     category: NameIdKey;
     description: string;
@@ -92,6 +116,10 @@ interface AchievementResponse extends ResponseBase, NameId {
     media: KeyBase;
     display_order: number;
 }
+/**
+ * Interface for a response from the achievement index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AchievementIndexResponse extends ResponseBase {
     achievements: Array<NameIdKey>;
 }
@@ -100,6 +128,10 @@ interface AchievementMediaItem {
     value: string;
     file_data_id: number;
 }
+/**
+ * Interface for a response from the achievement media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AchievementMediaResponse extends ResponseBase {
     id: number;
     assets: Array<AchievementMediaItem>;
@@ -122,6 +154,10 @@ interface AuctionHousePosting {
     quantity: number;
     time_left: AuctionHouseTimeLeft;
 }
+/**
+ * Interface for a response from the auction house endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AuctionHouseResponse extends ResponseBase {
     connected_realm: {
         href: string;
@@ -140,13 +176,25 @@ interface AuctionHouseCommodity {
     unit_price: number;
     time_left: AuctionHouseTimeLeft;
 }
+/**
+ * Interface for a response from the auction house commodities endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AuctionHouseCommoditiesResponse extends ResponseBase {
     auctions: Array<AuctionHouseCommodity>;
 }
 
+/**
+ * Interface for a response from the azerite essence index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AzeriteEssenceIndexResponse extends ResponseBase {
     azerite_essences: Array<NameIdKey>;
 }
+/**
+ * Interface for a response from the azerite essence endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AzeriteEssenceResponse extends ResponseBase, NameId {
     allowed_specializations: Array<NameIdKey>;
     powers: Array<Power>;
@@ -161,13 +209,27 @@ interface Power {
     main_power_spell: NameIdKey;
     passive_power_spell: NameIdKey;
 }
+/**
+ * Interface for a response from the azerite essence media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface AzeriteEssenceMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
+/**
+ * Interface for search parameters for azerite essences.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface AzeriteEssenceSearchParameters extends BaseSearchParameters {
     'allowed_specializations.id'?: number;
 }
+/**
+ * Interface for a response item from the azerite essence search endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface AzeriteEssenceSearchResponseItem extends KeyBase {
     data: {
         allowed_specializations: Array<NameId>;
@@ -176,16 +238,37 @@ interface AzeriteEssenceSearchResponseItem extends KeyBase {
 }
 
 type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
+/**
+ * The category of a realm.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 type RealmCategory = 'English' | 'French' | 'German' | 'Italian' | 'PS' | 'Russian' | 'Spanish' | 'Brazil' | 'Latin America' | 'Oceanic' | 'United States' | '한국';
+/**
+ * The timezone of a realm.
+ */
 type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
+/**
+ * The type of a realm, capitalized and shortended).
+ */
 type RealmTypeCapitalized = 'NORMAL' | 'RP';
+/**
+ * The type of a realm, not capitalized or shortened.
+ */
 type RealmType = 'Normal' | 'Roleplaying';
+/**
+ * The response for a realm index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface RealmIndexResponse extends ResponseBase {
     realms: Array<Realm$4>;
 }
 interface Realm$4 extends NameIdKey {
     slug: string;
 }
+/**
+ * The response for a realm.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface RealmResponse extends ResponseBase, NameId {
     region: NameIdKey;
     connected_realm: {
@@ -201,9 +284,19 @@ interface RealmResponse extends ResponseBase, NameId {
     is_tournament: boolean;
     slug: string;
 }
+/**
+ * The search parameters for realms.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface RealmSearchParameters extends BaseSearchParameters {
     timezone?: RealmTimezone;
 }
+/**
+ * The response for a realm search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface RealmSearchResponseItem extends KeyBase {
     data: {
         is_tournament: boolean;
@@ -227,6 +320,10 @@ interface RealmSearchResponseItem extends KeyBase {
 type RealmPopulation = 'Low' | 'Medium' | 'High' | 'Full' | 'New Players';
 type RealmPopulationCapitalized = 'LOW' | 'MEDIUM' | 'HIGH' | 'FULL' | 'RECOMMENDED';
 type RealmStatus = 'Up' | 'Down';
+/**
+ * Connected Realm Index API response.
+ * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
+ */
 interface ConnectedRealmIndexResponse extends ResponseBase {
     connected_realms: Array<{
         href: string;
@@ -253,6 +350,10 @@ interface RealmLockedStatus {
     is_locked_for_pct: boolean;
     is_locked_for_new_characters: boolean;
 }
+/**
+ * Connected Realm API response.
+ * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
+ */
 interface ConnectedRealmResponse extends ResponseBase {
     id: number;
     has_queue: boolean;
@@ -273,6 +374,11 @@ interface ConnectedRealmResponse extends ResponseBase {
     };
     realm_locked_status?: RealmLockedStatus;
 }
+/**
+ * Connected Realm Search API parameters.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface ConnectedRealmSearchParameters extends BaseSearchParameters {
     'realms.timezone'?: RealmTimezone;
     'status.type'?: Uppercase<RealmStatus>;
@@ -302,6 +408,11 @@ interface SearchRealmPopulation {
     type: RealmPopulationCapitalized;
     name: Record<Locales, string>;
 }
+/**
+ * Connected Realm Search API response item.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface ConnectedRealmSearchResponseItem extends KeyBase {
     data: {
         id: number;
@@ -312,9 +423,17 @@ interface ConnectedRealmSearchResponseItem extends KeyBase {
     };
 }
 
+/**
+ * Interface for a response from the conduit index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ConduitIndexResponse extends ResponseBase {
     conduits: Array<NameIdKey>;
 }
+/**
+ * Interface for a response from the conduit endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ConduitResponse extends ResponseBase {
     id: number;
     name: string;
@@ -339,9 +458,17 @@ interface SocketType {
     type: string;
     name: string;
 }
+/**
+ * Interface for a response from the covenant index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CovenantIndexResponse extends ResponseBase {
     covenants: Array<NameIdKey>;
 }
+/**
+ * Interface for a response from the covenant endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CovenantResponse extends ResponseBase {
     id: number;
     name: string;
@@ -352,6 +479,10 @@ interface RenownReward {
     level: number;
     reward: NameIdKey;
 }
+/**
+ * Interface for a response from the covenant media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CovenantMediaResponse extends ResponseBase {
     id: number;
     name: string;
@@ -388,6 +519,10 @@ interface SignatureAbilitySpellTooltip {
     cast_time: string;
     cooldown: string;
 }
+/**
+ * Interface for a response from the soulbind endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface SoulbindResponse extends ResponseBase {
     id: number;
     name: string;
@@ -396,10 +531,18 @@ interface SoulbindResponse extends ResponseBase {
     follower: NameIdKey;
     talent_tree: NameIdKey;
 }
+/**
+ * Interface for a response from the soulbind index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface SoulbindIndexResponse extends ResponseBase {
     soulbinds: Array<NameIdKey>;
 }
 
+/**
+ * The response for a creature.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureResponse extends ResponseBase {
     id: number;
     name: string;
@@ -411,6 +554,10 @@ interface CreatureResponse extends ResponseBase {
 interface CreatureDisplay$2 extends KeyBase {
     id: number;
 }
+/**
+ * The response for creature display media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureDisplayMediaResponse extends ResponseBase {
     assets: Array<DisplayMediaAsset>;
     id: number;
@@ -419,9 +566,17 @@ interface DisplayMediaAsset {
     key: string;
     value: string;
 }
+/**
+ * The response for a creature family index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureFamilyIndexResponse extends ResponseBase {
     creature_families: Array<NameIdKey>;
 }
+/**
+ * The response for a creature family.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureFamilyResponse extends ResponseBase {
     id: number;
     name: string;
@@ -431,21 +586,43 @@ interface CreatureFamilyResponse extends ResponseBase {
 interface Media$d extends KeyBase {
     id: number;
 }
+/**
+ * The response for creature family media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureFamilyMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
+/**
+ * The response for a creature type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureTypeIndexResponse extends ResponseBase {
     creature_types: Array<NameIdKey>;
 }
+/**
+ * The response for a creature type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface CreatureTypeResponse extends ResponseBase {
     id: number;
     name: string;
 }
+/**
+ * The search parameters for a creature.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface CreatureSearchParameters extends BaseSearchParameters {
     name: string;
     locale: Locales;
 }
+/**
+ * The response for a creature search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface CreatureSearchResponseItem extends KeyBase {
     data: {
         creature_displays: Array<{
@@ -465,6 +642,10 @@ interface CreatureSearchResponseItem extends KeyBase {
     };
 }
 
+/**
+ * The response for the guild crest components index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface GuildCrestComponentsIndexResponse extends ResponseBase {
     emblems: Array<Border>;
     borders: Array<Border>;
@@ -492,6 +673,10 @@ interface RGBA {
     b: number;
     a: number;
 }
+/**
+ * The response for a guild crest border or emblem.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface GuildCrestBorderEmblemResponse extends ResponseBase {
     assets: Array<GuildCrestAsset>;
     id: number;
@@ -501,9 +686,17 @@ interface GuildCrestAsset {
     value: string;
 }
 
+/**
+ * The response for the heirloom index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface HeirloomIndexResponse extends ResponseBase {
     heirlooms: Array<NameIdKey>;
 }
+/**
+ * The response for a heirloom.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface HeirloomResponse extends ResponseBase {
     id: number;
     item: NameIdKey;
@@ -587,6 +780,10 @@ interface InventoryType {
 }
 type StatTypeCapitalized = 'STRENGTH' | 'AGILITY' | 'INTELLECT' | 'STAMINA' | 'CRIT_RATING' | 'HASTE_RATING' | 'MASTERY' | 'VERSATILITY';
 type StatType = 'Strength' | 'Agility' | 'Intellect' | 'Stamina' | 'Critical Strike' | 'Haste' | 'Mastery' | 'Versatility';
+/**
+ * The response for an item.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ItemResponse extends ResponseBase, NameId {
     quality: ItemQuality;
     level: number;
@@ -715,27 +912,51 @@ interface RecipeItemDisplayStrings {
     silver: string;
     copper: string;
 }
+/**
+ * The response for an item class index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ItemClassIndexResponse extends ResponseBase {
     item_classes: Array<NameIdKey>;
 }
+/**
+ * The response for an item class.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ItemClassResponse extends ResponseBase {
     class_id: number;
     name: string;
     item_subclasses: Array<NameIdKey>;
 }
+/**
+ * The response for an item media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ItemMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
-interface ItemSubclassResponse extends ResponseBase {
+/**
+ * The response for an item subclass.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSubClassResponse extends ResponseBase {
     class_id: number;
     subclass_id: number;
     display_name: string;
     verbose_name: string;
 }
+/**
+ * The response for an item set index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ItemSetIndexResponse extends ResponseBase {
     item_sets: Array<NameIdKey>;
 }
+/**
+ * The response for an item set.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ItemSetResponse extends ResponseBase {
     id: number;
     name: string;
@@ -746,10 +967,20 @@ interface Effect {
     display_string: string;
     required_count: number;
 }
+/**
+ * The parameters for an item search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface ItemSearchParameters extends BaseSearchParameters {
     name: string;
     locale: Locales;
 }
+/**
+ * The response for an item search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface ItemSearchResponseItem extends KeyBase {
     data: {
         level: number;
@@ -782,9 +1013,17 @@ type EncounterCategory = 'RAID' | 'DUNGEON' | 'WORLD_BOSS';
 type EncounterMode = 'NORMAL' | 'HEROIC' | 'MYTHIC' | 'LFR';
 type ModeName = 'Raid Finder' | 'Normal' | 'Heroic' | 'Mythic' | 'Mythic+ Dungeons' | '10 Player' | '25 Player' | '10 Player (Heroic)' | '25 Player (Heroic)';
 type ModeType = 'LFR' | 'NORMAL' | 'HEROIC' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'LEGACY_10_MAN' | 'LEGACY_25_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN_HEROIC';
+/**
+ * The response for a journal encounter index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalEncounterIndexResponse extends ResponseBase {
     encounters: Array<NameIdKey>;
 }
+/**
+ * The response for a journal encounter.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalEncounterResponse extends ResponseBase, NameId {
     description: string;
     creatures: Array<Creature>;
@@ -821,16 +1060,32 @@ interface JournalSection {
     creature_display?: CreatureDisplay$1;
     spell?: NameIdKey;
 }
+/**
+ * The response for a journal expansion index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalExpansionIndexResponse extends ResponseBase {
     tiers: Array<NameIdKey>;
 }
+/**
+ * The response for a journal expansion.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalExpansionResponse extends ResponseBase, NameId {
     dungeons: Array<NameIdKey>;
     raids: Array<NameIdKey>;
 }
+/**
+ * The response for a journal instance index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalInstanceIndexResponse extends ResponseBase {
     instances: Array<NameIdKey>;
 }
+/**
+ * The response for a journal instance.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalInstanceResponse extends ResponseBase, NameId {
     map: NameId;
     area: NameId;
@@ -852,6 +1107,10 @@ interface ModeElement {
     players: number;
     is_tracked: boolean;
 }
+/**
+ * The response for journal instance media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface JournalInstanceMediaResponse extends ResponseBase {
     assets: Array<Asset>;
 }
@@ -859,10 +1118,20 @@ interface Asset {
     key: string;
     value: string;
 }
+/**
+ * The parameters for a journal encounter search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface JournalEncounterSearchParameters extends BaseSearchParameters {
     instanceName: string;
     locale: Locales;
 }
+/**
+ * The response for a journal encounter search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface JournalEncounterSearchResponseItem extends KeyBase {
     data: {
         instance: {
@@ -896,11 +1165,48 @@ interface JournalEncounterSearchItem {
     };
 }
 
+/**
+ * The search parameters for media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface MediaSearchParameters extends BaseSearchParameters {
+    tags?: string;
+}
+/**
+ * The response for a media search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface MediaSearchResponseItem extends KeyBase {
+    data: {
+        id: number;
+        assets: Array<MediaAsset>;
+    };
+}
+interface MediaAsset {
+    file_data_id: number;
+    key: string;
+    value: string;
+}
+
+/**
+ * The response for a modified crafting category.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ModifiedCraftingCategoryResponse extends ResponseBase, NameId {
 }
+/**
+ * The response for a modified crafting category index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ModifiedCraftingCategoryIndexResponse extends ResponseBase {
     categories: Array<NameIdKey>;
 }
+/**
+ * The response for a modified crafting index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ModifiedCraftingIndexResponse extends ResponseBase {
     categories: {
         href: string;
@@ -909,6 +1215,10 @@ interface ModifiedCraftingIndexResponse extends ResponseBase {
         href: string;
     };
 }
+/**
+ * The response for a modified crafting reagent slot type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ModifiedCraftingReagentSlotTypeIndexResponse extends ResponseBase {
     slot_types: Array<SlotType>;
 }
@@ -916,15 +1226,27 @@ interface SlotType extends KeyBase {
     name?: string;
     id: number;
 }
+/**
+ * The response for a modified crafting reagent slot type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ModifiedCraftingReagentSlotTypeResponse extends ResponseBase {
     id: number;
     description: string;
     compatible_categories: Array<NameIdKey>;
 }
 
+/**
+ * The response for a mount index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MountIndexResponse extends ResponseBase {
     mounts: Array<NameIdKey>;
 }
+/**
+ * The response for a mount.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MountResponse extends ResponseBase {
     id: number;
     name: string;
@@ -940,10 +1262,20 @@ interface Source$2 {
     type: string;
     name: string;
 }
+/**
+ * The search parameters for mounts.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface MountSearchParameters extends BaseSearchParameters {
     name: string;
     locale: Locales;
 }
+/**
+ * The response for a mount search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface MountSearchResponseItem extends KeyBase {
     data: {
         creature_displays: Array<{
@@ -962,9 +1294,17 @@ interface MountSearchResponseItem extends KeyBase {
     };
 }
 
+/**
+ * The response for a Mythic Keystone affix index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneAffixIndexResponse extends ResponseBase {
     affixes: Array<NameIdKey>;
 }
+/**
+ * The response for a Mythic Keystone affix.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneAffixResponse extends ResponseBase, NameId {
     description: string;
     media: Media$8;
@@ -972,14 +1312,26 @@ interface MythicKeystoneAffixResponse extends ResponseBase, NameId {
 interface Media$8 extends KeyBase {
     id: number;
 }
+/**
+ * The response for a Mythic Keystone affix media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneAffixMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
 
+/**
+ * The response for a Mythic Keystone dungeon index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneDungeonIndexResponse extends ResponseBase {
     dungeons: Array<NameIdKey>;
 }
+/**
+ * The response for a Mythic Keystone dungeon.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneDungeonResponse extends ResponseBase, NameId {
     map: NameId;
     zone: Zone;
@@ -994,6 +1346,10 @@ interface KeystoneUpgrade {
 interface Zone {
     slug: string;
 }
+/**
+ * The response for a Mythic Keystone index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneIndexResponse extends ResponseBase {
     seasons: {
         href: string;
@@ -1002,6 +1358,10 @@ interface MythicKeystoneIndexResponse extends ResponseBase {
         href: string;
     };
 }
+/**
+ * The response for a Mythic Keystone period index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystonePeriodIndexResponse extends ResponseBase {
     periods: Array<Period>;
     current_period: Period;
@@ -1009,15 +1369,27 @@ interface MythicKeystonePeriodIndexResponse extends ResponseBase {
 interface Period extends KeyBase {
     id: number;
 }
+/**
+ * The response for a Mythic Keystone period.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystonePeriodResponse extends ResponseBase {
     id: number;
     start_timestamp: number;
     end_timestamp: number;
 }
+/**
+ * The response for a Mythic Keystone season index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneSeasonIndexResponse extends ResponseBase {
     seasons: Array<Period>;
     current_season: Period;
 }
+/**
+ * The response for a Mythic Keystone season.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneSeasonResponse extends ResponseBase {
     id: number;
     start_timestamp: number;
@@ -1026,9 +1398,17 @@ interface MythicKeystoneSeasonResponse extends ResponseBase {
     season_name: string | null;
 }
 
+/**
+ * The response for a Mythic Keystone leaderboard index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneLeaderboardIndexResponse extends ResponseBase {
     current_leaderboards: Array<NameIdKey>;
 }
+/**
+ * The response for a Mythic Keystone leaderboard.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicKeystoneLeaderboardResponse extends ResponseBase {
     map: NameId;
     period: number;
@@ -1076,6 +1456,10 @@ interface MythicRating {
     rating: number;
 }
 
+/**
+ * The response for a Mythic Raid leaderboard.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface MythicRaidLeaderboardResponse extends ResponseBase {
     slug: string;
     criteria_type: string;
@@ -1104,9 +1488,17 @@ interface JournalInstance extends KeyBase {
     id: number;
 }
 
+/**
+ * The response for a pet index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PetIndexResponse extends ResponseBase {
     pets: Array<NameIdKey>;
 }
+/**
+ * The response for a pet.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PetResponse extends ResponseBase, NameId {
     battle_pet_type: BattlePetType;
     description: string;
@@ -1138,26 +1530,50 @@ interface Source$1 {
     type: string;
     name: string;
 }
+/**
+ * The response for a pet search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PetMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
+/**
+ * The response for a pet ability index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PetAbilityIndexResponse extends ResponseBase {
     abilities: Array<NameIdKey>;
 }
+/**
+ * The response for a pet ability.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PetAbilityResponse extends ResponseBase, NameId {
     battle_pet_type: BattlePetType;
     rounds: number;
     media: Media$7;
 }
+/**
+ * The response for a pet ability media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PetAbilityMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
 
+/**
+ * The response for a playable class index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableClassIndexResponse extends ResponseBase {
     classes: Array<NameIdKey>;
 }
+/**
+ * The response for a playable class.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableClassResponse extends ResponseBase, NameId {
     gender_name: Gender;
     power_type: NameIdKey;
@@ -1171,10 +1587,18 @@ interface PlayableClassResponse extends ResponseBase, NameId {
 interface Media$6 extends KeyBase {
     id: number;
 }
+/**
+ * The response for playable class media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableClassMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
+/**
+ * The response for a playable class's PvP talent slots.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpTalentSlotsResponse extends ResponseBase {
     talent_slots: Array<TalentSlot>;
 }
@@ -1183,9 +1607,17 @@ interface TalentSlot {
     unlock_player_level: number;
 }
 
+/**
+ * The playable race index response.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableRaceIndexResponse extends ResponseBase {
     races: Array<NameIdKey>;
 }
+/**
+ * The playable race response.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableRaceResponse extends ResponseBase, NameId {
     gender_name: Gender;
     faction: Faction;
@@ -1194,10 +1626,18 @@ interface PlayableRaceResponse extends ResponseBase, NameId {
     playable_classes: Array<NameIdKey>;
 }
 
+/**
+ * The response for a playable specialization index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableSpecializationIndexResponse extends ResponseBase {
     character_specializations: Array<NameIdKey>;
     pet_specializations: Array<NameIdKey>;
 }
+/**
+ * The response for a playable specialization.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableSpecializationResponse extends ResponseBase, NameId {
     playable_class: NameIdKey;
     gender_description: Gender;
@@ -1229,20 +1669,40 @@ interface SpellTooltip {
 interface SpecTalentTree$1 extends KeyBase {
     name: string;
 }
+/**
+ * The response for a playable specialization media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PlayableSpecializationMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
 
+/**
+ * The response for a power type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PowerTypeIndexResponse extends ResponseBase {
     power_types: Array<NameIdKey>;
 }
+/**
+ * The response for a power type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PowerTypeResponse extends ResponseBase, NameId {
 }
 
+/**
+ * The response for a profession index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ProfessionIndexResponse extends ResponseBase {
     professions: Array<NameIdKey>;
 }
+/**
+ * The response for a profession.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ProfessionResponse extends ResponseBase, NameId {
     description: string;
     type: Type;
@@ -1256,6 +1716,10 @@ interface Type {
     type: string;
     name: string;
 }
+/**
+ * The response for a profession skill tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ProfessionSkillTierResponse extends ResponseBase, NameId {
     minimum_skill_level: number;
     maximum_skill_level: number;
@@ -1265,10 +1729,18 @@ interface Category {
     name: string;
     recipes: Array<NameIdKey>;
 }
+/**
+ * The response for a profession media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ProfessionMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
+/**
+ * The response for a recipe.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface RecipeResponse extends ResponseBase, NameId {
     media: Media$4;
     crafted_item: NameIdKey;
@@ -1282,11 +1754,19 @@ interface Reagent {
     reagent: NameIdKey;
     quantity: number;
 }
+/**
+ * The response for a recipe media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface RecipeMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
 
+/**
+ * The response for a PvP leaderboard.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpLeaderboardResponse extends ResponseBase {
     season: Season;
     name: string;
@@ -1315,10 +1795,18 @@ interface SeasonMatchStatistics {
     won: number;
     lost: number;
 }
+/**
+ * The response for a PvP leaderboard index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpLeaderboardIndexResponse extends ResponseBase {
     season: Season;
     leaderboards: Array<NameIdKey>;
 }
+/**
+ * The response for PvP rewards index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpRewardsIndexResponse extends ResponseBase {
     season: Season;
     rewards: Array<Reward>;
@@ -1334,6 +1822,10 @@ interface Bracket$1 {
     id: number;
     type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'SHUFFLE';
 }
+/**
+ * The response for a PvP season index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpSeasonIndexResponse extends ResponseBase {
     seasons: Array<Season>;
     current_season: Season;
@@ -1341,6 +1833,10 @@ interface PvpSeasonIndexResponse extends ResponseBase {
 interface Season extends KeyBase {
     id: number;
 }
+/**
+ * The response for a PvP season.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpSeasonResponse extends ResponseBase {
     id: number;
     leaderboards: {
@@ -1353,9 +1849,17 @@ interface PvpSeasonResponse extends ResponseBase {
     season_name: string;
 }
 
+/**
+ * The response for a PvP tier index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpTierIndexResponse extends ResponseBase {
     tiers: Array<NameIdKey>;
 }
+/**
+ * The response for a PvP tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpTierResponse extends ResponseBase, NameId {
     min_rating: number;
     max_rating: number;
@@ -1370,11 +1874,19 @@ interface Bracket {
 interface Media$3 extends KeyBase {
     id: number;
 }
+/**
+ * The response for a PvP tier media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpTierMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
 
+/**
+ * The response for a quest index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestIndexResponse extends ResponseBase {
     categories: {
         href: string;
@@ -1386,6 +1898,10 @@ interface QuestIndexResponse extends ResponseBase {
         href: string;
     };
 }
+/**
+ * The response for a quest.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestResponse extends ResponseBase {
     id: number;
     title: string;
@@ -1417,45 +1933,85 @@ interface Reputation {
     reward: NameIdKey;
     value: number;
 }
+/**
+ * The response for a quest area index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestAreaIndexResponse extends ResponseBase {
     areas: Array<NameIdKey>;
 }
+/**
+ * The response for a quest area.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestAreaResponse extends ResponseBase {
     id: number;
     area: string;
     quests: Array<NameIdKey>;
 }
+/**
+ * The response for a quest category index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestCategoryIndexResponse extends ResponseBase {
     categories: Array<NameIdKey>;
 }
+/**
+ * The response for a quest category.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestCategoryResponse extends ResponseBase {
     id: number;
     category: string;
     quests: Array<NameIdKey>;
 }
+/**
+ * The response for a quest type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestTypeIndexResponse extends ResponseBase {
     types: Array<NameIdKey>;
 }
+/**
+ * The response for a quest type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface QuestTypeResponse extends ResponseBase {
     id: number;
     type: string;
     quests: Array<NameIdKey>;
 }
 
+/**
+ * The response for a region index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface RegionIndexResponse extends ResponseBase {
     regions: Array<{
         href: string;
     }>;
 }
+/**
+ * The response for a region.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface RegionResponse extends ResponseBase, NameId {
     tag: string;
     patch_string: string;
 }
 
+/**
+ * The response for a reputation faction index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ReputationFactionIndexResponse extends ResponseBase {
     factions: Array<NameIdKey>;
     root_factions: Array<NameIdKey>;
 }
+/**
+ * The response for a reputation faction.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ReputationFactionResponse extends ResponseBase {
     id: number;
     name: string;
@@ -1465,6 +2021,10 @@ interface ReputationFactionResponse extends ResponseBase {
 interface ReputationTiers extends KeyBase {
     id: number;
 }
+/**
+ * The response for a reputation tier index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ReputationTiersIndexResponse extends ResponseBase {
     reputation_tiers: Array<ReputationTier>;
 }
@@ -1472,6 +2032,10 @@ interface ReputationTier extends KeyBase {
     id: number;
     name?: string;
 }
+/**
+ * The response for a reputation tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ReputationTiersResponse extends ResponseBase {
     id: number;
     tiers: Array<Tier>;
@@ -1484,6 +2048,10 @@ interface Tier {
     id: number;
 }
 
+/**
+ * The response for a spell.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface SpellResponse extends ResponseBase, NameId {
     description: null | string;
     media: Media$2;
@@ -1491,14 +2059,28 @@ interface SpellResponse extends ResponseBase, NameId {
 interface Media$2 extends KeyBase {
     id: number;
 }
+/**
+ * The response for a spell media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface SpellMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
     id: number;
 }
+/**
+ * The search parameters for spells.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface SpellSearchParameters extends BaseSearchParameters {
     name: string;
     locale: Locales;
 }
+/**
+ * The response for a spell search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
 interface SpellSearchResponseItem extends KeyBase {
     data: {
         name: Record<Locales, string | undefined>;
@@ -1509,9 +2091,17 @@ interface SpellSearchResponseItem extends KeyBase {
     };
 }
 
+/**
+ * The response for a pvp talent index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpTalentIndexResponse extends ResponseBase {
     pvp_talents: Array<NameIdKey>;
 }
+/**
+ * The response for a pvp talent.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface PvpTalentResponse extends ResponseBase {
     id: number;
     spell: NameIdKey;
@@ -1520,9 +2110,17 @@ interface PvpTalentResponse extends ResponseBase {
     unlock_player_level: number;
     compatible_slots: Array<number>;
 }
+/**
+ * The response for a talent index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TalentIndexResponse extends ResponseBase {
     talents: Array<NameIdKey>;
 }
+/**
+ * The response for a talent.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TalentResponse extends ResponseBase {
     id: number;
     rank_descriptions: Array<RankDescription>;
@@ -1536,6 +2134,10 @@ interface RankDescription {
     rank: number;
     description: null;
 }
+/**
+ * The response for a talent tree index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TalentTreeIndexResponse extends ResponseBase {
     spec_talent_trees: Array<TalentTree$1>;
     class_talent_trees: Array<TalentTree$1>;
@@ -1543,6 +2145,10 @@ interface TalentTreeIndexResponse extends ResponseBase {
 interface TalentTree$1 extends KeyBase {
     name: string;
 }
+/**
+ * The response for a talent tree.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TalentTreeResponse extends ResponseBase, NameId {
     playable_class: NameIdKey;
     playable_specialization: NameIdKey;
@@ -1616,6 +2222,10 @@ interface PurpleSpellTooltip {
     description: string;
     cast_time: string;
 }
+/**
+ * The response for a talent tree nodes.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TalentTreeNodesResponse extends ResponseBase {
     id: number;
     spec_talent_trees: Array<SpecTalentTree>;
@@ -1639,9 +2249,17 @@ interface Rank {
     tooltip?: Tooltip;
 }
 
+/**
+ * The response for a tech talent index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TechTalentIndexResponse extends ResponseBase {
     talents: Array<NameIdKey>;
 }
+/**
+ * The response for a tech talent.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TechTalentResponse extends ResponseBase, NameId {
     talent_tree: Media$1;
     tier: number;
@@ -1651,9 +2269,17 @@ interface TechTalentResponse extends ResponseBase, NameId {
 interface Media$1 extends KeyBase {
     id: number;
 }
+/**
+ * The response for a tech talent media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TechTalentMediaResponse extends ResponseBase {
     assets: Array<MediaAsset$1>;
 }
+/**
+ * The response for a tech talent tree index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TechTalentTreeIndexResponse extends ResponseBase {
     talent_trees: Array<TalentTree>;
 }
@@ -1661,6 +2287,10 @@ interface TalentTree extends KeyBase {
     id: number;
     name?: string;
 }
+/**
+ * The response for a tech talent tree.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TechTalentTreeResponse extends ResponseBase {
     id: number;
     playable_class: NameIdKey;
@@ -1668,16 +2298,32 @@ interface TechTalentTreeResponse extends ResponseBase {
     talents: Array<NameIdKey>;
 }
 
+/**
+ * The response for a title index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TitleIndexResponse extends ResponseBase {
     titles: Array<NameIdKey>;
 }
+/**
+ * The response for a title.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface TitleResponse extends ResponseBase, NameId {
     gender_name: Gender;
 }
 
+/**
+ * The response for a toy index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ToyIndexResponse extends ResponseBase {
     toys: Array<NameIdKey>;
 }
+/**
+ * The response for a toy.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface ToyResponse extends ResponseBase {
     id: number;
     item: NameIdKey;
@@ -1693,11 +2339,19 @@ interface Source {
     name: string;
 }
 
+/**
+ * The response for a WoW token.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
 interface WowTokenResponse extends ResponseBase {
     last_updated_timestamp: number;
     price: number;
 }
 
+/**
+ * The Blizzard API for World of Warcraft.
+ * @see https://develop.battle.net/documentation/world-of-warcraft
+ */
 declare const wow: {
     wowToken: () => {
         path: string;
@@ -2303,7 +2957,7 @@ declare const wow: {
         path: string;
         namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
         parameters?: Record<string, never> | undefined;
-        _responseType?: ItemSubclassResponse | undefined;
+        _responseType?: ItemSubClassResponse | undefined;
     };
     itemClassIndex: () => {
         path: string;
@@ -2541,4 +3195,4 @@ declare const wow: {
     };
 };
 
-export { type AchievementCategoryIndexResponse, type AchievementCategoryResponse, type AchievementIndexResponse, type AchievementMediaResponse, type AchievementResponse, type AuctionHouseCommoditiesResponse, type AuctionHouseResponse, type AzeriteEssenceIndexResponse, type AzeriteEssenceMediaResponse, type AzeriteEssenceResponse, type AzeriteEssenceSearchParameters, type AzeriteEssenceSearchResponseItem, type ConduitIndexResponse, type ConduitResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CovenantIndexResponse, type CovenantMediaResponse, type CovenantResponse, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type Effect, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type HeirloomIndexResponse, type HeirloomResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSetIndexResponse, type ItemSetResponse, type ItemSubclassResponse, type JournalEncounterIndexResponse, type JournalEncounterResponse, type JournalEncounterSearchParameters, type JournalEncounterSearchResponseItem, type JournalExpansionIndexResponse, type JournalExpansionResponse, type JournalInstanceIndexResponse, type JournalInstanceMediaResponse, type JournalInstanceResponse, type ModifiedCraftingCategoryIndexResponse, type ModifiedCraftingCategoryResponse, type ModifiedCraftingIndexResponse, type ModifiedCraftingReagentSlotTypeIndexResponse, type ModifiedCraftingReagentSlotTypeResponse, type MountIndexResponse, type MountResponse, type MountSearchParameters, type MountSearchResponseItem, type MythicKeystoneAffixIndexResponse, type MythicKeystoneAffixMediaResponse, type MythicKeystoneAffixResponse, type MythicKeystoneDungeonIndexResponse, type MythicKeystoneDungeonResponse, type MythicKeystoneIndexResponse, type MythicKeystoneLeaderboardIndexResponse, type MythicKeystoneLeaderboardResponse, type MythicKeystonePeriodIndexResponse, type MythicKeystonePeriodResponse, type MythicKeystoneSeasonIndexResponse, type MythicKeystoneSeasonResponse, type MythicRaidLeaderboardResponse, type PetAbilityIndexResponse, type PetAbilityMediaResponse, type PetAbilityResponse, type PetIndexResponse, type PetMediaResponse, type PetResponse, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PlayableSpecializationIndexResponse, type PlayableSpecializationMediaResponse, type PlayableSpecializationResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type ProfessionIndexResponse, type ProfessionMediaResponse, type ProfessionResponse, type ProfessionSkillTierResponse, type PvpLeaderboardIndexResponse, type PvpLeaderboardResponse, type PvpRewardsIndexResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type PvpTalentIndexResponse, type PvpTalentResponse, type PvpTalentSlotsResponse, type PvpTierIndexResponse, type PvpTierMediaResponse, type PvpTierResponse, type QuestAreaIndexResponse, type QuestAreaResponse, type QuestCategoryIndexResponse, type QuestCategoryResponse, type QuestIndexResponse, type QuestResponse, type QuestTypeIndexResponse, type QuestTypeResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RecipeMediaResponse, type RecipeResponse, type RegionIndexResponse, type RegionResponse, type ReputationFactionIndexResponse, type ReputationFactionResponse, type ReputationTiersIndexResponse, type ReputationTiersResponse, type SoulbindIndexResponse, type SoulbindResponse, type SpellMediaResponse, type SpellResponse, type SpellSearchParameters, type SpellSearchResponseItem, type TalentIndexResponse, type TalentResponse, type TalentTreeIndexResponse, type TalentTreeNodesResponse, type TalentTreeResponse, type TechTalentIndexResponse, type TechTalentMediaResponse, type TechTalentResponse, type TechTalentTreeIndexResponse, type TechTalentTreeResponse, type TitleIndexResponse, type TitleResponse, type ToyIndexResponse, type ToyResponse, type WithoutUnderscore, type WowTokenResponse, wow };
+export { type AchievementCategoryIndexResponse, type AchievementCategoryResponse, type AchievementIndexResponse, type AchievementMediaResponse, type AchievementResponse, type AuctionHouseCommoditiesResponse, type AuctionHouseResponse, type AzeriteEssenceIndexResponse, type AzeriteEssenceMediaResponse, type AzeriteEssenceResponse, type AzeriteEssenceSearchParameters, type AzeriteEssenceSearchResponseItem, type ConduitIndexResponse, type ConduitResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CovenantIndexResponse, type CovenantMediaResponse, type CovenantResponse, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type HeirloomIndexResponse, type HeirloomResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSetIndexResponse, type ItemSetResponse, type ItemSubClassResponse, type JournalEncounterIndexResponse, type JournalEncounterResponse, type JournalEncounterSearchParameters, type JournalEncounterSearchResponseItem, type JournalExpansionIndexResponse, type JournalExpansionResponse, type JournalInstanceIndexResponse, type JournalInstanceMediaResponse, type JournalInstanceResponse, type MediaSearchParameters, type MediaSearchResponseItem, type ModifiedCraftingCategoryIndexResponse, type ModifiedCraftingCategoryResponse, type ModifiedCraftingIndexResponse, type ModifiedCraftingReagentSlotTypeIndexResponse, type ModifiedCraftingReagentSlotTypeResponse, type MountIndexResponse, type MountResponse, type MountSearchParameters, type MountSearchResponseItem, type MythicKeystoneAffixIndexResponse, type MythicKeystoneAffixMediaResponse, type MythicKeystoneAffixResponse, type MythicKeystoneDungeonIndexResponse, type MythicKeystoneDungeonResponse, type MythicKeystoneIndexResponse, type MythicKeystoneLeaderboardIndexResponse, type MythicKeystoneLeaderboardResponse, type MythicKeystonePeriodIndexResponse, type MythicKeystonePeriodResponse, type MythicKeystoneSeasonIndexResponse, type MythicKeystoneSeasonResponse, type MythicRaidLeaderboardResponse, type PetAbilityIndexResponse, type PetAbilityMediaResponse, type PetAbilityResponse, type PetIndexResponse, type PetMediaResponse, type PetResponse, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PlayableSpecializationIndexResponse, type PlayableSpecializationMediaResponse, type PlayableSpecializationResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type ProfessionIndexResponse, type ProfessionMediaResponse, type ProfessionResponse, type ProfessionSkillTierResponse, type PvpLeaderboardIndexResponse, type PvpLeaderboardResponse, type PvpRewardsIndexResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type PvpTalentIndexResponse, type PvpTalentResponse, type PvpTalentSlotsResponse, type PvpTierIndexResponse, type PvpTierMediaResponse, type PvpTierResponse, type QuestAreaIndexResponse, type QuestAreaResponse, type QuestCategoryIndexResponse, type QuestCategoryResponse, type QuestIndexResponse, type QuestResponse, type QuestTypeIndexResponse, type QuestTypeResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RecipeMediaResponse, type RecipeResponse, type RegionIndexResponse, type RegionResponse, type ReputationFactionIndexResponse, type ReputationFactionResponse, type ReputationTiersIndexResponse, type ReputationTiersResponse, type SoulbindIndexResponse, type SoulbindResponse, type SpellMediaResponse, type SpellResponse, type SpellSearchParameters, type SpellSearchResponseItem, type TalentIndexResponse, type TalentResponse, type TalentTreeIndexResponse, type TalentTreeNodesResponse, type TalentTreeResponse, type TechTalentIndexResponse, type TechTalentMediaResponse, type TechTalentResponse, type TechTalentTreeIndexResponse, type TechTalentTreeResponse, type TitleIndexResponse, type TitleResponse, type ToyIndexResponse, type ToyResponse, type WithoutUnderscore, type WowTokenResponse, wow };