@pinta365/blizzard_api 0.4.0 → 0.5.0

package/esm/src/generated/wow_classic_era_api.d.ts

@@ -0,0 +1,418 @@
+import type { Achievement, AchievementCategory, AchievementMedia, Achievements } from "../wow/game_data/achievement.js";
+import type { AuctionHouseAuctions, AuctionHouses } from "../wow_classic/auction_house.js";
+import type { CharacterHunterPets } from "../wow/profile/character_hunter_pets.js";
+import type { CharacterMedia } from "../wow/profile/character_media.js";
+import type { CharacterProfileStatus } from "../wow/profile/character_profile.js";
+import type { CharacterReputations } from "../wow/profile/character_reputations.js";
+import type { ClassicAchievementCategories, ClassicCharacterAppearanceSummary, ClassicCharacterProfile, ClassicCharacterPvpSummary, ClassicCharacterStatistics, ClassicConnectedRealm, ClassicGuildAchievements } from "../wow_classic/profile_overrides.js";
+import type { ClassicEraCharacterSpecializations } from "../wow_classic/character_specializations.js";
+import type { ConnectedRealms } from "../wow/game_data/connected_realm.js";
+import type { Creature, CreatureDisplayMedia, CreatureFamilies, CreatureFamily, CreatureFamilyMedia, CreatureType, CreatureTypes } from "../wow/game_data/creature.js";
+import type { Guild, GuildActivity, GuildRoster } from "../wow/profile/guild.js";
+import type { GuildCrestBorder, GuildCrestEmblem, GuildCrests } from "../wow/game_data/guild_crest.js";
+import type { Item, ItemClass, ItemClasses, ItemMedia, ItemSubclass } from "../wow/game_data/item.js";
+import type { PlayableClass, PlayableClasses, PlayableClassMedia } from "../wow/game_data/playable_class.js";
+import type { PlayableRace, PlayableRaces } from "../wow/game_data/playable_race.js";
+import type { PowerType, PowerTypes } from "../wow/game_data/power_type.js";
+import type { Realm, Realms } from "../wow/game_data/realm.js";
+import type { Region, Regions } from "../wow/game_data/region.js";
+import type { Search, SearchParameters } from "../wow/search.js";
+import type { characterEquipments } from "../wow/profile/character_equipment.js";
+/**
+ * World of Warcraft Classic Era endpoints (Era, Season of Discovery, Hardcore, Anniversary).
+ */
+export interface WowClassicEraApi {
+    /**
+     * Fetches and returns details of a specific achievement identified by its ID.
+     *
+     * @param achievementId - The unique identifier of the achievement to retrieve.
+     * @returns A promise that resolves to an object representing the achievement details.
+     */
+    achievement(achievementId: number): Promise<Achievement>;
+    /**
+     * Returns an index of achievement categories.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of achievement categories.
+     */
+    achievementCategories(): Promise<ClassicAchievementCategories>;
+    /**
+     * Fetches and returns details of a specific achievement category identified by its ID.
+     *
+     * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
+     * @returns A promise that resolves to an object representing the achievement category details.
+     */
+    achievementCategory(achievementCategoryId: number): Promise<AchievementCategory>;
+    /**
+     * Fetches and returns media details for a specific achievement identified by its ID.
+     *
+     * @param achievementId - The unique identifier of the achievement to retrieve media details for.
+     * @returns A promise that resolves to an object representing the achievement media details.
+     */
+    achievementMedia(achievementId: number): Promise<AchievementMedia>;
+    /**
+     * Fetches and returns an index of achievements.
+     *
+     * @returns A promise that resolves to an object representing the index of achievements.
+     */
+    achievements(): Promise<Achievements>;
+    /**
+     * Returns all active auctions of one auction house of a Classic Era connected realm.
+     *
+     * @param connectedRealmId - The ID of the connected realm.
+     * @param auctionHouseId - The ID of the auction house, from auctionHouses().
+     * @returns A promise that resolves to an object listing the auctions.
+     */
+    auctionHouse(connectedRealmId: number, auctionHouseId: number): Promise<AuctionHouseAuctions>;
+    /**
+     * Returns an index of the auction houses (Alliance, Horde, neutral) of a Classic Era connected realm.
+     *
+     * @param connectedRealmId - The ID of the connected realm.
+     * @returns A promise that resolves to an object listing the auction houses.
+     */
+    auctionHouses(connectedRealmId: number): Promise<AuctionHouses>;
+    /**
+     * 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 a summary of a character's appearance settings.
+     */
+    characterAppearanceSummary(realmSlug: string, characterName: string): Promise<ClassicCharacterAppearanceSummary>;
+    /**
+     * Returns a summary of the items equipped by a character.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing details about items equipped by a character.
+     */
+    characterEquipments(realmSlug: string, characterName: string): Promise<characterEquipments>;
+    /**
+     * If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of the character's hunter pets.
+     */
+    characterHunterPets(realmSlug: string, characterName: string): Promise<CharacterHunterPets>;
+    /**
+     * Returns a summary of the media assets available for a character (such as an avatar render).
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param characterName - The lowercase name of the character.
+     * @returns A promise that resolves to an object representing a summary of the media assets available for a character.
+     */
+    characterMedia(realmSlug: string, characterName: string): Promise<CharacterMedia>;
+    /**
+     * 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 for a character.
+     */
+    characterProfile(realmSlug: string, characterName: string): Promise<ClassicCharacterProfile>;
+    /**
+     * 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.
+     */
+    characterProfileStatus(realmSlug: string, characterName: string): Promise<CharacterProfileStatus>;
+    /**
+     * 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 a PvP summary for a character.
+     */
+    characterPvpSummary(realmSlug: string, characterName: string): Promise<ClassicCharacterPvpSummary>;
+    /**
+     * 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.
+     */
+    characterReputations(realmSlug: string, characterName: string): Promise<CharacterReputations>;
+    /**
+     * Returns a summary of a character's talent trees (Classic Era).
+     *
+     * @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 character's talent groups.
+     */
+    characterSpecializations(realmSlug: string, characterName: string): Promise<ClassicEraCharacterSpecializations>;
+    /**
+     * 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.
+     */
+    characterStatistics(realmSlug: string, characterName: string): Promise<ClassicCharacterStatistics>;
+    /**
+     * Returns a connected realm by ID.
+     *
+     * @param connectedRealmId - The ID of the connected realm.
+     * @returns A promise that resolves to an object representing details about a connected realm.
+     */
+    connectedRealm(connectedRealmId: number): Promise<ClassicConnectedRealm>;
+    /**
+     * Returns the Connected Realms Index
+     *
+     * @returns A promise that resolves to an object representing a list of all Connected Realms.
+     */
+    connectedRealms(): Promise<ConnectedRealms>;
+    /**
+     * Returns details about a creature
+     *
+     * @param creatureId - The unique identifier for the creature
+     * @returns A promise that resolves to an object representing details about a creature.
+     */
+    creature(creatureId: number): Promise<Creature>;
+    /**
+     * Returns media details about a specific Creature display
+     *
+     * @param creatureDisplayId - The unique identifier Creature display Id.
+     * @returns A promise that resolves to an object representing media details about a Creature display.
+     */
+    creatureDisplayMedia(creatureDisplayId: number): Promise<CreatureDisplayMedia>;
+    /**
+     * Returns an index of creature families.
+     *
+     * @returns A promise that resolves to an object representing a list of all creature families.
+     */
+    creatureFamilies(): Promise<CreatureFamilies>;
+    /**
+     * Returns details about a creature family
+     *
+     * @param creatureFamilyId - The unique identifier for the creature family
+     * @returns A promise that resolves to an object representing details about a creature family.
+     */
+    creatureFamily(creatureFamilyId: number): Promise<CreatureFamily>;
+    /**
+     * Returns media details about a specific Creature family
+     *
+     * @param creatureFamilyId - The unique identifier Creature family Id.
+     * @returns A promise that resolves to an object representing media details about a Creature family.
+     */
+    creatureFamilyMedia(creatureFamilyId: number): Promise<CreatureFamilyMedia>;
+    /**
+     * Returns details about a creature types
+     *
+     * @param creatureTypeId - The unique identifier for the creature types
+     * @returns A promise that resolves to an object representing details about a creature types.
+     */
+    creatureType(creatureTypeId: number): Promise<CreatureType>;
+    /**
+     * Returns an index of creature types.
+     *
+     * @returns A promise that resolves to an object representing a list of all creature types.
+     */
+    creatureTypes(): Promise<CreatureTypes>;
+    /**
+     * Returns a single guild by its name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild by its name and realm.
+     */
+    guild(realmSlug: string, nameSlug: string): Promise<Guild>;
+    /**
+     * Returns a single guild's achievements by name.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a guild's achievements.
+     */
+    guildAchievements(realmSlug: string, nameSlug: string): Promise<ClassicGuildAchievements>;
+    /**
+     * Returns a single guild's activity by name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild's activity by its name and realm.
+     */
+    guildActivity(realmSlug: string, nameSlug: string): Promise<GuildActivity>;
+    /**
+     * Returns a Guild Crest Border Media
+     *
+     * @param borderId - The unique identifier for the Covenant
+     * @returns A promise that resolves to an object representing details about a Guild Crest Border Media.
+     */
+    guildCrestBorder(borderId: number): Promise<GuildCrestBorder>;
+    /**
+     * Returns a Crest Emblem Media
+     *
+     * @param emblemId - The unique identifier for the Crest Emblem Media
+     * @returns A promise that resolves to an object representing details about a Crest Emblem Media.
+     */
+    guildCrestEmblem(emblemId: number): Promise<GuildCrestEmblem>;
+    /**
+     * Returns the Guild Crest Components Index
+     *
+     * @returns A promise that resolves to an object representing a list of all Guild Crest Components.
+     */
+    guildCrests(): Promise<GuildCrests>;
+    /**
+     * Returns a single guild's roster by its name and realm.
+     *
+     * @param realmSlug - The slug of the realm.
+     * @param nameSlug - The slug of the guild.
+     * @returns A promise that resolves to an object representing a single guild's roster by its name and realm.
+     */
+    guildRoster(realmSlug: string, nameSlug: string): Promise<GuildRoster>;
+    /**
+     * Returns an item by ID.
+     *
+     * @param itemId - The unique identifier for the item by ID.
+     * @returns A promise that resolves to an object representing details about an item by ID.
+     */
+    item(itemId: number): Promise<Item>;
+    /**
+     * Returns an item class by ID.
+     *
+     * @param itemClassId - The unique identifier for the item class by ID.
+     * @returns A promise that resolves to an object representing details about an item class by ID.
+     */
+    itemClass(itemClassId: number): Promise<ItemClass>;
+    /**
+     * Returns an index of item classes.
+     *
+     * @returns A promise that resolves to an object representing a list of item classes.
+     */
+    itemClasses(): Promise<ItemClasses>;
+    /**
+     * Returns media details about a specific item Id
+     *
+     * @param itemId - The unique identifier for the item
+     * @returns A promise that resolves to an object representing media details about an item.
+     */
+    itemMedia(itemId: number): Promise<ItemMedia>;
+    /**
+     * Returns an item subclass by ID.
+     *
+     * @param itemClassId - The unique identifier for the item class by ID.
+     * @param itemSubclassId - The unique identifier for the item subclass by ID.
+     * @returns A promise that resolves to an object representing details about an item set by ID.
+     */
+    itemSubclass(itemClassId: number, itemSubclassId: number): Promise<ItemSubclass>;
+    /**
+     * Returns a playable class by ID.
+     *
+     * @param classId - The unique identifier for the playable class
+     * @returns A promise that resolves to an object representing details about a playable class.
+     */
+    playableClass(classId: number): Promise<PlayableClass>;
+    /**
+     * Returns an index of playable classes.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of playable classes.
+     */
+    playableClasses(): Promise<PlayableClasses>;
+    /**
+     * Returns media for a playable class by ID.
+     *
+     * @param playableClassId - The unique identifier for the playable class
+     * @returns A promise that resolves to an object representing media details about a playable class.
+     */
+    playableClassMedia(playableClassId: number): Promise<PlayableClassMedia>;
+    /**
+     * Returns a playable race by ID.
+     *
+     * @param playableRaceId - The unique identifier for the playable race
+     * @returns A promise that resolves to an object representing details about a playable race.
+     */
+    playableRace(playableRaceId: number): Promise<PlayableRace>;
+    /**
+     * Returns an index of playable races.
+     *
+     * @returns A promise that resolves to an object representing a list of the index of playable races.
+     */
+    playableRaces(): Promise<PlayableRaces>;
+    /**
+     * Returns a power type by ID.
+     *
+     * @param powerTypeId - The unique identifier for the power type.
+     * @returns A promise that resolves to an object representing details about a power type.
+     */
+    powerType(powerTypeId: number): Promise<PowerType>;
+    /**
+     * Returns an index of power types.
+     *
+     * @returns A promise that resolves to an object representing a list of power types.
+     */
+    powerTypes(): Promise<PowerTypes>;
+    /**
+     * Returns a single realm by slug or ID.
+     *
+     * @param realmSlugOrId - The unique identifier for the realm.
+     * @returns A promise that resolves to an object representing details about a realm.
+     */
+    realm(realmSlugOrId: string | number): Promise<Realm>;
+    /**
+     * Returns an index of realms.
+     *
+     * @returns A promise that resolves to an object representing a list of realms.
+     */
+    realms(): Promise<Realms>;
+    /**
+     * Returns a region by ID.
+     *
+     * @param regionId - The unique identifier for the region.
+     * @returns A promise that resolves to an object representing details about a region.
+     */
+    region(regionId: number): Promise<Region>;
+    /**
+     * Returns an index of regions.
+     *
+     * @returns A promise that resolves to an object representing a list of regions.
+     */
+    regions(): Promise<Regions>;
+    /**
+     * Performs a search of connected realms.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about the connected realms search.
+     */
+    searchConnectedRealm(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of creatures.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a creature search.
+     */
+    searchCreature(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of items.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about an item search.
+     */
+    searchItem(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of media.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a media search.
+     */
+    searchMedia(searchParameters: SearchParameters): Promise<Search>;
+    /**
+     * Performs a search of realms.
+     *
+     * @param SearchParameters - Object containing search parameters.
+     * @returns A promise that resolves to an object representing details about a realm search.
+     */
+    searchRealm(searchParameters: SearchParameters): Promise<Search>;
+}

package/esm/src/generated/wow_classic_era_api.js

@@ -0,0 +1,2 @@
+// Generated by scripts/gen_api.ts from src/wow_classic/era.ts. Do not edit; run `deno task gen:api`.
+export {};

package/esm/src/hearthstone/game_data/card_backs.d.ts

@@ -0,0 +1,31 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LocalizedString } from "../../shared/index.js";
+import type { SearchParameters } from "../search.js";
+export interface Cardback {
+    id: number;
+    sortCategory: number;
+    text: LocalizedString;
+    name: LocalizedString;
+    image: string;
+    slug: string;
+}
+export interface CardbackSearch {
+    cardBacks: Cardback[];
+    cardCount: number;
+    pageCount: number;
+    page: number;
+}
+/**
+ * Returns an up-to-date list of all card backs matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all card backs matching the search criteria.
+ */
+export declare function searchCardbacks(ctx: ApiContext, searchParameters: SearchParameters): Promise<CardbackSearch>;
+/**
+ * Returns the card back with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card back by slug.
+ * @returns A promise that resolves to an object representing details about a card back.
+ */
+export declare function fetchCardback(ctx: ApiContext, idorslug: string): Promise<Cardback>;

package/esm/src/hearthstone/game_data/card_backs.js

@@ -0,0 +1,22 @@
+import { search } from "../search.js";
+/**
+ * Returns an up-to-date list of all card backs matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all card backs matching the search criteria.
+ */
+export async function searchCardbacks(ctx, searchParameters) {
+    return await search(ctx, "/cardbacks", searchParameters);
+}
+/**
+ * Returns the card back with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card back by slug.
+ * @returns A promise that resolves to an object representing details about a card back.
+ */
+export async function fetchCardback(ctx, idorslug) {
+    return await ctx.request({
+        method: "GET",
+        url: `/hearthstone/cardbacks/${idorslug}`,
+    });
+}

package/esm/src/hearthstone/game_data/cards.d.ts

@@ -0,0 +1,55 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LocalizedString } from "../../shared/index.js";
+import type { SearchParameters } from "../search.js";
+export interface Card {
+    id: number;
+    collectible: number;
+    slug: string;
+    classId: number;
+    multiClassIds: number[];
+    cardTypeId: number;
+    cardSetId: number;
+    rarityId: number;
+    artistName: string | null;
+    health?: number;
+    attack?: number;
+    manaCost: number;
+    name: LocalizedString;
+    text: LocalizedString;
+    image: string;
+    imageGold: string;
+    flavorText: LocalizedString;
+    cropImage: string;
+    keywordIds?: number[];
+    childIds?: number[];
+    parentId?: number;
+    copyOfCardId?: number[];
+    spellSchoolId?: number;
+    minionTypeId?: number;
+    isZilliaxCosmeticModule?: boolean;
+    isZilliaxFunctionalModule?: boolean;
+    duels?: {
+        relevant: boolean;
+        constructed: boolean;
+    };
+}
+export interface CardSearch {
+    cards: Card[];
+    cardCount: number;
+    pageCount: number;
+    page: number;
+}
+/**
+ * Returns an up-to-date list of all cards matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all cards matching the search criteria.
+ */
+export declare function searchCards(ctx: ApiContext, searchParameters: SearchParameters): Promise<CardSearch>;
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card by slug.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+export declare function fetchCard(ctx: ApiContext, idorslug: string, gameMode?: string): Promise<Card>;

package/esm/src/hearthstone/game_data/cards.js

@@ -0,0 +1,26 @@
+import { search } from "../search.js";
+/**
+ * Returns an up-to-date list of all cards matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all cards matching the search criteria.
+ */
+export async function searchCards(ctx, searchParameters) {
+    return await search(ctx, "/cards", searchParameters);
+}
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card by slug.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+export async function fetchCard(ctx, idorslug, gameMode) {
+    const reqOptions = {
+        method: "GET",
+        url: `/hearthstone/cards/${idorslug}`,
+    };
+    if (gameMode) {
+        reqOptions["qs"] = { gameMode };
+    }
+    return await ctx.request(reqOptions);
+}

package/esm/src/hearthstone/game_data/decks.d.ts

@@ -0,0 +1,29 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LocalizedString } from "../../shared/index.js";
+import type { Card } from "./cards.js";
+export interface Options {
+    code?: string;
+    ids?: string;
+    hero?: string;
+}
+export interface Deck {
+    deckCode: string;
+    version: number;
+    format: string;
+    hero: Card;
+    heroPower: Card;
+    class: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    };
+    cards: Card[];
+    cardCount: number;
+}
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param options - find parameters fort the search.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+export declare function fetchDeck(ctx: ApiContext, options?: Options): Promise<Deck>;

package/esm/src/hearthstone/game_data/decks.js

@@ -0,0 +1,13 @@
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param options - find parameters fort the search.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+export async function fetchDeck(ctx, options) {
+    return await ctx.request({
+        method: "GET",
+        url: `/hearthstone/deck`,
+        qs: options,
+    });
+}