@blizzard-api/wow 3.0.6 → 4.0.1

package/dist/index-CP1gTrDv.d.ts

@@ -0,0 +1,312 @@
+import { BaseSearchParameters, Color, KeyBase, Locales, MediaAsset, NameId, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/item/types.d.ts
+/**
+ * The response for an item class index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemClassIndexResponse extends ResponseBase {
+  item_classes: Array<NameIdKey>;
+}
+/**
+ * The response for an item class.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemClassResponse extends ResponseBase {
+  class_id: number;
+  item_subclasses: Array<NameIdKey>;
+  name: string;
+}
+/**
+ * The response for an item media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for an item.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemResponse extends NameId, ResponseBase {
+  appearances?: Array<KeyBase & {
+    id: number;
+  }>;
+  description?: string;
+  inventory_type: InventoryTypeName;
+  is_equippable: boolean;
+  is_stackable: boolean;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level: number;
+  max_count: number;
+  media: Media;
+  preview_item: PreviewItem;
+  purchase_price: number;
+  purchase_quantity: number;
+  quality: ItemQuality;
+  required_level: number;
+  sell_price: number;
+}
+/**
+ * The parameters for an item search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface ItemSearchParameters extends BaseSearchParameters {
+  locale: Locales;
+  name: string;
+}
+/**
+ * The response for an item search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface ItemSearchResponse extends SearchResponseWithoutResults {
+  results: Array<ItemSearchResponseItem>;
+}
+/**
+ * The response for an item set index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSetIndexResponse extends ResponseBase {
+  item_sets: Array<NameIdKey>;
+}
+/**
+ * The response for an item set.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSetResponse extends ResponseBase {
+  effects: Array<Effect>;
+  id: number;
+  items: Array<NameIdKey>;
+  name: string;
+}
+/**
+ * The response for an item subclass.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ItemSubClassResponse extends ResponseBase {
+  class_id: number;
+  display_name: string;
+  hide_subclass_in_tooltips?: boolean;
+  subclass_id: number;
+  verbose_name?: string;
+}
+interface Armor {
+  display: Display;
+  value: number;
+}
+interface Damage {
+  damage_class: {
+    name: string;
+    type: string;
+  };
+  display_string: string;
+  max_value: number;
+  min_value: number;
+}
+interface Display {
+  color: Color;
+  display_string: string;
+}
+interface Durability {
+  display_string: string;
+  value: number;
+}
+interface Effect {
+  display_string: string;
+  required_count: number;
+}
+type InventoryType = 'BACK' | 'CHEST' | 'FEET' | 'FINGER' | 'HAND' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'SHOULDER' | 'THROWN' | 'TRINKET' | 'WAIST' | 'WRIST' | 'RANGED' | 'TWOHWEAPON' | 'WEAPON' | 'WEAPONMAINHAND' | 'WEAPONOFFHAND' | 'BAG' | 'NON_EQUIP' | 'SHIRT' | 'TABARD';
+interface InventoryTypeName {
+  name: string;
+  type: InventoryType;
+}
+interface InventoryTypeNameFromSearch {
+  name: Record<Locales, string>;
+  type: InventoryType;
+}
+interface ItemQuality {
+  name: string;
+  type: ItemQualityType;
+}
+interface ItemQualityFromSearch {
+  name: Record<Locales, string>;
+  type: ItemQualityType;
+}
+type ItemQualityType = 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
+interface ItemSearchResponseItem extends KeyBase {
+  data: {
+    appearances?: Array<{
+      id: number;
+    }>;
+    id: number;
+    inventory_type: InventoryTypeNameFromSearch;
+    is_equippable: boolean;
+    is_stackable: boolean;
+    item_class: {
+      id: number;
+      name: Record<Locales, string>;
+    };
+    item_subclass: {
+      id: number;
+      name: Record<Locales, string>;
+    };
+    level: number;
+    max_count: number;
+    media: {
+      id: number;
+    };
+    name: Record<Locales, string | undefined>;
+    purchase_price: number;
+    purchase_quantity: number;
+    quality: ItemQualityFromSearch;
+    required_level: number;
+    sell_price: number;
+  };
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface PreviewItem {
+  armor?: Armor;
+  binding?: {
+    name: string;
+    type: string;
+  };
+  bonus_list?: Array<number>;
+  container_slots?: Durability;
+  context?: number;
+  crafting_reagent?: string;
+  description?: string;
+  durability?: Durability;
+  inventory_type: InventoryTypeName;
+  is_subclass_hidden?: boolean;
+  item: Media;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level?: Durability;
+  media: Media;
+  name: string;
+  quality: ItemQuality;
+  recipe?: Recipe;
+  requirements?: Requirements;
+  sell_price?: number;
+  shield_block?: Armor;
+  spells?: Array<Spell>;
+  stats?: Array<Stat>;
+  unique_equipped?: string;
+  weapon?: Weapon;
+}
+interface Recipe {
+  item: RecipeItem;
+  reagents: Array<NameIdKey & {
+    quantity: number;
+  }>;
+  reagents_display_string: string;
+}
+interface RecipeItem {
+  armor?: Armor;
+  binding: {
+    name: string;
+    type: string;
+  };
+  durability: Durability;
+  inventory_type: InventoryTypeName;
+  item: Media;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level: Durability;
+  media: Media;
+  name: string;
+  quality: ItemQuality;
+  requirements: Requirements;
+  sell_price: {
+    display_strings: RecipeItemDisplayStrings;
+    value: number;
+  };
+  stats: Array<Stat>;
+  weapon?: Weapon;
+}
+interface RecipeItemDisplayStrings {
+  copper: string;
+  gold: string;
+  header: string;
+  silver: string;
+}
+interface Requirements {
+  level: Durability;
+}
+interface Spell {
+  description: string;
+  spell: NameIdKey;
+}
+interface Stat {
+  display: Display;
+  is_negated?: boolean;
+  type: {
+    name: string;
+    type: StatTypeCapitalized;
+  };
+  value: number;
+}
+type StatTypeCapitalized = 'AGILITY' | 'ARCANE_RESISTANCE' | 'CRIT_RATING' | 'FIRE_RESISTANCE' | 'FROST_RESISTANCE' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'NATURE_RESISTANCE' | 'SHADOW_RESISTANCE' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
+interface Weapon {
+  attack_speed: Durability;
+  damage: Damage;
+  dps: Durability;
+}
+//#endregion
+//#region src/item/index.d.ts
+/**
+ * Get an item by ID.
+ * @param itemId The item ID.
+ * @returns The item. See {@link ItemResponse}.
+ */
+declare function item(itemId: number): Resource<ItemResponse>;
+/**
+ * Get an item class by ID.
+ * @param itemClassId The item class ID.
+ * @returns The item class. See {@link ItemClassResponse}.
+ */
+declare function itemClass(itemClassId: number): Resource<ItemClassResponse>;
+/**
+ * Get an item class index.
+ * @returns The item class index. See {@link ItemClassIndexResponse}.
+ */
+declare function itemClassIndex(): Resource<ItemClassIndexResponse>;
+/**
+ * Get item media by ID.
+ * @param itemId The item ID.
+ * @returns The item media. See {@link ItemMediaResponse}.
+ */
+declare function itemMedia(itemId: number): Resource<ItemMediaResponse>;
+/**
+ * Search for items.
+ * @param options The search parameters. See {@link ItemSearchParameters}.
+ * @returns The search results. See {@link ItemSearchResponse}.
+ */
+declare function itemSearch(options: ItemSearchParameters): Resource<ItemSearchResponse, Omit<ItemSearchParameters, 'locale' | 'name'>>;
+/**
+ * Get an item set by ID.
+ * @param itemSetId The item set ID.
+ * @returns The item set. See {@link ItemSetResponse}.
+ */
+declare function itemSet(itemSetId: number): Resource<ItemSetResponse>;
+/**
+ * Get an item set index.
+ * @returns The item set index. See {@link ItemSetIndexResponse}.
+ */
+declare function itemSetIndex(): Resource<ItemSetIndexResponse>;
+/**
+ * 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}.
+ */
+declare function itemSubClass(itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
+//#endregion
+export { ItemSubClassResponse as _, itemSearch as a, itemSubClass as c, ItemMediaResponse as d, ItemResponse as f, ItemSetResponse as g, ItemSetIndexResponse as h, itemMedia as i, ItemClassIndexResponse as l, ItemSearchResponse as m, itemClass as n, itemSet as o, ItemSearchParameters as p, itemClassIndex as r, itemSetIndex as s, item as t, ItemClassResponse as u };
+//# sourceMappingURL=index-CP1gTrDv.d.ts.map

package/dist/index-CQXTvcKu2.d.ts

@@ -0,0 +1,72 @@
+import { Factions, Href, KeyBase, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/mythic-keystone-leaderboard/types.d.ts
+/**
+ * The response for a Mythic Keystone leaderboard index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneLeaderboardIndexResponse extends ResponseBase {
+  current_leaderboards: Array<NameIdKey>;
+}
+/**
+ * The response for a Mythic Keystone leaderboard.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneLeaderboardResponse extends ResponseBase {
+  connected_realm: Href;
+  keystone_affixes: Array<KeystoneAffixElement>;
+  leading_groups: Array<LeadingGroup>;
+  map: NameId;
+  map_challenge_mode_id: number;
+  name: string;
+  period: number;
+  period_end_timestamp: number;
+  period_start_timestamp: number;
+}
+interface KeystoneAffixElement {
+  keystone_affix: NameIdKey;
+  starting_level: number;
+}
+interface LeadingGroup {
+  completed_timestamp: number;
+  duration: number;
+  keystone_level: number;
+  members: Array<Member>;
+  ranking: number;
+}
+interface Member {
+  faction: {
+    type: Factions;
+  };
+  profile: Profile;
+  specialization: Specialization;
+}
+interface Profile extends NameId {
+  realm: Realm$1;
+}
+interface Realm$1 extends KeyBase {
+  id: number;
+  slug: string;
+}
+interface Specialization extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/mythic-keystone-leaderboard/index.d.ts
+/**
+ * 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}.
+ */
+declare function mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId: number, period: number): Resource<MythicKeystoneLeaderboardResponse>;
+/**
+ * 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}.
+ */
+declare function mythicKeystoneLeaderboardIndex(connectedRealmId: number): Resource<MythicKeystoneLeaderboardIndexResponse>;
+//#endregion
+export { MythicKeystoneLeaderboardResponse as i, mythicKeystoneLeaderboardIndex as n, MythicKeystoneLeaderboardIndexResponse as r, mythicKeystoneLeaderboard as t };
+//# sourceMappingURL=index-CQXTvcKu2.d.ts.map

package/dist/index-CS_QQdEk.d.ts

@@ -0,0 +1,22 @@
+import { Character, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-media/types.d.ts
+interface CharacterMediaSummaryResponse extends ResponseBase {
+  assets: Array<Asset>;
+  character: Character;
+}
+interface Asset {
+  key: string;
+  value: string;
+}
+//#endregion
+//#region src/character-media/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the media assets available for a character (such as an avatar render).
+ */
+declare function characterMediaSummary(realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
+//#endregion
+export { CharacterMediaSummaryResponse as n, characterMediaSummary as t };
+//# sourceMappingURL=index-CS_QQdEk.d.ts.map

package/dist/index-CWFif_SP2.d.ts

@@ -0,0 +1,31 @@
+import { NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/power-type/types.d.ts
+/**
+ * The response for a power type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PowerTypeIndexResponse extends ResponseBase {
+  power_types: Array<NameIdKey>;
+}
+/**
+ * The response for a power type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PowerTypeResponse extends NameId, ResponseBase {}
+//#endregion
+//#region src/power-type/index.d.ts
+/**
+ * Get a power type by ID.
+ * @param powerTypeId The power type ID.
+ * @returns The power type. See {@link PowerTypeResponse}.
+ */
+declare function powerType(powerTypeId: number): Resource<PowerTypeResponse>;
+/**
+ * Get a power type index.
+ * @returns The power type index. See {@link PowerTypeIndexResponse}.
+ */
+declare function powerTypeIndex(): Resource<PowerTypeIndexResponse>;
+//#endregion
+export { PowerTypeResponse as i, powerTypeIndex as n, PowerTypeIndexResponse as r, powerType as t };
+//# sourceMappingURL=index-CWFif_SP2.d.ts.map

package/dist/index-ChVDi11Z.d.ts

@@ -0,0 +1,54 @@
+import { Character, Faction, KeyBase, NameId, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-pvp/types.d.ts
+interface CharacterPvpBracketStatisticsResponse extends ResponseBase {
+  bracket: Bracket;
+  character: Character;
+  faction: Faction;
+  rating: number;
+  season: KeyBase & {
+    id: number;
+  };
+  season_match_statistics: MatchStatistics;
+  tier: KeyBase & {
+    id: number;
+  };
+  weekly_match_statistics: MatchStatistics;
+}
+interface CharacterPvpSummaryResponse extends ResponseBase {
+  character: Character;
+  honor_level: number;
+  honorable_kills: number;
+  pvp_map_statistics: Array<PvpMapStatistic>;
+}
+interface Bracket {
+  id: number;
+  type: string;
+}
+interface MatchStatistics {
+  lost: number;
+  played: number;
+  won: number;
+}
+interface PvpMapStatistic {
+  match_statistics: MatchStatistics;
+  world_map: NameId;
+}
+//#endregion
+//#region src/character-pvp/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @param bracketId The ID of the PvP bracket.
+ * @returns a PvP bracket statistics for a character.
+ */
+declare function characterPvpBracketStatistics(realmSlug: string, characterName: string, bracketId: '2v2' | '3v3' | 'rbg' | `shuffle-${string}-${string}`): Resource<CharacterPvpBracketStatisticsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a PvP summary for a character.
+ */
+declare function characterPvpSummary(realmSlug: string, characterName: string): Resource<CharacterPvpSummaryResponse>;
+//#endregion
+export { CharacterPvpSummaryResponse as i, characterPvpSummary as n, CharacterPvpBracketStatisticsResponse as r, characterPvpBracketStatistics as t };
+//# sourceMappingURL=index-ChVDi11Z.d.ts.map

package/dist/index-CmJhDVVk.d.ts

@@ -0,0 +1,157 @@
+import { KeyBase, MediaAsset, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/covenant/types.d.ts
+/**
+ * Interface for a response from the conduit index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ConduitIndexResponse extends ResponseBase {
+  conduits: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the conduit endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ConduitResponse extends ResponseBase {
+  id: number;
+  item: NameIdKey;
+  name: string;
+  ranks: Array<Rank>;
+  socket_type: SocketType;
+}
+/**
+ * Interface for a response from the covenant index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CovenantIndexResponse extends ResponseBase {
+  covenants: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the covenant media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CovenantMediaResponse extends ResponseBase {
+  assets?: Array<MediaAsset>;
+}
+/**
+ * Interface for a response from the covenant endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CovenantResponse extends ResponseBase {
+  class_abilities?: Array<ClassAbility>;
+  description: string;
+  id: number;
+  media?: Media;
+  name: string;
+  renown_rewards: Array<RenownReward>;
+  signature_ability?: SignatureAbility;
+  soulbinds?: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the soulbind index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SoulbindIndexResponse extends ResponseBase {
+  soulbinds: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the soulbind endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SoulbindResponse extends ResponseBase {
+  covenant: NameIdKey;
+  creature: NameIdKey;
+  follower: NameId;
+  id: number;
+  name: string;
+  talent_tree: NameIdKey;
+}
+interface ClassAbility {
+  id: number;
+  playable_class: NameIdKey;
+  spell_tooltip: ClassAbilitySpellTooltip;
+}
+interface ClassAbilitySpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  power_cost?: null | string;
+  range?: string;
+  spell: NameIdKey;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Rank {
+  id: number;
+  spell_tooltip: SpellTooltip;
+  tier: number;
+}
+interface RenownReward {
+  level: number;
+  reward: NameIdKey;
+}
+interface SignatureAbility {
+  id: number;
+  spell_tooltip: SignatureAbilitySpellTooltip;
+}
+interface SignatureAbilitySpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  range?: string;
+  spell: NameIdKey;
+}
+interface SocketType {
+  name: string;
+  type: string;
+}
+interface SpellTooltip {
+  cast_time: string;
+  description: string;
+  spell: NameIdKey;
+}
+//#endregion
+//#region src/covenant/index.d.ts
+/**
+ * Get a conduit by ID.
+ * @param conduitId The conduit ID.
+ * @returns The conduit. See {@link ConduitResponse}.
+ */
+declare function conduit(conduitId: number): Resource<ConduitResponse>;
+/**
+ * Get a conduit index.
+ * @returns The conduit index. See {@link ConduitIndexResponse}.
+ */
+declare function conduitIndex(): Resource<ConduitIndexResponse>;
+/**
+ * Get a covenant by ID.
+ * @param covenantId The covenant ID.
+ * @returns The covenant. See {@link CovenantResponse}.
+ */
+declare function covenant(covenantId: number): Resource<CovenantResponse>;
+/**
+ * Get a covenant index.
+ * @returns The covenant index. See {@link CovenantIndexResponse}.
+ */
+declare function covenantIndex(): Resource<CovenantIndexResponse>;
+/**
+ * Get covenant media by ID.
+ * @param covenantId The covenant ID.
+ * @returns The covenant media. See {@link CovenantMediaResponse}.
+ */
+declare function covenantMedia(covenantId: number): Resource<CovenantMediaResponse>;
+/**
+ * Get a soulbind by ID.
+ * @param soulbindId The soulbind ID.
+ * @returns The soulbind. See {@link SoulbindResponse}.
+ */
+declare function soulbind(soulbindId: number): Resource<SoulbindResponse>;
+/**
+ * Get a soulbind index.
+ * @returns The soulbind index. See {@link SoulbindIndexResponse}.
+ */
+declare function soulbindIndex(): Resource<SoulbindIndexResponse>;
+//#endregion
+export { covenantMedia as a, ConduitIndexResponse as c, CovenantMediaResponse as d, CovenantResponse as f, covenantIndex as i, ConduitResponse as l, SoulbindResponse as m, conduitIndex as n, soulbind as o, SoulbindIndexResponse as p, covenant as r, soulbindIndex as s, conduit as t, CovenantIndexResponse as u };
+//# sourceMappingURL=index-CmJhDVVk.d.ts.map