@blizzard-api/wow 3.0.5 → 4.0.0

package/dist/index-D9u-Oxk6.d.ts

@@ -0,0 +1,69 @@
+import { Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/auction-house/types.d.ts
+/**
+ * Interface for a response from the auction house commodities endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AuctionHouseCommoditiesResponse extends ResponseBase {
+  auctions: Array<AuctionHouseCommodity>;
+}
+/**
+ * Interface for a response from the auction house endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AuctionHouseResponse extends ResponseBase {
+  auctions: Array<AuctionHousePosting>;
+  commodities: {
+    href: string;
+  };
+  connected_realm: {
+    href: string;
+  };
+}
+interface AuctionHouseCommodity {
+  id: number;
+  item: {
+    id: number;
+  };
+  quantity: number;
+  time_left: AuctionHouseTimeLeft;
+  unit_price: number;
+}
+interface AuctionHousePosting {
+  bid?: number;
+  buyout: number;
+  id: number;
+  item: {
+    bonus_lists?: Array<number>;
+    context?: number;
+    id: number;
+    modifiers?: Array<{
+      type: number;
+      value: number;
+    }>;
+    pet_breed_id?: number;
+    pet_level?: number;
+    pet_quality_id?: number;
+    pet_species_id?: number;
+  };
+  quantity: number;
+  time_left: AuctionHouseTimeLeft;
+}
+type AuctionHouseTimeLeft = 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
+//#endregion
+//#region src/auction-house/index.d.ts
+/**
+ * Get auction house data for a connected realm.
+ * @param connectedRealmId The ID of the connected realm.
+ * @returns The auction house data. See {@link AuctionHouseResponse}.
+ */
+declare function auctions(connectedRealmId: number): Resource<AuctionHouseResponse>;
+/**
+ * Get auction house data for all connected realms.
+ * @returns The auction house data. See {@link AuctionHouseResponse}.
+ */
+declare function commodities(): Resource<AuctionHouseCommoditiesResponse>;
+//#endregion
+export { AuctionHouseResponse as i, commodities as n, AuctionHouseCommoditiesResponse as r, auctions as t };
+//# sourceMappingURL=index-D9u-Oxk6.d.ts.map

package/dist/index-DDHIN-u0.d.ts

@@ -0,0 +1,36 @@
+import { BaseSearchParameters, KeyBase, MediaAsset, Resource, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/media-search/types.d.ts
+/**
+ * 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 MediaSearchResponse extends SearchResponseWithoutResults {
+  results: Array<MediaSearchResponseItem>;
+}
+interface MediaSearchResponseItem extends KeyBase {
+  data: {
+    assets?: Array<MediaAsset>;
+    id?: number;
+  };
+}
+//#endregion
+//#region src/media-search/index.d.ts
+/**
+ * Search for media.
+ * @param options The search parameters. See {@link MediaSearchParameters}.
+ * @returns The search results. See {@link MediaSearchResponse}.
+ */
+declare function mediaSearch(options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
+//#endregion
+export { MediaSearchParameters as n, MediaSearchResponse as r, mediaSearch as t };
+//# sourceMappingURL=index-DDHIN-u0.d.ts.map

package/dist/index-DJZZaqMF.d.ts

@@ -0,0 +1,66 @@
+import { Character, Color, Faction, Gender, KeyBase, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-appearance/types.d.ts
+interface CharacterAppearanceResponse extends ResponseBase {
+  active_spec: NameIdKey;
+  character: Character;
+  customizations: Array<Customization>;
+  faction: Faction;
+  gender: Gender;
+  guild_crest: GuildCrest;
+  items: Array<Item>;
+  playable_class: NameIdKey;
+  playable_race: NameIdKey;
+}
+interface BorderEmblem {
+  color: RGBWithId;
+  id: number;
+  media: KeyBase & {
+    id: number;
+  };
+}
+interface Choice {
+  display_order: number;
+  id: number;
+  name?: null | string;
+}
+interface Customization {
+  choice: Choice;
+  option: NameId;
+}
+interface GuildCrest {
+  background: {
+    color: RGBWithId;
+  };
+  border: BorderEmblem;
+  emblem: BorderEmblem;
+}
+interface Item {
+  enchant: number;
+  id: number;
+  internal_slot_id: number;
+  item_appearance_modifier_id?: number;
+  secondary_id?: number;
+  secondary_item_appearance_modifier_id?: number;
+  secondary_subclass?: number;
+  slot: {
+    name: string;
+    type: string;
+  };
+  subclass?: number;
+}
+interface RGBWithId {
+  id: number;
+  rgba: Color;
+}
+//#endregion
+//#region src/character-appearance/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's appearance settings.
+ */
+declare function characterAppearanceSummary(realmSlug: string, characterName: string): Resource<CharacterAppearanceResponse>;
+//#endregion
+export { CharacterAppearanceResponse as n, characterAppearanceSummary as t };
+//# sourceMappingURL=index-DJZZaqMF.d.ts.map

package/dist/index-DLD2tbdk.d.ts

@@ -0,0 +1,68 @@
+import { Character, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-specializations/types.d.ts
+interface CharacterSpecializationsSummaryResponse extends ResponseBase {
+  active_hero_talent_tree: NameIdKey;
+  active_specialization: NameIdKey;
+  character: Character;
+  specializations: Array<Specialization>;
+}
+interface Loadout {
+  is_active: boolean;
+  selected_class_talent_tree: KeyBase & {
+    name: string;
+  };
+  selected_class_talents: Array<SelectedTalent>;
+  selected_hero_talent_tree: NameIdKey;
+  selected_hero_talents: Array<SelectedTalent>;
+  selected_spec_talent_tree: KeyBase & {
+    name: string;
+  };
+  selected_spec_talents?: Array<SelectedTalent>;
+  talent_loadout_code: string;
+}
+interface PvpTalentSlot {
+  selected: Selected;
+  slot_number: number;
+}
+interface Selected {
+  spell_tooltip: SpellTooltip;
+  talent: KeyBase & {
+    id: number;
+    name?: string;
+  };
+}
+interface SelectedTalent {
+  default_points?: number;
+  id: number;
+  rank: number;
+  tooltip?: Selected;
+}
+interface Specialization {
+  glyphs?: Array<NameIdKey>;
+  loadouts: Array<Loadout>;
+  pvp_talent_slots?: Array<PvpTalentSlot>;
+  specialization: NameIdKey;
+}
+interface SpellTooltip {
+  cast_time?: string;
+  cooldown?: string;
+  description?: string;
+  power_cost?: string;
+  range?: string;
+  spell: KeyBase & {
+    id: number;
+    name?: string;
+  };
+}
+//#endregion
+//#region src/character-specializations/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of a character's specializations.
+ */
+declare function characterSpecializationsSummary(realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
+//#endregion
+export { CharacterSpecializationsSummaryResponse as n, characterSpecializationsSummary as t };
+//# sourceMappingURL=index-DLD2tbdk.d.ts.map

package/dist/index-DScltfEW.d.ts

@@ -0,0 +1,89 @@
+import { Character, Href, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-achievements/types.d.ts
+interface CharacterAchievementsSummaryResponse extends ResponseBase {
+  achievements: Array<Achievement>;
+  category_progress: Array<CategoryProgress>;
+  character: Character;
+  recent_events: Array<RecentEvent>;
+  statistics: Href;
+  total_points: number;
+  total_quantity: number;
+}
+interface CharacterAchievementStatisticsResponse extends ResponseBase {
+  categories: Array<Category>;
+  character: Character;
+}
+interface Achievement {
+  achievement: NameIdKey;
+  completed_timestamp?: number;
+  criteria?: Criteria;
+  id: number;
+}
+interface Category {
+  id?: number;
+  name: string;
+  statistics?: Array<Statistic>;
+  sub_categories?: Array<SubCategory>;
+}
+interface CategoryProgress {
+  category: NameIdKey;
+  points: number;
+  quantity: number;
+}
+interface ChildCriterum {
+  amount?: number;
+  child_criteria?: Array<ChildCriterum2>;
+  id: number;
+  is_completed: boolean;
+}
+interface ChildCriterum2 {
+  amount?: number;
+  child_criteria?: Array<ChildCriterum3>;
+  id: number;
+  is_completed: boolean;
+}
+interface ChildCriterum3 {
+  amount?: number;
+  id: number;
+  is_completed: boolean;
+}
+interface Criteria {
+  amount?: number;
+  child_criteria?: Array<ChildCriterum>;
+  id: number;
+  is_completed: boolean;
+}
+interface RecentEvent {
+  achievement: NameIdKey;
+  timestamp: number;
+}
+interface Statistic {
+  description?: null | string;
+  id: number;
+  last_updated_timestamp: number;
+  name: string;
+  quantity: number;
+}
+interface SubCategory {
+  id: number;
+  name: string;
+  statistics: Array<Statistic>;
+}
+//#endregion
+//#region src/character-achievements/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the achievements a character has completed.
+ */
+declare function characterAchievementsSummary(realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a character's statistics as they pertain to achievements.
+ */
+declare function characterAchievementStatistics(realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
+//#endregion
+export { CharacterAchievementsSummaryResponse as i, characterAchievementsSummary as n, CharacterAchievementStatisticsResponse as r, characterAchievementStatistics as t };
+//# sourceMappingURL=index-DScltfEW.d.ts.map

package/dist/index-DZqv9GTd.d.ts

@@ -0,0 +1,125 @@
+import { c as RealmTypeCapitalized, r as RealmLocales, s as RealmTimezone, t as RealmCategory } from "./types-Z0ZgMUXA.js";
+import { BaseSearchParameters, Href, KeyBase, Locales, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/connected-realm/types.d.ts
+/**
+ * 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>;
+}
+/**
+ * Connected Realm API response.
+ * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
+ */
+interface ConnectedRealmResponse extends ResponseBase {
+  auctions: Href;
+  has_queue: boolean;
+  id: number;
+  mythic_leaderboards: Href;
+  population: {
+    name: string;
+    type: RealmPopulationCapitalized;
+  };
+  realm_locked_status?: RealmLockedStatus;
+  realms: Array<Realm$1>;
+  status: {
+    name: string;
+    type: RealmStatusCapitalized;
+  };
+}
+/**
+ * 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'?: RealmStatusCapitalized;
+}
+/**
+ * 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 ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
+  results: Array<ConnectedRealmSearchResponseItem>;
+}
+interface ConnectedRealmSearchResponseItem extends KeyBase {
+  data: {
+    has_queue: boolean;
+    id: number;
+    population: SearchRealmPopulation;
+    realms: Array<SearchRealm>;
+    status: SearchRealmStatus;
+  };
+}
+interface Realm$1 {
+  category: RealmCategory;
+  connected_realm: Href;
+  id: number;
+  is_tournament: boolean;
+  locale: RealmLocales;
+  name: string;
+  region: NameIdKey;
+  slug: string;
+  timezone: RealmTimezone;
+  type: {
+    name: string;
+    type: RealmTypeCapitalized;
+  };
+}
+interface RealmLockedStatus {
+  is_locked_for_new_characters: boolean;
+  is_locked_for_pct: boolean;
+}
+type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
+type RealmStatusCapitalized = 'DOWN' | 'UP';
+interface SearchRealm {
+  category: Record<Locales, string>;
+  id: number;
+  is_tournament: boolean;
+  locale: RealmLocales;
+  name: Record<Locales, string>;
+  region: {
+    id: number;
+    name: Record<Locales, string>;
+  };
+  slug: string;
+  timezone: RealmTimezone;
+  type: {
+    name: Record<Locales, string>;
+    type: RealmTypeCapitalized;
+  };
+}
+interface SearchRealmPopulation {
+  name: Record<Locales, string>;
+  type: RealmPopulationCapitalized;
+}
+interface SearchRealmStatus {
+  name: Record<Locales, string>;
+  type: RealmStatusCapitalized;
+}
+//#endregion
+//#region src/connected-realm/index.d.ts
+/**
+ * Get a connected realm by ID.
+ * @param connectedRealmId The connected realm ID.
+ * @returns The connected realm. See {@link ConnectedRealmResponse}.
+ */
+declare function connectedRealm(connectedRealmId: number): Resource<ConnectedRealmResponse>;
+/**
+ * Get a connected realm index.
+ * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
+ */
+declare function connectedRealmIndex(): Resource<ConnectedRealmIndexResponse>;
+/**
+ * Search for connected realms.
+ * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
+ * @returns The search results. See {@link ConnectedRealmSearchResponse}.
+ */
+declare function connectedRealmSearch(options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
+//#endregion
+export { ConnectedRealmResponse as a, ConnectedRealmIndexResponse as i, connectedRealmIndex as n, ConnectedRealmSearchParameters as o, connectedRealmSearch as r, ConnectedRealmSearchResponse as s, connectedRealm as t };
+//# sourceMappingURL=index-DZqv9GTd.d.ts.map

package/dist/index-DiU4f1cd2.d.ts

@@ -0,0 +1,45 @@
+import { GenderName, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/title/types.d.ts
+/**
+ * The response for a title index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TitleIndexResponse extends ResponseBase {
+  titles: Array<NameIdKey>;
+}
+/**
+ * The response for a title.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TitleResponse extends NameId, ResponseBase {
+  gender_name: GenderName;
+  source?: TitleSource;
+}
+interface TitleSource {
+  achievements?: Array<NameIdKey>;
+  quests?: Array<NameIdKey>;
+  type: {
+    name: string;
+    type: 'ACHIEVEMENT';
+  } | {
+    name: string;
+    type: 'QUEST';
+  };
+}
+//#endregion
+//#region src/title/index.d.ts
+/**
+ * Get a title by ID.
+ * @param titleId The title ID.
+ * @returns The title. See {@link TitleResponse}.
+ */
+declare function title(titleId: number): Resource<TitleResponse>;
+/**
+ * Get a title index.
+ * @returns The title index. See {@link TitleIndexResponse}.
+ */
+declare function titleIndex(): Resource<TitleIndexResponse>;
+//#endregion
+export { TitleResponse as i, titleIndex as n, TitleIndexResponse as r, title as t };
+//# sourceMappingURL=index-DiU4f1cd2.d.ts.map

package/dist/index-DlkM3Nrw2.d.ts

@@ -0,0 +1,45 @@
+import { KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/toy/types.d.ts
+/**
+ * The response for a toy index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ToyIndexResponse extends ResponseBase {
+  toys: Array<NameIdKey>;
+}
+/**
+ * The response for a toy.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ToyResponse extends ResponseBase {
+  id: number;
+  item: NameIdKey;
+  media: Media;
+  should_exclude_if_uncollected?: boolean;
+  source: Source;
+  source_description?: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Source {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region src/toy/index.d.ts
+/**
+ * Get a toy by ID.
+ * @param toyId The toy ID.
+ * @returns The toy. See {@link ToyResponse}.
+ */
+declare function toy(toyId: number): Resource<ToyResponse>;
+/**
+ * Get a toy index.
+ * @returns The toy index. See {@link ToyIndexResponse}.
+ */
+declare function toyIndex(): Resource<ToyIndexResponse>;
+//#endregion
+export { ToyResponse as i, toyIndex as n, ToyIndexResponse as r, toy as t };
+//# sourceMappingURL=index-DlkM3Nrw2.d.ts.map