@pinta365/blizzard_api 0.4.0 → 0.6.0

package/esm/src/generated/wow_api.d.ts

@@ -0,0 +1,1482 @@
+import type { AccountCollectionsIndex, AccountDecorCollection, AccountHeirloomsCollection, AccountMountsCollection, AccountPetsCollection, AccountProfileSummary, AccountToysCollection, AccountTransmogsCollection, ProtectedCharacterProfile } from "../wow/profile/account_profile.js";
+import type { Achievement, AchievementCategories, AchievementCategory, AchievementMedia, Achievements } from "../wow/game_data/achievement.js";
+import type { Auctions, Commodities } from "../wow/game_data/auction_house.js";
+import type { AzeriteEssenceDetails, AzeritEessenceMedia, AzeriteEssences } from "../wow/game_data/azerite_essence.js";
+import type { CharacterAchievementStatistics, CharacterAchievementSummary } from "../wow/profile/character_achievements.js";
+import type { CharacterAppearanceSummary } from "../wow/profile/character_appearance.js";
+import type { CharacterCollectionDecor, CharacterCollectionHeirlooms, CharacterCollectionMounts, CharacterCollectionPets, CharacterCollectionToys, CharacterCollectionTransmogs, CharacterCollectionTypes } from "../wow/profile/character_collections.js";
+import type { CharacterCompletedQuests, CharacterQuests } from "../wow/profile/character_quests.js";
+import type { CharacterEncounterDungeons, CharacterEncounterRaids, CharacterEncounters } from "../wow/profile/character_encounters.js";
+import type { CharacterHouse } from "../wow/profile/character_house.js";
+import type { CharacterHunterPets } from "../wow/profile/character_hunter_pets.js";
+import type { CharacterMedia } from "../wow/profile/character_media.js";
+import type { CharacterMythicKeystoneProfile, CharacterMythicKeystoneSeasonDetails } from "../wow/profile/character_mythic_keystone_profile.js";
+import type { CharacterProfessions } from "../wow/profile/character_professions.js";
+import type { CharacterProfile, CharacterProfileStatus } from "../wow/profile/character_profile.js";
+import type { CharacterPvpBracketStatistics, CharacterPvpSummary } from "../wow/profile/character_pvp.js";
+import type { CharacterReputations } from "../wow/profile/character_reputations.js";
+import type { CharacterSoulbinds } from "../wow/profile/character_soulbinds.js";
+import type { CharacterSpecializations } from "../wow/profile/character_specializations.js";
+import type { CharacterStatistics } from "../wow/profile/character_statistics.js";
+import type { CharacterTitles } from "../wow/profile/character_titles.js";
+import type { ConnectedRealm, ConnectedRealms } from "../wow/game_data/connected_realm.js";
+import type { Covenant, CovenantConduit, CovenantConduits, Covenants, CovenantSoulbind, CovenantSoulbinds } from "../wow/game_data/covenant.js";
+import type { Creature, CreatureDisplayMedia, CreatureFamilies, CreatureFamily, CreatureFamilyMedia, CreatureType, CreatureTypes } from "../wow/game_data/creature.js";
+import type { Decor, Decors, Fixture, FixtureHook, FixtureHooks, Fixtures, Room, Rooms } from "../wow/game_data/housing.js";
+import type { Guild, GuildAchievements, GuildActivity, GuildRoster } from "../wow/profile/guild.js";
+import type { GuildCrestBorder, GuildCrestEmblem, GuildCrests } from "../wow/game_data/guild_crest.js";
+import type { Heirloom, Heirlooms } from "../wow/game_data/heirloom.js";
+import type { Item, ItemClass, ItemClasses, ItemMedia, ItemSet, ItemSets, ItemSubclass } from "../wow/game_data/item.js";
+import type { ItemAppearance, ItemAppearanceSearch, ItemAppearanceSet, ItemAppearanceSets, ItemAppearanceSlot, ItemAppearanceSlots } from "../wow/game_data/item_appearance.js";
+import type { JournalEncounter, JournalEncounters, JournalExpansion, JournalExpansions, JournalInstance, JournalInstanceMedia, JournalInstances } from "../wow/game_data/journal.js";
+import type { KeystoneAffix, KeystoneAffixes, KeystoneAffixMedia } from "../wow/game_data/keystone_affix.js";
+import type { ModifiedCraftingCategories, ModifiedCraftingCategory, ModifiedCraftingParents, ModifiedCraftingSlotType, ModifiedCraftingSlotTypes } from "../wow/game_data/modified_crafting.js";
+import type { Mount, Mounts } from "../wow/game_data/mount.js";
+import type { MythicKeystoneDungeon, MythicKeystoneDungeons, MythicKeystoneIndex, MythicKeystonePeriod, MythicKeystonePeriods, MythicKeystoneSeason, MythicKeystoneSeasons } from "../wow/game_data/mythic_keystone_dungeon.js";
+import type { MythicKeystoneLeaderboard, MythicKeystoneLeaderboards } from "../wow/game_data/mythic_keystone_leaderboard.js";
+import type { MythicRaidLeaderboard } from "../wow/game_data/mythic_raid_leaderboard.js";
+import type { Neighborhood, NeighborhoodMap, NeighborhoodMaps } from "../wow/game_data/neighborhood.js";
+import type { Pet, PetAbilities, PetAbility, PetAbilityMedia, PetMedia, Pets } from "../wow/game_data/pet.js";
+import type { PlayableClass, PlayableClasses, PlayableClassMedia, PlayableClassPvpTalentSlots } from "../wow/game_data/playable_class.js";
+import type { PlayableRace, PlayableRaces } from "../wow/game_data/playable_race.js";
+import type { PlayableSpecialization, PlayableSpecializationMedia, PlayableSpecializations } from "../wow/game_data/playable_specialization.js";
+import type { PowerType, PowerTypes } from "../wow/game_data/power_type.js";
+import type { Profession, ProfessionMedia, ProfessionRecipie, professionRecipieMedia, Professions, ProfessionSkillTier } from "../wow/game_data/profession.js";
+import type { PvpSeason, PvpSeasonLeaderboard, PvpSeasonLeaderboards, PvpSeasonRewards, PvpSeasons } from "../wow/game_data/pvp_season.js";
+import type { PvpTalent, PvpTalents, Talent, Talents, TalentTree, TalentTreeNodes, TalentTrees } from "../wow/game_data/talent.js";
+import type { PvpTier, PvpTierMedia, PvpTiers } from "../wow/game_data/pvp_tier.js";
+import type { Quest, QuestArea, QuestAreas, QuestCategories, QuestCategory, Quests, QuestType, QuestTypes } from "../wow/game_data/quest.js";
+import type { Realm, Realms } from "../wow/game_data/realm.js";
+import type { Region, Regions } from "../wow/game_data/region.js";
+import type { ReputationFaction, ReputationFactions, ReputationTier, ReputationTiers } from "../wow/game_data/reputations.js";
+import type { Search, SearchParameters } from "../wow/search.js";
+import type { Spell, SpellMedia } from "../wow/game_data/spell.js";
+import type { TechTalent, TechTalentMedia, TechTalents, TechTalentTree, TechTalentTrees } from "../wow/game_data/tech_talent.js";
+import type { Title, Titles } from "../wow/game_data/title.js";
+import type { Toy, Toys } from "../wow/game_data/toy.js";
+import type { WowToken } from "../wow/game_data/token.js";
+import type { characterEquipments } from "../wow/profile/character_equipment.js";
+/**
+ * World of Warcraft endpoints.
+ */
+export interface WowApi {
+    /**
+     * Returns an index of collection types for an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object with links to the account's collections.
+     */
+    accountCollectionsIndex(): Promise<AccountCollectionsIndex>;
+    /**
+     * Returns the housing decor collected by an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account's decor.
+     */
+    accountDecorCollection(): Promise<AccountDecorCollection>;
+    /**
+     * Returns the heirlooms collected by an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account's heirlooms.
+     */
+    accountHeirloomsCollection(): Promise<AccountHeirloomsCollection>;
+    /**
+     * Returns the mounts collected by an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account's mounts.
+     */
+    accountMountsCollection(): Promise<AccountMountsCollection>;
+    /**
+     * Returns the battle pets collected by an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account's pets.
+     */
+    accountPetsCollection(): Promise<AccountPetsCollection>;
+    /**
+     * Returns a profile summary for an account, including its WoW accounts and characters.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account profile summary.
+     */
+    accountProfileSummary(): Promise<AccountProfileSummary>;
+    /**
+     * Returns the toys collected by an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account's toys.
+     */
+    accountToysCollection(): Promise<AccountToysCollection>;
+    /**
+     * Returns the transmog appearances and sets collected by an account.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account's transmogs.
+     */
+    accountTransmogsCollection(): Promise<AccountTransmogsCollection>;
+    /**
+     * Fetches and returns details of a specific achievement identified by its ID.
+     *
+     * @param achievementId - The unique identifier of the achievement to retrieve.
+     * @returns A promise that resolves to an object representing the achievement details.
+     */
+    achievement(achievementId: number): Promise<Achievement>;
+    /**
+     * Fetches and returns an index of achievement categories.
+     *
+     * @returns A promise that resolves to an object representing the index of achievement categories.
+     */
+    achievementCategories(): Promise<AchievementCategories>;
+    /**
+     * Fetches and returns details of a specific achievement category identified by its ID.
+     *
+     * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
+     * @returns A promise that resolves to an object representing the achievement category details.
+     */
+    achievementCategory(achievementCategoryId: number): Promise<AchievementCategory>;
+    /**
+     * Fetches and returns media details for a specific achievement identified by its ID.
+     *
+     * @param achievementId - The unique identifier of the achievement to retrieve media details for.
+     * @returns A promise that resolves to an object representing the achievement media details.
+     */
+    achievementMedia(achievementId: number): Promise<AchievementMedia>;
+    /**
+     * Fetches and returns an index of achievements.
+     *
+     * @returns A promise that resolves to an object representing the index of achievements.
+     */
+    achievements(): Promise<Achievements>;
+    /**
+     * Returns all active auctions for a connected realm.
+     *
+     * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
+     *
+     * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
+     *
+     * @param connectedRealmId - The id of the connected realm to return auctions from.
+     * @returns A promise that resolves to an object representing the auctions being listed.
+     */
+    auctions(connectedRealmId: number): Promise<Auctions>;
+    /**
+     * Returns details about a specific Azerite Essence Id
+     *
+     * @param azeriteEssenceId - The unique identifier Azerite Essence.
+     * @returns A promise that resolves to an object representing details about an Azerite Essences.
+     */
+    azeriteEssence(azeriteEssenceId: number): Promise<AzeriteEssenceDetails>;
+    /**
+     * Returns media details about a specific Azerite Essence Id
+     *
+     * @param azeriteEssenceId - The unique identifier Azerite Essence.
+     * @returns A promise that resolves to an object representing media details about an Azerite Essences.
+     */
+    azeriteEssenceMedia(azeriteEssenceId: number): Promise<AzeritEessenceMedia>;
+    /**
+     * Returns Azerite Essences Index
+     *
+     * @returns A promise that resolves to an object representing a list of all Azerite Essences.
+     */
+    azeriteEssences(): Promise<AzeriteEssences>;
+    /**
+     * Returns a character's statistics as they pertain to achievements.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about a characters achievement statistics.
+     */
+    characterAchievementStatistics(realmSlug: string, characterName: string): Promise<CharacterAchievementStatistics>;
+    /**
+     * Returns a summary of the achievements a character has completed.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about a characters achievement summary.
+     */
+    characterAchievementSummary(realmSlug: string, characterName: string): Promise<CharacterAchievementSummary>;
+    /**
+     * Returns a summary of a character's appearance settings.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about a character's appearance settings.
+     */
+    characterAppearanceSummary(realmSlug: string, characterName: string): Promise<CharacterAppearanceSummary>;
+    /**
+     * Returns a summary of the housing decor collection a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about decor a character has collected.
+     */
+    characterCollectionDecor(realmSlug: string, characterName: string): Promise<CharacterCollectionDecor>;
+    /**
+     * Returns a summary of the heirlooms a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about heirlooms a character has obtained.
+     */
+    characterCollectionHeirlooms(realmSlug: string, characterName: string): Promise<CharacterCollectionHeirlooms>;
+    /**
+     * Returns a summary of the mounts a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about mounts a character has obtained.
+     */
+    characterCollectionMounts(realmSlug: string, characterName: string): Promise<CharacterCollectionMounts>;
+    /**
+     * Returns a summary of the pets a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about pets a character has obtained.
+     */
+    characterCollectionPets(realmSlug: string, characterName: string): Promise<CharacterCollectionPets>;
+    /**
+     * Returns a summary of the toys a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about toys a character has obtained.
+     */
+    characterCollectionToys(realmSlug: string, characterName: string): Promise<CharacterCollectionToys>;
+    /**
+     * Returns a summary of the transmog appearances a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about transmog appearances a character has collected.
+     */
+    characterCollectionTransmogs(realmSlug: string, characterName: string): Promise<CharacterCollectionTransmogs>;
+    /**
+     * Returns an index of collection types for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about collection types for a character.
+     */
+    characterCollectionTypes(realmSlug: string, characterName: string): Promise<CharacterCollectionTypes>;
+    /**
+     * Returns a list of quests that a character has completed.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a list of quests that a character has completed.
+     */
+    characterCompletedQuests(realmSlug: string, characterName: string): Promise<CharacterCompletedQuests>;
+    /**
+     * Returns a summary of a character's completed dungeons.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about character's completed dungeons.
+     */
+    characterEncounterDungeons(realmSlug: string, characterName: string): Promise<CharacterEncounterDungeons>;
+    /**
+     * Returns a summary of a character's completed raids.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about character's completed raids.
+     */
+    characterEncounterRaids(realmSlug: string, characterName: string): Promise<CharacterEncounterRaids>;
+    /**
+     * Returns a summary of a character's encounters.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about character's encounters.
+     */
+    characterEncounters(realmSlug: string, characterName: string): Promise<CharacterEncounters>;
+    /**
+     * Returns a summary of the items equipped by a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about items equipped by a character.
+     */
+    characterEquipments(realmSlug: string, characterName: string): Promise<characterEquipments>;
+    /**
+     * Returns a summary of a house a character has built.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @param houseNumber - The number of the character's house (e.g. 1 for house-1).
+     */
+    characterHouse(realmSlug: string, characterName: string, houseNumber: number): Promise<CharacterHouse>;
+    /**
+     * If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of the character's hunter pets.
+     */
+    characterHunterPets(realmSlug: string, characterName: string): Promise<CharacterHunterPets>;
+    /**
+     * Returns a summary of the media assets available for a character (such as an avatar render).
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of the media assets available for a character.
+     */
+    characterMedia(realmSlug: string, characterName: string): Promise<CharacterMedia>;
+    /**
+     * Returns the Mythic Keystone profile index for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a Mythic Keystone profile.
+     */
+    characterMythicKeystoneProfile(realmSlug: string, characterName: string): Promise<CharacterMythicKeystoneProfile>;
+    /**
+     * 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.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @param seasonId - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a Mythic Keystone season details.
+     */
+    characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): Promise<CharacterMythicKeystoneSeasonDetails>;
+    /**
+     * Returns a summary of professions for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of professions for a character.
+     */
+    characterProfessions(realmSlug: string, characterName: string): Promise<CharacterProfessions>;
+    /**
+     * Returns a profile summary for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a profile summary.
+     */
+    characterProfile(realmSlug: string, characterName: string): Promise<CharacterProfile>;
+    /**
+     * 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:
+     *
+     * an HTTP 404 Not Found error is returned
+     * the is_valid value is false
+     * the returned character ID doesn't match the previously recorded value for the character
+     *
+     * The following example illustrates how to use this endpoint:
+     *
+     * A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
+     * After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
+     * If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
+     * If the character is valid and the character IDs match, the client retains the data for another 30 days.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a profile summary status.
+     */
+    characterProfileStatus(realmSlug: string, characterName: string): Promise<CharacterProfileStatus>;
+    /**
+     * Returns the PvP bracket statistics for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @param pvpBracket - The PvP bracket type.
+     * @returns A promise that resolves to an object representing the PvP bracket statistics for a character.
+     */
+    characterPvpBracketStatistics(realmSlug: string, characterName: string, pvpBracket: string): Promise<CharacterPvpBracketStatistics>;
+    /**
+     * Returns a PvP summary for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing the PvP summary for a character.
+     */
+    characterPvpSummary(realmSlug: string, characterName: string): Promise<CharacterPvpSummary>;
+    /**
+     * Returns a character's active quests as well as a link to the character's completed quests.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a character's active quests as well as a link to the character's completed quests.
+     */
+    characterQuests(realmSlug: string, characterName: string): Promise<CharacterQuests>;
+    /**
+     * Returns a summary of a character's reputations.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a character's reputations.
+     */
+    characterReputations(realmSlug: string, characterName: string): Promise<CharacterReputations>;
+    /**
+     * Returns a character's soulbinds.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a character's soulbinds.
+     */
+    characterSoulbinds(realmSlug: string, characterName: string): Promise<CharacterSoulbinds>;
+    /**
+     * Returns a summary of a character's specializations.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of a character's specializations.
+     */
+    characterSpecializations(realmSlug: string, characterName: string): Promise<CharacterSpecializations>;
+    /**
+     * Returns a statistics summary for a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a statistics summary for a character.
+     */
+    characterStatistics(realmSlug: string, characterName: string): Promise<CharacterStatistics>;
+    /**
+     * Returns a summary of titles a character has obtained.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of titles a character has obtained.
+     */
+    characterTitles(realmSlug: string, characterName: string): Promise<CharacterTitles>;
+    /**
+     * Returns all active auctions for commodity items for the entire game region.
+     *
+     * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
+     *
+     * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
+     *
+     * @returns A promise that resolves to an object representing the commodities being listed.
+     */
+    commodities(): Promise<Commodities>;
+    /**
+     * Returns details about a Connected Realms Id
+     *
+     * @param connectedRealmId - The unique identifier Connected Realms.
+     * @returns A promise that resolves to an object representing details about an Connected Realms.
+     */
+    connectedRealm(connectedRealmId: number): Promise<ConnectedRealm>;
+    /**
+     * Returns the Connected Realms Index
+     *
+     * @returns A promise that resolves to an object representing a list of all Connected Realms.
+     */
+    connectedRealms(): Promise<ConnectedRealms>;
+    /**
+     * Returns details about a Covenant
+     *
+     * @param covenantId - The unique identifier for the Covenant
+     * @returns A promise that resolves to an object representing details about a Covenant.
+     */
+    covenant(covenantId: number): Promise<Covenant>;
+    /**
+     * Returns details about a Covenant Conduit
+     *
+     * @param conduitId - The unique identifier for the Covenant Conduit
+     * @returns A promise that resolves to an object representing details about a Covenant Conduit.
+     */
+    covenantConduit(conduitId: number): Promise<CovenantConduit>;
+    /**
+     * Returns an index of Covenant Conduits.
+     *
+     * @returns A promise that resolves to an object representing a list of all Covenant Conduits.
+     */
+    covenantConduits(): Promise<CovenantConduits>;
+    /**
+     * Returns an index of Covenants.
+     *
+     * @returns A promise that resolves to an object representing a list of all Covenants.
+     */
+    covenants(): Promise<Covenants>;
+    /**
+     * Returns details about a Covenant Soulbind
+     *
+     * @param soulbindId - The unique identifier for the Covenant Soulbind
+     * @returns A promise that resolves to an object representing details about a Covenant Soulbind.
+     */
+    covenantSoulbind(soulbindId: number): Promise<CovenantSoulbind>;
+    /**
+     * Returns an index of Covenant Soulbinds.
+     *
+     * @returns A promise that resolves to an object representing a list of all Covenant Soulbinds.
+     */
+    covenantSoulbinds(): Promise<CovenantSoulbinds>;
+    /**
+     * Returns details about a creature
+     *
+     * @param creatureId - The unique identifier for the creature
+     * @returns A promise that resolves to an object representing details about a creature.
+     */
+    creature(creatureId: number): Promise<Creature>;
+    /**
+     * Returns media details about a specific Creature display
+     *
+     * @param creatureDisplayId - The unique identifier Creature display Id.
+     * @returns A promise that resolves to an object representing media details about a Creature display.
+     */
+    creatureDisplayMedia(creatureDisplayId: number): Promise<CreatureDisplayMedia>;
+    /**
+     * Returns an index of creature families.
+     *
+     * @returns A promise that resolves to an object representing a list of all creature families.
+     */
+    creatureFamilies(): Promise<CreatureFamilies>;
+    /**
+     * Returns details about a creature family
+     *
+     * @param creatureFamilyId - The unique identifier for the creature family
+     * @returns A promise that resolves to an object representing details about a creature family.
+     */
+    creatureFamily(creatureFamilyId: number): Promise<CreatureFamily>;
+    /**
+     * Returns media details about a specific Creature family
+     *
+     * @param creatureFamilyId - The unique identifier Creature family Id.
+     * @returns A promise that resolves to an object representing media details about a Creature family.
+     */
+    creatureFamilyMedia(creatureFamilyId: number): Promise<CreatureFamilyMedia>;
+    /**
+     * Returns details about a creature types
+     *
+     * @param creatureTypeId - The unique identifier for the creature types
+     * @returns A promise that resolves to an object representing details about a creature types.
+     */
+    creatureType(creatureTypeId: number): Promise<CreatureType>;
+    /**
+     * Returns an index of creature types.
+     *
+     * @returns A promise that resolves to an object representing a list of all creature types.
+     */
+    creatureTypes(): Promise<CreatureTypes>;
+    /**
+     * Returns a decor by ID.
+     *
+     * @param decorId - The ID of the decor.
+     */
+    decor(decorId: number): Promise<Decor>;
+    /**
+     * Returns an index of decor.
+     */
+    decors(): Promise<Decors>;
+    /**
+     * Returns a fixture by ID.
+     *
+     * @param fixtureId - The ID of the fixture.
+     */
+    fixture(fixtureId: number): Promise<Fixture>;
+    /**
+     * Returns a fixture hook by ID.
+     *
+     * @param fixtureHookId - The ID of the fixture hook.
+     */
+    fixtureHook(fixtureHookId: number): Promise<FixtureHook>;
+    /**
+     * Returns an index of fixture hooks.
+     */
+    fixtureHooks(): Promise<FixtureHooks>;
+    /**
+     * Returns an index of fixtures.
+     */
+    fixtures(): Promise<Fixtures>;
+    /**
+     * Returns a single guild by its name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild by its name and realm.
+     */
+    guild(realmSlug: string, nameSlug: string): Promise<Guild>;
+    /**
+     * Returns a single guild's achievements by name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild's achievements by its name and realm.
+     */
+    guildAchievements(realmSlug: string, nameSlug: string): Promise<GuildAchievements>;
+    /**
+     * Returns a single guild's activity by name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild's activity by its name and realm.
+     */
+    guildActivity(realmSlug: string, nameSlug: string): Promise<GuildActivity>;
+    /**
+     * Returns a Guild Crest Border Media
+     *
+     * @param borderId - The unique identifier for the Covenant
+     * @returns A promise that resolves to an object representing details about a Guild Crest Border Media.
+     */
+    guildCrestBorder(borderId: number): Promise<GuildCrestBorder>;
+    /**
+     * Returns a Crest Emblem Media
+     *
+     * @param emblemId - The unique identifier for the Crest Emblem Media
+     * @returns A promise that resolves to an object representing details about a Crest Emblem Media.
+     */
+    guildCrestEmblem(emblemId: number): Promise<GuildCrestEmblem>;
+    /**
+     * Returns the Guild Crest Components Index
+     *
+     * @returns A promise that resolves to an object representing a list of all Guild Crest Components.
+     */
+    guildCrests(): Promise<GuildCrests>;
+    /**
+     * Returns a single guild's roster by its name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild's roster by its name and realm.
+     */
+    guildRoster(realmSlug: string, nameSlug: string): Promise<GuildRoster>;
+    /**
+     * Returns a Heirloom
+     *
+     * @param heirloomId - The unique identifier for the Heirloom
+     * @returns A promise that resolves to an object representing details about a Heirloom.
+     */
+    heirloom(heirloomId: number): Promise<Heirloom>;
+    /**
+     * Returns the Heirloom Index
+     *
+     * @returns A promise that resolves to an object representing a list of all Heirlooms.
+     */
+    heirlooms(): Promise<Heirlooms>;
+    /**
+     * Returns an item by ID.
+     *
+     * @param itemId - The unique identifier for the item by ID.
+     * @returns A promise that resolves to an object representing details about an item by ID.
+     */
+    item(itemId: number): Promise<Item>;
+    /**
+     * Returns an item appearance by ID.
+     *
+     * @param appearanceId - The unique identifier for the item appearance by ID.
+     * @returns A promise that resolves to an object representing details about an item appearance.
+     */
+    itemAppearance(appearanceId: number): Promise<ItemAppearance>;
+    /**
+     * Returns an item appearance set by ID.
+     *
+     * @param appearanceSetId - The unique identifier for the item appearance set by ID.
+     * @returns A promise that resolves to an object representing details about an item appearance set.
+     */
+    itemAppearanceSet(appearanceSetId: number): Promise<ItemAppearanceSet>;
+    /**
+     * Returns a index of item appearance sets.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of item appearance sets.
+     */
+    itemAppearanceSets(): Promise<ItemAppearanceSets>;
+    /**
+     * Returns an item appearance slot by slot type.
+     *
+     * @param slotType - The slot type (e.g. "HEAD", "SHOULDER", "BODY").
+     * @returns A promise that resolves to an object representing details about an item appearance slot.
+     */
+    itemAppearanceSlot(slotType: string): Promise<ItemAppearanceSlot>;
+    /**
+     * Returns a index of item appearance slots.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of item appearance slots.
+     */
+    itemAppearanceSlots(): Promise<ItemAppearanceSlots>;
+    /**
+     * Returns an item class by ID.
+     *
+     * @param itemClassId - The unique identifier for the item class by ID.
+     * @returns A promise that resolves to an object representing details about an item class by ID.
+     */
+    itemClass(itemClassId: number): Promise<ItemClass>;
+    /**
+     * Returns an index of item classes.
+     *
+     * @returns A promise that resolves to an object representing a list of item classes.
+     */
+    itemClasses(): Promise<ItemClasses>;
+    /**
+     * Returns media details about a specific item Id
+     *
+     * @param itemId - The unique identifier for the item
+     * @returns A promise that resolves to an object representing media details about an item.
+     */
+    itemMedia(itemId: number): Promise<ItemMedia>;
+    /**
+     * Returns an item set by ID.
+     *
+     * @param itemSetId - The unique identifier for the item set by ID.
+     * @returns A promise that resolves to an object representing details about an item set by ID.
+     */
+    itemSet(itemSetId: number): Promise<ItemSet>;
+    /**
+     * Returns an index of item sets.
+     *
+     * @returns A promise that resolves to an object representing a list of item sets.
+     */
+    itemSets(): Promise<ItemSets>;
+    /**
+     * Returns an item subclass by ID.
+     *
+     * @param itemClassId - The unique identifier for the item class by ID.
+     * @param itemSubclassId - The unique identifier for the item subclass by ID.
+     * @returns A promise that resolves to an object representing details about an item set by ID.
+     */
+    itemSubclass(itemClassId: number, itemSubclassId: number): Promise<ItemSubclass>;
+    /**
+     * Returns a journal encounter by ID.
+     *
+     * @param journalEncounterId - The unique identifier for the journal encounter.
+     * @returns A promise that resolves to an object representing details about a journal encounter.
+     */
+    journalEncounter(journalEncounterId: number): Promise<JournalEncounter>;
+    /**
+     * Returns an index of journal encounters.
+     *
+     * @returns A promise that resolves to an object representing a list of journal expansions.
+     */
+    journalEncounters(): Promise<JournalEncounters>;
+    /**
+     * Returns a journal expansion by ID.
+     *
+     * @param journalExpansionId - The unique identifier for the journal expansion.
+     * @returns A promise that resolves to an object representing details about a journal expansion.
+     */
+    journalExpansion(journalExpansionId: number): Promise<JournalExpansion>;
+    /**
+     * Returns an index of journal expansions.
+     *
+     * @returns A promise that resolves to an object representing a list of journal expansions.
+     */
+    journalExpansions(): Promise<JournalExpansions>;
+    /**
+     * Returns a journal instances by ID.
+     *
+     * @param journalInstanceId - The unique identifier for the journal instances.
+     * @returns A promise that resolves to an object representing details about a journal instances.
+     */
+    journalInstance(journalInstanceId: number): Promise<JournalInstance>;
+    /**
+     * Returns media for a journal instance by ID.
+     *
+     * @param journalInstanceId - The unique identifier for the journal instance
+     * @returns A promise that resolves to an object representing media details about a journal instance.
+     */
+    journalInstanceMedia(journalInstanceId: number): Promise<JournalInstanceMedia>;
+    /**
+     * Returns an index of journal instances.
+     *
+     * @returns A promise that resolves to an object representing a list of journal instances.
+     */
+    journalInstances(): Promise<JournalInstances>;
+    /**
+     * Returns a mythic keystone affix by ID.
+     *
+     * @param keystoneAffixId - The unique identifier for the mythic keystone affix
+     * @returns A promise that resolves to an object representing details about a mythic keystone affix by ID.
+     */
+    keystoneAffix(keystoneAffixId: number): Promise<KeystoneAffix>;
+    /**
+     * Returns an index of mythic keystone affixes.
+     *
+     * @returns A promise that resolves to an object representing a list of the mythic keystone affixes.
+     */
+    keystoneAffixes(): Promise<KeystoneAffixes>;
+    /**
+     * Returns media for a mythic keystone affix by ID.
+     *
+     * @param keystoneAffixId - The unique identifier for the mythic keystone affix
+     * @returns A promise that resolves to an object representing media details about a mythic keystone affix.
+     */
+    keystoneAffixMedia(keystoneAffixId: number): Promise<KeystoneAffixMedia>;
+    /**
+     * Returns the index of Modified Crafting categories.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of Modified Crafting categories.
+     */
+    modifiedCraftingCategories(): Promise<ModifiedCraftingCategories>;
+    /**
+     * Returns a Modified Crafting category by ID.
+     *
+     * @param categoryId - The unique identifier for the Modified Crafting category
+     * @returns A promise that resolves to an object representing details about a Modified Crafting category.
+     */
+    modifiedCraftingCategory(categoryId: number): Promise<ModifiedCraftingCategory>;
+    /**
+     * Returns the parent index for Modified Crafting.
+     *
+     * @returns A promise that resolves to an object representing a list of the parent index for Modified Crafting.
+     */
+    modifiedCraftingParents(): Promise<ModifiedCraftingParents>;
+    /**
+     * Returns a Modified Crafting reagent slot type by ID.
+     *
+     * @param slotTypeId - The unique identifier for the Modified Crafting reagent slot type
+     * @returns A promise that resolves to an object representing details about a Modified Crafting reagent slot type by ID.
+     */
+    modifiedCraftingSlotType(slotTypeId: number): Promise<ModifiedCraftingSlotType>;
+    /**
+     * Returns the index of Modified Crafting reagent slot types.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of Modified Crafting reagent slot types
+     */
+    modifiedCraftingSlotTypes(): Promise<ModifiedCraftingSlotTypes>;
+    /**
+     * Returns a mount by ID.
+     *
+     * @param mountId - The unique identifier for the mount by ID.
+     * @returns A promise that resolves to an object representing details about a mount.
+     */
+    mount(mountId: number): Promise<Mount>;
+    /**
+     * Returns a index of mounts.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of mounts.
+     */
+    mounts(): Promise<Mounts>;
+    /**
+     * Returns a Mythic Keystone dungeon by ID.
+     *
+     * @param dungeonId - The unique identifier for the Mythic Keystone dungeon
+     * @returns A promise that resolves to an object representing details about a Mythic Keystone dungeon by ID.
+     */
+    mythicKeystoneDungeon(dungeonId: number): Promise<MythicKeystoneDungeon>;
+    /**
+     * Returns an index of Mythic Keystone dungeons.
+     *
+     * @returns A promise that resolves to an object representing a list of the Mythic Keystone dungeons.
+     */
+    mythicKeystoneDungeons(): Promise<MythicKeystoneDungeons>;
+    /**
+     * Returns an index of links to other documents related to Mythic Keystone dungeons.
+     *
+     * @returns A promise that resolves to an object representing a index of links to other documents related to Mythic Keystone dungeons.
+     */
+    mythicKeystoneIndex(): Promise<MythicKeystoneIndex>;
+    /**
+     * Returns a weekly Mythic Keystone Leaderboard by period.
+     *
+     * @param connectedRealmId - The unique identifier for the connected realm
+     * @param dungeonId - The unique identifier for the dungeon
+     * @param period - The unique identifier for the period
+     * @returns A promise that resolves to an object representing details about a weekly Mythic Keystone Leaderboard by period.
+     */
+    mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId: number, period: number): Promise<MythicKeystoneLeaderboard>;
+    /**
+     * Returns an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
+     *
+     * @param connectedRealmId - The unique identifier for the connected realm
+     * @returns A promise that resolves to an object representing an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
+     */
+    mythicKeystoneLeaderboards(connectedRealmId: number): Promise<MythicKeystoneLeaderboards>;
+    /**
+     * Returns a Mythic Keystone period by ID.
+     *
+     * @param periodId - The unique identifier for the Mythic Keystone period
+     * @returns A promise that resolves to an object representing details about a Mythic Keystone period by ID.
+     */
+    mythicKeystonePeriod(periodId: number): Promise<MythicKeystonePeriod>;
+    /**
+     * Returns an index of Mythic Keystone periods.
+     *
+     * @returns A promise that resolves to an object representing a index of Mythic Keystone periods.
+     */
+    mythicKeystonePeriods(): Promise<MythicKeystonePeriods>;
+    /**
+     * Returns a Mythic Keystone season by ID.
+     *
+     * @param seasonId - The unique identifier for the Mythic Keystone season
+     * @returns A promise that resolves to an object representing details about a Mythic Keystone season by ID.
+     */
+    mythicKeystoneSeason(seasonId: number): Promise<MythicKeystoneSeason>;
+    /**
+     * Returns an index of Mythic Keystone seasons.
+     *
+     * @returns A promise that resolves to an object representing a index of Mythic Keystone seasons
+     */
+    mythicKeystoneSeasons(): Promise<MythicKeystoneSeasons>;
+    /**
+     * Returns the leaderboard for a given raid and faction.
+     *
+     * @param raid - The slug of the raid (e.g. "uldir", "nyalotha-the-waking-city").
+     * @param faction - The faction, "alliance" or "horde".
+     * @returns A promise that resolves to an object representing the leaderboard for a given raid and faction.
+     */
+    mythicRaidLeaderboard(raid: string, faction: "alliance" | "horde"): Promise<MythicRaidLeaderboard>;
+    /**
+     * Returns a neighborhood by ID within a neighborhood map.
+     *
+     * @param neighborhoodMapId - The ID of the neighborhood map.
+     * @param neighborhoodId - The ID of the neighborhood.
+     */
+    neighborhood(neighborhoodMapId: number, neighborhoodId: number): Promise<Neighborhood>;
+    /**
+     * Returns a neighborhood map by ID.
+     *
+     * @param neighborhoodMapId - The ID of the neighborhood map.
+     */
+    neighborhoodMap(neighborhoodMapId: number): Promise<NeighborhoodMap>;
+    /**
+     * Returns an index of neighborhood maps.
+     */
+    neighborhoodMaps(): Promise<NeighborhoodMaps>;
+    /**
+     * Returns a battle pet by ID.
+     *
+     * @param petId - The unique identifier for the battle pet
+     * @returns A promise that resolves to an object representing details about a battle pet.
+     */
+    pet(petId: number): Promise<Pet>;
+    /**
+     * Returns an index of pet abilities.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of pet abilities.
+     */
+    petAbilities(): Promise<PetAbilities>;
+    /**
+     * Returns a pet ability by ID.
+     *
+     * @param petAbilityId - The unique identifier for the battle pet ability
+     * @returns A promise that resolves to an object representing details about a battle pet ability.
+     */
+    petAbility(petAbilityId: number): Promise<PetAbility>;
+    /**
+     * Returns media for a battle pet by ID.
+     *
+     * @param petAbilityId - The unique identifier for the battle pet
+     * @returns A promise that resolves to an object representing media details about a battle pet.
+     */
+    petAbilityMedia(petAbilityId: number): Promise<PetAbilityMedia>;
+    /**
+     * Returns media for a battle pet by ID.
+     *
+     * @param petId - The unique identifier for the battle pet
+     * @returns A promise that resolves to an object representing media details about a battle pet.
+     */
+    petMedia(petId: number): Promise<PetMedia>;
+    /**
+     * Returns an index of battle pets.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of battle pets.
+     */
+    pets(): Promise<Pets>;
+    /**
+     * Returns a playable class by ID.
+     *
+     * @param classId - The unique identifier for the playable class
+     * @returns A promise that resolves to an object representing details about a playable class.
+     */
+    playableClass(classId: number): Promise<PlayableClass>;
+    /**
+     * Returns an index of playable classes.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of playable classes.
+     */
+    playableClasses(): Promise<PlayableClasses>;
+    /**
+     * Returns media for a playable class by ID.
+     *
+     * @param playableClassId - The unique identifier for the playable class
+     * @returns A promise that resolves to an object representing media details about a playable class.
+     */
+    playableClassMedia(playableClassId: number): Promise<PlayableClassMedia>;
+    /**
+     * Returns the PvP talent slots for a playable class by ID.
+     *
+     * @param classId - The unique identifier for the playable class
+     * @returns A promise that resolves to an object representing PvP talent slots for a playable class.
+     */
+    playableClassPvpTalentSlots(classId: number): Promise<PlayableClassPvpTalentSlots>;
+    /**
+     * Returns a playable race by ID.
+     *
+     * @param playableRaceId - The unique identifier for the playable race
+     * @returns A promise that resolves to an object representing details about a playable race.
+     */
+    playableRace(playableRaceId: number): Promise<PlayableRace>;
+    /**
+     * Returns an index of playable races.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of playable races.
+     */
+    playableRaces(): Promise<PlayableRaces>;
+    /**
+     * Returns a playable specialization by ID.
+     *
+     * @param specId - The unique identifier for the playable specialization
+     * @returns A promise that resolves to an object representing details about a playable specialization.
+     */
+    playableSpecialization(specId: number): Promise<PlayableSpecialization>;
+    /**
+     * Returns media for a playable specialization by ID.
+     *
+     * @param specId - The unique identifier for the playable specialization
+     * @returns A promise that resolves to an object representing media details about a playable specialization.
+     */
+    playableSpecializationMedia(specId: number): Promise<PlayableSpecializationMedia>;
+    /**
+     * Returns an index of playable specializations.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of playable specializations.
+     */
+    playableSpecializations(): Promise<PlayableSpecializations>;
+    /**
+     * Returns a power type by ID.
+     *
+     * @param powerTypeId - The unique identifier for the power type.
+     * @returns A promise that resolves to an object representing details about a power type.
+     */
+    powerType(powerTypeId: number): Promise<PowerType>;
+    /**
+     * Returns an index of power types.
+     *
+     * @returns A promise that resolves to an object representing a list of power types.
+     */
+    powerTypes(): Promise<PowerTypes>;
+    /**
+     * Returns a profession by ID.
+     *
+     * @param professionId - The unique identifier for the profession.
+     * @returns A promise that resolves to an object representing details about a profession.
+     */
+    profession(professionId: number): Promise<Profession>;
+    /**
+     * Returns media for a profession by ID.
+     *
+     * @param professionId - The unique identifier for the profession
+     * @returns A promise that resolves to an object representing media details about a profession.
+     */
+    professionMedia(professionId: number): Promise<ProfessionMedia>;
+    /**
+     * Returns a recipe by ID.
+     *
+     * @param recipeId - The unique identifier for the recipe.
+     * @returns A promise that resolves to an object representing details about a recipe.
+     */
+    professionRecipie(recipeId: number): Promise<ProfessionRecipie>;
+    /**
+     * Returns media for a recipe by ID.
+     *
+     * @param recipeId - The unique identifier for the recipe
+     * @returns A promise that resolves to an object representing media details about a recipe.
+     */
+    professionRecipieMedia(recipeId: number): Promise<professionRecipieMedia>;
+    /**
+     * Returns an index of professions.
+     *
+     * @returns A promise that resolves to an object representing a list of professions.
+     */
+    professions(): Promise<Professions>;
+    /**
+     * Returns a skill tier for a profession by ID.
+     *
+     * @param professionId - The unique identifier for the profession
+     * @param skillTierId - The unique identifier for the skill tier
+     * @returns A promise that resolves to an object representing details about a skill tier.
+     */
+    professionSkillTier(professionId: number, skillTierId: number): Promise<ProfessionSkillTier>;
+    /**
+     * Returns a protected profile summary for a character (money, deaths, position, ...).
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @param realmId - The ID of the character's realm.
+     * @param characterId - The ID of the character.
+     * @returns A promise that resolves to an object representing the protected character profile.
+     */
+    protectedCharacterProfile(realmId: number, characterId: number): Promise<ProtectedCharacterProfile>;
+    /**
+     * Returns a PvP season by ID.
+     *
+     * @param pvpSeasonId - The unique identifier for the PvP season.
+     * @returns A promise that resolves to an object representing details about a PvP season.
+     */
+    pvpSeason(pvpSeasonId: number): Promise<PvpSeason>;
+    /**
+     * Returns the PvP leaderboard of a specific PvP bracket for a PvP season.
+     *
+     * @param pvpSeasonId - The unique identifier for the PvP season.
+     * @param pvpBracket - The name of the PvP bracket (e.g. "2v2", "3v3", "rbg", "shuffle-overall"), as listed by
+     * pvpSeasonLeaderboards().
+     * @returns A promise that resolves to an object representing details about the PvP bracket.
+     */
+    pvpSeasonLeaderboard(pvpSeasonId: number, pvpBracket: string): Promise<PvpSeasonLeaderboard>;
+    /**
+     * Returns an index of PvP leaderboards for a PvP season.
+     *
+     * @param pvpSeasonId - The unique identifier for the PvP season.
+     * @returns A promise that resolves to an object representing details about the PvP leaderboards.
+     */
+    pvpSeasonLeaderboards(pvpSeasonId: number): Promise<PvpSeasonLeaderboards>;
+    /**
+     * Returns an index of PvP rewards for a PvP season.
+     *
+     * @param pvpSeasonId - The unique identifier for the PvP season.
+     * @returns A promise that resolves to an object representing details about the PvP rewards.
+     */
+    pvpSeasonRewards(pvpSeasonId: number): Promise<PvpSeasonRewards>;
+    /**
+     * Returns an index of PvP seasons.
+     *
+     * @returns A promise that resolves to an object representing a list of PvP seasons.
+     */
+    pvpSeasons(): Promise<PvpSeasons>;
+    /**
+     * Returns a PvP talent by ID.
+     *
+     * @param pvpTalentId - The unique identifier for the PvP talent.
+     * @returns A promise that resolves to an object representing details about the PvP talent.
+     */
+    pvpTalent(pvpTalentId: number): Promise<PvpTalent>;
+    /**
+     * Returns an index of PvP talents.
+     *
+     * @returns A promise that resolves to an object representing a list of PvP talents.
+     */
+    pvpTalents(): Promise<PvpTalents>;
+    /**
+     * Returns a PvP tier by ID.
+     *
+     * @param pvpTierId - The unique identifier for the PvP tier.
+     * @returns A promise that resolves to an object representing details about a PvP tier.
+     */
+    pvpTier(pvpTierId: number): Promise<PvpTier>;
+    /**
+     * Returns media for a PvP tier by ID.
+     *
+     * @param pvpTierId - The unique identifier for the PvP tier
+     * @returns A promise that resolves to an object representing media details about a PvP tier.
+     */
+    pvpTierMedia(pvpTierId: number): Promise<PvpTierMedia>;
+    /**
+     * Returns an index of PvP tiers.
+     *
+     * @returns A promise that resolves to an object representing a list of PvP tiers.
+     */
+    pvpTiers(): Promise<PvpTiers>;
+    /**
+     * Returns a quest by ID.
+     *
+     * @param questId - The unique identifier for the quest.
+     * @returns A promise that resolves to an object representing details about a quest.
+     */
+    quest(questId: number): Promise<Quest>;
+    /**
+     * Returns a quest area by ID.
+     *
+     * @param questAreaId - The unique identifier for the quest area.
+     * @returns A promise that resolves to an object representing details about a quest area.
+     */
+    questArea(questAreaId: number): Promise<QuestArea>;
+    /**
+     * Returns an index of quest areas.
+     *
+     * @returns A promise that resolves to an object representing a list of quest areas.
+     */
+    questAreas(): Promise<QuestAreas>;
+    /**
+     * Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
+     *
+     * @returns A promise that resolves to an object representing a list of quest categories.
+     */
+    questCategories(): Promise<QuestCategories>;
+    /**
+     * Returns a quest category by ID.
+     *
+     * @param questCategoryId - The unique identifier for the quest category.
+     * @returns A promise that resolves to an object representing details about a quest category.
+     */
+    questCategory(questCategoryId: number): Promise<QuestCategory>;
+    /**
+     * Returns the parent index for quests.
+     *
+     * @returns A promise that resolves to an object representing a list of quests.
+     */
+    quests(): Promise<Quests>;
+    /**
+     * Returns a quest type by ID.
+     *
+     * @param questTypeId - The unique identifier for the quest type.
+     * @returns A promise that resolves to an object representing details about a quest type.
+     */
+    questType(questTypeId: number): Promise<QuestType>;
+    /**
+     * Returns an index of quest types (such as PvP quests, raid quests, or account quests).
+     *
+     * @returns A promise that resolves to an object representing a list of quest types.
+     */
+    questTypes(): Promise<QuestTypes>;
+    /**
+     * Returns a single realm by slug or ID.
+     *
+     * @param realmSlugOrId - The unique identifier for the realm.
+     * @returns A promise that resolves to an object representing details about a realm.
+     */
+    realm(realmSlugOrId: string | number): Promise<Realm>;
+    /**
+     * Returns an index of realms.
+     *
+     * @returns A promise that resolves to an object representing a list of realms.
+     */
+    realms(): Promise<Realms>;
+    /**
+     * Returns a region by ID.
+     *
+     * @param regionId - The unique identifier for the region.
+     * @returns A promise that resolves to an object representing details about a region.
+     */
+    region(regionId: number): Promise<Region>;
+    /**
+     * Returns an index of regions.
+     *
+     * @returns A promise that resolves to an object representing a list of regions.
+     */
+    regions(): Promise<Regions>;
+    /**
+     * Returns a single reputation faction by ID.
+     *
+     * @param reputationFactionId - The unique identifier for the reputation faction.
+     * @returns A promise that resolves to an object representing details about a reputation faction.
+     */
+    reputationFaction(reputationFactionId: string): Promise<ReputationFaction>;
+    /**
+     * Returns an index of reputation factions.
+     *
+     * @returns A promise that resolves to an object representing a list of reputation factions.
+     */
+    reputationFactions(): Promise<ReputationFactions>;
+    /**
+     * Returns a single set of reputation tiers by ID.
+     *
+     * @param reputationTiersId - The unique identifier for the reputation tier.
+     * @returns A promise that resolves to an object representing details about a reputation tier.
+     */
+    reputationTier(reputationTiersId: string): Promise<ReputationTier>;
+    /**
+     * Returns an index of reputation tiers.
+     *
+     * @returns A promise that resolves to an object representing a list of reputation tiers.
+     */
+    reputationTiers(): Promise<ReputationTiers>;
+    /**
+     * Returns a room by ID.
+     *
+     * @param roomId - The ID of the room.
+     */
+    room(roomId: number): Promise<Room>;
+    /**
+     * Returns an index of rooms.
+     */
+    rooms(): Promise<Rooms>;
+    /**
+     * Performs a search of azerite essences.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a Azerite Essences search.
+     */
+    searchAzeriteEssence(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of connected realms.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about the connected realms search.
+     */
+    searchConnectedRealm(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of creatures.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a creature search.
+     */
+    searchCreature(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of decor.
+     *
+     * @param searchParameters - Object containing search parameters.
+     */
+    searchDecor(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of fixtures.
+     *
+     * @param searchParameters - Object containing search parameters.
+     */
+    searchFixture(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of fixture hooks.
+     *
+     * @param searchParameters - Object containing search parameters.
+     */
+    searchFixtureHook(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of items.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about an item search.
+     */
+    searchItem(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of item appearances.
+     *
+     * @param searchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about an item appearance search.
+     */
+    searchItemAppearance(searchParameters: SearchParameters): Promise<ItemAppearanceSearch>;
+    /**
+     * Performs a search of journal encounters.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a journal encounter search.
+     */
+    searchJournalEncounter(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of media.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a media search.
+     */
+    searchMedia(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of mounts.
+     *
+     * @param searchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a mount search.
+     */
+    searchMount(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of realms.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a realm search.
+     */
+    searchRealm(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of rooms.
+     *
+     * @param searchParameters - Object containing search parameters.
+     */
+    searchRoom(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of spells.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a spell search.
+     */
+    searchSpell(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Returns a spell by ID.
+     *
+     * @param spellId - The unique identifier for the spell.
+     * @returns A promise that resolves to an object representing details about a spell.
+     */
+    spell(spellId: number): Promise<Spell>;
+    /**
+     * Returns media for a spell by ID.
+     *
+     * @param spellId - The unique identifier for the spell.
+     * @returns A promise that resolves to an object representing details about a spell.
+     */
+    spellMedia(spellId: number): Promise<SpellMedia>;
+    /**
+     * Returns a talent by ID.
+     *
+     * @param talentId - The unique identifier for the talent.
+     * @returns A promise that resolves to an object representing details about the talent.
+     */
+    talent(talentId: number): Promise<Talent>;
+    /**
+     * Returns an index of talents.
+     *
+     * @returns A promise that resolves to an object representing a list of talents.
+     */
+    talents(): Promise<Talents>;
+    /**
+     * Returns a talent tree by specialization ID.
+     *
+     * @param talentTreeId - The unique identifier for the talent tree.
+     * @param specId - The unique identifier for the specialization.
+     * @returns A promise that resolves to an object representing details about a talent tree.
+     */
+    talentTree(talentTreeId: number, specId: number): Promise<TalentTree>;
+    /**
+     * Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.
+     *
+     * @param talentTreeId - The unique identifier for the talent tree.
+     * @returns A promise that resolves to an object representing details about the talent tree nodes.
+     */
+    talentTreeNodes(talentTreeId: number): Promise<TalentTreeNodes>;
+    /**
+     * Returns an index of talent trees.
+     *
+     * @returns A promise that resolves to an object representing a list of talent trees.
+     */
+    talentTrees(): Promise<TalentTrees>;
+    /**
+     * Returns a tech talent by ID.
+     *
+     * @param techTalentId - The unique identifier for the tech talent tree.
+     * @returns A promise that resolves to an object representing details about the tech talent tree.
+     */
+    techTalent(techTalentId: number): Promise<TechTalent>;
+    /**
+     * Returns media for a tech talent by ID.
+     *
+     * @param techTalentId - The unique identifier for the tech talent.
+     * @returns A promise that resolves to an object representing details about a tech talent.
+     */
+    techTalentMedia(techTalentId: number): Promise<TechTalentMedia>;
+    /**
+     * Returns an index of tech talents.
+     *
+     * @returns A promise that resolves to an object representing a list of tech talents trees
+     */
+    techTalents(): Promise<TechTalents>;
+    /**
+     * Returns a tech talent tree by ID.
+     *
+     * @param techTalentTreeId - The unique identifier for the tech talent tree.
+     * @returns A promise that resolves to an object representing details about the tech talent tree.
+     */
+    techTalentTree(techTalentTreeId: number): Promise<TechTalentTree>;
+    /**
+     * Returns an index of tech talent trees.
+     *
+     * @returns A promise that resolves to an object representing a list of tech talents trees
+     */
+    techTalentTrees(): Promise<TechTalentTrees>;
+    /**
+     * Returns a title by ID.
+     *
+     * @param titleId - The unique identifier for the title.
+     * @returns A promise that resolves to an object representing details about a title.
+     */
+    title(titleId: number): Promise<Title>;
+    /**
+     * Returns an index of titles.
+     *
+     * @returns A promise that resolves to an object representing a list of titles.
+     */
+    titles(): Promise<Titles>;
+    /**
+     * Fetches and returns last known price and last updated timestamp for a wow token.
+     *
+     * @returns A promise that resolves to an object representing price and last updated timestamp.
+     */
+    token(): Promise<WowToken>;
+    /**
+     * Returns a toy by id.
+     *
+     * @param toyId - The unique identifier for the toy.
+     * @returns A promise that resolves to an object representing details about a toy.
+     */
+    toy(toyId: number): Promise<Toy>;
+    /**
+     * Returns an index of toys.
+     *
+     * @returns A promise that resolves to an object representing a list of toys.
+     */
+    toys(): Promise<Toys>;
+}