@pinta365/blizzard_api 0.3.9 → 0.5.0

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

@@ -0,0 +1,185 @@
+/**
+ * This module provides the WoW Account Profile API. These endpoints require a user access token with the
+ * `wow.profile` scope, acquired via the authorization code flow: use `client.forUser(token).wow.*`.
+ */
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+import type { CollectedHeirloom, CollectedPet, CollectedToy, DecorItem } from "./character_collections.js";
+export interface AccountCharacter {
+    character: Href;
+    protected_character: Href;
+    name: string;
+    id: number;
+    realm: KeyNameId & {
+        slug: string;
+    };
+    playable_class: KeyNameId;
+    playable_race: KeyNameId;
+    gender: TypeName;
+    faction: TypeName;
+    level: number;
+}
+export interface AccountProfileSummary extends LinkSelfHref {
+    id: number;
+    wow_accounts: {
+        id: number;
+        characters: AccountCharacter[];
+    }[];
+    collections: Href;
+}
+export interface ProtectedCharacterProfile extends LinkSelfHref {
+    id: number;
+    name: string;
+    money: number;
+    character: {
+        key: Href;
+        name: string;
+        id: number;
+        realm: KeyNameId & {
+            slug: string;
+        };
+    };
+    protected_stats: {
+        total_number_deaths: number;
+        total_gold_gained: number;
+        total_gold_lost: number;
+        total_item_value_gained: number;
+        level_number_deaths: number;
+        level_gold_gained: number;
+        level_gold_lost: number;
+        level_item_value_gained: number;
+    };
+    position: {
+        zone: {
+            name: string;
+            id: number;
+        };
+        map: {
+            name: string;
+            id: number;
+        };
+        x: number;
+        y: number;
+        z: number;
+        facing: number;
+    };
+    bind_position: {
+        zone: {
+            name: string;
+            id: number;
+        };
+        map: {
+            name: string;
+            id: number;
+        };
+        x: number;
+        y: number;
+        z: number;
+        facing: number;
+    };
+    wow_account: number;
+}
+export interface AccountCollectionsIndex extends LinkSelfHref {
+    pets: Href;
+    mounts: Href;
+    heirlooms: Href;
+    toys: Href;
+    transmogs: Href;
+    decor?: Href;
+}
+export interface AccountMount {
+    mount: KeyNameId;
+    is_favorite?: boolean;
+    is_useable?: boolean;
+}
+export interface AccountMountsCollection extends LinkSelfHref {
+    mounts: AccountMount[];
+}
+export interface AccountPetsCollection extends LinkSelfHref {
+    pets: CollectedPet[];
+    unlocked_battle_pet_slots: number;
+}
+export interface AccountToysCollection extends LinkSelfHref {
+    toys: CollectedToy[];
+}
+export interface AccountHeirloomsCollection extends LinkSelfHref {
+    heirlooms: CollectedHeirloom[];
+}
+export interface AccountTransmogsCollection extends LinkSelfHref {
+    appearance_sets: KeyNameId[];
+    slots: {
+        slot: TypeName;
+        appearances: {
+            key: Href;
+            id: number;
+        }[];
+    }[];
+}
+export interface AccountDecorCollection extends LinkSelfHref {
+    decor_collected: DecorItem[];
+}
+/**
+ * Returns a profile summary for an account, including its WoW accounts and characters.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account profile summary.
+ */
+export declare function accountProfileSummary(ctx: ApiContext): Promise<AccountProfileSummary>;
+/**
+ * Returns a protected profile summary for a character (money, deaths, position, ...).
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @param realmId - The ID of the character's realm.
+ * @param characterId - The ID of the character.
+ * @returns A promise that resolves to an object representing the protected character profile.
+ */
+export declare function protectedCharacterProfile(ctx: ApiContext, realmId: number, characterId: number): Promise<ProtectedCharacterProfile>;
+/**
+ * Returns an index of collection types for an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object with links to the account's collections.
+ */
+export declare function accountCollectionsIndex(ctx: ApiContext): Promise<AccountCollectionsIndex>;
+/**
+ * Returns the mounts collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's mounts.
+ */
+export declare function accountMountsCollection(ctx: ApiContext): Promise<AccountMountsCollection>;
+/**
+ * Returns the battle pets collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's pets.
+ */
+export declare function accountPetsCollection(ctx: ApiContext): Promise<AccountPetsCollection>;
+/**
+ * Returns the toys collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's toys.
+ */
+export declare function accountToysCollection(ctx: ApiContext): Promise<AccountToysCollection>;
+/**
+ * Returns the heirlooms collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's heirlooms.
+ */
+export declare function accountHeirloomsCollection(ctx: ApiContext): Promise<AccountHeirloomsCollection>;
+/**
+ * Returns the transmog appearances and sets collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's transmogs.
+ */
+export declare function accountTransmogsCollection(ctx: ApiContext): Promise<AccountTransmogsCollection>;
+/**
+ * Returns the housing decor collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's decor.
+ */
+export declare function accountDecorCollection(ctx: ApiContext): Promise<AccountDecorCollection>;

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

@@ -0,0 +1,132 @@
+/**
+ * This module provides the WoW Account Profile API. These endpoints require a user access token with the
+ * `wow.profile` scope, acquired via the authorization code flow: use `client.forUser(token).wow.*`.
+ */
+/**
+ * Returns a profile summary for an account, including its WoW accounts and characters.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account profile summary.
+ */
+export async function accountProfileSummary(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns a protected profile summary for a character (money, deaths, position, ...).
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @param realmId - The ID of the character's realm.
+ * @param characterId - The ID of the character.
+ * @returns A promise that resolves to an object representing the protected character profile.
+ */
+export async function protectedCharacterProfile(ctx, realmId, characterId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/profile/user/wow/protected-character/${realmId}-${characterId}`,
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns an index of collection types for an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object with links to the account's collections.
+ */
+export async function accountCollectionsIndex(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns the mounts collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's mounts.
+ */
+export async function accountMountsCollection(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections/mounts",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns the battle pets collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's pets.
+ */
+export async function accountPetsCollection(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections/pets",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns the toys collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's toys.
+ */
+export async function accountToysCollection(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections/toys",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns the heirlooms collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's heirlooms.
+ */
+export async function accountHeirloomsCollection(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections/heirlooms",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns the transmog appearances and sets collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's transmogs.
+ */
+export async function accountTransmogsCollection(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections/transmogs",
+        namespace: "profile",
+        auth: "user",
+    });
+}
+/**
+ * Returns the housing decor collected by an account.
+ * Requires a user access token (client.forUser(token)).
+ *
+ * @returns A promise that resolves to an object representing the account's decor.
+ */
+export async function accountDecorCollection(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/profile/user/wow/collections/decor",
+        namespace: "profile",
+        auth: "user",
+    });
+}

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

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

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

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

package/esm/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>;