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

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

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

//#region src/mythic-keystone-dungeon/types.d.ts
/**
 * The response for a Mythic Keystone dungeon index.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystoneDungeonIndexResponse extends ResponseBase {
  dungeons: Array<NameIdKey>;
}
/**
 * The response for a Mythic Keystone dungeon.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystoneDungeonResponse extends NameId, ResponseBase {
  dungeon: NameIdKey;
  is_tracked: boolean;
  keystone_upgrades: Array<KeystoneUpgrade>;
  map: NameId;
  zone: Zone;
}
/**
 * The response for a Mythic Keystone index.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystoneIndexResponse extends ResponseBase {
  dungeons: Href;
  seasons: Href;
}
/**
 * The response for a Mythic Keystone period index.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystonePeriodIndexResponse extends ResponseBase {
  current_period: Period;
  periods: Array<Period>;
}
/**
 * The response for a Mythic Keystone period.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystonePeriodResponse extends ResponseBase {
  end_timestamp: number;
  id: number;
  start_timestamp: number;
}
/**
 * The response for a Mythic Keystone season index.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystoneSeasonIndexResponse extends ResponseBase {
  current_season: Period;
  seasons: Array<Period>;
}
/**
 * The response for a Mythic Keystone season.
 * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
 */
interface MythicKeystoneSeasonResponse extends ResponseBase {
  end_timestamp?: number;
  id: number;
  periods: Array<Period>;
  season_name: null | string;
  start_timestamp: number;
}
interface KeystoneUpgrade {
  qualifying_duration: number;
  upgrade_level: number;
}
interface Period extends KeyBase {
  id: number;
}
interface Zone {
  slug: string;
}
//#endregion
//#region src/mythic-keystone-dungeon/index.d.ts
/**
 * Get a Mythic Keystone dungeon by ID.
 * @param mythicKeystoneDungeonId The Mythic Keystone dungeon ID.
 * @returns The Mythic Keystone dungeon. See {@link MythicKeystoneDungeonResponse}.
 */
declare function mythicKeystoneDungeon(mythicKeystoneDungeonId: number): Resource<MythicKeystoneDungeonResponse>;
/**
 * Get a Mythic Keystone dungeon index.
 * @returns The Mythic Keystone dungeon index. See {@link MythicKeystoneDungeonIndexResponse}.
 */
declare function mythicKeystoneDungeonIndex(): Resource<MythicKeystoneDungeonIndexResponse>;
/**
 * Get a Mythic Keystone index.
 * @returns The Mythic Keystone index. See {@link MythicKeystoneIndexResponse}.
 */
declare function mythicKeystoneIndex(): Resource<MythicKeystoneIndexResponse>;
/**
 * Get a Mythic Keystone period by ID.
 * @param mythicKeystonePeriodId The Mythic Keystone period ID.
 * @returns The Mythic Keystone period. See {@link MythicKeystonePeriodResponse}.
 */
declare function mythicKeystonePeriod(mythicKeystonePeriodId: number): Resource<MythicKeystonePeriodResponse>;
/**
 * Get a Mythic Keystone period index.
 * @returns The Mythic Keystone period index. See {@link MythicKeystonePeriodIndexResponse}.
 */
declare function mythicKeystonePeriodIndex(): Resource<MythicKeystonePeriodIndexResponse>;
/**
 * Get a Mythic Keystone season by ID.
 * @param mythicKeystoneSeasonId The Mythic Keystone season ID.
 * @returns The Mythic Keystone season. See {@link MythicKeystoneSeasonResponse}.
 */
declare function mythicKeystoneSeason(mythicKeystoneSeasonId: number): Resource<MythicKeystoneSeasonResponse>;
/**
 * Get a Mythic Keystone season index.
 * @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
 */
declare function mythicKeystoneSeasonIndex(): Resource<MythicKeystoneSeasonIndexResponse>;
//#endregion
export { mythicKeystonePeriodIndex as a, MythicKeystoneDungeonIndexResponse as c, MythicKeystonePeriodIndexResponse as d, MythicKeystonePeriodResponse as f, mythicKeystonePeriod as i, MythicKeystoneDungeonResponse as l, MythicKeystoneSeasonResponse as m, mythicKeystoneDungeonIndex as n, mythicKeystoneSeason as o, MythicKeystoneSeasonIndexResponse as p, mythicKeystoneIndex as r, mythicKeystoneSeasonIndex as s, mythicKeystoneDungeon as t, MythicKeystoneIndexResponse as u };
//# sourceMappingURL=index-CisDEinP.d.ts.map