@pinta365/blizzard_api 0.3.5

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterAchievementStatistics = exports.characterAchievementSummary = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * Returns a summary of the achievements a character has completed.
+ *
+ * @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 characters achievement summary.
+ */
+async function characterAchievementSummary(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/achievements`,
+        namespace: "profile",
+    });
+}
+exports.characterAchievementSummary = characterAchievementSummary;
+/**
+ * Returns a character's statistics as they pertain to achievements.
+ *
+ * @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 characters achievement statistics.
+ */
+async function characterAchievementStatistics(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/achievements/statistics`,
+        namespace: "profile",
+    });
+}
+exports.characterAchievementStatistics = characterAchievementStatistics;

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

@@ -0,0 +1,75 @@
+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/script/src/wow/profile/character_appearance.js

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

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

@@ -0,0 +1,92 @@
+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/script/src/wow/profile/character_collections.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterCollectionHeirlooms = exports.characterCollectionToys = exports.characterCollectionPets = exports.characterCollectionMounts = exports.characterCollectionTypes = void 0;
+const index_js_1 = require("../../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.
+ */
+async function characterCollectionTypes(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections`,
+        namespace: "profile",
+    });
+}
+exports.characterCollectionTypes = 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.
+ */
+async function characterCollectionMounts(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/mounts`,
+        namespace: "profile",
+    });
+}
+exports.characterCollectionMounts = 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.
+ */
+async function characterCollectionPets(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/pets`,
+        namespace: "profile",
+    });
+}
+exports.characterCollectionPets = 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.
+ */
+async function characterCollectionToys(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/toys`,
+        namespace: "profile",
+    });
+}
+exports.characterCollectionToys = 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.
+ */
+async function characterCollectionHeirlooms(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/heirlooms`,
+        namespace: "profile",
+    });
+}
+exports.characterCollectionHeirlooms = characterCollectionHeirlooms;

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

@@ -0,0 +1,77 @@
+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/script/src/wow/profile/character_encounters.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterEncounterRaids = exports.characterEncounterDungeons = exports.characterEncounters = void 0;
+const index_js_1 = require("../../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.
+ */
+async function characterEncounters(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters`,
+        namespace: "profile",
+    });
+}
+exports.characterEncounters = 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.
+ */
+async function characterEncounterDungeons(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters/dungeons`,
+        namespace: "profile",
+    });
+}
+exports.characterEncounterDungeons = 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.
+ */
+async function characterEncounterRaids(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/encounters/raids`,
+        namespace: "profile",
+    });
+}
+exports.characterEncounterRaids = characterEncounterRaids;

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

@@ -0,0 +1,132 @@
+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/script/src/wow/profile/character_equipment.js

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

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

@@ -0,0 +1,21 @@
+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/script/src/wow/profile/character_hunter_pets.js

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

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

@@ -0,0 +1,13 @@
+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/script/src/wow/profile/character_media.js

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