@pinta365/blizzard_api 0.4.0 → 0.6.0

package/esm/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/esm/src/wow/profile/character_profile.js

@@ -0,0 +1,39 @@
+/**
+ * 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 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.
+ */
+export async function characterProfileStatus(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/status`,
+        namespace: "profile",
+    });
+}

package/esm/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/esm/src/wow/profile/character_pvp.js

@@ -0,0 +1,29 @@
+/**
+ * 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 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.
+ */
+export async function characterPvpSummary(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/pvp-summary`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,29 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface CharacterQuests extends LinkSelfHref {
+    character: Character;
+    in_progress: KeyNameId[];
+    completed: {
+        href: string;
+    };
+}
+export interface CharacterCompletedQuests extends LinkSelfHref {
+    character: Character;
+    quests: KeyNameId[];
+}
+/**
+ * Returns a character's active quests as well as a link to the character's completed quests.
+ *
+ * @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 character's active quests as well as a link to the character's completed quests.
+ */
+export declare function characterQuests(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterQuests>;
+/**
+ * Returns a list of quests that 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 a list of quests that a character has completed.
+ */
+export declare function characterCompletedQuests(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterCompletedQuests>;

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

@@ -0,0 +1,28 @@
+/**
+ * Returns a character's active quests as well as a link to the character's completed quests.
+ *
+ * @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 character's active quests as well as a link to the character's completed quests.
+ */
+export async function characterQuests(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/quests`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a list of quests that 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 a list of quests that a character has completed.
+ */
+export async function characterCompletedQuests(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/quests/completed`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,30 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface CharacterReputations extends LinkSelfHref {
+    character: Character;
+    reputations: {
+        faction: KeyNameId;
+        standing: {
+            raw: number;
+            value: number;
+            max: number;
+            tier?: number;
+            renown_level?: number;
+            name: LocalizedString;
+        };
+        /** Paragon progress, for factions at maximum standing that have a paragon track. */
+        paragon?: {
+            raw: number;
+            value: number;
+            max: number;
+        };
+    }[];
+}
+/**
+ * Returns a summary of a character's reputations.
+ *
+ * @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 character's reputations.
+ */
+export declare function characterReputations(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterReputations>;

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

@@ -0,0 +1,14 @@
+/**
+ * Returns a summary of a character's reputations.
+ *
+ * @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 character's reputations.
+ */
+export async function characterReputations(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/reputations`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,31 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+export interface CharacterSoulbinds extends LinkSelfHref {
+    character: Character;
+    chosen_covenant: KeyNameId;
+    renown_level: number;
+    soulbinds: {
+        soulbind: KeyNameId;
+        traits?: {
+            trait?: KeyNameId;
+            conduit_socket?: {
+                type: TypeName;
+                socket: {
+                    conduit: KeyNameId;
+                    rank: number;
+                };
+            };
+            tier: number;
+            display_order: number;
+        }[];
+        is_active?: boolean;
+    }[];
+}
+/**
+ * Returns a character's soulbinds.
+ *
+ * @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 character's soulbinds.
+ */
+export declare function characterSoulbinds(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterSoulbinds>;

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

@@ -0,0 +1,14 @@
+/**
+ * Returns a character's soulbinds.
+ *
+ * @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 character's soulbinds.
+ */
+export async function characterSoulbinds(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/soulbinds`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,82 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyId, KeyName, KeyNameId, LinkSelfHref, LocalizedString, NamedRef, NameId } from "../../shared/index.js";
+export interface Detail {
+    talent: KeyId & {
+        name?: string;
+    };
+    spell_tooltip: {
+        spell: KeyId & {
+            name?: string;
+        };
+        description?: LocalizedString | null;
+        cast_time?: LocalizedString;
+        power_cost?: LocalizedString;
+        cooldown?: LocalizedString;
+        range?: LocalizedString;
+    };
+}
+export interface CharacterSpecializationTalent {
+    id: number;
+    rank: number;
+    tooltip?: Detail;
+    default_points?: number;
+}
+export interface ClassicSpecializationTalent {
+    talent: {
+        name: string;
+        id: number;
+    };
+    spell_tooltip: {
+        spell: {
+            name: string;
+            id: number;
+        };
+        description: string;
+        cast_time: string;
+        cooldown?: string;
+        power_cost?: string | null;
+        range?: string;
+    };
+}
+export interface CharacterSpecializations extends LinkSelfHref {
+    specializations: {
+        specialization: KeyNameId;
+        specialization_name?: string;
+        glyphs?: KeyNameId[];
+        talents?: ClassicSpecializationTalent[];
+        pvp_talent_slots?: {
+            selected: Detail;
+            slot_number: number;
+        }[];
+        loadouts?: {
+            is_active: boolean;
+            talent_loadout_code: string;
+            selected_class_talents: CharacterSpecializationTalent[];
+            selected_spec_talents: CharacterSpecializationTalent[];
+            selected_hero_talents?: CharacterSpecializationTalent[];
+            selected_class_talent_tree?: KeyName;
+            selected_spec_talent_tree?: KeyName;
+            selected_hero_talent_tree?: KeyNameId;
+        }[];
+    }[];
+    specialization_groups?: {
+        is_active: boolean;
+        glyphs?: NameId[];
+        specializations?: {
+            specialization?: KeyNameId;
+            specialization_name: string;
+            talents: ClassicSpecializationTalent[];
+        }[];
+    }[];
+    active_specialization: KeyNameId;
+    active_hero_talent_tree?: NamedRef;
+    character: Character;
+}
+/**
+ * Returns a summary of a character's specializations.
+ *
+ * @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 a character's specializations.
+ */
+export declare function characterSpecializations(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterSpecializations>;

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

@@ -0,0 +1,14 @@
+/**
+ * Returns a summary of a character's specializations.
+ *
+ * @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 a character's specializations.
+ */
+export async function characterSpecializations(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/specializations`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,104 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface StatRating {
+    rating_bonus: number;
+    value: number;
+    rating_normalized: number;
+}
+export interface StatRatingBonus {
+    rating_bonus: number;
+    rating_normalized: number;
+}
+export interface CharacterStatistics extends LinkSelfHref {
+    health: number;
+    power: number;
+    power_type: KeyNameId;
+    speed: StatRatingBonus;
+    strength: {
+        base: number;
+        effective: number;
+    };
+    agility: {
+        base: number;
+        effective: number;
+    };
+    intellect: {
+        base: number;
+        effective: number;
+    };
+    stamina: {
+        base: number;
+        effective: number;
+    };
+    melee_crit: StatRating;
+    melee_haste: StatRating;
+    mastery: StatRating;
+    bonus_armor: number;
+    lifesteal: StatRating;
+    versatility: number;
+    versatility_damage_done_bonus: number;
+    versatility_healing_done_bonus: number;
+    versatility_damage_taken_bonus: number;
+    avoidance: StatRatingBonus;
+    attack_power: number;
+    main_hand_damage_min: number;
+    main_hand_damage_max: number;
+    main_hand_speed: number;
+    main_hand_dps: number;
+    off_hand_damage_min: number;
+    off_hand_damage_max: number;
+    off_hand_speed: number;
+    off_hand_dps: number;
+    spell_power: number;
+    spell_penetration: number;
+    spell_crit: StatRating;
+    mana_regen: number;
+    mana_regen_combat: number;
+    armor: {
+        base: number;
+        effective: number;
+    };
+    dodge: StatRating;
+    parry: StatRating;
+    block: StatRating;
+    ranged_crit: StatRating;
+    ranged_haste: StatRating;
+    spell_haste: StatRating;
+    spirit?: {
+        base: number;
+        effective: number;
+    };
+    defense?: {
+        base: number;
+        effective: number;
+    };
+    arcane_resistance?: {
+        base: number;
+        effective: number;
+    };
+    fire_resistance?: {
+        base: number;
+        effective: number;
+    };
+    holy_resistance?: {
+        base: number;
+        effective: number;
+    };
+    nature_resistance?: {
+        base: number;
+        effective: number;
+    };
+    shadow_resistance?: {
+        base: number;
+        effective: number;
+    };
+    character: Character;
+}
+/**
+ * Returns a statistics 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 statistics summary for a character.
+ */
+export declare function characterStatistics(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterStatistics>;

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

@@ -0,0 +1,14 @@
+/**
+ * Returns a statistics 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 statistics summary for a character.
+ */
+export async function characterStatistics(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/statistics`,
+        namespace: "profile",
+    });
+}

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

@@ -0,0 +1,14 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface CharacterTitles extends LinkSelfHref {
+    character: Character;
+    titles: KeyNameId[];
+}
+/**
+ * Returns a summary of titles 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 a summary of titles a character has obtained.
+ */
+export declare function characterTitles(ctx: ApiContext, realmSlug: string, characterName: string): Promise<CharacterTitles>;

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

@@ -0,0 +1,14 @@
+/**
+ * Returns a summary of titles 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 a summary of titles a character has obtained.
+ */
+export async function characterTitles(ctx, realmSlug, characterName) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/titles`,
+        namespace: "profile",
+    });
+}