@blizzard-api/classic-wow 1.1.6 → 2.0.0

package/dist/index.d.cts

@@ -1,1138 +0,0 @@
-import { BlizzardNamespaces, Resource, Locales, BaseSearchParameters, SearchResponse } from '@blizzard-api/core';
-
-/**
- *
- */
-interface Href {
-    href: string;
-}
-/**
- * Base interface for Blizzard API responses.
- */
-interface ResponseBase {
-    _links: {
-        self: Href;
-    };
-}
-/**
- * Base record interface containing key.href property that often appear in Blizzard API responses.
- */
-interface KeyBase {
-    key: Href;
-}
-/**
- * Base record interface containing name and id properties that often appear together in Blizzard API responses.
- */
-interface NameId {
-    id: number;
-    name: string;
-}
-/**
- * Base record containing both {@link KeyBase} and {@link NameId} interfaces.
- */
-interface NameIdKey extends KeyBase, NameId {
-}
-/**
- * A record containing the RGBA values of a color.
- */
-interface Color {
-    a: number;
-    b: number;
-    g: number;
-    r: number;
-}
-/**
- * The media asset associated with a character or entity in World of Warcraft.
- */
-interface MediaAsset$1 {
-    file_data_id: number;
-    key: string;
-    value: string;
-}
-/**
- * The playable gender names/descriptions in World of Warcraft.
- */
-interface GenderName {
-    female: string;
-    male: string;
-}
-/**
- * The playable factions in World of Warcraft.
- */
-declare const Factions: {
-    readonly ALLIANCE: "ALLIANCE";
-    readonly HORDE: "HORDE";
-};
-/**
- * The faction associated with a character or entity in World of Warcraft.
- */
-interface Faction {
-    name: Capitalize<Lowercase<keyof typeof Factions>>;
-    type: keyof typeof Factions;
-}
-/**
- * The standard structure to represent a World of Warcraft Realm.
- */
-interface Realm$1 extends NameIdKey {
-    slug: string;
-}
-
-interface AuctionHouseIndexResponse extends ResponseBase {
-    auctions: Array<NameIdKey>;
-}
-interface AuctionsResponse extends ResponseBase, NameId {
-    auctions: Array<Auction>;
-    connected_realm: {
-        href: string;
-    };
-}
-interface Auction {
-    bid: number;
-    buyout: number;
-    id: number;
-    item: {
-        id: number;
-        rand?: number;
-        seed?: number;
-    };
-    quantity: number;
-    time_left: 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
-}
-
-/**
- * Returns an index of auction houses for a connected realm.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param connectedRealmId The ID of the connected realm.
- * @returns The auction house index. See {@link AuctionHouseIndexResponse}.
- */
-declare function auctionHouseIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, connectedRealmId: number): Resource<AuctionHouseIndexResponse>;
-/**
- * Returns all active auctions for a specific auction house on 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.
- *
- * Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param connectedRealmId The ID of the connected realm.
- * @param auctionHouseId The ID of the auction house.
- * @returns The auction house data. See {@link AuctionsResponse}.
- */
-declare function auctions(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, connectedRealmId: number, auctionHouseId: number): Resource<AuctionsResponse>;
-
-type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
-/**
- * The category of a realm.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'Latin America' | 'Oceanic' | 'PS' | 'Russian' | 'Spanish' | 'United States' | '한국';
-/**
- * The timezone of a realm.
- */
-type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
-/**
- * The type of a realm, capitalized and shortended).
- */
-type RealmTypeCapitalized = 'NORMAL' | 'RP';
-/**
- * The type of a realm, not capitalized or shortened.
- */
-type RealmType = 'Normal' | 'Roleplaying';
-/**
- * The response for a realm index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface RealmIndexResponse extends ResponseBase {
-    realms: Array<Realm$1>;
-}
-/**
- * The response for a realm.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface RealmResponse extends ResponseBase, NameId {
-    category: RealmCategory;
-    connected_realm: {
-        href: string;
-    };
-    is_tournament: boolean;
-    locale: WithoutUnderscore<Locales>;
-    region: NameIdKey;
-    slug: string;
-    timezone: RealmTimezone;
-    type: {
-        name: RealmType;
-        type: RealmTypeCapitalized;
-    };
-}
-/**
- * The search parameters for realms.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface RealmSearchParameters extends BaseSearchParameters {
-    timezone?: RealmTimezone;
-}
-/**
- * The response for a realm search.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface RealmSearchResponseItem extends KeyBase {
-    data: {
-        category: Record<Locales, string | undefined>;
-        id: number;
-        is_tournament: boolean;
-        locale: WithoutUnderscore<Locales>;
-        name: Record<Locales, string | undefined>;
-        region: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-        slug: string;
-        timezone: RealmTimezone;
-        type: {
-            name: Record<Locales, string | undefined>;
-            type: RealmTypeCapitalized;
-        };
-    };
-}
-
-type RealmPopulation = 'Full' | 'High' | 'Low' | 'Medium' | 'New Players';
-type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
-type RealmStatus = 'Down' | 'Up';
-/**
- * Connected Realm Index API response.
- * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
- */
-interface ConnectedRealmIndexResponse extends ResponseBase {
-    connected_realms: Array<{
-        href: string;
-    }>;
-}
-interface Realm {
-    category: RealmCategory;
-    connected_realm: {
-        href: string;
-    };
-    id: number;
-    is_tournament: boolean;
-    locale: WithoutUnderscore<Locales>;
-    name: string;
-    region: NameIdKey;
-    slug: string;
-    timezone: RealmTimezone;
-    type: {
-        name: RealmType;
-        type: RealmTypeCapitalized;
-    };
-}
-interface RealmLockedStatus {
-    is_locked_for_new_characters: boolean;
-    is_locked_for_pct: boolean;
-}
-/**
- * Connected Realm API response.
- * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
- */
-interface ConnectedRealmResponse extends ResponseBase {
-    auctions: {
-        href: string;
-    };
-    has_queue: boolean;
-    id: number;
-    mythic_leaderboards: {
-        href: string;
-    };
-    population: {
-        name: RealmPopulation;
-        type: RealmPopulationCapitalized;
-    };
-    realm_locked_status?: RealmLockedStatus;
-    realms: Array<Realm>;
-    status: {
-        name: RealmStatus;
-        type: Uppercase<RealmStatus>;
-    };
-}
-/**
- * Connected Realm Search API parameters.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface ConnectedRealmSearchParameters extends BaseSearchParameters {
-    'realms.timezone'?: RealmTimezone;
-    'status.type'?: Uppercase<RealmStatus>;
-}
-interface SearchRealm {
-    category: Record<Locales, string | undefined>;
-    id: number;
-    is_tournament: boolean;
-    locale: WithoutUnderscore<Locales>;
-    name: Record<Locales, string | undefined>;
-    region: {
-        id: number;
-        name: Record<Locales, string | undefined>;
-    };
-    slug: string;
-    timezone: RealmTimezone;
-    type: {
-        name: Record<Locales, string | undefined>;
-        type: RealmTypeCapitalized;
-    };
-}
-interface SearchRealmStatus {
-    name: Record<Locales, string>;
-    type: Uppercase<RealmStatus>;
-}
-interface SearchRealmPopulation {
-    name: Record<Locales, string>;
-    type: RealmPopulationCapitalized;
-}
-/**
- * Connected Realm Search API response item.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface ConnectedRealmSearchResponseItem extends KeyBase {
-    data: {
-        has_queue: boolean;
-        id: number;
-        population: SearchRealmPopulation;
-        realms: Array<SearchRealm>;
-        status: SearchRealmStatus;
-    };
-}
-
-/**
- * Returns an index of connected realms.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
- */
-declare function connectedRealmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<ConnectedRealmIndexResponse>;
-/**
- * Returns a connected realm by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param connectedRealmId The connected realm ID.
- * @returns The connected realm. See {@link ConnectedRealmResponse}.
- */
-declare function connectedRealm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, connectedRealmId: number): Resource<ConnectedRealmResponse>;
-/**
- * Performs a search of connected realms.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
- * @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
- */
-declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, options: ConnectedRealmSearchParameters): Resource<SearchResponse<ConnectedRealmSearchResponseItem>, ConnectedRealmSearchParameters>;
-
-/**
- * The response for a creature.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureResponse extends ResponseBase {
-    creature_displays: Array<CreatureDisplay>;
-    family: NameIdKey;
-    id: number;
-    is_tameable: boolean;
-    name: string;
-    type: NameIdKey;
-}
-interface CreatureDisplay extends KeyBase {
-    id: number;
-}
-/**
- * The response for creature display media.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureDisplayMediaResponse extends ResponseBase {
-    assets: Array<DisplayMediaAsset>;
-    id: number;
-}
-interface DisplayMediaAsset {
-    key: string;
-    value: string;
-}
-/**
- * The response for a creature family index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureFamilyIndexResponse extends ResponseBase {
-    creature_families: Array<NameIdKey>;
-}
-/**
- * The response for a creature family.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureFamilyResponse extends ResponseBase {
-    id: number;
-    media: Media$3;
-    name: string;
-    specialization: NameIdKey;
-}
-interface Media$3 extends KeyBase {
-    id: number;
-}
-/**
- * The response for creature family media.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureFamilyMediaResponse extends ResponseBase {
-    assets: Array<MediaAsset$1>;
-    id: number;
-}
-/**
- * The response for a creature type index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureTypeIndexResponse extends ResponseBase {
-    creature_types: Array<NameIdKey>;
-}
-/**
- * The response for a creature type.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface CreatureTypeResponse extends ResponseBase {
-    id: number;
-    name: string;
-}
-/**
- * The search parameters for a creature.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface CreatureSearchParameters extends BaseSearchParameters {
-    locale: Locales;
-    name: string;
-}
-/**
- * The response for a creature search.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface CreatureSearchResponseItem extends KeyBase {
-    data: {
-        creature_displays: Array<{
-            id: number;
-        }>;
-        family?: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-        id: number;
-        is_tameable: boolean;
-        name: Record<Locales, string | undefined>;
-        type: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-    };
-}
-
-/**
- * Returns a creature by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param creatureId The creature ID.
- * @returns The creature. See {@link CreatureResponse}.
- */
-declare function creature(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureId: number): Resource<CreatureResponse>;
-/**
- * Returns media for a creature display by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param creatureDisplayId The creature display ID.
- * @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
- */
-declare function creatureDisplayMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureDisplayId: number): Resource<CreatureDisplayMediaResponse>;
-/**
- * Returns a creature family by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param creatureFamilyId The creature family ID.
- * @returns The creature family. See {@link CreatureFamilyResponse}.
- */
-declare function creatureFamily(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureFamilyId: number): Resource<CreatureFamilyResponse>;
-/**
- * Returns an index of creature families.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
- */
-declare function creatureFamilyIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<CreatureFamilyIndexResponse>;
-/**
- * Returns media for a creature family by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param creatureFamilyId The creature family ID.
- * @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
- */
-declare function creatureFamilyMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureFamilyId: number): Resource<CreatureFamilyMediaResponse>;
-/**
- * Returns a creature type by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param creatureTypeId The creature type ID.
- * @returns The creature type. See {@link CreatureTypeResponse}.
- */
-declare function creatureType(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureTypeId: number): Resource<CreatureTypeResponse>;
-/**
- * Returns an index of creature types.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
- */
-declare function creatureTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<CreatureTypeIndexResponse>;
-/**
- * Performs a search of creatures.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param options The creature search parameters. See {@link CreatureSearchParameters}.
- * @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
- */
-declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: CreatureSearchParameters): Resource<SearchResponse<CreatureSearchResponseItem>, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
-
-/**
- * The response for the guild crest components index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface GuildCrestComponentsIndexResponse extends ResponseBase {
-    borders: Array<Border>;
-    colors: Colors;
-    emblems: Array<Border>;
-}
-interface Border {
-    id: number;
-    media: Media$2;
-}
-interface Media$2 extends KeyBase {
-    id: number;
-}
-interface Colors {
-    backgrounds: Array<Background>;
-    borders: Array<Background>;
-    emblems: Array<Background>;
-}
-interface Background {
-    id: number;
-    rgba: RGBA;
-}
-interface RGBA {
-    a: number;
-    b: number;
-    g: number;
-    r: number;
-}
-/**
- * The response for a guild crest border or emblem.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface GuildCrestBorderEmblemResponse extends ResponseBase {
-    assets: Array<GuildCrestAsset>;
-    id: number;
-}
-interface GuildCrestAsset {
-    key: string;
-    value: string;
-}
-
-/**
- * Returns an index of guild crest media.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
- */
-declare function guildCrestComponentsIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<GuildCrestComponentsIndexResponse>;
-/**
- * Returns media for a guild crest border by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param borderId The guild crest border ID.
- * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
- */
-declare function guildCrestBorder(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, borderId: number): Resource<GuildCrestBorderEmblemResponse>;
-/**
- * Returns media for a guild crest emblem by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param emblemId The guild crest emblem ID.
- * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
- */
-declare function guildCrestEmblem(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
-
-interface ItemQuality {
-    name: Record<Locales, string | undefined>;
-    type: 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
-}
-interface InventoryType {
-    name: Record<Locales, string | undefined>;
-    type: 'BACK' | 'BAG' | 'CHEST' | 'FEET' | 'FINGER' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'NON_EQUIP' | 'SHIRT' | 'SHOULDER' | 'TABARD' | 'TRINKET' | 'TWOHWEAPON' | 'WAIST' | 'WRIST';
-}
-type StatTypeCapitalized = 'AGILITY' | 'CRIT_RATING' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
-type StatType = 'Agility' | 'Critical Strike' | 'Haste' | 'Intellect' | 'Mastery' | 'Stamina' | 'Strength' | 'Versatility';
-/**
- * The response for an item.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemResponse extends ResponseBase, NameId {
-    description?: string;
-    inventory_type: InventoryType;
-    is_equippable: boolean;
-    is_stackable: boolean;
-    item_class: NameIdKey;
-    item_subclass: NameIdKey;
-    level: number;
-    max_count: number;
-    media: Media$1;
-    preview_item: PreviewItem;
-    purchase_price: number;
-    purchase_quantity: number;
-    quality: ItemQuality;
-    required_level: number;
-    sell_price: number;
-}
-interface Media$1 extends KeyBase {
-    id: number;
-}
-interface PreviewItem {
-    armor?: Armor;
-    binding?: {
-        name: string;
-        type: string;
-    };
-    bonus_list?: Array<number>;
-    container_slots?: Durability;
-    context?: number;
-    crafting_reagent?: string;
-    description?: string;
-    durability?: Durability;
-    inventory_type: InventoryType;
-    is_subclass_hidden?: boolean;
-    item: Media$1;
-    item_class: NameIdKey;
-    item_subclass: NameIdKey;
-    level?: Durability;
-    media: Media$1;
-    name: string;
-    quality: ItemQuality;
-    recipe?: Recipe;
-    requirements?: Requirements;
-    sell_price?: number;
-    shield_block?: Armor;
-    spells?: Array<Spell>;
-    stats?: Array<Stat>;
-    unique_equipped?: 'Unique';
-    weapon?: Weapon;
-}
-interface Armor {
-    display: Display;
-    value: number;
-}
-interface Durability {
-    display_string: string;
-    value: number;
-}
-interface Requirements {
-    level: Durability;
-}
-interface Spell {
-    description: string;
-    spell: NameIdKey;
-}
-interface Stat {
-    display: Display;
-    is_negated?: boolean;
-    type: {
-        name: StatType;
-        type: StatTypeCapitalized;
-    };
-    value: number;
-}
-interface Display {
-    color: Color;
-    display_string: string;
-}
-interface Weapon {
-    attack_speed: Durability;
-    damage: Damage;
-    dps: Durability;
-}
-interface Damage {
-    damage_class: {
-        name: string;
-        type: string;
-    };
-    display_string: string;
-    max_value: number;
-    min_value: number;
-}
-interface Recipe {
-    item: RecipeItem;
-    reagents: Array<{
-        quantity: number;
-    } & NameIdKey>;
-    reagents_display_string: string;
-}
-interface RecipeItem {
-    armor?: Armor;
-    binding: {
-        name: string;
-        type: string;
-    };
-    durability: Durability;
-    inventory_type: InventoryType;
-    item: Media$1;
-    item_class: NameIdKey;
-    item_subclass: NameIdKey;
-    level: Durability;
-    media: Media$1;
-    name: string;
-    quality: ItemQuality;
-    requirements: Requirements;
-    sell_price: {
-        display_strings: RecipeItemDisplayStrings;
-        value: number;
-    };
-    stats: Array<Stat>;
-    weapon?: Weapon;
-}
-interface RecipeItemDisplayStrings {
-    copper: string;
-    gold: string;
-    header: string;
-    silver: string;
-}
-/**
- * The response for an item class index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemClassIndexResponse extends ResponseBase {
-    item_classes: Array<NameIdKey>;
-}
-/**
- * The response for an item class.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemClassResponse extends ResponseBase {
-    class_id: number;
-    item_subclasses: Array<NameIdKey>;
-    name: string;
-}
-/**
- * The response for an item media.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemMediaResponse extends ResponseBase {
-    assets: Array<MediaAsset$1>;
-    id: number;
-}
-/**
- * The response for an item subclass.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemSubClassResponse extends ResponseBase {
-    class_id: number;
-    display_name: string;
-    hide_subclass_in_tooltips: boolean;
-    subclass_id: number;
-    verbose_name: string;
-}
-/**
- * The parameters for an item search.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface ItemSearchParameters extends BaseSearchParameters {
-    locale: Locales;
-    name: string;
-}
-/**
- * The response for an item search.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface ItemSearchResponseItem extends KeyBase {
-    data: {
-        id: number;
-        inventory_type: InventoryType;
-        is_equippable: boolean;
-        is_stackable: boolean;
-        item_class: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-        item_subclass: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-        level: number;
-        max_count: number;
-        media: {
-            id: number;
-        };
-        name: Record<Locales, string | undefined>;
-        purchase_price: number;
-        purchase_quantity: number;
-        quality: ItemQuality;
-        required_level: number;
-        sell_price: number;
-    };
-}
-
-/**
- * Get an item class index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The item class index. See {@link ItemClassIndexResponse}.
- */
-declare function itemClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<ItemClassIndexResponse>;
-/**
- * Get an item class by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param itemClassId The item class ID.
- * @returns The item class. See {@link ItemClassResponse}.
- */
-declare function itemClass(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemClassId: number): Resource<ItemClassResponse>;
-/**
- * Get an item subclass by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param itemClassId The item class ID.
- * @param itemSubclassId The item subclass ID.
- * @returns The item subclass. See {@link ItemSubClassResponse}.
- */
-declare function itemSubClass(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
-/**
- * Get an item by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param itemId The item ID.
- * @returns The item. See {@link ItemResponse}.
- */
-declare function item(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemId: number): Resource<ItemResponse>;
-/**
- * Get item media by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param itemId The item ID.
- * @returns The item media. See {@link ItemMediaResponse}.
- */
-declare function itemMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemId: number): Resource<ItemMediaResponse>;
-/**
- * Search for items.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param options The search parameters. See {@link ItemSearchParameters}.
- * @returns The search results. See {@link SearchResponse}.
- */
-declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, 'locale' | 'name'>>;
-
-/**
- * The search parameters for media.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface MediaSearchParameters extends BaseSearchParameters {
-    tags?: string;
-}
-/**
- * The response for a media search.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
- */
-interface MediaSearchResponseItem extends KeyBase {
-    data: {
-        assets: Array<MediaAsset>;
-        id: number;
-    };
-}
-interface MediaAsset {
-    file_data_id: number;
-    key: string;
-    value: string;
-}
-
-/**
- * Search for media.
- * @param options The search parameters. See {@link MediaSearchParameters}.
- * @returns The search results. See {@link SearchResponse}.
- */
-declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: MediaSearchParameters): Resource<SearchResponse<MediaSearchResponseItem>, MediaSearchParameters>;
-
-/**
- * The response for a playable class index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PlayableClassIndexResponse extends ResponseBase {
-    classes: Array<NameIdKey>;
-}
-/**
- * The response for playable class media.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PlayableClassMediaResponse extends ResponseBase {
-    assets: Array<MediaAsset$1>;
-    id: number;
-}
-
-/**
- * The response for a playable class.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft-classic/game-data-apis}
- */
-interface PlayableClassResponse extends ResponseBase, NameId {
-    gender_name: GenderName;
-    media: Media;
-    playable_races: Array<NameIdKey>;
-    power_type: NameIdKey;
-    pvp_talent_slots: {
-        href: string;
-    };
-}
-interface Media extends KeyBase {
-    id: number;
-}
-
-/**
- * Get a playable class by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param playableClassId The playable class ID.
- * @returns The playable class. See {@link PlayableClassResponse}.
- */
-declare function playableClass(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, playableClassId: number): Resource<PlayableClassResponse>;
-/**
- * Get a playable class index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The playable class index. See {@link PlayableClassIndexResponse}.
- */
-declare function playableClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<PlayableClassIndexResponse>;
-/**
- * Get playable class media by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param playableClassId The playable class ID.
- * @returns The playable class media. See {@link PlayableClassMediaResponse}.
- */
-declare function playableClassMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, playableClassId: number): Resource<PlayableClassMediaResponse>;
-
-/**
- * The playable race index response.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PlayableRaceIndexResponse extends ResponseBase {
-    races: Array<NameIdKey>;
-}
-/**
- * The playable race response.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PlayableRaceResponse extends ResponseBase, NameId {
-    faction: Faction;
-    gender_name: GenderName;
-    is_allied_race: boolean;
-    is_selectable: boolean;
-    playable_classes: Array<NameIdKey>;
-}
-
-/**
- * Get a playable race by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param playableRaceId The playable race ID.
- * @returns The playable race. See {@link PlayableRaceResponse}.
- */
-declare function playableRace(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, playableRaceId: number): Resource<PlayableRaceResponse>;
-/**
- * Get a playable race index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
- */
-declare function playableRaceIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<PlayableRaceIndexResponse>;
-
-/**
- * The response for a power type index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PowerTypeIndexResponse extends ResponseBase {
-    power_types: Array<NameIdKey>;
-}
-/**
- * The response for a power type.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PowerTypeResponse extends ResponseBase, NameId {
-}
-
-/**
- * Get a power type by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param powerTypeId The power type ID.
- * @returns The power type. See {@link PowerTypeResponse}.
- */
-declare function powerType(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, powerTypeId: number): Resource<PowerTypeResponse>;
-/**
- * Get a power type index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The power type index. See {@link PowerTypeIndexResponse}.
- */
-declare function powerTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<PowerTypeIndexResponse>;
-
-/**
- * The response for a PvP season index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PvpSeasonIndexResponse extends ResponseBase {
-    current_season: Season;
-    seasons: Array<Season>;
-}
-interface Season extends KeyBase {
-    id: number;
-}
-/**
- * The response for a PvP season.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface PvpSeasonResponse extends ResponseBase {
-    id: number;
-    leaderboards: {
-        href: string;
-    };
-    rewards: {
-        href: string;
-    };
-    season_name?: string;
-    season_start_timestamp: number;
-}
-
-/**
- * Get a PvP season index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
- */
-declare function pvpSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<PvpSeasonIndexResponse>;
-/**
- * Get a PvP season by ID.
- * @param pvpSeasonId The PvP season ID.
- * @returns The PvP season. See {@link PvpSeasonResponse}.
- */
-declare function pvpSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpSeasonId: number): Resource<PvpSeasonResponse>;
-/**
- * Returns an index of PvP Regions.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- */
-declare function pvpRegionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<unknown>;
-/**
- * Returns an index of PvP Seasons in a PvP region.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param pvpRegionId The PvP region ID.
- * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
- */
-declare function pvpRegionalSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number): Resource<PvpSeasonIndexResponse>;
-/**
- * Returns a PvP season by region ID and season ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param pvpRegionId The PvP region ID.
- * @param pvpSeasonId The PvP season ID.
- */
-declare function pvpRegionalSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
-/**
- * Returns an index of PvP leaderboards for a PvP season in a given PvP region.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param pvpRegionId The PvP region ID.
- * @param pvpSeasonId The PvP season ID.
- */
-declare function pvpLeaderboardIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
-/**
- * Get a PvP leaderboard by PvP season ID and bracket.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param pvpRegionId The PvP region ID.
- * @param pvpSeasonId The PvP season ID.
- * @param pvpBracket The PvP bracket.
- */
-declare function pvpLeaderboard(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number, pvpBracket: string): Resource<unknown>;
-/**
- * Returns an index of PvP rewards for a PvP season in a given PvP region.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param pvpRegionId The PvP region ID.
- * @param pvpSeasonId The PvP season ID.
- */
-declare function pvpRewardsIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
-
-/**
- * Get a realm by slug.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param realmSlug The realm slug.
- * @returns The realm. See {@link RealmResponse}.
- */
-declare function realm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, realmSlug: string): Resource<RealmResponse>;
-/**
- * Get a realm index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The realm index. See {@link RealmIndexResponse}.
- */
-declare function realmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<RealmIndexResponse>;
-/**
- * Search for realms.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param options The search parameters. See {@link RealmSearchParameters}.
- * @returns The search results. See {@link SearchResponse}.
- */
-declare function realmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, options: RealmSearchParameters): Resource<SearchResponse<RealmSearchResponseItem>, RealmSearchParameters>;
-
-/**
- * The response for a region index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface RegionIndexResponse extends ResponseBase {
-    regions: Array<{
-        href: string;
-    }>;
-}
-/**
- * The response for a region.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface RegionResponse extends ResponseBase, NameId {
-    patch_string: string;
-    tag: string;
-}
-
-/**
- * Get a region by ID.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @param regionId The region ID.
- * @returns The region. See {@link RegionResponse}.
- */
-declare function region(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, regionId: number): Resource<RegionResponse>;
-/**
- * Get a region index.
- * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
- * @returns The region index. See {@link RegionIndexResponse}.
- */
-declare function regionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<RegionIndexResponse>;
-
-declare const classicWow: {
-    auctionHouseIndex: typeof auctionHouseIndex;
-    auctions: typeof auctions;
-    connectedRealm: typeof connectedRealm;
-    connectedRealmIndex: typeof connectedRealmIndex;
-    connectedRealmSearch: typeof connectedRealmSearch;
-    creature: typeof creature;
-    creatureDisplayMedia: typeof creatureDisplayMedia;
-    creatureFamily: typeof creatureFamily;
-    creatureFamilyIndex: typeof creatureFamilyIndex;
-    creatureFamilyMedia: typeof creatureFamilyMedia;
-    creatureSearch: typeof creatureSearch;
-    creatureType: typeof creatureType;
-    creatureTypeIndex: typeof creatureTypeIndex;
-    guildCrestBorder: typeof guildCrestBorder;
-    guildCrestComponentsIndex: typeof guildCrestComponentsIndex;
-    guildCrestEmblem: typeof guildCrestEmblem;
-    item: typeof item;
-    itemClass: typeof itemClass;
-    itemClassIndex: typeof itemClassIndex;
-    itemMedia: typeof itemMedia;
-    itemSearch: typeof itemSearch;
-    itemSubClass: typeof itemSubClass;
-    mediaSearch: typeof mediaSearch;
-    playableClass: typeof playableClass;
-    playableClassIndex: typeof playableClassIndex;
-    playableClassMedia: typeof playableClassMedia;
-    playableRace: typeof playableRace;
-    playableRaceIndex: typeof playableRaceIndex;
-    powerType: typeof powerType;
-    powerTypeIndex: typeof powerTypeIndex;
-    pvpLeaderboard: typeof pvpLeaderboard;
-    pvpLeaderboardIndex: typeof pvpLeaderboardIndex;
-    pvpRegionalSeason: typeof pvpRegionalSeason;
-    pvpRegionalSeasonIndex: typeof pvpRegionalSeasonIndex;
-    pvpRegionIndex: typeof pvpRegionIndex;
-    pvpRewardsIndex: typeof pvpRewardsIndex;
-    pvpSeason: typeof pvpSeason;
-    pvpSeasonIndex: typeof pvpSeasonIndex;
-    realm: typeof realm;
-    realmIndex: typeof realmIndex;
-    realmSearch: typeof realmSearch;
-    region: typeof region;
-    regionIndex: typeof regionIndex;
-};
-
-export { type AuctionHouseIndexResponse, type AuctionsResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSubClassResponse, type MediaSearchParameters, type MediaSearchResponseItem, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RegionIndexResponse, type RegionResponse, type WithoutUnderscore, auctionHouseIndex, auctions, classicWow, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, classicWow as default, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSubClass, mediaSearch, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, powerType, powerTypeIndex, pvpLeaderboard, pvpLeaderboardIndex, pvpRegionIndex, pvpRegionalSeason, pvpRegionalSeasonIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, realm, realmIndex, realmSearch, region, regionIndex };