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

package/dist/character-mythic-keystone-profile/character-mythic-keystone-profile.d.ts

@@ -0,0 +1,21 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterMythicKeystoneProfileIndexResponse, CharacterMythicKeystoneSeasonDetailsResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @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>;
+
+export { characterMythicKeystoneProfileIndex, characterMythicKeystoneSeasonDetails };

package/dist/character-mythic-keystone-profile/character-mythic-keystone-profile.js

@@ -0,0 +1,3 @@
+export { characterMythicKeystoneProfileIndex, characterMythicKeystoneSeasonDetails } from '../chunk-LE4UHLYZ.js';
+//# sourceMappingURL=character-mythic-keystone-profile.js.map
+//# sourceMappingURL=character-mythic-keystone-profile.js.map

package/dist/character-mythic-keystone-profile/character-mythic-keystone-profile.js.map

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

package/dist/character-mythic-keystone-profile/types.d.ts

@@ -0,0 +1,46 @@
+import { ResponseBase, Character, KeyBase, NameIdKey, NameId, Realm, Color } from '../base.js';
+
+interface CharacterMythicKeystoneProfileIndexResponse extends ResponseBase {
+    character: Character;
+    current_period: CurrentPeriod;
+    seasons: Array<KeyBase & {
+        id: number;
+    }>;
+}
+interface CharacterMythicKeystoneSeasonDetailsResponse extends ResponseBase {
+    best_runs: Array<BestRun>;
+    character: NameIdKey;
+    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;
+}
+
+export type { CharacterMythicKeystoneProfileIndexResponse, CharacterMythicKeystoneSeasonDetailsResponse };

package/dist/character-mythic-keystone-profile/types.js

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

package/dist/character-mythic-keystone-profile/types.js.map

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

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

@@ -0,0 +1,12 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterProfessionsSummaryResponse } 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 professions for a character.
+ */
+declare function characterProfessionsSummary(realmSlug: string, characterName: string): Resource<CharacterProfessionsSummaryResponse>;
+
+export { characterProfessionsSummary };

package/dist/character-professions/character-professions.js

@@ -0,0 +1,3 @@
+export { characterProfessionsSummary } from '../chunk-GLXKCE6S.js';
+//# sourceMappingURL=character-professions.js.map
+//# sourceMappingURL=character-professions.js.map

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

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

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

@@ -0,0 +1,25 @@
+import { ResponseBase, Character, NameIdKey, NameId } from '../base.js';
+
+interface CharacterProfessionsSummaryResponse extends ResponseBase {
+    character: Character;
+    primaries: Array<Primary>;
+    secondaries: Array<Secondary>;
+}
+interface Primary {
+    profession: NameIdKey;
+    tiers: Array<Tier>;
+}
+interface Secondary {
+    max_skill_points?: number;
+    profession: NameIdKey;
+    skill_points?: number;
+    tiers?: Array<Tier>;
+}
+interface Tier {
+    known_recipes?: Array<NameIdKey>;
+    max_skill_points: number;
+    skill_points: number;
+    tier: NameId;
+}
+
+export type { CharacterProfessionsSummaryResponse };

package/dist/character-professions/types.js

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

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

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

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

@@ -0,0 +1,30 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterProfileStatusResponse, CharacterProfileSummaryResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
+ * - an HTTP 404 Not Found error is returned
+ * - the is_valid value is false
+ * - the returned character ID doesn't match the previously recorded value for the character
+ *
+ * The following example illustrates how to use this endpoint:
+ *
+ * 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
+ * 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
+ * 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
+ * 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns the status of the character profile for a character.
+ */
+declare function characterProfileStatus(realmSlug: string, characterName: string): Resource<CharacterProfileStatusResponse>;
+/**
+ * Returns a summary of the character profile for a character.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the character profile for a character.
+ */
+declare function characterProfileSummary(realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
+
+export { characterProfileStatus, characterProfileSummary };

package/dist/character-profile/character-profile.js

@@ -0,0 +1,3 @@
+export { characterProfileStatus, characterProfileSummary } from '../chunk-LXEXXIEG.js';
+//# sourceMappingURL=character-profile.js.map
+//# sourceMappingURL=character-profile.js.map

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

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

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

@@ -0,0 +1,55 @@
+import { ResponseBase, Href, NameIdKey, Faction, Realm } from '../base.js';
+
+interface CharacterProfileStatusResponse extends ResponseBase {
+    id: number;
+    is_valid: boolean;
+}
+interface CharacterProfileSummaryResponse extends ResponseBase {
+    achievement_points: number;
+    achievements: Href;
+    achievements_statistics: Href;
+    active_spec: NameIdKey;
+    active_title: NameIdKey & {
+        display_string: string;
+    };
+    appearance: Href;
+    average_item_level: number;
+    character_class: NameIdKey;
+    collections: Href;
+    covenant_progress: CovenantProgress;
+    encounters: Href;
+    equipment: Href;
+    equipped_item_level: number;
+    experience: number;
+    faction: Faction;
+    gender: Faction;
+    guild: Guild;
+    hunter_pets: Href;
+    id: number;
+    last_login_timestamp: number;
+    level: number;
+    media: Href;
+    mythic_keystone_profile: Href;
+    name: string;
+    name_search: string;
+    professions: Href;
+    pvp_summary: Href;
+    quests: Href;
+    race: NameIdKey;
+    realm: Realm;
+    reputations: Href;
+    specializations: Href;
+    statistics: Href;
+    titles: Href;
+}
+interface CovenantProgress {
+    chosen_covenant: NameIdKey;
+    renown_level: number;
+    soulbinds: Href;
+}
+interface Guild extends NameIdKey {
+    faction: Faction;
+    realm: Realm;
+}
+
+export type { CharacterProfileStatusResponse, CharacterProfileSummaryResponse };

package/dist/character-profile/types.js

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

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

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

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

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

package/dist/character-pvp/character-pvp.js

@@ -0,0 +1,3 @@
+export { characterPvpSummary } from '../chunk-U3H47BSV.js';
+//# sourceMappingURL=character-pvp.js.map
+//# sourceMappingURL=character-pvp.js.map

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

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

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

@@ -0,0 +1,19 @@
+import { ResponseBase, Character, NameId } from '../base.js';
+
+interface CharacterPvpSummaryResponse extends ResponseBase {
+    character: Character;
+    honor_level: number;
+    honorable_kills: number;
+    pvp_map_statistics: Array<PvpMapStatistic>;
+}
+interface MatchStatistics {
+    lost: number;
+    played: number;
+    won: number;
+}
+interface PvpMapStatistic {
+    match_statistics: MatchStatistics;
+    world_map: NameId;
+}
+
+export type { CharacterPvpSummaryResponse };

package/dist/character-pvp/types.js

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

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

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

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

@@ -0,0 +1,18 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterCompletedQuestsResponse, CharacterQuestsResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a list of quests that a character has completed.
+ */
+declare function characterCompletedQuests(realmSlug: string, characterName: string): Resource<CharacterCompletedQuestsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a character's active quests as well as a link to the character's completed quests.
+ */
+declare function characterQuests(realmSlug: string, characterName: string): Resource<CharacterQuestsResponse>;
+
+export { characterCompletedQuests, characterQuests };

package/dist/character-quests/character-quests.js

@@ -0,0 +1,3 @@
+export { characterCompletedQuests, characterQuests } from '../chunk-RDKBICVU.js';
+//# sourceMappingURL=character-quests.js.map
+//# sourceMappingURL=character-quests.js.map

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

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

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

@@ -0,0 +1,13 @@
+import { ResponseBase, Character, NameIdKey, Href } from '../base.js';
+
+interface CharacterCompletedQuestsResponse extends ResponseBase {
+    character: Character;
+    quests: Array<NameIdKey>;
+}
+interface CharacterQuestsResponse extends ResponseBase {
+    character: Character;
+    completed: Href;
+    in_progress: Array<NameIdKey>;
+}
+
+export type { CharacterCompletedQuestsResponse, CharacterQuestsResponse };

package/dist/character-quests/types.js

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

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

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

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

@@ -0,0 +1,12 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterReputationsSummaryResponse } 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 reputations.
+ */
+declare function characterReputationsSummary(realmSlug: string, characterName: string): Resource<CharacterReputationsSummaryResponse>;
+
+export { characterReputationsSummary };

package/dist/character-reputations/character-reputations.js

@@ -0,0 +1,3 @@
+export { characterReputationsSummary } from '../chunk-5JEMELDR.js';
+//# sourceMappingURL=character-reputations.js.map
+//# sourceMappingURL=character-reputations.js.map

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

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

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

@@ -0,0 +1,25 @@
+import { ResponseBase, Character, NameIdKey } from '../base.js';
+
+interface CharacterReputationsSummaryResponse extends ResponseBase {
+    character: Character;
+    reputations: Array<Reputation>;
+}
+interface Paragon {
+    max: number;
+    raw: number;
+    value: number;
+}
+interface Reputation {
+    faction: NameIdKey;
+    paragon?: Paragon;
+    standing: Standing;
+}
+interface Standing {
+    max: number;
+    name: string;
+    raw: number;
+    tier: number;
+    value: number;
+}
+
+export type { CharacterReputationsSummaryResponse };

package/dist/character-reputations/types.js

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

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

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

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

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

package/dist/character-soulbinds/character-soulbinds.js

@@ -0,0 +1,3 @@
+export { characterSoulbinds } from '../chunk-26JOGQUD.js';
+//# sourceMappingURL=character-soulbinds.js.map
+//# sourceMappingURL=character-soulbinds.js.map

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

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

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

@@ -0,0 +1,33 @@
+import { ResponseBase, Character, NameIdKey } from '../base.js';
+
+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: 'Endurance Conduit Slot' | 'Finesse Conduit Slot' | 'Potency Conduit Slot';
+    type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
+}
+
+export type { CharacterSoulbindsResponse };

package/dist/character-soulbinds/types.js

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

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

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

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

@@ -0,0 +1,12 @@
+import { Resource } from '@blizzard-api/core';
+import { CharacterSpecializationsSummaryResponse } 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 specializations.
+ */
+declare function characterSpecializationsSummary(realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
+
+export { characterSpecializationsSummary };

package/dist/character-specializations/character-specializations.js

@@ -0,0 +1,3 @@
+export { characterSpecializationsSummary } from '../chunk-JIJPTSGU.js';
+//# sourceMappingURL=character-specializations.js.map
+//# sourceMappingURL=character-specializations.js.map

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

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

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

@@ -0,0 +1,46 @@
+import { ResponseBase, NameIdKey, Character } from '../base.js';
+
+interface CharacterSpecializationsSummaryResponse extends ResponseBase {
+    active_hero_talent: NameIdKey;
+    active_specialization: NameIdKey;
+    character: Character;
+    specializations: Array<Specialization>;
+}
+interface Loadout {
+    is_active: boolean;
+    selected_class_talent_tree: NameIdKey;
+    selected_class_talents: Array<SelectedTalent>;
+    selected_spec_talent_tree: NameIdKey;
+    selected_spec_talents?: Array<SelectedTalent>;
+    talent_loadout_code: string;
+}
+interface PvpTalentSlot {
+    selected: Selected;
+    slot_number: number;
+}
+interface Selected {
+    spell_tooltip: SpellTooltip;
+    talent: NameIdKey;
+}
+interface SelectedTalent {
+    default_points?: number;
+    id: number;
+    rank: number;
+    tooltip: Selected;
+}
+interface Specialization {
+    glyphs?: Array<NameIdKey>;
+    loadouts: Array<Loadout>;
+    pvp_talent_slots?: Array<PvpTalentSlot>;
+    specialization: NameIdKey;
+}
+interface SpellTooltip {
+    cast_time: '1.5 sec cast' | '2.5 sec cast' | '3 sec cast' | 'Channeled' | 'Instant' | 'Passive';
+    cooldown?: string;
+    description: string;
+    power_cost?: string;
+    range?: '8-30 yd range' | '15 yd range' | '30 yd range' | '40 yd range' | '50 yd range' | '55 yd range' | '100 yd range' | 'Melee Range';
+    spell: NameIdKey;
+}
+
+export type { CharacterSpecializationsSummaryResponse };

package/dist/character-specializations/types.js

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

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

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

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

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

package/dist/character-statistics/character-statistics.js

@@ -0,0 +1,3 @@
+export { characterStatisticsSummary } from '../chunk-G775CQBW.js';
+//# sourceMappingURL=character-statistics.js.map
+//# sourceMappingURL=character-statistics.js.map

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

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

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

@@ -0,0 +1,59 @@
+import { ResponseBase, Character } from '../base.js';
+
+interface CharacterStatisticsSummaryResponse extends ResponseBase {
+    agility: BaseEffectiveStat;
+    armor: BaseEffectiveStat;
+    attack_power: number;
+    avoidance: Rating;
+    block: RatingWithValue;
+    bonus_armor: number;
+    character: Character;
+    dodge: RatingWithValue;
+    health: number;
+    intellect: BaseEffectiveStat;
+    lifesteal: RatingWithValue;
+    main_hand_damage_max: number;
+    main_hand_damage_min: number;
+    main_hand_dps: number;
+    main_hand_speed: number;
+    mana_regen: number;
+    mana_regen_combat: number;
+    mastery: RatingWithValue;
+    melee_crit: RatingWithValue;
+    melee_haste: RatingWithValue;
+    off_hand_damage_max: number;
+    off_hand_damage_min: number;
+    off_hand_dps: number;
+    off_hand_speed: number;
+    parry: RatingWithValue;
+    power: number;
+    power_type: Character;
+    ranged_crit: RatingWithValue;
+    ranged_haste: RatingWithValue;
+    speed: Rating;
+    spell_crit: RatingWithValue;
+    spell_haste: RatingWithValue;
+    spell_penetration: number;
+    spell_power: number;
+    stamina: BaseEffectiveStat;
+    strength: BaseEffectiveStat;
+    versatility: number;
+    versatility_damage_done_bonus: number;
+    versatility_damage_taken_bonus: number;
+    versatility_healing_done_bonus: number;
+}
+interface BaseEffectiveStat {
+    base: number;
+    effective: number;
+}
+interface Rating {
+    rating: number;
+    rating_bonus: number;
+}
+interface RatingWithValue {
+    rating: number;
+    rating_bonus: number;
+    value: number;
+}
+
+export type { CharacterStatisticsSummaryResponse };

package/dist/character-statistics/types.js

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

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

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