@blizzard-api/wow 3.0.6 → 4.0.0

package/dist/index-BXawY6VA2.d.ts

@@ -0,0 +1,150 @@
+import { Faction, Href, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/quest/types.d.ts
+/**
+ * The response for a quest area index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestAreaIndexResponse extends ResponseBase {
+  areas: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a quest area.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestAreaResponse extends ResponseBase {
+  area: string;
+  id: number;
+  quests: Array<NameIdKey>;
+}
+/**
+ * The response for a quest category index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestCategoryIndexResponse extends ResponseBase {
+  categories: Array<NameIdKey>;
+}
+/**
+ * The response for a quest category.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestCategoryResponse extends ResponseBase {
+  category: string;
+  id: number;
+  quests: Array<NameIdKey>;
+}
+/**
+ * The response for a quest index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestIndexResponse extends ResponseBase {
+  areas: Href;
+  categories: Href;
+  types: Href;
+}
+/**
+ * The response for a quest.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestResponse extends ResponseBase {
+  area?: NameIdKey;
+  category: NameIdKey;
+  description: string;
+  id: number;
+  requirements: Requirements;
+  rewards: Rewards;
+  title: string;
+}
+/**
+ * The response for a quest type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestTypeIndexResponse extends ResponseBase {
+  types: Array<NameIdKey>;
+}
+/**
+ * The response for a quest type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface QuestTypeResponse extends ResponseBase {
+  id: number;
+  quests: Array<NameIdKey>;
+  type: string;
+}
+interface Money {
+  units: Units;
+  value: number;
+}
+interface Reputation {
+  reward: NameIdKey;
+  value: number;
+}
+interface ReputationRequirement {
+  faction: NameIdKey;
+  min_reputation: number;
+}
+interface Requirements {
+  faction: Faction;
+  max_character_level: number;
+  min_character_level: number;
+  reputations: Array<ReputationRequirement>;
+}
+interface Rewards {
+  experience: number;
+  money: Money;
+  reputations: Array<Reputation>;
+}
+interface Units {
+  copper: number;
+  gold: number;
+  silver: number;
+}
+//#endregion
+//#region src/quest/index.d.ts
+/**
+ * Get a quest by ID.
+ * @param questId The quest ID.
+ * @returns The quest. See {@link QuestResponse}.
+ */
+declare function quest(questId: number): Resource<QuestResponse>;
+/**
+ * Get a quest area by ID.
+ * @param questAreaId The quest area ID.
+ * @returns The quest area. See {@link QuestAreaResponse}.
+ */
+declare function questArea(questAreaId: number): Resource<QuestAreaResponse>;
+/**
+ * Get a quest area index.
+ * @returns The quest area index. See {@link QuestAreaIndexResponse}.
+ */
+declare function questAreaIndex(): Resource<QuestAreaIndexResponse>;
+/**
+ * Get a quest category by ID.
+ * @param questCategoryId The quest category ID.
+ * @returns The quest category. See {@link QuestCategoryResponse}.
+ */
+declare function questCategory(questCategoryId: number): Resource<QuestCategoryResponse>;
+/**
+ * Get a quest category index.
+ * @returns The quest category index. See {@link QuestCategoryIndexResponse}.
+ */
+declare function questCategoryIndex(): Resource<QuestCategoryIndexResponse>;
+/**
+ * Get a quest index.
+ * @returns The quest index. See {@link QuestIndexResponse}.
+ */
+declare function questIndex(): Resource<QuestIndexResponse>;
+/**
+ * Get a quest type by ID.
+ * @param questTypeId The quest type ID.
+ * @returns The quest type. See {@link QuestTypeResponse}.
+ */
+declare function questType(questTypeId: number): Resource<QuestTypeResponse>;
+/**
+ * Get a quest type index.
+ * @returns The quest type index. See {@link QuestTypeIndexResponse}.
+ */
+declare function questTypeIndex(): Resource<QuestTypeIndexResponse>;
+//#endregion
+export { questCategoryIndex as a, questTypeIndex as c, QuestCategoryIndexResponse as d, QuestCategoryResponse as f, QuestTypeResponse as g, QuestTypeIndexResponse as h, questCategory as i, QuestAreaIndexResponse as l, QuestResponse as m, questArea as n, questIndex as o, QuestIndexResponse as p, questAreaIndex as r, questType as s, quest as t, QuestAreaResponse as u };
+//# sourceMappingURL=index-BXawY6VA2.d.ts.map

package/dist/index-B_OrLUY42.d.ts

@@ -0,0 +1,102 @@
+import { KeyBase, MediaAsset, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/tech-talent/types.d.ts
+/**
+ * The response for a tech talent index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TechTalentIndexResponse extends ResponseBase {
+  talents: Array<NameIdKey>;
+}
+/**
+ * The response for a tech talent media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TechTalentMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+}
+/**
+ * The response for a tech talent.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TechTalentResponse extends NameId, ResponseBase {
+  description?: string;
+  display_order: number;
+  media: Media;
+  prerequisite_talent?: NameIdKey;
+  socket_type?: {
+    name: string;
+    type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
+  };
+  spell_tooltip?: SpellTooltip;
+  talent_tree: KeyBase & {
+    id: number;
+    name?: string;
+  };
+  tier: number;
+}
+/**
+ * The response for a tech talent tree index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TechTalentTreeIndexResponse extends ResponseBase {
+  talent_trees: Array<TalentTree>;
+}
+/**
+ * The response for a tech talent tree.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface TechTalentTreeResponse extends ResponseBase {
+  id: number;
+  max_tiers: number;
+  playable_class?: NameIdKey;
+  talents: Array<NameIdKey>;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface SpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: null | string;
+  power_cost?: null | string;
+  range?: string;
+  spell: NullishNameIdKey;
+}
+interface TalentTree extends KeyBase {
+  id: number;
+  name?: string;
+}
+//#endregion
+//#region src/tech-talent/index.d.ts
+/**
+ * Get a tech talent by ID.
+ * @param techTalentId The tech talent ID.
+ * @returns The tech talent. See {@link TechTalentResponse}.
+ */
+declare function techTalent(techTalentId: number): Resource<TechTalentResponse>;
+/**
+ * Get a tech talent index.
+ * @returns The tech talent index. See {@link TechTalentIndexResponse}.
+ */
+declare function techTalentIndex(): Resource<TechTalentIndexResponse>;
+/**
+ * Get tech talent media by ID.
+ * @param techTalentId The tech talent ID.
+ * @returns The tech talent media. See {@link TechTalentMediaResponse}.
+ */
+declare function techTalentMedia(techTalentId: number): Resource<TechTalentMediaResponse>;
+/**
+ * Get a tech talent tree by ID.
+ * @param techTalentTreeId The tech talent tree ID.
+ * @returns The tech talent tree. See {@link TechTalentTreeResponse}.
+ */
+declare function techTalentTree(techTalentTreeId: number): Resource<TechTalentTreeResponse>;
+/**
+ * Get a tech talent tree index.
+ * @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
+ */
+declare function techTalentTreeIndex(): Resource<TechTalentTreeIndexResponse>;
+//#endregion
+export { techTalentTreeIndex as a, TechTalentResponse as c, techTalentTree as i, TechTalentTreeIndexResponse as l, techTalentIndex as n, TechTalentIndexResponse as o, techTalentMedia as r, TechTalentMediaResponse as s, techTalent as t, TechTalentTreeResponse as u };
+//# sourceMappingURL=index-B_OrLUY42.d.ts.map

package/dist/index-BcKDDvwF.d.ts

@@ -0,0 +1,85 @@
+import { Faction, Gender, Href, NameIdKey, Realm, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-profile/types.d.ts
+interface CharacterProfileStatusResponse extends ResponseBase {
+  id: number;
+  is_valid: boolean;
+}
+interface CharacterProfileSummaryResponse extends ResponseBase {
+  achievement_points: number;
+  achievements: Href;
+  achievements_statistics: Href;
+  active_spec: NameIdKey;
+  active_title?: NameIdKey & {
+    display_string: string;
+  };
+  appearance: Href;
+  average_item_level: number;
+  character_class: NameIdKey;
+  collections: Href;
+  covenant_progress: CovenantProgress;
+  encounters: Href;
+  equipment: Href;
+  equipped_item_level: number;
+  experience: number;
+  faction: Faction;
+  gender: Gender;
+  guild?: Guild;
+  houses?: Array<Href>;
+  hunter_pets: Href;
+  id: number;
+  is_remix: boolean;
+  last_login_timestamp: number;
+  level: number;
+  media: Href;
+  mythic_keystone_profile: Href;
+  name: string;
+  name_search: string;
+  professions: Href;
+  pvp_summary: Href;
+  quests: Href;
+  race: NameIdKey;
+  realm: Realm;
+  reputations: Href;
+  specializations: Href;
+  statistics: Href;
+  titles: Href;
+}
+interface CovenantProgress {
+  chosen_covenant: NameIdKey;
+  renown_level: number;
+  soulbinds: Href;
+}
+interface Guild extends NameIdKey {
+  faction: Faction;
+  realm: Realm;
+}
+//#endregion
+//#region src/character-profile/index.d.ts
+/**
+ * Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
+ * - an HTTP 404 Not Found error is returned
+ * - the is_valid value is false
+ * - the returned character ID doesn't match the previously recorded value for the character
+ *
+ * The following example illustrates how to use this endpoint:
+ *
+ * 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
+ * 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
+ * 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
+ * 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns the status of the character profile for a character.
+ */
+declare function characterProfileStatus(realmSlug: string, characterName: string): Resource<CharacterProfileStatusResponse>;
+/**
+ * Returns a summary of the character profile for a character.
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a summary of the character profile for a character.
+ */
+declare function characterProfileSummary(realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
+//#endregion
+export { CharacterProfileSummaryResponse as i, characterProfileSummary as n, CharacterProfileStatusResponse as r, characterProfileStatus as t };
+//# sourceMappingURL=index-BcKDDvwF.d.ts.map

package/dist/index-Bd_PavJU.d.ts

@@ -0,0 +1,56 @@
+import { KeyBase, MediaAsset, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/mythic-keystone-affix/types.d.ts
+/**
+ * The response for a Mythic Keystone affix index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneAffixIndexResponse extends ResponseBase {
+  affixes: Array<KeyBase & {
+    id: number;
+    name: null | string;
+  }>;
+}
+/**
+ * The response for a Mythic Keystone affix media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneAffixMediaResponse extends ResponseBase {
+  assets?: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a Mythic Keystone affix.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MythicKeystoneAffixResponse extends ResponseBase {
+  description: null | string;
+  id: number;
+  media: Media;
+  name: null | string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/mythic-keystone-affix/index.d.ts
+/**
+ * Get a list of all Mythic Keystone affixes.
+ * @param mythicKeystoneAffixId The ID of the Mythic Keystone affix.
+ * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
+ */
+declare function mythicKeystoneAffix(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixResponse>;
+/**
+ * Get a list of all Mythic Keystone affixes.
+ * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
+ */
+declare function mythicKeystoneAffixIndex(): Resource<MythicKeystoneAffixIndexResponse>;
+/**
+ * Get a list of all Mythic Keystone affix media.
+ * @param mythicKeystoneAffixId The ID of the Mythic Keystone affix.
+ * @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
+ */
+declare function mythicKeystoneAffixMedia(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixMediaResponse>;
+//#endregion
+export { MythicKeystoneAffixMediaResponse as a, MythicKeystoneAffixIndexResponse as i, mythicKeystoneAffixIndex as n, MythicKeystoneAffixResponse as o, mythicKeystoneAffixMedia as r, mythicKeystoneAffix as t };
+//# sourceMappingURL=index-Bd_PavJU.d.ts.map

package/dist/index-BgkVcJkr2.d.ts

@@ -0,0 +1,60 @@
+import { KeyBase, MediaAsset, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/pvp-tier/types.d.ts
+/**
+ * The response for a PvP tier index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpTierIndexResponse extends ResponseBase {
+  tiers: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a PvP tier media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpTierMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a PvP tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PvpTierResponse extends ResponseBase {
+  bracket: Bracket;
+  id: number;
+  max_rating: number;
+  media: Media;
+  min_rating: number;
+  name: null | string;
+  rating_type: number;
+}
+interface Bracket {
+  id: number;
+  type: string;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+//#endregion
+//#region src/pvp-tier/index.d.ts
+/**
+ * Get a PvP tier by ID.
+ * @param pvpTierId The PvP tier ID.
+ * @returns The PvP tier. See {@link PvpTierResponse}.
+ */
+declare function pvpTier(pvpTierId: number): Resource<PvpTierResponse>;
+/**
+ * Get a PvP tier index.
+ * @returns The PvP tier index. See {@link PvpTierIndexResponse}.
+ */
+declare function pvpTierIndex(): Resource<PvpTierIndexResponse>;
+/**
+ * Get PvP tier media by ID.
+ * @param pvpTierId The PvP tier ID.
+ * @returns The PvP tier media. See {@link PvpTierMediaResponse}.
+ */
+declare function pvpTierMedia(pvpTierId: number): Resource<PvpTierMediaResponse>;
+//#endregion
+export { PvpTierMediaResponse as a, PvpTierIndexResponse as i, pvpTierIndex as n, PvpTierResponse as o, pvpTierMedia as r, pvpTier as t };
+//# sourceMappingURL=index-BgkVcJkr2.d.ts.map

package/dist/index-BuORTLmA.d.ts

@@ -0,0 +1,29 @@
+import { Character, Href, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-quests/types.d.ts
+interface CharacterCompletedQuestsResponse extends ResponseBase {
+  character: Character;
+  quests: Array<NameIdKey>;
+}
+interface CharacterQuestsResponse extends ResponseBase {
+  character: Character;
+  completed: Href;
+  in_progress: Array<NameIdKey>;
+}
+//#endregion
+//#region src/character-quests/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a list of quests that a character has completed.
+ */
+declare function characterCompletedQuests(realmSlug: string, characterName: string): Resource<CharacterCompletedQuestsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param characterName The lowercase name of the character.
+ * @returns a character's active quests as well as a link to the character's completed quests.
+ */
+declare function characterQuests(realmSlug: string, characterName: string): Resource<CharacterQuestsResponse>;
+//#endregion
+export { CharacterQuestsResponse as i, characterQuests as n, CharacterCompletedQuestsResponse as r, characterCompletedQuests as t };
+//# sourceMappingURL=index-BuORTLmA.d.ts.map

package/dist/index-C2BXkcO8.d.ts

@@ -0,0 +1,36 @@
+import { Character, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/character-reputations/types.d.ts
+interface CharacterReputationsSummaryResponse extends ResponseBase {
+  character: Character;
+  reputations: Array<Reputation>;
+}
+interface Paragon {
+  max: number;
+  raw: number;
+  value: number;
+}
+interface Reputation {
+  faction: NameIdKey;
+  paragon?: Paragon;
+  standing: Standing;
+}
+interface Standing {
+  max: number;
+  name: string;
+  raw: number;
+  renown_level?: number;
+  tier?: number;
+  value: number;
+}
+//#endregion
+//#region src/character-reputations/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 reputations.
+ */
+declare function characterReputationsSummary(realmSlug: string, characterName: string): Resource<CharacterReputationsSummaryResponse>;
+//#endregion
+export { CharacterReputationsSummaryResponse as n, characterReputationsSummary as t };
+//# sourceMappingURL=index-C2BXkcO8.d.ts.map

package/dist/index-C9JT3jCN2.d.ts

@@ -0,0 +1,77 @@
+import { GenderName, KeyBase, MediaAsset, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/playable-specialization/types.d.ts
+/**
+ * The response for a playable specialization index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableSpecializationIndexResponse extends ResponseBase {
+  character_specializations: Array<NameIdKey>;
+  pet_specializations: Array<NameIdKey>;
+}
+/**
+ * The response for a playable specialization media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableSpecializationMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a playable specialization.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface PlayableSpecializationResponse extends NameId, ResponseBase {
+  gender_description: GenderName;
+  hero_talent_trees: Array<NullishNameIdKey>;
+  media: Media;
+  playable_class: NameIdKey;
+  power_type: NameIdKey;
+  primary_stat_type: PrimaryStatType;
+  pvp_talents: Array<PvpTalent>;
+  role: PrimaryStatType;
+  spec_talent_tree: SpecTalentTree;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface PrimaryStatType {
+  name: string;
+  type: string;
+}
+interface PvpTalent {
+  spell_tooltip: SpellTooltip;
+  talent: NameIdKey;
+}
+interface SpecTalentTree extends KeyBase {
+  name: string;
+}
+interface SpellTooltip {
+  cast_time: string;
+  cooldown?: string;
+  description: string;
+  power_cost?: null | string;
+  range?: string;
+}
+//#endregion
+//#region src/playable-specialization/index.d.ts
+/**
+ * Get a playable specialization by ID.
+ * @param specializationId The playable specialization ID.
+ * @returns The playable specialization. See {@link PlayableSpecializationResponse}.
+ */
+declare function playableSpecialization(specializationId: number): Resource<PlayableSpecializationResponse>;
+/**
+ * Get a playable specialization index.
+ * @returns The playable specialization index. See {@link PlayableSpecializationIndexResponse}.
+ */
+declare function playableSpecializationIndex(): Resource<PlayableSpecializationIndexResponse>;
+/**
+ * Get a playable specialization media by ID.
+ * @param specializationId The playable specialization ID.
+ * @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
+ */
+declare function playableSpecializationMedia(specializationId: number): Resource<PlayableSpecializationMediaResponse>;
+//#endregion
+export { PlayableSpecializationMediaResponse as a, PlayableSpecializationIndexResponse as i, playableSpecializationIndex as n, PlayableSpecializationResponse as o, playableSpecializationMedia as r, playableSpecialization as t };
+//# sourceMappingURL=index-C9JT3jCN2.d.ts.map