@blizzard-api/wow 0.2.2 → 0.2.4

package/dist/index.cjs

@@ -33,30 +33,53 @@ var searchBase = `${base}/search`;
 var achievementBase = `${base}/achievement`;
 var achievementCategoryBase = `${base}/achievement-category`;
 var achievementApi = {
+  /**
+   * Get an achievement category by ID.
+   * @param achievementCategoryId The achievement category ID.
+   * @returns The achievement category. See {@link AchievementCategoryResponse}.
+   */
   achievementCategory: (achievementCategoryId) => {
     return {
       path: `${achievementCategoryBase}/${achievementCategoryId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an achievement category index.
+   * @returns The achievement category index. See {@link AchievementCategoryIndexResponse}.
+   */
   achievementCategoryIndex: () => {
     return {
       path: `${achievementCategoryBase}/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get an achievement by ID.
+   * @param achievementId The achievement ID.
+   * @returns The achievement. See {@link AchievementResponse}.
+   */
   achievement: (achievementId) => {
     return {
       path: `${achievementBase}/${achievementId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an achievement index.
+   * @returns The achievement index. See {@link AchievementIndexResponse}.
+   */
   achievementIndex: () => {
     return {
       path: `${achievementBase}/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get achievement media by ID.
+   * @param achievementId The achievement ID.
+   * @returns The achievement media. See {@link AchievementMediaResponse}.
+   */
   achievementMedia: (achievementId) => {
     return { path: `${mediaBase}/achievement/${achievementId}`, namespace: "static" };
   }
@@ -64,12 +87,21 @@ var achievementApi = {
 
 // src/auction-house/auction-house.ts
 var auctionHouseApi = {
+  /**
+   * Get auction house data for a connected realm.
+   * @param connectedRealmId The ID of the connected realm.
+   * @returns The auction house data. See {@link AuctionHouseResponse}.
+   */
   auctions: (connectedRealmId) => {
     return {
       path: `${base}/connected-realm/${connectedRealmId}/auctions`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get auction house data for all connected realms.
+   * @returns The auction house data. See {@link AuctionHouseResponse}.
+   */
   commodities: () => {
     return {
       path: `${base}/auctions/commodities`,
@@ -80,21 +112,40 @@ var auctionHouseApi = {
 
 // src/azerite-essence/azerite-essence.ts
 var azeriteEssenceApi = {
+  /**
+   * Get an azerite essence by ID.
+   * @param azeriteEssenceId The azerite essence ID.
+   * @returns The azerite essence. See {@link AzeriteEssenceResponse}.
+   */
   azeriteEssence: (azeriteEssenceId) => {
     return {
       path: `${base}/azerite-essence/${azeriteEssenceId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an azerite essence index.
+   * @returns The azerite essence index. See {@link AzeriteEssenceIndexResponse}.
+   */
   azeriteEssenceIndex: () => {
     return {
       path: `${base}/azerite-essence/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get azerite essence media by ID.
+   * @param azeriteEssenceId The azerite essence ID.
+   * @returns The azerite essence media. See {@link AzeriteEssenceMediaResponse}.
+   */
   azeriteEssenceMedia: (azeriteEssenceId) => {
     return { path: `${mediaBase}/azerite-essence/${azeriteEssenceId}`, namespace: "static" };
   },
+  /**
+   * Search for azerite essences.
+   * @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   azeriteEssenceSearch: (options) => {
     return {
       path: `${searchBase}/azerite-essence`,
@@ -110,18 +161,32 @@ var azeriteEssenceApi = {
 
 // src/connected-realm/connected-realm.ts
 var connectedRealmApi = {
+  /**
+   * Get a connected realm index.
+   * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
+   */
   connectedRealmIndex: () => {
     return {
       path: `${base}/connected-realm/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a connected realm by ID.
+   * @param connectedRealmId The connected realm ID.
+   * @returns The connected realm. See {@link ConnectedRealmResponse}.
+   */
   connectedRealm: (connectedRealmId) => {
     return {
       path: `${base}/connected-realm/${connectedRealmId}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Search for connected realms.
+   * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
+   * @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
+   */
   connectedRealmSearch: (options) => {
     return {
       namespace: "dynamic",
@@ -138,42 +203,74 @@ var connectedRealmApi = {
 
 // src/covenant/covenant.ts
 var covenantApi = {
+  /**
+   * Get a conduit by ID.
+   * @param conduitId The conduit ID.
+   * @returns The conduit. See {@link ConduitResponse}.
+   */
   conduit: (conduitId) => {
     return {
       path: `${base}/covenant/conduit/${conduitId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a conduit index.
+   * @returns The conduit index. See {@link ConduitIndexResponse}.
+   */
   conduitIndex: () => {
     return {
       path: `${base}/covenant/conduit/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a covenant by ID.
+   * @param covenantId The covenant ID.
+   * @returns The covenant. See {@link CovenantResponse}.
+   */
   covenant: (covenantId) => {
     return {
       path: `${base}/covenant/${covenantId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a covenant index.
+   * @returns The covenant index. See {@link CovenantIndexResponse}.
+   */
   covenantIndex: () => {
     return {
       path: `${base}/covenant/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get covenant media by ID.
+   * @param covenantId The covenant ID.
+   * @returns The covenant media. See {@link CovenantMediaResponse}.
+   */
   covenantMedia: (covenantId) => {
     return {
       path: `${mediaBase}/covenant/${covenantId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a soulbind by ID.
+   * @param soulbindId The soulbind ID.
+   * @returns The soulbind. See {@link SoulbindResponse}.
+   */
   soulbind: (soulbindId) => {
     return {
       path: `${base}/covenant/soulbind/${soulbindId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a soulbind index.
+   * @returns The soulbind index. See {@link SoulbindIndexResponse}.
+   */
   soulbindIndex: () => {
     return {
       path: `${base}/covenant/soulbind/index`,
@@ -184,48 +281,86 @@ var covenantApi = {
 
 // src/creature/creature.ts
 var creatureApi = {
+  /**
+   * Get a creature by ID.
+   * @param creatureId The creature ID.
+   * @returns The creature. See {@link CreatureResponse}.
+   */
   creature: (creatureId) => {
     return {
       path: `${base}/creature/${creatureId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get creature display media by ID.
+   * @param creatureDisplayId The creature display ID.
+   * @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
+   */
   creatureDisplayMedia: (creatureDisplayId) => {
     return {
       path: `${mediaBase}/creature-display/${creatureDisplayId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a creature family by ID.
+   * @param creatureFamilyId The creature family ID.
+   * @returns The creature family. See {@link CreatureFamilyResponse}.
+   */
   creatureFamily: (creatureFamilyId) => {
     return {
       path: `${base}/creature-family/${creatureFamilyId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a creature family index.
+   * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
+   */
   creatureFamilyIndex: () => {
     return {
       path: `${base}/creature-family/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get creature family media by ID.
+   * @param creatureFamilyId The creature family ID.
+   * @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
+   */
   creatureFamilyMedia: (creatureFamilyId) => {
     return {
       path: `${mediaBase}/creature-family/${creatureFamilyId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a creature type by ID.
+   * @param creatureTypeId The creature type ID.
+   * @returns The creature type. See {@link CreatureTypeResponse}.
+   */
   creatureType: (creatureTypeId) => {
     return {
       path: `${base}/creature-type/${creatureTypeId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a creature type index.
+   * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
+   */
   creatureTypeIndex: () => {
     return {
       path: `${base}/creature-type/index`,
       namespace: "static"
     };
   },
+  /**
+   * Search for creatures.
+   * @param options The creature search parameters. See {@link CreatureSearchParameters}.
+   * @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
+   */
   creatureSearch: (options) => {
     return {
       namespace: "static",
@@ -241,18 +376,32 @@ var creatureApi = {
 
 // src/guild-crest/guild-crest.ts
 var guildCrestApi = {
+  /**
+   * Get the guild crest components index.
+   * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
+   */
   guildCrestComponentsIndex: () => {
     return {
       path: `${base}/guild-crest/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a guild crest border by ID.
+   * @param borderId The guild crest border ID.
+   * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
+   */
   guildCrestBorder: (borderId) => {
     return {
       path: `${mediaBase}/guild-crest/border/${borderId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a guild crest emblem by ID.
+   * @param emblemId The guild crest emblem ID.
+   * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
+   */
   guildCrestEmblem: (emblemId) => {
     return {
       path: `${mediaBase}/guild-crest/emblem/${emblemId}`,
@@ -263,12 +412,21 @@ var guildCrestApi = {
 
 // src/heirloom/heirloom.ts
 var heirloomApi = {
+  /**
+   * Get a heirloom by ID.
+   * @param heirloomId The heirloom ID.
+   * @returns The heirloom. See {@link HeirloomResponse}.
+   */
   heirloom: (heirloomId) => {
     return {
       path: `${base}/heirloom/${heirloomId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get the heirloom index.
+   * @returns The heirloom index. See {@link HeirloomIndexResponse}.
+   */
   heirloomIndex: () => {
     return {
       path: `${base}/heirloom/index`,
@@ -279,48 +437,87 @@ var heirloomApi = {
 
 // src/item/item.ts
 var itemApi = {
+  /**
+   * Get an item by ID.
+   * @param itemId The item ID.
+   * @returns The item. See {@link ItemResponse}.
+   */
   item: (itemId) => {
     return {
       path: `${base}/item/${itemId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an item class by ID.
+   * @param itemClassId The item class ID.
+   * @returns The item class. See {@link ItemClassResponse}.
+   */
   itemClass: (itemClassId) => {
     return {
       path: `${base}/item-class/${itemClassId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an item subclass by ID.
+   * @param itemClassId The item class ID.
+   * @param itemSubclassId The item subclass ID.
+   * @returns The item subclass. See {@link ItemSubClassResponse}.
+   */
   itemSubClass: (itemClassId, itemSubclassId) => {
     return {
       path: `${base}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an item class index.
+   * @returns The item class index. See {@link ItemClassIndexResponse}.
+   */
   itemClassIndex: () => {
     return {
       path: `${base}/item-class/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get item media by ID.
+   * @param itemId The item ID.
+   * @returns The item media. See {@link ItemMediaResponse}.
+   */
   itemMedia: (itemId) => {
     return {
       path: `${mediaBase}/item/${itemId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an item set by ID.
+   * @param itemSetId The item set ID.
+   * @returns The item set. See {@link ItemSetResponse}.
+   */
   itemSet: (itemSetId) => {
     return {
       path: `${base}/item-set/${itemSetId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get an item set index.
+   * @returns The item set index. See {@link ItemSetIndexResponse}.
+   */
   itemSetIndex: () => {
     return {
       path: `${base}/item-set/index`,
       namespace: "static"
     };
   },
+  /**
+   * Search for items.
+   * @param options The search parameters. See {@link ItemSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   itemSearch: (options) => {
     return {
       namespace: "static",
@@ -336,18 +533,32 @@ var itemApi = {
 
 // src/journal/journal.ts
 var journalApi = {
+  /**
+   * Get a journal encounter by ID.
+   * @param journalEncounterId The journal encounter ID.
+   * @returns The journal encounter. See {@link JournalEncounterResponse}.
+   */
   journalEncounter: (journalEncounterId) => {
     return {
       path: `${base}/journal-encounter/${journalEncounterId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get the journal encounter index.
+   * @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
+   */
   journalEncounterIndex: () => {
     return {
       path: `${base}/journal-encounter/index`,
       namespace: "static"
     };
   },
+  /**
+   * Search for journal encounters.
+   * @param options The search parameters. See {@link JournalEncounterSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   journalEncounterSearch: (options) => {
     return {
       namespace: "static",
@@ -359,30 +570,53 @@ var journalApi = {
       path: `${searchBase}/journal-encounter`
     };
   },
+  /**
+   * Get a journal expansion by ID.
+   * @param journalExpansionId The journal expansion ID.
+   * @returns The journal expansion. See {@link JournalExpansionResponse}.
+   */
   journalExpansion: (journalExpansionId) => {
     return {
       path: `${base}/journal-expansion/${journalExpansionId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get the journal expansion index.
+   * @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
+   */
   journalExpansionIndex: () => {
     return {
       path: `${base}/journal-expansion/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a journal instance by ID.
+   * @param journalInstanceId The journal instance ID.
+   * @returns The journal instance. See {@link JournalInstanceResponse}.
+   */
   journalInstance: (journalInstanceId) => {
     return {
       path: `${base}/journal-instance/${journalInstanceId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get the journal instance index.
+   * @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
+   */
   journalInstanceIndex: () => {
     return {
       path: `${base}/journal-instance/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get journal instance media by ID.
+   * @param journalInstanceId The journal instance ID.
+   * @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
+   */
   journalInstanceMedia: (journalInstanceId) => {
     return {
       path: `${mediaBase}/journal-instance/${journalInstanceId}`,
@@ -393,6 +627,11 @@ var journalApi = {
 
 // src/media-search/media-search.ts
 var mediaSearchApi = {
+  /**
+   * Search for media.
+   * @param options The search parameters. See {@link MediaSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   mediaSearch: (options) => {
     return {
       namespace: "static",
@@ -408,30 +647,52 @@ var mediaSearchApi = {
 
 // src/modified-crafting/modified-crafting.ts
 var modifiedCraftingApi = {
+  /**
+   * Get a modified crafting category by ID.
+   * @param modifiedCraftingCategoryId The modified crafting category ID.
+   * @returns The modified crafting category. See {@link ModifiedCraftingCategoryResponse}.
+   */
   modifiedCraftingCategory: (modifiedCraftingCategoryId) => {
     return {
       path: `${base}/modified-crafting/category/${modifiedCraftingCategoryId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a modified crafting category index.
+   * @returns The modified crafting category index. See {@link ModifiedCraftingCategoryIndexResponse}.
+   */
   modifiedCraftingCategoryIndex: () => {
     return {
       path: `${base}/modified-crafting/category/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a modified crafting index.
+   * @returns The modified crafting index. See {@link ModifiedCraftingIndexResponse}.
+   */
   modifiedCraftingIndex: () => {
     return {
       path: `${base}/modified-crafting/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a modified crafting reagent slot type by ID.
+   * @param modifiedCraftingReagentSlotTypeId The modified crafting reagent slot type ID.
+   * @returns The modified crafting reagent slot type. See {@link ModifiedCraftingReagentSlotTypeResponse}.
+   */
   modifiedCraftingReagentSlotType: (modifiedCraftingReagentSlotTypeId) => {
     return {
       path: `${base}/modified-crafting/reagent-slot-type/${modifiedCraftingReagentSlotTypeId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a modified crafting reagent slot type index.
+   * @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
+   */
   modifiedCraftingReagentSlotTypeIndex: () => {
     return {
       path: `${base}/modified-crafting/reagent-slot-type/index`,
@@ -442,18 +703,32 @@ var modifiedCraftingApi = {
 
 // src/mount/mount.ts
 var mountApi = {
+  /**
+   * Get a mount by ID.
+   * @param mountId The mount ID.
+   * @returns The mount. See {@link MountResponse}.
+   */
   mount: (mountId) => {
     return {
       path: `${base}/mount/${mountId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a mount index.
+   * @returns The mount index. See {@link MountIndexResponse}.
+   */
   mountIndex: () => {
     return {
       path: `${base}/mount/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a mount search.
+   * @param options The search parameters. See {@link MountSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   mountSearch: (options) => {
     return {
       namespace: "static",
@@ -469,18 +744,30 @@ var mountApi = {
 
 // src/mythic-keystone-affix/mythic-keystone-affix.ts
 var mythicKeystoneAffixApi = {
+  /**
+   * Get a list of all Mythic Keystone affixes.
+   * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
+   */
   mythicKeystoneAffix: (mythicKeystoneAffixId) => {
     return {
       path: `${base}/keystone-affix/${mythicKeystoneAffixId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a list of all Mythic Keystone affixes.
+   * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
+   */
   mythicKeystoneAffixIndex: () => {
     return {
       path: `${base}/keystone-affix/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a list of all Mythic Keystone affix media.
+   * @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
+   */
   mythicKeystoneAffixMedia: (mythicKeystoneAffixId) => {
     return {
       path: `${mediaBase}/keystone-affix/${mythicKeystoneAffixId}`,
@@ -491,42 +778,73 @@ var mythicKeystoneAffixApi = {
 
 // src/mythic-keystone-dungeon/mythic-keystone-dungeon.ts
 var mythicKeystoneDungeonApi = {
+  /**
+   * Get a Mythic Keystone dungeon by ID.
+   * @param mythicKeystoneDungeonId The Mythic Keystone dungeon ID.
+   * @returns The Mythic Keystone dungeon. See {@link MythicKeystoneDungeonResponse}.
+   */
   mythicKeystoneDungeon: (mythicKeystoneDungeonId) => {
     return {
       path: `${base}/mythic-keystone/dungeon/${mythicKeystoneDungeonId}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone dungeon index.
+   * @returns The Mythic Keystone dungeon index. See {@link MythicKeystoneDungeonIndexResponse}.
+   */
   mythicKeystoneDungeonIndex: () => {
     return {
       path: `${base}/mythic-keystone/dungeon/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone index.
+   * @returns The Mythic Keystone index. See {@link MythicKeystoneIndexResponse}.
+   */
   mythicKeystoneIndex: () => {
     return {
       path: `${base}/mythic-keystone/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone period by ID.
+   * @param mythicKeystonePeriodId The Mythic Keystone period ID.
+   * @returns The Mythic Keystone period. See {@link MythicKeystonePeriodResponse}.
+   */
   mythicKeystonePeriod: (mythicKeystonePeriodId) => {
     return {
       path: `${base}/mythic-keystone/period/${mythicKeystonePeriodId}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone period index.
+   * @returns The Mythic Keystone period index. See {@link MythicKeystonePeriodIndexResponse}.
+   */
   mythicKeystonePeriodIndex: () => {
     return {
       path: `${base}/mythic-keystone/period/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone season by ID.
+   * @param mythicKeystoneSeasonId The Mythic Keystone season ID.
+   * @returns The Mythic Keystone season. See {@link MythicKeystoneSeasonResponse}.
+   */
   mythicKeystoneSeason: (mythicKeystoneSeasonId) => {
     return {
       path: `${base}/mythic-keystone/season/${mythicKeystoneSeasonId}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone season index.
+   * @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
+   */
   mythicKeystoneSeasonIndex: () => {
     return {
       path: `${base}/mythic-keystone/season/index`,
@@ -537,12 +855,24 @@ var mythicKeystoneDungeonApi = {
 
 // src/mythic-keystone-leaderboard/mythic-keystone-leaderboard.ts
 var mythicKeystoneLeaderboardApi = {
+  /**
+   * Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
+   * @param connectedRealmId The connected realm ID.
+   * @param dungeonId The dungeon ID.
+   * @param period The period ID.
+   * @returns The Mythic Keystone leaderboard. See {@link MythicKeystoneLeaderboardResponse}.
+   */
   mythicKeystoneLeaderboard: (connectedRealmId, dungeonId, period) => {
     return {
       path: `${base}/connected-realm/${connectedRealmId}/mythic-leaderboard/${dungeonId}/period/${period}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a Mythic Keystone leaderboard index by connected realm ID.
+   * @param connectedRealmId The connected realm ID.
+   * @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
+   */
   mythicKeystoneLeaderboardIndex: (connectedRealmId) => {
     return {
       path: `${base}/connected-realm/${connectedRealmId}/mythic-leaderboard/index`,
@@ -553,6 +883,12 @@ var mythicKeystoneLeaderboardApi = {
 
 // src/mythic-raid-leaderboard/mythic-raid-leaderboard.ts
 var mythicRaidLeaderboardApi = {
+  /**
+   * Get a Mythic Raid leaderboard by raid and faction.
+   * @param raid The slug of the raid.
+   * @param faction The faction. Either 'alliance' or 'horde'.
+   * @returns The Mythic Raid leaderboard. See {@link MythicRaidLeaderboardResponse}.
+   */
   mythicRaidLeaderboard: (raid, faction) => {
     return {
       path: `${base}/leaderboard/hall-of-fame/${raid}/${faction}`,
@@ -563,36 +899,64 @@ var mythicRaidLeaderboardApi = {
 
 // src/pet/pet.ts
 var petApi = {
+  /**
+   * Get a pet by ID.
+   * @param petId The pet ID.
+   * @returns The pet. See {@link PetResponse}.
+   */
   pet: (petId) => {
     return {
       path: `${base}/pet/${petId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a pet index.
+   * @returns The pet index. See {@link PetIndexResponse}.
+   */
   petIndex: () => {
     return {
       path: `${base}/pet/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a pet media by ID.
+   * @param petId The pet ID.
+   * @returns The pet media. See {@link PetMediaResponse}.
+   */
   petMedia: (petId) => {
     return {
       path: `${mediaBase}/pet/${petId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a pet ability by ID.
+   * @param petAbilityId The pet ability ID.
+   * @returns The pet ability. See {@link PetAbilityResponse}.
+   */
   petAbility: (petAbilityId) => {
     return {
       path: `${base}/pet-ability/${petAbilityId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a pet ability index.
+   * @returns The pet ability index. See {@link PetAbilityIndexResponse}.
+   */
   petAbilityIndex: () => {
     return {
       path: `${base}/pet-ability/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a pet ability media by ID.
+   * @param petAbilityId The pet ability ID.
+   * @returns The pet ability media. See {@link PetAbilityMediaResponse}.
+   */
   petAbilityMedia: (petAbilityId) => {
     return {
       path: `${mediaBase}/pet-ability/${petAbilityId}`,
@@ -603,24 +967,43 @@ var petApi = {
 
 // src/playable-class/playable-class.ts
 var playableClassApi = {
+  /**
+   * Get a playable class by ID.
+   * @param playableClassId The playable class ID.
+   * @returns The playable class. See {@link PlayableClassResponse}.
+   */
   playableClass: (playableClassId) => {
     return {
       path: `${base}/playable-class/${playableClassId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a playable class index.
+   * @returns The playable class index. See {@link PlayableClassIndexResponse}.
+   */
   playableClassIndex: () => {
     return {
       path: `${base}/playable-class/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get playable class media by ID.
+   * @param playableClassId The playable class ID.
+   * @returns The playable class media. See {@link PlayableClassMediaResponse}.
+   */
   playableClassMedia: (playableClassId) => {
     return {
       path: `${mediaBase}/playable-class/${playableClassId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a playable class's PvP talent slots by ID.
+   * @param playableClassId The playable class ID.
+   * @returns The playable class's PvP talent slots. See {@link PvpTalentSlotsResponse}.
+   */
   pvpTalentSlots: (playableClassId) => {
     return {
       path: `${base}/playable-class/${playableClassId}/pvp-talent-slots`,
@@ -631,12 +1014,21 @@ var playableClassApi = {
 
 // src/playable-race/playable-race.ts
 var playableRaceApi = {
+  /**
+   * Get a playable race by ID.
+   * @param playableRaceId The playable race ID.
+   * @returns The playable race. See {@link PlayableRaceResponse}.
+   */
   playableRace: (playableRaceId) => {
     return {
       path: `${base}/playable-race/${playableRaceId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a playable race index.
+   * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
+   */
   playableRaceIndex: () => {
     return {
       path: `${base}/playable-race/index`,
@@ -647,18 +1039,32 @@ var playableRaceApi = {
 
 // src/playable-specialization/playable-specialization.ts
 var playableSpecializationApi = {
+  /**
+   * Get a playable specialization by ID.
+   * @param specializationId The playable specialization ID.
+   * @returns The playable specialization. See {@link PlayableSpecializationResponse}.
+   */
   playableSpecialization: (specializationId) => {
     return {
       path: `${base}/playable-specialization/${specializationId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a playable specialization index.
+   * @returns The playable specialization index. See {@link PlayableSpecializationIndexResponse}.
+   */
   playableSpecializationIndex: () => {
     return {
       path: `${base}/playable-specialization/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a playable specialization media by ID.
+   * @param specializationId The playable specialization ID.
+   * @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
+   */
   playableSpecializationMedia: (specializationId) => {
     return {
       path: `${mediaBase}/playable-specialization/${specializationId}`,
@@ -669,12 +1075,21 @@ var playableSpecializationApi = {
 
 // src/power-type/power-type.ts
 var powerTypeApi = {
+  /**
+   * Get a power type by ID.
+   * @param powerTypeId The power type ID.
+   * @returns The power type. See {@link PowerTypeResponse}.
+   */
   powerType: (powerTypeId) => {
     return {
       path: `${base}/power-type/${powerTypeId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a power type index.
+   * @returns The power type index. See {@link PowerTypeIndexResponse}.
+   */
   powerTypeIndex: () => {
     return {
       path: `${base}/power-type/index`,
@@ -685,36 +1100,66 @@ var powerTypeApi = {
 
 // src/profession/profession.ts
 var professionApi = {
+  /**
+   * Get a profession by ID.
+   * @param professionId The profession ID.
+   * @returns The profession. See {@link ProfessionResponse}.
+   */
   profession: (professionId) => {
     return {
       path: `${base}/profession/${professionId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a profession index.
+   * @returns The profession index. See {@link ProfessionIndexResponse}.
+   */
   professionIndex: () => {
     return {
       path: `${base}/profession/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get profession media by ID.
+   * @param professionId The profession ID.
+   * @returns The profession media. See {@link ProfessionMediaResponse}.
+   */
   professionMedia: (professionId) => {
     return {
       path: `${mediaBase}/profession/${professionId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a profession's skill tier by ID.
+   * @param professionId The profession ID.
+   * @param skillTierId The skill tier ID.
+   * @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
+   */
   professionSkillTier: (professionId, skillTierId) => {
     return {
       path: `${base}/profession/${professionId}/skill-tier/${skillTierId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a recipe by ID.
+   * @param recipeId The recipe ID.
+   * @returns The recipe. See {@link RecipeResponse}.
+   */
   recipe: (recipeId) => {
     return {
       path: `${base}/recipe/${recipeId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get recipe media by ID.
+   * @param recipeId The recipe ID.
+   * @returns The recipe media. See {@link RecipeMediaResponse}.
+   */
   recipeMedia: (recipeId) => {
     return {
       path: `${mediaBase}/recipe/${recipeId}`,
@@ -725,30 +1170,55 @@ var professionApi = {
 
 // src/pvp-season/pvp-season.ts
 var pvpSeasonApi = {
+  /**
+   * Get a PvP leaderboard by PvP season ID and bracket.
+   * @param pvpSeasonId The PvP season ID.
+   * @param bracket The PvP bracket.
+   * @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
+   */
   pvpLeaderboard: (pvpSeasonId, bracket) => {
     return {
       path: `${base}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${bracket}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a PvP leaderboard index by PvP season ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
+   */
   pvpLeaderboardIndex: (pvpSeasonId) => {
     return {
       path: `${base}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a PvP reward index by PvP season ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
+   */
   pvpRewardsIndex: (pvpSeasonId) => {
     return {
       path: `${base}/pvp-season/${pvpSeasonId}/pvp-reward/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a PvP season by ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP season. See {@link PvpSeasonResponse}.
+   */
   pvpSeason: (pvpSeasonId) => {
     return {
       path: `${base}/pvp-season/${pvpSeasonId}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a PvP season index.
+   * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
+   */
   pvpSeasonIndex: () => {
     return {
       path: `${base}/pvp-season/index`,
@@ -759,18 +1229,32 @@ var pvpSeasonApi = {
 
 // src/pvp-tier/pvp-tier.ts
 var pvpTierApi = {
+  /**
+   * Get a PvP tier by ID.
+   * @param pvpTierId The PvP tier ID.
+   * @returns The PvP tier. See {@link PvpTierResponse}.
+   */
   pvpTier: (pvpTierId) => {
     return {
       path: `${base}/pvp-tier/${pvpTierId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a PvP tier index.
+   * @returns The PvP tier index. See {@link PvpTierIndexResponse}.
+   */
   pvpTierIndex: () => {
     return {
       path: `${base}/pvp-tier/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get PvP tier media by ID.
+   * @param pvpTierId The PvP tier ID.
+   * @returns The PvP tier media. See {@link PvpTierMediaResponse}.
+   */
   pvpTierMedia: (pvpTierId) => {
     return {
       path: `${mediaBase}/pvp-tier/${pvpTierId}`,
@@ -781,48 +1265,84 @@ var pvpTierApi = {
 
 // src/quest/quest.ts
 var questApi = {
+  /**
+   * Get a quest by ID.
+   * @param questId The quest ID.
+   * @returns The quest. See {@link QuestResponse}.
+   */
   quest: (questId) => {
     return {
       path: `${base}/quest/${questId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest index.
+   * @returns The quest index. See {@link QuestIndexResponse}.
+   */
   questIndex: () => {
     return {
       path: `${base}/quest/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest area by ID.
+   * @param questAreaId The quest area ID.
+   * @returns The quest area. See {@link QuestAreaResponse}.
+   */
   questArea: (questAreaId) => {
     return {
       path: `${base}/quest/area/${questAreaId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest area index.
+   * @returns The quest area index. See {@link QuestAreaIndexResponse}.
+   */
   questAreaIndex: () => {
     return {
       path: `${base}/quest/area/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest category by ID.
+   * @param questCategoryId The quest category ID.
+   * @returns The quest category. See {@link QuestCategoryResponse}.
+   */
   questCategory: (questCategoryId) => {
     return {
       path: `${base}/quest/category/${questCategoryId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest category index.
+   * @returns The quest category index. See {@link QuestCategoryIndexResponse}.
+   */
   questCategoryIndex: () => {
     return {
       path: `${base}/quest/category/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest type by ID.
+   * @param questTypeId The quest type ID.
+   * @returns The quest type. See {@link QuestTypeResponse}.
+   */
   questType: (questTypeId) => {
     return {
       path: `${base}/quest/type/${questTypeId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a quest type index.
+   * @returns The quest type index. See {@link QuestTypeIndexResponse}.
+   */
   questTypeIndex: () => {
     return {
       path: `${base}/quest/type/index`,
@@ -833,18 +1353,32 @@ var questApi = {
 
 // src/realm/realm.ts
 var realmApi = {
+  /**
+   * Get a realm by slug.
+   * @param realmSlug The realm slug.
+   * @returns The realm. See {@link RealmResponse}.
+   */
   realm: (realmSlug) => {
     return {
       path: `${base}/realm/${realmSlug}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a realm index.
+   * @returns The realm index. See {@link RealmIndexResponse}.
+   */
   realmIndex: () => {
     return {
       path: `${base}/realm/index`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Search for realms.
+   * @param options The search parameters. See {@link RealmSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   realmSearch: (options) => {
     return {
       namespace: "dynamic",
@@ -860,12 +1394,21 @@ var realmApi = {
 
 // src/region/region.ts
 var regionApi = {
+  /**
+   * Get a region by ID.
+   * @param regionId The region ID.
+   * @returns The region. See {@link RegionResponse}.
+   */
   region: (regionId) => {
     return {
       path: `${base}/region/${regionId}`,
       namespace: "dynamic"
     };
   },
+  /**
+   * Get a region index.
+   * @returns The region index. See {@link RegionIndexResponse}.
+   */
   regionIndex: () => {
     return {
       path: `${base}/region/index`,
@@ -876,24 +1419,42 @@ var regionApi = {
 
 // src/reputations/reputations.ts
 var reputationApi = {
+  /**
+   * Get a reputation faction by ID.
+   * @param reputationFactionId The reputation faction ID.
+   * @returns The reputation faction. See {@link ReputationFactionResponse}.
+   */
   reputationFaction: (reputationFactionId) => {
     return {
       path: `${base}/reputation-faction/${reputationFactionId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a reputation faction index.
+   * @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
+   */
   reputationFactionIndex: () => {
     return {
       path: `${base}/reputation-faction/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a reputation tier by ID.
+   * @param reputationTiersId The reputation tier ID.
+   * @returns The reputation tier. See {@link ReputationTiersResponse}.
+   */
   reputationTiers: (reputationTiersId) => {
     return {
       path: `${base}/reputation-tiers/${reputationTiersId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a reputation tier index.
+   * @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
+   */
   reputationTiersIndex: () => {
     return {
       path: `${base}/reputation-tiers/index`,
@@ -904,18 +1465,33 @@ var reputationApi = {
 
 // src/spell/spell.ts
 var spellApi = {
+  /**
+   * Get a spell by ID.
+   * @param spellId The spell ID.
+   * @returns The spell. See {@link SpellResponse}.
+   */
   spell: (spellId) => {
     return {
       path: `${base}/spell/${spellId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get spell media by ID.
+   * @param spellId The spell ID.
+   * @returns The spell media. See {@link SpellMediaResponse}.
+   */
   spellMedia: (spellId) => {
     return {
       path: `${mediaBase}/spell/${spellId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a spell search.
+   * @param options The spell search options. See {@link SpellSearchParameters}.
+   * @returns The spell search. See {@link SearchResponse}.
+   */
   spellSearch: (options) => {
     return {
       namespace: "static",
@@ -931,42 +1507,75 @@ var spellApi = {
 
 // src/talent/talent.ts
 var talentApi = {
+  /**
+   * Get a PvP talent by ID.
+   * @param pvpTalentId The PvP talent ID.
+   * @returns The PvP talent. See {@link PvpTalentResponse}.
+   */
   pvpTalent: (pvpTalentId) => {
     return {
       path: `${base}/pvp-talent/${pvpTalentId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a PvP talent index.
+   * @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
+   */
   pvpTalentIndex: () => {
     return {
       path: `${base}/pvp-talent/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a talent by ID.
+   * @param talentId The talent ID.
+   * @returns The talent. See {@link TalentResponse}.
+   */
   talent: (talentId) => {
     return {
       path: `${base}/talent/${talentId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a talent index.
+   * @returns The talent index. See {@link TalentIndexResponse}.
+   */
   talentIndex: () => {
     return {
       path: `${base}/talent/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get a talent tree by ID.
+   * @param talentTreeId The talent tree ID.
+   * @param specId The playable specialization ID.
+   * @returns The talent tree. See {@link TalentTreeResponse}.
+   */
   talentTree: (talentTreeId, specId) => {
     return {
       path: `${base}/talent-tree/${talentTreeId}/playable-specialization/${specId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a talent tree index.
+   * @returns The talent tree index. See {@link TalentTreeIndexResponse}.
+   */
   talentTreeIndex: () => {
     return {
       path: `${base}/talent-tree/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get talent tree nodes by talent tree ID.
+   * @param talentTreeId The talent tree ID.
+   * @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
+   */
   talentTreeNodes: (talentTreeId) => {
     return {
       path: `${base}/talent-tree/${talentTreeId}`,
@@ -977,30 +1586,53 @@ var talentApi = {
 
 // src/tech-talent/tech-talent.ts
 var techTalentApi = {
+  /**
+   * Get a tech talent by ID.
+   * @param techTalentId The tech talent ID.
+   * @returns The tech talent. See {@link TechTalentResponse}.
+   */
   techTalent: (techTalentId) => {
     return {
       path: `${base}/tech-talent/${techTalentId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a tech talent index.
+   * @returns The tech talent index. See {@link TechTalentIndexResponse}.
+   */
   techTalentIndex: () => {
     return {
       path: `${base}/tech-talent/index`,
       namespace: "static"
     };
   },
+  /**
+   * Get tech talent media by ID.
+   * @param techTalentId The tech talent ID.
+   * @returns The tech talent media. See {@link TechTalentMediaResponse}.
+   */
   techTalentMedia: (techTalentId) => {
     return {
       path: `${mediaBase}/tech-talent/${techTalentId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a tech talent tree by ID.
+   * @param techTalentTreeId The tech talent tree ID.
+   * @returns The tech talent tree. See {@link TechTalentTreeResponse}.
+   */
   techTalentTree: (techTalentTreeId) => {
     return {
       path: `${base}/tech-talent-tree/${techTalentTreeId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a tech talent tree index.
+   * @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
+   */
   techTalentTreeIndex: () => {
     return {
       path: `${base}/tech-talent-tree/index`,
@@ -1011,12 +1643,21 @@ var techTalentApi = {
 
 // src/title/title.ts
 var titleApi = {
+  /**
+   * Get a title by ID.
+   * @param titleId The title ID.
+   * @returns The title. See {@link TitleResponse}.
+   */
   title: (titleId) => {
     return {
       path: `${base}/title/${titleId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a title index.
+   * @returns The title index. See {@link TitleIndexResponse}.
+   */
   titleIndex: () => {
     return {
       path: `${base}/title/index`,
@@ -1027,12 +1668,21 @@ var titleApi = {
 
 // src/toy/toy.ts
 var toyApi = {
+  /**
+   * Get a toy by ID.
+   * @param toyId The toy ID.
+   * @returns The toy. See {@link ToyResponse}.
+   */
   toy: (toyId) => {
     return {
       path: `${base}/toy/${toyId}`,
       namespace: "static"
     };
   },
+  /**
+   * Get a toy index.
+   * @returns The toy index. See {@link ToyIndexResponse}.
+   */
   toyIndex: () => {
     return {
       path: `${base}/toy/index`,
@@ -1043,6 +1693,10 @@ var toyApi = {
 
 // src/wow-token/wow-token.ts
 var wowTokenApi = {
+  /**
+   * Get the current WoW token price.
+   * @returns The WoW token price. See {@link WowTokenResponse}.
+   */
   wowToken: () => {
     return {
       path: `${base}/token/index`,