@pinta365/blizzard_api 0.3.7 → 0.3.9

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

@@ -1,75 +0,0 @@
-import type { Character, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
-export interface CharacterAppearanceSummary extends LinkSelfHref {
-    character: Character;
-    playable_race: KeyNameId;
-    playable_class: KeyNameId;
-    active_spec: KeyNameId;
-    gender: TypeName;
-    faction: TypeName;
-    guild_crest: {
-        emblem: {
-            id: number;
-            media: KeyId;
-            color: {
-                id: number;
-                rgba: {
-                    r: number;
-                    g: number;
-                    b: number;
-                    a: number;
-                };
-            };
-        };
-        border: {
-            id: number;
-            media: KeyId;
-            color: {
-                id: number;
-                rgba: {
-                    r: number;
-                    g: number;
-                    b: number;
-                    a: number;
-                };
-            };
-        };
-        background: {
-            color: {
-                id: number;
-                rgba: {
-                    r: number;
-                    g: number;
-                    b: number;
-                    a: number;
-                };
-            };
-        };
-    };
-    items: {
-        id: number;
-        slot: TypeName;
-        enchant: number;
-        item_appearance_modifier_id: number;
-        internal_slot_id: number;
-        subclass: number;
-    }[];
-    customizations: {
-        option: {
-            name: LocalizedString;
-            id: number;
-        };
-        choice: {
-            name?: LocalizedString;
-            id: number;
-            display_order: number;
-        };
-    }[];
-}
-/**
- * Returns a summary of a character's appearance settings.
- *
- * @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 a character's appearance settings.
- */
-export declare function characterAppearanceSummary(realmSlug: string, characterName: string): Promise<CharacterAppearanceSummary>;

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

@@ -1,15 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * Returns a summary of a character's appearance settings.
- *
- * @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 a character's appearance settings.
- */
-export async function characterAppearanceSummary(realmSlug, characterName) {
-    return await request({
-        method: "GET",
-        url: `/profile/wow/character/${realmSlug}/${characterName}/appearance`,
-        namespace: "profile",
-    });
-}

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

@@ -1,92 +0,0 @@
-import type { Character, KeyId, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
-export interface Href {
-    href: string;
-}
-export interface CharacterCollectionTypes extends LinkSelfHref {
-    pets: Href;
-    mounts: Href;
-    heirlooms: Href;
-    toys: Href;
-    character: Character;
-}
-export interface Mount {
-    mounts: KeyNameId;
-    is_character_specific?: boolean;
-    is_useable: boolean;
-}
-export interface CharacterCollectionMounts extends LinkSelfHref {
-    mounts: Mount[];
-}
-export interface Pet {
-    species: KeyNameId;
-    level: number;
-    quality: TypeName;
-    stats: {
-        breed_id: number;
-        health: number;
-        power: number;
-        speed: number;
-    };
-    creature_display: KeyId;
-    id: number;
-}
-export interface CharacterCollectionPets extends LinkSelfHref {
-    pets: Pet[];
-    unlocked_battle_pet_slots: number;
-}
-export interface Toy {
-    toy: KeyNameId;
-    is_favorite?: boolean;
-}
-export interface CharacterCollectionToys extends LinkSelfHref {
-    toys: Toy[];
-}
-export interface Heirloom {
-    heirloom: KeyNameId;
-    upgrade: {
-        level: number;
-    };
-}
-export interface CharacterCollectionHeirlooms extends LinkSelfHref {
-    heirlooms: Heirloom[];
-}
-/**
- * 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 declare function characterCollectionTypes(realmSlug: string, characterName: string): Promise<CharacterCollectionTypes>;
-/**
- * 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 declare function characterCollectionMounts(realmSlug: string, characterName: string): Promise<CharacterCollectionMounts>;
-/**
- * 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 declare function characterCollectionPets(realmSlug: string, characterName: string): Promise<CharacterCollectionPets>;
-/**
- * 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 declare function characterCollectionToys(realmSlug: string, characterName: string): Promise<CharacterCollectionToys>;
-/**
- * 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 declare function characterCollectionHeirlooms(realmSlug: string, characterName: string): Promise<CharacterCollectionHeirlooms>;

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

@@ -1,71 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName) {
-    return await request({
-        method: "GET",
-        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/heirlooms`,
-        namespace: "profile",
-    });
-}

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

@@ -1,77 +0,0 @@
-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: 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(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(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(realmSlug: string, characterName: string): Promise<CharacterEncounterRaids>;

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

@@ -1,43 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName) {
-    return await request({
-        method: "GET",
-        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters/raids`,
-        namespace: "profile",
-    });
-}

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

@@ -1,132 +0,0 @@
-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 characterEquipments extends LinkSelfHref {
-    character: Character;
-    equipped_items: {
-        item: KeyId;
-        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;
-        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;
-        }[];
-        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;
-            };
-        };
-        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;
-        };
-        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(realmSlug: string, characterName: string): Promise<characterEquipments>;

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

@@ -1,15 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * 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(realmSlug, characterName) {
-    return await request({
-        method: "GET",
-        url: `/profile/wow/character/${realmSlug}/${characterName}/equipment`,
-        namespace: "profile",
-    });
-}

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

@@ -1,21 +0,0 @@
-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(realmSlug: string, characterName: string): Promise<CharacterHunterPets>;

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

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

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

@@ -1,13 +0,0 @@
-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(realmSlug: string, characterName: string): Promise<CharacterMedia>;

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

@@ -1,15 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * 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(realmSlug, characterName) {
-    return await request({
-        method: "GET",
-        url: `/profile/wow/character/${realmSlug}/${characterName}/character-media`,
-        namespace: "profile",
-    });
-}

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

@@ -1,58 +0,0 @@
-import type { Character, KeyId, KeyNameId, LinkSelfHref } from "../../shared/index.js";
-export interface MythicRating {
-    color: {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    };
-    rating: number;
-}
-export interface CharacterMythicKeystoneProfile extends LinkSelfHref {
-    current_period: {
-        period: KeyId;
-    };
-    seasons: KeyId[];
-    character: Character;
-    current_mythic_rating: MythicRating;
-}
-export interface CharacterMythicKeystoneSeasonDetails extends LinkSelfHref {
-    season: KeyId;
-    best_runs: {
-        completed_timestamp: number;
-        duration: number;
-        keystone_level: number;
-        keystone_affixes: KeyNameId[];
-        members: {
-            character: Character;
-            specialization: KeyNameId;
-            race: KeyNameId;
-            equipped_item_level: number;
-        }[];
-        dungeon: KeyNameId;
-        is_completed_within_time: boolean;
-        mythic_rating: MythicRating;
-        map_rating: MythicRating;
-    }[];
-    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(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(realmSlug: string, characterName: string, seasonId: number): Promise<CharacterMythicKeystoneSeasonDetails>;

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

@@ -1,32 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * 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(realmSlug, characterName) {
-    return await 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(realmSlug, characterName, seasonId) {
-    return await request({
-        method: "GET",
-        url: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile/season/${seasonId}`,
-        namespace: "profile",
-    });
-}