@pinta365/blizzard_api 0.4.0 → 0.6.0

package/esm/src/wow/game_data/mount.js

@@ -0,0 +1,35 @@
+import { search } from "../search.js";
+/**
+ * Returns a index of mounts.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of mounts.
+ */
+export async function mounts(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/mount/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a mount by ID.
+ *
+ * @param mountId - The unique identifier for the mount by ID.
+ * @returns A promise that resolves to an object representing details about a mount.
+ */
+export async function mount(ctx, mountId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/mount/${mountId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of mounts.
+ *
+ * @param searchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a mount search.
+ */
+export async function searchMount(ctx, searchParameters) {
+    return await search(ctx, "/mount", "static", searchParameters);
+}

package/esm/src/wow/game_data/mythic_keystone_dungeon.d.ts

@@ -0,0 +1,92 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, NameId } from "../../shared/index.js";
+export interface MythicKeystoneDungeons extends LinkSelfHref {
+    dungeons: KeyNameId[];
+}
+export interface MythicKeystoneDungeon extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    map: NameId;
+    zone: {
+        slug: string;
+    };
+    dungeon: KeyNameId;
+    keystone_upgrades: {
+        upgrade_level: number;
+        qualifying_duration: number;
+    }[];
+    is_tracked: boolean;
+}
+export interface MythicKeystoneIndex extends LinkSelfHref {
+    seasons: {
+        href: string;
+    };
+    dungeons: {
+        href: string;
+    };
+}
+export interface MythicKeystonePeriods extends LinkSelfHref {
+    periods: KeyId[];
+    current_period: KeyId;
+}
+export interface MythicKeystonePeriod extends LinkSelfHref {
+    id: number;
+    start_timestamp: number;
+    end_timestamp: number;
+}
+export interface MythicKeystoneSeason extends LinkSelfHref {
+    id: number;
+    start_timestamp: number;
+    end_timestamp?: number;
+    periods: KeyId[];
+    season_name: LocalizedString | null;
+}
+/**
+ * Returns an index of Mythic Keystone dungeons.
+ *
+ * @returns A promise that resolves to an object representing a list of the Mythic Keystone dungeons.
+ */
+export declare function mythicKeystoneDungeons(ctx: ApiContext): Promise<MythicKeystoneDungeons>;
+/**
+ * Returns a Mythic Keystone dungeon by ID.
+ *
+ * @param dungeonId - The unique identifier for the Mythic Keystone dungeon
+ * @returns A promise that resolves to an object representing details about a Mythic Keystone dungeon by ID.
+ */
+export declare function mythicKeystoneDungeon(ctx: ApiContext, dungeonId: number): Promise<MythicKeystoneDungeon>;
+/**
+ * Returns an index of links to other documents related to Mythic Keystone dungeons.
+ *
+ * @returns A promise that resolves to an object representing a index of links to other documents related to Mythic Keystone dungeons.
+ */
+export declare function mythicKeystoneIndex(ctx: ApiContext): Promise<MythicKeystoneIndex>;
+/**
+ * Returns an index of Mythic Keystone periods.
+ *
+ * @returns A promise that resolves to an object representing a index of Mythic Keystone periods.
+ */
+export declare function mythicKeystonePeriods(ctx: ApiContext): Promise<MythicKeystonePeriods>;
+/**
+ * Returns a Mythic Keystone period by ID.
+ *
+ * @param periodId - The unique identifier for the Mythic Keystone period
+ * @returns A promise that resolves to an object representing details about a Mythic Keystone period by ID.
+ */
+export declare function mythicKeystonePeriod(ctx: ApiContext, periodId: number): Promise<MythicKeystonePeriod>;
+export interface MythicKeystoneSeasons extends LinkSelfHref {
+    "seasons": KeyId[];
+    "current_season": KeyId;
+}
+/**
+ * Returns an index of Mythic Keystone seasons.
+ *
+ * @returns A promise that resolves to an object representing a index of Mythic Keystone seasons
+ */
+export declare function mythicKeystoneSeasons(ctx: ApiContext): Promise<MythicKeystoneSeasons>;
+/**
+ * Returns a Mythic Keystone season by ID.
+ *
+ * @param seasonId - The unique identifier for the Mythic Keystone season
+ * @returns A promise that resolves to an object representing details about a Mythic Keystone season by ID.
+ */
+export declare function mythicKeystoneSeason(ctx: ApiContext, seasonId: number): Promise<MythicKeystoneSeason>;

package/esm/src/wow/game_data/mythic_keystone_dungeon.js

@@ -0,0 +1,87 @@
+/**
+ * Returns an index of Mythic Keystone dungeons.
+ *
+ * @returns A promise that resolves to an object representing a list of the Mythic Keystone dungeons.
+ */
+export async function mythicKeystoneDungeons(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/mythic-keystone/dungeon/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a Mythic Keystone dungeon by ID.
+ *
+ * @param dungeonId - The unique identifier for the Mythic Keystone dungeon
+ * @returns A promise that resolves to an object representing details about a Mythic Keystone dungeon by ID.
+ */
+export async function mythicKeystoneDungeon(ctx, dungeonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/mythic-keystone/dungeon/${dungeonId}`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns an index of links to other documents related to Mythic Keystone dungeons.
+ *
+ * @returns A promise that resolves to an object representing a index of links to other documents related to Mythic Keystone dungeons.
+ */
+export async function mythicKeystoneIndex(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/mythic-keystone/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns an index of Mythic Keystone periods.
+ *
+ * @returns A promise that resolves to an object representing a index of Mythic Keystone periods.
+ */
+export async function mythicKeystonePeriods(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/mythic-keystone/period/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a Mythic Keystone period by ID.
+ *
+ * @param periodId - The unique identifier for the Mythic Keystone period
+ * @returns A promise that resolves to an object representing details about a Mythic Keystone period by ID.
+ */
+export async function mythicKeystonePeriod(ctx, periodId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/mythic-keystone/period/${periodId}`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns an index of Mythic Keystone seasons.
+ *
+ * @returns A promise that resolves to an object representing a index of Mythic Keystone seasons
+ */
+export async function mythicKeystoneSeasons(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/mythic-keystone/season/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a Mythic Keystone season by ID.
+ *
+ * @param seasonId - The unique identifier for the Mythic Keystone season
+ * @returns A promise that resolves to an object representing details about a Mythic Keystone season by ID.
+ */
+export async function mythicKeystoneSeason(ctx, seasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/mythic-keystone/season/${seasonId}`,
+        namespace: "dynamic",
+    });
+}

package/esm/src/wow/game_data/mythic_keystone_leaderboard.d.ts

@@ -0,0 +1,70 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, NameId } from "../../shared/index.js";
+export interface MythicKeystoneLeaderboards extends LinkSelfHref {
+    current_leaderboards?: KeyNameId[];
+}
+export interface MythicLeaderboardRating {
+    color: {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+    rating: number;
+}
+export interface MythicKeystoneLeaderboard extends LinkSelfHref {
+    map: NameId;
+    period: number;
+    period_start_timestamp: number;
+    period_end_timestamp: number;
+    connected_realm: {
+        href: string;
+    };
+    leading_groups: {
+        ranking: number;
+        duration: number;
+        completed_timestamp: number;
+        keystone_level: number;
+        mythic_rating?: MythicLeaderboardRating;
+        members: {
+            profile: {
+                name: string;
+                id: number;
+                realm: {
+                    key: {
+                        href: string;
+                    };
+                    id: number;
+                    slug: string;
+                };
+            };
+            faction: {
+                type: string;
+            };
+            specialization: KeyId;
+        }[];
+    }[];
+    keystone_affixes: {
+        keystone_affix: KeyNameId;
+        starting_level: number;
+        max_level?: number;
+    }[];
+    map_challenge_mode_id: number;
+    name: LocalizedString;
+}
+/**
+ * Returns an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
+ *
+ * @param connectedRealmId - The unique identifier for the connected realm
+ * @returns A promise that resolves to an object representing an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
+ */
+export declare function mythicKeystoneLeaderboards(ctx: ApiContext, connectedRealmId: number): Promise<MythicKeystoneLeaderboards>;
+/**
+ * Returns a weekly Mythic Keystone Leaderboard by period.
+ *
+ * @param connectedRealmId - The unique identifier for the connected realm
+ * @param dungeonId - The unique identifier for the dungeon
+ * @param period - The unique identifier for the period
+ * @returns A promise that resolves to an object representing details about a weekly Mythic Keystone Leaderboard by period.
+ */
+export declare function mythicKeystoneLeaderboard(ctx: ApiContext, connectedRealmId: number, dungeonId: number, period: number): Promise<MythicKeystoneLeaderboard>;

package/esm/src/wow/game_data/mythic_keystone_leaderboard.js

@@ -0,0 +1,28 @@
+/**
+ * Returns an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
+ *
+ * @param connectedRealmId - The unique identifier for the connected realm
+ * @returns A promise that resolves to an object representing an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
+ */
+export async function mythicKeystoneLeaderboards(ctx, connectedRealmId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/connected-realm/${connectedRealmId}/mythic-leaderboard/index`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a weekly Mythic Keystone Leaderboard by period.
+ *
+ * @param connectedRealmId - The unique identifier for the connected realm
+ * @param dungeonId - The unique identifier for the dungeon
+ * @param period - The unique identifier for the period
+ * @returns A promise that resolves to an object representing details about a weekly Mythic Keystone Leaderboard by period.
+ */
+export async function mythicKeystoneLeaderboard(ctx, connectedRealmId, dungeonId, period) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/connected-realm/${connectedRealmId}/mythic-leaderboard/${dungeonId}/period/${period}`,
+        namespace: "dynamic",
+    });
+}

package/esm/src/wow/game_data/mythic_raid_leaderboard.d.ts

@@ -0,0 +1,36 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, LinkSelfHref } from "../../shared/index.js";
+export interface MythicRaidLeaderboard extends LinkSelfHref {
+    slug: string;
+    criteria_type: string;
+    entries: {
+        guild: {
+            name: string;
+            id: number;
+            realm: {
+                name: null;
+                id: number;
+                slug: string;
+            };
+        };
+        faction: {
+            type: string;
+        };
+        timestamp: number;
+        region: string;
+        rank: number;
+    }[];
+    journal_instance: {
+        key: Href;
+        name: string | null;
+        id: number;
+    };
+}
+/**
+ * Returns the leaderboard for a given raid and faction.
+ *
+ * @param raid - The slug of the raid (e.g. "uldir", "nyalotha-the-waking-city").
+ * @param faction - The faction, "alliance" or "horde".
+ * @returns A promise that resolves to an object representing the leaderboard for a given raid and faction.
+ */
+export declare function mythicRaidLeaderboard(ctx: ApiContext, raid: string, faction: "alliance" | "horde"): Promise<MythicRaidLeaderboard>;

package/esm/src/wow/game_data/mythic_raid_leaderboard.js

@@ -0,0 +1,14 @@
+/**
+ * Returns the leaderboard for a given raid and faction.
+ *
+ * @param raid - The slug of the raid (e.g. "uldir", "nyalotha-the-waking-city").
+ * @param faction - The faction, "alliance" or "horde".
+ * @returns A promise that resolves to an object representing the leaderboard for a given raid and faction.
+ */
+export async function mythicRaidLeaderboard(ctx, raid, faction) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/leaderboard/hall-of-fame/${raid}/${faction}`,
+        namespace: "dynamic",
+    });
+}

package/esm/src/wow/game_data/neighborhood.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft neighborhood map data using the Blizzard API.
+ */
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref, NamedRef } from "../../shared/index.js";
+export interface NeighborhoodMaps extends LinkSelfHref {
+    maps: NamedRef[];
+}
+export interface NeighborhoodMap extends LinkSelfHref {
+    id: number;
+    name: string;
+}
+export interface Neighborhood extends LinkSelfHref {
+    id: number;
+    /** The neighborhood map this neighborhood belongs to. */
+    neighborhood_map: NamedRef;
+    /** Plot/address identifier (e.g. "63-74-67"). */
+    neighborhood_name: string;
+}
+/**
+ * Returns an index of neighborhood maps.
+ */
+export declare function neighborhoodMaps(ctx: ApiContext): Promise<NeighborhoodMaps>;
+/**
+ * Returns a neighborhood map by ID.
+ *
+ * @param neighborhoodMapId - The ID of the neighborhood map.
+ */
+export declare function neighborhoodMap(ctx: ApiContext, neighborhoodMapId: number): Promise<NeighborhoodMap>;
+/**
+ * Returns a neighborhood by ID within a neighborhood map.
+ *
+ * @param neighborhoodMapId - The ID of the neighborhood map.
+ * @param neighborhoodId - The ID of the neighborhood.
+ */
+export declare function neighborhood(ctx: ApiContext, neighborhoodMapId: number, neighborhoodId: number): Promise<Neighborhood>;

package/esm/src/wow/game_data/neighborhood.js

@@ -0,0 +1,38 @@
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft neighborhood map data using the Blizzard API.
+ */
+/**
+ * Returns an index of neighborhood maps.
+ */
+export async function neighborhoodMaps(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/neighborhood-map/index",
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a neighborhood map by ID.
+ *
+ * @param neighborhoodMapId - The ID of the neighborhood map.
+ */
+export async function neighborhoodMap(ctx, neighborhoodMapId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/neighborhood-map/${neighborhoodMapId}`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * Returns a neighborhood by ID within a neighborhood map.
+ *
+ * @param neighborhoodMapId - The ID of the neighborhood map.
+ * @param neighborhoodId - The ID of the neighborhood.
+ */
+export async function neighborhood(ctx, neighborhoodMapId, neighborhoodId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/neighborhood-map/${neighborhoodMapId}/neighborhood/${neighborhoodId}`,
+        namespace: "dynamic",
+    });
+}

package/esm/src/wow/game_data/pet.d.ts

@@ -0,0 +1,93 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Pets extends LinkSelfHref {
+    pets: KeyNameId[];
+}
+export interface Pet extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    battle_pet_type: {
+        id: number;
+        type: string;
+        name: LocalizedString;
+    };
+    description: LocalizedString;
+    is_capturable: boolean;
+    is_tradable: boolean;
+    is_battlepet: boolean;
+    is_alliance_only: boolean;
+    is_horde_only: boolean;
+    abilities: {
+        ability: KeyNameId;
+        slot: number;
+        required_level: number;
+    }[];
+    source: TypeName;
+    icon: string;
+    creature: KeyNameId;
+    is_random_creature_display: boolean;
+    should_exclude_if_uncollected: boolean;
+    media: KeyId;
+}
+export interface PetMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+export interface PetAbilities extends LinkSelfHref {
+    abilities: KeyNameId[];
+}
+export interface PetAbility extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    battle_pet_type: {
+        id: number;
+        type: string;
+        name: LocalizedString;
+    };
+    rounds: number;
+    media: KeyId;
+}
+export interface PetAbilityMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns an index of battle pets.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of battle pets.
+ */
+export declare function pets(ctx: ApiContext): Promise<Pets>;
+/**
+ * Returns a battle pet by ID.
+ *
+ * @param petId - The unique identifier for the battle pet
+ * @returns A promise that resolves to an object representing details about a battle pet.
+ */
+export declare function pet(ctx: ApiContext, petId: number): Promise<Pet>;
+/**
+ * Returns media for a battle pet by ID.
+ *
+ * @param petId - The unique identifier for the battle pet
+ * @returns A promise that resolves to an object representing media details about a battle pet.
+ */
+export declare function petMedia(ctx: ApiContext, petId: number): Promise<PetMedia>;
+/**
+ * Returns an index of pet abilities.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of pet abilities.
+ */
+export declare function petAbilities(ctx: ApiContext): Promise<PetAbilities>;
+/**
+ * Returns a pet ability by ID.
+ *
+ * @param petAbilityId - The unique identifier for the battle pet ability
+ * @returns A promise that resolves to an object representing details about a battle pet ability.
+ */
+export declare function petAbility(ctx: ApiContext, petAbilityId: number): Promise<PetAbility>;
+/**
+ * Returns media for a battle pet by ID.
+ *
+ * @param petAbilityId - The unique identifier for the battle pet
+ * @returns A promise that resolves to an object representing media details about a battle pet.
+ */
+export declare function petAbilityMedia(ctx: ApiContext, petAbilityId: number): Promise<PetAbilityMedia>;

package/esm/src/wow/game_data/pet.js

@@ -0,0 +1,76 @@
+/**
+ * Returns an index of battle pets.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of battle pets.
+ */
+export async function pets(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/pet/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a battle pet by ID.
+ *
+ * @param petId - The unique identifier for the battle pet
+ * @returns A promise that resolves to an object representing details about a battle pet.
+ */
+export async function pet(ctx, petId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pet/${petId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a battle pet by ID.
+ *
+ * @param petId - The unique identifier for the battle pet
+ * @returns A promise that resolves to an object representing media details about a battle pet.
+ */
+export async function petMedia(ctx, petId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/pet/${petId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of pet abilities.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of pet abilities.
+ */
+export async function petAbilities(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/pet-ability/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a pet ability by ID.
+ *
+ * @param petAbilityId - The unique identifier for the battle pet ability
+ * @returns A promise that resolves to an object representing details about a battle pet ability.
+ */
+export async function petAbility(ctx, petAbilityId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/pet-ability/${petAbilityId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a battle pet by ID.
+ *
+ * @param petAbilityId - The unique identifier for the battle pet
+ * @returns A promise that resolves to an object representing media details about a battle pet.
+ */
+export async function petAbilityMedia(ctx, petAbilityId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/pet-ability/${petAbilityId}`,
+        namespace: "static",
+    });
+}

package/esm/src/wow/game_data/playable_class.d.ts

@@ -0,0 +1,58 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface PlayableClasses extends LinkSelfHref {
+    classes: KeyNameId[];
+}
+export interface PlayableClass extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    gender_name: {
+        male: LocalizedString;
+        female: LocalizedString;
+    };
+    power_type: KeyNameId;
+    specializations?: KeyNameId[];
+    media: KeyId;
+    pvp_talent_slots: {
+        href: string;
+    };
+    playable_races: KeyNameId[];
+    additional_power_types?: KeyNameId[];
+}
+export interface PlayableClassMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+export interface PlayableClassPvpTalentSlots extends LinkSelfHref {
+    talent_slots: {
+        slot_number: number;
+        unlock_player_level: number;
+    }[];
+}
+/**
+ * Returns an index of playable classes.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of playable classes.
+ */
+export declare function playableClasses(ctx: ApiContext): Promise<PlayableClasses>;
+/**
+ * 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.
+ */
+export declare function playableClass(ctx: ApiContext, classId: number): Promise<PlayableClass>;
+/**
+ * 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.
+ */
+export declare function playableClassMedia(ctx: ApiContext, playableClassId: number): Promise<PlayableClassMedia>;
+/**
+ * Returns the PvP talent slots for a playable class by ID.
+ *
+ * @param classId - The unique identifier for the playable class
+ * @returns A promise that resolves to an object representing PvP talent slots for a playable class.
+ */
+export declare function playableClassPvpTalentSlots(ctx: ApiContext, classId: number): Promise<PlayableClassPvpTalentSlots>;