@blizzard-api/wow/dist/index-s-cdLa6h2.d.ts

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

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-s-cdLa6h2.d.ts.map