@pinta365/blizzard_api 0.4.0 → 0.5.0

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

@@ -0,0 +1,102 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, KeyId, NamedRef } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface AppearanceSlot {
+    type: string;
+    name: string;
+}
+export interface ItemAppearance {
+    "_links": {
+        self: Href;
+    };
+    id: number;
+    slot: AppearanceSlot;
+    item_class: NamedRef;
+    item_subclass: NamedRef;
+    item_display_info_id: number;
+    items: NamedRef[];
+    media: KeyId;
+}
+export interface ItemAppearanceSets {
+    "_links": {
+        self: Href;
+    };
+    appearance_sets: NamedRef[];
+}
+export interface ItemAppearanceSet {
+    "_links": {
+        self: Href;
+    };
+    id: number;
+    set_name: string;
+    appearances: KeyId[];
+}
+export interface ItemAppearanceSlotRef {
+    key: Href;
+}
+export interface ItemAppearanceSlots {
+    "_links": {
+        self: Href;
+    };
+    slots: ItemAppearanceSlotRef[];
+}
+export interface ItemAppearanceSlot {
+    "_links": {
+        self: Href;
+    };
+    appearances: KeyId[];
+}
+export interface ItemAppearanceSearchResult {
+    key: Href;
+    data: {
+        id: number;
+        item_display_info_id: number;
+        slot: {
+            type: string;
+            name: string | Record<string, string>;
+        };
+    };
+}
+export interface ItemAppearanceSearch extends Search {
+    results: ItemAppearanceSearchResult[];
+}
+/**
+ * Returns an item appearance by ID.
+ *
+ * @param appearanceId - The unique identifier for the item appearance by ID.
+ * @returns A promise that resolves to an object representing details about an item appearance.
+ */
+export declare function itemAppearance(ctx: ApiContext, appearanceId: number): Promise<ItemAppearance>;
+/**
+ * Returns a index of item appearance sets.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of item appearance sets.
+ */
+export declare function itemAppearanceSets(ctx: ApiContext): Promise<ItemAppearanceSets>;
+/**
+ * Returns an item appearance set by ID.
+ *
+ * @param appearanceSetId - The unique identifier for the item appearance set by ID.
+ * @returns A promise that resolves to an object representing details about an item appearance set.
+ */
+export declare function itemAppearanceSet(ctx: ApiContext, appearanceSetId: number): Promise<ItemAppearanceSet>;
+/**
+ * Returns a index of item appearance slots.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of item appearance slots.
+ */
+export declare function itemAppearanceSlots(ctx: ApiContext): Promise<ItemAppearanceSlots>;
+/**
+ * Returns an item appearance slot by slot type.
+ *
+ * @param slotType - The slot type (e.g. "HEAD", "SHOULDER", "BODY").
+ * @returns A promise that resolves to an object representing details about an item appearance slot.
+ */
+export declare function itemAppearanceSlot(ctx: ApiContext, slotType: string): Promise<ItemAppearanceSlot>;
+/**
+ * Performs a search of item appearances.
+ *
+ * @param searchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about an item appearance search.
+ */
+export declare function searchItemAppearance(ctx: ApiContext, searchParameters: SearchParameters): Promise<ItemAppearanceSearch>;

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

@@ -0,0 +1,73 @@
+import { search } from "../search.js";
+/**
+ * Returns an item appearance by ID.
+ *
+ * @param appearanceId - The unique identifier for the item appearance by ID.
+ * @returns A promise that resolves to an object representing details about an item appearance.
+ */
+export async function itemAppearance(ctx, appearanceId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item-appearance/${appearanceId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns a index of item appearance sets.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of item appearance sets.
+ */
+export async function itemAppearanceSets(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/item-appearance/set/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns an item appearance set by ID.
+ *
+ * @param appearanceSetId - The unique identifier for the item appearance set by ID.
+ * @returns A promise that resolves to an object representing details about an item appearance set.
+ */
+export async function itemAppearanceSet(ctx, appearanceSetId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item-appearance/set/${appearanceSetId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns a index of item appearance slots.
+ *
+ * @returns A promise that resolves to an object representing a list of the index of item appearance slots.
+ */
+export async function itemAppearanceSlots(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/item-appearance/slot/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns an item appearance slot by slot type.
+ *
+ * @param slotType - The slot type (e.g. "HEAD", "SHOULDER", "BODY").
+ * @returns A promise that resolves to an object representing details about an item appearance slot.
+ */
+export async function itemAppearanceSlot(ctx, slotType) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/item-appearance/slot/${slotType}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of item appearances.
+ *
+ * @param searchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about an item appearance search.
+ */
+export async function searchItemAppearance(ctx, searchParameters) {
+    return await search(ctx, "/item-appearance", "static", searchParameters);
+}

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

@@ -0,0 +1,124 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, NamedRef, NameId, TypeName } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface JournalExpansions extends LinkSelfHref {
+    tiers: KeyNameId[];
+}
+export interface JournalExpansion extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    dungeons: KeyNameId[];
+    raids: KeyNameId[];
+    world_bosses: NamedRef[];
+}
+export interface JournalEncounters extends LinkSelfHref {
+    encounters: KeyNameId[];
+}
+export interface EncounterSection {
+    id: number;
+    title: string;
+    body_text?: string;
+    sections?: EncounterSection[];
+    spell?: KeyNameId;
+    creature_display?: KeyId;
+}
+export interface JournalEncounter extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description: LocalizedString;
+    creatures: {
+        id: number;
+        name: LocalizedString;
+        creature_display: KeyId;
+    }[];
+    items: {
+        id: number;
+        item: KeyNameId;
+    }[];
+    sections: EncounterSection[];
+    instance: KeyNameId;
+    category: {
+        type: string;
+    };
+    modes: TypeName[];
+}
+export interface JournalInstances extends LinkSelfHref {
+    instances: KeyNameId[];
+}
+export interface JournalInstance extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    map: NameId;
+    area?: NameId;
+    description: LocalizedString;
+    encounters: KeyNameId[];
+    expansion: KeyNameId;
+    location?: NameId;
+    modes: {
+        mode: TypeName;
+        players: number;
+        is_tracked: boolean;
+    }[];
+    media: KeyId;
+    minimum_level: number;
+    order_index: number;
+    category: {
+        type: string;
+    };
+}
+export interface JournalInstanceMedia extends LinkSelfHref {
+    assets: Asset[];
+}
+/**
+ * Returns an index of journal expansions.
+ *
+ * @returns A promise that resolves to an object representing a list of journal expansions.
+ */
+export declare function journalExpansions(ctx: ApiContext): Promise<JournalExpansions>;
+/**
+ * Returns a journal expansion by ID.
+ *
+ * @param journalExpansionId - The unique identifier for the journal expansion.
+ * @returns A promise that resolves to an object representing details about a journal expansion.
+ */
+export declare function journalExpansion(ctx: ApiContext, journalExpansionId: number): Promise<JournalExpansion>;
+/**
+ * Returns an index of journal encounters.
+ *
+ * @returns A promise that resolves to an object representing a list of journal expansions.
+ */
+export declare function journalEncounters(ctx: ApiContext): Promise<JournalEncounters>;
+/**
+ * Returns a journal encounter by ID.
+ *
+ * @param journalEncounterId - The unique identifier for the journal encounter.
+ * @returns A promise that resolves to an object representing details about a journal encounter.
+ */
+export declare function journalEncounter(ctx: ApiContext, journalEncounterId: number): Promise<JournalEncounter>;
+/**
+ * Performs a search of journal encounters.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a journal encounter search.
+ */
+export declare function searchJournalEncounter(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns an index of journal instances.
+ *
+ * @returns A promise that resolves to an object representing a list of journal instances.
+ */
+export declare function journalInstances(ctx: ApiContext): Promise<JournalInstances>;
+/**
+ * Returns a journal instances by ID.
+ *
+ * @param journalInstanceId - The unique identifier for the journal instances.
+ * @returns A promise that resolves to an object representing details about a journal instances.
+ */
+export declare function journalInstance(ctx: ApiContext, journalInstanceId: number): Promise<JournalInstance>;
+/**
+ * Returns media for a journal instance by ID.
+ *
+ * @param journalInstanceId - The unique identifier for the journal instance
+ * @returns A promise that resolves to an object representing media details about a journal instance.
+ */
+export declare function journalInstanceMedia(ctx: ApiContext, journalInstanceId: number): Promise<JournalInstanceMedia>;

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

@@ -0,0 +1,98 @@
+import { search } from "../search.js";
+/**
+ * Returns an index of journal expansions.
+ *
+ * @returns A promise that resolves to an object representing a list of journal expansions.
+ */
+export async function journalExpansions(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/journal-expansion/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a journal expansion by ID.
+ *
+ * @param journalExpansionId - The unique identifier for the journal expansion.
+ * @returns A promise that resolves to an object representing details about a journal expansion.
+ */
+export async function journalExpansion(ctx, journalExpansionId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/journal-expansion/${journalExpansionId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns an index of journal encounters.
+ *
+ * @returns A promise that resolves to an object representing a list of journal expansions.
+ */
+export async function journalEncounters(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/journal-encounter/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a journal encounter by ID.
+ *
+ * @param journalEncounterId - The unique identifier for the journal encounter.
+ * @returns A promise that resolves to an object representing details about a journal encounter.
+ */
+export async function journalEncounter(ctx, journalEncounterId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/journal-encounter/${journalEncounterId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Performs a search of journal encounters.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about a journal encounter search.
+ */
+export async function searchJournalEncounter(ctx, searchParameters) {
+    return await search(ctx, "/journal-encounter", "static", searchParameters);
+}
+/**
+ * Returns an index of journal instances.
+ *
+ * @returns A promise that resolves to an object representing a list of journal instances.
+ */
+export async function journalInstances(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/journal-instance/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a journal instances by ID.
+ *
+ * @param journalInstanceId - The unique identifier for the journal instances.
+ * @returns A promise that resolves to an object representing details about a journal instances.
+ */
+export async function journalInstance(ctx, journalInstanceId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/journal-instance/${journalInstanceId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a journal instance by ID.
+ *
+ * @param journalInstanceId - The unique identifier for the journal instance
+ * @returns A promise that resolves to an object representing media details about a journal instance.
+ */
+export async function journalInstanceMedia(ctx, journalInstanceId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/journal-instance/${journalInstanceId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,39 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, Href, KeyId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface KeystoneAffixes extends LinkSelfHref {
+    affixes: {
+        key: Href;
+        name: string | null;
+        id: number;
+    }[];
+}
+export interface KeystoneAffix extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    description: LocalizedString;
+    media: KeyId;
+}
+export interface KeystoneAffixMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Returns an index of mythic keystone affixes.
+ *
+ * @returns A promise that resolves to an object representing a list of the mythic keystone affixes.
+ */
+export declare function keystoneAffixes(ctx: ApiContext): Promise<KeystoneAffixes>;
+/**
+ * Returns a mythic keystone affix by ID.
+ *
+ * @param keystoneAffixId - The unique identifier for the mythic keystone affix
+ * @returns A promise that resolves to an object representing details about a mythic keystone affix by ID.
+ */
+export declare function keystoneAffix(ctx: ApiContext, keystoneAffixId: number): Promise<KeystoneAffix>;
+/**
+ * Returns media for a mythic keystone affix by ID.
+ *
+ * @param keystoneAffixId - The unique identifier for the mythic keystone affix
+ * @returns A promise that resolves to an object representing media details about a mythic keystone affix.
+ */
+export declare function keystoneAffixMedia(ctx: ApiContext, keystoneAffixId: number): Promise<KeystoneAffixMedia>;

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

@@ -0,0 +1,38 @@
+/**
+ * Returns an index of mythic keystone affixes.
+ *
+ * @returns A promise that resolves to an object representing a list of the mythic keystone affixes.
+ */
+export async function keystoneAffixes(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/keystone-affix/index",
+        namespace: "static",
+    });
+}
+/**
+ * Returns a mythic keystone affix by ID.
+ *
+ * @param keystoneAffixId - The unique identifier for the mythic keystone affix
+ * @returns A promise that resolves to an object representing details about a mythic keystone affix by ID.
+ */
+export async function keystoneAffix(ctx, keystoneAffixId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/keystone-affix/${keystoneAffixId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Returns media for a mythic keystone affix by ID.
+ *
+ * @param keystoneAffixId - The unique identifier for the mythic keystone affix
+ * @returns A promise that resolves to an object representing media details about a mythic keystone affix.
+ */
+export async function keystoneAffixMedia(ctx, keystoneAffixId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/keystone-affix/${keystoneAffixId}`,
+        namespace: "static",
+    });
+}

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

@@ -0,0 +1,9 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+/**
+ * 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.
+ */
+export declare function searchMedia(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;

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

@@ -0,0 +1,10 @@
+import { search } from "../search.js";
+/**
+ * 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.
+ */
+export async function searchMedia(ctx, searchParameters) {
+    return await search(ctx, "/media", "static", searchParameters);
+}

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

@@ -0,0 +1,65 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { Href, 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: {
+        key: Href;
+        name?: string;
+        id: number;
+    }[];
+}
+export interface ModifiedCraftingCategory extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+}
+export interface ModifiedCraftingSlotTypes extends LinkSelfHref {
+    slot_types: {
+        key: Href;
+        name?: string;
+        id: number;
+    }[];
+}
+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(ctx: ApiContext): 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(ctx: ApiContext): 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(ctx: ApiContext, 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(ctx: ApiContext): 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(ctx: ApiContext, slotTypeId: number): Promise<ModifiedCraftingSlotType>;

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

@@ -0,0 +1,62 @@
+/**
+ * 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(ctx) {
+    return await ctx.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(ctx) {
+    return await ctx.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(ctx, categoryId) {
+    return await ctx.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(ctx) {
+    return await ctx.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(ctx, slotTypeId) {
+    return await ctx.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,38 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.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(ctx: ApiContext): 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(ctx: ApiContext, mountId: number): Promise<Mount>;
+/**
+ * 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 declare function searchMount(ctx: ApiContext, searchParameters: SearchParameters): Promise<Search>;