@blizzard-api/wow 3.0.6 → 4.0.1

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

package/dist/index-Do1l3j1C.d.ts

@@ -0,0 +1,283 @@
+import { BaseSearchParameters, Faction, KeyBase, Locales, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/journal/types.d.ts
+/**
+ * The response for a journal encounter index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalEncounterIndexResponse extends ResponseBase {
+  encounters: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a journal encounter.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalEncounterResponse extends NameId, ResponseBase {
+  category: Category;
+  creatures?: Array<Creature>;
+  description?: string;
+  faction?: Faction;
+  instance: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  items?: Array<Item>;
+  modes?: Array<Mode>;
+  sections?: Array<JournalSection>;
+}
+/**
+ * The parameters for a journal encounter 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 JournalEncounterSearchParameters extends BaseSearchParameters {
+  instanceName: string;
+  locale: Locales;
+}
+/**
+ * The response for a journal encounter 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 JournalEncounterSearchResponse extends SearchResponseWithoutResults {
+  results: Array<JournalEncounterSearchResponseItem>;
+}
+/**
+ * The response for a journal expansion index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalExpansionIndexResponse extends ResponseBase {
+  tiers: Array<NameIdKey>;
+}
+/**
+ * The response for a journal expansion.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalExpansionResponse extends NameId, ResponseBase {
+  dungeons: Array<NameIdKey>;
+  raids: Array<NameIdKey>;
+  world_bosses?: Array<NameIdKey>;
+}
+/**
+ * The response for a journal instance index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalInstanceIndexResponse extends ResponseBase {
+  instances: Array<NameIdKey>;
+}
+/**
+ * The response for journal instance media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalInstanceMediaResponse extends ResponseBase {
+  assets: Array<Asset>;
+}
+/**
+ * The response for a journal instance.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface JournalInstanceResponse extends NameId, ResponseBase {
+  area?: NameId;
+  category: Category;
+  description?: string;
+  encounters: Array<NameIdKey>;
+  expansion?: NameIdKey;
+  location?: NameId;
+  map?: NameId;
+  media: Media;
+  minimum_level?: number;
+  modes?: Array<ModeElement>;
+  order_index?: number;
+}
+interface Asset {
+  key: string;
+  value: string;
+}
+interface Category {
+  type?: EncounterCategory;
+}
+interface Creature extends NameId {
+  creature_display: CreatureDisplay;
+  description?: string;
+}
+interface CreatureDisplay extends KeyBase {
+  id: number;
+}
+type EncounterCategory = 'DUNGEON' | 'EVENT' | 'RAID' | 'WORLD_BOSS';
+type EncounterMode = 'HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
+interface Item {
+  id: number;
+  item: NameIdKey;
+}
+interface JournalEncounterSearchCreature {
+  creature_display: {
+    id: number;
+  };
+  id: number;
+  name: Record<Locales, string>;
+}
+interface JournalEncounterSearchItem {
+  id: number;
+  item: {
+    id: number;
+    name: Record<Locales, string>;
+  };
+}
+interface JournalEncounterSearchResponseItem extends KeyBase {
+  data: {
+    category: Category;
+    creatures: Array<JournalEncounterSearchCreature>;
+    id: number;
+    instance: {
+      id: number;
+      name?: Record<Locales, string>;
+    };
+    items?: Array<JournalEncounterSearchItem>;
+    modes?: Array<{
+      name: Record<Locales, string>;
+      type: EncounterMode;
+    }>;
+    name: Record<Locales, string>;
+    sections?: Array<JournalSection>;
+  };
+}
+interface JournalSection {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  sections?: Array<JournalSubSection>;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: null | string;
+}
+interface JournalSubSection {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  sections?: Array<JournalSubSection2>;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: string;
+}
+interface JournalSubSection2 {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  sections?: Array<JournalSubSection3>;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: string;
+}
+interface JournalSubSection3 {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  sections?: Array<JournalSubSection4>;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: string;
+}
+interface JournalSubSection4 {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  sections?: Array<JournalSubSection5>;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: string;
+}
+interface JournalSubSection5 {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  sections?: Array<JournalSubSection6>;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: string;
+}
+interface JournalSubSection6 {
+  body_text?: null | string;
+  creature_display?: CreatureDisplay;
+  id: number;
+  spell?: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  title?: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Mode {
+  name: string;
+  type: ModeType;
+}
+interface ModeElement {
+  is_timewalking?: boolean;
+  is_tracked: boolean;
+  mode: Mode;
+  players: number;
+}
+type ModeType = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
+//#endregion
+//#region src/journal/index.d.ts
+/**
+ * Get a journal encounter by ID.
+ * @param journalEncounterId The journal encounter ID.
+ * @returns The journal encounter. See {@link JournalEncounterResponse}.
+ */
+declare function journalEncounter(journalEncounterId: number): Resource<JournalEncounterResponse>;
+/**
+ * Get the journal encounter index.
+ * @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
+ */
+declare function journalEncounterIndex(): Resource<JournalEncounterIndexResponse>;
+/**
+ * Search for journal encounters.
+ * @param options The search parameters. See {@link JournalEncounterSearchParameters}.
+ * @returns The search results. See {@link JournalEncounterSearchResponse}.
+ */
+declare function journalEncounterSearch(options: JournalEncounterSearchParameters): Resource<JournalEncounterSearchResponse, Omit<JournalEncounterSearchParameters, 'instanceName' | 'locale'>>;
+/**
+ * Get a journal expansion by ID.
+ * @param journalExpansionId The journal expansion ID.
+ * @returns The journal expansion. See {@link JournalExpansionResponse}.
+ */
+declare function journalExpansion(journalExpansionId: number): Resource<JournalExpansionResponse>;
+/**
+ * Get the journal expansion index.
+ * @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
+ */
+declare function journalExpansionIndex(): Resource<JournalExpansionIndexResponse>;
+/**
+ * Get a journal instance by ID.
+ * @param journalInstanceId The journal instance ID.
+ * @returns The journal instance. See {@link JournalInstanceResponse}.
+ */
+declare function journalInstance(journalInstanceId: number): Resource<JournalInstanceResponse>;
+/**
+ * Get the journal instance index.
+ * @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
+ */
+declare function journalInstanceIndex(): Resource<JournalInstanceIndexResponse>;
+/**
+ * Get journal instance media by ID.
+ * @param journalInstanceId The journal instance ID.
+ * @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
+ */
+declare function journalInstanceMedia(journalInstanceId: number): Resource<JournalInstanceMediaResponse>;
+//#endregion
+export { JournalInstanceResponse as _, journalExpansionIndex as a, journalInstanceMedia as c, JournalEncounterSearchParameters as d, JournalEncounterSearchResponse as f, JournalInstanceMediaResponse as g, JournalInstanceIndexResponse as h, journalExpansion as i, JournalEncounterIndexResponse as l, JournalExpansionResponse as m, journalEncounterIndex as n, journalInstance as o, JournalExpansionIndexResponse as p, journalEncounterSearch as r, journalInstanceIndex as s, journalEncounter as t, JournalEncounterResponse as u };
+//# sourceMappingURL=index-Do1l3j1C.d.ts.map

package/dist/index-DpfeUoRy.d.ts

@@ -0,0 +1,149 @@
+import { Faction, KeyBase, MediaAsset, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/achievements/types.d.ts
+/**
+ * Interface for a response from the achievement category index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AchievementCategoryIndexResponse extends ResponseBase {
+  categories: Array<NameIdKey>;
+  guild_categories: Array<NameIdKey>;
+  root_categories: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the achievement category endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AchievementCategoryResponse extends NameId, ResponseBase {
+  achievements: Array<NameIdKey>;
+  aggregates_by_faction: {
+    alliance: {
+      points: number;
+      quantity: number;
+    };
+    horde: {
+      points: number;
+      quantity: number;
+    };
+  };
+  display_order: number;
+  is_guild_category: boolean;
+  parent_category?: NameIdKey;
+  subcategories?: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the achievement index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AchievementIndexResponse extends ResponseBase {
+  achievements: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the achievement media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AchievementMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * Interface for a response from the achievement endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AchievementResponse extends NameId, ResponseBase {
+  category: NameIdKey;
+  criteria?: Criteria;
+  description: null | string;
+  display_order: number;
+  guild_reward_items?: Array<NameIdKey>;
+  is_account_wide: boolean;
+  media: KeyBase & {
+    id: number;
+  };
+  next_achievement?: NameIdKey;
+  points: number;
+  prerequisite_achievement?: NameIdKey;
+  requirements?: {
+    faction: Faction;
+  };
+  reward_description?: string;
+  reward_item?: NameIdKey;
+}
+interface ChildCriteria {
+  achievement?: NameIdKey;
+  amount: number;
+  child_criteria?: Array<ChildCriteria2>;
+  description: null | string;
+  faction?: Faction;
+  id: number;
+  is_gold?: boolean;
+  operator?: Operator;
+  show_progress_bar?: boolean;
+}
+interface ChildCriteria2 {
+  achievement?: NameIdKey;
+  amount: number;
+  child_criteria?: Array<ChildCriteria3>;
+  description: null | string;
+  faction?: Faction;
+  id: number;
+  is_gold?: boolean;
+  operator?: Operator;
+  show_progress_bar?: boolean;
+}
+interface ChildCriteria3 {
+  achievement?: NameIdKey;
+  amount: number;
+  description: null | string;
+  faction?: Faction;
+  id: number;
+  is_gold?: boolean;
+  operator?: Operator;
+  show_progress_bar?: boolean;
+}
+interface Criteria {
+  amount: number;
+  child_criteria?: Array<ChildCriteria>;
+  description: null | string;
+  faction?: Faction;
+  id: number;
+  operator?: Operator;
+  show_progress_bar?: boolean;
+}
+interface Operator {
+  name: string;
+  type: 'AND' | 'COMPLETE_AT_LEAST';
+}
+//#endregion
+//#region src/achievements/index.d.ts
+/**
+ * Get an achievement by ID.
+ * @param achievementId The achievement ID.
+ * @returns The achievement. See {@link AchievementResponse}.
+ */
+declare function achievement(achievementId: number): Resource<AchievementResponse>;
+/**
+ * Get an achievement category by ID.
+ * @param achievementCategoryId The achievement category ID.
+ * @returns The achievement category. See {@link AchievementCategoryResponse}.
+ */
+declare function achievementCategory(achievementCategoryId: number): Resource<AchievementCategoryResponse>;
+/**
+ * Get an achievement category index.
+ * @returns The achievement category index. See {@link AchievementCategoryIndexResponse}.
+ */
+declare function achievementCategoryIndex(): Resource<AchievementCategoryIndexResponse>;
+/**
+ * Get an achievement index.
+ * @returns The achievement index. See {@link AchievementIndexResponse}.
+ */
+declare function achievementIndex(): Resource<AchievementIndexResponse>;
+/**
+ * Get achievement media by ID.
+ * @param achievementId The achievement ID.
+ * @returns The achievement media. See {@link AchievementMediaResponse}.
+ */
+declare function achievementMedia(achievementId: number): Resource<AchievementMediaResponse>;
+//#endregion
+export { achievementMedia as a, AchievementIndexResponse as c, achievementIndex as i, AchievementMediaResponse as l, achievementCategory as n, AchievementCategoryIndexResponse as o, achievementCategoryIndex as r, AchievementCategoryResponse as s, achievement as t, AchievementResponse as u };
+//# sourceMappingURL=index-DpfeUoRy.d.ts.map

package/dist/index-DvzdYkdL.d.ts

@@ -0,0 +1,89 @@
+import { BaseSearchParameters, KeyBase, Locales, MediaAsset, NameId, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/azerite-essence/types.d.ts
+/**
+ * Interface for a response from the azerite essence index endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AzeriteEssenceIndexResponse extends ResponseBase {
+  azerite_essences: Array<NameIdKey>;
+}
+/**
+ * Interface for a response from the azerite essence media endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AzeriteEssenceMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * Interface for a response from the azerite essence endpoint.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface AzeriteEssenceResponse extends NameId, ResponseBase {
+  allowed_specializations: Array<NameIdKey>;
+  media: Media;
+  powers: Array<Power>;
+}
+/**
+ * Interface for search parameters for azerite essences.
+ * @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 AzeriteEssenceSearchParameters extends BaseSearchParameters {
+  'allowed_specializations.id'?: number;
+}
+/**
+ * Interface for a response item from the azerite essence search endpoint.
+ * @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 AzeriteEssenceSearchResponse extends SearchResponseWithoutResults {
+  results: Array<AzeriteEssenceSearchResponseItem>;
+}
+interface AzeriteEssenceSearchResponseItem extends KeyBase {
+  data: {
+    allowed_specializations: Array<{
+      id: number;
+      name: Record<Locales, string>;
+    }>;
+    name: Record<Locales, string>;
+  };
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface Power {
+  id: number;
+  main_power_spell: NameIdKey;
+  passive_power_spell: NameIdKey;
+  rank: number;
+}
+//#endregion
+//#region src/azerite-essence/index.d.ts
+/**
+ * Get an azerite essence by ID.
+ * @param azeriteEssenceId The azerite essence ID.
+ * @returns The azerite essence. See {@link AzeriteEssenceResponse}.
+ */
+declare function azeriteEssence(azeriteEssenceId: number): Resource<AzeriteEssenceResponse>;
+/**
+ * Get an azerite essence index.
+ * @returns The azerite essence index. See {@link AzeriteEssenceIndexResponse}.
+ */
+declare function azeriteEssenceIndex(): Resource<AzeriteEssenceIndexResponse>;
+/**
+ * Get azerite essence media by ID.
+ * @param azeriteEssenceId The azerite essence ID.
+ * @returns The azerite essence media. See {@link AzeriteEssenceMediaResponse}.
+ */
+declare function azeriteEssenceMedia(azeriteEssenceId: number): Resource<AzeriteEssenceMediaResponse>;
+/**
+ * Search for azerite essences.
+ * @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
+ * @returns The search results. See {@link AzeriteEssenceSearchResponse}.
+ */
+declare function azeriteEssenceSearch(options: AzeriteEssenceSearchParameters): Resource<AzeriteEssenceSearchResponse, AzeriteEssenceSearchParameters>;
+//#endregion
+export { AzeriteEssenceIndexResponse as a, AzeriteEssenceSearchParameters as c, azeriteEssenceSearch as i, AzeriteEssenceSearchResponse as l, azeriteEssenceIndex as n, AzeriteEssenceMediaResponse as o, azeriteEssenceMedia as r, AzeriteEssenceResponse as s, azeriteEssence as t };
+//# sourceMappingURL=index-DvzdYkdL.d.ts.map