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