@pinta365/blizzard_api 0.3.7 → 0.4.0

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

@@ -1,114 +0,0 @@
-import type { KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
-export interface Quests extends LinkSelfHref {
-    categories: {
-        href: string;
-    };
-    areas: {
-        href: string;
-    };
-    types: {
-        href: string;
-    };
-}
-export interface Quest extends LinkSelfHref {
-    id: number;
-    title: LocalizedString;
-    area: KeyNameId;
-    description: LocalizedString;
-    requirements: {
-        min_character_level: number;
-        max_character_level: number;
-        faction: TypeName;
-    };
-    rewards: {
-        experience: number;
-        reputations: {
-            reward: KeyNameId;
-            value: number;
-        }[];
-        money: {
-            value: number;
-            units: {
-                gold: number;
-                silver: number;
-                copper: number;
-            };
-        };
-    };
-}
-export interface QuestCategories extends LinkSelfHref {
-    categories: KeyNameId[];
-}
-export interface QuestCategory extends LinkSelfHref {
-    id: number;
-    category: LocalizedString;
-    quests: KeyNameId[];
-}
-export interface QuestAreas extends LinkSelfHref {
-    areas: KeyNameId[];
-}
-export interface QuestArea extends LinkSelfHref {
-    id: number;
-    area: LocalizedString;
-    quests: KeyNameId[];
-}
-export interface QuestTypes extends LinkSelfHref {
-    types: KeyNameId[];
-}
-export interface QuestType extends LinkSelfHref {
-    id: number;
-    type: LocalizedString;
-    quests: KeyNameId[];
-}
-/**
- * Returns the parent index for quests.
- *
- * @returns A promise that resolves to an object representing a list of quests.
- */
-export declare function quests(): Promise<Quests>;
-/**
- * Returns a quest by ID.
- *
- * @param questId - The unique identifier for the quest.
- * @returns A promise that resolves to an object representing details about a quest.
- */
-export declare function quest(questId: number): Promise<Quest>;
-/**
- * Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
- *
- * @returns A promise that resolves to an object representing a list of quest categories.
- */
-export declare function questCategories(): Promise<QuestCategories>;
-/**
- * Returns a quest category by ID.
- *
- * @param questCategoryId - The unique identifier for the quest category.
- * @returns A promise that resolves to an object representing details about a quest category.
- */
-export declare function questCategory(questCategoryId: number): Promise<QuestCategory>;
-/**
- * Returns an index of quest areas.
- *
- * @returns A promise that resolves to an object representing a list of quest areas.
- */
-export declare function questAreas(): Promise<QuestAreas>;
-/**
- * Returns a quest area by ID.
- *
- * @param questAreaId - The unique identifier for the quest area.
- * @returns A promise that resolves to an object representing details about a quest area.
- */
-export declare function questArea(questAreaId: number): Promise<QuestArea>;
-/**
- * Returns an index of quest types (such as PvP quests, raid quests, or account quests).
- *
- * @returns A promise that resolves to an object representing a list of quest types.
- */
-export declare function questTypes(): Promise<QuestTypes>;
-/**
- * Returns a quest type by ID.
- *
- * @param questTypeId - The unique identifier for the quest type.
- * @returns A promise that resolves to an object representing details about a quest type.
- */
-export declare function questType(questTypeId: number): Promise<QuestType>;

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

@@ -1,101 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * Returns the parent index for quests.
- *
- * @returns A promise that resolves to an object representing a list of quests.
- */
-export async function quests() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/quest/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a quest by ID.
- *
- * @param questId - The unique identifier for the quest.
- * @returns A promise that resolves to an object representing details about a quest.
- */
-export async function quest(questId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/quest/${questId}`,
-        namespace: "static",
-    });
-}
-/**
- * Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
- *
- * @returns A promise that resolves to an object representing a list of quest categories.
- */
-export async function questCategories() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/quest/category/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a quest category by ID.
- *
- * @param questCategoryId - The unique identifier for the quest category.
- * @returns A promise that resolves to an object representing details about a quest category.
- */
-export async function questCategory(questCategoryId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/quest/category/${questCategoryId}`,
-        namespace: "static",
-    });
-}
-/**
- * Returns an index of quest areas.
- *
- * @returns A promise that resolves to an object representing a list of quest areas.
- */
-export async function questAreas() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/quest/area/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a quest area by ID.
- *
- * @param questAreaId - The unique identifier for the quest area.
- * @returns A promise that resolves to an object representing details about a quest area.
- */
-export async function questArea(questAreaId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/quest/area/${questAreaId}`,
-        namespace: "static",
-    });
-}
-/**
- * Returns an index of quest types (such as PvP quests, raid quests, or account quests).
- *
- * @returns A promise that resolves to an object representing a list of quest types.
- */
-export async function questTypes() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/quest/type/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a quest type by ID.
- *
- * @param questTypeId - The unique identifier for the quest type.
- * @returns A promise that resolves to an object representing details about a quest type.
- */
-export async function questType(questTypeId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/quest/type/${questTypeId}`,
-        namespace: "static",
-    });
-}

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

@@ -1,42 +0,0 @@
-import type { KeyName, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface RealmList extends KeyNameId {
-    slug: string;
-}
-export interface Realms extends LinkSelfHref {
-    realms: RealmList[];
-}
-export interface Realm extends LinkSelfHref {
-    id: number;
-    region: KeyName;
-    connected_realm: {
-        href: string;
-    };
-    name: LocalizedString;
-    category: LocalizedString;
-    locale: string;
-    timezone: string;
-    type: TypeName;
-    is_tournament: boolean;
-    slug: string;
-}
-/**
- * Returns an index of realms.
- *
- * @returns A promise that resolves to an object representing a list of realms.
- */
-export declare function realms(): Promise<Realms>;
-/**
- * Returns a single realm by slug or ID.
- *
- * @param realmSlug - The unique identifier for the realm.
- * @returns A promise that resolves to an object representing details about a realm.
- */
-export declare function realm(realmSlug: string): Promise<Realm>;
-/**
- * Performs a search of realms.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a realm search.
- */
-export declare function searchRealm(searchParameters: SearchParameters): Promise<Search>;

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

@@ -1,36 +0,0 @@
-import { request } from "../../shared/index.js";
-import { search } from "../search.js";
-/**
- * Returns an index of realms.
- *
- * @returns A promise that resolves to an object representing a list of realms.
- */
-export async function realms() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/realm/index",
-        namespace: "dynamic",
-    });
-}
-/**
- * Returns a single realm by slug or ID.
- *
- * @param realmSlug - The unique identifier for the realm.
- * @returns A promise that resolves to an object representing details about a realm.
- */
-export async function realm(realmSlug) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/realm/${realmSlug}`,
-        namespace: "dynamic",
-    });
-}
-/**
- * Performs a search of realms.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a realm search.
- */
-export async function searchRealm(searchParameters) {
-    return await search("/realm", "dynamic", searchParameters);
-}

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

@@ -1,24 +0,0 @@
-import type { LinkSelfHref, LocalizedString } from "../../shared/index.js";
-export interface Regions extends LinkSelfHref {
-    regions: {
-        href: string;
-    }[];
-}
-export interface Region extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    tag: string;
-}
-/**
- * Returns an index of regions.
- *
- * @returns A promise that resolves to an object representing a list of regions.
- */
-export declare function regions(): Promise<Regions>;
-/**
- * Returns a region by ID.
- *
- * @param regionId - The unique identifier for the region.
- * @returns A promise that resolves to an object representing details about a region.
- */
-export declare function region(regionId: number): Promise<Region>;

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

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

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

@@ -1,50 +0,0 @@
-import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-export interface ReputationFactions extends LinkSelfHref {
-    factions: KeyNameId[];
-    root_factions: KeyNameId[];
-}
-export interface ReputationFaction extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    description: LocalizedString;
-    reputation_tiers: KeyId;
-}
-export interface ReputationTiers extends LinkSelfHref {
-    reputation_tiers: KeyNameId[];
-}
-export interface ReputationTier extends LinkSelfHref {
-    id: number;
-    tiers: {
-        name: LocalizedString;
-        min_value: number;
-        max_value: number;
-        id: number;
-    }[];
-    faction: KeyNameId;
-}
-/**
- * Returns an index of reputation factions.
- *
- * @returns A promise that resolves to an object representing a list of reputation factions.
- */
-export declare function reputationFactions(): Promise<ReputationFactions>;
-/**
- * Returns a single reputation faction by ID.
- *
- * @param reputationFactionId - The unique identifier for the reputation faction.
- * @returns A promise that resolves to an object representing details about a reputation faction.
- */
-export declare function reputationFaction(reputationFactionId: string): Promise<ReputationFaction>;
-/**
- * Returns an index of reputation tiers.
- *
- * @returns A promise that resolves to an object representing a list of reputation tiers.
- */
-export declare function reputationTiers(): Promise<ReputationTiers>;
-/**
- * Returns a single set of reputation tiers by ID.
- *
- * @param reputationTiersId - The unique identifier for the reputation tier.
- * @returns A promise that resolves to an object representing details about a reputation tier.
- */
-export declare function reputationTier(reputationTiersId: string): Promise<ReputationTier>;

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

@@ -1,51 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * Returns an index of reputation factions.
- *
- * @returns A promise that resolves to an object representing a list of reputation factions.
- */
-export async function reputationFactions() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/reputation-faction/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a single reputation faction by ID.
- *
- * @param reputationFactionId - The unique identifier for the reputation faction.
- * @returns A promise that resolves to an object representing details about a reputation faction.
- */
-export async function reputationFaction(reputationFactionId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/reputation-faction/${reputationFactionId}`,
-        namespace: "static",
-    });
-}
-/**
- * Returns an index of reputation tiers.
- *
- * @returns A promise that resolves to an object representing a list of reputation tiers.
- */
-export async function reputationTiers() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/reputation-tiers/index",
-        namespace: "static",
-    });
-}
-/**
- * Returns a single set of reputation tiers by ID.
- *
- * @param reputationTiersId - The unique identifier for the reputation tier.
- * @returns A promise that resolves to an object representing details about a reputation tier.
- */
-export async function reputationTier(reputationTiersId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/reputation-tiers/${reputationTiersId}`,
-        namespace: "static",
-    });
-}

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

@@ -1,33 +0,0 @@
-import type { Asset, KeyId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface Spell extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    description: LocalizedString;
-    media: KeyId;
-}
-export interface SpellMedia extends LinkSelfHref {
-    assets: Asset[];
-    id: number;
-}
-/**
- * Returns a spell by ID.
- *
- * @param spellId - The unique identifier for the spell.
- * @returns A promise that resolves to an object representing details about a spell.
- */
-export declare function spell(spellId: number): Promise<Spell>;
-/**
- * Returns media for a spell by ID.
- *
- * @param spellId - The unique identifier for the spell.
- * @returns A promise that resolves to an object representing details about a spell.
- */
-export declare function spellMedia(spellId: number): Promise<SpellMedia>;
-/**
- * Performs a search of spells.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a spell search.
- */
-export declare function searchSpell(searchParameters: SearchParameters): Promise<Search>;

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

@@ -1,37 +0,0 @@
-import { request } from "../../shared/index.js";
-import { search } from "../search.js";
-/**
- * Returns a spell by ID.
- *
- * @param spellId - The unique identifier for the spell.
- * @returns A promise that resolves to an object representing details about a spell.
- */
-export async function spell(spellId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/spell/${spellId}`,
-        namespace: "static",
-    });
-}
-/**
- * Returns media for a spell by ID.
- *
- * @param spellId - The unique identifier for the spell.
- * @returns A promise that resolves to an object representing details about a spell.
- */
-export async function spellMedia(spellId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/media/spell/${spellId}`,
-        namespace: "static",
-    });
-}
-/**
- * Performs a search of spells.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a spell search.
- */
-export async function searchSpell(searchParameters) {
-    return await search("/spell", "static", searchParameters);
-}

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

@@ -1,129 +0,0 @@
-import type { KeyName, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-export interface TalentTrees extends LinkSelfHref {
-    spec_talent_trees: KeyNameId;
-    class_talent_trees: KeyName;
-}
-export interface SpellTooltip {
-    spell: KeyNameId;
-    description: string;
-    cast_time: string;
-    power_cost?: string;
-    range?: string;
-}
-export interface Tooltip {
-    talent: KeyNameId;
-    spell_tooltip: SpellTooltip;
-}
-export interface Rank {
-    rank: number;
-    tooltip?: Tooltip;
-    choice_of_tooltips?: Tooltip[];
-}
-export interface NodeType {
-    id: number;
-    type: string;
-}
-export interface TalentNode {
-    id: number;
-    locked_by?: number[];
-    unlocks?: number[];
-    node_type: NodeType;
-    ranks: Rank[];
-    display_row: number;
-    display_col: number;
-    raw_position_x: number;
-    raw_position_y: number;
-}
-export interface TalentTree extends LinkSelfHref {
-    id: number;
-    playable_class: KeyNameId;
-    playable_specialization: KeyNameId;
-    name: LocalizedString;
-    media: {
-        key: {
-            href: string;
-        };
-    };
-    restriction_lines: {
-        required_points: number;
-        restricted_row: number;
-        is_for_class: boolean;
-    }[];
-    class_talent_nodes: TalentNode[];
-}
-export interface TalentTreeNodes extends LinkSelfHref {
-    id: number;
-    spec_talent_trees?: KeyName[];
-    talent_nodes?: TalentNode[];
-}
-export interface Talents extends LinkSelfHref {
-    talents: KeyNameId[];
-}
-export interface Talent extends LinkSelfHref {
-    id: number;
-    rank_descriptions: {
-        rank: number;
-        description: LocalizedString;
-    }[];
-    spell: KeyNameId;
-    playable_class: KeyNameId;
-    playable_specialization: KeyNameId;
-}
-export interface PvpTalents extends LinkSelfHref {
-    pvp_talents: KeyNameId[];
-}
-export interface PvpTalent extends LinkSelfHref {
-    id: number;
-    spell: KeyNameId;
-    playable_specialization: KeyNameId;
-    description: LocalizedString;
-    unlock_player_level: number;
-    compatible_slots: number[];
-}
-/**
- * Returns an index of talent trees.
- *
- * @returns A promise that resolves to an object representing a list of talent trees.
- */
-export declare function talentTrees(): Promise<TalentTrees>;
-/**
- * Returns a talent tree by specialization ID.
- *
- * @param talentTreeId - The unique identifier for the talent tree.
- * @param specId - The unique identifier for the specialization.
- * @returns A promise that resolves to an object representing details about a talent tree.
- */
-export declare function talentTree(talentTreeId: number, specId: number): Promise<TalentTree>;
-/**
- * Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.
- *
- * @param talentTreeId - The unique identifier for the talent tree.
- * @returns A promise that resolves to an object representing details about the talent tree nodes.
- */
-export declare function talentTreeNodes(talentTreeId: number): Promise<TalentTreeNodes>;
-/**
- * Returns an index of talents.
- *
- * @returns A promise that resolves to an object representing a list of talents.
- */
-export declare function talents(): Promise<Talents>;
-/**
- * Returns a talent by ID.
- *
- * @param talentId - The unique identifier for the talent.
- * @returns A promise that resolves to an object representing details about the talent.
- */
-export declare function talent(talentId: number): Promise<Talent>;
-/**
- * Returns an index of PvP talents.
- *
- * @returns A promise that resolves to an object representing a list of PvP talents.
- */
-export declare function pvpTalents(): Promise<PvpTalents>;
-/**
- * Returns a PvP talent by ID.
- *
- * @param pvpTalentId - The unique identifier for the PvP talent.
- * @returns A promise that resolves to an object representing details about the PvP talent.
- */
-export declare function pvpTalent(pvpTalentId: number): Promise<PvpTalent>;