@blizzard-api/wow/dist/index-DKUy2rnt.d.ts

A series of helpers to interact with the World of Warcraft Blizzard API

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-DKUy2rnt.d.ts.map