@blizzard-api/wow 3.0.6 → 4.0.1

package/dist/index-B-v4jmT8.d.ts

@@ -0,0 +1,120 @@
+import { Character, Href, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-collections/types.d.ts
+interface CharacterCollectionsIndexResponse extends ResponseBase {
+  character: Character;
+  decors: Href;
+  heirlooms: Href;
+  mounts: Href;
+  pets: Href;
+  toys: Href;
+  transmogs: Href;
+}
+interface CharacterHeirloomsCollectionSummaryResponse extends ResponseBase {
+  heirlooms: Array<Heirloom>;
+}
+interface CharacterMountsCollectionSummaryResponse extends ResponseBase {
+  mounts: Array<Mount>;
+}
+interface CharacterPetsCollectionSummaryResponse extends ResponseBase {
+  pets: Array<Pet>;
+  unlocked_battle_pet_slots: number;
+}
+interface CharacterToysCollectionSummaryResponse extends ResponseBase {
+  toys: Array<Toy>;
+}
+interface CharacterTransmogCollectionSummaryResponse extends ResponseBase {
+  appearance_sets: Array<NameIdKey>;
+  slots: Array<Slot>;
+}
+interface Heirloom {
+  heirloom: NameIdKey;
+  upgrade: {
+    level: number;
+  };
+}
+interface Mount {
+  is_character_specific?: boolean;
+  is_favorite?: boolean;
+  is_useable: boolean;
+  mount: NameIdKey;
+}
+interface Pet {
+  active_slot?: number;
+  creature_display?: KeyBase & {
+    id: number;
+  };
+  id: number;
+  is_active?: boolean;
+  is_favorite?: boolean;
+  level: number;
+  name?: string;
+  quality: Quality;
+  species: NameIdKey;
+  stats: Stats;
+}
+interface Quality {
+  name: string;
+  type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
+}
+interface Slot {
+  appearances: Array<KeyBase & {
+    id: number;
+  }>;
+  slot: SlotSlot;
+}
+interface SlotSlot {
+  name: string;
+  type: string;
+}
+interface Stats {
+  breed_id: number;
+  health: number;
+  power: number;
+  speed: number;
+}
+interface Toy {
+  is_favorite?: boolean;
+  toy: NameIdKey;
+}
+//#endregion
+//#region src/character-collections/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns an index of collection types for a character.
+ */
+declare function characterCollectionsIndex(realmSlug: string, characterName: string): Resource<CharacterCollectionsIndexResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the heirlooms a character has obtained.
+ */
+declare function characterHeirloomsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterHeirloomsCollectionSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the mounts a character has obtained.
+ */
+declare function characterMountsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterMountsCollectionSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the battle pets a character has obtained.
+ */
+declare function characterPetsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterPetsCollectionSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the toys a character has obtained.
+ */
+declare function characterToysCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterToysCollectionSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the transmog unlocks a character has obtained.
+ */
+declare function characterTransmogCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterTransmogCollectionSummaryResponse>;
+//#endregion
+export { characterToysCollectionSummary as a, CharacterHeirloomsCollectionSummaryResponse as c, CharacterToysCollectionSummaryResponse as d, CharacterTransmogCollectionSummaryResponse as f, characterPetsCollectionSummary as i, CharacterMountsCollectionSummaryResponse as l, characterHeirloomsCollectionSummary as n, characterTransmogCollectionSummary as o, characterMountsCollectionSummary as r, CharacterCollectionsIndexResponse as s, characterCollectionsIndex as t, CharacterPetsCollectionSummaryResponse as u };
+//# sourceMappingURL=index-B-v4jmT8.d.ts.map

package/dist/index-BAx6xlRe.d.ts

@@ -0,0 +1,43 @@
+import { Character, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-soulbinds/types.d.ts
+interface CharacterSoulbindsResponse extends ResponseBase {
+  character: Character;
+  chosen_covenant: NameIdKey;
+  renown_level: number;
+  soulbinds: Array<Soulbind>;
+}
+interface ConduitSocket {
+  socket: Socket;
+  type: TypeClass;
+}
+interface Socket {
+  conduit: NameIdKey;
+  rank: number;
+}
+interface Soulbind {
+  is_active?: boolean;
+  soulbind: NameIdKey;
+  traits: Array<Trait>;
+}
+interface Trait {
+  conduit_socket?: ConduitSocket;
+  display_order: number;
+  tier: number;
+  trait?: NameIdKey;
+}
+interface TypeClass {
+  name: string;
+  type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
+}
+//#endregion
+//#region src/character-soulbinds/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a character's soulbinds.
+ */
+declare function characterSoulbinds(realmSlug: string, characterName: string): Resource<CharacterSoulbindsResponse>;
+//#endregion
+export { CharacterSoulbindsResponse as n, characterSoulbinds as t };
+//# sourceMappingURL=index-BAx6xlRe.d.ts.map

package/dist/index-BJYdOuJB2.d.ts

@@ -0,0 +1,21 @@
+import { Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/wow-token/types.d.ts
+/**
+ * The response for a WoW token.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface WowTokenResponse extends ResponseBase {
+  last_updated_timestamp: number;
+  price: number;
+}
+//#endregion
+//#region src/wow-token/index.d.ts
+/**
+ * Get the current WoW token price.
+ * @returns The WoW token price. See {@link WowTokenResponse}.
+ */
+declare function wowToken(): Resource<WowTokenResponse>;
+//#endregion
+export { WowTokenResponse as n, wowToken as t };
+//# sourceMappingURL=index-BJYdOuJB2.d.ts.map

package/dist/index-BM5t9AbX2.d.ts

@@ -0,0 +1,72 @@
+import { GenderName, Href, KeyBase, MediaAsset, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/playable-class/types.d.ts
+/**
+ * The response for a playable class index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableClassIndexResponse extends ResponseBase {
+  classes: Array<NameIdKey>;
+}
+/**
+ * The response for playable class media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableClassMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a playable class.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableClassResponse extends NameId, ResponseBase {
+  gender_name: GenderName;
+  media: Media;
+  playable_races: Array<NameIdKey>;
+  power_type: NameIdKey;
+  pvp_talent_slots: Href;
+  specializations: Array<NameIdKey>;
+}
+/**
+ * The response for a playable class's PvP talent slots.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpTalentSlotsResponse extends ResponseBase {
+  talent_slots: Array<TalentSlot>;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface TalentSlot {
+  slot_number: number;
+  unlock_player_level: number;
+}
+//#endregion
+//#region src/playable-class/index.d.ts
+/**
+ * Get a playable class by ID.
+ * @param playableClassId The playable class ID.
+ * @returns The playable class. See {@link PlayableClassResponse}.
+ */
+declare function playableClass(playableClassId: number): Resource<PlayableClassResponse>;
+/**
+ * Get a playable class index.
+ * @returns The playable class index. See {@link PlayableClassIndexResponse}.
+ */
+declare function playableClassIndex(): Resource<PlayableClassIndexResponse>;
+/**
+ * Get playable class media by ID.
+ * @param playableClassId The playable class ID.
+ * @returns The playable class media. See {@link PlayableClassMediaResponse}.
+ */
+declare function playableClassMedia(playableClassId: number): Resource<PlayableClassMediaResponse>;
+/**
+ * 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}.
+ */
+declare function pvpTalentSlots(playableClassId: number): Resource<PvpTalentSlotsResponse>;
+//#endregion
+export { PlayableClassIndexResponse as a, PvpTalentSlotsResponse as c, pvpTalentSlots as i, playableClassIndex as n, PlayableClassMediaResponse as o, playableClassMedia as r, PlayableClassResponse as s, playableClass as t };
+//# sourceMappingURL=index-BM5t9AbX2.d.ts.map

package/dist/index-BOz0BCUN2.d.ts

@@ -0,0 +1,233 @@
+import { KeyBase, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/talent/types.d.ts
+/**
+ * The response for a pvp talent index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpTalentIndexResponse extends ResponseBase {
+  pvp_talents: Array<NameIdKey>;
+}
+/**
+ * The response for a pvp talent.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpTalentResponse extends ResponseBase {
+  compatible_slots: Array<number>;
+  description: string;
+  id: number;
+  overrides_spell?: NameIdKey;
+  playable_specialization: NameIdKey;
+  spell: NameIdKey;
+  unlock_player_level: number;
+}
+/**
+ * The response for a talent index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TalentIndexResponse extends ResponseBase {
+  talents: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a talent.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TalentResponse extends ResponseBase {
+  id: number;
+  overrides_spell?: NameIdKey;
+  playable_class?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  playable_specialization?: NameIdKey;
+  rank_descriptions?: Array<RankDescription>;
+  spell?: NameIdKey;
+}
+/**
+ * The response for a talent tree index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TalentTreeIndexResponse extends ResponseBase {
+  class_talent_trees: Array<TalentTree>;
+  hero_talent_trees: Array<NameIdKey>;
+  spec_talent_trees: Array<TalentTree>;
+}
+/**
+ * The response for a talent tree nodes.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TalentTreeNodesResponse extends ResponseBase {
+  id: number;
+  spec_talent_trees: Array<SpecTalentTree>;
+  talent_nodes: Array<TalentNode>;
+}
+/**
+ * The response for a talent tree.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TalentTreeResponse extends NameId, ResponseBase {
+  class_talent_nodes: Array<ClassTalentNode>;
+  hero_talent_trees: Array<HeroTalentTree>;
+  media: KeyBase;
+  playable_class: NameIdKey;
+  playable_specialization: NameIdKey;
+  restriction_lines: Array<RestrictionLine>;
+  spec_talent_nodes: Array<SpecTalentNode>;
+}
+interface ChoiceOfTooltip {
+  spell_tooltip: PurpleSpellTooltip;
+  talent: NameIdKey;
+}
+interface ClassTalentNode {
+  display_col: number;
+  display_row: number;
+  id: number;
+  locked_by?: Array<number>;
+  node_type: NodeType;
+  ranks: Array<ClassTalentNodeRank>;
+  raw_position_x: number;
+  raw_position_y: number;
+  unlocks?: Array<number>;
+}
+interface ClassTalentNodeRank {
+  choice_of_tooltips?: Array<Tooltip>;
+  default_points?: number;
+  rank: number;
+  tooltip?: Tooltip;
+}
+interface HeroTalentTree extends NameId {
+  hero_talent_nodes: Array<HeroTalentTreeNode>;
+  media: KeyBase & {
+    id: number;
+  };
+  playable_class: NameIdKey;
+  playable_specializations: Array<NameIdKey>;
+}
+interface HeroTalentTreeNode {
+  display_col: number;
+  display_row: number;
+  id: number;
+  locked_by?: Array<number>;
+  node_type: {
+    id: number;
+    type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
+  };
+  ranks: Array<Rank>;
+  raw_position_x: number;
+  raw_position_y: number;
+  unlocks?: Array<number>;
+}
+interface NodeType {
+  id: number;
+  type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
+}
+interface PurpleSpellTooltip {
+  cast_time: string;
+  description: string;
+  spell: NameIdKey;
+}
+interface Rank {
+  choice_of_tooltips?: Array<Tooltip>;
+  default_points?: number;
+  rank: number;
+  tooltip?: Tooltip;
+}
+interface RankDescription {
+  description: null | string;
+  rank: number;
+}
+interface RestrictionLine {
+  is_for_class: boolean;
+  required_points: number;
+  restricted_row: number;
+}
+interface SpecTalentNode {
+  display_col: number;
+  display_row: number;
+  id: number;
+  locked_by?: Array<number>;
+  node_type: NodeType;
+  ranks: Array<SpecTalentNodeRank>;
+  raw_position_x: number;
+  raw_position_y: number;
+  unlocks?: Array<number>;
+}
+interface SpecTalentNodeRank {
+  choice_of_tooltips?: Array<ChoiceOfTooltip>;
+  rank: number;
+  tooltip?: Tooltip;
+}
+interface SpecTalentTree extends KeyBase {
+  name: string;
+}
+interface TalentNode {
+  display_col: number;
+  display_row: number;
+  id: number;
+  locked_by?: Array<number>;
+  node_type: NodeType;
+  ranks: Array<Rank>;
+  raw_position_x: number;
+  raw_position_y: number;
+  unlocks?: Array<number>;
+}
+interface TalentTree extends KeyBase {
+  name: string;
+}
+interface Tooltip {
+  spell_tooltip: TooltipSpellTooltip;
+  talent: NameIdKey;
+}
+interface TooltipSpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  power_cost?: string;
+  range?: string;
+  spell: NameIdKey;
+}
+//#endregion
+//#region src/talent/index.d.ts
+/**
+ * Get a PvP talent by ID.
+ * @param pvpTalentId The PvP talent ID.
+ * @returns The PvP talent. See {@link PvpTalentResponse}.
+ */
+declare function pvpTalent(pvpTalentId: number): Resource<PvpTalentResponse>;
+/**
+ * Get a PvP talent index.
+ * @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
+ */
+declare function pvpTalentIndex(): Resource<PvpTalentIndexResponse>;
+/**
+ * Get a talent by ID.
+ * @param talentId The talent ID.
+ * @returns The talent. See {@link TalentResponse}.
+ */
+declare function talent(talentId: number): Resource<TalentResponse>;
+/**
+ * Get a talent index.
+ * @returns The talent index. See {@link TalentIndexResponse}.
+ */
+declare function talentIndex(): Resource<TalentIndexResponse>;
+/**
+ * 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}.
+ */
+declare function talentTree(talentTreeId: number, specId: number): Resource<TalentTreeResponse>;
+/**
+ * Get a talent tree index.
+ * @returns The talent tree index. See {@link TalentTreeIndexResponse}.
+ */
+declare function talentTreeIndex(): Resource<TalentTreeIndexResponse>;
+/**
+ * Get talent tree nodes by talent tree ID.
+ * @param talentTreeId The talent tree ID.
+ * @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
+ */
+declare function talentTreeNodes(talentTreeId: number): Resource<TalentTreeNodesResponse>;
+//#endregion
+export { talentTree as a, PvpTalentIndexResponse as c, TalentResponse as d, TalentTreeIndexResponse as f, talentIndex as i, PvpTalentResponse as l, TalentTreeResponse as m, pvpTalentIndex as n, talentTreeIndex as o, TalentTreeNodesResponse as p, talent as r, talentTreeNodes as s, pvpTalent as t, TalentIndexResponse as u };
+//# sourceMappingURL=index-BOz0BCUN2.d.ts.map

package/dist/index-BUSzkCHP2.d.ts

@@ -0,0 +1,38 @@
+import { Faction, GenderName, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/playable-race/types.d.ts
+/**
+ * The playable race index response.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableRaceIndexResponse extends ResponseBase {
+  races: Array<NameIdKey>;
+}
+/**
+ * The playable race response.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableRaceResponse extends NameId, ResponseBase {
+  faction: Faction;
+  gender_name: GenderName;
+  is_allied_race: boolean;
+  is_selectable: boolean;
+  playable_classes: Array<NameIdKey>;
+  racial_spells: Array<NameIdKey>;
+}
+//#endregion
+//#region src/playable-race/index.d.ts
+/**
+ * Get a playable race by ID.
+ * @param playableRaceId The playable race ID.
+ * @returns The playable race. See {@link PlayableRaceResponse}.
+ */
+declare function playableRace(playableRaceId: number): Resource<PlayableRaceResponse>;
+/**
+ * Get a playable race index.
+ * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
+ */
+declare function playableRaceIndex(): Resource<PlayableRaceIndexResponse>;
+//#endregion
+export { PlayableRaceResponse as i, playableRaceIndex as n, PlayableRaceIndexResponse as r, playableRace as t };
+//# sourceMappingURL=index-BUSzkCHP2.d.ts.map

package/dist/index-BWGWNZX7.d.ts

@@ -0,0 +1,62 @@
+import { Color, KeyBase, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/guild-crest/types.d.ts
+/**
+ * The response for a guild crest border or emblem.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface GuildCrestBorderEmblemResponse extends ResponseBase {
+  assets: Array<GuildCrestAsset>;
+  id: number;
+}
+/**
+ * The response for the guild crest components index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface GuildCrestComponentsIndexResponse extends ResponseBase {
+  borders: Array<Border>;
+  colors: Colors;
+  emblems: Array<Border>;
+}
+interface Background {
+  id: number;
+  rgba: Color;
+}
+interface Border {
+  id: number;
+  media: Media;
+}
+interface Colors {
+  backgrounds: Array<Background>;
+  borders: Array<Background>;
+  emblems: Array<Background>;
+}
+interface GuildCrestAsset {
+  key: string;
+  value: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/guild-crest/index.d.ts
+/**
+ * Get a guild crest border by ID.
+ * @param borderId The guild crest border ID.
+ * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
+ */
+declare function guildCrestBorder(borderId: number): Resource<GuildCrestBorderEmblemResponse>;
+/**
+ * Get the guild crest components index.
+ * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
+ */
+declare function guildCrestComponentsIndex(): Resource<GuildCrestComponentsIndexResponse>;
+/**
+ * Get a guild crest emblem by ID.
+ * @param emblemId The guild crest emblem ID.
+ * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
+ */
+declare function guildCrestEmblem(emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
+//#endregion
+export { GuildCrestComponentsIndexResponse as a, GuildCrestBorderEmblemResponse as i, guildCrestComponentsIndex as n, guildCrestEmblem as r, guildCrestBorder as t };
+//# sourceMappingURL=index-BWGWNZX7.d.ts.map