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

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

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