@blizzard-api/wow 3.0.6 → 4.0.1

package/dist/index-CE4iGLJf2.d.ts

@@ -0,0 +1,128 @@
+import { KeyBase, MediaAsset, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/profession/types.d.ts
+/**
+ * The response for a profession index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionIndexResponse extends ResponseBase {
+  professions: Array<NameIdKey>;
+}
+/**
+ * The response for a profession media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a profession.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionResponse extends NameId, ResponseBase {
+  description: string;
+  media: Media;
+  skill_tiers: Array<NameIdKey>;
+  type: Type;
+}
+/**
+ * The response for a profession skill tier.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface ProfessionSkillTierResponse extends NameId, ResponseBase {
+  categories: Array<Category>;
+  maximum_skill_level: number;
+  minimum_skill_level: number;
+}
+/**
+ * The response for a recipe media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RecipeMediaResponse extends ResponseBase {
+  assets: Array<MediaAsset>;
+  id: number;
+}
+/**
+ * The response for a recipe.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface RecipeResponse extends NameId, ResponseBase {
+  alliance_crafted_item?: NameIdKey;
+  crafted_item?: NameIdKey;
+  crafted_quantity?: CraftedQuantity;
+  description?: string;
+  horde_crafted_item?: NameIdKey;
+  media: Media;
+  modified_crafting_slots?: Array<ModifiedCraftSlot>;
+  rank?: number;
+  reagents?: Array<Reagent>;
+}
+interface Category {
+  name: string;
+  recipes: Array<NullishNameIdKey>;
+}
+interface CraftedQuantity {
+  maximum?: number;
+  minimum?: number;
+  value?: number;
+}
+interface Media extends KeyBase {
+  id: number;
+}
+interface ModifiedCraftSlot {
+  display_order: number;
+  slot_type: KeyBase & {
+    id: number;
+    name?: string;
+  };
+}
+interface Reagent {
+  quantity: number;
+  reagent: NameIdKey;
+}
+interface Type {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region src/profession/index.d.ts
+/**
+ * Get a profession by ID.
+ * @param professionId The profession ID.
+ * @returns The profession. See {@link ProfessionResponse}.
+ */
+declare function profession(professionId: number): Resource<ProfessionResponse>;
+/**
+ * Get a profession index.
+ * @returns The profession index. See {@link ProfessionIndexResponse}.
+ */
+declare function professionIndex(): Resource<ProfessionIndexResponse>;
+/**
+ * Get profession media by ID.
+ * @param professionId The profession ID.
+ * @returns The profession media. See {@link ProfessionMediaResponse}.
+ */
+declare function professionMedia(professionId: number): Resource<ProfessionMediaResponse>;
+/**
+ * Get a profession's skill tier by ID.
+ * @param professionId The profession ID.
+ * @param skillTierId The skill tier ID.
+ * @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
+ */
+declare function professionSkillTier(professionId: number, skillTierId: number): Resource<ProfessionSkillTierResponse>;
+/**
+ * Get a recipe by ID.
+ * @param recipeId The recipe ID.
+ * @returns The recipe. See {@link RecipeResponse}.
+ */
+declare function recipe(recipeId: number): Resource<RecipeResponse>;
+/**
+ * Get recipe media by ID.
+ * @param recipeId The recipe ID.
+ * @returns The recipe media. See {@link RecipeMediaResponse}.
+ */
+declare function recipeMedia(recipeId: number): Resource<RecipeMediaResponse>;
+//#endregion
+export { recipe as a, ProfessionMediaResponse as c, RecipeMediaResponse as d, RecipeResponse as f, professionSkillTier as i, ProfessionResponse as l, professionIndex as n, recipeMedia as o, professionMedia as r, ProfessionIndexResponse as s, profession as t, ProfessionSkillTierResponse as u };
+//# sourceMappingURL=index-CE4iGLJf2.d.ts.map

package/dist/index-CH3CudPP.d.ts

@@ -0,0 +1,91 @@
+import { BaseSearchParameters, Faction, Factions, KeyBase, Locales, NameIdKey, NullishNameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
+
+//#region src/mount/types.d.ts
+/**
+ * The response for a mount index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MountIndexResponse extends ResponseBase {
+  mounts: Array<NullishNameIdKey>;
+}
+/**
+ * The response for a mount.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface MountResponse extends ResponseBase {
+  creature_displays: Array<CreatureDisplay>;
+  description: null | string;
+  faction?: Faction;
+  id: number;
+  name: string;
+  requirements?: {
+    classes?: Array<NameIdKey>;
+    faction?: Faction;
+    races?: Array<NameIdKey>;
+  };
+  should_exclude_if_uncollected?: boolean;
+  source?: Source;
+}
+/**
+ * The search parameters for mounts.
+ * @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 MountSearchParameters extends BaseSearchParameters {
+  locale: Locales;
+  name: string;
+}
+/**
+ * The response for a mount 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 MountSearchResponse extends SearchResponseWithoutResults {
+  results: Array<MountSearchResponseItem>;
+}
+interface CreatureDisplay extends KeyBase {
+  id: number;
+}
+interface MountSearchResponseItem extends KeyBase {
+  data: {
+    creature_displays: Array<{
+      id: number;
+    }>;
+    faction?: {
+      name: Record<Locales, string>;
+      type: Factions;
+    };
+    id: number;
+    name: Record<Locales, string>;
+    source: {
+      name: Record<Locales, string>;
+      type: string;
+    };
+  };
+}
+interface Source {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region src/mount/index.d.ts
+/**
+ * Get a mount by ID.
+ * @param mountId The mount ID.
+ * @returns The mount. See {@link MountResponse}.
+ */
+declare function mount(mountId: number): Resource<MountResponse>;
+/**
+ * Get a mount index.
+ * @returns The mount index. See {@link MountIndexResponse}.
+ */
+declare function mountIndex(): Resource<MountIndexResponse>;
+/**
+ * Get a mount search.
+ * @param options The search parameters. See {@link MountSearchParameters}.
+ * @returns The search results. See {@link MountSearchResponse}.
+ */
+declare function mountSearch(options: MountSearchParameters): Resource<MountSearchResponse, Omit<MountSearchParameters, 'locale' | 'name'>>;
+//#endregion
+export { MountResponse as a, MountIndexResponse as i, mountIndex as n, MountSearchParameters as o, mountSearch as r, MountSearchResponse as s, mount as t };
+//# sourceMappingURL=index-CH3CudPP.d.ts.map

package/dist/index-CJSqSpru.d.ts

@@ -0,0 +1,145 @@
+import { Character, Color, Faction, Factions, Href, KeyBase, NameIdKey, Realm, Resource, ResponseBase } from "@blizzard-api/core";
+
+//#region src/guild/types.d.ts
+interface GuildAchievementsResponse extends ResponseBase {
+  achievements: Array<Achievement>;
+  category_progress: Array<CategoryProgress>;
+  guild: Guild;
+  recent_events: Array<RecentEvent>;
+  total_points: number;
+  total_quantity: number;
+}
+interface GuildActivityResponse extends ResponseBase {
+  activities: Array<ActivityElement>;
+  guild: Guild;
+}
+interface GuildResponse extends ResponseBase {
+  achievement_points: number;
+  achievements: Href;
+  activity: Href;
+  created_timestamp: number;
+  crest: Crest;
+  faction: Faction;
+  id: number;
+  member_count: number;
+  name: string;
+  name_search: string;
+  realm: Realm;
+  roster: Href;
+}
+interface GuildRosterResponse extends ResponseBase {
+  guild: Guild;
+  members: Array<Member>;
+}
+interface Achievement {
+  achievement: NameIdKey;
+  completed_timestamp?: number;
+  criteria?: Criteria;
+  id: number;
+}
+interface ActivityElement {
+  activity: {
+    type: string;
+  };
+  character_achievement?: CharacterAchievement;
+  encounter_completed?: EncounterActivity;
+  timestamp: number;
+}
+interface Border {
+  color: RgbWithId;
+  id: number;
+  media: KeyBase & {
+    id: number;
+  };
+}
+interface CategoryProgress {
+  category: NameIdKey;
+  points: number;
+  quantity: number;
+}
+interface CharacterAchievement {
+  achievement: NameIdKey;
+  character: Character;
+}
+interface ChildCriterum {
+  amount: number;
+  id: number;
+  is_completed: boolean;
+}
+interface Crest {
+  background: {
+    color: RgbWithId;
+  };
+  border: Border;
+  emblem: Border;
+}
+interface Criteria {
+  amount?: number;
+  child_criteria?: Array<ChildCriterum>;
+  id: number;
+  is_completed: boolean;
+}
+interface EncounterActivity {
+  encounter: NameIdKey;
+  mode: {
+    name: string;
+    type: ModeType;
+  };
+}
+interface Guild extends NameIdKey {
+  faction: Faction;
+  realm: Realm;
+}
+interface Member {
+  character: RosterMemberCharacter;
+  rank: number;
+}
+type ModeType = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
+interface Playable extends KeyBase {
+  id: number;
+}
+interface RecentEvent {
+  achievement: NameIdKey;
+  timestamp: number;
+}
+interface RgbWithId {
+  id: number;
+  rgba: Color;
+}
+interface RosterMemberCharacter extends Character {
+  faction: {
+    type: Factions;
+  };
+  level: number;
+  playable_class: Playable;
+  playable_race: Playable;
+}
+//#endregion
+//#region src/guild/index.d.ts
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild by its name and realm.
+ */
+declare function guild(realmSlug: string, nameSlug: string): Resource<GuildResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's achievements by name and realm.
+ */
+declare function guildAchievements(realmSlug: string, nameSlug: string): Resource<GuildAchievementsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's activity by name and realm.
+ */
+declare function guildActivity(realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's roster by its name and realm.
+ */
+declare function guildRoster(realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
+//#endregion
+export { GuildAchievementsResponse as a, GuildRosterResponse as c, guildRoster as i, guildAchievements as n, GuildActivityResponse as o, guildActivity as r, GuildResponse as s, guild as t };
+//# sourceMappingURL=index-CJSqSpru.d.ts.map

package/dist/index-CMDZfaJk.d.ts

@@ -0,0 +1,161 @@
+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>;
+  quests?: 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-CMDZfaJk.d.ts.map