@blizzard-api/wow 3.0.5 → 4.0.0

package/dist/index-DxEXkR_n.d.ts

@@ -0,0 +1,81 @@
+import { Href, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/modified-crafting/types.d.ts
+/**
+ * The response for a modified crafting category index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ModifiedCraftingCategoryIndexResponse extends ResponseBase {
+  categories: Array<KeyBase & {
+    id: number;
+    name?: null | string;
+  }>;
+}
+/**
+ * The response for a modified crafting category.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ModifiedCraftingCategoryResponse extends ResponseBase {
+  id: number;
+  name?: string;
+}
+/**
+ * The response for a modified crafting index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ModifiedCraftingIndexResponse extends ResponseBase {
+  categories: Href;
+  slot_types: Href;
+}
+/**
+ * The response for a modified crafting reagent slot type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ModifiedCraftingReagentSlotTypeIndexResponse extends ResponseBase {
+  slot_types: Array<SlotType>;
+}
+/**
+ * The response for a modified crafting reagent slot type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ModifiedCraftingReagentSlotTypeResponse extends ResponseBase {
+  compatible_categories: Array<NameIdKey>;
+  description: string;
+  id: number;
+}
+interface SlotType extends KeyBase {
+  id: number;
+  name?: null | string;
+}
+//#endregion
+//#region src/modified-crafting/index.d.ts
+/**
+ * Get a modified crafting category by ID.
+ * @param modifiedCraftingCategoryId The modified crafting category ID.
+ * @returns The modified crafting category. See {@link ModifiedCraftingCategoryResponse}.
+ */
+declare function modifiedCraftingCategory(modifiedCraftingCategoryId: number): Resource<ModifiedCraftingCategoryResponse>;
+/**
+ * Get a modified crafting category index.
+ * @returns The modified crafting category index. See {@link ModifiedCraftingCategoryIndexResponse}.
+ */
+declare function modifiedCraftingCategoryIndex(): Resource<ModifiedCraftingCategoryIndexResponse>;
+/**
+ * Get a modified crafting index.
+ * @returns The modified crafting index. See {@link ModifiedCraftingIndexResponse}.
+ */
+declare function modifiedCraftingIndex(): Resource<ModifiedCraftingIndexResponse>;
+/**
+ * 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}.
+ */
+declare function modifiedCraftingReagentSlotType(modifiedCraftingReagentSlotTypeId: number): Resource<ModifiedCraftingReagentSlotTypeResponse>;
+/**
+ * Get a modified crafting reagent slot type index.
+ * @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
+ */
+declare function modifiedCraftingReagentSlotTypeIndex(): Resource<ModifiedCraftingReagentSlotTypeIndexResponse>;
+//#endregion
+export { modifiedCraftingReagentSlotTypeIndex as a, ModifiedCraftingIndexResponse as c, modifiedCraftingReagentSlotType as i, ModifiedCraftingReagentSlotTypeIndexResponse as l, modifiedCraftingCategoryIndex as n, ModifiedCraftingCategoryIndexResponse as o, modifiedCraftingIndex as r, ModifiedCraftingCategoryResponse as s, modifiedCraftingCategory as t, ModifiedCraftingReagentSlotTypeResponse as u };
+//# sourceMappingURL=index-DxEXkR_n.d.ts.map

package/dist/index-Dzfv2QaX.d.ts

@@ -0,0 +1,65 @@
+import { Character, Color, KeyBase, NameId, NameIdKey, Realm, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-mythic-keystone-profile/types.d.ts
+interface CharacterMythicKeystoneProfileIndexResponse extends ResponseBase {
+  character: Character;
+  current_period: CurrentPeriod;
+  seasons: Array<KeyBase & {
+    id: number;
+  }>;
+}
+interface CharacterMythicKeystoneSeasonDetailsResponse extends ResponseBase {
+  best_runs: Array<BestRun>;
+  character: Character;
+  mythic_rating: MythicRating;
+  season: KeyBase & {
+    id: number;
+  };
+}
+interface BestRun {
+  completed_timestamp: number;
+  dungeon: NameIdKey;
+  duration: number;
+  is_completed_within_time: boolean;
+  keystone_affixes: Array<NameIdKey>;
+  keystone_level: number;
+  members: Array<Member>;
+  mythic_rating: MythicRating;
+}
+interface CurrentPeriod {
+  period: KeyBase & {
+    id: number;
+  };
+}
+interface Member {
+  character: NameId & {
+    realm: Realm;
+  };
+  equipped_item_level: number;
+  race: NameIdKey;
+  specialization: NameIdKey;
+}
+interface MythicRating {
+  color: Color;
+  rating: number;
+}
+//#endregion
+//#region src/character-mythic-keystone-profile/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns Returns the Mythic Keystone season details for a character. Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
+ */
+declare function characterMythicKeystoneProfileIndex(realmSlug: string, characterName: string): Resource<CharacterMythicKeystoneProfileIndexResponse>;
+/**
+ * Returns the Mythic Keystone season details for a character.
+ * Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @param seasonId The ID of the season.
+ * @returns the Mythic Keystone season details for a character.
+ */
+declare function characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): Resource<CharacterMythicKeystoneSeasonDetailsResponse>;
+//#endregion
+export { CharacterMythicKeystoneSeasonDetailsResponse as i, characterMythicKeystoneSeasonDetails as n, CharacterMythicKeystoneProfileIndexResponse as r, characterMythicKeystoneProfileIndex as t };
+//# sourceMappingURL=index-Dzfv2QaX.d.ts.map

package/dist/index-J46u_PSy2.d.ts

@@ -0,0 +1,117 @@
+import { KeyBase, MediaAsset, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/pet/types.d.ts
+/**
+ * The response for a pet ability index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PetAbilityIndexResponse extends ResponseBase {
+  abilities: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a pet ability media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PetAbilityMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a pet ability.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PetAbilityResponse extends NameId, ResponseBase {
+  battle_pet_type: BattlePetType;
+  cooldown?: number;
+  media: Media;
+  rounds: number;
+}
+/**
+ * The response for a pet index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PetIndexResponse extends ResponseBase {
+  pets: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a pet search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PetMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a pet.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PetResponse extends NameId, ResponseBase {
+  abilities?: Array<Ability>;
+  battle_pet_type: BattlePetType;
+  creature: NameIdKey;
+  description: null | string;
+  icon: string;
+  is_alliance_only: boolean;
+  is_battlepet: boolean;
+  is_capturable: boolean;
+  is_horde_only: boolean;
+  is_random_creature_display: boolean;
+  is_tradable: boolean;
+  media: Media;
+  should_exclude_if_uncollected?: boolean;
+  source?: Source;
+}
+interface Ability {
+  ability: NameIdKey;
+  required_level: number;
+  slot: number;
+}
+interface BattlePetType extends NameId {
+  type: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Source {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region src/pet/index.d.ts
+/**
+ * Get a pet by ID.
+ * @param petId The pet ID.
+ * @returns The pet. See {@link PetResponse}.
+ */
+declare function pet(petId: number): Resource<PetResponse>;
+/**
+ * Get a pet ability by ID.
+ * @param petAbilityId The pet ability ID.
+ * @returns The pet ability. See {@link PetAbilityResponse}.
+ */
+declare function petAbility(petAbilityId: number): Resource<PetAbilityResponse>;
+/**
+ * Get a pet ability index.
+ * @returns The pet ability index. See {@link PetAbilityIndexResponse}.
+ */
+declare function petAbilityIndex(): Resource<PetAbilityIndexResponse>;
+/**
+ * Get a pet ability media by ID.
+ * @param petAbilityId The pet ability ID.
+ * @returns The pet ability media. See {@link PetAbilityMediaResponse}.
+ */
+declare function petAbilityMedia(petAbilityId: number): Resource<PetAbilityMediaResponse>;
+/**
+ * Get a pet index.
+ * @returns The pet index. See {@link PetIndexResponse}.
+ */
+declare function petIndex(): Resource<PetIndexResponse>;
+/**
+ * Get a pet media by ID.
+ * @param petId The pet ID.
+ * @returns The pet media. See {@link PetMediaResponse}.
+ */
+declare function petMedia(petId: number): Resource<PetMediaResponse>;
+//#endregion
+export { petIndex as a, PetAbilityMediaResponse as c, PetMediaResponse as d, PetResponse as f, petAbilityMedia as i, PetAbilityResponse as l, petAbility as n, petMedia as o, petAbilityIndex as r, PetAbilityIndexResponse as s, pet as t, PetIndexResponse as u };
+//# sourceMappingURL=index-J46u_PSy2.d.ts.map

package/dist/index-LhUh1Lk5.d.ts

@@ -0,0 +1,30 @@
+import { Character, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-hunter-pets/types.d.ts
+interface CharacterHunterPetsSummaryResponse extends ResponseBase {
+  character: Character;
+  hunter_pets: Array<HunterPet>;
+}
+interface HunterPet {
+  creature: NameIdKey;
+  creature_display: KeyBase & {
+    id: number;
+  };
+  is_active?: boolean;
+  is_summoned?: boolean;
+  level: number;
+  name: string;
+  slot: number;
+}
+//#endregion
+//#region src/character-hunter-pets/index.d.ts
+/**
+ * If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the character's hunter pets.
+ */
+declare function characterHunterPetsSummary(realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
+//#endregion
+export { CharacterHunterPetsSummaryResponse as n, characterHunterPetsSummary as t };
+//# sourceMappingURL=index-LhUh1Lk5.d.ts.map

package/dist/index-SfMQ7bBi2.d.ts

@@ -0,0 +1,86 @@
+import { Faction, KeyBase, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/reputations/types.d.ts
+/**
+ * The response for a reputation faction index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationFactionIndexResponse extends ResponseBase {
+  factions: Array<NullishNameIdKey>;
+  root_factions: Array<NameIdKey>;
+}
+/**
+ * The response for a reputation faction.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationFactionResponse extends ResponseBase {
+  can_paragon?: boolean;
+  description?: string;
+  factions?: Array<NameIdKey>;
+  header_shows_bar?: boolean;
+  id: number;
+  is_header?: boolean;
+  is_renown?: boolean;
+  name: string;
+  player_faction?: Faction;
+  renown_tiers?: Array<RenownTier>;
+  reputation_tiers?: ReputationTier;
+}
+/**
+ * The response for a reputation tier index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationTiersIndexResponse extends ResponseBase {
+  reputation_tiers: Array<ReputationTier>;
+}
+/**
+ * The response for a reputation tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ReputationTiersResponse extends ResponseBase {
+  faction?: NameIdKey;
+  id: number;
+  tiers: Array<Tier>;
+}
+interface RenownTier {
+  level: number;
+  name: string;
+  rewards: Array<NameIdKey>;
+}
+interface ReputationTier extends KeyBase {
+  id: number;
+  name?: string;
+}
+interface Tier {
+  id: number;
+  max_value: number;
+  min_value: number;
+  name: string;
+}
+//#endregion
+//#region src/reputations/index.d.ts
+/**
+ * Get a reputation faction by ID.
+ * @param reputationFactionId The reputation faction ID.
+ * @returns The reputation faction. See {@link ReputationFactionResponse}.
+ */
+declare function reputationFaction(reputationFactionId: number): Resource<ReputationFactionResponse>;
+/**
+ * Get a reputation faction index.
+ * @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
+ */
+declare function reputationFactionIndex(): Resource<ReputationFactionIndexResponse>;
+/**
+ * Get a reputation tier by ID.
+ * @param reputationTiersId The reputation tier ID.
+ * @returns The reputation tier. See {@link ReputationTiersResponse}.
+ */
+declare function reputationTiers(reputationTiersId: number): Resource<ReputationTiersResponse>;
+/**
+ * Get a reputation tier index.
+ * @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
+ */
+declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
+//#endregion
+export { ReputationFactionIndexResponse as a, ReputationTiersResponse as c, reputationTiersIndex as i, reputationFactionIndex as n, ReputationFactionResponse as o, reputationTiers as r, ReputationTiersIndexResponse as s, reputationFaction as t };
+//# sourceMappingURL=index-SfMQ7bBi2.d.ts.map

package/dist/index-Xyv-CG_n.d.ts

@@ -0,0 +1,160 @@
+import { Character, Color, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-equipment/types.d.ts
+interface CharacterEquipmentSummaryResponse extends ResponseBase {
+  character: Character;
+  equipped_item_sets?: Array<Set>;
+  equipped_items: Array<EquippedItem>;
+}
+interface Armor {
+  display: NameDescription;
+  value: number;
+}
+interface Damage {
+  damage_class: NameType;
+  display_string: string;
+  max_value: number;
+  min_value: number;
+}
+interface DisplayStrings {
+  copper: string;
+  gold: string;
+  header: string;
+  silver: string;
+}
+interface DisplayStringValue {
+  display_string: string;
+  value: number;
+}
+interface Effect {
+  display_string: string;
+  is_active?: boolean;
+  required_count: number;
+}
+interface Enchantment {
+  display_string: string;
+  enchantment_id: number;
+  enchantment_slot: EnchantmentSlot;
+  source_item?: NameIdKey;
+}
+interface EnchantmentSlot {
+  id: number;
+  type: string;
+}
+interface EquippedItem {
+  armor?: Armor;
+  binding: NameType;
+  bonus_list?: Array<number>;
+  context: number;
+  description?: string;
+  durability?: DisplayStringValue;
+  enchantments?: Array<Enchantment>;
+  inventory_type: NameType;
+  is_subclass_hidden?: boolean;
+  item: KeyBase & {
+    id: number;
+  };
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level: DisplayStringValue;
+  limit_category?: string;
+  media: KeyBase & {
+    id: number;
+  };
+  modified_appearance_id?: number;
+  modified_crafting_stat?: Array<ModifiedCraftingStat>;
+  name: string;
+  name_description?: NameDescription;
+  quality: NameType;
+  quantity: number;
+  requirements?: Requirements;
+  sell_price?: SellPrice;
+  set?: Set;
+  slot: NameType;
+  sockets?: Array<Socket>;
+  spells?: Array<Spell>;
+  stats?: Array<Stat>;
+  transmog?: Transmog;
+  unique_equipped?: string;
+  weapon?: Weapon;
+}
+interface ItemElement {
+  is_equipped?: boolean;
+  item: NameIdKey;
+}
+interface ModifiedCraftingStat {
+  id: number;
+  name: string;
+  type: string;
+}
+interface NameDescription {
+  color: Color;
+  display_string: string;
+}
+interface NameType {
+  name: string;
+  type: string;
+}
+interface PlayableClasses {
+  display_string: string;
+  links: Array<NameIdKey>;
+}
+interface Requirements {
+  level: DisplayStringValue;
+  playable_classes?: PlayableClasses;
+}
+interface SellPrice {
+  display_strings: DisplayStrings;
+  value: number;
+}
+interface Set {
+  display_string: string;
+  effects: Array<Effect>;
+  item_set: NameIdKey;
+  items: Array<ItemElement>;
+}
+interface Socket {
+  context?: number;
+  display_color?: Color;
+  display_string?: string;
+  item?: NameIdKey;
+  media?: KeyBase & {
+    id: number;
+  };
+  socket_type: NameType;
+}
+interface Spell {
+  description: string;
+  display_color?: Color;
+  spell: NameIdKey;
+}
+interface Stat {
+  display: NameDescription;
+  is_equip_bonus?: boolean;
+  is_negated?: boolean;
+  type: NameType;
+  value: number;
+}
+interface Transmog {
+  display_string: string;
+  item: NameIdKey;
+  item_modified_appearance_id: number;
+  second_item?: NameIdKey;
+  second_item_modified_appearance_id?: number;
+}
+interface Weapon {
+  attack_speed: DisplayStringValue;
+  damage: Damage;
+  dps: DisplayStringValue;
+}
+//#endregion
+//#region src/character-equipment/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the items equipped by a character.
+ */
+declare function characterEquipmentSummary(realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
+//#endregion
+export { CharacterEquipmentSummaryResponse as n, characterEquipmentSummary as t };
+//# sourceMappingURL=index-Xyv-CG_n.d.ts.map

package/dist/index-ZAJGdEvm.d.ts

@@ -0,0 +1,102 @@
+import { Color, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/heirloom/types.d.ts
+/**
+ * The response for the heirloom index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface HeirloomIndexResponse extends ResponseBase {
+  heirlooms: Array<NameIdKey>;
+}
+/**
+ * The response for a heirloom.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface HeirloomResponse extends ResponseBase {
+  id: number;
+  item: NameIdKey;
+  media: Media;
+  source: Source;
+  source_description: string;
+  upgrades: Array<Upgrade>;
+}
+interface AttackSpeedClass {
+  display_string: string;
+  value: number;
+}
+interface Damage {
+  damage_class: Source;
+  display_string: string;
+  max_value: number;
+  min_value: number;
+}
+interface Display {
+  color: Color;
+  display_string: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Requirements {
+  level: RequirementsLevel;
+}
+interface RequirementsLevel {
+  display_string: string;
+}
+interface Source {
+  name: string;
+  type: string;
+}
+interface Stat {
+  display: Display;
+  is_equip_bonus?: boolean;
+  type: Source;
+  value: number;
+}
+interface Upgrade {
+  item: UpgradeItem;
+  level: number;
+}
+interface UpgradeItem {
+  binding: Source;
+  bonus_list: Array<number>;
+  context: number;
+  inventory_type: Source;
+  item: Media;
+  item_class: NameIdKey;
+  item_subclass: NameIdKey;
+  level: AttackSpeedClass;
+  media: Media;
+  name: string;
+  quality: Source;
+  requirements: Requirements;
+  stats: Array<Stat>;
+  upgrades: Upgrades;
+  weapon: Weapon;
+}
+interface Upgrades {
+  display_string: string;
+  max_value: number;
+  value: number;
+}
+interface Weapon {
+  attack_speed: AttackSpeedClass;
+  damage: Damage;
+  dps: AttackSpeedClass;
+}
+//#endregion
+//#region src/heirloom/index.d.ts
+/**
+ * Get a heirloom by ID.
+ * @param heirloomId The heirloom ID.
+ * @returns The heirloom. See {@link HeirloomResponse}.
+ */
+declare function heirloom(heirloomId: number): Resource<HeirloomResponse>;
+/**
+ * Get the heirloom index.
+ * @returns The heirloom index. See {@link HeirloomIndexResponse}.
+ */
+declare function heirloomIndex(): Resource<HeirloomIndexResponse>;
+//#endregion
+export { HeirloomResponse as i, heirloomIndex as n, HeirloomIndexResponse as r, heirloom as t };
+//# sourceMappingURL=index-ZAJGdEvm.d.ts.map