@blizzard-api/d3 0.1.6 → 1.0.1

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 import { Resource } from '@blizzard-api/core';
 
+interface ActIndexResponse {
+    acts: Array<Act$1>;
+}
 interface ActResponse {
     name: string;
     number: number;
     quests: Array<Quest>;
     slug: string;
 }
-interface ActIndexResponse {
-    acts: Array<Act$1>;
-}
 interface Act$1 {
     name: string;
     number: number;
@@ -30,15 +30,7 @@ interface ArtisanResponse {
     slug: string;
     training: Training;
 }
-interface Training {
-    tiers: Array<Tier>;
-}
-interface Tier {
-    taughtRecipes: Array<Recipe>;
-    tier: number;
-    trainedRecipes: Array<Recipe>;
-}
-interface Recipe {
+interface RecipeResponse {
     cost: number;
     id: string;
     itemProduced: Item$1;
@@ -57,7 +49,7 @@ interface Reagent$1 {
     item: Item$1;
     quantity: number;
 }
-interface RecipeResponse {
+interface Recipe {
     cost: number;
     id: string;
     itemProduced: Item$1;
@@ -65,6 +57,14 @@ interface RecipeResponse {
     reagents: Array<Reagent$1>;
     slug: string;
 }
+interface Tier {
+    taughtRecipes: Array<Recipe>;
+    tier: number;
+    trainedRecipes: Array<Recipe>;
+}
+interface Training {
+    tiers: Array<Tier>;
+}
 
 declare function artisan(artisanSlug: string): Resource<ArtisanResponse>;
 declare function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse>;
@@ -78,9 +78,17 @@ interface CharacterClassResponse {
     skills: Record<'active' | 'passive', Array<Skill$2>>;
     slug: string;
 }
-interface SkillCategory {
+interface SkillResponse {
+    runes: Array<Rune$1>;
+    skill: Skill$2;
+}
+interface Rune$1 {
+    description: string;
+    descriptionHtml: string;
+    level: number;
     name: string;
     slug: string;
+    type: string;
 }
 interface Skill$2 {
     description: string;
@@ -92,17 +100,9 @@ interface Skill$2 {
     slug: string;
     tooltipUrl: string;
 }
-interface SkillResponse {
-    runes: Array<Rune$1>;
-    skill: Skill$2;
-}
-interface Rune$1 {
-    description: string;
-    descriptionHtml: string;
-    level: number;
+interface SkillCategory {
     name: string;
     slug: string;
-    type: string;
 }
 
 declare function characterClass(characterClassSlug: string): Resource<CharacterClassResponse>;
@@ -138,6 +138,32 @@ interface ResponseBase {
     };
 }
 
+interface EraIndexResponse extends ResponseBase {
+    current_era: number;
+    era: Array<{
+        href: string;
+    }>;
+    generated_by: string;
+    last_update_time: string;
+}
+interface EraLeaderboardResponse extends ResponseBase {
+    column: Array<Column>;
+    era: number;
+    generated_by: string;
+    greater_rift: boolean;
+    greater_rift_solo_class: string;
+    key: string;
+    last_update_time: string;
+    row: Array<Row>;
+    title: string;
+}
+interface EraResponse extends ResponseBase {
+    era_id: number;
+    era_start_date: number;
+    generated_by: string;
+    last_update_time: string;
+    leaderboard: Array<EraLeaderboard>;
+}
 interface SeasonIndexResponse extends ResponseBase {
     current_season: number;
     generated_by: string;
@@ -148,20 +174,6 @@ interface SeasonIndexResponse extends ResponseBase {
     service_current_season: number;
     service_season_state: string;
 }
-interface SeasonResponse extends ResponseBase {
-    generated_by: string;
-    last_update_time: string;
-    leaderboard: Array<Leaderboard>;
-    season_id: number;
-}
-interface Leaderboard {
-    hardcore?: boolean;
-    hero_class_string?: string;
-    ladder: {
-        href: string;
-    };
-    team_size?: number;
-}
 interface SeasonLeaderboardResponse extends ResponseBase {
     achievement_points: boolean;
     column: Array<Column>;
@@ -172,6 +184,12 @@ interface SeasonLeaderboardResponse extends ResponseBase {
     season: number;
     title: string;
 }
+interface SeasonResponse extends ResponseBase {
+    generated_by: string;
+    last_update_time: string;
+    leaderboard: Array<Leaderboard>;
+    season_id: number;
+}
 interface Column {
     hidden: boolean;
     id: LeaderboardId;
@@ -179,7 +197,26 @@ interface Column {
     order?: number;
     type: 'DATETIME' | 'NUMBER' | 'STRING';
 }
+interface EraLeaderboard {
+    hardcore?: boolean;
+    hero_class_string?: string;
+    ladder: Self;
+    team_size: number;
+}
+interface Leaderboard {
+    hardcore?: boolean;
+    hero_class_string?: string;
+    ladder: {
+        href: string;
+    };
+    team_size?: number;
+}
 type LeaderboardId = 'AchievementPoints' | 'BattleTag' | 'ClanName' | 'CompletedTime' | 'GameAccount' | 'HeroBattleTag' | 'HeroClanTag' | 'HeroClass' | 'HeroGender' | 'HeroId' | 'HeroLevel' | 'HeroVisualItems' | 'ParagonLevel' | 'Rank' | 'RiftLevel' | 'RiftTime';
+interface Player {
+    accountId: number;
+    data: Array<RowData>;
+    key: string;
+}
 interface Row {
     data: Array<RowData>;
     order: number;
@@ -191,54 +228,38 @@ interface RowData {
     string?: string;
     timestamp?: number;
 }
-interface Player {
-    accountId: number;
-    data: Array<RowData>;
-    key: string;
-}
-interface EraIndexResponse extends ResponseBase {
-    current_era: number;
-    era: Array<{
-        href: string;
-    }>;
-    generated_by: string;
-    last_update_time: string;
-}
-interface EraResponse extends ResponseBase {
-    era_id: number;
-    era_start_date: number;
-    generated_by: string;
-    last_update_time: string;
-    leaderboard: Array<EraLeaderboard>;
-}
 interface Self {
     href: string;
 }
-interface EraLeaderboard {
-    hardcore?: boolean;
-    hero_class_string?: string;
-    ladder: Self;
-    team_size: number;
-}
-interface EraLeaderboardResponse extends ResponseBase {
-    column: Array<Column>;
-    era: number;
-    generated_by: string;
-    greater_rift: boolean;
-    greater_rift_solo_class: string;
-    key: string;
-    last_update_time: string;
-    row: Array<Row>;
-    title: string;
-}
 
-declare function seasonIndex(): Resource<SeasonIndexResponse>;
-declare function season(id: number): Resource<SeasonResponse>;
-declare function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse>;
-declare function eraIndex(): Resource<EraIndexResponse>;
 declare function era(id: number): Resource<EraResponse>;
+declare function eraIndex(): Resource<EraIndexResponse>;
 declare function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse>;
+declare function season(id: number): Resource<SeasonResponse>;
+declare function seasonIndex(): Resource<SeasonIndexResponse>;
+declare function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse>;
+
+interface ItemTypeIndexResponse {
+    id: string;
+    name: string;
+    path: string;
+}
+interface ItemTypeResponse {
+    icon: string;
+    id: string;
+    name: string;
+    path: string;
+    slug: string;
+}
+
+declare function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>>;
+declare function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>>;
 
+interface Attributes$1 {
+    other: Array<unknown>;
+    primary: Array<Primary>;
+    secondary: Array<Primary>;
+}
 interface ItemResponse {
     accountBound: boolean;
     attributes: Attributes$1;
@@ -263,11 +284,6 @@ interface ItemResponse {
     type: Type;
     typeName: string;
 }
-interface Attributes$1 {
-    other: Array<unknown>;
-    primary: Array<Primary>;
-    secondary: Array<Primary>;
-}
 interface Primary {
     text: string;
     textHtml: string;
@@ -282,22 +298,62 @@ interface Type {
 
 declare function item(itemSlugAndId: string): Resource<ItemResponse>;
 
-interface ItemTypeIndexResponse {
-    id: string;
-    name: string;
-    path: string;
+interface AccountHeroFollowerItemsResponse {
+    enchantress: Record<string, FollowerItem>;
+    scoundrel: Record<string, FollowerItem>;
+    templar: Record<string, FollowerItem>;
 }
-interface ItemTypeResponse {
+interface AccountHeroItemsResponse {
+    accountBound: boolean;
+    armor: number;
+    attacksPerSecond: number;
+    attributes: Attributes;
+    attributesHtml: Attributes;
+    craftedBy?: CraftedBy;
+    damage?: string;
+    displayColor: DisplayColor;
+    dps?: string;
+    elementalType?: string;
+    flavorText: string;
+    gems?: Array<Gem>;
     icon: string;
     id: string;
+    isSeasonRequiredToDrop: boolean;
+    itemLevel: number;
+    maxDamage: number;
+    minDamage: number;
     name: string;
-    path: string;
-    slug: string;
+    openSockets: number;
+    requiredLevel: number;
+    seasonRequiredToDrop: number;
+    set?: Set;
+    slots: string;
+    stackSizeMax: number;
+    tooltipParams: string;
+    type: Record<string, boolean | string>;
+    typeName: string;
+}
+interface AccountHeroResponse {
+    alive: boolean;
+    class: string;
+    followers: Followers;
+    gender: number;
+    hardcore: boolean;
+    highestSoloRiftCompleted: number;
+    id: number;
+    items: Record<string, Item>;
+    kills: Kills;
+    lastUpdated: number;
+    legendaryPowers: Array<Item>;
+    level: number;
+    name: string;
+    paragonLevel: number;
+    progression: HeroProgression;
+    seasonal: boolean;
+    seasonCreated: number;
+    skills: Skills;
+    stats: Record<string, number>;
 }
-
-declare function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>>;
-declare function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>>;
-
 interface AccountResponse {
     battleTag: string;
     blacksmith: Artisan;
@@ -326,191 +382,76 @@ interface AccountResponse {
     seasonalProfiles: Record<`season${number}`, Season>;
     timePlayed: TimePlayed;
 }
-interface Artisan {
-    level: number;
-    slug: 'blacksmith' | 'jeweler' | 'mystic';
-}
-interface Hero {
-    class: string;
-    classSlug: string;
-    dead: boolean;
-    gender: number;
-    hardcore: boolean;
-    id: number;
-    kills: HeroKills;
-    'last-updated': number;
-    level: number;
-    name: string;
-    paragonLevel: number;
-    seasonal: boolean;
-}
-interface HeroKills {
-    elites: number;
+interface AccountHeroItem {
+    icon: string;
+    id: string;
+    name: string;
+    path: string;
+    slug: string;
 }
 interface AccountResponseKills {
     elites: number;
     hardcoreMonsters: number;
     monsters: number;
 }
-interface Progression {
-    act1: boolean;
-    act2: boolean;
-    act3: boolean;
-    act4: boolean;
-    act5: boolean;
-}
-interface Season {
-    highestHardcoreLevel: number;
-    kills: AccountResponseKills;
-    paragonLevel: number;
-    paragonLevelHardcore: number;
-    seasonId: number;
-    timePlayed: TimePlayed;
+interface Act {
+    completed: boolean;
+    completedQuests: Array<CompletedQuest>;
 }
-interface TimePlayed {
-    barbarian: number;
-    crusader: number;
-    'demon-hunter': number;
-    monk: number;
-    necromancer: number;
-    'witch-doctor': number;
-    wizard: number;
+interface Active {
+    rune: Rune;
+    skill: Skill;
 }
-interface AccountHeroResponse {
-    alive: boolean;
-    class: string;
-    followers: Followers;
-    gender: number;
-    hardcore: boolean;
-    highestSoloRiftCompleted: number;
-    id: number;
-    items: Record<string, Item>;
-    kills: Kills;
-    lastUpdated: number;
-    legendaryPowers: Array<Item>;
+interface Artisan {
     level: number;
-    name: string;
-    paragonLevel: number;
-    progression: HeroProgression;
-    seasonal: boolean;
-    seasonCreated: number;
-    skills: Skills;
-    stats: Record<string, number>;
+    slug: 'blacksmith' | 'jeweler' | 'mystic';
 }
-interface Followers {
-    enchantress: Enchantress;
-    scoundrel: Scoundrel;
-    templar: Templar;
+interface Attributes {
+    primary: Array<string>;
+    secondary?: Array<string>;
 }
-interface Enchantress {
-    items: EnchantressItems;
-    level: number;
-    skills: Array<unknown>;
+interface CompletedQuest {
+    name: string;
     slug: string;
-    stats: Stats;
 }
-interface EnchantressItems {
-    mainHand: Item;
-}
-interface Item {
-    displayColor?: DisplayColor;
-    dyeColor?: Item;
-    icon: string;
+interface CraftedBy {
+    cost: number;
     id: string;
+    itemProduced: ItemProduced;
     name: string;
-    tooltipParams: string;
-}
-interface Stats {
-    experienceBonus: number;
-    goldFind: number;
-    magicFind: number;
-}
-interface Scoundrel {
-    items: Record<string, Item>;
-    level: number;
-    skills: Array<Skill>;
+    reagents: Array<Reagent>;
     slug: string;
-    stats: Stats;
 }
-interface Skill {
-    description: string;
-    descriptionHtml: string;
-    flavorText?: string;
+type DisplayColor = 'blue' | 'green' | 'orange' | 'white' | 'yellow';
+interface Dye {
     icon: string;
-    level: number;
+    id: string;
     name: string;
-    slug: string;
-    tooltipUrl: string;
+    tooltipParams: string;
 }
-interface Templar {
-    items: TemplarItems;
+interface Enchantress {
+    items: EnchantressItems;
     level: number;
-    skills: Array<Skill>;
+    skills: Array<unknown>;
     slug: string;
     stats: Stats;
 }
-interface TemplarItems {
-    bracers: Item;
-    feet: Item;
-    hands: Item;
-    head: Item;
+interface EnchantressItems {
     mainHand: Item;
-    offHand: Item;
-    shoulders: Item;
-    torso: Item;
-    waist: Item;
 }
-interface Kills {
-    elites: number;
-}
-interface HeroProgression {
-    act1: Act;
-    act2: Act;
-    act3: Act;
-    act4: Act;
-    act5: Act;
-}
-interface Act {
-    completed: boolean;
-    completedQuests: Array<CompletedQuest>;
-}
-interface CompletedQuest {
-    name: string;
-    slug: string;
-}
-interface Skills {
-    active: Array<Active>;
-    passive: Array<Passive>;
-}
-interface Active {
-    rune: Rune;
-    skill: Skill;
-}
-interface Rune {
-    description: string;
-    descriptionHtml: string;
-    level: number;
-    name: string;
-    slug: string;
-    type: string;
-}
-interface Passive {
-    skill: Skill;
-}
-type DisplayColor = 'blue' | 'green' | 'orange' | 'white' | 'yellow';
-interface AccountHeroItemsResponse {
+interface FollowerItem {
     accountBound: boolean;
     armor: number;
     attacksPerSecond: number;
-    attributes: Attributes;
-    attributesHtml: Attributes;
+    attributes?: Attributes;
+    attributesHtml?: Attributes;
+    blockChance?: string;
     craftedBy?: CraftedBy;
     damage?: string;
-    displayColor: DisplayColor;
+    displayColor: string;
     dps?: string;
-    elementalType?: string;
-    flavorText: string;
-    gems?: Array<Gem>;
+    dye?: Dye;
+    flavorText?: string;
     icon: string;
     id: string;
     isSeasonRequiredToDrop: boolean;
@@ -528,40 +469,94 @@ interface AccountHeroItemsResponse {
     type: Record<string, boolean | string>;
     typeName: string;
 }
-interface Attributes {
-    primary: Array<string>;
-    secondary?: Array<string>;
+interface Followers {
+    enchantress: Enchantress;
+    scoundrel: Scoundrel;
+    templar: Templar;
 }
-interface CraftedBy {
-    cost: number;
+interface Gem {
+    attributes: Array<string>;
+    isGem: boolean;
+    isJewel: boolean;
+    item: AccountHeroItem;
+    jewelRank?: number;
+    jewelSecondaryUnlockRank?: number;
+}
+interface Hero {
+    class: string;
+    classSlug: string;
+    dead: boolean;
+    gender: number;
+    hardcore: boolean;
+    id: number;
+    kills: HeroKills;
+    'last-updated': number;
+    level: number;
+    name: string;
+    paragonLevel: number;
+    seasonal: boolean;
+}
+interface HeroKills {
+    elites: number;
+}
+interface HeroProgression {
+    act1: Act;
+    act2: Act;
+    act3: Act;
+    act4: Act;
+    act5: Act;
+}
+interface Item {
+    displayColor?: DisplayColor;
+    dyeColor?: Item;
+    icon: string;
     id: string;
-    itemProduced: ItemProduced;
     name: string;
-    reagents: Array<Reagent>;
-    slug: string;
+    tooltipParams: string;
 }
 interface ItemProduced {
     id: string;
     path: string;
 }
+interface Kills {
+    elites: number;
+}
+interface Passive {
+    skill: Skill;
+}
+interface Progression {
+    act1: boolean;
+    act2: boolean;
+    act3: boolean;
+    act4: boolean;
+    act5: boolean;
+}
 interface Reagent {
     item: AccountHeroItem;
     quantity: number;
 }
-interface AccountHeroItem {
-    icon: string;
-    id: string;
+interface Rune {
+    description: string;
+    descriptionHtml: string;
+    level: number;
     name: string;
-    path: string;
     slug: string;
+    type: string;
 }
-interface Gem {
-    attributes: Array<string>;
-    isGem: boolean;
-    isJewel: boolean;
-    item: AccountHeroItem;
-    jewelRank?: number;
-    jewelSecondaryUnlockRank?: number;
+interface Scoundrel {
+    items: Record<string, Item>;
+    level: number;
+    skills: Array<Skill>;
+    slug: string;
+    stats: Stats;
+}
+interface Season {
+    highestHardcoreLevel: number;
+    kills: AccountResponseKills;
+    paragonLevel: number;
+    paragonLevelHardcore: number;
+    seasonId: number;
+    timePlayed: TimePlayed;
 }
 interface Set {
     description: string;
@@ -569,52 +564,57 @@ interface Set {
     name: string;
     slug: string;
 }
-interface AccountHeroFollowerItemsResponse {
-    enchantress: Record<string, FollowerItem>;
-    scoundrel: Record<string, FollowerItem>;
-    templar: Record<string, FollowerItem>;
-}
-interface FollowerItem {
-    accountBound: boolean;
-    armor: number;
-    attacksPerSecond: number;
-    attributes?: Attributes;
-    attributesHtml?: Attributes;
-    blockChance?: string;
-    craftedBy?: CraftedBy;
-    damage?: string;
-    displayColor: string;
-    dps?: string;
-    dye?: Dye;
+interface Skill {
+    description: string;
+    descriptionHtml: string;
     flavorText?: string;
     icon: string;
-    id: string;
-    isSeasonRequiredToDrop: boolean;
-    itemLevel: number;
-    maxDamage: number;
-    minDamage: number;
+    level: number;
     name: string;
-    openSockets: number;
-    requiredLevel: number;
-    seasonRequiredToDrop: number;
-    set?: Set;
-    slots: string;
-    stackSizeMax: number;
-    tooltipParams: string;
-    type: Record<string, boolean | string>;
-    typeName: string;
+    slug: string;
+    tooltipUrl: string;
 }
-interface Dye {
-    icon: string;
-    id: string;
-    name: string;
-    tooltipParams: string;
+interface Skills {
+    active: Array<Active>;
+    passive: Array<Passive>;
+}
+interface Stats {
+    experienceBonus: number;
+    goldFind: number;
+    magicFind: number;
+}
+interface Templar {
+    items: TemplarItems;
+    level: number;
+    skills: Array<Skill>;
+    slug: string;
+    stats: Stats;
+}
+interface TemplarItems {
+    bracers: Item;
+    feet: Item;
+    hands: Item;
+    head: Item;
+    mainHand: Item;
+    offHand: Item;
+    shoulders: Item;
+    torso: Item;
+    waist: Item;
+}
+interface TimePlayed {
+    barbarian: number;
+    crusader: number;
+    'demon-hunter': number;
+    monk: number;
+    necromancer: number;
+    'witch-doctor': number;
+    wizard: number;
 }
 
 declare function account(battleTag: string): Resource<AccountResponse>;
 declare function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
-declare function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
 declare function accountHeroFollowerItems(battleTag: string, heroId: number): Resource<AccountHeroFollowerItemsResponse>;
+declare function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
 
 declare const d3: {
     act: typeof act;