@pinta365/blizzard_api 0.3.7 → 0.4.0

package/script/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/script/src/wow/game_data/journal.js

@@ -1,110 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.journalInstanceMedia = exports.journalInstance = exports.journalInstances = exports.searchJournalEncounter = exports.journalEncounter = exports.journalEncounters = exports.journalExpansion = exports.journalExpansions = void 0;
-const index_js_1 = require("../../shared/index.js");
-const search_js_1 = require("../search.js");
-/**
- * Returns an index of journal expansions.
- *
- * @returns A promise that resolves to an object representing a list of journal expansions.
- */
-async function journalExpansions() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/journal-expansion/index",
-        namespace: "static",
-    });
-}
-exports.journalExpansions = 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.
- */
-async function journalExpansion(journalExpansionId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/journal-expansion/${journalExpansionId}`,
-        namespace: "static",
-    });
-}
-exports.journalExpansion = journalExpansion;
-/**
- * Returns an index of journal encounters.
- *
- * @returns A promise that resolves to an object representing a list of journal expansions.
- */
-async function journalEncounters() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/journal-encounter/index",
-        namespace: "static",
-    });
-}
-exports.journalEncounters = 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.
- */
-async function journalEncounter(journalEncounterId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/journal-encounter/${journalEncounterId}`,
-        namespace: "static",
-    });
-}
-exports.journalEncounter = 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.
- */
-async function searchJournalEncounter(searchParameters) {
-    return await (0, search_js_1.search)("/journal-encounter", "static", searchParameters);
-}
-exports.searchJournalEncounter = searchJournalEncounter;
-/**
- * Returns an index of journal instances.
- *
- * @returns A promise that resolves to an object representing a list of journal instances.
- */
-async function journalInstances() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/journal-instance/index",
-        namespace: "static",
-    });
-}
-exports.journalInstances = 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.
- */
-async function journalInstance(journalInstanceId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/journal-instance/${journalInstanceId}`,
-        namespace: "static",
-    });
-}
-exports.journalInstance = 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.
- */
-async function journalInstanceMedia(journalInstanceId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/media/journal-instance/${journalInstanceId}`,
-        namespace: "static",
-    });
-}
-exports.journalInstanceMedia = journalInstanceMedia;

package/script/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/script/src/wow/game_data/keystone_affix.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.keystoneAffixMedia = exports.keystoneAffix = exports.keystoneAffixes = void 0;
-const index_js_1 = require("../../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.
- */
-async function keystoneAffixes() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/keystone-affix/index",
-        namespace: "static",
-    });
-}
-exports.keystoneAffixes = 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.
- */
-async function keystoneAffix(keystoneAffixId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/keystone-affix/${keystoneAffixId}`,
-        namespace: "static",
-    });
-}
-exports.keystoneAffix = 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.
- */
-async function keystoneAffixMedia(keystoneAffixId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/media/keystone-affix/${keystoneAffixId}`,
-        namespace: "static",
-    });
-}
-exports.keystoneAffixMedia = keystoneAffixMedia;

package/script/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/script/src/wow/game_data/media_search.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.searchMedia = void 0;
-const search_js_1 = require("../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.
- */
-async function searchMedia(searchParameters) {
-    return await (0, search_js_1.search)("/media", "static", searchParameters);
-}
-exports.searchMedia = searchMedia;

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

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

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

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.modifiedCraftingSlotType = exports.modifiedCraftingSlotTypes = exports.modifiedCraftingCategory = exports.modifiedCraftingCategories = exports.modifiedCraftingParents = void 0;
-const index_js_1 = require("../../shared/index.js");
-/**
- * Returns the parent index for Modified Crafting.
- *
- * @returns A promise that resolves to an object representing a list of the parent index for Modified Crafting.
- */
-async function modifiedCraftingParents() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/modified-crafting/index",
-        namespace: "static",
-    });
-}
-exports.modifiedCraftingParents = 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.
- */
-async function modifiedCraftingCategories() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/modified-crafting/category/index",
-        namespace: "static",
-    });
-}
-exports.modifiedCraftingCategories = 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.
- */
-async function modifiedCraftingCategory(categoryId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/modified-crafting/category/${categoryId}`,
-        namespace: "static",
-    });
-}
-exports.modifiedCraftingCategory = 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
- */
-async function modifiedCraftingSlotTypes() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/modified-crafting/reagent-slot-type/index",
-        namespace: "static",
-    });
-}
-exports.modifiedCraftingSlotTypes = 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.
- */
-async function modifiedCraftingSlotType(slotTypeId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/modified-crafting/reagent-slot-type/${slotTypeId}`,
-        namespace: "static",
-    });
-}
-exports.modifiedCraftingSlotType = modifiedCraftingSlotType;

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

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

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

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.searchMount = exports.mount = exports.mounts = void 0;
-const index_js_1 = require("../../shared/index.js");
-/**
- * Returns a index of mounts.
- *
- * @returns A promise that resolves to an object representing a list of the index of mounts.
- */
-async function mounts() {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: "/data/wow/mount/index",
-        namespace: "static",
-    });
-}
-exports.mounts = 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.
- */
-async function mount(mountId) {
-    return await (0, index_js_1.request)({
-        method: "GET",
-        url: `/data/wow/mount/${mountId}`,
-        namespace: "static",
-    });
-}
-exports.mount = mount;
-function searchMount() {
-    //TODO: Placeholder for the mount Search, will probably be using ./search.ts
-    throw new Error("Not implemented yet!");
-}
-exports.searchMount = searchMount;

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

@@ -1,91 +0,0 @@
-import type { KeyId, KeyNameId, LinkSelfHref, LocalizedString, NameId } from "../../shared/index.js";
-export interface MythicKeystoneDungeons extends LinkSelfHref {
-    dungeons: KeyNameId[];
-}
-export interface MythicKeystoneDungeon extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    map: NameId;
-    zone: {
-        slug: string;
-    };
-    dungeon: KeyNameId;
-    keystone_updates: {
-        upgrade_level: number;
-        qualifying_duration: number;
-    }[];
-    is_traacked: boolean;
-}
-export interface MythicKeystoneIndex extends LinkSelfHref {
-    seasons: {
-        href: string;
-    };
-    dungeons: {
-        href: string;
-    };
-}
-export interface MythicKeystonePeriods extends LinkSelfHref {
-    periods: KeyId[];
-    current_period: KeyId;
-}
-export interface MythicKeystonePeriod extends LinkSelfHref {
-    id: number;
-    start_timestamp: number;
-    end_timestamp: number;
-}
-export interface MythicKeystoneSeason extends LinkSelfHref {
-    id: number;
-    start_timestamp: number;
-    end_timestamp?: number;
-    periods: KeyId[];
-    season_name: LocalizedString;
-}
-/**
- * Returns an index of Mythic Keystone dungeons.
- *
- * @returns A promise that resolves to an object representing a list of the Mythic Keystone dungeons.
- */
-export declare function mythicKeystoneDungeons(): Promise<MythicKeystoneDungeons>;
-/**
- * Returns a Mythic Keystone dungeon by ID.
- *
- * @param dungeonId - The unique identifier for the Mythic Keystone dungeon
- * @returns A promise that resolves to an object representing details about a Mythic Keystone dungeon by ID.
- */
-export declare function mythicKeystoneDungeon(dungeonId: number): Promise<MythicKeystoneDungeon>;
-/**
- * Returns an index of links to other documents related to Mythic Keystone dungeons.
- *
- * @returns A promise that resolves to an object representing a index of links to other documents related to Mythic Keystone dungeons.
- */
-export declare function mythicKeystoneIndex(): Promise<MythicKeystoneIndex>;
-/**
- * Returns an index of Mythic Keystone periods.
- *
- * @returns A promise that resolves to an object representing a index of Mythic Keystone periods.
- */
-export declare function mythicKeystonePeriods(): Promise<MythicKeystonePeriods>;
-/**
- * Returns a Mythic Keystone period by ID.
- *
- * @param periodId - The unique identifier for the Mythic Keystone period
- * @returns A promise that resolves to an object representing details about a Mythic Keystone period by ID.
- */
-export declare function mythicKeystonePeriod(periodId: number): Promise<MythicKeystonePeriod>;
-export interface MythicKeystoneSeasons extends LinkSelfHref {
-    "seasons": KeyId[];
-    "current_season": KeyId;
-}
-/**
- * Returns an index of Mythic Keystone seasons.
- *
- * @returns A promise that resolves to an object representing a index of Mythic Keystone seasons
- */
-export declare function mythicKeystoneSeasons(): Promise<MythicKeystoneSeasons>;
-/**
- * Returns a Mythic Keystone season by ID.
- *
- * @param seasonId - The unique identifier for the Mythic Keystone season
- * @returns A promise that resolves to an object representing details about a Mythic Keystone season by ID.
- */
-export declare function mythicKeystoneSeason(seasonId: number): Promise<MythicKeystoneSeason>;