@pinta365/blizzard_api 0.3.7 → 0.4.0

package/script/src/wow/game_data/achievement.js

@@ -1,77 +0,0 @@
-"use strict";
-/**
- * This module provides interfaces and API function definitions for fetching World of Warcraft achievement data using the Blizzard API.
- *
- * @author Pinta <https://github.com/Pinta365>
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.achievementMedia = exports.achievement = exports.achievements = exports.achievementCategory = exports.achievementCategories = void 0;
-const index_js_1 = require("../../shared/index.js");
-/**
- * Fetches and returns an index of achievement categories.
- *
- * @returns A promise that resolves to an object representing the index of achievement categories.
- */
-async function achievementCategories() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/achievement-category/index",
-        namespace: "static",
-    });
-}
-exports.achievementCategories = achievementCategories;
-/**
- * Fetches and returns details of a specific achievement category identified by its ID.
- *
- * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
- * @returns A promise that resolves to an object representing the achievement category details.
- */
-async function achievementCategory(achievementCategoryId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/achievement-category/${achievementCategoryId}`,
-        namespace: "static",
-    });
-}
-exports.achievementCategory = achievementCategory;
-/**
- * Fetches and returns an index of achievements.
- *
- * @returns A promise that resolves to an object representing the index of achievements.
- */
-async function achievements() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/achievement/index",
-        namespace: "static",
-    });
-}
-exports.achievements = achievements;
-/**
- * Fetches and returns details of a specific achievement identified by its ID.
- *
- * @param achievementId - The unique identifier of the achievement to retrieve.
- * @returns A promise that resolves to an object representing the achievement details.
- */
-async function achievement(achievementId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/achievement/${achievementId}`,
-        namespace: "static",
-    });
-}
-exports.achievement = achievement;
-/**
- * Fetches and returns media details for a specific achievement identified by its ID.
- *
- * @param achievementId - The unique identifier of the achievement to retrieve media details for.
- * @returns A promise that resolves to an object representing the achievement media details.
- */
-async function achievementMedia(achievementId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/media/achievement/${achievementId}`,
-        namespace: "static",
-    });
-}
-exports.achievementMedia = achievementMedia;

package/script/src/wow/game_data/auction_house.d.ts

@@ -1,64 +0,0 @@
-import type { LinkSelfHref } from "../../shared/index.js";
-export interface AuctionItem {
-    id: number;
-    modifiers?: {
-        type: number;
-        value: number;
-    }[];
-    pet_breed_id?: number;
-    pet_level?: number;
-    pet_quality_id?: number;
-    pet_species_id?: number;
-    bonus_lists?: number[];
-    context?: number;
-}
-export interface AuctionListing {
-    id: number;
-    item: AuctionItem;
-    bid?: number;
-    buyout?: number;
-    quantity: number;
-    time_left: "SHORT" | "MEDIUM" | "LONG" | "VERY_LONG";
-}
-export interface Auctions extends LinkSelfHref {
-    connected_realm: {
-        href: string;
-    };
-    auctions: AuctionListing[];
-    commodities: {
-        href: string;
-    };
-}
-export interface commodity {
-    "id": number;
-    "item": {
-        "id": number;
-    };
-    "quantity": number;
-    "unit_price": number;
-    "time_left": "SHORT" | "MEDIUM" | "LONG" | "VERY_LONG";
-}
-export interface Commodities extends LinkSelfHref {
-    auctions: commodity[];
-}
-/**
- * Returns all active auctions for a connected realm.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
- *
- * @param connectedRealmId - The id of the connected realm to return auctions from.
- * @returns A promise that resolves to an object representing the auctions being listed.
- */
-export declare function auctions(connectedRealmId: number): Promise<Auctions>;
-/**
- * Returns all active auctions for commodity items for the entire game region.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
- *
- * @returns A promise that resolves to an object representing the commodities being listed.
- */
-export declare function commodities(): Promise<Commodities>;

package/script/src/wow/game_data/auction_house.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.commodities = exports.auctions = void 0;
-const index_js_1 = require("../../shared/index.js");
-/**
- * Returns all active auctions for a connected realm.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
- *
- * @param connectedRealmId - The id of the connected realm to return auctions from.
- * @returns A promise that resolves to an object representing the auctions being listed.
- */
-async function auctions(connectedRealmId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/connected-realm/${connectedRealmId}/auctions`,
-        namespace: "dynamic",
-    });
-}
-exports.auctions = auctions;
-/**
- * Returns all active auctions for commodity items for the entire game region.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
- *
- * @returns A promise that resolves to an object representing the commodities being listed.
- */
-async function commodities() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/auctions/commodities",
-        namespace: "dynamic",
-    });
-}
-exports.commodities = commodities;

package/script/src/wow/game_data/azerite_essence.d.ts

@@ -1,49 +0,0 @@
-import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface AzeriteEssences extends LinkSelfHref {
-    azerite_essences: KeyNameId[];
-}
-export interface AzeritePower {
-    id: number;
-    rank: number;
-    main_power_spell: KeyNameId;
-    passive_power_spell: KeyNameId;
-}
-export interface AzeriteEssenceDetails extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    allowed_specializations: KeyNameId[];
-    powers: AzeritePower[];
-    media: KeyId;
-}
-export interface AzeritEessenceMedia extends LinkSelfHref {
-    assets: Asset[];
-    id: number;
-}
-/**
- * Returns Azerite Essences Index
- *
- * @returns A promise that resolves to an object representing a list of all Azerite Essences.
- */
-export declare function azeriteEssences(): Promise<AzeriteEssences>;
-/**
- * Returns details about a specific Azerite Essence Id
- *
- * @param azeriteEssenceId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing details about an Azerite Essences.
- */
-export declare function azeriteEssence(azeriteEssenceId: number): Promise<AzeriteEssenceDetails>;
-/**
- * Performs a search of azerite essences.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a Azerite Essences search.
- */
-export declare function searchAzeriteEssence(searchParameters: SearchParameters): Promise<Search>;
-/**
- * Returns media details about a specific Azerite Essence Id
- *
- * @param azeriteEssenceId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing media details about an Azerite Essences.
- */
-export declare function azeriteEssenceMedia(azeriteEssenceId: number): Promise<AzeritEessenceMedia>;

package/script/src/wow/game_data/azerite_essence.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.azeriteEssenceMedia = exports.searchAzeriteEssence = exports.azeriteEssence = exports.azeriteEssences = void 0;
-const index_js_1 = require("../../shared/index.js");
-const search_js_1 = require("../search.js");
-/**
- * Returns Azerite Essences Index
- *
- * @returns A promise that resolves to an object representing a list of all Azerite Essences.
- */
-async function azeriteEssences() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/azerite-essence/index",
-        namespace: "static",
-    });
-}
-exports.azeriteEssences = azeriteEssences;
-/**
- * Returns details about a specific Azerite Essence Id
- *
- * @param azeriteEssenceId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing details about an Azerite Essences.
- */
-async function azeriteEssence(azeriteEssenceId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/azerite-essence/${azeriteEssenceId}`,
-        namespace: "static",
-    });
-}
-exports.azeriteEssence = azeriteEssence;
-/**
- * Performs a search of azerite essences.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a Azerite Essences search.
- */
-async function searchAzeriteEssence(searchParameters) {
-    return await (0, search_js_1.search)("/azerite-essence", "static", searchParameters);
-}
-exports.searchAzeriteEssence = searchAzeriteEssence;
-/**
- * Returns media details about a specific Azerite Essence Id
- *
- * @param azeriteEssenceId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing media details about an Azerite Essences.
- */
-async function azeriteEssenceMedia(azeriteEssenceId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/media/azerite-essence/${azeriteEssenceId}`,
-        namespace: "static",
-    });
-}
-exports.azeriteEssenceMedia = azeriteEssenceMedia;

package/script/src/wow/game_data/connected_realm.d.ts

@@ -1,54 +0,0 @@
-import type { KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface ConnectedRealms extends LinkSelfHref {
-    connected_realms: {
-        href: string;
-    }[];
-}
-export interface Realm {
-    id: number;
-    region: KeyNameId;
-    connected_realm: {
-        href: string;
-    };
-    name: LocalizedString;
-    category: LocalizedString;
-    locale: string;
-    timezone: string;
-    type: TypeName;
-    is_tournament: boolean;
-    slug: string;
-}
-export interface ConnectedRealm extends LinkSelfHref {
-    id: number;
-    has_queue: boolean;
-    status: TypeName;
-    population: TypeName;
-    realms: Realm[];
-    mythic_leaderboards: {
-        href: string;
-    };
-    auctions: {
-        href: string;
-    };
-}
-/**
- * Returns the Connected Realms Index
- *
- * @returns A promise that resolves to an object representing a list of all Connected Realms.
- */
-export declare function connectedRealms(): Promise<ConnectedRealms>;
-/**
- * Returns details about a Connected Realms Id
- *
- * @param connectedRealmId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing details about an Azerite Essences.
- */
-export declare function connectedRealm(connectedRealmId: number): Promise<ConnectedRealm>;
-/**
- * Performs a search of connected realms.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about the connected realms search.
- */
-export declare function searchConnectedRealm(searchParameters: SearchParameters): Promise<Search>;

package/script/src/wow/game_data/connected_realm.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.searchConnectedRealm = exports.connectedRealm = exports.connectedRealms = void 0;
-const index_js_1 = require("../../shared/index.js");
-const search_js_1 = require("../search.js");
-/**
- * Returns the Connected Realms Index
- *
- * @returns A promise that resolves to an object representing a list of all Connected Realms.
- */
-async function connectedRealms() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/connected-realm/index",
-        namespace: "dynamic",
-    });
-}
-exports.connectedRealms = connectedRealms;
-/**
- * Returns details about a Connected Realms Id
- *
- * @param connectedRealmId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing details about an Azerite Essences.
- */
-async function connectedRealm(connectedRealmId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/connected-realm/${connectedRealmId}`,
-        namespace: "dynamic",
-    });
-}
-exports.connectedRealm = connectedRealm;
-/**
- * Performs a search of connected realms.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about the connected realms search.
- */
-async function searchConnectedRealm(searchParameters) {
-    return await (0, search_js_1.search)("/connected-realm", "dynamic", searchParameters);
-}
-exports.searchConnectedRealm = searchConnectedRealm;

package/script/src/wow/game_data/covenant.d.ts

@@ -1,108 +0,0 @@
-import type { Asset, KeyNameId, LinkSelfHref, LocalizedString, NameId, TypeName } from "../../shared/index.js";
-export interface Covenants extends LinkSelfHref {
-    covenants: KeyNameId[];
-}
-export interface SpellTooltip {
-    spell: KeyNameId;
-    description: LocalizedString;
-    cast_time: string;
-    power_cost: number | null;
-    range: string;
-    cooldown: string;
-}
-export interface SignatureAbility {
-    id: number;
-    spell_tooltip: SpellTooltip;
-}
-export interface ClassAbility {
-    id: number;
-    playable_class: KeyNameId;
-    spell_tooltip: SpellTooltip;
-}
-export interface Covenant extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    description: LocalizedString;
-    signature_ability: SignatureAbility;
-    class_abilities: ClassAbility[];
-}
-export interface CovenantMedia extends LinkSelfHref {
-    assets: Asset[];
-}
-export interface CovenantSoulbinds extends LinkSelfHref {
-    soulbinds: KeyNameId;
-}
-export interface CovenantSoulbind extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    covenant: KeyNameId;
-    creature: KeyNameId;
-    follower: NameId;
-    talent_tree: KeyNameId;
-}
-export interface CovenantConduits extends LinkSelfHref {
-    conduits: KeyNameId;
-}
-export interface SpellTooltip {
-    spell: KeyNameId;
-    description: LocalizedString;
-    cast_time: string;
-}
-export interface Rank {
-    id: number;
-    tier: number;
-    spell_tooltip: SpellTooltip;
-}
-export interface CovenantConduit extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    item: KeyNameId;
-    socket_type: TypeName;
-    ranks: Rank[];
-}
-/**
- * Returns an index of Covenants.
- *
- * @returns A promise that resolves to an object representing a list of all Covenants.
- */
-export declare function covenants(): Promise<Covenants>;
-/**
- * Returns details about a Covenant
- *
- * @param covenantId - The unique identifier for the Covenant
- * @returns A promise that resolves to an object representing details about a Covenant.
- */
-export declare function covenant(covenantId: number): Promise<Covenant>;
-/**
- * Returns media details about a Covenant
- *
- * @param covenantId - The unique identifier for the Covenant.
- * @returns A promise that resolves to an object representing media details about a Covenant.
- */
-export declare function azeriteEssenceMedia(covenantId: number): Promise<CovenantMedia>;
-/**
- * Returns an index of Covenant Soulbinds.
- *
- * @returns A promise that resolves to an object representing a list of all Covenant Soulbinds.
- */
-export declare function covenantSoulbinds(): Promise<CovenantSoulbinds>;
-/**
- * Returns details about a Covenant Soulbind
- *
- * @param soulbindId - The unique identifier for the Covenant Soulbind
- * @returns A promise that resolves to an object representing details about a Covenant Soulbind.
- */
-export declare function covenantSoulbind(soulbindId: number): Promise<CovenantSoulbind>;
-/**
- * Returns an index of Covenant Conduits.
- *
- * @returns A promise that resolves to an object representing a list of all Covenant Conduits.
- */
-export declare function covenantConduits(): Promise<CovenantConduits>;
-/**
- * Returns details about a Covenant Conduit
- *
- * @param conduitId - The unique identifier for the Covenant Conduit
- * @returns A promise that resolves to an object representing details about a Covenant Conduit.
- */
-export declare function covenantConduit(conduitId: number): Promise<CovenantConduit>;

package/script/src/wow/game_data/covenant.js

@@ -1,99 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.covenantConduit = exports.covenantConduits = exports.covenantSoulbind = exports.covenantSoulbinds = exports.azeriteEssenceMedia = exports.covenant = exports.covenants = void 0;
-const index_js_1 = require("../../shared/index.js");
-/**
- * Returns an index of Covenants.
- *
- * @returns A promise that resolves to an object representing a list of all Covenants.
- */
-async function covenants() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/covenant/index",
-        namespace: "static",
-    });
-}
-exports.covenants = covenants;
-/**
- * Returns details about a Covenant
- *
- * @param covenantId - The unique identifier for the Covenant
- * @returns A promise that resolves to an object representing details about a Covenant.
- */
-async function covenant(covenantId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/covenant/${covenantId}`,
-        namespace: "static",
-    });
-}
-exports.covenant = covenant;
-/**
- * Returns media details about a Covenant
- *
- * @param covenantId - The unique identifier for the Covenant.
- * @returns A promise that resolves to an object representing media details about a Covenant.
- */
-async function azeriteEssenceMedia(covenantId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/media/covenant/${covenantId}`,
-        namespace: "static",
-    });
-}
-exports.azeriteEssenceMedia = azeriteEssenceMedia;
-/**
- * Returns an index of Covenant Soulbinds.
- *
- * @returns A promise that resolves to an object representing a list of all Covenant Soulbinds.
- */
-async function covenantSoulbinds() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/covenant/soulbind/index",
-        namespace: "static",
-    });
-}
-exports.covenantSoulbinds = covenantSoulbinds;
-/**
- * Returns details about a Covenant Soulbind
- *
- * @param soulbindId - The unique identifier for the Covenant Soulbind
- * @returns A promise that resolves to an object representing details about a Covenant Soulbind.
- */
-async function covenantSoulbind(soulbindId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/covenant/soulbind/${soulbindId}`,
-        namespace: "static",
-    });
-}
-exports.covenantSoulbind = covenantSoulbind;
-/**
- * Returns an index of Covenant Conduits.
- *
- * @returns A promise that resolves to an object representing a list of all Covenant Conduits.
- */
-async function covenantConduits() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/covenant/conduit/index",
-        namespace: "static",
-    });
-}
-exports.covenantConduits = covenantConduits;
-/**
- * Returns details about a Covenant Conduit
- *
- * @param conduitId - The unique identifier for the Covenant Conduit
- * @returns A promise that resolves to an object representing details about a Covenant Conduit.
- */
-async function covenantConduit(conduitId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/covenant/conduit/${conduitId}`,
-        namespace: "static",
-    });
-}
-exports.covenantConduit = covenantConduit;

package/script/src/wow/game_data/creature.d.ts

@@ -1,97 +0,0 @@
-import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface CreatureFamilies extends LinkSelfHref {
-    creature_families: KeyNameId[];
-}
-export interface CreatureFamily extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    specialization: KeyNameId;
-    media: KeyId;
-}
-export interface CreatureTypes extends LinkSelfHref {
-    creature_types: KeyNameId[];
-}
-export interface CreatureType extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-}
-export interface Creature extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    type: KeyNameId;
-    family: KeyNameId;
-    creature_displays: KeyId[];
-    is_tameable: boolean;
-}
-export interface CreatureDisplayAssets {
-    key: string;
-    value: string;
-}
-export interface CreatureDisplayMedia extends LinkSelfHref {
-    assets: CreatureDisplayAssets[];
-    id: number;
-}
-export interface CreatureFamilyAssets {
-    key: string;
-    value: string;
-    file_data_id: number;
-}
-export interface CreatureFamilyMedia extends LinkSelfHref {
-    assets: CreatureFamilyAssets[];
-    id: number;
-}
-/**
- * Returns an index of creature families.
- *
- * @returns A promise that resolves to an object representing a list of all creature families.
- */
-export declare function creatureFamilies(): Promise<CreatureFamilies>;
-/**
- * Returns details about a creature family
- *
- * @param creatureFamilyId - The unique identifier for the creature family
- * @returns A promise that resolves to an object representing details about a creature family.
- */
-export declare function creatureFamily(creatureFamilyId: number): Promise<CreatureFamily>;
-/**
- * Returns an index of creature types.
- *
- * @returns A promise that resolves to an object representing a list of all creature types.
- */
-export declare function creatureTypes(): Promise<CreatureTypes>;
-/**
- * Returns details about a creature types
- *
- * @param creatureTypeId - The unique identifier for the creature types
- * @returns A promise that resolves to an object representing details about a creature types.
- */
-export declare function creatureType(creatureTypeId: number): Promise<CreatureType>;
-/**
- * Returns details about a creature
- *
- * @param creatureId - The unique identifier for the creature
- * @returns A promise that resolves to an object representing details about a creature.
- */
-export declare function creature(creatureId: number): Promise<Creature>;
-/**
- * Performs a search of creatures.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a creature search.
- */
-export declare function searchCreature(searchParameters: SearchParameters): Promise<Search>;
-/**
- * Returns media details about a specific Creature display
- *
- * @param creatureDisplayId - The unique identifier Creature display Id.
- * @returns A promise that resolves to an object representing media details about a Creature display.
- */
-export declare function creatureDisplayMedia(creatureDisplayId: number): Promise<CreatureDisplayMedia>;
-/**
- * Returns media details about a specific Creature family
- *
- * @param creatureFamilyId - The unique identifier Creature family Id.
- * @returns A promise that resolves to an object representing media details about a Creature family.
- */
-export declare function creatureFamilyMedia(creatureFamilyId: number): Promise<CreatureFamilyMedia>;