@pinta365/blizzard_api 0.3.5

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

@@ -0,0 +1,58 @@
+import type { Character, KeyId, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+export interface MythicRating {
+    color: {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+    rating: number;
+}
+export interface CharacterMythicKeystoneProfile extends LinkSelfHref {
+    current_period: {
+        period: KeyId;
+    };
+    seasons: KeyId[];
+    character: Character;
+    current_mythic_rating: MythicRating;
+}
+export interface CharacterMythicKeystoneSeasonDetails extends LinkSelfHref {
+    season: KeyId;
+    best_runs: {
+        completed_timestamp: number;
+        duration: number;
+        keystone_level: number;
+        keystone_affixes: KeyNameId[];
+        members: {
+            character: Character;
+            specialization: KeyNameId;
+            race: KeyNameId;
+            equipped_item_level: number;
+        }[];
+        dungeon: KeyNameId;
+        is_completed_within_time: boolean;
+        mythic_rating: MythicRating;
+        map_rating: MythicRating;
+    }[];
+    character: Character;
+    mythic_rating: MythicRating;
+}
+/**
+ * Returns the Mythic Keystone profile index for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone profile.
+ */
+export declare function characterMythicKeystoneProfile(realmSlug: string, characterName: string): Promise<CharacterMythicKeystoneProfile>;
+/**
+ * Returns the Mythic Keystone season details for a character.
+ *
+ * Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @param seasonId - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone season details.
+ */
+export declare function characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): Promise<CharacterMythicKeystoneSeasonDetails>;

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.characterMythicKeystoneSeasonDetails = exports.characterMythicKeystoneProfile = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * Returns the Mythic Keystone profile index for a character.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param characterName - The lowercase name of the character.
+ * @returns A promise that resolves to an object representing a Mythic Keystone profile.
+ */
+async function characterMythicKeystoneProfile(realmSlug, characterName) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile`,
+        namespace: "profile",
+    });
+}
+exports.characterMythicKeystoneProfile = 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.
+ */
+async function characterMythicKeystoneSeasonDetails(realmSlug, characterName, seasonId) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile/season/${seasonId}`,
+        namespace: "profile",
+    });
+}
+exports.characterMythicKeystoneSeasonDetails = characterMythicKeystoneSeasonDetails;

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

@@ -0,0 +1,26 @@
+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 Profession {
+    profession: KeyNameId;
+    skill_points?: number;
+    max_skill_points?: number;
+    tiers?: Tier[];
+}
+export interface CharacterProfessions extends LinkSelfHref {
+    character: Character;
+    primaries: Profession[];
+    secondaries: Profession[];
+}
+/**
+ * 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(realmSlug: string, characterName: string): Promise<CharacterProfessions>;

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

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

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

@@ -0,0 +1,82 @@
+import { KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Href {
+    href: string;
+}
+export interface Realm extends KeyNameId {
+    slug: string;
+}
+export interface CharacterProfile extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    gender: TypeName;
+    faction: TypeName;
+    race: KeyNameId;
+    character_class: KeyNameId;
+    active_spec: KeyNameId;
+    realm: Realm;
+    guild: {
+        key: Href;
+        name: LocalizedString;
+        id: number;
+        realm: Realm;
+        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;
+}
+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(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(realmSlug: string, characterName: string): Promise<CharacterProfileStatus>;

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

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

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

@@ -0,0 +1,51 @@
+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;
+}
+/**
+ * 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(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(realmSlug: string, characterName: string): Promise<CharacterPvpSummary>;

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

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

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

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

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

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

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

@@ -0,0 +1,22 @@
+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;
+            name: LocalizedString;
+        };
+    }[];
+}
+/**
+ * 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(realmSlug: string, characterName: string): Promise<CharacterReputations>;

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

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

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

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

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

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

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

@@ -0,0 +1,44 @@
+import type { Character, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface Detail {
+    talent: KeyNameId;
+    spell_tooltip: {
+        spell: KeyNameId;
+        description: LocalizedString;
+        cast_time: LocalizedString;
+        power_cost?: LocalizedString;
+        cooldown?: LocalizedString;
+        range?: LocalizedString;
+    };
+}
+export interface Talent {
+    id: number;
+    rank: number;
+    tooltip: Detail;
+    default_points?: number;
+}
+export interface CharacterSpecializations extends LinkSelfHref {
+    specializations: {
+        specialization: KeyNameId;
+        glyphs?: KeyNameId[];
+        pvp_talent_slots: {
+            selected: Detail;
+            slot_number: number;
+        }[];
+        loadouts: {
+            is_active: boolean;
+            talent_loadout_code: string;
+            selected_class_talents: Talent[];
+            selected_spec_talents: Talent[];
+        }[];
+    }[];
+    active_specialization: KeyNameId;
+    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(realmSlug: string, characterName: string): Promise<CharacterSpecializations>;

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

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