@pinta365/blizzard_api 0.3.9 → 0.5.0

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

@@ -0,0 +1,88 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface AchievementCriteria {
+    id: number;
+    amount?: number;
+    is_completed: boolean;
+    child_criteria?: AchievementCriteria[];
+}
+export interface CharacterAchievementSummary extends LinkSelfHref {
+    total_quantity: number;
+    total_points: number;
+    achievements: {
+        id: number;
+        achievement: KeyNameId;
+        criteria?: AchievementCriteria;
+        completed_timestamp?: number;
+    }[];
+    category_progress: {
+        category: KeyNameId;
+        quantity: number;
+        points: number;
+    }[];
+    recent_events: {
+        achievement: KeyNameId;
+        timestamp: number;
+    }[];
+    character: Character;
+    statistics: {
+        href: string;
+    };
+}
+export interface AchievementStatistic {
+    id: number;
+    name: LocalizedString;
+    last_updated_timestamp: number;
+    description?: LocalizedString | null;
+    quantity: number;
+}
+export interface AchievementsubCategory {
+    id: number;
+    name: LocalizedString;
+    statistics: {
+        id: number;
+        name: LocalizedString;
+        last_updated_timestamp: number;
+        description?: LocalizedString | null;
+        quantity: number;
+    }[];
+}
+export interface CharacterAchievementStatistics extends LinkSelfHref {
+    character: {
+        key: {
+            href: string;
+        };
+        name: LocalizedString;
+        id: number;
+        realm: {
+            key: {
+                href: string;
+            };
+            name: LocalizedString;
+            id: number;
+            slug: string;
+        };
+    };
+    categories: {
+        id?: number;
+        name: LocalizedString;
+        sub_categories?: AchievementsubCategory[];
+        statistics?: AchievementStatistic[];
+    }[];
+}
+/**
+ * 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.
+ */
+export declare function characterAchievementSummary(ctx: ApiContext, realmSlug: string, characterName: string): Promise<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.
+ */
+export declare function characterAchievementStatistics(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterAchievementStatistics>;

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

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

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

@@ -0,0 +1,79 @@
+import type { ApiContext } from "../../shared/index.js";
+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;
+        secondary_id?: number;
+        secondary_item_appearance_modifier_id?: number;
+        secondary_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(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterAppearanceSummary>;

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

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

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

@@ -0,0 +1,132 @@
+import type { ApiContext, Character, Href, KeyId, KeyNameId, LinkSelfHref, NamedRef, TypeName } from "../../shared/index.js";
+export interface CharacterCollectionTypes extends LinkSelfHref {
+    pets: Href;
+    mounts: Href;
+    heirlooms: Href;
+    toys: Href;
+    character: Character;
+    transmogs: Href;
+    decors?: Href;
+}
+export interface CollectedMount {
+    mount: KeyNameId;
+    is_character_specific?: boolean;
+    is_useable: boolean;
+    is_favorite?: boolean;
+}
+export interface CharacterCollectionMounts extends LinkSelfHref {
+    mounts: CollectedMount[];
+}
+export interface CollectedPet {
+    species: KeyNameId;
+    level: number;
+    quality: TypeName;
+    stats: {
+        breed_id: number;
+        health: number;
+        power: number;
+        speed: number;
+    };
+    creature_display?: KeyId;
+    id: number;
+    is_active?: boolean;
+    active_slot?: number;
+}
+export interface CharacterCollectionPets extends LinkSelfHref {
+    pets: CollectedPet[];
+    unlocked_battle_pet_slots: number;
+}
+export interface CollectedToy {
+    toy: KeyNameId;
+    is_favorite?: boolean;
+}
+export interface CharacterCollectionToys extends LinkSelfHref {
+    toys: CollectedToy[];
+}
+export interface CollectedHeirloom {
+    heirloom: KeyNameId;
+    upgrade: {
+        level: number;
+    };
+}
+export interface CharacterCollectionHeirlooms extends LinkSelfHref {
+    heirlooms: CollectedHeirloom[];
+}
+export interface DecorItem {
+    decor: NamedRef;
+    /** How many of this decor are owned. */
+    quantity: number;
+}
+export interface CharacterCollectionDecor extends LinkSelfHref {
+    decor_collected: DecorItem[];
+}
+export interface TransmogrifiedSlot {
+    slot: {
+        type: string;
+        name: string;
+    };
+    appearances: KeyId[];
+}
+export interface CharacterCollectionTransmogs {
+    "_links": {
+        self: Href;
+    };
+    appearance_sets: NamedRef[];
+    slots: TransmogrifiedSlot[];
+}
+/**
+ * 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(ctx: ApiContext, 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(ctx: ApiContext, 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(ctx: ApiContext, 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(ctx: ApiContext, 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(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterCollectionHeirlooms>;
+/**
+ * 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 declare function characterCollectionDecor(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterCollectionDecor>;
+/**
+ * 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 declare function characterCollectionTransmogs(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterCollectionTransmogs>;

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

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterCollectionTypes = characterCollectionTypes;
+exports.characterCollectionMounts = characterCollectionMounts;
+exports.characterCollectionPets = characterCollectionPets;
+exports.characterCollectionToys = characterCollectionToys;
+exports.characterCollectionHeirlooms = characterCollectionHeirlooms;
+exports.characterCollectionDecor = characterCollectionDecor;
+exports.characterCollectionTransmogs = characterCollectionTransmogs;
+/**
+ * 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(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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+async function characterCollectionTransmogs(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/collections/transmogs`,
+        namespace: "profile",
+    });
+}

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

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