@blizzard-api/wow 2.0.2 → 2.1.0-next.0

package/dist/character-achievements/character-achievements.d.ts

@@ -0,0 +1,18 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterAchievementsSummaryResponse, CharacterAchievementStatisticsResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the achievements a character has completed.
+ */
+declare function characterAchievementsSummary(realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a character's statistics as they pertain to achievements.
+ */
+declare function characterAchievementStatistics(realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
+
+export { characterAchievementStatistics, characterAchievementsSummary };

package/dist/character-achievements/character-achievements.js

@@ -0,0 +1,3 @@
+export { characterAchievementStatistics, characterAchievementsSummary } from '../chunk-OYEA5CMS.js';
+//# sourceMappingURL=character-achievements.js.map
+//# sourceMappingURL=character-achievements.js.map

package/dist/character-achievements/character-achievements.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-achievements.js"}

package/dist/character-achievements/types.d.ts

@@ -0,0 +1,56 @@
+import { ResponseBase, Character, Href, NameIdKey } from '../base.js';
+
+interface CharacterAchievementsSummaryResponse extends ResponseBase {
+    achievements: Array<Achievement>;
+    category_progress: Array<CategoryProgress>;
+    character: Character;
+    recent_events: Array<RecentEvent>;
+    statistics: Href;
+    total_points: number;
+    total_quantity: number;
+}
+interface CharacterAchievementStatisticsResponse extends ResponseBase {
+    categories: Array<Category>;
+    character: Character;
+}
+interface Achievement {
+    achievement: NameIdKey;
+    completed_timestamp?: number;
+    criteria?: Criteria;
+    id: number;
+}
+interface Category {
+    id: number;
+    name: string;
+    statistics: Array<Statistic>;
+    sub_categories: Array<SubCategory>;
+}
+interface CategoryProgress {
+    category: NameIdKey;
+    points: number;
+    quantity: number;
+}
+interface Criteria {
+    amount?: number;
+    child_criteria?: Array<Criteria>;
+    id: number;
+    is_completed: boolean;
+}
+interface RecentEvent {
+    achievement: NameIdKey;
+    timestamp: number;
+}
+interface Statistic {
+    description?: string;
+    id: number;
+    last_updated_timestamp: number;
+    name: string;
+    quantity: number;
+}
+interface SubCategory {
+    id: number;
+    name: string;
+    statistics: Array<Statistic>;
+}
+
+export type { CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse };

package/dist/character-achievements/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/character-achievements/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/character-appearance/character-appearance.d.ts

@@ -0,0 +1,12 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterAppearanceResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's appearance settings.
+ */
+declare function characterAppearanceSummary(realmSlug: string, characterName: string): Resource<CharacterAppearanceResponse>;
+
+export { characterAppearanceSummary };

package/dist/character-appearance/character-appearance.js

@@ -0,0 +1,3 @@
+export { characterAppearanceSummary } from '../chunk-Z6SN5O7U.js';
+//# sourceMappingURL=character-appearance.js.map
+//# sourceMappingURL=character-appearance.js.map

package/dist/character-appearance/character-appearance.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-appearance.js"}

package/dist/character-appearance/types.d.ts

@@ -0,0 +1,53 @@
+import { ResponseBase, NameIdKey, Character, Faction, Gender, NameId, Color, KeyBase } from '../base.js';
+
+interface CharacterAppearanceResponse extends ResponseBase {
+    active_spec: NameIdKey;
+    character: Character;
+    customizations: Array<Customization>;
+    faction: Faction;
+    gender: Gender;
+    guild_crest: GuildCrest;
+    items: Array<Item>;
+    playable_class: NameIdKey;
+    playable_race: NameIdKey;
+}
+interface BorderEmblem {
+    color: RGBWithId;
+    id: number;
+    media: KeyBase & {
+        id: number;
+    };
+}
+interface Choice {
+    display_order: number;
+    id: number;
+    name?: string;
+}
+interface Customization {
+    choice: Choice;
+    option: NameId;
+}
+interface GuildCrest {
+    background: {
+        color: RGBWithId;
+    };
+    border: BorderEmblem;
+    emblem: BorderEmblem;
+}
+interface Item {
+    enchant: number;
+    id: number;
+    internal_slot_id: number;
+    item_appearance_modifier_id: number;
+    slot: {
+        name: string;
+        type: string;
+    };
+    subclass: number;
+}
+interface RGBWithId {
+    id: number;
+    rgba: Color;
+}
+
+export type { CharacterAppearanceResponse };

package/dist/character-appearance/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/character-appearance/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/character-collections/character-collections.d.ts

@@ -0,0 +1,42 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterCollectionsIndexResponse, CharacterHeirloomsCollectionSummaryResponse, CharacterMountsCollectionSummaryResponse, CharacterPetsCollectionSummaryResponse, CharacterToysCollectionSummaryResponse, CharacterTransmogCollectionSummaryResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @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>;
+
+export { characterCollectionsIndex, characterHeirloomsCollectionSummary, characterMountsCollectionSummary, characterPetsCollectionSummary, characterToysCollectionSummary, characterTransmogCollectionSummary };

package/dist/character-collections/character-collections.js

@@ -0,0 +1,3 @@
+export { characterCollectionsIndex, characterHeirloomsCollectionSummary, characterMountsCollectionSummary, characterPetsCollectionSummary, characterToysCollectionSummary, characterTransmogCollectionSummary } from '../chunk-YB62WBDV.js';
+//# sourceMappingURL=character-collections.js.map
+//# sourceMappingURL=character-collections.js.map

package/dist/character-collections/character-collections.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-collections.js"}

package/dist/character-collections/types.d.ts

@@ -0,0 +1,79 @@
+import { ResponseBase, Character, Href, NameIdKey, KeyBase } from '../base.js';
+
+interface CharacterCollectionsIndexResponse extends ResponseBase {
+    character: Character;
+    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: 'Common' | 'Poor' | 'Rare' | 'Uncommon';
+    type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
+}
+interface Slot {
+    appearances: Array<KeyBase & {
+        id: number;
+    }>;
+    slot: Slot;
+}
+interface Slot {
+    name: string;
+    type: string;
+}
+interface Stats {
+    breed_id: number;
+    health: number;
+    power: number;
+    speed: number;
+}
+interface Toy {
+    is_favorite?: boolean;
+    toy: NameIdKey;
+}
+
+export type { CharacterCollectionsIndexResponse, CharacterHeirloomsCollectionSummaryResponse, CharacterMountsCollectionSummaryResponse, CharacterPetsCollectionSummaryResponse, CharacterToysCollectionSummaryResponse, CharacterTransmogCollectionSummaryResponse };

package/dist/character-collections/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/character-collections/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/character-encounters/character-encounters.d.ts

@@ -0,0 +1,24 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterDungeonsResponse, CharacterEncountersSummaryResponse, CharacterRaidsResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's completed dungeons.
+ */
+declare function characterDungeons(realmSlug: string, characterName: string): Resource<CharacterDungeonsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's encounters.
+ */
+declare function characterEncountersSummary(realmSlug: string, characterName: string): Resource<CharacterEncountersSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's completed raids.
+ */
+declare function characterRaids(realmSlug: string, characterName: string): Resource<CharacterRaidsResponse>;
+
+export { characterDungeons, characterEncountersSummary, characterRaids };

package/dist/character-encounters/character-encounters.js

@@ -0,0 +1,3 @@
+export { characterDungeons, characterEncountersSummary, characterRaids } from '../chunk-CMQTS6M4.js';
+//# sourceMappingURL=character-encounters.js.map
+//# sourceMappingURL=character-encounters.js.map

package/dist/character-encounters/character-encounters.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-encounters.js"}

package/dist/character-encounters/types.d.ts

@@ -0,0 +1,56 @@
+import { ResponseBase, Character, Href, NameIdKey } from '../base.js';
+
+interface CharacterDungeonsResponse extends ResponseBase {
+    expansions: Array<Expansion<DungeonMode>>;
+}
+interface CharacterEncountersSummaryResponse extends ResponseBase {
+    character: Character;
+    dungeons: Href;
+    raids: Href;
+}
+interface CharacterRaidsResponse extends ResponseBase {
+    character: Character;
+    expansions: Array<Expansion<RaidMode>>;
+}
+interface DungeonDifficulties {
+    name: 'Heroic' | 'Mythic' | 'Mythic+ Dungeons' | 'Normal';
+    type: 'HEROIC' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
+}
+interface DungeonMode {
+    difficulty: DungeonDifficulties;
+    progress: Progress;
+    status: Status;
+}
+interface Encounter {
+    completed_count: number;
+    encounter: NameIdKey;
+    last_kill_timestamp: number;
+}
+interface Expansion<T> {
+    expansion: NameIdKey;
+    instances: Array<Instance<T>>;
+}
+interface Instance<T> {
+    instance: NameIdKey;
+    modes: Array<T>;
+}
+interface Progress {
+    completed_count: number;
+    encounters: Array<Encounter>;
+    total_count: number;
+}
+interface RaidDifficulties {
+    name: '10 Player' | '10 Player (Heroic)' | '25 Player' | '25 Player (Heroic)' | 'Heroic' | 'Mythic' | 'Normal' | 'Raid Finder';
+    type: 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
+}
+interface RaidMode {
+    difficulty: RaidDifficulties;
+    progress: Progress;
+    status: Status;
+}
+interface Status {
+    name: 'Complete' | 'In Progress';
+    type: 'COMPLETE' | 'IN_PROGRESS';
+}
+
+export type { CharacterDungeonsResponse, CharacterEncountersSummaryResponse, CharacterRaidsResponse };

package/dist/character-encounters/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/character-encounters/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/character-equipment/character-equipment.d.ts

@@ -0,0 +1,12 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterEquipmentSummaryResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @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>;
+
+export { characterEquipmentSummary };

package/dist/character-equipment/character-equipment.js

@@ -0,0 +1,3 @@
+export { characterEquipmentSummary } from '../chunk-JMTWNL23.js';
+//# sourceMappingURL=character-equipment.js.map
+//# sourceMappingURL=character-equipment.js.map

package/dist/character-equipment/character-equipment.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-equipment.js"}

package/dist/character-equipment/types.d.ts

@@ -0,0 +1,144 @@
+import { ResponseBase, Character, KeyBase, NameIdKey, Color } from '../base.js';
+
+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 extends NameIdKey {
+    is_equipped?: boolean;
+}
+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 {
+    display_string: string;
+    item: NameIdKey;
+    media: KeyBase & {
+        id: number;
+    };
+    socket_type: NameType;
+}
+interface Spell {
+    description: string;
+    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;
+}
+interface Weapon {
+    attack_speed: DisplayStringValue;
+    damage: Damage;
+    dps: DisplayStringValue;
+}
+
+export type { CharacterEquipmentSummaryResponse };

package/dist/character-equipment/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/character-equipment/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/character-hunter-pets/character-hunter-pets.d.ts

@@ -0,0 +1,13 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterHunterPetsSummaryResponse } from './types.js';
+import '../base.js';
+
+/**
+ * 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>;
+
+export { characterHunterPetsSummary };

package/dist/character-hunter-pets/character-hunter-pets.js

@@ -0,0 +1,3 @@
+export { characterHunterPetsSummary } from '../chunk-JAJBQO52.js';
+//# sourceMappingURL=character-hunter-pets.js.map
+//# sourceMappingURL=character-hunter-pets.js.map

package/dist/character-hunter-pets/character-hunter-pets.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-hunter-pets.js"}

package/dist/character-hunter-pets/types.d.ts

@@ -0,0 +1,19 @@
+import { ResponseBase, Character, NameIdKey, KeyBase } from '../base.js';
+
+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;
+}
+
+export type { CharacterHunterPetsSummaryResponse };

package/dist/character-hunter-pets/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/character-hunter-pets/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/character-media/character-media.d.ts

@@ -0,0 +1,12 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterMediaSummaryResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @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>;
+
+export { characterMediaSummary };

package/dist/character-media/character-media.js

@@ -0,0 +1,3 @@
+export { characterMediaSummary } from '../chunk-VTEJNKYT.js';
+//# sourceMappingURL=character-media.js.map
+//# sourceMappingURL=character-media.js.map

package/dist/character-media/character-media.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"character-media.js"}