@pinta365/blizzard_api 0.3.9 → 0.5.0

package/esm/src/wow/profile/character_collections.js

@@ -0,0 +1,98 @@
+/**
+ * Returns an index of collection types for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about collection types for a character.
+ */
+export async function characterCollectionTypes(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of the mounts a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about mounts a character has obtained.
+ */
+export async function characterCollectionMounts(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/mounts`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of the pets a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about pets a character has obtained.
+ */
+export async function characterCollectionPets(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/pets`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of the toys a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about toys a character has obtained.
+ */
+export async function characterCollectionToys(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/toys`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of the heirlooms a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about heirlooms a character has obtained.
+ */
+export async function characterCollectionHeirlooms(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/heirlooms`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of the housing decor collection a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about decor a character has collected.
+ */
+export async function characterCollectionDecor(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/decor`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of the transmog appearances a character has obtained.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about transmog appearances a character has collected.
+ */
+export async function characterCollectionTransmogs(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/transmogs`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_encounters.d.ts

@@ -0,0 +1,78 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+export interface CharacterEncounters extends LinkSelfHref {
+    character: Character;
+    dungeons: {
+        href: string;
+    };
+    raids: {
+        href: string;
+    };
+}
+export interface CharacterEncounterDungeons extends LinkSelfHref {
+    expansions: {
+        expansion: KeyNameId;
+        instances: {
+            instance: KeyNameId;
+            modes: {
+                difficulty: Partial<TypeName>;
+                status: TypeName;
+                progress: {
+                    completed_count: number;
+                    total_count: number;
+                    encounters: {
+                        encounter: KeyNameId;
+                        completed_count: number;
+                        last_kill_timestamp: number;
+                    }[];
+                };
+            }[];
+        }[];
+    }[];
+}
+export interface CharacterEncounterRaids extends LinkSelfHref {
+    character: Character;
+    expansions: {
+        expansion: KeyNameId;
+        instances: {
+            instance: KeyNameId;
+            modes: {
+                difficulty: TypeName;
+                status: TypeName;
+                progress: {
+                    completed_count: number;
+                    total_count: number;
+                    encounters: {
+                        encounter: KeyNameId;
+                        completed_count: number;
+                        last_kill_timestamp: number;
+                    }[];
+                };
+            }[];
+        }[];
+    }[];
+}
+/**
+ * Returns a summary of a character's encounters.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about character's encounters.
+ */
+export declare function characterEncounters(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterEncounters>;
+/**
+ * Returns a summary of a character's completed dungeons.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about character's completed dungeons.
+ */
+export declare function characterEncounterDungeons(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterEncounterDungeons>;
+/**
+ * Returns a summary of a character's completed raids.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about character's completed raids.
+ */
+export declare function characterEncounterRaids(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterEncounterRaids>;

package/esm/src/wow/profile/character_encounters.js

@@ -0,0 +1,42 @@
+/**
+ * Returns a summary of a character's encounters.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about character's encounters.
+ */
+export async function characterEncounters(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of a character's completed dungeons.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about character's completed dungeons.
+ */
+export async function characterEncounterDungeons(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters/dungeons`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a summary of a character's completed raids.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about character's completed raids.
+ */
+export async function characterEncounterRaids(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters/raids`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_equipment.d.ts

@@ -0,0 +1,177 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Rgba {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface EquippedItemWeapon {
+    damage: {
+        min_value: number;
+        max_value: number;
+        display_string: LocalizedString;
+        damage_class: TypeName;
+    };
+    attack_speed: {
+        value: number;
+        display_string: LocalizedString;
+    };
+    dps: {
+        value: number;
+        display_string: LocalizedString;
+    };
+}
+export interface characterEquipments extends LinkSelfHref {
+    character: Character;
+    equipped_items: {
+        item: KeyId;
+        description?: LocalizedString;
+        limit_category?: string | null;
+        modified_crafting_stat?: {
+            id: number;
+            type: string;
+            name: string;
+        }[];
+        shield_block?: {
+            value: number;
+            display: {
+                display_string: LocalizedString;
+                color: Rgba;
+            };
+        };
+        unique_equipped?: string | null;
+        weapon?: EquippedItemWeapon;
+        sockets?: {
+            socket_type: TypeName;
+            item: KeyNameId;
+            display_string: LocalizedString;
+            media: KeyId;
+        }[];
+        enchantments?: {
+            display_string?: LocalizedString;
+            source_item?: KeyNameId;
+            enchantment_id: number;
+            enchantment_slot: {
+                id: number;
+                type?: string;
+            };
+        }[];
+        slot: TypeName;
+        quantity: number;
+        context?: number;
+        bonus_list?: number[];
+        quality: TypeName;
+        name: LocalizedString;
+        modified_appearance_id?: number;
+        media: KeyId;
+        item_class: KeyNameId;
+        item_subclass: KeyNameId;
+        inventory_type: TypeName;
+        binding?: TypeName | null;
+        armor?: {
+            value: number;
+            display: {
+                display_string: LocalizedString;
+                color: Rgba;
+            };
+        };
+        stats?: {
+            type: TypeName;
+            value: number;
+            is_negated?: boolean;
+            is_equip_bonus?: boolean;
+            display: {
+                display_string: LocalizedString;
+                color: Rgba;
+            };
+        }[];
+        spells?: {
+            spell: KeyNameId;
+            description: LocalizedString;
+            display_color?: Rgba;
+        }[];
+        sell_price?: {
+            value: number;
+            display_strings: {
+                header: LocalizedString;
+                gold: string;
+                silver: string;
+                copper: string;
+            };
+        };
+        requirements?: {
+            level: {
+                value: number;
+                display_string: LocalizedString;
+            };
+            playable_classes?: {
+                links: KeyNameId[];
+                display_string: LocalizedString;
+            };
+            faction?: {
+                value: TypeName;
+                display_string: LocalizedString;
+            };
+            reputation?: {
+                faction: KeyNameId;
+                min_reputation_level: number;
+                display_string: LocalizedString;
+            };
+        };
+        set?: {
+            item_set: KeyNameId;
+            items: {
+                item: KeyNameId;
+                is_equipped?: boolean;
+            }[];
+            effects: {
+                display_string: LocalizedString;
+                required_count: number;
+                is_active?: boolean;
+            }[];
+            display_string: LocalizedString;
+        };
+        level?: {
+            value: number;
+            display_string: LocalizedString;
+        };
+        transmog?: {
+            item: KeyNameId;
+            display_string: LocalizedString;
+            item_modified_appearance_id: number;
+            second_item?: KeyNameId;
+            second_item_modified_appearance_id?: number;
+        };
+        durability?: {
+            value: number;
+            display_string: LocalizedString;
+        };
+        is_subclass_hidden?: boolean;
+        name_description?: {
+            display_string: LocalizedString;
+            color: Rgba;
+        };
+    }[];
+    equipped_item_sets?: {
+        item_set?: KeyNameId;
+        items?: {
+            item: KeyNameId;
+            is_equipped?: boolean;
+        }[];
+        effects?: {
+            display_string: LocalizedString;
+            required_count: number;
+            is_active?: boolean;
+        }[];
+        display_string?: LocalizedString;
+    }[];
+}
+/**
+ * Returns a summary of the items equipped by a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about items equipped by a character.
+ */
+export declare function characterEquipments(ctx: ApiContext, realmSlug: string, characterName: string): Promise<characterEquipments>;

package/esm/src/wow/profile/character_equipment.js

@@ -0,0 +1,14 @@
+/**
+ * Returns a summary of the items equipped by a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing details about items equipped by a character.
+ */
+export async function characterEquipments(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/equipment`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_house.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This module provides the API function for fetching a character's house summary using the Blizzard API.
+ */
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref } from "../../shared/index.js";
+export interface CharacterHouse extends LinkSelfHref {
+    id?: number;
+}
+/**
+ * Returns a summary of a house a character has built.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @param houseNumber - The number of the character's house (e.g. 1 for house-1).
+ */
+export declare function characterHouse(ctx: ApiContext, realmSlug: string, characterName: string, houseNumber: number): Promise<CharacterHouse>;

package/esm/src/wow/profile/character_house.js

@@ -0,0 +1,17 @@
+/**
+ * This module provides the API function for fetching a character's house summary using the Blizzard API.
+ */
+/**
+ * Returns a summary of a house a character has built.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @param houseNumber - The number of the character's house (e.g. 1 for house-1).
+ */
+export async function characterHouse(ctx, realmSlug, characterName, houseNumber) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/house/house-${houseNumber}`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_hunter_pets.d.ts

@@ -0,0 +1,22 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface CharacterHunterPets extends LinkSelfHref {
+    character: Character;
+    hunter_pets: {
+        name: LocalizedString;
+        level: number;
+        creature: KeyNameId;
+        slot: number;
+        is_active?: boolean;
+        is_summoned?: boolean;
+        creature_display: KeyId;
+    }[];
+}
+/**
+ * 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 promise that resolves to an object representing a summary of the character's hunter pets.
+ */
+export declare function characterHunterPets(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterHunterPets>;

package/esm/src/wow/profile/character_hunter_pets.js

@@ -0,0 +1,14 @@
+/**
+ * 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 promise that resolves to an object representing a summary of the character's hunter pets.
+ */
+export async function characterHunterPets(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/hunter-pets`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_media.d.ts

@@ -0,0 +1,14 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, Character, LinkSelfHref } from "../../shared/index.js";
+export interface CharacterMedia extends LinkSelfHref {
+    character: Character;
+    assets: Asset[];
+}
+/**
+ * Returns a summary of the media assets available for a character (such as an avatar render).
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of the media assets available for a character.
+ */
+export declare function characterMedia(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterMedia>;

package/esm/src/wow/profile/character_media.js

@@ -0,0 +1,14 @@
+/**
+ * Returns a summary of the media assets available for a character (such as an avatar render).
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of the media assets available for a character.
+ */
+export async function characterMedia(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/character-media`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_mythic_keystone_profile.d.ts

@@ -0,0 +1,70 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, Href, KeyId, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface MythicRating {
+    color: {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+    rating: number;
+}
+export interface MythicKeystoneMemberCharacter {
+    name: string;
+    id: number;
+    realm: {
+        key: Href;
+        id: number;
+        slug: string;
+    };
+}
+export interface MythicKeystoneBestRun {
+    completed_timestamp: number;
+    duration: number;
+    keystone_level: number;
+    keystone_affixes: KeyNameId[];
+    members: {
+        character: MythicKeystoneMemberCharacter;
+        specialization: KeyNameId;
+        race: KeyNameId;
+        equipped_item_level: number;
+    }[];
+    dungeon: KeyNameId;
+    is_completed_within_time: boolean;
+    mythic_rating: MythicRating;
+    map_rating: MythicRating;
+}
+export interface CharacterMythicKeystoneProfile extends LinkSelfHref {
+    current_period: {
+        period: KeyId;
+        best_runs?: MythicKeystoneBestRun[];
+    };
+    seasons: KeyId[];
+    character: Character;
+    current_mythic_rating: MythicRating;
+}
+export interface CharacterMythicKeystoneSeasonDetails extends LinkSelfHref {
+    season: KeyId;
+    best_runs: MythicKeystoneBestRun[];
+    character: Character;
+    mythic_rating: MythicRating;
+}
+/**
+ * Returns the Mythic Keystone profile index for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone profile.
+ */
+export declare function characterMythicKeystoneProfile(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterMythicKeystoneProfile>;
+/**
+ * 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 lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone season details.
+ */
+export declare function characterMythicKeystoneSeasonDetails(ctx: ApiContext, realmSlug: string, characterName: string, seasonId: number): Promise<CharacterMythicKeystoneSeasonDetails>;

package/esm/src/wow/profile/character_mythic_keystone_profile.js

@@ -0,0 +1,31 @@
+/**
+ * Returns the Mythic Keystone profile index for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone profile.
+ */
+export async function characterMythicKeystoneProfile(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile`,
+        namespace: "profile",
+    });
+}
+/**
+ * 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 lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone season details.
+ */
+export async function characterMythicKeystoneSeasonDetails(ctx, realmSlug, characterName, seasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile/season/${seasonId}`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/profile/character_professions.d.ts

@@ -0,0 +1,29 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, NameId } from "../../shared/index.js";
+export interface Tier {
+    skill_points: number;
+    max_skill_points: number;
+    tier: NameId;
+    known_recipes?: KeyNameId[];
+}
+export interface CharacterProfession {
+    profession: KeyNameId;
+    skill_points?: number;
+    max_skill_points?: number;
+    tiers?: Tier[];
+}
+export interface CharacterProfessions extends LinkSelfHref {
+    character: Character;
+    /** Absent when the character has no primary professions. */
+    primaries?: CharacterProfession[];
+    /** Absent when the character has no secondary professions. */
+    secondaries?: CharacterProfession[];
+}
+/**
+ * Returns a summary of professions for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of professions for a character.
+ */
+export declare function characterProfessions(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterProfessions>;

package/esm/src/wow/profile/character_professions.js

@@ -0,0 +1,14 @@
+/**
+ * Returns a summary of professions for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a summary of professions for a character.
+ */
+export async function characterProfessions(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/professions`,
+        namespace: "profile",
+    });
+}