@blizzard-api/wow 3.0.6 → 4.0.0

package/dist/index-CQXTvcKu2.d.ts

@@ -0,0 +1,72 @@
+import { Factions, Href, KeyBase, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/mythic-keystone-leaderboard/types.d.ts
+/**
+ * The response for a Mythic Keystone leaderboard index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneLeaderboardIndexResponse extends ResponseBase {
+  current_leaderboards: Array<NameIdKey>;
+}
+/**
+ * The response for a Mythic Keystone leaderboard.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneLeaderboardResponse extends ResponseBase {
+  connected_realm: Href;
+  keystone_affixes: Array<KeystoneAffixElement>;
+  leading_groups: Array<LeadingGroup>;
+  map: NameId;
+  map_challenge_mode_id: number;
+  name: string;
+  period: number;
+  period_end_timestamp: number;
+  period_start_timestamp: number;
+}
+interface KeystoneAffixElement {
+  keystone_affix: NameIdKey;
+  starting_level: number;
+}
+interface LeadingGroup {
+  completed_timestamp: number;
+  duration: number;
+  keystone_level: number;
+  members: Array<Member>;
+  ranking: number;
+}
+interface Member {
+  faction: {
+    type: Factions;
+  };
+  profile: Profile;
+  specialization: Specialization;
+}
+interface Profile extends NameId {
+  realm: Realm$1;
+}
+interface Realm$1 extends KeyBase {
+  id: number;
+  slug: string;
+}
+interface Specialization extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/mythic-keystone-leaderboard/index.d.ts
+/**
+ * Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
+ * @param connectedRealmId The connected realm ID.
+ * @param dungeonId The dungeon ID.
+ * @param period The period ID.
+ * @returns The Mythic Keystone leaderboard. See {@link MythicKeystoneLeaderboardResponse}.
+ */
+declare function mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId: number, period: number): Resource<MythicKeystoneLeaderboardResponse>;
+/**
+ * Get a Mythic Keystone leaderboard index by connected realm ID.
+ * @param connectedRealmId The connected realm ID.
+ * @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
+ */
+declare function mythicKeystoneLeaderboardIndex(connectedRealmId: number): Resource<MythicKeystoneLeaderboardIndexResponse>;
+//#endregion
+export { MythicKeystoneLeaderboardResponse as i, mythicKeystoneLeaderboardIndex as n, MythicKeystoneLeaderboardIndexResponse as r, mythicKeystoneLeaderboard as t };
+//# sourceMappingURL=index-CQXTvcKu2.d.ts.map

package/dist/index-CS_QQdEk.d.ts

@@ -0,0 +1,22 @@
+import { Character, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-media/types.d.ts
+interface CharacterMediaSummaryResponse extends ResponseBase {
+  assets: Array<Asset>;
+  character: Character;
+}
+interface Asset {
+  key: string;
+  value: string;
+}
+//#endregion
+//#region src/character-media/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the media assets available for a character (such as an avatar render).
+ */
+declare function characterMediaSummary(realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
+//#endregion
+export { CharacterMediaSummaryResponse as n, characterMediaSummary as t };
+//# sourceMappingURL=index-CS_QQdEk.d.ts.map

package/dist/index-CWFif_SP2.d.ts

@@ -0,0 +1,31 @@
+import { NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/power-type/types.d.ts
+/**
+ * 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 NameId, ResponseBase {}
+//#endregion
+//#region src/power-type/index.d.ts
+/**
+ * Get a power type by ID.
+ * @param powerTypeId The power type ID.
+ * @returns The power type. See {@link PowerTypeResponse}.
+ */
+declare function powerType(powerTypeId: number): Resource<PowerTypeResponse>;
+/**
+ * Get a power type index.
+ * @returns The power type index. See {@link PowerTypeIndexResponse}.
+ */
+declare function powerTypeIndex(): Resource<PowerTypeIndexResponse>;
+//#endregion
+export { PowerTypeResponse as i, powerTypeIndex as n, PowerTypeIndexResponse as r, powerType as t };
+//# sourceMappingURL=index-CWFif_SP2.d.ts.map

package/dist/index-CZy1t3WK.d.ts

@@ -0,0 +1,160 @@
+import { BaseSearchParameters, KeyBase, Locales, NameId, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/housing-decor/types.d.ts
+interface DecorIndexResponse extends ResponseBase {
+  decor_items: Array<NameIdKey>;
+}
+interface DecorResponse extends ResponseBase {
+  default_collection_count?: number;
+  dye_slots?: Array<DyeSlot>;
+  id: number;
+  items: NameIdKey;
+  name: string;
+  source?: Array<DecorSource>;
+}
+interface DecorSearchResponse extends SearchResponseWithoutResults {
+  results: Array<DecorSearchResponseItem>;
+}
+interface FixtureHookIndexResponse extends ResponseBase {
+  fixture_hooks: Array<NameIdKey>;
+}
+interface FixtureHookResponse extends ResponseBase {
+  id: number;
+  parent_fixture: NameIdKey;
+  type_name: string;
+}
+interface FixtureHookSearchResponse extends SearchResponseWithoutResults {
+  results: Array<FixtureHookSearchResponseItem>;
+}
+interface FixtureIndexResponse extends ResponseBase {
+  fixtures: Array<NameIdKey>;
+}
+interface FixtureResponse extends NameId, ResponseBase {
+  hooks?: Array<NameIdKey>;
+}
+interface FixtureSearchResponse extends SearchResponseWithoutResults {
+  results: Array<FixtureSearchResponseItem>;
+}
+/**
+ * The search parameters for a decor.
+ * @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 GenericDecorSearchParameters extends BaseSearchParameters {
+  locale: Locales;
+  name: string;
+}
+interface RoomIndexReponse extends ResponseBase {
+  rooms: Array<NameIdKey>;
+}
+interface RoomResponse extends NameId, ResponseBase {}
+interface RoomSearchResponse extends SearchResponseWithoutResults {
+  results: Array<RoomSearchResponseItem>;
+}
+interface DecorSearchResponseItem extends KeyBase {
+  data: {
+    id: number;
+    item: {
+      id: number;
+      name: Record<Locales, string>;
+    };
+    name: Record<Locales, string | undefined>;
+  };
+}
+interface DecorSource {
+  achievements?: Array<NameIdKey>;
+  recipes?: Array<NameIdKey>;
+}
+interface DyeSlot {
+  dye_color_category: string;
+  slot_index: number;
+}
+interface FixtureHookSearchResponseItem extends KeyBase {
+  id: number;
+}
+interface FixtureSearchResponseItem extends KeyBase {
+  data: {
+    id: number;
+    name: Record<Locales, string | undefined>;
+  };
+}
+interface RoomSearchResponseItem extends KeyBase {
+  data: {
+    id: number;
+    name: Record<Locales, string | undefined>;
+  };
+}
+//#endregion
+//#region src/housing-decor/index.d.ts
+/**
+ *
+ * Returns an index of decor.
+ * @returns An index of decor. See {@link DecorIndexResponse}.
+ */
+declare function decorIndex(): Resource<DecorIndexResponse>;
+/**
+ * Returns a decor by ID.
+ * @param decorId The decor ID.
+ * @returns A decor. See {@link DecorResponse}.
+ */
+declare function decor(decorId: number): Resource<DecorResponse>;
+/**
+ * Searches for decor.
+ * @param options The search parameters. See {@link GenericDecorSearchParameters}.
+ * @returns A decor. See {@link DecorSearchResponse}.
+ */
+declare function decorSearch(options: GenericDecorSearchParameters): Resource<DecorSearchResponse, Omit<GenericDecorSearchParameters, 'locale' | 'name'>>;
+/**
+ * Returns an index of fixtures.
+ * @returns An index of fixtures. See {@link FixtureIndexResponse}.
+ */
+declare function fixtureIndex(): Resource<FixtureIndexResponse>;
+/**
+ * Returns a fixture by ID.
+ * @param fixtureId The fixture ID.
+ * @returns A fixture. See {@link FixtureResponse}.
+ */
+declare function fixture(fixtureId: number): Resource<FixtureResponse>;
+/**
+ * Searches for fixtures.
+ * @param options The search parameters. See {@link GenericDecorSearchParameters}.
+ * @returns A fixture. See {@link FixtureSearchResponse}.
+ */
+declare function fixtureSearch(options: GenericDecorSearchParameters): Resource<FixtureSearchResponse, Omit<GenericDecorSearchParameters, 'locale' | 'name'>>;
+/**
+ * Returns an index of fixture hooks.
+ * @returns An index of fixture hooks. See {@link FixtureHookIndexResponse}.
+ */
+declare function fixtureHookIndex(): Resource<FixtureHookIndexResponse>;
+/**
+ * Returns a fixture hook by ID.
+ * @param fixtureHookId The fixture hook ID.
+ * @returns A fixture hook. See {@link FixtureHookResponse}.
+ */
+declare function fixtureHook(fixtureHookId: number): Resource<FixtureHookResponse>;
+/**
+ * Searches for fixture hooks.
+ * @param options The search parameters. See {@link GenericDecorSearchParameters}.
+ * @returns A fixture hook. See {@link FixtureSearchResponse}.
+ */
+declare function fixtureHookSearch(options: GenericDecorSearchParameters): Resource<FixtureHookSearchResponse, Omit<GenericDecorSearchParameters, 'locale' | 'name'>>;
+/**
+ * Returns an index of rooms.
+ * @returns An index of rooms. See {@link RoomIndexReponse}.
+ */
+declare function roomIndex(): Resource<RoomIndexReponse>;
+/**
+ * Returns a room by ID.
+ * @param roomId The room ID.
+ * @returns A room. See {@link RoomResponse}.
+ */
+declare function room(roomId: number): Resource<RoomResponse>;
+/**
+ * Searches for rooms.
+ * @param options The search parameters. See {@link GenericDecorSearchParameters}.
+ * @returns A room. See {@link RoomSearchResponse}.
+ */
+declare function roomSearch(options: GenericDecorSearchParameters): Resource<RoomSearchResponse, Omit<GenericDecorSearchParameters, 'locale' | 'name'>>;
+//#endregion
+export { RoomIndexReponse as C, GenericDecorSearchParameters as S, RoomSearchResponse as T, FixtureHookResponse as _, fixtureHook as a, FixtureResponse as b, fixtureIndex as c, roomIndex as d, roomSearch as f, FixtureHookIndexResponse as g, DecorSearchResponse as h, fixture as i, fixtureSearch as l, DecorResponse as m, decorIndex as n, fixtureHookIndex as o, DecorIndexResponse as p, decorSearch as r, fixtureHookSearch as s, decor as t, room as u, FixtureHookSearchResponse as v, RoomResponse as w, FixtureSearchResponse as x, FixtureIndexResponse as y };
+//# sourceMappingURL=index-CZy1t3WK.d.ts.map

package/dist/index-ChVDi11Z.d.ts

@@ -0,0 +1,54 @@
+import { Character, Faction, KeyBase, NameId, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-pvp/types.d.ts
+interface CharacterPvpBracketStatisticsResponse extends ResponseBase {
+  bracket: Bracket;
+  character: Character;
+  faction: Faction;
+  rating: number;
+  season: KeyBase & {
+    id: number;
+  };
+  season_match_statistics: MatchStatistics;
+  tier: KeyBase & {
+    id: number;
+  };
+  weekly_match_statistics: MatchStatistics;
+}
+interface CharacterPvpSummaryResponse extends ResponseBase {
+  character: Character;
+  honor_level: number;
+  honorable_kills: number;
+  pvp_map_statistics: Array<PvpMapStatistic>;
+}
+interface Bracket {
+  id: number;
+  type: string;
+}
+interface MatchStatistics {
+  lost: number;
+  played: number;
+  won: number;
+}
+interface PvpMapStatistic {
+  match_statistics: MatchStatistics;
+  world_map: NameId;
+}
+//#endregion
+//#region src/character-pvp/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @param bracketId The ID of the PvP bracket.
+ * @returns a PvP bracket statistics for a character.
+ */
+declare function characterPvpBracketStatistics(realmSlug: string, characterName: string, bracketId: '2v2' | '3v3' | 'rbg' | `shuffle-${string}-${string}`): Resource<CharacterPvpBracketStatisticsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a PvP summary for a character.
+ */
+declare function characterPvpSummary(realmSlug: string, characterName: string): Resource<CharacterPvpSummaryResponse>;
+//#endregion
+export { CharacterPvpSummaryResponse as i, characterPvpSummary as n, CharacterPvpBracketStatisticsResponse as r, characterPvpBracketStatistics as t };
+//# sourceMappingURL=index-ChVDi11Z.d.ts.map

package/dist/index-CmJhDVVk.d.ts

@@ -0,0 +1,157 @@
+import { KeyBase, MediaAsset, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/covenant/types.d.ts
+/**
+ * Interface for a response from the conduit index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ConduitIndexResponse extends ResponseBase {
+  conduits: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the conduit endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ConduitResponse extends ResponseBase {
+  id: number;
+  item: NameIdKey;
+  name: string;
+  ranks: Array<Rank>;
+  socket_type: SocketType;
+}
+/**
+ * Interface for a response from the covenant index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CovenantIndexResponse extends ResponseBase {
+  covenants: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the covenant media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CovenantMediaResponse extends ResponseBase {
+  assets?: Array<MediaAsset>;
+}
+/**
+ * Interface for a response from the covenant endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CovenantResponse extends ResponseBase {
+  class_abilities?: Array<ClassAbility>;
+  description: string;
+  id: number;
+  media?: Media;
+  name: string;
+  renown_rewards: Array<RenownReward>;
+  signature_ability?: SignatureAbility;
+  soulbinds?: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the soulbind index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SoulbindIndexResponse extends ResponseBase {
+  soulbinds: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the soulbind endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SoulbindResponse extends ResponseBase {
+  covenant: NameIdKey;
+  creature: NameIdKey;
+  follower: NameId;
+  id: number;
+  name: string;
+  talent_tree: NameIdKey;
+}
+interface ClassAbility {
+  id: number;
+  playable_class: NameIdKey;
+  spell_tooltip: ClassAbilitySpellTooltip;
+}
+interface ClassAbilitySpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  power_cost?: null | string;
+  range?: string;
+  spell: NameIdKey;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Rank {
+  id: number;
+  spell_tooltip: SpellTooltip;
+  tier: number;
+}
+interface RenownReward {
+  level: number;
+  reward: NameIdKey;
+}
+interface SignatureAbility {
+  id: number;
+  spell_tooltip: SignatureAbilitySpellTooltip;
+}
+interface SignatureAbilitySpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  range?: string;
+  spell: NameIdKey;
+}
+interface SocketType {
+  name: string;
+  type: string;
+}
+interface SpellTooltip {
+  cast_time: string;
+  description: string;
+  spell: NameIdKey;
+}
+//#endregion
+//#region src/covenant/index.d.ts
+/**
+ * Get a conduit by ID.
+ * @param conduitId The conduit ID.
+ * @returns The conduit. See {@link ConduitResponse}.
+ */
+declare function conduit(conduitId: number): Resource<ConduitResponse>;
+/**
+ * Get a conduit index.
+ * @returns The conduit index. See {@link ConduitIndexResponse}.
+ */
+declare function conduitIndex(): Resource<ConduitIndexResponse>;
+/**
+ * Get a covenant by ID.
+ * @param covenantId The covenant ID.
+ * @returns The covenant. See {@link CovenantResponse}.
+ */
+declare function covenant(covenantId: number): Resource<CovenantResponse>;
+/**
+ * Get a covenant index.
+ * @returns The covenant index. See {@link CovenantIndexResponse}.
+ */
+declare function covenantIndex(): Resource<CovenantIndexResponse>;
+/**
+ * Get covenant media by ID.
+ * @param covenantId The covenant ID.
+ * @returns The covenant media. See {@link CovenantMediaResponse}.
+ */
+declare function covenantMedia(covenantId: number): Resource<CovenantMediaResponse>;
+/**
+ * Get a soulbind by ID.
+ * @param soulbindId The soulbind ID.
+ * @returns The soulbind. See {@link SoulbindResponse}.
+ */
+declare function soulbind(soulbindId: number): Resource<SoulbindResponse>;
+/**
+ * Get a soulbind index.
+ * @returns The soulbind index. See {@link SoulbindIndexResponse}.
+ */
+declare function soulbindIndex(): Resource<SoulbindIndexResponse>;
+//#endregion
+export { covenantMedia as a, ConduitIndexResponse as c, CovenantMediaResponse as d, CovenantResponse as f, covenantIndex as i, ConduitResponse as l, SoulbindResponse as m, conduitIndex as n, soulbind as o, SoulbindIndexResponse as p, covenant as r, soulbindIndex as s, conduit as t, CovenantIndexResponse as u };
+//# sourceMappingURL=index-CmJhDVVk.d.ts.map

package/dist/index-Cry2-cm82.d.ts

@@ -0,0 +1,123 @@
+import { Faction, Factions, Href, KeyBase, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/pvp-season/types.d.ts
+/**
+ * The response for a PvP leaderboard index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpLeaderboardIndexResponse extends ResponseBase {
+  leaderboards: Array<KeyBase & {
+    id?: number;
+    name: string;
+  }>;
+  season: Season;
+}
+/**
+ * The response for a PvP leaderboard.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpLeaderboardResponse extends ResponseBase {
+  bracket: Bracket;
+  entries: Array<Entry>;
+  name: string;
+  season: Season;
+}
+/**
+ * The response for PvP rewards index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpRewardsIndexResponse extends ResponseBase {
+  rewards: Array<Reward>;
+  season: Season;
+}
+/**
+ * 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>;
+}
+/**
+ * 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;
+  rewards: Href;
+  season_end_timestamp?: number;
+  season_name?: null | string;
+  season_start_timestamp: number;
+}
+interface Bracket {
+  id: number;
+  type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'BLITZ' | 'SHUFFLE';
+}
+interface Character$1 extends NameId {
+  realm: Realm$1;
+}
+interface Entry {
+  character: Character$1;
+  faction: {
+    type: Factions;
+  };
+  rank: number;
+  rating: number;
+  season_match_statistics: SeasonMatchStatistics;
+  tier: Season;
+}
+interface Realm$1 extends KeyBase {
+  id: number;
+  slug: string;
+}
+interface Reward {
+  achievement: NameIdKey;
+  bracket: Bracket;
+  faction?: Faction;
+  rating_cutoff: number;
+  specialization?: NameIdKey;
+}
+interface Season extends KeyBase {
+  id: number;
+}
+interface SeasonMatchStatistics {
+  lost: number;
+  played: number;
+  won: number;
+}
+//#endregion
+//#region src/pvp-season/index.d.ts
+/**
+ * Get a PvP leaderboard by PvP season ID and bracket.
+ * @param pvpSeasonId The PvP season ID.
+ * @param bracket The PvP bracket.
+ * @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
+ */
+declare function pvpLeaderboard(pvpSeasonId: number, bracket: string): Resource<PvpLeaderboardResponse>;
+/**
+ * Get a PvP leaderboard index by PvP season ID.
+ * @param pvpSeasonId The PvP season ID.
+ * @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
+ */
+declare function pvpLeaderboardIndex(pvpSeasonId: number): Resource<PvpLeaderboardIndexResponse>;
+/**
+ * Get a PvP reward index by PvP season ID.
+ * @param pvpSeasonId The PvP season ID.
+ * @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
+ */
+declare function pvpRewardsIndex(pvpSeasonId: number): Resource<PvpRewardsIndexResponse>;
+/**
+ * Get a PvP season by ID.
+ * @param pvpSeasonId The PvP season ID.
+ * @returns The PvP season. See {@link PvpSeasonResponse}.
+ */
+declare function pvpSeason(pvpSeasonId: number): Resource<PvpSeasonResponse>;
+/**
+ * Get a PvP season index.
+ * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
+ */
+declare function pvpSeasonIndex(): Resource<PvpSeasonIndexResponse>;
+//#endregion
+export { pvpSeasonIndex as a, PvpRewardsIndexResponse as c, pvpSeason as i, PvpSeasonIndexResponse as l, pvpLeaderboardIndex as n, PvpLeaderboardIndexResponse as o, pvpRewardsIndex as r, PvpLeaderboardResponse as s, pvpLeaderboard as t, PvpSeasonResponse as u };
+//# sourceMappingURL=index-Cry2-cm82.d.ts.map

package/dist/index-Cto5KQ-A2.d.ts

@@ -0,0 +1,71 @@
+import { BaseSearchParameters, KeyBase, Locales, MediaAsset, NameId, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/spell/types.d.ts
+/**
+ * The response for a spell media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SpellMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a spell.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface SpellResponse extends NameId, ResponseBase {
+  description: null | string;
+  media: Media;
+}
+/**
+ * The search parameters for spells.
+ * @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 SpellSearchParameters extends BaseSearchParameters {
+  locale: Locales;
+  name: string;
+}
+/**
+ * The response for a spell 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 SpellSearchResponse extends SearchResponseWithoutResults {
+  results: Array<SpellSearchResponseItem>;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface SpellSearchResponseItem extends KeyBase {
+  data: {
+    id: number;
+    media: {
+      id: number;
+    };
+    name: Record<Locales, string>;
+  };
+}
+//#endregion
+//#region src/spell/index.d.ts
+/**
+ * Get a spell by ID.
+ * @param spellId The spell ID.
+ * @returns The spell. See {@link SpellResponse}.
+ */
+declare function spell(spellId: number): Resource<SpellResponse>;
+/**
+ * Get spell media by ID.
+ * @param spellId The spell ID.
+ * @returns The spell media. See {@link SpellMediaResponse}.
+ */
+declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
+/**
+ * Get a spell search.
+ * @param options The spell search options. See {@link SpellSearchParameters}.
+ * @returns The spell search. See {@link SpellSearchResponse}.
+ */
+declare function spellSearch(options: SpellSearchParameters): Resource<SpellSearchResponse, Omit<SpellSearchParameters, 'locale' | 'name'>>;
+//#endregion
+export { SpellResponse as a, SpellMediaResponse as i, spellMedia as n, SpellSearchParameters as o, spellSearch as r, SpellSearchResponse as s, spell as t };
+//# sourceMappingURL=index-Cto5KQ-A2.d.ts.map