@blizzard-api/classic-wow 1.1.1 → 1.1.3
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 +19 -14
- package/dist/index.cjs +103 -167
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +176 -176
- package/dist/index.d.ts +176 -176
- package/dist/index.js +56 -98
- package/dist/index.js.map +1 -1
- package/package.json +6 -4
package/dist/index.d.ts
CHANGED
|
@@ -22,8 +22,8 @@ interface KeyBase {
|
|
|
22
22
|
* Base record interface containing name and id properties that often appear together in Blizzard API responses.
|
|
23
23
|
*/
|
|
24
24
|
interface NameId {
|
|
25
|
-
name: string;
|
|
26
25
|
id: number;
|
|
26
|
+
name: string;
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
29
|
* Base record containing both {@link KeyBase} and {@link NameId} interfaces.
|
|
@@ -34,25 +34,25 @@ interface NameIdKey extends KeyBase, NameId {
|
|
|
34
34
|
* A record containing the RGBA values of a color.
|
|
35
35
|
*/
|
|
36
36
|
interface Color {
|
|
37
|
-
r: number;
|
|
38
|
-
g: number;
|
|
39
|
-
b: number;
|
|
40
37
|
a: number;
|
|
38
|
+
b: number;
|
|
39
|
+
g: number;
|
|
40
|
+
r: number;
|
|
41
41
|
}
|
|
42
42
|
/**
|
|
43
43
|
* The media asset associated with a character or entity in World of Warcraft.
|
|
44
44
|
*/
|
|
45
45
|
interface MediaAsset$1 {
|
|
46
|
+
file_data_id: number;
|
|
46
47
|
key: string;
|
|
47
48
|
value: string;
|
|
48
|
-
file_data_id: number;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* The playable genders in World of Warcraft.
|
|
52
52
|
*/
|
|
53
53
|
interface Gender {
|
|
54
|
-
male: string;
|
|
55
54
|
female: string;
|
|
55
|
+
male: string;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
58
|
* The playable factions in World of Warcraft.
|
|
@@ -65,8 +65,8 @@ declare const Factions: {
|
|
|
65
65
|
* The faction associated with a character or entity in World of Warcraft.
|
|
66
66
|
*/
|
|
67
67
|
interface Faction {
|
|
68
|
-
type: keyof typeof Factions;
|
|
69
68
|
name: Capitalize<Lowercase<keyof typeof Factions>>;
|
|
69
|
+
type: keyof typeof Factions;
|
|
70
70
|
}
|
|
71
71
|
|
|
72
72
|
interface AuctionHouseIndexResponse extends ResponseBase {
|
|
@@ -79,16 +79,16 @@ interface AuctionsResponse extends ResponseBase, NameId {
|
|
|
79
79
|
};
|
|
80
80
|
}
|
|
81
81
|
interface Auction {
|
|
82
|
+
bid: number;
|
|
83
|
+
buyout: number;
|
|
82
84
|
id: number;
|
|
83
85
|
item: {
|
|
84
86
|
id: number;
|
|
85
87
|
rand?: number;
|
|
86
88
|
seed?: number;
|
|
87
89
|
};
|
|
88
|
-
bid: number;
|
|
89
|
-
buyout: number;
|
|
90
90
|
quantity: number;
|
|
91
|
-
time_left: '
|
|
91
|
+
time_left: 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
|
|
92
92
|
}
|
|
93
93
|
|
|
94
94
|
/**
|
|
@@ -116,7 +116,7 @@ type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Su
|
|
|
116
116
|
* The category of a realm.
|
|
117
117
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
118
118
|
*/
|
|
119
|
-
type RealmCategory = 'English' | 'French' | 'German' | 'Italian' | '
|
|
119
|
+
type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'Latin America' | 'Oceanic' | 'PS' | 'Russian' | 'Spanish' | 'United States' | '한국';
|
|
120
120
|
/**
|
|
121
121
|
* The timezone of a realm.
|
|
122
122
|
*/
|
|
@@ -144,19 +144,19 @@ interface Realm$1 extends NameIdKey {
|
|
|
144
144
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
145
145
|
*/
|
|
146
146
|
interface RealmResponse extends ResponseBase, NameId {
|
|
147
|
-
|
|
147
|
+
category: RealmCategory;
|
|
148
148
|
connected_realm: {
|
|
149
149
|
href: string;
|
|
150
150
|
};
|
|
151
|
-
|
|
151
|
+
is_tournament: boolean;
|
|
152
152
|
locale: WithoutUnderscore<Locales>;
|
|
153
|
+
region: NameIdKey;
|
|
154
|
+
slug: string;
|
|
153
155
|
timezone: RealmTimezone;
|
|
154
156
|
type: {
|
|
155
|
-
type: RealmTypeCapitalized;
|
|
156
157
|
name: RealmType;
|
|
158
|
+
type: RealmTypeCapitalized;
|
|
157
159
|
};
|
|
158
|
-
is_tournament: boolean;
|
|
159
|
-
slug: string;
|
|
160
160
|
}
|
|
161
161
|
/**
|
|
162
162
|
* The search parameters for realms.
|
|
@@ -173,27 +173,27 @@ interface RealmSearchParameters extends BaseSearchParameters {
|
|
|
173
173
|
*/
|
|
174
174
|
interface RealmSearchResponseItem extends KeyBase {
|
|
175
175
|
data: {
|
|
176
|
+
category: Record<Locales, string | undefined>;
|
|
177
|
+
id: number;
|
|
176
178
|
is_tournament: boolean;
|
|
177
|
-
|
|
179
|
+
locale: WithoutUnderscore<Locales>;
|
|
178
180
|
name: Record<Locales, string | undefined>;
|
|
179
|
-
id: number;
|
|
180
181
|
region: {
|
|
181
|
-
name: Record<Locales, string | undefined>;
|
|
182
182
|
id: number;
|
|
183
|
+
name: Record<Locales, string | undefined>;
|
|
183
184
|
};
|
|
184
|
-
|
|
185
|
-
|
|
185
|
+
slug: string;
|
|
186
|
+
timezone: RealmTimezone;
|
|
186
187
|
type: {
|
|
187
|
-
type: RealmTypeCapitalized;
|
|
188
188
|
name: Record<Locales, string | undefined>;
|
|
189
|
+
type: RealmTypeCapitalized;
|
|
189
190
|
};
|
|
190
|
-
slug: string;
|
|
191
191
|
};
|
|
192
192
|
}
|
|
193
193
|
|
|
194
|
-
type RealmPopulation = '
|
|
195
|
-
type RealmPopulationCapitalized = '
|
|
196
|
-
type RealmStatus = '
|
|
194
|
+
type RealmPopulation = 'Full' | 'High' | 'Low' | 'Medium' | 'New Players';
|
|
195
|
+
type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
|
|
196
|
+
type RealmStatus = 'Down' | 'Up';
|
|
197
197
|
/**
|
|
198
198
|
* Connected Realm Index API response.
|
|
199
199
|
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
@@ -204,49 +204,49 @@ interface ConnectedRealmIndexResponse extends ResponseBase {
|
|
|
204
204
|
}>;
|
|
205
205
|
}
|
|
206
206
|
interface Realm {
|
|
207
|
-
|
|
208
|
-
region: NameIdKey;
|
|
207
|
+
category: RealmCategory;
|
|
209
208
|
connected_realm: {
|
|
210
209
|
href: string;
|
|
211
210
|
};
|
|
212
|
-
|
|
213
|
-
|
|
211
|
+
id: number;
|
|
212
|
+
is_tournament: boolean;
|
|
214
213
|
locale: WithoutUnderscore<Locales>;
|
|
214
|
+
name: string;
|
|
215
|
+
region: NameIdKey;
|
|
216
|
+
slug: string;
|
|
215
217
|
timezone: RealmTimezone;
|
|
216
218
|
type: {
|
|
217
|
-
type: RealmTypeCapitalized;
|
|
218
219
|
name: RealmType;
|
|
220
|
+
type: RealmTypeCapitalized;
|
|
219
221
|
};
|
|
220
|
-
is_tournament: boolean;
|
|
221
|
-
slug: string;
|
|
222
222
|
}
|
|
223
223
|
interface RealmLockedStatus {
|
|
224
|
-
is_locked_for_pct: boolean;
|
|
225
224
|
is_locked_for_new_characters: boolean;
|
|
225
|
+
is_locked_for_pct: boolean;
|
|
226
226
|
}
|
|
227
227
|
/**
|
|
228
228
|
* Connected Realm API response.
|
|
229
229
|
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
230
230
|
*/
|
|
231
231
|
interface ConnectedRealmResponse extends ResponseBase {
|
|
232
|
-
|
|
232
|
+
auctions: {
|
|
233
|
+
href: string;
|
|
234
|
+
};
|
|
233
235
|
has_queue: boolean;
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
236
|
+
id: number;
|
|
237
|
+
mythic_leaderboards: {
|
|
238
|
+
href: string;
|
|
237
239
|
};
|
|
238
240
|
population: {
|
|
239
|
-
type: RealmPopulationCapitalized;
|
|
240
241
|
name: RealmPopulation;
|
|
242
|
+
type: RealmPopulationCapitalized;
|
|
241
243
|
};
|
|
244
|
+
realm_locked_status?: RealmLockedStatus;
|
|
242
245
|
realms: Array<Realm>;
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
auctions: {
|
|
247
|
-
href: string;
|
|
246
|
+
status: {
|
|
247
|
+
name: RealmStatus;
|
|
248
|
+
type: Uppercase<RealmStatus>;
|
|
248
249
|
};
|
|
249
|
-
realm_locked_status?: RealmLockedStatus;
|
|
250
250
|
}
|
|
251
251
|
/**
|
|
252
252
|
* Connected Realm Search API parameters.
|
|
@@ -258,29 +258,29 @@ interface ConnectedRealmSearchParameters extends BaseSearchParameters {
|
|
|
258
258
|
'status.type'?: Uppercase<RealmStatus>;
|
|
259
259
|
}
|
|
260
260
|
interface SearchRealm {
|
|
261
|
+
category: Record<Locales, string | undefined>;
|
|
262
|
+
id: number;
|
|
261
263
|
is_tournament: boolean;
|
|
262
|
-
|
|
264
|
+
locale: WithoutUnderscore<Locales>;
|
|
263
265
|
name: Record<Locales, string | undefined>;
|
|
264
|
-
id: number;
|
|
265
|
-
category: Record<Locales, string | undefined>;
|
|
266
266
|
region: {
|
|
267
|
-
name: Record<Locales, string | undefined>;
|
|
268
267
|
id: number;
|
|
268
|
+
name: Record<Locales, string | undefined>;
|
|
269
269
|
};
|
|
270
|
-
|
|
270
|
+
slug: string;
|
|
271
|
+
timezone: RealmTimezone;
|
|
271
272
|
type: {
|
|
272
|
-
type: RealmTypeCapitalized;
|
|
273
273
|
name: Record<Locales, string | undefined>;
|
|
274
|
+
type: RealmTypeCapitalized;
|
|
274
275
|
};
|
|
275
|
-
slug: string;
|
|
276
276
|
}
|
|
277
277
|
interface SearchRealmStatus {
|
|
278
|
-
type: Uppercase<RealmStatus>;
|
|
279
278
|
name: Record<Locales, string>;
|
|
279
|
+
type: Uppercase<RealmStatus>;
|
|
280
280
|
}
|
|
281
281
|
interface SearchRealmPopulation {
|
|
282
|
-
type: RealmPopulationCapitalized;
|
|
283
282
|
name: Record<Locales, string>;
|
|
283
|
+
type: RealmPopulationCapitalized;
|
|
284
284
|
}
|
|
285
285
|
/**
|
|
286
286
|
* Connected Realm Search API response item.
|
|
@@ -289,11 +289,11 @@ interface SearchRealmPopulation {
|
|
|
289
289
|
*/
|
|
290
290
|
interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
291
291
|
data: {
|
|
292
|
-
id: number;
|
|
293
292
|
has_queue: boolean;
|
|
293
|
+
id: number;
|
|
294
|
+
population: SearchRealmPopulation;
|
|
294
295
|
realms: Array<SearchRealm>;
|
|
295
296
|
status: SearchRealmStatus;
|
|
296
|
-
population: SearchRealmPopulation;
|
|
297
297
|
};
|
|
298
298
|
}
|
|
299
299
|
|
|
@@ -323,12 +323,12 @@ declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dy
|
|
|
323
323
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
324
324
|
*/
|
|
325
325
|
interface CreatureResponse extends ResponseBase {
|
|
326
|
+
creature_displays: Array<CreatureDisplay>;
|
|
327
|
+
family: NameIdKey;
|
|
326
328
|
id: number;
|
|
329
|
+
is_tameable: boolean;
|
|
327
330
|
name: string;
|
|
328
331
|
type: NameIdKey;
|
|
329
|
-
family: NameIdKey;
|
|
330
|
-
creature_displays: Array<CreatureDisplay>;
|
|
331
|
-
is_tameable: boolean;
|
|
332
332
|
}
|
|
333
333
|
interface CreatureDisplay extends KeyBase {
|
|
334
334
|
id: number;
|
|
@@ -358,9 +358,9 @@ interface CreatureFamilyIndexResponse extends ResponseBase {
|
|
|
358
358
|
*/
|
|
359
359
|
interface CreatureFamilyResponse extends ResponseBase {
|
|
360
360
|
id: number;
|
|
361
|
+
media: Media$3;
|
|
361
362
|
name: string;
|
|
362
363
|
specialization: NameIdKey;
|
|
363
|
-
media: Media$3;
|
|
364
364
|
}
|
|
365
365
|
interface Media$3 extends KeyBase {
|
|
366
366
|
id: number;
|
|
@@ -394,8 +394,8 @@ interface CreatureTypeResponse extends ResponseBase {
|
|
|
394
394
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
395
395
|
*/
|
|
396
396
|
interface CreatureSearchParameters extends BaseSearchParameters {
|
|
397
|
-
name: string;
|
|
398
397
|
locale: Locales;
|
|
398
|
+
name: string;
|
|
399
399
|
}
|
|
400
400
|
/**
|
|
401
401
|
* The response for a creature search.
|
|
@@ -407,14 +407,14 @@ interface CreatureSearchResponseItem extends KeyBase {
|
|
|
407
407
|
creature_displays: Array<{
|
|
408
408
|
id: number;
|
|
409
409
|
}>;
|
|
410
|
-
|
|
411
|
-
name: Record<Locales, string | undefined>;
|
|
412
|
-
id: number;
|
|
413
|
-
type: {
|
|
410
|
+
family?: {
|
|
414
411
|
id: number;
|
|
415
412
|
name: Record<Locales, string | undefined>;
|
|
416
413
|
};
|
|
417
|
-
|
|
414
|
+
id: number;
|
|
415
|
+
is_tameable: boolean;
|
|
416
|
+
name: Record<Locales, string | undefined>;
|
|
417
|
+
type: {
|
|
418
418
|
id: number;
|
|
419
419
|
name: Record<Locales, string | undefined>;
|
|
420
420
|
};
|
|
@@ -474,16 +474,16 @@ declare function creatureTypeIndex(namespace: Extract<BlizzardNamespaces, 'stati
|
|
|
474
474
|
* @param options The creature search parameters. See {@link CreatureSearchParameters}.
|
|
475
475
|
* @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
|
|
476
476
|
*/
|
|
477
|
-
declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: CreatureSearchParameters): Resource<SearchResponse<CreatureSearchResponseItem>, Omit<CreatureSearchParameters, '
|
|
477
|
+
declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: CreatureSearchParameters): Resource<SearchResponse<CreatureSearchResponseItem>, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
|
|
478
478
|
|
|
479
479
|
/**
|
|
480
480
|
* The response for the guild crest components index.
|
|
481
481
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
482
482
|
*/
|
|
483
483
|
interface GuildCrestComponentsIndexResponse extends ResponseBase {
|
|
484
|
-
emblems: Array<Border>;
|
|
485
484
|
borders: Array<Border>;
|
|
486
485
|
colors: Colors;
|
|
486
|
+
emblems: Array<Border>;
|
|
487
487
|
}
|
|
488
488
|
interface Border {
|
|
489
489
|
id: number;
|
|
@@ -493,19 +493,19 @@ interface Media$2 extends KeyBase {
|
|
|
493
493
|
id: number;
|
|
494
494
|
}
|
|
495
495
|
interface Colors {
|
|
496
|
-
emblems: Array<Background>;
|
|
497
|
-
borders: Array<Background>;
|
|
498
496
|
backgrounds: Array<Background>;
|
|
497
|
+
borders: Array<Background>;
|
|
498
|
+
emblems: Array<Background>;
|
|
499
499
|
}
|
|
500
500
|
interface Background {
|
|
501
501
|
id: number;
|
|
502
502
|
rgba: RGBA;
|
|
503
503
|
}
|
|
504
504
|
interface RGBA {
|
|
505
|
-
r: number;
|
|
506
|
-
g: number;
|
|
507
|
-
b: number;
|
|
508
505
|
a: number;
|
|
506
|
+
b: number;
|
|
507
|
+
g: number;
|
|
508
|
+
r: number;
|
|
509
509
|
}
|
|
510
510
|
/**
|
|
511
511
|
* The response for a guild crest border or emblem.
|
|
@@ -543,109 +543,109 @@ declare function guildCrestEmblem(namespace: Extract<BlizzardNamespaces, 'static
|
|
|
543
543
|
|
|
544
544
|
interface ItemQuality {
|
|
545
545
|
name: Record<Locales, string | undefined>;
|
|
546
|
-
type: '
|
|
546
|
+
type: 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
547
547
|
}
|
|
548
548
|
interface InventoryType {
|
|
549
549
|
name: Record<Locales, string | undefined>;
|
|
550
|
-
type: '
|
|
550
|
+
type: 'BACK' | 'BAG' | 'CHEST' | 'FEET' | 'FINGER' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'NON_EQUIP' | 'SHIRT' | 'SHOULDER' | 'TABARD' | 'TRINKET' | 'TWOHWEAPON' | 'WAIST' | 'WRIST';
|
|
551
551
|
}
|
|
552
|
-
type StatTypeCapitalized = '
|
|
553
|
-
type StatType = '
|
|
552
|
+
type StatTypeCapitalized = 'AGILITY' | 'CRIT_RATING' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
|
|
553
|
+
type StatType = 'Agility' | 'Critical Strike' | 'Haste' | 'Intellect' | 'Mastery' | 'Stamina' | 'Strength' | 'Versatility';
|
|
554
554
|
/**
|
|
555
555
|
* The response for an item.
|
|
556
556
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
557
557
|
*/
|
|
558
558
|
interface ItemResponse extends ResponseBase, NameId {
|
|
559
|
-
|
|
560
|
-
level: number;
|
|
561
|
-
required_level: number;
|
|
562
|
-
media: Media$1;
|
|
563
|
-
item_class: NameIdKey;
|
|
564
|
-
item_subclass: NameIdKey;
|
|
559
|
+
description?: string;
|
|
565
560
|
inventory_type: InventoryType;
|
|
566
|
-
purchase_price: number;
|
|
567
|
-
sell_price: number;
|
|
568
|
-
max_count: number;
|
|
569
561
|
is_equippable: boolean;
|
|
570
562
|
is_stackable: boolean;
|
|
563
|
+
item_class: NameIdKey;
|
|
564
|
+
item_subclass: NameIdKey;
|
|
565
|
+
level: number;
|
|
566
|
+
max_count: number;
|
|
567
|
+
media: Media$1;
|
|
571
568
|
preview_item: PreviewItem;
|
|
569
|
+
purchase_price: number;
|
|
572
570
|
purchase_quantity: number;
|
|
573
|
-
|
|
571
|
+
quality: ItemQuality;
|
|
572
|
+
required_level: number;
|
|
573
|
+
sell_price: number;
|
|
574
574
|
}
|
|
575
575
|
interface Media$1 extends KeyBase {
|
|
576
576
|
id: number;
|
|
577
577
|
}
|
|
578
578
|
interface PreviewItem {
|
|
579
|
-
|
|
580
|
-
quality: ItemQuality;
|
|
581
|
-
name: string;
|
|
582
|
-
media: Media$1;
|
|
583
|
-
item_class: NameIdKey;
|
|
584
|
-
item_subclass: NameIdKey;
|
|
585
|
-
inventory_type: InventoryType;
|
|
579
|
+
armor?: Armor;
|
|
586
580
|
binding?: {
|
|
587
|
-
type: string;
|
|
588
581
|
name: string;
|
|
582
|
+
type: string;
|
|
589
583
|
};
|
|
590
|
-
armor?: Armor;
|
|
591
|
-
sell_price?: number;
|
|
592
|
-
requirements?: Requirements;
|
|
593
|
-
level?: Durability;
|
|
594
|
-
is_subclass_hidden?: boolean;
|
|
595
|
-
spells?: Array<Spell>;
|
|
596
|
-
context?: number;
|
|
597
584
|
bonus_list?: Array<number>;
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
585
|
+
container_slots?: Durability;
|
|
586
|
+
context?: number;
|
|
587
|
+
crafting_reagent?: string;
|
|
601
588
|
description?: string;
|
|
589
|
+
durability?: Durability;
|
|
590
|
+
inventory_type: InventoryType;
|
|
591
|
+
is_subclass_hidden?: boolean;
|
|
592
|
+
item: Media$1;
|
|
593
|
+
item_class: NameIdKey;
|
|
594
|
+
item_subclass: NameIdKey;
|
|
595
|
+
level?: Durability;
|
|
596
|
+
media: Media$1;
|
|
597
|
+
name: string;
|
|
598
|
+
quality: ItemQuality;
|
|
602
599
|
recipe?: Recipe;
|
|
600
|
+
requirements?: Requirements;
|
|
601
|
+
sell_price?: number;
|
|
603
602
|
shield_block?: Armor;
|
|
603
|
+
spells?: Array<Spell>;
|
|
604
|
+
stats?: Array<Stat>;
|
|
604
605
|
unique_equipped?: 'Unique';
|
|
605
|
-
|
|
606
|
-
container_slots?: Durability;
|
|
606
|
+
weapon?: Weapon;
|
|
607
607
|
}
|
|
608
608
|
interface Armor {
|
|
609
|
-
value: number;
|
|
610
609
|
display: Display;
|
|
610
|
+
value: number;
|
|
611
611
|
}
|
|
612
612
|
interface Durability {
|
|
613
|
-
value: number;
|
|
614
613
|
display_string: string;
|
|
614
|
+
value: number;
|
|
615
615
|
}
|
|
616
616
|
interface Requirements {
|
|
617
617
|
level: Durability;
|
|
618
618
|
}
|
|
619
619
|
interface Spell {
|
|
620
|
-
spell: NameIdKey;
|
|
621
620
|
description: string;
|
|
621
|
+
spell: NameIdKey;
|
|
622
622
|
}
|
|
623
623
|
interface Stat {
|
|
624
|
+
display: Display;
|
|
625
|
+
is_negated?: boolean;
|
|
624
626
|
type: {
|
|
625
|
-
type: StatTypeCapitalized;
|
|
626
627
|
name: StatType;
|
|
628
|
+
type: StatTypeCapitalized;
|
|
627
629
|
};
|
|
628
630
|
value: number;
|
|
629
|
-
is_negated?: boolean;
|
|
630
|
-
display: Display;
|
|
631
631
|
}
|
|
632
632
|
interface Display {
|
|
633
|
-
display_string: string;
|
|
634
633
|
color: Color;
|
|
634
|
+
display_string: string;
|
|
635
635
|
}
|
|
636
636
|
interface Weapon {
|
|
637
|
-
damage: Damage;
|
|
638
637
|
attack_speed: Durability;
|
|
638
|
+
damage: Damage;
|
|
639
639
|
dps: Durability;
|
|
640
640
|
}
|
|
641
641
|
interface Damage {
|
|
642
|
-
min_value: number;
|
|
643
|
-
max_value: number;
|
|
644
|
-
display_string: string;
|
|
645
642
|
damage_class: {
|
|
646
|
-
type: string;
|
|
647
643
|
name: string;
|
|
644
|
+
type: string;
|
|
648
645
|
};
|
|
646
|
+
display_string: string;
|
|
647
|
+
max_value: number;
|
|
648
|
+
min_value: number;
|
|
649
649
|
}
|
|
650
650
|
interface Recipe {
|
|
651
651
|
item: RecipeItem;
|
|
@@ -655,33 +655,33 @@ interface Recipe {
|
|
|
655
655
|
reagents_display_string: string;
|
|
656
656
|
}
|
|
657
657
|
interface RecipeItem {
|
|
658
|
-
|
|
659
|
-
quality: ItemQuality;
|
|
660
|
-
name: string;
|
|
661
|
-
media: Media$1;
|
|
662
|
-
item_class: NameIdKey;
|
|
663
|
-
item_subclass: NameIdKey;
|
|
664
|
-
inventory_type: InventoryType;
|
|
658
|
+
armor?: Armor;
|
|
665
659
|
binding: {
|
|
666
|
-
type: string;
|
|
667
660
|
name: string;
|
|
661
|
+
type: string;
|
|
668
662
|
};
|
|
669
|
-
|
|
670
|
-
|
|
663
|
+
durability: Durability;
|
|
664
|
+
inventory_type: InventoryType;
|
|
665
|
+
item: Media$1;
|
|
666
|
+
item_class: NameIdKey;
|
|
667
|
+
item_subclass: NameIdKey;
|
|
668
|
+
level: Durability;
|
|
669
|
+
media: Media$1;
|
|
670
|
+
name: string;
|
|
671
|
+
quality: ItemQuality;
|
|
672
|
+
requirements: Requirements;
|
|
671
673
|
sell_price: {
|
|
672
|
-
value: number;
|
|
673
674
|
display_strings: RecipeItemDisplayStrings;
|
|
675
|
+
value: number;
|
|
674
676
|
};
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
durability: Durability;
|
|
678
|
-
armor?: Armor;
|
|
677
|
+
stats: Array<Stat>;
|
|
678
|
+
weapon?: Weapon;
|
|
679
679
|
}
|
|
680
680
|
interface RecipeItemDisplayStrings {
|
|
681
|
-
|
|
681
|
+
copper: string;
|
|
682
682
|
gold: string;
|
|
683
|
+
header: string;
|
|
683
684
|
silver: string;
|
|
684
|
-
copper: string;
|
|
685
685
|
}
|
|
686
686
|
/**
|
|
687
687
|
* The response for an item class index.
|
|
@@ -696,8 +696,8 @@ interface ItemClassIndexResponse extends ResponseBase {
|
|
|
696
696
|
*/
|
|
697
697
|
interface ItemClassResponse extends ResponseBase {
|
|
698
698
|
class_id: number;
|
|
699
|
-
name: string;
|
|
700
699
|
item_subclasses: Array<NameIdKey>;
|
|
700
|
+
name: string;
|
|
701
701
|
}
|
|
702
702
|
/**
|
|
703
703
|
* The response for an item media.
|
|
@@ -713,10 +713,10 @@ interface ItemMediaResponse extends ResponseBase {
|
|
|
713
713
|
*/
|
|
714
714
|
interface ItemSubClassResponse extends ResponseBase {
|
|
715
715
|
class_id: number;
|
|
716
|
-
subclass_id: number;
|
|
717
716
|
display_name: string;
|
|
718
|
-
verbose_name: string;
|
|
719
717
|
hide_subclass_in_tooltips: boolean;
|
|
718
|
+
subclass_id: number;
|
|
719
|
+
verbose_name: string;
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
722
|
* The parameters for an item search.
|
|
@@ -724,8 +724,8 @@ interface ItemSubClassResponse extends ResponseBase {
|
|
|
724
724
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
725
725
|
*/
|
|
726
726
|
interface ItemSearchParameters extends BaseSearchParameters {
|
|
727
|
-
name: string;
|
|
728
727
|
locale: Locales;
|
|
728
|
+
name: string;
|
|
729
729
|
}
|
|
730
730
|
/**
|
|
731
731
|
* The response for an item search.
|
|
@@ -734,29 +734,29 @@ interface ItemSearchParameters extends BaseSearchParameters {
|
|
|
734
734
|
*/
|
|
735
735
|
interface ItemSearchResponseItem extends KeyBase {
|
|
736
736
|
data: {
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
sell_price: number;
|
|
740
|
-
item_subclass: {
|
|
741
|
-
name: Record<Locales, string | undefined>;
|
|
742
|
-
id: number;
|
|
743
|
-
};
|
|
737
|
+
id: number;
|
|
738
|
+
inventory_type: InventoryType;
|
|
744
739
|
is_equippable: boolean;
|
|
745
|
-
|
|
746
|
-
media: {
|
|
747
|
-
id: number;
|
|
748
|
-
};
|
|
740
|
+
is_stackable: boolean;
|
|
749
741
|
item_class: {
|
|
742
|
+
id: number;
|
|
750
743
|
name: Record<Locales, string | undefined>;
|
|
744
|
+
};
|
|
745
|
+
item_subclass: {
|
|
751
746
|
id: number;
|
|
747
|
+
name: Record<Locales, string | undefined>;
|
|
752
748
|
};
|
|
753
|
-
|
|
749
|
+
level: number;
|
|
754
750
|
max_count: number;
|
|
755
|
-
|
|
751
|
+
media: {
|
|
752
|
+
id: number;
|
|
753
|
+
};
|
|
756
754
|
name: Record<Locales, string | undefined>;
|
|
757
755
|
purchase_price: number;
|
|
758
|
-
|
|
759
|
-
|
|
756
|
+
purchase_quantity: number;
|
|
757
|
+
quality: ItemQuality;
|
|
758
|
+
required_level: number;
|
|
759
|
+
sell_price: number;
|
|
760
760
|
};
|
|
761
761
|
}
|
|
762
762
|
|
|
@@ -801,7 +801,7 @@ declare function itemMedia(namespace: Extract<BlizzardNamespaces, 'static-classi
|
|
|
801
801
|
* @param options The search parameters. See {@link ItemSearchParameters}.
|
|
802
802
|
* @returns The search results. See {@link SearchResponse}.
|
|
803
803
|
*/
|
|
804
|
-
declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, '
|
|
804
|
+
declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, 'locale' | 'name'>>;
|
|
805
805
|
|
|
806
806
|
/**
|
|
807
807
|
* The search parameters for media.
|
|
@@ -818,8 +818,8 @@ interface MediaSearchParameters extends BaseSearchParameters {
|
|
|
818
818
|
*/
|
|
819
819
|
interface MediaSearchResponseItem extends KeyBase {
|
|
820
820
|
data: {
|
|
821
|
-
id: number;
|
|
822
821
|
assets: Array<MediaAsset>;
|
|
822
|
+
id: number;
|
|
823
823
|
};
|
|
824
824
|
}
|
|
825
825
|
interface MediaAsset {
|
|
@@ -857,12 +857,12 @@ interface PlayableClassMediaResponse extends ResponseBase {
|
|
|
857
857
|
*/
|
|
858
858
|
interface PlayableClassResponse extends ResponseBase, NameId {
|
|
859
859
|
gender_name: Gender;
|
|
860
|
-
power_type: NameIdKey;
|
|
861
860
|
media: Media;
|
|
861
|
+
playable_races: Array<NameIdKey>;
|
|
862
|
+
power_type: NameIdKey;
|
|
862
863
|
pvp_talent_slots: {
|
|
863
864
|
href: string;
|
|
864
865
|
};
|
|
865
|
-
playable_races: Array<NameIdKey>;
|
|
866
866
|
}
|
|
867
867
|
interface Media extends KeyBase {
|
|
868
868
|
id: number;
|
|
@@ -901,10 +901,10 @@ interface PlayableRaceIndexResponse extends ResponseBase {
|
|
|
901
901
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
902
902
|
*/
|
|
903
903
|
interface PlayableRaceResponse extends ResponseBase, NameId {
|
|
904
|
-
gender_name: Gender;
|
|
905
904
|
faction: Faction;
|
|
906
|
-
|
|
905
|
+
gender_name: Gender;
|
|
907
906
|
is_allied_race: boolean;
|
|
907
|
+
is_selectable: boolean;
|
|
908
908
|
playable_classes: Array<NameIdKey>;
|
|
909
909
|
}
|
|
910
910
|
|
|
@@ -955,8 +955,8 @@ declare function powerTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-c
|
|
|
955
955
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
956
956
|
*/
|
|
957
957
|
interface PvpSeasonIndexResponse extends ResponseBase {
|
|
958
|
-
seasons: Array<Season>;
|
|
959
958
|
current_season: Season;
|
|
959
|
+
seasons: Array<Season>;
|
|
960
960
|
}
|
|
961
961
|
interface Season extends KeyBase {
|
|
962
962
|
id: number;
|
|
@@ -973,8 +973,8 @@ interface PvpSeasonResponse extends ResponseBase {
|
|
|
973
973
|
rewards: {
|
|
974
974
|
href: string;
|
|
975
975
|
};
|
|
976
|
-
season_start_timestamp: number;
|
|
977
976
|
season_name?: string;
|
|
977
|
+
season_start_timestamp: number;
|
|
978
978
|
}
|
|
979
979
|
|
|
980
980
|
/**
|
|
@@ -1066,8 +1066,8 @@ interface RegionIndexResponse extends ResponseBase {
|
|
|
1066
1066
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1067
1067
|
*/
|
|
1068
1068
|
interface RegionResponse extends ResponseBase, NameId {
|
|
1069
|
-
tag: string;
|
|
1070
1069
|
patch_string: string;
|
|
1070
|
+
tag: string;
|
|
1071
1071
|
}
|
|
1072
1072
|
|
|
1073
1073
|
/**
|
|
@@ -1095,18 +1095,18 @@ declare const classicWow: {
|
|
|
1095
1095
|
creatureFamily: typeof creatureFamily;
|
|
1096
1096
|
creatureFamilyIndex: typeof creatureFamilyIndex;
|
|
1097
1097
|
creatureFamilyMedia: typeof creatureFamilyMedia;
|
|
1098
|
+
creatureSearch: typeof creatureSearch;
|
|
1098
1099
|
creatureType: typeof creatureType;
|
|
1099
1100
|
creatureTypeIndex: typeof creatureTypeIndex;
|
|
1100
|
-
creatureSearch: typeof creatureSearch;
|
|
1101
|
-
guildCrestComponentsIndex: typeof guildCrestComponentsIndex;
|
|
1102
1101
|
guildCrestBorder: typeof guildCrestBorder;
|
|
1102
|
+
guildCrestComponentsIndex: typeof guildCrestComponentsIndex;
|
|
1103
1103
|
guildCrestEmblem: typeof guildCrestEmblem;
|
|
1104
|
-
itemClassIndex: typeof itemClassIndex;
|
|
1105
|
-
itemClass: typeof itemClass;
|
|
1106
|
-
itemSubClass: typeof itemSubClass;
|
|
1107
1104
|
item: typeof item;
|
|
1105
|
+
itemClass: typeof itemClass;
|
|
1106
|
+
itemClassIndex: typeof itemClassIndex;
|
|
1108
1107
|
itemMedia: typeof itemMedia;
|
|
1109
1108
|
itemSearch: typeof itemSearch;
|
|
1109
|
+
itemSubClass: typeof itemSubClass;
|
|
1110
1110
|
mediaSearch: typeof mediaSearch;
|
|
1111
1111
|
playableClass: typeof playableClass;
|
|
1112
1112
|
playableClassIndex: typeof playableClassIndex;
|
|
@@ -1115,14 +1115,14 @@ declare const classicWow: {
|
|
|
1115
1115
|
playableRaceIndex: typeof playableRaceIndex;
|
|
1116
1116
|
powerType: typeof powerType;
|
|
1117
1117
|
powerTypeIndex: typeof powerTypeIndex;
|
|
1118
|
-
pvpSeasonIndex: typeof pvpSeasonIndex;
|
|
1119
|
-
pvpSeason: typeof pvpSeason;
|
|
1120
|
-
pvpRegionIndex: typeof pvpRegionIndex;
|
|
1121
|
-
pvpRegionalSeasonIndex: typeof pvpRegionalSeasonIndex;
|
|
1122
|
-
pvpRegionalSeason: typeof pvpRegionalSeason;
|
|
1123
|
-
pvpLeaderboardIndex: typeof pvpLeaderboardIndex;
|
|
1124
1118
|
pvpLeaderboard: typeof pvpLeaderboard;
|
|
1119
|
+
pvpLeaderboardIndex: typeof pvpLeaderboardIndex;
|
|
1120
|
+
pvpRegionalSeason: typeof pvpRegionalSeason;
|
|
1121
|
+
pvpRegionalSeasonIndex: typeof pvpRegionalSeasonIndex;
|
|
1122
|
+
pvpRegionIndex: typeof pvpRegionIndex;
|
|
1125
1123
|
pvpRewardsIndex: typeof pvpRewardsIndex;
|
|
1124
|
+
pvpSeason: typeof pvpSeason;
|
|
1125
|
+
pvpSeasonIndex: typeof pvpSeasonIndex;
|
|
1126
1126
|
realm: typeof realm;
|
|
1127
1127
|
realmIndex: typeof realmIndex;
|
|
1128
1128
|
realmSearch: typeof realmSearch;
|
|
@@ -1130,4 +1130,4 @@ declare const classicWow: {
|
|
|
1130
1130
|
regionIndex: typeof regionIndex;
|
|
1131
1131
|
};
|
|
1132
1132
|
|
|
1133
|
-
export { type AuctionHouseIndexResponse, type AuctionsResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSubClassResponse, type MediaSearchParameters, type MediaSearchResponseItem, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RegionIndexResponse, type RegionResponse, type WithoutUnderscore, auctionHouseIndex, auctions, classicWow, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, 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 };
|
|
1133
|
+
export { type AuctionHouseIndexResponse, type AuctionsResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSubClassResponse, type MediaSearchParameters, type MediaSearchResponseItem, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RegionIndexResponse, type RegionResponse, type WithoutUnderscore, auctionHouseIndex, auctions, classicWow, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, classicWow as default, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, 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 };
|