@blizzard-api/wow/dist/index-D25lQ0kF.d.ts

A series of helpers to interact with the World of Warcraft Blizzard API

import { Character, Href, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";

//#region src/character-collections/types.d.ts
interface CharacterCollectionsIndexResponse extends ResponseBase {
  character: Character;
  decors: Href;
  heirlooms: Href;
  mounts: Href;
  pets: Href;
  toys: Href;
  transmogs: Href;
}
interface CharacterHeirloomsCollectionSummaryResponse extends ResponseBase {
  heirlooms: Array<Heirloom>;
}
interface CharacterMountsCollectionSummaryResponse extends ResponseBase {
  mounts: Array<Mount>;
}
interface CharacterPetsCollectionSummaryResponse extends ResponseBase {
  pets: Array<Pet>;
  unlocked_battle_pet_slots: number;
}
interface CharacterToysCollectionSummaryResponse extends ResponseBase {
  toys: Array<Toy>;
}
interface CharacterTransmogCollectionSummaryResponse extends ResponseBase {
  appearance_sets: Array<NameIdKey>;
  slots: Array<Slot>;
}
interface Heirloom {
  heirloom: NameIdKey;
  upgrade: {
    level: number;
  };
}
interface Mount {
  is_character_specific?: boolean;
  is_favorite?: boolean;
  is_useable: boolean;
  mount: NameIdKey;
}
interface Pet {
  active_slot?: number;
  creature_display?: KeyBase & {
    id: number;
  };
  id: number;
  is_active?: boolean;
  is_favorite?: boolean;
  level: number;
  name?: string;
  quality: Quality;
  species: NameIdKey;
  stats: Stats;
}
interface Quality {
  name: string;
  type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
}
interface Slot {
  appearances: Array<KeyBase & {
    id: number;
  }>;
  slot: SlotSlot;
}
interface SlotSlot {
  name: string;
  type: string;
}
interface Stats {
  breed_id: number;
  health: number;
  power: number;
  speed: number;
}
interface Toy {
  is_favorite?: boolean;
  toy: NameIdKey;
}
//#endregion
//#region src/character-collections/index.d.ts
/**
 * @param realmSlug The slug of the realm.
 * @param characterName The lowercase name of the character.
 * @returns an index of collection types for a character.
 */
declare function characterCollectionsIndex(realmSlug: string, characterName: string): Resource<CharacterCollectionsIndexResponse>;
/**
 * @param realmSlug The slug of the realm.
 * @param characterName The lowercase name of the character.
 * @returns a summary of the heirlooms a character has obtained.
 */
declare function characterHeirloomsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterHeirloomsCollectionSummaryResponse>;
/**
 * @param realmSlug The slug of the realm.
 * @param characterName The lowercase name of the character.
 * @returns a summary of the mounts a character has obtained.
 */
declare function characterMountsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterMountsCollectionSummaryResponse>;
/**
 * @param realmSlug The slug of the realm.
 * @param characterName The lowercase name of the character.
 * @returns a summary of the battle pets a character has obtained.
 */
declare function characterPetsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterPetsCollectionSummaryResponse>;
/**
 * @param realmSlug The slug of the realm.
 * @param characterName The lowercase name of the character.
 * @returns a summary of the toys a character has obtained.
 */
declare function characterToysCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterToysCollectionSummaryResponse>;
/**
 * @param realmSlug The slug of the realm.
 * @param characterName The lowercase name of the character.
 * @returns a summary of the transmog unlocks a character has obtained.
 */
declare function characterTransmogCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterTransmogCollectionSummaryResponse>;
//#endregion
export { characterToysCollectionSummary as a, CharacterHeirloomsCollectionSummaryResponse as c, CharacterToysCollectionSummaryResponse as d, CharacterTransmogCollectionSummaryResponse as f, characterPetsCollectionSummary as i, CharacterMountsCollectionSummaryResponse as l, characterHeirloomsCollectionSummary as n, characterTransmogCollectionSummary as o, characterMountsCollectionSummary as r, CharacterCollectionsIndexResponse as s, characterCollectionsIndex as t, CharacterPetsCollectionSummaryResponse as u };
//# sourceMappingURL=index-D25lQ0kF.d.ts.map