@pinta365/blizzard_api 0.3.7 → 0.4.0

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

@@ -1,79 +0,0 @@
-import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
-export interface Heirlooms extends LinkSelfHref {
-    heirlooms: KeyNameId[];
-}
-export interface ValueDisplayString {
-    value: number;
-    display_string: LocalizedString;
-}
-export interface UpgradeStats {
-    type: TypeName;
-    value: number;
-    display: {
-        display_string: LocalizedString;
-        color: {
-            r: number;
-            g: number;
-            b: number;
-            a: number;
-        };
-    };
-}
-export interface Upgrade {
-    item: {
-        item: KeyId;
-        context: number;
-        bonus_list: number[];
-        quality: TypeName;
-        name: LocalizedString;
-        media: KeyId;
-        item_class: KeyNameId;
-        item_subclass: KeyNameId;
-        inventory_type: TypeName;
-        binding: TypeName;
-        weapon: {
-            damage: {
-                min_value: number;
-                max_value: number;
-                display_string: LocalizedString;
-                damage_class: TypeName;
-            };
-            attack_speed: ValueDisplayString;
-            dps: ValueDisplayString;
-        };
-        stats: UpgradeStats[];
-        upgrades: {
-            value: number;
-            max_value: number;
-            display_string: LocalizedString;
-        };
-        requirements: {
-            level: {
-                display_string: LocalizedString;
-            };
-        };
-        level: ValueDisplayString;
-    };
-    level: number;
-}
-export interface Heirloom extends LinkSelfHref {
-    id: number;
-    item: KeyNameId;
-    source: TypeName;
-    source_description: LocalizedString;
-    upgrades: Upgrade[];
-    media: KeyId;
-}
-/**
- * Returns the Heirloom Index
- *
- * @returns A promise that resolves to an object representing a list of all Heirlooms.
- */
-export declare function heirlooms(): Promise<Heirlooms>;
-/**
- * Returns a Heirloom
- *
- * @param heirloomId - The unique identifier for the Heirloom
- * @returns A promise that resolves to an object representing details about a Heirloom.
- */
-export declare function heirloom(heirloomId: number): Promise<Heirloom>;

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

@@ -1,26 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * Returns the Heirloom Index
- *
- * @returns A promise that resolves to an object representing a list of all Heirlooms.
- */
-export async function heirlooms() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/heirloom/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a Heirloom
- *
- * @param heirloomId - The unique identifier for the Heirloom
- * @returns A promise that resolves to an object representing details about a Heirloom.
- */
-export async function heirloom(heirloomId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/heirloom/${heirloomId}`,
-        namespace: "static",
-    });
-}

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

@@ -1,166 +0,0 @@
-import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface ItemClasses extends LinkSelfHref {
-    item_classes: KeyNameId[];
-}
-export interface ItemClass extends LinkSelfHref {
-    class_id: number;
-    name: LocalizedString;
-    item_subclasses: KeyNameId[];
-}
-export interface ItemSets extends LinkSelfHref {
-    item_sets: KeyNameId[];
-}
-export interface ItemSet extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    items: KeyNameId[];
-    effects: {
-        display_string: LocalizedString;
-        required_count: number;
-    };
-    is_effect_active: boolean;
-}
-export interface ItemSubclass extends LinkSelfHref {
-    class_id: number;
-    subclass_id: number;
-    display_name: LocalizedString;
-    hide_subclass_in_tooltips?: boolean;
-}
-export interface Item extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    quality: TypeName;
-    level: number;
-    required_level: number;
-    media: KeyId;
-    item_class: KeyNameId;
-    item_subclass: KeyNameId;
-    inventory_type: TypeName;
-    purchase_price: number;
-    sell_price: number;
-    max_count: number;
-    is_equippable: boolean;
-    is_stackable: boolean;
-    preview_item: {
-        item: KeyId;
-        context: number;
-        bonus_list: number[];
-        quality: TypeName;
-        name: LocalizedString;
-        media: KeyId;
-        item_class: KeyNameId;
-        item_subclass: KeyNameId;
-        inventory_type: TypeName;
-        binding: TypeName;
-        unique_equipped: string;
-        weapon: {
-            damage: {
-                min_value: number;
-                max_value: number;
-                display_string: LocalizedString;
-                damage_class: TypeName;
-            };
-            attack_speed: {
-                value: number;
-                display_string: LocalizedString;
-            };
-            dps: {
-                value: number;
-                display_string: LocalizedString;
-            };
-        };
-        stats: {
-            type: TypeName;
-            value: number;
-            is_negated: boolean;
-            display: {
-                display_string: LocalizedString;
-                color: {
-                    r: number;
-                    g: number;
-                    b: number;
-                    a: number;
-                };
-            };
-        }[];
-        spells: {
-            spell: KeyNameId;
-            description: LocalizedString;
-        }[];
-        requirements: {
-            level: {
-                value: number;
-                display_string: LocalizedString;
-            };
-        };
-        level: {
-            value: number;
-            display_string: LocalizedString;
-        };
-        durability: {
-            value: number;
-            display_string: LocalizedString;
-        };
-    };
-    purchase_quantity: number;
-}
-export interface ItemMedia extends LinkSelfHref {
-    assets: Asset[];
-    id: number;
-}
-/**
- * Returns an index of item classes.
- *
- * @returns A promise that resolves to an object representing a list of item classes.
- */
-export declare function itemClasses(): Promise<ItemClasses>;
-/**
- * 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.
- */
-export declare function itemClass(itemClassId: number): Promise<ItemClass>;
-/**
- * Returns an index of item sets.
- *
- * @returns A promise that resolves to an object representing a list of item sets.
- */
-export declare function itemSets(): Promise<ItemSets>;
-/**
- * Returns an item set by ID.
- *
- * @param itemSetId - The unique identifier for the item set by ID.
- * @returns A promise that resolves to an object representing details about an item set by ID.
- */
-export declare function itemSet(itemSetId: number): Promise<ItemSet>;
-/**
- * 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.
- */
-export declare function itemSubclass(itemClassId: number, itemSubclassId: number): Promise<ItemSubclass>;
-/**
- * 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.
- */
-export declare function item(itemId: number): Promise<Item>;
-/**
- * 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.
- */
-export declare function itemMedia(itemId: number): Promise<ItemMedia>;
-/**
- * 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.
- */
-export declare function searchItem(searchParameters: SearchParameters): Promise<Search>;

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

@@ -1,101 +0,0 @@
-import { request } from "../../shared/index.js";
-import { search } from "../search.js";
-/**
- * Returns an index of item classes.
- *
- * @returns A promise that resolves to an object representing a list of item classes.
- */
-export async function itemClasses() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/item-class/index",
-        namespace: "static",
-    });
-}
-/**
- * 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.
- */
-export async function itemClass(itemClassId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/item-class/${itemClassId}`,
-        namespace: "static",
-    });
-}
-/**
- * Returns an index of item sets.
- *
- * @returns A promise that resolves to an object representing a list of item sets.
- */
-export async function itemSets() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/item-set/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns an item set by ID.
- *
- * @param itemSetId - The unique identifier for the item set by ID.
- * @returns A promise that resolves to an object representing details about an item set by ID.
- */
-export async function itemSet(itemSetId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/item-set/${itemSetId}`,
-        namespace: "static",
-    });
-}
-/**
- * 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.
- */
-export async function itemSubclass(itemClassId, itemSubclassId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/item-class/${itemClassId}/item-subclass/${itemSubclassId}`,
-        namespace: "static",
-    });
-}
-/**
- * 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.
- */
-export async function item(itemId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/item/${itemId}`,
-        namespace: "static",
-    });
-}
-/**
- * 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.
- */
-export async function itemMedia(itemId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/media/item/${itemId}`,
-        namespace: "static",
-    });
-}
-/**
- * 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.
- */
-export async function searchItem(searchParameters) {
-    return await search("/item", "static", searchParameters);
-}

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

@@ -1,121 +0,0 @@
-import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, 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[];
-}
-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: 5;
-        is_tracked: true;
-    }[];
-    media: KeyId;
-    minimum_level: 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(): 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(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(): 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(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(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(): 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(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(journalInstanceId: number): Promise<JournalInstanceMedia>;

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

@@ -1,99 +0,0 @@
-import { request } from "../../shared/index.js";
-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() {
-    return await 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(journalExpansionId) {
-    return await 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() {
-    return await 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(journalEncounterId) {
-    return await 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(searchParameters) {
-    return await search("/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() {
-    return await 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(journalInstanceId) {
-    return await 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(journalInstanceId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/media/journal-instance/${journalInstanceId}`,
-        namespace: "static",
-    });
-}

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

@@ -1,34 +0,0 @@
-import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-export interface KeystoneAffixes extends LinkSelfHref {
-    affixes: KeyNameId[];
-}
-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(): 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(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(keystoneAffixId: number): Promise<KeystoneAffixMedia>;

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

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

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

@@ -1,8 +0,0 @@
-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(searchParameters: SearchParameters): Promise<Search>;

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

@@ -1,10 +0,0 @@
-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(searchParameters) {
-    return await search("/media", "static", searchParameters);
-}