@blizzard-api/wow 4.1.6 → 4.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/dist/account-profile/index.d.ts +2 -2
  2. package/dist/account-profile/index.js +22 -10
  3. package/dist/account-profile/index.js.map +1 -1
  4. package/dist/achievements/index.d.ts +1 -1
  5. package/dist/azerite-essence/index.d.ts +1 -1
  6. package/dist/character-achievements/index.d.ts +1 -1
  7. package/dist/character-achievements/index.js +3 -3
  8. package/dist/character-achievements/index.js.map +1 -1
  9. package/dist/character-appearance/index.d.ts +1 -1
  10. package/dist/character-collections/index.d.ts +2 -2
  11. package/dist/character-collections/index.js +19 -8
  12. package/dist/character-collections/index.js.map +1 -1
  13. package/dist/character-equipment/index.d.ts +1 -1
  14. package/dist/character-house/index.d.ts +2 -0
  15. package/dist/character-house/index.js +22 -0
  16. package/dist/character-house/index.js.map +1 -0
  17. package/dist/character-hunter-pets/index.d.ts +1 -1
  18. package/dist/character-mythic-keystone-profile/index.d.ts +1 -1
  19. package/dist/character-pvp/index.d.ts +1 -1
  20. package/dist/character-soulbinds/index.d.ts +1 -1
  21. package/dist/covenant/index.d.ts +1 -1
  22. package/dist/creature/index.d.ts +1 -1
  23. package/dist/guild/index.d.ts +1 -1
  24. package/dist/guild/index.js +5 -5
  25. package/dist/guild/index.js.map +1 -1
  26. package/dist/guild-crest/index.d.ts +1 -1
  27. package/dist/heirloom/index.d.ts +1 -1
  28. package/dist/housing-decor/index.d.ts +1 -1
  29. package/dist/{index-t9XEyuoB.d.ts → index-0Bhntrik.d.ts} +4 -7
  30. package/dist/{index-C1YdeTeh.d.ts → index-B8gaHbmp.d.ts} +7 -20
  31. package/dist/{index-BXil5dXL.d.ts → index-BA-S_4s8.d.ts} +4 -10
  32. package/dist/{index-fgCzpXCR.d.ts → index-BDKw2T5h.d.ts} +3 -6
  33. package/dist/{index-DwH3cSMV.d.ts → index-BHHO7RV3.d.ts} +3 -6
  34. package/dist/{index-XAI3xA9N.d.ts → index-BKuDd7nT.d.ts} +6 -20
  35. package/dist/{index-CaRIVhVv.d.ts → index-Bz4N9R8o.d.ts} +3 -5
  36. package/dist/{index-BzlqLJ2o.d.ts → index-C9yo07sd.d.ts} +4 -8
  37. package/dist/index-CAAhdmK-.d.ts +25 -0
  38. package/dist/{index-Djm0g1Yi.d.ts → index-CCBUIqOU.d.ts} +5 -10
  39. package/dist/{index-BmPjWZiM.d.ts → index-CT77a0JF.d.ts} +10 -19
  40. package/dist/{index-Mo0Nrg5B.d.ts → index-Cc4oZQrM.d.ts} +5 -14
  41. package/dist/{index-C0vm3zy-.d.ts → index-Cev12iRl.d.ts} +5 -12
  42. package/dist/{index-BM2O2XmC.d.ts → index-CljBIBHy.d.ts} +5 -13
  43. package/dist/{index-C_3k8Q6y.d.ts → index-D317dq94.d.ts} +7 -10
  44. package/dist/{index-BYi-k0bg.d.ts → index-D4WW7V4l.d.ts} +5 -11
  45. package/dist/index-DB-CW2qB.d.ts +42 -0
  46. package/dist/{index-gYxee23q.d.ts → index-DFlcJK5P.d.ts} +3 -6
  47. package/dist/{index-DOEs0UyY.d.ts → index-DGUAqQfD.d.ts} +3 -4
  48. package/dist/{index-D8XusKs5.d.ts → index-DP01g0EB.d.ts} +4 -8
  49. package/dist/{index-CJD7VTCV.d.ts → index-DRLsvfW5.d.ts} +3 -5
  50. package/dist/{index-DxnUqJGs.d.ts → index-DVacJ9ne.d.ts} +6 -15
  51. package/dist/{index-CEF2RBas.d.ts → index-DWXx_hQX.d.ts} +3 -5
  52. package/dist/index-DXJEmC1r.d.ts +115 -0
  53. package/dist/{index-Zo-8eUYk.d.ts → index-Dcoq8HHI.d.ts} +4 -11
  54. package/dist/{index-mg4RaAL2.d.ts → index-DkkhK4mL.d.ts} +3 -6
  55. package/dist/{index-CahuOTZl.d.ts → index-DzFNhtcD.d.ts} +11 -18
  56. package/dist/{index-YDf016Cx.d.ts → index-ECczWYo-.d.ts} +3 -6
  57. package/dist/{index-DE8VhwEW.d.ts → index-FuJJlGI3.d.ts} +24 -26
  58. package/dist/{index-DqReVqKo.d.ts → index-G_mEQkdH.d.ts} +3 -5
  59. package/dist/{index-BT8uSt8c.d.ts → index-Ho48pOyM.d.ts} +4 -11
  60. package/dist/{index-CNnXwh3U.d.ts → index-QcJecti6.d.ts} +22 -26
  61. package/dist/{index-voS2LTm4.d.ts → index-U0fk242w.d.ts} +3 -6
  62. package/dist/{index-DMYMiLKS.d.ts → index-Y2Yt9EzH.d.ts} +3 -5
  63. package/dist/{index-DU34NE5y.d.ts → index-_gTBl2_Y.d.ts} +5 -12
  64. package/dist/{index-CHk_Cxrn.d.ts → index-bl4DdMgs.d.ts} +8 -11
  65. package/dist/{index-CPXZZPZt.d.ts → index-clqZ-M8A.d.ts} +3 -6
  66. package/dist/{index-D9zRWOGv.d.ts → index-eLWbd2FJ.d.ts} +3 -6
  67. package/dist/index.d.ts +52 -36
  68. package/dist/index.js +18 -3
  69. package/dist/index.js.map +1 -1
  70. package/dist/item/index.d.ts +1 -1
  71. package/dist/item-appearance/index.d.ts +2 -0
  72. package/dist/item-appearance/index.js +74 -0
  73. package/dist/item-appearance/index.js.map +1 -0
  74. package/dist/journal/index.d.ts +1 -1
  75. package/dist/mount/index.d.ts +1 -1
  76. package/dist/mythic-keystone-affix/index.d.ts +1 -1
  77. package/dist/mythic-keystone-dungeon/index.d.ts +1 -1
  78. package/dist/mythic-keystone-leaderboard/index.d.ts +1 -1
  79. package/dist/mythic-raid-leaderboard/index.d.ts +1 -1
  80. package/dist/neighborhood-map/index.d.ts +2 -0
  81. package/dist/neighborhood-map/index.js +38 -0
  82. package/dist/neighborhood-map/index.js.map +1 -0
  83. package/dist/pet/index.d.ts +1 -1
  84. package/dist/playable-class/index.d.ts +1 -1
  85. package/dist/playable-specialization/index.d.ts +1 -1
  86. package/dist/profession/index.d.ts +1 -1
  87. package/dist/pvp-season/index.d.ts +1 -1
  88. package/dist/pvp-tier/index.d.ts +1 -1
  89. package/dist/reputations/index.d.ts +1 -1
  90. package/dist/spell/index.d.ts +1 -1
  91. package/dist/talent/index.d.ts +1 -1
  92. package/dist/tech-talent/index.d.ts +1 -1
  93. package/dist/toy/index.d.ts +1 -1
  94. package/dist/types-BihzpfkI.d.ts +18 -0
  95. package/package.json +3 -3
@@ -1,4 +1,4 @@
1
- import { KeyBase, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { IdKey, KeyBase, NameId, NameIdKey, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for a pvp talent index.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -95,9 +95,7 @@ interface ClassTalentNodeRank {
95
95
  }
96
96
  interface HeroTalentTree extends NameId {
97
97
  hero_talent_nodes: Array<HeroTalentTreeNode>;
98
- media: KeyBase & {
99
- id: number;
100
- };
98
+ media: IdKey;
101
99
  playable_class: NameIdKey;
102
100
  playable_specializations: Array<NameIdKey>;
103
101
  }
@@ -225,4 +223,4 @@ declare function talentTreeIndex(): Resource<TalentTreeIndexResponse>;
225
223
  */
226
224
  declare function talentTreeNodes(talentTreeId: number): Resource<TalentTreeNodesResponse>;
227
225
  export { talentTree as a, PvpTalentIndexResponse as c, TalentResponse as d, TalentTreeIndexResponse as f, talentIndex as i, PvpTalentResponse as l, TalentTreeResponse as m, pvpTalentIndex as n, talentTreeIndex as o, TalentTreeNodesResponse as p, talent as r, talentTreeNodes as s, pvpTalent as t, TalentIndexResponse as u };
228
- //# sourceMappingURL=index-CJD7VTCV.d.ts.map
226
+ //# sourceMappingURL=index-DRLsvfW5.d.ts.map
@@ -1,4 +1,4 @@
1
- import { KeyBase, MediaAsset, NameId, NameIdKey, NullishNameId, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { IdKey, MediaAsset, NameId, NameIdKey, NameType, NullishNameId, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for a pet ability index.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -21,7 +21,7 @@ interface PetAbilityMediaResponse extends ResponseBase {
21
21
  interface PetAbilityResponse extends NullishNameId, ResponseBase {
22
22
  battle_pet_type: BattlePetType;
23
23
  cooldown?: number;
24
- media: Media;
24
+ media: IdKey;
25
25
  rounds: number;
26
26
  }
27
27
  /**
@@ -55,25 +55,16 @@ interface PetResponse extends NameId, ResponseBase {
55
55
  is_horde_only: boolean;
56
56
  is_random_creature_display: boolean;
57
57
  is_tradable: boolean;
58
- media: Media;
58
+ media: IdKey;
59
59
  should_exclude_if_uncollected?: boolean;
60
- source?: Source;
60
+ source?: NameType;
61
61
  }
62
62
  interface Ability {
63
63
  ability: NameIdKey;
64
64
  required_level: number;
65
65
  slot: number;
66
66
  }
67
- interface BattlePetType extends NameId {
68
- type: string;
69
- }
70
- interface Media extends KeyBase {
71
- id: number;
72
- }
73
- interface Source {
74
- name: string;
75
- type: string;
76
- }
67
+ interface BattlePetType extends NameId, NameType {}
77
68
  /**
78
69
  * Get a pet by ID.
79
70
  * @param petId The pet ID.
@@ -109,4 +100,4 @@ declare function petIndex(): Resource<PetIndexResponse>;
109
100
  */
110
101
  declare function petMedia(petId: number): Resource<PetMediaResponse>;
111
102
  export { petIndex as a, PetAbilityMediaResponse as c, PetMediaResponse as d, PetResponse as f, petAbilityMedia as i, PetAbilityResponse as l, petAbility as n, petMedia as o, petAbilityIndex as r, PetAbilityIndexResponse as s, pet as t, PetIndexResponse as u };
112
- //# sourceMappingURL=index-DxnUqJGs.d.ts.map
103
+ //# sourceMappingURL=index-DVacJ9ne.d.ts.map
@@ -1,4 +1,4 @@
1
- import { Faction, KeyBase, NameIdKey, NullishNameId, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { Faction, KeyBase, NameId, NameIdKey, NullishNameId, NullishNameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for a reputation faction index.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -47,11 +47,9 @@ interface ReputationTier extends KeyBase {
47
47
  id: number;
48
48
  name?: string;
49
49
  }
50
- interface Tier {
51
- id: number;
50
+ interface Tier extends NameId {
52
51
  max_value: number;
53
52
  min_value: number;
54
- name: string;
55
53
  }
56
54
  /**
57
55
  * Get a reputation faction by ID.
@@ -76,4 +74,4 @@ declare function reputationTiers(reputationTiersId: number): Resource<Reputation
76
74
  */
77
75
  declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
78
76
  export { ReputationFactionIndexResponse as a, ReputationTiersResponse as c, reputationTiersIndex as i, reputationFactionIndex as n, ReputationFactionResponse as o, reputationTiers as r, ReputationTiersIndexResponse as s, reputationFaction as t };
79
- //# sourceMappingURL=index-CEF2RBas.d.ts.map
77
+ //# sourceMappingURL=index-DWXx_hQX.d.ts.map
@@ -0,0 +1,115 @@
1
+ import { BaseSearchParameters, IdKey, KeyBase, Locales, NameIdKey, NullishNameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
2
+ /**
3
+ * The equipment slot types an item appearance can belong to.
4
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
5
+ */
6
+ type ItemAppearanceSlotType = 'AMMO' | 'BAG' | 'BODY' | 'CHEST' | 'CLOAK' | 'FEET' | 'HAND' | 'HEAD' | 'HOLDABLE' | 'LEGS' | 'RANGED' | 'RANGEDRIGHT' | 'ROBE' | 'SHIELD' | 'SHOULDER' | 'TABARD' | 'THROWN' | 'TWOHWEAPON' | 'WAIST' | 'WEAPON' | 'WEAPONMAINHAND' | 'WEAPONOFFHAND' | 'WRIST';
7
+ /**
8
+ * The response for an item appearance.
9
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
10
+ */
11
+ interface ItemAppearanceResponse extends ResponseBase {
12
+ id: number;
13
+ item_class?: NameIdKey;
14
+ item_display_info_id: number;
15
+ item_subclass?: NameIdKey;
16
+ items?: Array<NullishNameIdKey>;
17
+ media: IdKey;
18
+ slot?: ItemAppearanceSlot;
19
+ }
20
+ /**
21
+ * The search parameters for item appearances.
22
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
23
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
24
+ */
25
+ interface ItemAppearanceSearchParameters extends BaseSearchParameters {
26
+ id?: number;
27
+ }
28
+ /**
29
+ * The response for an item appearance search.
30
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
31
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
32
+ */
33
+ interface ItemAppearanceSearchResponse extends SearchResponseWithoutResults {
34
+ results: Array<ItemAppearanceSearchResponseItem>;
35
+ }
36
+ /**
37
+ * The response for an item appearance set index.
38
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
39
+ */
40
+ interface ItemAppearanceSetIndexResponse extends ResponseBase {
41
+ appearance_sets: Array<NameIdKey>;
42
+ }
43
+ /**
44
+ * The response for an item appearance set.
45
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
46
+ */
47
+ interface ItemAppearanceSetResponse extends ResponseBase {
48
+ appearances: Array<IdKey>;
49
+ id: number;
50
+ set_name: string;
51
+ }
52
+ /**
53
+ * The response for an item appearance slot index.
54
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
55
+ */
56
+ interface ItemAppearanceSlotIndexResponse extends ResponseBase {
57
+ slots: Array<KeyBase>;
58
+ }
59
+ /**
60
+ * The response for an item appearance slot.
61
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
62
+ */
63
+ interface ItemAppearanceSlotResponse extends ResponseBase {
64
+ appearances: Array<IdKey>;
65
+ }
66
+ interface ItemAppearanceSearchResponseItem extends KeyBase {
67
+ data: {
68
+ id: number;
69
+ item_display_info_id: number;
70
+ slot?: {
71
+ name: Record<Locales, string | undefined>;
72
+ type: ItemAppearanceSlotType;
73
+ };
74
+ };
75
+ }
76
+ interface ItemAppearanceSlot {
77
+ name: string;
78
+ type: ItemAppearanceSlotType;
79
+ }
80
+ /**
81
+ * Get an item appearance by ID.
82
+ * @param appearanceId The item appearance ID.
83
+ * @returns The item appearance. See {@link ItemAppearanceResponse}.
84
+ */
85
+ declare function itemAppearance(appearanceId: number): Resource<ItemAppearanceResponse>;
86
+ /**
87
+ * Search for item appearances.
88
+ * @param options The search parameters. See {@link ItemAppearanceSearchParameters}.
89
+ * @returns The search results. See {@link ItemAppearanceSearchResponse}.
90
+ */
91
+ declare function itemAppearanceSearch(options: ItemAppearanceSearchParameters): Resource<ItemAppearanceSearchResponse, ItemAppearanceSearchParameters>;
92
+ /**
93
+ * Get an item appearance set by ID.
94
+ * @param appearanceSetId The item appearance set ID.
95
+ * @returns The item appearance set. See {@link ItemAppearanceSetResponse}.
96
+ */
97
+ declare function itemAppearanceSet(appearanceSetId: number): Resource<ItemAppearanceSetResponse>;
98
+ /**
99
+ * Get an item appearance set index.
100
+ * @returns The item appearance set index. See {@link ItemAppearanceSetIndexResponse}.
101
+ */
102
+ declare function itemAppearanceSetIndex(): Resource<ItemAppearanceSetIndexResponse>;
103
+ /**
104
+ * Get an item appearance slot by slot type.
105
+ * @param slotType The item appearance slot type.
106
+ * @returns The item appearance slot. See {@link ItemAppearanceSlotResponse}.
107
+ */
108
+ declare function itemAppearanceSlot(slotType: ItemAppearanceSlotType): Resource<ItemAppearanceSlotResponse>;
109
+ /**
110
+ * Get an item appearance slot index.
111
+ * @returns The item appearance slot index. See {@link ItemAppearanceSlotIndexResponse}.
112
+ */
113
+ declare function itemAppearanceSlotIndex(): Resource<ItemAppearanceSlotIndexResponse>;
114
+ export { itemAppearanceSlot as a, ItemAppearanceSearchParameters as c, ItemAppearanceSetResponse as d, ItemAppearanceSlotIndexResponse as f, itemAppearanceSetIndex as i, ItemAppearanceSearchResponse as l, ItemAppearanceSlotType as m, itemAppearanceSearch as n, itemAppearanceSlotIndex as o, ItemAppearanceSlotResponse as p, itemAppearanceSet as r, ItemAppearanceResponse as s, itemAppearance as t, ItemAppearanceSetIndexResponse as u };
115
+ //# sourceMappingURL=index-DXJEmC1r.d.ts.map
@@ -1,4 +1,4 @@
1
- import { KeyBase, MediaAsset, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { IdKey, MediaAsset, NameId, NameIdKey, NameType, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * Interface for a response from the conduit index endpoint.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -15,7 +15,7 @@ interface ConduitResponse extends ResponseBase {
15
15
  item: NameIdKey;
16
16
  name: string;
17
17
  ranks: Array<Rank>;
18
- socket_type: SocketType;
18
+ socket_type: NameType;
19
19
  }
20
20
  /**
21
21
  * Interface for a response from the covenant index endpoint.
@@ -39,7 +39,7 @@ interface CovenantResponse extends ResponseBase {
39
39
  class_abilities?: Array<ClassAbility>;
40
40
  description: string;
41
41
  id: number;
42
- media?: Media;
42
+ media?: IdKey;
43
43
  name: string;
44
44
  renown_rewards: Array<RenownReward>;
45
45
  signature_ability?: SignatureAbility;
@@ -77,9 +77,6 @@ interface ClassAbilitySpellTooltip {
77
77
  range?: string;
78
78
  spell: NameIdKey;
79
79
  }
80
- interface Media extends KeyBase {
81
- id: number;
82
- }
83
80
  interface Rank {
84
81
  id: number;
85
82
  spell_tooltip: SpellTooltip;
@@ -100,10 +97,6 @@ interface SignatureAbilitySpellTooltip {
100
97
  range?: string;
101
98
  spell: NameIdKey;
102
99
  }
103
- interface SocketType {
104
- name: string;
105
- type: string;
106
- }
107
100
  interface SpellTooltip {
108
101
  cast_time: string;
109
102
  description: string;
@@ -149,4 +142,4 @@ declare function soulbind(soulbindId: number): Resource<SoulbindResponse>;
149
142
  */
150
143
  declare function soulbindIndex(): Resource<SoulbindIndexResponse>;
151
144
  export { covenantMedia as a, ConduitIndexResponse as c, CovenantMediaResponse as d, CovenantResponse as f, covenantIndex as i, ConduitResponse as l, SoulbindResponse as m, conduitIndex as n, soulbind as o, SoulbindIndexResponse as p, covenant as r, soulbindIndex as s, conduit as t, CovenantIndexResponse as u };
152
- //# sourceMappingURL=index-Zo-8eUYk.d.ts.map
145
+ //# sourceMappingURL=index-Dcoq8HHI.d.ts.map
@@ -1,4 +1,4 @@
1
- import { Color, Href, KeyBase, NameId, NameIdKey, NonNeutralFactions, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { Color, Href, IdKey, KeyBase, NameId, NameIdKey, NonNeutralFactions, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for a Mythic Keystone leaderboard index.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -39,7 +39,7 @@ interface Member {
39
39
  type: NonNeutralFactions;
40
40
  };
41
41
  profile: Profile;
42
- specialization: Specialization;
42
+ specialization: IdKey;
43
43
  }
44
44
  interface MythicRating {
45
45
  color: Color;
@@ -52,9 +52,6 @@ interface Realm$1 extends KeyBase {
52
52
  id: number;
53
53
  slug: string;
54
54
  }
55
- interface Specialization extends KeyBase {
56
- id: number;
57
- }
58
55
  /**
59
56
  * Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
60
57
  * @param connectedRealmId The connected realm ID.
@@ -70,4 +67,4 @@ declare function mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId:
70
67
  */
71
68
  declare function mythicKeystoneLeaderboardIndex(connectedRealmId: number): Resource<MythicKeystoneLeaderboardIndexResponse>;
72
69
  export { MythicKeystoneLeaderboardResponse as i, mythicKeystoneLeaderboardIndex as n, MythicKeystoneLeaderboardIndexResponse as r, mythicKeystoneLeaderboard as t };
73
- //# sourceMappingURL=index-mg4RaAL2.d.ts.map
70
+ //# sourceMappingURL=index-DkkhK4mL.d.ts.map
@@ -1,4 +1,4 @@
1
- import { Color, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { Color, IdKey, NameIdKey, NameType, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for the heirloom index.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -13,8 +13,8 @@ interface HeirloomIndexResponse extends ResponseBase {
13
13
  interface HeirloomResponse extends ResponseBase {
14
14
  id: number;
15
15
  item: NameIdKey;
16
- media: Media;
17
- source: Source;
16
+ media: IdKey;
17
+ source: NameType;
18
18
  source_description: string;
19
19
  upgrades: Array<Upgrade>;
20
20
  }
@@ -23,7 +23,7 @@ interface AttackSpeedClass {
23
23
  value: number;
24
24
  }
25
25
  interface Damage {
26
- damage_class: Source;
26
+ damage_class: NameType;
27
27
  display_string: string;
28
28
  max_value: number;
29
29
  min_value: number;
@@ -32,23 +32,16 @@ interface Display {
32
32
  color: Color;
33
33
  display_string: string;
34
34
  }
35
- interface Media extends KeyBase {
36
- id: number;
37
- }
38
35
  interface Requirements {
39
36
  level: RequirementsLevel;
40
37
  }
41
38
  interface RequirementsLevel {
42
39
  display_string: string;
43
40
  }
44
- interface Source {
45
- name: string;
46
- type: string;
47
- }
48
41
  interface Stat {
49
42
  display: Display;
50
43
  is_equip_bonus?: boolean;
51
- type: Source;
44
+ type: NameType;
52
45
  value: number;
53
46
  }
54
47
  interface Upgrade {
@@ -56,17 +49,17 @@ interface Upgrade {
56
49
  level: number;
57
50
  }
58
51
  interface UpgradeItem {
59
- binding: Source;
52
+ binding: NameType;
60
53
  bonus_list: Array<number>;
61
54
  context: number;
62
- inventory_type: Source;
63
- item: Media;
55
+ inventory_type: NameType;
56
+ item: IdKey;
64
57
  item_class: NameIdKey;
65
58
  item_subclass: NameIdKey;
66
59
  level: AttackSpeedClass;
67
- media: Media;
60
+ media: IdKey;
68
61
  name: string;
69
- quality: Source;
62
+ quality: NameType;
70
63
  requirements: Requirements;
71
64
  stats: Array<Stat>;
72
65
  upgrades: Upgrades;
@@ -94,4 +87,4 @@ declare function heirloom(heirloomId: number): Resource<HeirloomResponse>;
94
87
  */
95
88
  declare function heirloomIndex(): Resource<HeirloomIndexResponse>;
96
89
  export { HeirloomResponse as i, heirloomIndex as n, HeirloomIndexResponse as r, heirloom as t };
97
- //# sourceMappingURL=index-CahuOTZl.d.ts.map
90
+ //# sourceMappingURL=index-DzFNhtcD.d.ts.map
@@ -1,4 +1,4 @@
1
- import { BaseSearchParameters, KeyBase, Locales, MediaAsset, NameId, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
1
+ import { BaseSearchParameters, IdKey, KeyBase, Locales, MediaAsset, NameId, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for a spell media.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -13,7 +13,7 @@ interface SpellMediaResponse extends ResponseBase {
13
13
  */
14
14
  interface SpellResponse extends NameId, ResponseBase {
15
15
  description: null | string;
16
- media: Media;
16
+ media: IdKey;
17
17
  }
18
18
  /**
19
19
  * The search parameters for spells.
@@ -32,9 +32,6 @@ interface SpellSearchParameters extends BaseSearchParameters {
32
32
  interface SpellSearchResponse extends SearchResponseWithoutResults {
33
33
  results: Array<SpellSearchResponseItem>;
34
34
  }
35
- interface Media extends KeyBase {
36
- id: number;
37
- }
38
35
  interface SpellSearchResponseItem extends KeyBase {
39
36
  data: {
40
37
  id: number;
@@ -63,4 +60,4 @@ declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
63
60
  */
64
61
  declare function spellSearch(options: SpellSearchParameters): Resource<SpellSearchResponse, Omit<SpellSearchParameters, 'locale' | 'name'>>;
65
62
  export { SpellResponse as a, SpellMediaResponse as i, spellMedia as n, SpellSearchParameters as o, spellSearch as r, SpellSearchResponse as s, spell as t };
66
- //# sourceMappingURL=index-YDf016Cx.d.ts.map
63
+ //# sourceMappingURL=index-ECczWYo-.d.ts.map
@@ -1,12 +1,18 @@
1
- import { Faction, Gender, Href, KeyBase, NameId, NameIdKey, ProtectedResource, Realm } from "@blizzard-api/core";
1
+ import { n as PetStats, t as PetQuality } from "./types-BihzpfkI.js";
2
+ import { Faction, Gender, Href, IdKey, NameId, NameIdKey, NameType, ProtectedResource, Realm } from "@blizzard-api/core";
2
3
  interface AccountCollectionsIndexResponse {
3
4
  _links: Links;
5
+ decors?: Href;
4
6
  heirlooms: Href;
5
7
  mounts: Href;
6
8
  pets: Href;
7
9
  toys: Href;
8
10
  transmogs: Href;
9
11
  }
12
+ interface AccountDecorCollectionResponse {
13
+ _links: Links;
14
+ decor_collected: Array<DecorItem>;
15
+ }
10
16
  interface AccountHeirloomsCollectionSummaryResponse {
11
17
  _links: Links;
12
18
  heirlooms: Array<Heirloom>;
@@ -58,16 +64,16 @@ interface Character$1 {
58
64
  protected_character: Href;
59
65
  realm: Realm;
60
66
  }
67
+ interface DecorItem {
68
+ decor: NameIdKey;
69
+ quantity: number;
70
+ }
61
71
  interface Heirloom {
62
72
  heirloom: NameIdKey;
63
73
  upgrade: {
64
74
  level: number;
65
75
  };
66
76
  }
67
- interface InnerSlot {
68
- name: string;
69
- type: string;
70
- }
71
77
  interface Links {
72
78
  profile: Href;
73
79
  self: Href;
@@ -79,17 +85,15 @@ interface Mount {
79
85
  }
80
86
  interface Pet {
81
87
  active_slot?: number;
82
- creature_display?: KeyBase & {
83
- id: number;
84
- };
88
+ creature_display?: IdKey;
85
89
  id: number;
86
90
  is_active?: boolean;
87
91
  is_favorite?: boolean;
88
92
  level: number;
89
93
  name?: string;
90
- quality: Quality;
94
+ quality: PetQuality;
91
95
  species: NameIdKey;
92
- stats: Stats;
96
+ stats: PetStats;
93
97
  }
94
98
  interface Position {
95
99
  facing: number;
@@ -109,21 +113,9 @@ interface ProtectedStats {
109
113
  total_item_value_gained: number;
110
114
  total_number_deaths: number;
111
115
  }
112
- interface Quality {
113
- name: string;
114
- type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
115
- }
116
116
  interface Slot {
117
- appearances: Array<KeyBase & {
118
- id: number;
119
- }>;
120
- slot: InnerSlot;
121
- }
122
- interface Stats {
123
- breed_id: number;
124
- health: number;
125
- power: number;
126
- speed: number;
117
+ appearances: Array<IdKey>;
118
+ slot: NameType;
127
119
  }
128
120
  interface Toy {
129
121
  is_favorite?: boolean;
@@ -139,6 +131,12 @@ interface WowAccount {
139
131
  * @returns an index of collection types for an account.
140
132
  */
141
133
  declare function accountCollectionsIndex(token: string): ProtectedResource<AccountCollectionsIndexResponse>;
134
+ /**
135
+ * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
136
+ * @param token The OAuth 2.0 access token to use for authentication.
137
+ * @returns the housing decor an account has collected.
138
+ */
139
+ declare function accountDecorCollection(token: string): ProtectedResource<AccountDecorCollectionResponse>;
142
140
  /**
143
141
  * Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
144
142
  * @param token The OAuth 2.0 access token to use for authentication.
@@ -183,5 +181,5 @@ declare function accountTransmogsCollectionSummary(token: string): ProtectedReso
183
181
  * @returns a protected profile summary for a character.
184
182
  */
185
183
  declare function protectedCharacterProfileSummary(realmId: number, characterId: number, token: string): ProtectedResource<ProtectedCharacterProfileSummaryResponse>;
186
- export { accountProfileSummary as a, protectedCharacterProfileSummary as c, AccountMountsCollectionSummaryResponse as d, AccountPetsCollectionSummaryResponse as f, ProtectedCharacterProfileSummaryResponse as g, AccountTransmogsCollectionSummaryResponse as h, accountPetsCollectionSummary as i, AccountCollectionsIndexResponse as l, AccountToysCollectionSummaryResponse as m, accountHeirloomsCollectionSummary as n, accountToysCollectionSummary as o, AccountProfileSummaryResponse as p, accountMountsCollectionSummary as r, accountTransmogsCollectionSummary as s, accountCollectionsIndex as t, AccountHeirloomsCollectionSummaryResponse as u };
187
- //# sourceMappingURL=index-DE8VhwEW.d.ts.map
184
+ export { AccountTransmogsCollectionSummaryResponse as _, accountPetsCollectionSummary as a, accountTransmogsCollectionSummary as c, AccountDecorCollectionResponse as d, AccountHeirloomsCollectionSummaryResponse as f, AccountToysCollectionSummaryResponse as g, AccountProfileSummaryResponse as h, accountMountsCollectionSummary as i, protectedCharacterProfileSummary as l, AccountPetsCollectionSummaryResponse as m, accountDecorCollection as n, accountProfileSummary as o, AccountMountsCollectionSummaryResponse as p, accountHeirloomsCollectionSummary as r, accountToysCollectionSummary as s, accountCollectionsIndex as t, AccountCollectionsIndexResponse as u, ProtectedCharacterProfileSummaryResponse as v };
185
+ //# sourceMappingURL=index-FuJJlGI3.d.ts.map
@@ -1,13 +1,11 @@
1
- import { Character, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { Character, IdKey, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  interface CharacterHunterPetsSummaryResponse extends ResponseBase {
3
3
  character: Character;
4
4
  hunter_pets: Array<HunterPet>;
5
5
  }
6
6
  interface HunterPet {
7
7
  creature: NameIdKey;
8
- creature_display: KeyBase & {
9
- id: number;
10
- };
8
+ creature_display: IdKey;
11
9
  is_active?: boolean;
12
10
  is_summoned?: boolean;
13
11
  level: number;
@@ -22,4 +20,4 @@ interface HunterPet {
22
20
  */
23
21
  declare function characterHunterPetsSummary(realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
24
22
  export { CharacterHunterPetsSummaryResponse as n, characterHunterPetsSummary as t };
25
- //# sourceMappingURL=index-DqReVqKo.d.ts.map
23
+ //# sourceMappingURL=index-G_mEQkdH.d.ts.map
@@ -1,4 +1,4 @@
1
- import { KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { IdKey, NameIdKey, NameType, Resource, ResponseBase } from "@blizzard-api/core";
2
2
  /**
3
3
  * The response for a toy index.
4
4
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -13,18 +13,11 @@ interface ToyIndexResponse extends ResponseBase {
13
13
  interface ToyResponse extends ResponseBase {
14
14
  id: number;
15
15
  item: NameIdKey;
16
- media: Media;
16
+ media: IdKey;
17
17
  should_exclude_if_uncollected?: boolean;
18
- source: Source;
18
+ source: NameType;
19
19
  source_description?: string;
20
20
  }
21
- interface Media extends KeyBase {
22
- id: number;
23
- }
24
- interface Source {
25
- name: string;
26
- type: string;
27
- }
28
21
  /**
29
22
  * Get a toy by ID.
30
23
  * @param toyId The toy ID.
@@ -37,4 +30,4 @@ declare function toy(toyId: number): Resource<ToyResponse>;
37
30
  */
38
31
  declare function toyIndex(): Resource<ToyIndexResponse>;
39
32
  export { ToyResponse as i, toyIndex as n, ToyIndexResponse as r, toy as t };
40
- //# sourceMappingURL=index-BT8uSt8c.d.ts.map
33
+ //# sourceMappingURL=index-Ho48pOyM.d.ts.map
@@ -1,4 +1,8 @@
1
- import { Character, Href, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
1
+ import { n as PetStats, t as PetQuality } from "./types-BihzpfkI.js";
2
+ import { Character, Href, IdKey, NameIdKey, NameType, Resource, ResponseBase } from "@blizzard-api/core";
3
+ interface CharacterCollectionDecorResponse extends ResponseBase {
4
+ decor_collected: Array<DecorItem>;
5
+ }
2
6
  interface CharacterCollectionsIndexResponse extends ResponseBase {
3
7
  character: Character;
4
8
  decors: Href;
@@ -25,6 +29,10 @@ interface CharacterTransmogCollectionSummaryResponse extends ResponseBase {
25
29
  appearance_sets?: Array<NameIdKey>;
26
30
  slots?: Array<Slot>;
27
31
  }
32
+ interface DecorItem {
33
+ decor: NameIdKey;
34
+ quantity: number;
35
+ }
28
36
  interface Heirloom {
29
37
  heirloom: NameIdKey;
30
38
  upgrade: {
@@ -39,37 +47,19 @@ interface Mount {
39
47
  }
40
48
  interface Pet {
41
49
  active_slot?: number;
42
- creature_display?: KeyBase & {
43
- id: number;
44
- };
50
+ creature_display?: IdKey;
45
51
  id: number;
46
52
  is_active?: boolean;
47
53
  is_favorite?: boolean;
48
54
  level: number;
49
55
  name?: string;
50
- quality: Quality;
56
+ quality: PetQuality;
51
57
  species: NameIdKey;
52
- stats: Stats;
53
- }
54
- interface Quality {
55
- name: string;
56
- type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
58
+ stats: PetStats;
57
59
  }
58
60
  interface Slot {
59
- appearances: Array<KeyBase & {
60
- id: number;
61
- }>;
62
- slot: SlotSlot;
63
- }
64
- interface SlotSlot {
65
- name: string;
66
- type: string;
67
- }
68
- interface Stats {
69
- breed_id: number;
70
- health: number;
71
- power: number;
72
- speed: number;
61
+ appearances: Array<IdKey>;
62
+ slot: NameType;
73
63
  }
74
64
  interface Toy {
75
65
  is_favorite?: boolean;
@@ -81,6 +71,12 @@ interface Toy {
81
71
  * @returns an index of collection types for a character.
82
72
  */
83
73
  declare function characterCollectionsIndex(realmSlug: string, characterName: string): Resource<CharacterCollectionsIndexResponse>;
74
+ /**
75
+ * @param realmSlug The slug of the realm.
76
+ * @param characterName The lowercase name of the character.
77
+ * @returns a summary of the housing decor a character has collected.
78
+ */
79
+ declare function characterCollectionDecor(realmSlug: string, characterName: string): Resource<CharacterCollectionDecorResponse>;
84
80
  /**
85
81
  * @param realmSlug The slug of the realm.
86
82
  * @param characterName The lowercase name of the character.
@@ -111,5 +107,5 @@ declare function characterToysCollectionSummary(realmSlug: string, characterName
111
107
  * @returns a summary of the transmog unlocks a character has obtained.
112
108
  */
113
109
  declare function characterTransmogCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterTransmogCollectionSummaryResponse>;
114
- export { characterToysCollectionSummary as a, CharacterHeirloomsCollectionSummaryResponse as c, CharacterToysCollectionSummaryResponse as d, CharacterTransmogCollectionSummaryResponse as f, characterPetsCollectionSummary as i, CharacterMountsCollectionSummaryResponse as l, characterHeirloomsCollectionSummary as n, characterTransmogCollectionSummary as o, characterMountsCollectionSummary as r, CharacterCollectionsIndexResponse as s, characterCollectionsIndex as t, CharacterPetsCollectionSummaryResponse as u };
115
- //# sourceMappingURL=index-CNnXwh3U.d.ts.map
110
+ export { characterPetsCollectionSummary as a, CharacterCollectionDecorResponse as c, CharacterMountsCollectionSummaryResponse as d, CharacterPetsCollectionSummaryResponse as f, characterMountsCollectionSummary as i, CharacterCollectionsIndexResponse as l, CharacterTransmogCollectionSummaryResponse as m, characterCollectionsIndex as n, characterToysCollectionSummary as o, CharacterToysCollectionSummaryResponse as p, characterHeirloomsCollectionSummary as r, characterTransmogCollectionSummary as s, characterCollectionDecor as t, CharacterHeirloomsCollectionSummaryResponse as u };
111
+ //# sourceMappingURL=index-QcJecti6.d.ts.map