@blizzard-api/classic-wow 3.0.5 → 4.0.0
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.
- package/dist/auction-house/index.d.ts +2 -0
- package/dist/auction-house/index.js +35 -0
- package/dist/auction-house/index.js.map +1 -0
- package/dist/character-achievements/index.d.ts +2 -0
- package/dist/character-achievements/index.js +30 -0
- package/dist/character-achievements/index.js.map +1 -0
- package/dist/character-equipment/index.d.ts +2 -0
- package/dist/character-equipment/index.js +19 -0
- package/dist/character-equipment/index.js.map +1 -0
- package/dist/character-hunter-pets/index.d.ts +2 -0
- package/dist/character-hunter-pets/index.js +19 -0
- package/dist/character-hunter-pets/index.js.map +1 -0
- package/dist/character-media/index.d.ts +2 -0
- package/dist/character-media/index.js +18 -0
- package/dist/character-media/index.js.map +1 -0
- package/dist/character-profile/index.d.ts +2 -0
- package/dist/character-profile/index.js +42 -0
- package/dist/character-profile/index.js.map +1 -0
- package/dist/character-specialization/index.d.ts +2 -0
- package/dist/character-specialization/index.js +18 -0
- package/dist/character-specialization/index.js.map +1 -0
- package/dist/character-statistics/index.d.ts +2 -0
- package/dist/character-statistics/index.js +18 -0
- package/dist/character-statistics/index.js.map +1 -0
- package/dist/connected-realm/index.d.ts +2 -0
- package/dist/connected-realm/index.js +47 -0
- package/dist/connected-realm/index.js.map +1 -0
- package/dist/creature/index.d.ts +2 -0
- package/dist/creature/index.js +105 -0
- package/dist/creature/index.js.map +1 -0
- package/dist/guild/index.d.ts +2 -0
- package/dist/guild/index.js +54 -0
- package/dist/guild/index.js.map +1 -0
- package/dist/guild-crest/index.d.ts +2 -0
- package/dist/guild-crest/index.js +41 -0
- package/dist/guild-crest/index.js.map +1 -0
- package/dist/index--VDjAqSZ.d.ts +23 -0
- package/dist/index-0TuKK7MU.d.ts +75 -0
- package/dist/index-B-LUShkQ.d.ts +167 -0
- package/dist/index-BHX6BR24.d.ts +163 -0
- package/dist/index-BQ-NY0vY.d.ts +128 -0
- package/dist/index-BZ8QSRSe.d.ts +90 -0
- package/dist/index-BrwXCy4D.d.ts +40 -0
- package/dist/index-BtfmrbYY.d.ts +31 -0
- package/dist/index-C7VwaWu6.d.ts +66 -0
- package/dist/index-Ce02MoQO.d.ts +37 -0
- package/dist/index-DDSvssGG.d.ts +59 -0
- package/dist/index-DSc_fuNb.d.ts +46 -0
- package/dist/index-DUgdQv4k.d.ts +36 -0
- package/dist/index-DajMx-uR.d.ts +143 -0
- package/dist/index-Djpr-_AW.d.ts +65 -0
- package/dist/index-DmVmLB_p.d.ts +51 -0
- package/dist/index-i0vuifJx.d.ts +33 -0
- package/dist/index-u8N9Fa6T.d.ts +290 -0
- package/dist/index-y_6cJbJi.d.ts +89 -0
- package/dist/index.d.ts +22 -1632
- package/dist/index.js +20 -753
- package/dist/index.js.map +1 -1
- package/dist/item/index.d.ts +2 -0
- package/dist/item/index.js +83 -0
- package/dist/item/index.js.map +1 -0
- package/dist/media-search/index.d.ts +2 -0
- package/dist/media-search/index.js +23 -0
- package/dist/media-search/index.js.map +1 -0
- package/dist/playable-class/index.d.ts +2 -0
- package/dist/playable-class/index.js +41 -0
- package/dist/playable-class/index.js.map +1 -0
- package/dist/playable-race/index.d.ts +2 -0
- package/dist/playable-race/index.js +29 -0
- package/dist/playable-race/index.js.map +1 -0
- package/dist/power-type/index.d.ts +2 -0
- package/dist/power-type/index.js +29 -0
- package/dist/power-type/index.js.map +1 -0
- package/dist/pvp-season/index.d.ts +2 -0
- package/dist/pvp-season/index.js +105 -0
- package/dist/pvp-season/index.js.map +1 -0
- package/dist/realm/index.d.ts +27 -0
- package/dist/realm/index.js +46 -0
- package/dist/realm/index.js.map +1 -0
- package/dist/region/index.d.ts +2 -0
- package/dist/region/index.js +29 -0
- package/dist/region/index.js.map +1 -0
- package/dist/types-gA98D5Xw.d.ts +79 -0
- package/package.json +16 -7
package/dist/index.d.ts
CHANGED
|
@@ -1,1635 +1,25 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { i as AuctionsResponse, n as auctions, r as AuctionHouseIndexResponse, t as auctionHouseIndex } from "./index-DSc_fuNb.js";
|
|
2
|
+
import { i as CharacterAchievementsSummaryResponse, n as characterAchievementsSummary, r as CharacterAchievementStatisticsResponse, t as characterAchievementStatistics } from "./index-BZ8QSRSe.js";
|
|
3
|
+
import { n as CharacterEquipmentSummaryResponse, t as characterEquipmentSummary } from "./index-BHX6BR24.js";
|
|
4
|
+
import { n as CharacterHunterPetsSummaryResponse, t as characterHunterPetsSummary } from "./index-BtfmrbYY.js";
|
|
5
|
+
import { n as CharacterMediaSummaryResponse, t as characterMediaSummary } from "./index--VDjAqSZ.js";
|
|
6
|
+
import { i as CharacterProfileStatusResponse, n as characterProfileSummary, r as CharacterProfileSummaryResponse, t as characterProfileStatus } from "./index-0TuKK7MU.js";
|
|
7
|
+
import { n as CharacterSpecializationsSummaryResponse, t as characterSpecializationsSummary } from "./index-DmVmLB_p.js";
|
|
8
|
+
import { n as CharacterStatisticsSummaryResponse, t as characterStatisticsSummary } from "./index-C7VwaWu6.js";
|
|
9
|
+
import { a as RealmSearchParameters, c as RealmTypeCapitalized, i as RealmResponse, n as RealmIndexResponse, o as RealmSearchResponse, r as RealmLocales, s as RealmTimezone, t as RealmCategory } from "./types-gA98D5Xw.js";
|
|
10
|
+
import { a as ConnectedRealmResponse, i as ConnectedRealmIndexResponse, n as connectedRealmIndex, o as ConnectedRealmSearchParameters, r as connectedRealmSearch, s as ConnectedRealmSearchResponse, t as connectedRealm } from "./index-BQ-NY0vY.js";
|
|
11
|
+
import { _ as CreatureTypeResponse, a as creatureFamilyMedia, c as creatureTypeIndex, d as CreatureFamilyMediaResponse, f as CreatureFamilyResponse, g as CreatureTypeIndexResponse, h as CreatureSearchResponse, i as creatureFamilyIndex, l as CreatureDisplayMediaResponse, m as CreatureSearchParameters, n as creatureDisplayMedia, o as creatureSearch, p as CreatureResponse, r as creatureFamily, s as creatureType, t as creature, u as CreatureFamilyIndexResponse } from "./index-B-LUShkQ.js";
|
|
12
|
+
import { a as GuildCrestComponentsIndexResponse, i as GuildCrestBorderEmblemResponse, n as guildCrestComponentsIndex, r as guildCrestEmblem, t as guildCrestBorder } from "./index-Djpr-_AW.js";
|
|
13
|
+
import { a as GuildAchievementsClassicEraResponse, c as GuildResponse, i as guildRoster, l as GuildRosterResponse, n as guildAchievements, o as GuildAchievementsResponse, r as guildActivity, s as GuildActivityResponse, t as guild } from "./index-DajMx-uR.js";
|
|
14
|
+
import { a as itemSearch, c as ItemClassResponse, d as ItemSearchParameters, f as ItemSearchResponse, i as itemMedia, l as ItemMediaResponse, n as itemClass, o as itemSubClass, p as ItemSubClassResponse, r as itemClassIndex, s as ItemClassIndexResponse, t as item, u as ItemResponse } from "./index-u8N9Fa6T.js";
|
|
15
|
+
import { n as MediaSearchParameters, r as MediaSearchResponse, t as mediaSearch } from "./index-Ce02MoQO.js";
|
|
16
|
+
import { a as PlayableClassMediaResponse, i as PlayableClassIndexResponse, n as playableClassIndex, o as PlayableClassResponse, r as playableClassMedia, t as playableClass } from "./index-DDSvssGG.js";
|
|
17
|
+
import { i as PlayableRaceResponse, n as playableRaceIndex, r as PlayableRaceIndexResponse, t as playableRace } from "./index-BrwXCy4D.js";
|
|
18
|
+
import { i as PowerTypeResponse, n as powerTypeIndex, r as PowerTypeIndexResponse, t as powerType } from "./index-i0vuifJx.js";
|
|
19
|
+
import { a as pvpRegionalSeasonIndex, c as pvpSeasonIndex, i as pvpRegionalSeason, l as PvpSeasonIndexResponse, n as pvpLeaderboardIndex, o as pvpRewardsIndex, r as pvpRegionIndex, s as pvpSeason, t as pvpLeaderboard, u as PvpSeasonResponse } from "./index-y_6cJbJi.js";
|
|
20
|
+
import { realm, realmIndex, realmSearch } from "./realm/index.js";
|
|
21
|
+
import { i as RegionResponse, n as regionIndex, r as RegionIndexResponse, t as region } from "./index-DUgdQv4k.js";
|
|
2
22
|
|
|
3
|
-
//#region src/auction-house/types.d.ts
|
|
4
|
-
interface AuctionHouseIndexResponse extends ResponseBase {
|
|
5
|
-
auctions: Array<NameIdKey>;
|
|
6
|
-
}
|
|
7
|
-
interface AuctionsResponse extends NameId, ResponseBase {
|
|
8
|
-
auctions: Array<Auction>;
|
|
9
|
-
connected_realm: Href;
|
|
10
|
-
}
|
|
11
|
-
interface Auction {
|
|
12
|
-
bid: number;
|
|
13
|
-
buyout: number;
|
|
14
|
-
id: number;
|
|
15
|
-
item: {
|
|
16
|
-
id: number;
|
|
17
|
-
rand?: number;
|
|
18
|
-
seed?: number;
|
|
19
|
-
};
|
|
20
|
-
quantity: number;
|
|
21
|
-
time_left: 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
|
|
22
|
-
}
|
|
23
|
-
//#endregion
|
|
24
|
-
//#region src/auction-house/auction-house.d.ts
|
|
25
|
-
/**
|
|
26
|
-
* Returns an index of auction houses for a connected realm.
|
|
27
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
28
|
-
* @param connectedRealmId The ID of the connected realm.
|
|
29
|
-
* @returns The auction house index. See {@link AuctionHouseIndexResponse}.
|
|
30
|
-
*/
|
|
31
|
-
declare function auctionHouseIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number): Resource<AuctionHouseIndexResponse>;
|
|
32
|
-
/**
|
|
33
|
-
* Returns all active auctions for a specific auction house on a connected realm.
|
|
34
|
-
*
|
|
35
|
-
* Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
|
|
36
|
-
*
|
|
37
|
-
* Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
|
|
38
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
39
|
-
* @param connectedRealmId The ID of the connected realm.
|
|
40
|
-
* @param auctionHouseId The ID of the auction house.
|
|
41
|
-
* @returns The auction house data. See {@link AuctionsResponse}.
|
|
42
|
-
*/
|
|
43
|
-
declare function auctions(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number, auctionHouseId: number): Resource<AuctionsResponse>;
|
|
44
|
-
//#endregion
|
|
45
|
-
//#region src/character-achievements/types.d.ts
|
|
46
|
-
interface CharacterAchievementsSummaryResponse extends ResponseBase {
|
|
47
|
-
achievements: Array<Achievement$1>;
|
|
48
|
-
category_progress: Array<CategoryProgress$1>;
|
|
49
|
-
character: Character;
|
|
50
|
-
recent_events: Array<RecentEvent$1>;
|
|
51
|
-
total_points: number;
|
|
52
|
-
total_quantity: number;
|
|
53
|
-
}
|
|
54
|
-
interface CharacterAchievementStatisticsResponse extends ResponseBase {
|
|
55
|
-
categories: Array<Category>;
|
|
56
|
-
character: Character;
|
|
57
|
-
}
|
|
58
|
-
interface Achievement$1 {
|
|
59
|
-
achievement: NameIdKey;
|
|
60
|
-
completed_timestamp?: number;
|
|
61
|
-
criteria?: Criteria$1;
|
|
62
|
-
id: number;
|
|
63
|
-
}
|
|
64
|
-
interface Category {
|
|
65
|
-
id: number;
|
|
66
|
-
name: string;
|
|
67
|
-
statistics?: Array<Statistic>;
|
|
68
|
-
sub_categories?: Array<SubCategory>;
|
|
69
|
-
}
|
|
70
|
-
interface CategoryProgress$1 {
|
|
71
|
-
category: NameIdKey;
|
|
72
|
-
points: number;
|
|
73
|
-
quantity: number;
|
|
74
|
-
}
|
|
75
|
-
interface ChildCriterum$1 {
|
|
76
|
-
amount?: number;
|
|
77
|
-
child_criteria?: Array<ChildCriterum2>;
|
|
78
|
-
id: number;
|
|
79
|
-
is_completed: boolean;
|
|
80
|
-
}
|
|
81
|
-
interface ChildCriterum2 {
|
|
82
|
-
amount?: number;
|
|
83
|
-
child_criteria?: Array<ChildCriterum3>;
|
|
84
|
-
id: number;
|
|
85
|
-
is_completed: boolean;
|
|
86
|
-
}
|
|
87
|
-
interface ChildCriterum3 {
|
|
88
|
-
amount?: number;
|
|
89
|
-
id: number;
|
|
90
|
-
is_completed: boolean;
|
|
91
|
-
}
|
|
92
|
-
interface Criteria$1 {
|
|
93
|
-
amount?: number;
|
|
94
|
-
child_criteria?: Array<ChildCriterum$1>;
|
|
95
|
-
id: number;
|
|
96
|
-
is_completed: boolean;
|
|
97
|
-
}
|
|
98
|
-
interface RecentEvent$1 {
|
|
99
|
-
achievement: NameIdKey;
|
|
100
|
-
timestamp: number;
|
|
101
|
-
}
|
|
102
|
-
interface Statistic {
|
|
103
|
-
description?: null | string;
|
|
104
|
-
id: number;
|
|
105
|
-
last_updated_timestamp: number;
|
|
106
|
-
name: string;
|
|
107
|
-
quantity: number;
|
|
108
|
-
}
|
|
109
|
-
interface SubCategory {
|
|
110
|
-
id: number;
|
|
111
|
-
name: string;
|
|
112
|
-
statistics: Array<Statistic>;
|
|
113
|
-
}
|
|
114
|
-
//#endregion
|
|
115
|
-
//#region src/character-achievements/character-achievements.d.ts
|
|
116
|
-
/**
|
|
117
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}. Note: This API is not supported for classic era realms.
|
|
118
|
-
* @param realmSlug The slug of the realm.
|
|
119
|
-
* @param characterName The lowercase name of the character.
|
|
120
|
-
* @returns a summary of the achievements a character has completed.
|
|
121
|
-
*/
|
|
122
|
-
declare function characterAchievementsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
|
|
123
|
-
/**
|
|
124
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}. Note: This API is not supported for classic era realms.
|
|
125
|
-
* @param realmSlug The slug of the realm.
|
|
126
|
-
* @param characterName The lowercase name of the character.
|
|
127
|
-
* @returns a character's statistics as they pertain to achievements.
|
|
128
|
-
*/
|
|
129
|
-
declare function characterAchievementStatistics(namespace: Extract<BlizzardNamespaces, 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
|
|
130
|
-
//#endregion
|
|
131
|
-
//#region src/character-equipment/types.d.ts
|
|
132
|
-
interface CharacterEquipmentSummaryResponse extends ResponseBase {
|
|
133
|
-
character: Character;
|
|
134
|
-
equipped_item_sets: Array<Set>;
|
|
135
|
-
equipped_items: Array<EquippedItem>;
|
|
136
|
-
}
|
|
137
|
-
interface Armor$1 {
|
|
138
|
-
display: NameDescription;
|
|
139
|
-
value: number;
|
|
140
|
-
}
|
|
141
|
-
interface Damage$1 {
|
|
142
|
-
damage_class: NameType;
|
|
143
|
-
display_string: string;
|
|
144
|
-
max_value: number;
|
|
145
|
-
min_value: number;
|
|
146
|
-
}
|
|
147
|
-
interface DisplayStrings {
|
|
148
|
-
copper: string;
|
|
149
|
-
gold: string;
|
|
150
|
-
header: string;
|
|
151
|
-
silver: string;
|
|
152
|
-
}
|
|
153
|
-
interface DisplayStringValue {
|
|
154
|
-
display_string: string;
|
|
155
|
-
value: number;
|
|
156
|
-
}
|
|
157
|
-
interface Effect {
|
|
158
|
-
display_string: string;
|
|
159
|
-
is_active?: boolean;
|
|
160
|
-
required_count: number;
|
|
161
|
-
}
|
|
162
|
-
interface Enchantment {
|
|
163
|
-
display_string?: string;
|
|
164
|
-
enchantment_id: number;
|
|
165
|
-
enchantment_slot: EnchantmentSlot;
|
|
166
|
-
source_item?: NameIdKey;
|
|
167
|
-
spell?: {
|
|
168
|
-
description: string;
|
|
169
|
-
spell: NameIdKey;
|
|
170
|
-
};
|
|
171
|
-
}
|
|
172
|
-
interface EnchantmentSlot {
|
|
173
|
-
id: number;
|
|
174
|
-
type?: string;
|
|
175
|
-
}
|
|
176
|
-
interface EquippedItem {
|
|
177
|
-
armor?: Armor$1;
|
|
178
|
-
binding: NameType;
|
|
179
|
-
bonus_list?: Array<number>;
|
|
180
|
-
context?: number;
|
|
181
|
-
description?: string;
|
|
182
|
-
durability?: DisplayStringValue;
|
|
183
|
-
enchantments?: Array<Enchantment>;
|
|
184
|
-
inventory_type: NameType;
|
|
185
|
-
is_subclass_hidden?: boolean;
|
|
186
|
-
item: KeyBase & {
|
|
187
|
-
id: number;
|
|
188
|
-
};
|
|
189
|
-
item_class: NameIdKey;
|
|
190
|
-
item_subclass: NameIdKey;
|
|
191
|
-
level?: DisplayStringValue;
|
|
192
|
-
limit_category?: string;
|
|
193
|
-
media: KeyBase & {
|
|
194
|
-
id: number;
|
|
195
|
-
};
|
|
196
|
-
modified_appearance_id?: number;
|
|
197
|
-
modified_crafting_stat?: Array<ModifiedCraftingStat>;
|
|
198
|
-
name: string;
|
|
199
|
-
name_description?: NameDescription;
|
|
200
|
-
quality: NameType;
|
|
201
|
-
quantity: number;
|
|
202
|
-
requirements?: Requirements$1;
|
|
203
|
-
sell_price?: SellPrice;
|
|
204
|
-
set?: Set;
|
|
205
|
-
slot: NameType;
|
|
206
|
-
sockets?: Array<Socket>;
|
|
207
|
-
spells?: Array<Spell$1>;
|
|
208
|
-
stats?: Array<Stat$1>;
|
|
209
|
-
transmog?: Transmog;
|
|
210
|
-
unique_equipped?: string;
|
|
211
|
-
upgrade_id?: number;
|
|
212
|
-
weapon?: Weapon$1;
|
|
213
|
-
}
|
|
214
|
-
interface ItemElement {
|
|
215
|
-
is_equipped?: boolean;
|
|
216
|
-
item: NameIdKey;
|
|
217
|
-
}
|
|
218
|
-
interface ModifiedCraftingStat {
|
|
219
|
-
id: number;
|
|
220
|
-
name: string;
|
|
221
|
-
type: string;
|
|
222
|
-
}
|
|
223
|
-
interface NameDescription {
|
|
224
|
-
color: Color;
|
|
225
|
-
display_string: string;
|
|
226
|
-
}
|
|
227
|
-
interface NameType {
|
|
228
|
-
name: string;
|
|
229
|
-
type: string;
|
|
230
|
-
}
|
|
231
|
-
interface PlayableClasses {
|
|
232
|
-
display_string: string;
|
|
233
|
-
links: Array<NameIdKey>;
|
|
234
|
-
}
|
|
235
|
-
interface Requirements$1 {
|
|
236
|
-
level: DisplayStringValue;
|
|
237
|
-
playable_classes?: PlayableClasses;
|
|
238
|
-
}
|
|
239
|
-
interface SellPrice {
|
|
240
|
-
display_strings: DisplayStrings;
|
|
241
|
-
value: number;
|
|
242
|
-
}
|
|
243
|
-
interface Set {
|
|
244
|
-
display_string?: string;
|
|
245
|
-
effects?: Array<Effect>;
|
|
246
|
-
item_set?: NameIdKey;
|
|
247
|
-
items?: Array<ItemElement>;
|
|
248
|
-
}
|
|
249
|
-
interface Socket {
|
|
250
|
-
display_string: string;
|
|
251
|
-
item: NameIdKey;
|
|
252
|
-
media: KeyBase & {
|
|
253
|
-
id: number;
|
|
254
|
-
};
|
|
255
|
-
socket_type: NameType;
|
|
256
|
-
}
|
|
257
|
-
interface Spell$1 {
|
|
258
|
-
description: string;
|
|
259
|
-
display_color?: Color;
|
|
260
|
-
spell: NameIdKey;
|
|
261
|
-
}
|
|
262
|
-
interface Stat$1 {
|
|
263
|
-
display: NameDescription;
|
|
264
|
-
is_equip_bonus?: boolean;
|
|
265
|
-
is_negated?: boolean;
|
|
266
|
-
type: NameType;
|
|
267
|
-
value: number;
|
|
268
|
-
}
|
|
269
|
-
interface Transmog {
|
|
270
|
-
display_string: string;
|
|
271
|
-
item: NameIdKey;
|
|
272
|
-
item_modified_appearance_id: number;
|
|
273
|
-
}
|
|
274
|
-
interface Weapon$1 {
|
|
275
|
-
attack_speed: DisplayStringValue;
|
|
276
|
-
damage: Damage$1;
|
|
277
|
-
dps: DisplayStringValue;
|
|
278
|
-
}
|
|
279
|
-
//#endregion
|
|
280
|
-
//#region src/character-equipment/character-equipment.d.ts
|
|
281
|
-
/**
|
|
282
|
-
* Returns a summary of the items equipped by a character.
|
|
283
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
284
|
-
* @param realmSlug The realm slug.
|
|
285
|
-
* @param characterName The character name.
|
|
286
|
-
* @returns The character equipment summary.
|
|
287
|
-
*/
|
|
288
|
-
declare function characterEquipmentSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
|
|
289
|
-
//#endregion
|
|
290
|
-
//#region src/character-hunter-pets/types.d.ts
|
|
291
|
-
interface CharacterHunterPetsSummaryResponse extends ResponseBase {
|
|
292
|
-
character: Character;
|
|
293
|
-
hunter_pets: Array<HunterPet>;
|
|
294
|
-
}
|
|
295
|
-
interface HunterPet {
|
|
296
|
-
creature: NameIdKey;
|
|
297
|
-
creature_display: KeyBase & {
|
|
298
|
-
id: number;
|
|
299
|
-
};
|
|
300
|
-
is_active?: boolean;
|
|
301
|
-
is_summoned?: boolean;
|
|
302
|
-
level: number;
|
|
303
|
-
name: string;
|
|
304
|
-
slot: number;
|
|
305
|
-
}
|
|
306
|
-
//#endregion
|
|
307
|
-
//#region src/character-hunter-pets/character-hunter-pets.d.ts
|
|
308
|
-
/**
|
|
309
|
-
* If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
|
|
310
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
311
|
-
* @param realmSlug The slug of the realm.
|
|
312
|
-
* @param characterName The lowercase name of the character.
|
|
313
|
-
* @returns a summary of the character's hunter pets.
|
|
314
|
-
*/
|
|
315
|
-
declare function characterHunterPetsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
|
|
316
|
-
//#endregion
|
|
317
|
-
//#region src/character-media/types.d.ts
|
|
318
|
-
interface CharacterMediaSummaryResponse extends ResponseBase {
|
|
319
|
-
assets: Array<Asset>;
|
|
320
|
-
character: Character;
|
|
321
|
-
}
|
|
322
|
-
interface Asset {
|
|
323
|
-
key: string;
|
|
324
|
-
value: string;
|
|
325
|
-
}
|
|
326
|
-
//#endregion
|
|
327
|
-
//#region src/character-media/character-media.d.ts
|
|
328
|
-
/**
|
|
329
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
330
|
-
* @param realmSlug The slug of the realm.
|
|
331
|
-
* @param characterName The lowercase name of the character.
|
|
332
|
-
* @returns a summary of the media assets available for a character (such as an avatar render).
|
|
333
|
-
*/
|
|
334
|
-
declare function characterMediaSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
|
|
335
|
-
//#endregion
|
|
336
|
-
//#region ../wow/src/character-profile/types.d.ts
|
|
337
|
-
interface CharacterProfileStatusResponse extends ResponseBase {
|
|
338
|
-
id: number;
|
|
339
|
-
is_valid: boolean;
|
|
340
|
-
}
|
|
341
|
-
//#endregion
|
|
342
|
-
//#region src/character-profile/types.d.ts
|
|
343
|
-
interface CharacterProfileSummaryResponse extends ResponseBase {
|
|
344
|
-
achievement_points?: number;
|
|
345
|
-
achievements?: Href;
|
|
346
|
-
active_spec: NameIdKey;
|
|
347
|
-
active_title?: {
|
|
348
|
-
name: string;
|
|
349
|
-
};
|
|
350
|
-
appearance: Href;
|
|
351
|
-
average_item_level: number;
|
|
352
|
-
character_class: NameIdKey;
|
|
353
|
-
equipment: Href;
|
|
354
|
-
equipped_item_level: number;
|
|
355
|
-
experience: number;
|
|
356
|
-
faction: Faction;
|
|
357
|
-
gender: Gender;
|
|
358
|
-
guild?: Guild$1;
|
|
359
|
-
hunter_pets?: Href;
|
|
360
|
-
id: number;
|
|
361
|
-
is_ghost?: boolean;
|
|
362
|
-
is_self_found?: boolean;
|
|
363
|
-
last_login_timestamp: number;
|
|
364
|
-
level: number;
|
|
365
|
-
media: Href;
|
|
366
|
-
name: string;
|
|
367
|
-
pvp_summary: Href;
|
|
368
|
-
race: NameIdKey;
|
|
369
|
-
realm: Realm;
|
|
370
|
-
specializations: Href;
|
|
371
|
-
statistics: Href;
|
|
372
|
-
titles: Href;
|
|
373
|
-
}
|
|
374
|
-
interface Guild$1 extends NameIdKey {
|
|
375
|
-
faction: Faction;
|
|
376
|
-
realm: Realm;
|
|
377
|
-
}
|
|
378
|
-
//#endregion
|
|
379
|
-
//#region src/character-profile/character-profile.d.ts
|
|
380
|
-
/**
|
|
381
|
-
* Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
|
|
382
|
-
* - an HTTP 404 Not Found error is returned
|
|
383
|
-
* - the is_valid value is false
|
|
384
|
-
* - the returned character ID doesn't match the previously recorded value for the character
|
|
385
|
-
*
|
|
386
|
-
* The following example illustrates how to use this endpoint:
|
|
387
|
-
*
|
|
388
|
-
* 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
|
|
389
|
-
* 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
|
|
390
|
-
* 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
|
|
391
|
-
* 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
|
|
392
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
393
|
-
* @param realmSlug The slug of the realm.
|
|
394
|
-
* @param characterName The lowercase name of the character.
|
|
395
|
-
* @returns the status of the character profile for a character.
|
|
396
|
-
*/
|
|
397
|
-
declare function characterProfileStatus(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<typeof namespace extends 'profile-classic1x' ? CharacterProfileStatusResponse : never>;
|
|
398
|
-
/**
|
|
399
|
-
* Returns a summary of the character profile for a character.
|
|
400
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
401
|
-
* @param realmSlug The slug of the realm.
|
|
402
|
-
* @param characterName The lowercase name of the character.
|
|
403
|
-
* @returns a summary of the character profile for a character.
|
|
404
|
-
*/
|
|
405
|
-
declare function characterProfileSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
|
|
406
|
-
//#endregion
|
|
407
|
-
//#region src/character-specialization/types.d.ts
|
|
408
|
-
interface CharacterSpecializationsSummaryResponse extends ResponseBase {
|
|
409
|
-
active_specialization?: NameIdKey;
|
|
410
|
-
character: Character;
|
|
411
|
-
specialization_groups: Array<SpecializationGroup>;
|
|
412
|
-
specializations?: Array<ClassicProgressionSpecialization>;
|
|
413
|
-
}
|
|
414
|
-
interface ClassicProgressionSpecialization {
|
|
415
|
-
specialization: NameIdKey;
|
|
416
|
-
specialization_name: string;
|
|
417
|
-
talents?: Array<TalentElement>;
|
|
418
|
-
}
|
|
419
|
-
interface SpecializationGroup {
|
|
420
|
-
glyphs?: Array<NameId>;
|
|
421
|
-
is_active: boolean;
|
|
422
|
-
specializations?: Array<SpecializationGroupItem>;
|
|
423
|
-
}
|
|
424
|
-
interface SpecializationGroupItem {
|
|
425
|
-
specialization_name: string;
|
|
426
|
-
spent_points: number;
|
|
427
|
-
talents: Array<TalentElement>;
|
|
428
|
-
}
|
|
429
|
-
interface SpellTooltip {
|
|
430
|
-
cast_time: string;
|
|
431
|
-
cooldown?: string;
|
|
432
|
-
description: string;
|
|
433
|
-
power_cost?: null | string;
|
|
434
|
-
range?: string;
|
|
435
|
-
spell: NameId;
|
|
436
|
-
}
|
|
437
|
-
interface TalentElement {
|
|
438
|
-
spell_tooltip: SpellTooltip;
|
|
439
|
-
talent: NameId | {
|
|
440
|
-
id: number;
|
|
441
|
-
};
|
|
442
|
-
talent_rank?: number;
|
|
443
|
-
}
|
|
444
|
-
//#endregion
|
|
445
|
-
//#region src/character-specialization/character-specialization.d.ts
|
|
446
|
-
/**
|
|
447
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
448
|
-
* @param realmSlug The slug of the realm.
|
|
449
|
-
* @param characterName The lowercase name of the character.
|
|
450
|
-
* @returns a summary of a character's specializations.
|
|
451
|
-
*/
|
|
452
|
-
declare function characterSpecializationsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
|
|
453
|
-
//#endregion
|
|
454
|
-
//#region src/character-statistics/types.d.ts
|
|
455
|
-
interface CharacterStatisticsSummaryResponse extends ResponseBase {
|
|
456
|
-
agility: BaseEffectiveStat;
|
|
457
|
-
arcane_resistance?: BaseEffectiveStat;
|
|
458
|
-
armor: BaseEffectiveStat;
|
|
459
|
-
attack_power: number;
|
|
460
|
-
block: RatingWithValue;
|
|
461
|
-
bonus_armor?: number;
|
|
462
|
-
character: Character;
|
|
463
|
-
defense?: BaseEffectiveStat;
|
|
464
|
-
dodge: RatingWithValue;
|
|
465
|
-
fire_resistance?: BaseEffectiveStat;
|
|
466
|
-
health: number;
|
|
467
|
-
holy_resistance?: BaseEffectiveStat;
|
|
468
|
-
intellect: BaseEffectiveStat;
|
|
469
|
-
main_hand_damage_max: number;
|
|
470
|
-
main_hand_damage_min: number;
|
|
471
|
-
main_hand_dps: number;
|
|
472
|
-
main_hand_speed: number;
|
|
473
|
-
mana_regen: number;
|
|
474
|
-
mana_regen_combat: number;
|
|
475
|
-
mastery?: RatingWithValue;
|
|
476
|
-
melee_crit: RatingWithValue;
|
|
477
|
-
melee_haste?: RatingWithValue;
|
|
478
|
-
nature_resistance?: BaseEffectiveStat;
|
|
479
|
-
off_hand_damage_max: number;
|
|
480
|
-
off_hand_damage_min: number;
|
|
481
|
-
off_hand_dps: number;
|
|
482
|
-
off_hand_speed: number;
|
|
483
|
-
parry: RatingWithValue;
|
|
484
|
-
power: number;
|
|
485
|
-
power_type: NameIdKey;
|
|
486
|
-
ranged_crit: RatingWithValue;
|
|
487
|
-
ranged_haste?: RatingWithValue;
|
|
488
|
-
shadow_resistance?: BaseEffectiveStat;
|
|
489
|
-
spell_crit: RatingWithValue;
|
|
490
|
-
spell_haste?: RatingWithValue;
|
|
491
|
-
spell_penetration: number;
|
|
492
|
-
spell_power: number;
|
|
493
|
-
spirit: BaseEffectiveStat;
|
|
494
|
-
stamina: BaseEffectiveStat;
|
|
495
|
-
strength: BaseEffectiveStat;
|
|
496
|
-
}
|
|
497
|
-
interface BaseEffectiveStat {
|
|
498
|
-
base: number;
|
|
499
|
-
effective: number;
|
|
500
|
-
}
|
|
501
|
-
interface RatingWithValue {
|
|
502
|
-
rating_bonus: number;
|
|
503
|
-
rating_normalized: number;
|
|
504
|
-
value: number;
|
|
505
|
-
}
|
|
506
|
-
//#endregion
|
|
507
|
-
//#region src/character-statistics/character-statistics.d.ts
|
|
508
|
-
/**
|
|
509
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
510
|
-
* @param realmSlug The slug of the realm.
|
|
511
|
-
* @param characterName The lowercase name of the character.
|
|
512
|
-
* @returns a statistics summary for a character.
|
|
513
|
-
*/
|
|
514
|
-
declare function characterStatisticsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterStatisticsSummaryResponse>;
|
|
515
|
-
//#endregion
|
|
516
|
-
//#region src/realm/types.d.ts
|
|
517
|
-
/**
|
|
518
|
-
* The category of a realm.
|
|
519
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
520
|
-
*/
|
|
521
|
-
type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'Latin America' | 'Oceanic' | 'PS' | 'Russian' | 'Spanish' | 'United States' | '한국';
|
|
522
|
-
/**
|
|
523
|
-
* The response for a realm index.
|
|
524
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
525
|
-
*/
|
|
526
|
-
interface RealmIndexResponse extends ResponseBase {
|
|
527
|
-
realms: Array<Realm>;
|
|
528
|
-
}
|
|
529
|
-
type RealmLocales = 'deDE' | 'enGB' | 'enUS' | 'esES' | 'esMX' | 'frFR' | 'itIT' | 'koKR' | 'ptBR' | 'ptPT' | 'ruRU' | 'zhCN' | 'zhTW';
|
|
530
|
-
/**
|
|
531
|
-
* The response for a realm.
|
|
532
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
533
|
-
*/
|
|
534
|
-
interface RealmResponse extends NameId, ResponseBase {
|
|
535
|
-
category: RealmCategory;
|
|
536
|
-
connected_realm: Href;
|
|
537
|
-
is_tournament: boolean;
|
|
538
|
-
locale: RealmLocales;
|
|
539
|
-
region: NameIdKey;
|
|
540
|
-
slug: string;
|
|
541
|
-
timezone: RealmTimezone;
|
|
542
|
-
type: {
|
|
543
|
-
name: string;
|
|
544
|
-
type: RealmTypeCapitalized;
|
|
545
|
-
};
|
|
546
|
-
}
|
|
547
|
-
/**
|
|
548
|
-
* The search parameters for realms.
|
|
549
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
550
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
551
|
-
*/
|
|
552
|
-
interface RealmSearchParameters extends BaseSearchParameters {
|
|
553
|
-
timezone?: RealmTimezone;
|
|
554
|
-
}
|
|
555
|
-
/**
|
|
556
|
-
* The response for a realm search.
|
|
557
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
558
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
559
|
-
*/
|
|
560
|
-
interface RealmSearchResponse extends SearchResponseWithoutResults {
|
|
561
|
-
results: Array<RealmSearchResponseItem>;
|
|
562
|
-
}
|
|
563
|
-
/**
|
|
564
|
-
* The timezone of a realm.
|
|
565
|
-
*/
|
|
566
|
-
type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
|
|
567
|
-
type RealmTypeCapitalized = 'NORMAL' | 'RP';
|
|
568
|
-
/**
|
|
569
|
-
* The type of a realm, capitalized and shortended).
|
|
570
|
-
*/
|
|
571
|
-
interface RealmSearchResponseItem extends KeyBase {
|
|
572
|
-
data: {
|
|
573
|
-
category: Record<Locales, string>;
|
|
574
|
-
id: number;
|
|
575
|
-
is_tournament: boolean;
|
|
576
|
-
locale: RealmLocales;
|
|
577
|
-
name: Record<Locales, string>;
|
|
578
|
-
region: {
|
|
579
|
-
id: number;
|
|
580
|
-
name: Record<Locales, string>;
|
|
581
|
-
};
|
|
582
|
-
slug: string;
|
|
583
|
-
timezone: RealmTimezone;
|
|
584
|
-
type: {
|
|
585
|
-
name: string;
|
|
586
|
-
type: RealmTypeCapitalized;
|
|
587
|
-
};
|
|
588
|
-
};
|
|
589
|
-
}
|
|
590
|
-
//#endregion
|
|
591
|
-
//#region src/connected-realm/types.d.ts
|
|
592
|
-
/**
|
|
593
|
-
* Connected Realm Index API response.
|
|
594
|
-
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
595
|
-
*/
|
|
596
|
-
interface ConnectedRealmIndexResponse extends ResponseBase {
|
|
597
|
-
connected_realms: Array<Href>;
|
|
598
|
-
}
|
|
599
|
-
/**
|
|
600
|
-
* Connected Realm API response.
|
|
601
|
-
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
602
|
-
*/
|
|
603
|
-
interface ConnectedRealmResponse extends ResponseBase {
|
|
604
|
-
auctions: Href;
|
|
605
|
-
has_queue: boolean;
|
|
606
|
-
id: number;
|
|
607
|
-
population: {
|
|
608
|
-
name: string;
|
|
609
|
-
type: RealmPopulationCapitalized;
|
|
610
|
-
};
|
|
611
|
-
pvp_season?: Href;
|
|
612
|
-
realm_locked_status?: RealmLockedStatus;
|
|
613
|
-
realms: Array<Realm$1>;
|
|
614
|
-
status: {
|
|
615
|
-
name: string;
|
|
616
|
-
type: RealmStatusCapitalized;
|
|
617
|
-
};
|
|
618
|
-
}
|
|
619
|
-
/**
|
|
620
|
-
* Connected Realm Search API parameters.
|
|
621
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
622
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
623
|
-
*/
|
|
624
|
-
interface ConnectedRealmSearchParameters extends BaseSearchParameters {
|
|
625
|
-
'realms.timezone'?: RealmTimezone;
|
|
626
|
-
'status.type'?: RealmStatusCapitalized;
|
|
627
|
-
}
|
|
628
|
-
/**
|
|
629
|
-
* Connected Realm Search API response item.
|
|
630
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
631
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
632
|
-
*/
|
|
633
|
-
interface ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
|
|
634
|
-
results: Array<ConnectedRealmSearchResponseItem>;
|
|
635
|
-
}
|
|
636
|
-
interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
637
|
-
data: {
|
|
638
|
-
has_queue: boolean;
|
|
639
|
-
id: number;
|
|
640
|
-
population: SearchRealmPopulation;
|
|
641
|
-
realms: Array<SearchRealm>;
|
|
642
|
-
status: SearchRealmStatus;
|
|
643
|
-
};
|
|
644
|
-
}
|
|
645
|
-
interface Realm$1 {
|
|
646
|
-
category: RealmCategory;
|
|
647
|
-
connected_realm: Href;
|
|
648
|
-
id: number;
|
|
649
|
-
is_tournament: boolean;
|
|
650
|
-
locale: RealmLocales;
|
|
651
|
-
name: string;
|
|
652
|
-
region: NameIdKey;
|
|
653
|
-
slug: string;
|
|
654
|
-
timezone: RealmTimezone;
|
|
655
|
-
type: {
|
|
656
|
-
name: string;
|
|
657
|
-
type: RealmTypeCapitalized;
|
|
658
|
-
};
|
|
659
|
-
}
|
|
660
|
-
interface RealmLockedStatus {
|
|
661
|
-
is_locked_for_new_characters: boolean;
|
|
662
|
-
is_locked_for_pct: boolean;
|
|
663
|
-
}
|
|
664
|
-
type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOCKED' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
|
|
665
|
-
type RealmStatusCapitalized = 'DOWN' | 'UP';
|
|
666
|
-
interface SearchRealm {
|
|
667
|
-
category: Record<Locales, string>;
|
|
668
|
-
id: number;
|
|
669
|
-
is_tournament: boolean;
|
|
670
|
-
locale: RealmLocales;
|
|
671
|
-
name: Record<Locales, string | undefined>;
|
|
672
|
-
region: {
|
|
673
|
-
id: number;
|
|
674
|
-
name: Record<Locales, string>;
|
|
675
|
-
};
|
|
676
|
-
slug: string;
|
|
677
|
-
timezone: RealmTimezone;
|
|
678
|
-
type: {
|
|
679
|
-
name: Record<Locales, string>;
|
|
680
|
-
type: RealmTypeCapitalized;
|
|
681
|
-
};
|
|
682
|
-
}
|
|
683
|
-
interface SearchRealmPopulation {
|
|
684
|
-
name: Record<Locales, string>;
|
|
685
|
-
type: RealmPopulationCapitalized;
|
|
686
|
-
}
|
|
687
|
-
interface SearchRealmStatus {
|
|
688
|
-
name: Record<Locales, string>;
|
|
689
|
-
type: RealmStatusCapitalized;
|
|
690
|
-
}
|
|
691
|
-
//#endregion
|
|
692
|
-
//#region src/connected-realm/connected-realm.d.ts
|
|
693
|
-
/**
|
|
694
|
-
* Returns a connected realm by ID.
|
|
695
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
696
|
-
* @param connectedRealmId The connected realm ID.
|
|
697
|
-
* @returns The connected realm. See {@link ConnectedRealmResponse}.
|
|
698
|
-
*/
|
|
699
|
-
declare function connectedRealm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number): Resource<ConnectedRealmResponse>;
|
|
700
|
-
/**
|
|
701
|
-
* Returns an index of connected realms.
|
|
702
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
703
|
-
* @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
|
|
704
|
-
*/
|
|
705
|
-
declare function connectedRealmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<ConnectedRealmIndexResponse>;
|
|
706
|
-
/**
|
|
707
|
-
* Performs a search of connected realms.
|
|
708
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
709
|
-
* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
|
|
710
|
-
* @returns The search results. See {@link ConnectedRealmSearchResponse}.
|
|
711
|
-
*/
|
|
712
|
-
declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
|
|
713
|
-
//#endregion
|
|
714
|
-
//#region src/creature/types.d.ts
|
|
715
|
-
/**
|
|
716
|
-
* The response for creature display media.
|
|
717
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
718
|
-
*/
|
|
719
|
-
interface CreatureDisplayMediaResponse extends ResponseBase {
|
|
720
|
-
assets: Array<DisplayMediaAsset>;
|
|
721
|
-
id: number;
|
|
722
|
-
}
|
|
723
|
-
/**
|
|
724
|
-
* The response for a creature family index.
|
|
725
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
726
|
-
*/
|
|
727
|
-
interface CreatureFamilyIndexResponse extends ResponseBase {
|
|
728
|
-
creature_families: Array<NameIdKey>;
|
|
729
|
-
}
|
|
730
|
-
/**
|
|
731
|
-
* The response for creature family media.
|
|
732
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
733
|
-
*/
|
|
734
|
-
interface CreatureFamilyMediaResponse extends ResponseBase {
|
|
735
|
-
assets: Array<MediaAsset>;
|
|
736
|
-
id: number;
|
|
737
|
-
}
|
|
738
|
-
/**
|
|
739
|
-
* The response for a creature family.
|
|
740
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
741
|
-
*/
|
|
742
|
-
interface CreatureFamilyResponse extends ResponseBase {
|
|
743
|
-
id: number;
|
|
744
|
-
media?: Media$3;
|
|
745
|
-
name: string;
|
|
746
|
-
specialization?: NameIdKey;
|
|
747
|
-
}
|
|
748
|
-
/**
|
|
749
|
-
* The response for a creature.
|
|
750
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
751
|
-
*/
|
|
752
|
-
interface CreatureResponse extends ResponseBase {
|
|
753
|
-
creature_displays: Array<CreatureDisplay>;
|
|
754
|
-
family: NameIdKey;
|
|
755
|
-
id: number;
|
|
756
|
-
is_tameable: boolean;
|
|
757
|
-
name: string;
|
|
758
|
-
type: NameIdKey;
|
|
759
|
-
}
|
|
760
|
-
/**
|
|
761
|
-
* The search parameters for a creature.
|
|
762
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
763
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
764
|
-
*/
|
|
765
|
-
interface CreatureSearchParameters extends BaseSearchParameters {
|
|
766
|
-
locale: Locales;
|
|
767
|
-
name: string;
|
|
768
|
-
}
|
|
769
|
-
/**
|
|
770
|
-
* The response for a creature search.
|
|
771
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
772
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
773
|
-
*/
|
|
774
|
-
interface CreatureSearchResponse extends SearchResponseWithoutResults {
|
|
775
|
-
results: Array<CreatureSearchResponseItem>;
|
|
776
|
-
}
|
|
777
|
-
/**
|
|
778
|
-
* The response for a creature type index.
|
|
779
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
780
|
-
*/
|
|
781
|
-
interface CreatureTypeIndexResponse extends ResponseBase {
|
|
782
|
-
creature_types: Array<NameIdKey>;
|
|
783
|
-
}
|
|
784
|
-
/**
|
|
785
|
-
* The response for a creature type.
|
|
786
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
787
|
-
*/
|
|
788
|
-
interface CreatureTypeResponse extends ResponseBase {
|
|
789
|
-
id: number;
|
|
790
|
-
name: string;
|
|
791
|
-
}
|
|
792
|
-
interface CreatureDisplay extends KeyBase {
|
|
793
|
-
id: number;
|
|
794
|
-
}
|
|
795
|
-
interface CreatureSearchResponseItem extends KeyBase {
|
|
796
|
-
data: {
|
|
797
|
-
creature_displays: Array<{
|
|
798
|
-
id: number;
|
|
799
|
-
}>;
|
|
800
|
-
family?: {
|
|
801
|
-
id: number;
|
|
802
|
-
name: Record<Locales, string>;
|
|
803
|
-
};
|
|
804
|
-
id: number;
|
|
805
|
-
is_tameable: boolean;
|
|
806
|
-
name: Record<Locales, string | undefined>;
|
|
807
|
-
type: {
|
|
808
|
-
id: number;
|
|
809
|
-
name: Record<Locales, string>;
|
|
810
|
-
};
|
|
811
|
-
};
|
|
812
|
-
}
|
|
813
|
-
interface DisplayMediaAsset {
|
|
814
|
-
key: string;
|
|
815
|
-
value: string;
|
|
816
|
-
}
|
|
817
|
-
interface Media$3 extends KeyBase {
|
|
818
|
-
id: number;
|
|
819
|
-
}
|
|
820
|
-
//#endregion
|
|
821
|
-
//#region src/creature/creature.d.ts
|
|
822
|
-
/**
|
|
823
|
-
* Returns a creature by ID.
|
|
824
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
825
|
-
* @param creatureId The creature ID.
|
|
826
|
-
* @returns The creature. See {@link CreatureResponse}.
|
|
827
|
-
*/
|
|
828
|
-
declare function creature(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureId: number): Resource<CreatureResponse>;
|
|
829
|
-
/**
|
|
830
|
-
* Returns media for a creature display by ID.
|
|
831
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
832
|
-
* @param creatureDisplayId The creature display ID.
|
|
833
|
-
* @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
|
|
834
|
-
*/
|
|
835
|
-
declare function creatureDisplayMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureDisplayId: number): Resource<CreatureDisplayMediaResponse>;
|
|
836
|
-
/**
|
|
837
|
-
* Returns a creature family by ID.
|
|
838
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
839
|
-
* @param creatureFamilyId The creature family ID.
|
|
840
|
-
* @returns The creature family. See {@link CreatureFamilyResponse}.
|
|
841
|
-
*/
|
|
842
|
-
declare function creatureFamily(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureFamilyId: number): Resource<CreatureFamilyResponse>;
|
|
843
|
-
/**
|
|
844
|
-
* Returns an index of creature families.
|
|
845
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
846
|
-
* @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
|
|
847
|
-
*/
|
|
848
|
-
declare function creatureFamilyIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<CreatureFamilyIndexResponse>;
|
|
849
|
-
/**
|
|
850
|
-
* Returns media for a creature family by ID.
|
|
851
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
852
|
-
* @param creatureFamilyId The creature family ID.
|
|
853
|
-
* @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
|
|
854
|
-
*/
|
|
855
|
-
declare function creatureFamilyMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureFamilyId: number): Resource<CreatureFamilyMediaResponse>;
|
|
856
|
-
/**
|
|
857
|
-
* Performs a search of creatures.
|
|
858
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
859
|
-
* @param options The creature search parameters. See {@link CreatureSearchParameters}.
|
|
860
|
-
* @returns The creature search results. See {@link CreatureSearchResponse}.
|
|
861
|
-
*/
|
|
862
|
-
declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: CreatureSearchParameters): Resource<CreatureSearchResponse, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
|
|
863
|
-
/**
|
|
864
|
-
* Returns a creature type by ID.
|
|
865
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
866
|
-
* @param creatureTypeId The creature type ID.
|
|
867
|
-
* @returns The creature type. See {@link CreatureTypeResponse}.
|
|
868
|
-
*/
|
|
869
|
-
declare function creatureType(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureTypeId: number): Resource<CreatureTypeResponse>;
|
|
870
|
-
/**
|
|
871
|
-
* Returns an index of creature types.
|
|
872
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
873
|
-
* @returns The creature type index. See {@link CreatureTypeIndexResponse}.
|
|
874
|
-
*/
|
|
875
|
-
declare function creatureTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<CreatureTypeIndexResponse>;
|
|
876
|
-
//#endregion
|
|
877
|
-
//#region src/guild-crest/types.d.ts
|
|
878
|
-
/**
|
|
879
|
-
* The response for a guild crest border or emblem.
|
|
880
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
881
|
-
*/
|
|
882
|
-
interface GuildCrestBorderEmblemResponse extends ResponseBase {
|
|
883
|
-
assets: Array<GuildCrestAsset>;
|
|
884
|
-
id: number;
|
|
885
|
-
}
|
|
886
|
-
/**
|
|
887
|
-
* The response for the guild crest components index.
|
|
888
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
889
|
-
*/
|
|
890
|
-
interface GuildCrestComponentsIndexResponse extends ResponseBase {
|
|
891
|
-
borders: Array<Border$1>;
|
|
892
|
-
colors: Colors;
|
|
893
|
-
emblems: Array<Border$1>;
|
|
894
|
-
}
|
|
895
|
-
interface Background {
|
|
896
|
-
id: number;
|
|
897
|
-
rgba: Color;
|
|
898
|
-
}
|
|
899
|
-
interface Border$1 {
|
|
900
|
-
id: number;
|
|
901
|
-
media: Media$2;
|
|
902
|
-
}
|
|
903
|
-
interface Colors {
|
|
904
|
-
backgrounds?: Array<Background>;
|
|
905
|
-
borders?: Array<Background>;
|
|
906
|
-
emblems?: Array<Background>;
|
|
907
|
-
}
|
|
908
|
-
interface GuildCrestAsset {
|
|
909
|
-
key: string;
|
|
910
|
-
value: string;
|
|
911
|
-
}
|
|
912
|
-
interface Media$2 extends KeyBase {
|
|
913
|
-
id: number;
|
|
914
|
-
}
|
|
915
|
-
//#endregion
|
|
916
|
-
//#region src/guild-crest/guild-crest.d.ts
|
|
917
|
-
/**
|
|
918
|
-
* Returns media for a guild crest border by ID.
|
|
919
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
920
|
-
* @param borderId The guild crest border ID.
|
|
921
|
-
* @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
|
|
922
|
-
*/
|
|
923
|
-
declare function guildCrestBorder(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, borderId: number): Resource<GuildCrestBorderEmblemResponse>;
|
|
924
|
-
/**
|
|
925
|
-
* Returns an index of guild crest media.
|
|
926
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
927
|
-
* @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
|
|
928
|
-
*/
|
|
929
|
-
declare function guildCrestComponentsIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<GuildCrestComponentsIndexResponse>;
|
|
930
|
-
/**
|
|
931
|
-
* Returns media for a guild crest emblem by ID.
|
|
932
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
933
|
-
* @param emblemId The guild crest emblem ID.
|
|
934
|
-
* @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
|
|
935
|
-
*/
|
|
936
|
-
declare function guildCrestEmblem(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
|
|
937
|
-
//#endregion
|
|
938
|
-
//#region src/guild/types.d.ts
|
|
939
|
-
interface GuildAchievementsClassicEraResponse extends ResponseBase {
|
|
940
|
-
guild: Guild;
|
|
941
|
-
}
|
|
942
|
-
interface GuildAchievementsResponse extends ResponseBase {
|
|
943
|
-
achievements: Array<Achievement>;
|
|
944
|
-
category_progress: Array<CategoryProgress>;
|
|
945
|
-
guild: Guild;
|
|
946
|
-
recent_events: Array<RecentEvent>;
|
|
947
|
-
total_points: number;
|
|
948
|
-
total_quantity: number;
|
|
949
|
-
}
|
|
950
|
-
interface GuildActivityResponse extends ResponseBase {
|
|
951
|
-
activities?: Array<ActivityElement>;
|
|
952
|
-
guild: Guild;
|
|
953
|
-
}
|
|
954
|
-
interface GuildResponse extends ResponseBase {
|
|
955
|
-
achievement_points: number;
|
|
956
|
-
achievements: Href;
|
|
957
|
-
activity: Href;
|
|
958
|
-
created_timestamp: number;
|
|
959
|
-
crest?: Crest;
|
|
960
|
-
faction: Faction;
|
|
961
|
-
id: number;
|
|
962
|
-
member_count: number;
|
|
963
|
-
name: string;
|
|
964
|
-
name_search: string;
|
|
965
|
-
realm: Realm;
|
|
966
|
-
roster: Href;
|
|
967
|
-
}
|
|
968
|
-
interface GuildRosterResponse extends ResponseBase {
|
|
969
|
-
guild: Guild;
|
|
970
|
-
members: Array<Member>;
|
|
971
|
-
}
|
|
972
|
-
interface Achievement {
|
|
973
|
-
achievement: NameIdKey;
|
|
974
|
-
completed_timestamp?: number;
|
|
975
|
-
criteria?: Criteria;
|
|
976
|
-
id: number;
|
|
977
|
-
}
|
|
978
|
-
interface ActivityElement {
|
|
979
|
-
activity: {
|
|
980
|
-
type: string;
|
|
981
|
-
};
|
|
982
|
-
character_achievement: CharacterAchievement;
|
|
983
|
-
timestamp: number;
|
|
984
|
-
}
|
|
985
|
-
interface Border {
|
|
986
|
-
color: RgbWithId;
|
|
987
|
-
id: number;
|
|
988
|
-
media: KeyBase & {
|
|
989
|
-
id: number;
|
|
990
|
-
};
|
|
991
|
-
}
|
|
992
|
-
interface CategoryProgress {
|
|
993
|
-
category: NameIdKey;
|
|
994
|
-
points: number;
|
|
995
|
-
quantity: number;
|
|
996
|
-
}
|
|
997
|
-
interface CharacterAchievement {
|
|
998
|
-
achievement: NameIdKey;
|
|
999
|
-
character: Character;
|
|
1000
|
-
}
|
|
1001
|
-
interface ChildCriterum {
|
|
1002
|
-
amount: number;
|
|
1003
|
-
id: number;
|
|
1004
|
-
is_completed: boolean;
|
|
1005
|
-
}
|
|
1006
|
-
interface Crest {
|
|
1007
|
-
background: {
|
|
1008
|
-
color: RgbWithId;
|
|
1009
|
-
};
|
|
1010
|
-
border: Border;
|
|
1011
|
-
emblem: Border;
|
|
1012
|
-
}
|
|
1013
|
-
interface Criteria {
|
|
1014
|
-
amount?: number;
|
|
1015
|
-
child_criteria?: Array<ChildCriterum>;
|
|
1016
|
-
id: number;
|
|
1017
|
-
is_completed: boolean;
|
|
1018
|
-
}
|
|
1019
|
-
interface Guild extends NameIdKey {
|
|
1020
|
-
faction: Faction;
|
|
1021
|
-
realm: Realm;
|
|
1022
|
-
}
|
|
1023
|
-
interface Member {
|
|
1024
|
-
character: RosterMemberCharacter;
|
|
1025
|
-
rank: number;
|
|
1026
|
-
}
|
|
1027
|
-
interface Playable extends KeyBase {
|
|
1028
|
-
id: number;
|
|
1029
|
-
}
|
|
1030
|
-
interface RecentEvent {
|
|
1031
|
-
achievement: NameIdKey;
|
|
1032
|
-
timestamp: number;
|
|
1033
|
-
}
|
|
1034
|
-
interface RgbWithId {
|
|
1035
|
-
id: number;
|
|
1036
|
-
rgba: Color;
|
|
1037
|
-
}
|
|
1038
|
-
interface RosterMemberCharacter extends Character {
|
|
1039
|
-
level: number;
|
|
1040
|
-
playable_class: Playable;
|
|
1041
|
-
playable_race: Playable;
|
|
1042
|
-
}
|
|
1043
|
-
//#endregion
|
|
1044
|
-
//#region src/guild/guild.d.ts
|
|
1045
|
-
/**
|
|
1046
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1047
|
-
* @param realmSlug The slug of the realm.
|
|
1048
|
-
* @param nameSlug The lowercase name of the guild.
|
|
1049
|
-
* @returns a single guild by its name and realm.
|
|
1050
|
-
*/
|
|
1051
|
-
declare function guild(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildResponse>;
|
|
1052
|
-
/**
|
|
1053
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1054
|
-
* @param realmSlug The slug of the realm.
|
|
1055
|
-
* @param nameSlug The lowercase name of the guild.
|
|
1056
|
-
* @returns a single guild's achievements by name and realm.
|
|
1057
|
-
*/
|
|
1058
|
-
declare function guildAchievements<T extends Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>>(namespace: T, realmSlug: string, nameSlug: string): Resource<T extends 'profile-classic1x' ? GuildAchievementsClassicEraResponse : GuildAchievementsResponse>;
|
|
1059
|
-
/**
|
|
1060
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1061
|
-
* @param realmSlug The slug of the realm.
|
|
1062
|
-
* @param nameSlug The lowercase name of the guild.
|
|
1063
|
-
* @returns a single guild's activity by name and realm.
|
|
1064
|
-
*/
|
|
1065
|
-
declare function guildActivity(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
|
|
1066
|
-
/**
|
|
1067
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1068
|
-
* @param realmSlug The slug of the realm.
|
|
1069
|
-
* @param nameSlug The lowercase name of the guild.
|
|
1070
|
-
* @returns a single guild's roster by its name and realm.
|
|
1071
|
-
*/
|
|
1072
|
-
declare function guildRoster(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
|
|
1073
|
-
//#endregion
|
|
1074
|
-
//#region src/item/types.d.ts
|
|
1075
|
-
/**
|
|
1076
|
-
* The response for an item class index.
|
|
1077
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1078
|
-
*/
|
|
1079
|
-
interface ItemClassIndexResponse extends ResponseBase {
|
|
1080
|
-
item_classes: Array<NameIdKey>;
|
|
1081
|
-
}
|
|
1082
|
-
/**
|
|
1083
|
-
* The response for an item class.
|
|
1084
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1085
|
-
*/
|
|
1086
|
-
interface ItemClassResponse extends ResponseBase {
|
|
1087
|
-
class_id: number;
|
|
1088
|
-
item_subclasses: Array<NameIdKey>;
|
|
1089
|
-
name: string;
|
|
1090
|
-
}
|
|
1091
|
-
/**
|
|
1092
|
-
* The response for an item media.
|
|
1093
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1094
|
-
*/
|
|
1095
|
-
interface ItemMediaResponse extends ResponseBase {
|
|
1096
|
-
assets: Array<MediaAsset>;
|
|
1097
|
-
id: number;
|
|
1098
|
-
}
|
|
1099
|
-
/**
|
|
1100
|
-
* The response for an item.
|
|
1101
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1102
|
-
*/
|
|
1103
|
-
interface ItemResponse extends NameId, ResponseBase {
|
|
1104
|
-
description?: string;
|
|
1105
|
-
inventory_type: InventoryType;
|
|
1106
|
-
is_equippable: boolean;
|
|
1107
|
-
is_stackable: boolean;
|
|
1108
|
-
item_class: NameIdKey;
|
|
1109
|
-
item_subclass: NameIdKey;
|
|
1110
|
-
level: number;
|
|
1111
|
-
max_count: number;
|
|
1112
|
-
media: Media$1;
|
|
1113
|
-
preview_item: PreviewItem;
|
|
1114
|
-
purchase_price: number;
|
|
1115
|
-
purchase_quantity: number;
|
|
1116
|
-
quality: ItemQuality;
|
|
1117
|
-
required_level: number;
|
|
1118
|
-
sell_price: number;
|
|
1119
|
-
}
|
|
1120
|
-
/**
|
|
1121
|
-
* The parameters for an item search.
|
|
1122
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1123
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1124
|
-
*/
|
|
1125
|
-
interface ItemSearchParameters extends BaseSearchParameters {
|
|
1126
|
-
locale: Locales;
|
|
1127
|
-
name: string;
|
|
1128
|
-
}
|
|
1129
|
-
/**
|
|
1130
|
-
* The response for an item search.
|
|
1131
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1132
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1133
|
-
*/
|
|
1134
|
-
interface ItemSearchResponse extends SearchResponseWithoutResults {
|
|
1135
|
-
results: Array<ItemSearchResponseItem>;
|
|
1136
|
-
}
|
|
1137
|
-
/**
|
|
1138
|
-
* The response for an item subclass.
|
|
1139
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1140
|
-
*/
|
|
1141
|
-
interface ItemSubClassResponse extends ResponseBase {
|
|
1142
|
-
class_id: number;
|
|
1143
|
-
display_name: string;
|
|
1144
|
-
hide_subclass_in_tooltips: boolean;
|
|
1145
|
-
subclass_id: number;
|
|
1146
|
-
verbose_name: string;
|
|
1147
|
-
}
|
|
1148
|
-
interface Armor {
|
|
1149
|
-
display: Display;
|
|
1150
|
-
value: number;
|
|
1151
|
-
}
|
|
1152
|
-
interface Damage {
|
|
1153
|
-
damage_class: {
|
|
1154
|
-
name: string;
|
|
1155
|
-
type: string;
|
|
1156
|
-
};
|
|
1157
|
-
display_string: string;
|
|
1158
|
-
max_value: number;
|
|
1159
|
-
min_value: number;
|
|
1160
|
-
}
|
|
1161
|
-
interface Display {
|
|
1162
|
-
color: Color;
|
|
1163
|
-
display_string: string;
|
|
1164
|
-
}
|
|
1165
|
-
interface Durability {
|
|
1166
|
-
display_string: string;
|
|
1167
|
-
value: number;
|
|
1168
|
-
}
|
|
1169
|
-
interface InventoryType {
|
|
1170
|
-
name: Record<Locales, string>;
|
|
1171
|
-
type: 'BACK' | 'BAG' | 'CHEST' | 'FEET' | 'FINGER' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'NON_EQUIP' | 'SHIRT' | 'SHOULDER' | 'TABARD' | 'TRINKET' | 'TWOHWEAPON' | 'WAIST' | 'WRIST';
|
|
1172
|
-
}
|
|
1173
|
-
interface ItemQuality {
|
|
1174
|
-
name: Record<Locales, string>;
|
|
1175
|
-
type: 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
1176
|
-
}
|
|
1177
|
-
interface ItemSearchResponseItem extends KeyBase {
|
|
1178
|
-
data: {
|
|
1179
|
-
id: number;
|
|
1180
|
-
inventory_type: InventoryType;
|
|
1181
|
-
is_equippable: boolean;
|
|
1182
|
-
is_stackable: boolean;
|
|
1183
|
-
item_class: {
|
|
1184
|
-
id: number;
|
|
1185
|
-
name: Record<Locales, string>;
|
|
1186
|
-
};
|
|
1187
|
-
item_subclass: {
|
|
1188
|
-
id: number;
|
|
1189
|
-
name: Record<Locales, string>;
|
|
1190
|
-
};
|
|
1191
|
-
level: number;
|
|
1192
|
-
max_count: number;
|
|
1193
|
-
media: {
|
|
1194
|
-
id: number;
|
|
1195
|
-
};
|
|
1196
|
-
name: Record<Locales, string>;
|
|
1197
|
-
purchase_price: number;
|
|
1198
|
-
purchase_quantity: number;
|
|
1199
|
-
quality: ItemQuality;
|
|
1200
|
-
required_level: number;
|
|
1201
|
-
sell_price: number;
|
|
1202
|
-
};
|
|
1203
|
-
}
|
|
1204
|
-
interface Media$1 extends KeyBase {
|
|
1205
|
-
id: number;
|
|
1206
|
-
}
|
|
1207
|
-
interface PreviewItem {
|
|
1208
|
-
armor?: Armor;
|
|
1209
|
-
binding?: {
|
|
1210
|
-
name: string;
|
|
1211
|
-
type: string;
|
|
1212
|
-
};
|
|
1213
|
-
bonus_list?: Array<number>;
|
|
1214
|
-
container_slots?: Durability;
|
|
1215
|
-
context?: number;
|
|
1216
|
-
crafting_reagent?: string;
|
|
1217
|
-
description?: string;
|
|
1218
|
-
durability?: Durability;
|
|
1219
|
-
inventory_type: InventoryType;
|
|
1220
|
-
is_subclass_hidden?: boolean;
|
|
1221
|
-
item: Media$1;
|
|
1222
|
-
item_class: NameIdKey;
|
|
1223
|
-
item_subclass: NameIdKey;
|
|
1224
|
-
level?: Durability;
|
|
1225
|
-
media: Media$1;
|
|
1226
|
-
name: string;
|
|
1227
|
-
quality: ItemQuality;
|
|
1228
|
-
recipe?: Recipe;
|
|
1229
|
-
requirements?: Requirements;
|
|
1230
|
-
sell_price?: number;
|
|
1231
|
-
shield_block?: Armor;
|
|
1232
|
-
spells?: Array<Spell>;
|
|
1233
|
-
stats?: Array<Stat>;
|
|
1234
|
-
unique_equipped?: 'Unique';
|
|
1235
|
-
weapon?: Weapon;
|
|
1236
|
-
}
|
|
1237
|
-
interface Recipe {
|
|
1238
|
-
item: RecipeItem;
|
|
1239
|
-
reagents: Array<NameIdKey & {
|
|
1240
|
-
quantity: number;
|
|
1241
|
-
}>;
|
|
1242
|
-
reagents_display_string: string;
|
|
1243
|
-
}
|
|
1244
|
-
interface RecipeItem {
|
|
1245
|
-
armor?: Armor;
|
|
1246
|
-
binding: {
|
|
1247
|
-
name: string;
|
|
1248
|
-
type: string;
|
|
1249
|
-
};
|
|
1250
|
-
durability: Durability;
|
|
1251
|
-
inventory_type: InventoryType;
|
|
1252
|
-
item: Media$1;
|
|
1253
|
-
item_class: NameIdKey;
|
|
1254
|
-
item_subclass: NameIdKey;
|
|
1255
|
-
level: Durability;
|
|
1256
|
-
media: Media$1;
|
|
1257
|
-
name: string;
|
|
1258
|
-
quality: ItemQuality;
|
|
1259
|
-
requirements: Requirements;
|
|
1260
|
-
sell_price: {
|
|
1261
|
-
display_strings: RecipeItemDisplayStrings;
|
|
1262
|
-
value: number;
|
|
1263
|
-
};
|
|
1264
|
-
stats: Array<Stat>;
|
|
1265
|
-
weapon?: Weapon;
|
|
1266
|
-
}
|
|
1267
|
-
interface RecipeItemDisplayStrings {
|
|
1268
|
-
copper: string;
|
|
1269
|
-
gold: string;
|
|
1270
|
-
header: string;
|
|
1271
|
-
silver: string;
|
|
1272
|
-
}
|
|
1273
|
-
interface Requirements {
|
|
1274
|
-
level: Durability;
|
|
1275
|
-
}
|
|
1276
|
-
interface Spell {
|
|
1277
|
-
description: string;
|
|
1278
|
-
spell: NameIdKey;
|
|
1279
|
-
}
|
|
1280
|
-
interface Stat {
|
|
1281
|
-
display: Display;
|
|
1282
|
-
is_negated?: boolean;
|
|
1283
|
-
type: {
|
|
1284
|
-
name: StatType;
|
|
1285
|
-
type: StatTypeCapitalized;
|
|
1286
|
-
};
|
|
1287
|
-
value: number;
|
|
1288
|
-
}
|
|
1289
|
-
type StatType = 'Agility' | 'Critical Strike' | 'Haste' | 'Intellect' | 'Mastery' | 'Stamina' | 'Strength' | 'Versatility';
|
|
1290
|
-
type StatTypeCapitalized = 'AGILITY' | 'CRIT_RATING' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
|
|
1291
|
-
interface Weapon {
|
|
1292
|
-
attack_speed: Durability;
|
|
1293
|
-
damage: Damage;
|
|
1294
|
-
dps: Durability;
|
|
1295
|
-
}
|
|
1296
|
-
//#endregion
|
|
1297
|
-
//#region src/item/item.d.ts
|
|
1298
|
-
/**
|
|
1299
|
-
* Get an item by ID.
|
|
1300
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1301
|
-
* @param itemId The item ID.
|
|
1302
|
-
* @returns The item. See {@link ItemResponse}.
|
|
1303
|
-
*/
|
|
1304
|
-
declare function item(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, itemId: number): Resource<ItemResponse>;
|
|
1305
|
-
/**
|
|
1306
|
-
* Get an item class by ID.
|
|
1307
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1308
|
-
* @param itemClassId The item class ID.
|
|
1309
|
-
* @returns The item class. See {@link ItemClassResponse}.
|
|
1310
|
-
*/
|
|
1311
|
-
declare function itemClass(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, itemClassId: number): Resource<ItemClassResponse>;
|
|
1312
|
-
/**
|
|
1313
|
-
* Get an item class index.
|
|
1314
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1315
|
-
* @returns The item class index. See {@link ItemClassIndexResponse}.
|
|
1316
|
-
*/
|
|
1317
|
-
declare function itemClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<ItemClassIndexResponse>;
|
|
1318
|
-
/**
|
|
1319
|
-
* Get item media by ID.
|
|
1320
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1321
|
-
* @param itemId The item ID.
|
|
1322
|
-
* @returns The item media. See {@link ItemMediaResponse}.
|
|
1323
|
-
*/
|
|
1324
|
-
declare function itemMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, itemId: number): Resource<ItemMediaResponse>;
|
|
1325
|
-
/**
|
|
1326
|
-
* Search for items.
|
|
1327
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1328
|
-
* @param options The search parameters. See {@link ItemSearchParameters}.
|
|
1329
|
-
* @returns The search results. See {@link ItemSearchResponse}.
|
|
1330
|
-
*/
|
|
1331
|
-
declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: ItemSearchParameters): Resource<ItemSearchResponse, Omit<ItemSearchParameters, 'locale' | 'name'>>;
|
|
1332
|
-
/**
|
|
1333
|
-
* Get an item subclass by ID.
|
|
1334
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1335
|
-
* @param itemClassId The item class ID.
|
|
1336
|
-
* @param itemSubclassId The item subclass ID.
|
|
1337
|
-
* @returns The item subclass. See {@link ItemSubClassResponse}.
|
|
1338
|
-
*/
|
|
1339
|
-
declare function itemSubClass(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
|
|
1340
|
-
//#endregion
|
|
1341
|
-
//#region src/media-search/types.d.ts
|
|
1342
|
-
/**
|
|
1343
|
-
* The search parameters for media.
|
|
1344
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1345
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1346
|
-
*/
|
|
1347
|
-
interface MediaSearchParameters extends BaseSearchParameters {
|
|
1348
|
-
tags?: string;
|
|
1349
|
-
}
|
|
1350
|
-
/**
|
|
1351
|
-
* The response for a media search.
|
|
1352
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1353
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1354
|
-
*/
|
|
1355
|
-
interface MediaSearchResponse extends SearchResponseWithoutResults {
|
|
1356
|
-
results: Array<MediaSearchResponseItem>;
|
|
1357
|
-
}
|
|
1358
|
-
interface MediaSearchResponseItem extends KeyBase {
|
|
1359
|
-
data: {
|
|
1360
|
-
assets?: Array<MediaAsset>;
|
|
1361
|
-
id?: number;
|
|
1362
|
-
};
|
|
1363
|
-
}
|
|
1364
|
-
//#endregion
|
|
1365
|
-
//#region src/media-search/media-search.d.ts
|
|
1366
|
-
/**
|
|
1367
|
-
* Search for media.
|
|
1368
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1369
|
-
* @param options The search parameters. See {@link MediaSearchParameters}.
|
|
1370
|
-
* @returns The search results. See {@link MediaSearchResponse}.
|
|
1371
|
-
*/
|
|
1372
|
-
declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
|
|
1373
|
-
//#endregion
|
|
1374
|
-
//#region src/playable-class/types.d.ts
|
|
1375
|
-
/**
|
|
1376
|
-
* The response for a playable class index.
|
|
1377
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1378
|
-
*/
|
|
1379
|
-
interface PlayableClassIndexResponse extends ResponseBase {
|
|
1380
|
-
classes: Array<NameIdKey>;
|
|
1381
|
-
}
|
|
1382
|
-
/**
|
|
1383
|
-
* The response for playable class media.
|
|
1384
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1385
|
-
*/
|
|
1386
|
-
interface PlayableClassMediaResponse extends ResponseBase {
|
|
1387
|
-
assets: Array<MediaAsset>;
|
|
1388
|
-
id: number;
|
|
1389
|
-
}
|
|
1390
|
-
/**
|
|
1391
|
-
* The response for a playable class.
|
|
1392
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft-classic/game-data-apis}
|
|
1393
|
-
*/
|
|
1394
|
-
interface PlayableClassResponse extends NameId, ResponseBase {
|
|
1395
|
-
additional_power_types?: Array<NameIdKey>;
|
|
1396
|
-
gender_name: GenderName;
|
|
1397
|
-
media: Media;
|
|
1398
|
-
playable_races: Array<NameIdKey>;
|
|
1399
|
-
power_type: NameIdKey;
|
|
1400
|
-
pvp_talent_slots: Href;
|
|
1401
|
-
specializations?: Array<NameIdKey>;
|
|
1402
|
-
}
|
|
1403
|
-
interface Media extends KeyBase {
|
|
1404
|
-
id: number;
|
|
1405
|
-
}
|
|
1406
|
-
//#endregion
|
|
1407
|
-
//#region src/playable-class/playable-class.d.ts
|
|
1408
|
-
/**
|
|
1409
|
-
* Get a playable class by ID.
|
|
1410
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1411
|
-
* @param playableClassId The playable class ID.
|
|
1412
|
-
* @returns The playable class. See {@link PlayableClassResponse}.
|
|
1413
|
-
*/
|
|
1414
|
-
declare function playableClass(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableClassId: number): Resource<PlayableClassResponse>;
|
|
1415
|
-
/**
|
|
1416
|
-
* Get a playable class index.
|
|
1417
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1418
|
-
* @returns The playable class index. See {@link PlayableClassIndexResponse}.
|
|
1419
|
-
*/
|
|
1420
|
-
declare function playableClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PlayableClassIndexResponse>;
|
|
1421
|
-
/**
|
|
1422
|
-
* Get playable class media by ID.
|
|
1423
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1424
|
-
* @param playableClassId The playable class ID.
|
|
1425
|
-
* @returns The playable class media. See {@link PlayableClassMediaResponse}.
|
|
1426
|
-
*/
|
|
1427
|
-
declare function playableClassMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableClassId: number): Resource<PlayableClassMediaResponse>;
|
|
1428
|
-
//#endregion
|
|
1429
|
-
//#region src/playable-race/types.d.ts
|
|
1430
|
-
/**
|
|
1431
|
-
* The playable race index response.
|
|
1432
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1433
|
-
*/
|
|
1434
|
-
interface PlayableRaceIndexResponse extends ResponseBase {
|
|
1435
|
-
races: Array<NameIdKey>;
|
|
1436
|
-
}
|
|
1437
|
-
/**
|
|
1438
|
-
* The playable race response.
|
|
1439
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1440
|
-
*/
|
|
1441
|
-
interface PlayableRaceResponse extends NameId, ResponseBase {
|
|
1442
|
-
faction: Faction;
|
|
1443
|
-
gender_name: GenderName;
|
|
1444
|
-
is_allied_race: boolean;
|
|
1445
|
-
is_selectable: boolean;
|
|
1446
|
-
playable_classes: Array<NameIdKey>;
|
|
1447
|
-
racial_spells: Array<NameIdKey>;
|
|
1448
|
-
}
|
|
1449
|
-
//#endregion
|
|
1450
|
-
//#region src/playable-race/playable-race.d.ts
|
|
1451
|
-
/**
|
|
1452
|
-
* Get a playable race by ID.
|
|
1453
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1454
|
-
* @param playableRaceId The playable race ID.
|
|
1455
|
-
* @returns The playable race. See {@link PlayableRaceResponse}.
|
|
1456
|
-
*/
|
|
1457
|
-
declare function playableRace(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableRaceId: number): Resource<PlayableRaceResponse>;
|
|
1458
|
-
/**
|
|
1459
|
-
* Get a playable race index.
|
|
1460
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1461
|
-
* @returns The playable race index. See {@link PlayableRaceIndexResponse}.
|
|
1462
|
-
*/
|
|
1463
|
-
declare function playableRaceIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PlayableRaceIndexResponse>;
|
|
1464
|
-
//#endregion
|
|
1465
|
-
//#region src/power-type/types.d.ts
|
|
1466
|
-
/**
|
|
1467
|
-
* The response for a power type index.
|
|
1468
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1469
|
-
*/
|
|
1470
|
-
interface PowerTypeIndexResponse extends ResponseBase {
|
|
1471
|
-
power_types: Array<NameIdKey>;
|
|
1472
|
-
}
|
|
1473
|
-
/**
|
|
1474
|
-
* The response for a power type.
|
|
1475
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1476
|
-
*/
|
|
1477
|
-
interface PowerTypeResponse extends NameId, ResponseBase {}
|
|
1478
|
-
//#endregion
|
|
1479
|
-
//#region src/power-type/power-type.d.ts
|
|
1480
|
-
/**
|
|
1481
|
-
* Get a power type by ID.
|
|
1482
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1483
|
-
* @param powerTypeId The power type ID.
|
|
1484
|
-
* @returns The power type. See {@link PowerTypeResponse}.
|
|
1485
|
-
*/
|
|
1486
|
-
declare function powerType(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, powerTypeId: number): Resource<PowerTypeResponse>;
|
|
1487
|
-
/**
|
|
1488
|
-
* Get a power type index.
|
|
1489
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1490
|
-
* @returns The power type index. See {@link PowerTypeIndexResponse}.
|
|
1491
|
-
*/
|
|
1492
|
-
declare function powerTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PowerTypeIndexResponse>;
|
|
1493
|
-
//#endregion
|
|
1494
|
-
//#region src/pvp-season/types.d.ts
|
|
1495
|
-
/**
|
|
1496
|
-
* The response for a PvP season index.
|
|
1497
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1498
|
-
*/
|
|
1499
|
-
interface PvpSeasonIndexResponse extends ResponseBase {
|
|
1500
|
-
current_season: Season;
|
|
1501
|
-
seasons: Array<Season>;
|
|
1502
|
-
}
|
|
1503
|
-
/**
|
|
1504
|
-
* The response for a PvP season.
|
|
1505
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1506
|
-
*/
|
|
1507
|
-
interface PvpSeasonResponse extends ResponseBase {
|
|
1508
|
-
id: number;
|
|
1509
|
-
leaderboards: Href;
|
|
1510
|
-
rewards: Href;
|
|
1511
|
-
season_name?: string;
|
|
1512
|
-
season_start_timestamp: number;
|
|
1513
|
-
}
|
|
1514
|
-
interface Season extends KeyBase {
|
|
1515
|
-
id: number;
|
|
1516
|
-
}
|
|
1517
|
-
//#endregion
|
|
1518
|
-
//#region src/pvp-season/pvp-season.d.ts
|
|
1519
|
-
/**
|
|
1520
|
-
* Get a PvP leaderboard by PvP season ID and bracket.
|
|
1521
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1522
|
-
* @param pvpRegionId The PvP region ID.
|
|
1523
|
-
* @param pvpSeasonId The PvP season ID.
|
|
1524
|
-
* @param pvpBracket The PvP bracket.
|
|
1525
|
-
* @returns The PvP leaderboard.
|
|
1526
|
-
*/
|
|
1527
|
-
declare function pvpLeaderboard(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, pvpRegionId: number, pvpSeasonId: number, pvpBracket: string): Resource<unknown>;
|
|
1528
|
-
/**
|
|
1529
|
-
* Returns an index of PvP leaderboards for a PvP season in a given PvP region.
|
|
1530
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1531
|
-
* @param pvpRegionId The PvP region ID.
|
|
1532
|
-
* @param pvpSeasonId The PvP season ID.
|
|
1533
|
-
* @returns The PvP leaderboard index.
|
|
1534
|
-
*/
|
|
1535
|
-
declare function pvpLeaderboardIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
|
|
1536
|
-
/**
|
|
1537
|
-
* Returns a PvP season by region ID and season ID.
|
|
1538
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1539
|
-
* @param pvpRegionId The PvP region ID.
|
|
1540
|
-
* @param pvpSeasonId The PvP season ID.
|
|
1541
|
-
* @returns The PvP season.
|
|
1542
|
-
*/
|
|
1543
|
-
declare function pvpRegionalSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
|
|
1544
|
-
/**
|
|
1545
|
-
* Returns an index of PvP Seasons in a PvP region.
|
|
1546
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1547
|
-
* @param pvpRegionId The PvP region ID.
|
|
1548
|
-
* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
|
|
1549
|
-
*/
|
|
1550
|
-
declare function pvpRegionalSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, pvpRegionId: number): Resource<PvpSeasonIndexResponse>;
|
|
1551
|
-
/**
|
|
1552
|
-
* Returns an index of PvP Regions.
|
|
1553
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1554
|
-
* @returns The PvP region index.
|
|
1555
|
-
*/
|
|
1556
|
-
declare function pvpRegionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<unknown>;
|
|
1557
|
-
/**
|
|
1558
|
-
* Returns an index of PvP rewards for a PvP season in a given PvP region.
|
|
1559
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1560
|
-
* @param pvpRegionId The PvP region ID.
|
|
1561
|
-
* @param pvpSeasonId The PvP season ID.
|
|
1562
|
-
* @returns The PvP reward index.
|
|
1563
|
-
*/
|
|
1564
|
-
declare function pvpRewardsIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
|
|
1565
|
-
/**
|
|
1566
|
-
* Get a PvP season by ID.
|
|
1567
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1568
|
-
* @param pvpSeasonId The PvP season ID.
|
|
1569
|
-
* @returns The PvP season. See {@link PvpSeasonResponse}.
|
|
1570
|
-
*/
|
|
1571
|
-
declare function pvpSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, pvpSeasonId: number): Resource<PvpSeasonResponse>;
|
|
1572
|
-
/**
|
|
1573
|
-
* Get a PvP season index.
|
|
1574
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1575
|
-
* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
|
|
1576
|
-
*/
|
|
1577
|
-
declare function pvpSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<PvpSeasonIndexResponse>;
|
|
1578
|
-
//#endregion
|
|
1579
|
-
//#region src/realm/realm.d.ts
|
|
1580
|
-
/**
|
|
1581
|
-
* Get a realm by slug.
|
|
1582
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1583
|
-
* @param realmSlug The realm slug.
|
|
1584
|
-
* @returns The realm. See {@link RealmResponse}.
|
|
1585
|
-
*/
|
|
1586
|
-
declare function realm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, realmSlug: string): Resource<RealmResponse>;
|
|
1587
|
-
/**
|
|
1588
|
-
* Get a realm index.
|
|
1589
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1590
|
-
* @returns The realm index. See {@link RealmIndexResponse}.
|
|
1591
|
-
*/
|
|
1592
|
-
declare function realmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<RealmIndexResponse>;
|
|
1593
|
-
/**
|
|
1594
|
-
* Search for realms.
|
|
1595
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1596
|
-
* @param options The search parameters. See {@link RealmSearchParameters}.
|
|
1597
|
-
* @returns The search results. See {@link RealmSearchResponse}.
|
|
1598
|
-
*/
|
|
1599
|
-
declare function realmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: RealmSearchParameters): Resource<RealmSearchResponse, RealmSearchParameters>;
|
|
1600
|
-
//#endregion
|
|
1601
|
-
//#region src/region/types.d.ts
|
|
1602
|
-
/**
|
|
1603
|
-
* The response for a region index.
|
|
1604
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1605
|
-
*/
|
|
1606
|
-
interface RegionIndexResponse extends ResponseBase {
|
|
1607
|
-
regions: Array<Href>;
|
|
1608
|
-
}
|
|
1609
|
-
/**
|
|
1610
|
-
* The response for a region.
|
|
1611
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1612
|
-
*/
|
|
1613
|
-
interface RegionResponse extends NameId, ResponseBase {
|
|
1614
|
-
patch_string: string;
|
|
1615
|
-
tag: string;
|
|
1616
|
-
}
|
|
1617
|
-
//#endregion
|
|
1618
|
-
//#region src/region/region.d.ts
|
|
1619
|
-
/**
|
|
1620
|
-
* Get a region by ID.
|
|
1621
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1622
|
-
* @param regionId The region ID.
|
|
1623
|
-
* @returns The region. See {@link RegionResponse}.
|
|
1624
|
-
*/
|
|
1625
|
-
declare function region(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, regionId: number): Resource<RegionResponse>;
|
|
1626
|
-
/**
|
|
1627
|
-
* Get a region index.
|
|
1628
|
-
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
1629
|
-
* @returns The region index. See {@link RegionIndexResponse}.
|
|
1630
|
-
*/
|
|
1631
|
-
declare function regionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<RegionIndexResponse>;
|
|
1632
|
-
//#endregion
|
|
1633
23
|
//#region src/index.d.ts
|
|
1634
24
|
declare const classicWow: {
|
|
1635
25
|
auctionHouseIndex: typeof auctionHouseIndex;
|
|
@@ -1690,5 +80,5 @@ declare const classicWow: {
|
|
|
1690
80
|
regionIndex: typeof regionIndex;
|
|
1691
81
|
};
|
|
1692
82
|
//#endregion
|
|
1693
|
-
export { AuctionHouseIndexResponse, AuctionsResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse,
|
|
83
|
+
export { AuctionHouseIndexResponse, AuctionsResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse, CharacterProfileStatusResponse, CharacterProfileSummaryResponse, CharacterSpecializationsSummaryResponse, CharacterStatisticsSummaryResponse, ConnectedRealmIndexResponse, ConnectedRealmResponse, ConnectedRealmSearchParameters, ConnectedRealmSearchResponse, CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponse, CreatureTypeIndexResponse, CreatureTypeResponse, GuildAchievementsClassicEraResponse, GuildAchievementsResponse, GuildActivityResponse, GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse, GuildResponse, GuildRosterResponse, ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponse, ItemSubClassResponse, MediaSearchParameters, MediaSearchResponse, PlayableClassIndexResponse, PlayableClassMediaResponse, PlayableClassResponse, PlayableRaceIndexResponse, PlayableRaceResponse, PowerTypeIndexResponse, PowerTypeResponse, PvpSeasonIndexResponse, PvpSeasonResponse, RealmCategory, RealmIndexResponse, RealmLocales, RealmResponse, RealmSearchParameters, RealmSearchResponse, RealmTimezone, RealmTypeCapitalized, RegionIndexResponse, RegionResponse, auctionHouseIndex, auctions, characterAchievementStatistics, characterAchievementsSummary, characterEquipmentSummary, characterHunterPetsSummary, characterMediaSummary, characterProfileStatus, characterProfileSummary, characterSpecializationsSummary, characterStatisticsSummary, classicWow, classicWow as default, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSubClass, mediaSearch, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, powerType, powerTypeIndex, pvpLeaderboard, pvpLeaderboardIndex, pvpRegionIndex, pvpRegionalSeason, pvpRegionalSeasonIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, realm, realmIndex, realmSearch, region, regionIndex };
|
|
1694
84
|
//# sourceMappingURL=index.d.ts.map
|