@pinta365/blizzard_api 0.3.5

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

@@ -0,0 +1,56 @@
+import type { KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface ModifiedCraftingParents extends LinkSelfHref {
+    categories: {
+        href: string;
+    };
+    slot_types: {
+        href: string;
+    };
+}
+export interface ModifiedCraftingCategories extends LinkSelfHref {
+    categories: KeyNameId;
+}
+export interface ModifiedCraftingCategory extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+}
+export interface ModifiedCraftingSlotTypes extends LinkSelfHref {
+    slot_types: KeyNameId[];
+}
+export interface ModifiedCraftingSlotType extends LinkSelfHref {
+    id: number;
+    description: LocalizedString;
+    compatible_categories: KeyNameId[];
+}
+/**
+ * Returns the parent index for Modified Crafting.
+ *
+ * @returns A promise that resolves to an object representing a list of the parent index for Modified Crafting.
+ */
+export declare function modifiedCraftingParents(): Promise<ModifiedCraftingParents>;
+/**
+ * Returns the index of Modified Crafting categories.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of Modified Crafting categories.
+ */
+export declare function modifiedCraftingCategories(): Promise<ModifiedCraftingCategories>;
+/**
+ * Returns a Modified Crafting category by ID.
+ *
+ * @param categoryId - The unique identifier for the Modified Crafting category
+ * @returns A promise that resolves to an object representing details about a Modified Crafting category.
+ */
+export declare function modifiedCraftingCategory(categoryId: number): Promise<ModifiedCraftingCategory>;
+/**
+ * Returns the index of Modified Crafting reagent slot types.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of Modified Crafting reagent slot types
+ */
+export declare function modifiedCraftingSlotTypes(): Promise<ModifiedCraftingSlotTypes>;
+/**
+ * Returns a Modified Crafting reagent slot type by ID.
+ *
+ * @param slotTypeId - The unique identifier for the Modified Crafting reagent slot type
+ * @returns A promise that resolves to an object representing details about a Modified Crafting reagent slot type by ID.
+ */
+export declare function modifiedCraftingSlotType(slotTypeId: number): Promise<ModifiedCraftingSlotType>;

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

@@ -0,0 +1,63 @@
+import { request } from "../../shared/index.js";
+/**
+ * Returns the parent index for Modified Crafting.
+ *
+ * @returns A promise that resolves to an object representing a list of the parent index for Modified Crafting.
+ */
+export async function modifiedCraftingParents() {
+    return await request({
+        method: "GET",
+        url: "/data/wow/modified-crafting/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns the index of Modified Crafting categories.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of Modified Crafting categories.
+ */
+export async function modifiedCraftingCategories() {
+    return await request({
+        method: "GET",
+        url: "/data/wow/modified-crafting/category/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a Modified Crafting category by ID.
+ *
+ * @param categoryId - The unique identifier for the Modified Crafting category
+ * @returns A promise that resolves to an object representing details about a Modified Crafting category.
+ */
+export async function modifiedCraftingCategory(categoryId) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/modified-crafting/category/${categoryId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns the index of Modified Crafting reagent slot types.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of Modified Crafting reagent slot types
+ */
+export async function modifiedCraftingSlotTypes() {
+    return await request({
+        method: "GET",
+        url: "/data/wow/modified-crafting/reagent-slot-type/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a Modified Crafting reagent slot type by ID.
+ *
+ * @param slotTypeId - The unique identifier for the Modified Crafting reagent slot type
+ * @returns A promise that resolves to an object representing details about a Modified Crafting reagent slot type by ID.
+ */
+export async function modifiedCraftingSlotType(slotTypeId) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/modified-crafting/reagent-slot-type/${slotTypeId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,30 @@
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Mounts extends LinkSelfHref {
+    mounts: KeyNameId[];
+}
+export interface Mount extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    creature_displays: KeyId[];
+    description: LocalizedString;
+    source: TypeName;
+    faction?: TypeName;
+    should_exclude_if_uncollected?: boolean;
+    requirements?: {
+        faction: TypeName;
+    };
+}
+/**
+ * Returns a index of mounts.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of mounts.
+ */
+export declare function mounts(): Promise<Mounts>;
+/**
+ * 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 declare function mount(mountId: number): Promise<Mount>;
+export declare function searchMount(): void;

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

@@ -0,0 +1,30 @@
+import { request } from "../../shared/index.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() {
+    return await 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(mountId) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/mount/${mountId}`,
+        namespace: "static",
+    });
+}
+export function searchMount() {
+    //TODO: Placeholder for the mount Search, will probably be using ./search.ts
+    throw new Error("Not implemented yet!");
+}

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

@@ -0,0 +1,91 @@
+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_updates: {
+        upgrade_level: number;
+        qualifying_duration: number;
+    }[];
+    is_traacked: 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;
+}
+/**
+ * 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(): 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(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(): 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(): 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(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(): 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(seasonId: number): Promise<MythicKeystoneSeason>;

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

@@ -0,0 +1,88 @@
+import { request } from "../../shared/index.js";
+/**
+ * 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() {
+    return await 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(dungeonId) {
+    return await 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() {
+    return await 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() {
+    return await 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(periodId) {
+    return await 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() {
+    return await 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(seasonId) {
+    return await 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,58 @@
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, NameId } from "../../shared/index.js";
+export interface MythicKeystoneLeaderboards extends LinkSelfHref {
+    current_leaderboards: KeyNameId[];
+}
+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;
+        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;
+    }[];
+    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(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(connectedRealmId: number, dungeonId: number, period: number): Promise<MythicKeystoneLeaderboard>;

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

@@ -0,0 +1,29 @@
+import { request } from "../../shared/index.js";
+/**
+ * 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(connectedRealmId) {
+    return await 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(connectedRealmId, dungeonId, period) {
+    return await 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,31 @@
+import type { KeyNameId, 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: KeyNameId;
+}
+/**
+ * Returns the leaderboard for a given raid and faction.
+ *
+ * @param raid - The unique identifier for the raid
+ * @param faction - The unique identifier for the faction
+ * @returns A promise that resolves to an object representing the leaderboard for a given raid and faction.
+ */
+export declare function mythicRaidLeaderboard(raid: number, faction: number): Promise<MythicRaidLeaderboard>;

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

@@ -0,0 +1,15 @@
+import { request } from "../../shared/index.js";
+/**
+ * Returns the leaderboard for a given raid and faction.
+ *
+ * @param raid - The unique identifier for the raid
+ * @param faction - The unique identifier for the faction
+ * @returns A promise that resolves to an object representing the leaderboard for a given raid and faction.
+ */
+export async function mythicRaidLeaderboard(raid, faction) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/leaderboard/hall-of-fame/${raid}/${faction}`,
+        namespace: "dynamic",
+    });
+}

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

@@ -0,0 +1,91 @@
+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;
+    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(): 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(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(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(): 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(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(petAbilityId: number): Promise<PetAbilityMedia>;

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

@@ -0,0 +1,77 @@
+import { request } from "../../shared/index.js";
+/**
+ * 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() {
+    return await 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(petId) {
+    return await 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(petId) {
+    return await 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() {
+    return await 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(petAbilityId) {
+    return await 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(petAbilityId) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/media/pet-ability${petAbilityId}`,
+        namespace: "static",
+    });
+}