@blizzard-api/classic-wow
Version:
A series of helpers to interact with the World of Warcraft Classic Blizzard API
31 lines (30 loc) • 1.27 kB
TypeScript
import { BlizzardNamespaces, Character, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
//#region src/character-hunter-pets/types.d.ts
interface CharacterHunterPetsSummaryResponse extends ResponseBase {
character: Character;
hunter_pets: Array<HunterPet>;
}
interface HunterPet {
creature: NameIdKey;
creature_display: KeyBase & {
id: number;
};
is_active?: boolean;
is_summoned?: boolean;
level: number;
name: string;
slot: number;
}
//#endregion
//#region src/character-hunter-pets/index.d.ts
/**
* If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param realmSlug The slug of the realm.
* @param characterName The lowercase name of the character.
* @returns a summary of the character's hunter pets.
*/
declare function characterHunterPetsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
//#endregion
export { CharacterHunterPetsSummaryResponse as n, characterHunterPetsSummary as t };
//# sourceMappingURL=index-BtfmrbYY.d.ts.map