@pinta365/blizzard_api 0.7.1 → 0.8.0

package/script/src/generated/wow_forever_api.d.ts

@@ -0,0 +1,939 @@
+import type { AccountCollectionsIndex, AccountHeirloomsCollection, AccountMountsCollection, AccountPetsCollection, AccountToysCollection } from "../wow/profile/account_profile.js";
+import type { Achievement, AchievementCategory, AchievementMedia, Achievements } from "../wow/game_data/achievement.js";
+import type { Creature, CreatureDisplayMedia, CreatureFamilies, CreatureFamily, CreatureFamilyMedia, CreatureType, CreatureTypes } from "../wow/game_data/creature.js";
+import type { ForeverAccountProfileSummary, ForeverAccountTransmogsCollection } from "../wow_forever/account.js";
+import type { ForeverAchievementCategories, ForeverHeirlooms, ForeverItemAppearanceSearch, ForeverJournalEncounters, ForeverJournalExpansions, ForeverJournalInstances, ForeverMount, ForeverPet, ForeverPetAbilities, ForeverPlayableSpecialization, ForeverPlayableSpecializations, ForeverProfessionRecipie, ForeverQuest, ForeverReputationFaction, ForeverTalentTree, ForeverTalentTrees, ForeverTitle } from "../wow_forever/game_data.js";
+import type { ForeverCharacterAchievementStatistics, ForeverCharacterAchievementSummary, ForeverCharacterAppearanceSummary, ForeverCharacterCollectionHeirlooms, ForeverCharacterCollectionMounts, ForeverCharacterCollectionPets, ForeverCharacterCollectionToys, ForeverCharacterCollectionTransmogs, ForeverCharacterCollectionTypes, ForeverCharacterCompletedQuests, ForeverCharacterEncounterDungeons, ForeverCharacterEncounterRaids, ForeverCharacterEncounters, ForeverCharacterEquipment, ForeverCharacterMedia, ForeverCharacterMythicKeystoneProfile, ForeverCharacterProfessions, ForeverCharacterProfile, ForeverCharacterProfileStatus, ForeverCharacterPvpSummary, ForeverCharacterQuests, ForeverCharacterReputations, ForeverCharacterSpecializations, ForeverCharacterStatistics, ForeverCharacterTitles } from "../wow_forever/character.js";
+import type { ForeverGuild, ForeverGuildAchievements, ForeverGuildActivity, ForeverGuildRoster } from "../wow_forever/guild.js";
+import type { ForeverRuleset, ForeverRulesets } from "../wow_forever/ruleset.js";
+import type { GuildCrestBorder, GuildCrestEmblem, GuildCrests } from "../wow/game_data/guild_crest.js";
+import type { Heirloom } from "../wow/game_data/heirloom.js";
+import type { Item, ItemClass, ItemClasses, ItemMedia, ItemSet, ItemSets, ItemSubclass } from "../wow/game_data/item.js";
+import type { ItemAppearance, ItemAppearanceSet, ItemAppearanceSets, ItemAppearanceSlot, ItemAppearanceSlots } from "../wow/game_data/item_appearance.js";
+import type { JournalEncounter, JournalExpansion, JournalInstance, JournalInstanceMedia } from "../wow/game_data/journal.js";
+import type { Mounts } from "../wow/game_data/mount.js";
+import type { PetAbility, PetAbilityMedia, PetMedia, Pets } from "../wow/game_data/pet.js";
+import type { PlayableClass, PlayableClasses, PlayableClassMedia } from "../wow/game_data/playable_class.js";
+import type { PlayableRace, PlayableRaces } from "../wow/game_data/playable_race.js";
+import type { PlayableSpecializationMedia } from "../wow/game_data/playable_specialization.js";
+import type { PowerType, PowerTypes } from "../wow/game_data/power_type.js";
+import type { Profession, ProfessionMedia, professionRecipieMedia, Professions, ProfessionSkillTier } from "../wow/game_data/profession.js";
+import type { QuestArea, QuestAreas, QuestCategories, QuestCategory, Quests, QuestType, QuestTypes } from "../wow/game_data/quest.js";
+import type { Region, Regions } from "../wow/game_data/region.js";
+import type { 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 { Talent, Talents, TalentTreeNodes } from "../wow/game_data/talent.js";
+import type { Titles } from "../wow/game_data/title.js";
+import type { Toy, Toys } from "../wow/game_data/toy.js";
+/**
+ * World of Warcraft: Forever endpoints (game data and account profile).
+ */
+export interface WowForeverApi {
+    /**
+     * 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 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 Forever characters.
+     * Requires a user access token (client.forUser(token)).
+     *
+     * @returns A promise that resolves to an object representing the account profile summary.
+     */
+    accountProfileSummary(): Promise<ForeverAccountProfileSummary>;
+    /**
+     * 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<ForeverAccountTransmogsCollection>;
+    /**
+     * 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>;
+    /**
+     * Returns an index of achievement categories.
+     *
+     * @returns A promise that resolves to an object representing an index of achievement categories.
+     */
+    achievementCategories(): Promise<ForeverAchievementCategories>;
+    /**
+     * 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 a character's statistics as they pertain to achievements.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the achievement statistics.
+     */
+    characterAchievementStatistics(name: string, surname: string): Promise<ForeverCharacterAchievementStatistics>;
+    /**
+     * Returns a summary of the achievements a character has completed.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the achievement summary.
+     */
+    characterAchievementSummary(name: string, surname: string): Promise<ForeverCharacterAchievementSummary>;
+    /**
+     * Returns a summary of a character's appearance settings.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the appearance summary.
+     */
+    characterAppearanceSummary(name: string, surname: string): Promise<ForeverCharacterAppearanceSummary>;
+    /**
+     * Returns the heirlooms a character has collected.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the collected heirlooms.
+     */
+    characterCollectionHeirlooms(name: string, surname: string): Promise<ForeverCharacterCollectionHeirlooms>;
+    /**
+     * Returns the mounts a character has collected.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the collected mounts.
+     */
+    characterCollectionMounts(name: string, surname: string): Promise<ForeverCharacterCollectionMounts>;
+    /**
+     * Returns the battle pets a character has collected.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the collected pets.
+     */
+    characterCollectionPets(name: string, surname: string): Promise<ForeverCharacterCollectionPets>;
+    /**
+     * Returns the toys a character has collected.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the collected toys.
+     */
+    characterCollectionToys(name: string, surname: string): Promise<ForeverCharacterCollectionToys>;
+    /**
+     * Returns the transmog appearances a character has collected.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the collected transmogs.
+     */
+    characterCollectionTransmogs(name: string, surname: string): Promise<ForeverCharacterCollectionTransmogs>;
+    /**
+     * Returns an index of collection types for a character.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the collection index.
+     */
+    characterCollectionTypes(name: string, surname: string): Promise<ForeverCharacterCollectionTypes>;
+    /**
+     * Returns the quests a character has completed.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the completed quests.
+     */
+    characterCompletedQuests(name: string, surname: string): Promise<ForeverCharacterCompletedQuests>;
+    /**
+     * Returns a summary of a character's completed dungeons.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the completed dungeons.
+     */
+    characterEncounterDungeons(name: string, surname: string): Promise<ForeverCharacterEncounterDungeons>;
+    /**
+     * Returns a summary of a character's completed raids.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the completed raids.
+     */
+    characterEncounterRaids(name: string, surname: string): Promise<ForeverCharacterEncounterRaids>;
+    /**
+     * Returns a summary of a character's encounters.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the encounter summary.
+     */
+    characterEncounters(name: string, surname: string): Promise<ForeverCharacterEncounters>;
+    /**
+     * Returns a summary of the items equipped by a character.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the equipped items.
+     */
+    characterEquipments(name: string, surname: string): Promise<ForeverCharacterEquipment>;
+    /**
+     * Returns a summary of the media assets available for a character (such as an avatar render).
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the character's media assets.
+     */
+    characterMedia(name: string, surname: string): Promise<ForeverCharacterMedia>;
+    /**
+     * Returns the Mythic Keystone profile index for a character.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the Mythic Keystone profile.
+     */
+    characterMythicKeystoneProfile(name: string, surname: string): Promise<ForeverCharacterMythicKeystoneProfile>;
+    /**
+     * Returns a summary of a character's professions.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the professions.
+     */
+    characterProfessions(name: string, surname: string): Promise<ForeverCharacterProfessions>;
+    /**
+     * Returns a profile summary for a character.
+     *
+     * @param name - The character's name (first part), e.g. "Anduin". Case-insensitive.
+     * @param surname - The character's surname (second part), e.g. "Wrynn". Case-insensitive.
+     * @returns A promise that resolves to an object representing a profile summary.
+     */
+    characterProfile(name: string, surname: string): Promise<ForeverCharacterProfile>;
+    /**
+     * Returns the status and a unique ID for a character. Use the ID to check whether a character with the same name is
+     * still the same character.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the character's status.
+     */
+    characterProfileStatus(name: string, surname: string): Promise<ForeverCharacterProfileStatus>;
+    /**
+     * Returns a PvP summary for a character.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the PvP summary.
+     */
+    characterPvpSummary(name: string, surname: string): Promise<ForeverCharacterPvpSummary>;
+    /**
+     * Returns a character's active quests and links to its completed quests.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the quests.
+     */
+    characterQuests(name: string, surname: string): Promise<ForeverCharacterQuests>;
+    /**
+     * Returns a summary of a character's reputations.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the reputations.
+     */
+    characterReputations(name: string, surname: string): Promise<ForeverCharacterReputations>;
+    /**
+     * Returns a summary of a character's specializations.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the specializations.
+     */
+    characterSpecializations(name: string, surname: string): Promise<ForeverCharacterSpecializations>;
+    /**
+     * Returns a statistics summary for a character.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the statistics.
+     */
+    characterStatistics(name: string, surname: string): Promise<ForeverCharacterStatistics>;
+    /**
+     * Returns a summary of the titles a character has obtained.
+     *
+     * @param name - The character's name (first part). Case-insensitive.
+     * @param surname - The character's surname (second part). Case-insensitive.
+     * @returns A promise that resolves to an object representing the titles.
+     */
+    characterTitles(name: string, surname: string): Promise<ForeverCharacterTitles>;
+    /**
+     * 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 single guild by its name slug.
+     *
+     * @param nameSlug - The slug of the guild, e.g. "unbound".
+     * @returns A promise that resolves to an object representing the guild.
+     */
+    guild(nameSlug: string): Promise<ForeverGuild>;
+    /**
+     * Returns a guild's achievements.
+     *
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing the guild's achievements.
+     */
+    guildAchievements(nameSlug: string): Promise<ForeverGuildAchievements>;
+    /**
+     * Returns a guild's recent activity.
+     *
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing the guild's activity.
+     */
+    guildActivity(nameSlug: string): Promise<ForeverGuildActivity>;
+    /**
+     * 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 guild's roster.
+     *
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing the guild's roster.
+     */
+    guildRoster(nameSlug: string): Promise<ForeverGuildRoster>;
+    /**
+     * 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 an index of heirlooms.
+     *
+     * @returns A promise that resolves to an object representing an index of heirlooms.
+     */
+    heirlooms(): Promise<ForeverHeirlooms>;
+    /**
+     * 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 an index of journal encounters.
+     */
+    journalEncounters(): Promise<ForeverJournalEncounters>;
+    /**
+     * 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 an index of journal expansions.
+     */
+    journalExpansions(): Promise<ForeverJournalExpansions>;
+    /**
+     * 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 an index of journal instances.
+     */
+    journalInstances(): Promise<ForeverJournalInstances>;
+    /**
+     * Returns a mount by ID.
+     *
+     * @param mountId - The ID of the mount.
+     * @returns A promise that resolves to an object representing the mount.
+     */
+    mount(mountId: number): Promise<ForeverMount>;
+    /**
+     * 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 battle pet by ID.
+     *
+     * @param petId - The ID of the pet.
+     * @returns A promise that resolves to an object representing the battle pet.
+     */
+    pet(petId: number): Promise<ForeverPet>;
+    /**
+     * Returns an index of pet abilities.
+     *
+     * @returns A promise that resolves to an object representing an index of pet abilities.
+     */
+    petAbilities(): Promise<ForeverPetAbilities>;
+    /**
+     * 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 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 ID of the playable specialization.
+     * @returns A promise that resolves to an object representing the playable specialization.
+     */
+    playableSpecialization(specId: number): Promise<ForeverPlayableSpecialization>;
+    /**
+     * 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 an index of playable specializations.
+     */
+    playableSpecializations(): Promise<ForeverPlayableSpecializations>;
+    /**
+     * 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 ID of the recipe.
+     * @returns A promise that resolves to an object representing the recipe.
+     */
+    professionRecipie(recipeId: number): Promise<ForeverProfessionRecipie>;
+    /**
+     * 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 quest by ID.
+     *
+     * @param questId - The ID of the quest.
+     * @returns A promise that resolves to an object representing the quest.
+     */
+    quest(questId: number): Promise<ForeverQuest>;
+    /**
+     * 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 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 reputation faction by ID.
+     *
+     * @param reputationFactionId - The ID of the reputation faction.
+     * @returns A promise that resolves to an object representing the reputation faction.
+     */
+    reputationFaction(reputationFactionId: string): Promise<ForeverReputationFaction>;
+    /**
+     * 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 ruleset by ID.
+     *
+     * @param rulesetId - The ID of the ruleset.
+     * @returns A promise that resolves to an object representing the ruleset.
+     */
+    ruleset(rulesetId: number): Promise<ForeverRuleset>;
+    /**
+     * Returns an index of the rulesets in the region.
+     *
+     * @returns A promise that resolves to an object representing the ruleset index.
+     */
+    rulesets(): Promise<ForeverRulesets>;
+    /**
+     * 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 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 - Search parameters, e.g. `{ _page: 1, orderby: "id" }`.
+     * @returns A promise that resolves to an object representing the search results.
+     */
+    searchItemAppearance(searchParameters: SearchParameters): Promise<ForeverItemAppearanceSearch>;
+    /**
+     * 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 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<ForeverTalentTree>;
+    /**
+     * 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 an index of talent trees.
+     */
+    talentTrees(): Promise<ForeverTalentTrees>;
+    /**
+     * Returns a title by ID.
+     *
+     * @param titleId - The ID of the title.
+     * @returns A promise that resolves to an object representing the title.
+     */
+    title(titleId: number): Promise<ForeverTitle>;
+    /**
+     * Returns an index of titles.
+     *
+     * @returns A promise that resolves to an object representing a list of titles.
+     */
+    titles(): Promise<Titles>;
+    /**
+     * 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>;
+}