@pinta365/blizzard_api 0.3.9 → 0.5.0

package/script/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/script/src/wow/profile/character_equipment.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterEquipments = characterEquipments;
+/**
+ * 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.
+ */
+async function characterEquipments(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/equipment`,
+        namespace: "profile",
+    });
+}

package/script/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/script/src/wow/profile/character_house.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * This module provides the API function for fetching a character's house summary using the Blizzard API.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterHouse = characterHouse;
+/**
+ * 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).
+ */
+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/script/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/script/src/wow/profile/character_hunter_pets.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterHunterPets = characterHunterPets;
+/**
+ * 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.
+ */
+async function characterHunterPets(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/hunter-pets`,
+        namespace: "profile",
+    });
+}

package/script/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/script/src/wow/profile/character_media.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterMedia = characterMedia;
+/**
+ * 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.
+ */
+async function characterMedia(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/character-media`,
+        namespace: "profile",
+    });
+}

package/script/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/script/src/wow/profile/character_mythic_keystone_profile.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterMythicKeystoneProfile = characterMythicKeystoneProfile;
+exports.characterMythicKeystoneSeasonDetails = characterMythicKeystoneSeasonDetails;
+/**
+ * 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.
+ */
+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.
+ */
+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/script/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/script/src/wow/profile/character_professions.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterProfessions = characterProfessions;
+/**
+ * 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.
+ */
+async function characterProfessions(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/professions`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_profile.d.ts

@@ -0,0 +1,83 @@
+import type { ApiContext, Href, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface CharacterRealm extends KeyNameId {
+    slug: string;
+}
+export interface CharacterProfile extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    active_title?: {
+        name: string;
+    };
+    gender: TypeName;
+    faction: TypeName;
+    race: KeyNameId;
+    character_class: KeyNameId;
+    active_spec: KeyNameId;
+    realm: CharacterRealm;
+    guild?: {
+        key: Href;
+        name: LocalizedString;
+        id: number;
+        realm: CharacterRealm;
+        faction: TypeName;
+    };
+    level: number;
+    experience: number;
+    achievement_points: number;
+    achievements: Href;
+    titles: Href;
+    pvp_summary: Href;
+    encounters: Href;
+    media: Href;
+    last_login_timestamp: number;
+    average_item_level: number;
+    equipped_item_level: number;
+    specializations: Href;
+    statistics: Href;
+    mythic_keystone_profile: Href;
+    equipment: Href;
+    appearance: Href;
+    collections: Href;
+    reputations: Href;
+    quests: Href;
+    achievements_statistics: Href;
+    professions: Href;
+    covenant_progress?: {
+        chosen_covenant: KeyNameId;
+        renown_level: number;
+        soulbinds: Href;
+    };
+    name_search: string;
+    is_remix: boolean;
+}
+export interface CharacterProfileStatus extends LinkSelfHref {
+    id: number;
+    is_valid: boolean;
+}
+/**
+ * Returns a profile summary 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 profile summary.
+ */
+export declare function characterProfile(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterProfile>;
+/**
+ * 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:
+ *
+ * A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
+ * After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
+ * If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
+ * 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 A promise that resolves to an object representing a profile summary status.
+ */
+export declare function characterProfileStatus(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterProfileStatus>;

package/script/src/wow/profile/character_profile.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterProfile = characterProfile;
+exports.characterProfileStatus = characterProfileStatus;
+/**
+ * Returns a profile summary 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 profile summary.
+ */
+async function characterProfile(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}`,
+        namespace: "profile",
+    });
+}
+/**
+ * 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:
+ *
+ * A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
+ * After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
+ * If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
+ * 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 A promise that resolves to an object representing a profile summary status.
+ */
+async function characterProfileStatus(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/status`,
+        namespace: "profile",
+    });
+}

package/script/src/wow/profile/character_pvp.d.ts

@@ -0,0 +1,53 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface MatchStatistic {
+    played: number;
+    won: number;
+    lost: number;
+}
+export interface CharacterPvpBracketStatistics extends LinkSelfHref {
+    character: Character;
+    faction: TypeName;
+    bracket: {
+        id: number;
+        type: string;
+    };
+    rating: number;
+    season: KeyId;
+    tier: KeyId;
+    season_match_statistics: MatchStatistic;
+    weekly_match_statistics: MatchStatistic;
+}
+export interface CharacterPvpSummary extends LinkSelfHref {
+    brackets?: {
+        href: string;
+    }[];
+    honor_level: number;
+    pvp_map_statistics?: {
+        world_map: {
+            name: LocalizedString;
+            id: number;
+        };
+        match_statistics: MatchStatistic;
+    }[];
+    honorable_kills: number;
+    character: Character;
+    pvp_rank?: number;
+}
+/**
+ * Returns the PvP bracket statistics for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @param pvpBracket - The PvP bracket type.
+ * @returns A promise that resolves to an object representing the PvP bracket statistics for a character.
+ */
+export declare function characterPvpBracketStatistics(ctx: ApiContext, realmSlug: string, characterName: string, pvpBracket: string): Promise<CharacterPvpBracketStatistics>;
+/**
+ * Returns a PvP summary 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 the PvP summary for a character.
+ */
+export declare function characterPvpSummary(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterPvpSummary>;

package/script/src/wow/profile/character_pvp.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterPvpBracketStatistics = characterPvpBracketStatistics;
+exports.characterPvpSummary = characterPvpSummary;
+/**
+ * Returns the PvP bracket statistics for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @param pvpBracket - The PvP bracket type.
+ * @returns A promise that resolves to an object representing the PvP bracket statistics for a character.
+ */
+async function characterPvpBracketStatistics(ctx, realmSlug, characterName, pvpBracket) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/pvp-bracket/${pvpBracket}`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a PvP summary 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 the PvP summary for a character.
+ */
+async function characterPvpSummary(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/pvp-summary`,
+        namespace: "profile",
+    });
+}