@blizzard-api/wow 2.1.0 → 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 +80 -80
- package/dist/index.d.ts +694 -621
- package/dist/index.js +150 -383
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,108 +1,5 @@
|
|
|
1
|
-
import { BaseSearchParameters, Locales, Origins, ProtectedResource, Resource,
|
|
1
|
+
import { BaseSearchParameters, Character, Color, Faction, Factions, Gender, GenderName, Href, KeyBase, Locales, MediaAsset, NameId, NameIdKey, Origins, ProtectedResource, Realm, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
|
|
2
2
|
|
|
3
|
-
//#region src/base.d.ts
|
|
4
|
-
/**
|
|
5
|
-
*
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* A record containing the RGBA values of a color.
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
*
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* A record containing the RGBA values of a color.
|
|
16
|
-
*/
|
|
17
|
-
interface Color {
|
|
18
|
-
a: number;
|
|
19
|
-
b: number;
|
|
20
|
-
g: number;
|
|
21
|
-
r: number;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* The playable gender names/descriptions in World of Warcraft.
|
|
25
|
-
*/
|
|
26
|
-
interface GenderName {
|
|
27
|
-
female: string;
|
|
28
|
-
male: string;
|
|
29
|
-
}
|
|
30
|
-
interface Href {
|
|
31
|
-
href: string;
|
|
32
|
-
}
|
|
33
|
-
/**
|
|
34
|
-
* Base record interface containing key.href property that often appear in Blizzard API responses.
|
|
35
|
-
*/
|
|
36
|
-
interface KeyBase {
|
|
37
|
-
key: Href;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* The media asset associated with a character or entity in World of Warcraft.
|
|
41
|
-
*/
|
|
42
|
-
interface MediaAsset$1 {
|
|
43
|
-
file_data_id: number;
|
|
44
|
-
key: string;
|
|
45
|
-
value: string;
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Base record interface containing name and id properties that often appear together in Blizzard API responses.
|
|
49
|
-
*/
|
|
50
|
-
interface NameId {
|
|
51
|
-
id: number;
|
|
52
|
-
name: string;
|
|
53
|
-
}
|
|
54
|
-
/**
|
|
55
|
-
* Base record containing both {@link KeyBase} and {@link NameId} interfaces.
|
|
56
|
-
*/
|
|
57
|
-
interface NameIdKey extends KeyBase, NameId {}
|
|
58
|
-
/**
|
|
59
|
-
* Base interface for Blizzard API responses.
|
|
60
|
-
*/
|
|
61
|
-
interface ResponseBase {
|
|
62
|
-
_links: {
|
|
63
|
-
self: Href;
|
|
64
|
-
};
|
|
65
|
-
}
|
|
66
|
-
/**
|
|
67
|
-
* The playable genders in World of Warcraft.
|
|
68
|
-
*/
|
|
69
|
-
declare const Genders: {
|
|
70
|
-
readonly FEMALE: "FEMALE";
|
|
71
|
-
readonly MALE: "MALE";
|
|
72
|
-
};
|
|
73
|
-
/**
|
|
74
|
-
* The gender associated with a character or entity in World of Warcraft.
|
|
75
|
-
*/
|
|
76
|
-
interface Gender {
|
|
77
|
-
name: Capitalize<Lowercase<keyof typeof Genders>>;
|
|
78
|
-
type: keyof typeof Genders;
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* The playable factions in World of Warcraft.
|
|
82
|
-
*/
|
|
83
|
-
declare const Factions: {
|
|
84
|
-
readonly ALLIANCE: "ALLIANCE";
|
|
85
|
-
readonly HORDE: "HORDE";
|
|
86
|
-
};
|
|
87
|
-
/**
|
|
88
|
-
* The standard structure to represent a World of Warcraft Character.
|
|
89
|
-
*/
|
|
90
|
-
interface Character$2 extends NameIdKey {
|
|
91
|
-
realm: Realm$4;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* The faction associated with a character or entity in World of Warcraft.
|
|
95
|
-
*/
|
|
96
|
-
interface Faction {
|
|
97
|
-
name: Capitalize<Lowercase<keyof typeof Factions>>;
|
|
98
|
-
type: keyof typeof Factions;
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* The standard structure to represent a World of Warcraft Realm.
|
|
102
|
-
*/
|
|
103
|
-
interface Realm$4 extends NameIdKey {
|
|
104
|
-
slug: string;
|
|
105
|
-
} //#endregion
|
|
106
3
|
//#region src/account-profile/types.d.ts
|
|
107
4
|
interface AccountCollectionsIndexResponse {
|
|
108
5
|
_links: Links;
|
|
@@ -143,7 +40,7 @@ interface AccountTransmogsCollectionSummaryResponse {
|
|
|
143
40
|
interface ProtectedCharacterProfileSummaryResponse {
|
|
144
41
|
_links: Links;
|
|
145
42
|
bind_position: Position;
|
|
146
|
-
character:
|
|
43
|
+
character: Realm;
|
|
147
44
|
id: number;
|
|
148
45
|
money: number;
|
|
149
46
|
name: string;
|
|
@@ -151,7 +48,7 @@ interface ProtectedCharacterProfileSummaryResponse {
|
|
|
151
48
|
protected_stats: ProtectedStats;
|
|
152
49
|
wow_account: number;
|
|
153
50
|
}
|
|
154
|
-
interface Character$
|
|
51
|
+
interface Character$2 {
|
|
155
52
|
character: Href;
|
|
156
53
|
faction: Faction;
|
|
157
54
|
gender: Gender;
|
|
@@ -161,7 +58,7 @@ interface Character$1 {
|
|
|
161
58
|
playable_class: NameIdKey;
|
|
162
59
|
playable_race: NameIdKey;
|
|
163
60
|
protected_character: Href;
|
|
164
|
-
realm: Realm
|
|
61
|
+
realm: Realm;
|
|
165
62
|
}
|
|
166
63
|
interface Heirloom$1 {
|
|
167
64
|
heirloom: NameIdKey;
|
|
@@ -211,7 +108,7 @@ interface ProtectedStats {
|
|
|
211
108
|
total_number_deaths: number;
|
|
212
109
|
}
|
|
213
110
|
interface Quality$1 {
|
|
214
|
-
name:
|
|
111
|
+
name: string;
|
|
215
112
|
type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
216
113
|
}
|
|
217
114
|
interface Slot$1 {
|
|
@@ -235,10 +132,9 @@ interface Toy$1 {
|
|
|
235
132
|
toy: NameIdKey;
|
|
236
133
|
}
|
|
237
134
|
interface WowAccount {
|
|
238
|
-
characters: Array<Character$
|
|
135
|
+
characters: Array<Character$2>;
|
|
239
136
|
id: number;
|
|
240
137
|
}
|
|
241
|
-
|
|
242
138
|
//#endregion
|
|
243
139
|
//#region src/account-profile/account-profile.d.ts
|
|
244
140
|
/**
|
|
@@ -291,7 +187,6 @@ declare function accountTransmogsCollectionSummary(token: string): ProtectedReso
|
|
|
291
187
|
* @returns a protected profile summary for a character.
|
|
292
188
|
*/
|
|
293
189
|
declare function protectedCharacterProfileSummary(realmId: number, characterId: number, token: string): ProtectedResource<ProtectedCharacterProfileSummaryResponse>;
|
|
294
|
-
|
|
295
190
|
//#endregion
|
|
296
191
|
//#region src/achievements/types.d.ts
|
|
297
192
|
/**
|
|
@@ -320,8 +215,9 @@ interface AchievementCategoryResponse extends NameId, ResponseBase {
|
|
|
320
215
|
};
|
|
321
216
|
};
|
|
322
217
|
display_order: number;
|
|
323
|
-
|
|
324
|
-
parent_category
|
|
218
|
+
is_guild_category: boolean;
|
|
219
|
+
parent_category?: NameIdKey;
|
|
220
|
+
subcategories?: Array<NameIdKey>;
|
|
325
221
|
}
|
|
326
222
|
/**
|
|
327
223
|
* Interface for a response from the achievement index endpoint.
|
|
@@ -335,7 +231,7 @@ interface AchievementIndexResponse extends ResponseBase {
|
|
|
335
231
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
336
232
|
*/
|
|
337
233
|
interface AchievementMediaResponse extends ResponseBase {
|
|
338
|
-
assets: Array<
|
|
234
|
+
assets: Array<MediaAsset>;
|
|
339
235
|
id: number;
|
|
340
236
|
}
|
|
341
237
|
/**
|
|
@@ -344,23 +240,68 @@ interface AchievementMediaResponse extends ResponseBase {
|
|
|
344
240
|
*/
|
|
345
241
|
interface AchievementResponse extends NameId, ResponseBase {
|
|
346
242
|
category: NameIdKey;
|
|
347
|
-
criteria
|
|
348
|
-
amount: number;
|
|
349
|
-
description: string;
|
|
350
|
-
id: number;
|
|
351
|
-
};
|
|
243
|
+
criteria?: Criteria$2;
|
|
352
244
|
description: string;
|
|
353
245
|
display_order: number;
|
|
246
|
+
guild_reward_items?: Array<NameIdKey>;
|
|
354
247
|
is_account_wide: boolean;
|
|
355
|
-
media: KeyBase
|
|
248
|
+
media: KeyBase & {
|
|
249
|
+
id: number;
|
|
250
|
+
};
|
|
251
|
+
next_achievement?: NameIdKey;
|
|
356
252
|
points: number;
|
|
253
|
+
prerequisite_achievement?: NameIdKey;
|
|
254
|
+
requirements?: {
|
|
255
|
+
faction: Faction;
|
|
256
|
+
};
|
|
257
|
+
reward_description?: string;
|
|
258
|
+
reward_item?: NameIdKey;
|
|
357
259
|
}
|
|
358
|
-
interface
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
260
|
+
interface ChildCriteria {
|
|
261
|
+
achievement?: NameIdKey;
|
|
262
|
+
amount: number;
|
|
263
|
+
child_criteria?: Array<ChildCriteria2>;
|
|
264
|
+
description: null | string;
|
|
265
|
+
faction?: Faction;
|
|
266
|
+
id: number;
|
|
267
|
+
is_gold?: boolean;
|
|
268
|
+
operator?: Operator;
|
|
269
|
+
show_progress_bar?: boolean;
|
|
270
|
+
}
|
|
271
|
+
interface ChildCriteria2 {
|
|
272
|
+
achievement?: NameIdKey;
|
|
273
|
+
amount: number;
|
|
274
|
+
child_criteria?: Array<ChildCriteria3>;
|
|
275
|
+
description: null | string;
|
|
276
|
+
faction?: Faction;
|
|
277
|
+
id: number;
|
|
278
|
+
is_gold?: boolean;
|
|
279
|
+
operator?: Operator;
|
|
280
|
+
show_progress_bar?: boolean;
|
|
281
|
+
}
|
|
282
|
+
interface ChildCriteria3 {
|
|
283
|
+
achievement?: NameIdKey;
|
|
284
|
+
amount: number;
|
|
285
|
+
description: null | string;
|
|
286
|
+
faction?: Faction;
|
|
287
|
+
id: number;
|
|
288
|
+
is_gold?: boolean;
|
|
289
|
+
operator?: Operator;
|
|
290
|
+
show_progress_bar?: boolean;
|
|
291
|
+
}
|
|
292
|
+
interface Criteria$2 {
|
|
293
|
+
amount: number;
|
|
294
|
+
child_criteria?: Array<ChildCriteria>;
|
|
295
|
+
description: null | string;
|
|
296
|
+
faction?: Faction;
|
|
297
|
+
id: number;
|
|
298
|
+
operator?: Operator;
|
|
299
|
+
show_progress_bar?: boolean;
|
|
300
|
+
}
|
|
301
|
+
interface Operator {
|
|
302
|
+
name: string;
|
|
303
|
+
type: 'AND' | 'COMPLETE_AT_LEAST';
|
|
362
304
|
}
|
|
363
|
-
|
|
364
305
|
//#endregion
|
|
365
306
|
//#region src/achievements/achievements.d.ts
|
|
366
307
|
/**
|
|
@@ -391,7 +332,6 @@ declare function achievementIndex(): Resource<AchievementIndexResponse>;
|
|
|
391
332
|
* @returns The achievement media. See {@link AchievementMediaResponse}.
|
|
392
333
|
*/
|
|
393
334
|
declare function achievementMedia(achievementId: number): Resource<AchievementMediaResponse>;
|
|
394
|
-
|
|
395
335
|
//#endregion
|
|
396
336
|
//#region src/auction-house/types.d.ts
|
|
397
337
|
/**
|
|
@@ -424,23 +364,26 @@ interface AuctionHouseCommodity {
|
|
|
424
364
|
unit_price: number;
|
|
425
365
|
}
|
|
426
366
|
interface AuctionHousePosting {
|
|
427
|
-
bid
|
|
367
|
+
bid?: number;
|
|
428
368
|
buyout: number;
|
|
429
369
|
id: number;
|
|
430
370
|
item: {
|
|
431
|
-
bonus_lists
|
|
432
|
-
context
|
|
371
|
+
bonus_lists?: Array<number>;
|
|
372
|
+
context?: number;
|
|
433
373
|
id: number;
|
|
434
|
-
modifiers
|
|
374
|
+
modifiers?: Array<{
|
|
435
375
|
type: number;
|
|
436
376
|
value: number;
|
|
437
377
|
}>;
|
|
378
|
+
pet_breed_id?: number;
|
|
379
|
+
pet_level?: number;
|
|
380
|
+
pet_quality_id?: number;
|
|
381
|
+
pet_species_id?: number;
|
|
438
382
|
};
|
|
439
383
|
quantity: number;
|
|
440
384
|
time_left: AuctionHouseTimeLeft;
|
|
441
385
|
}
|
|
442
386
|
type AuctionHouseTimeLeft = 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
|
|
443
|
-
|
|
444
387
|
//#endregion
|
|
445
388
|
//#region src/auction-house/auction-house.d.ts
|
|
446
389
|
/**
|
|
@@ -454,7 +397,6 @@ declare function auctions(connectedRealmId: number): Resource<AuctionHouseRespon
|
|
|
454
397
|
* @returns The auction house data. See {@link AuctionHouseResponse}.
|
|
455
398
|
*/
|
|
456
399
|
declare function commodities(): Resource<AuctionHouseCommoditiesResponse>;
|
|
457
|
-
|
|
458
400
|
//#endregion
|
|
459
401
|
//#region src/azerite-essence/types.d.ts
|
|
460
402
|
/**
|
|
@@ -469,7 +411,7 @@ interface AzeriteEssenceIndexResponse extends ResponseBase {
|
|
|
469
411
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
470
412
|
*/
|
|
471
413
|
interface AzeriteEssenceMediaResponse extends ResponseBase {
|
|
472
|
-
assets: Array<MediaAsset
|
|
414
|
+
assets: Array<MediaAsset>;
|
|
473
415
|
id: number;
|
|
474
416
|
}
|
|
475
417
|
/**
|
|
@@ -494,9 +436,15 @@ interface AzeriteEssenceSearchParameters extends BaseSearchParameters {
|
|
|
494
436
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
495
437
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
496
438
|
*/
|
|
439
|
+
interface AzeriteEssenceSearchResponse extends SearchResponseWithoutResults {
|
|
440
|
+
results: Array<AzeriteEssenceSearchResponseItem>;
|
|
441
|
+
}
|
|
497
442
|
interface AzeriteEssenceSearchResponseItem extends KeyBase {
|
|
498
443
|
data: {
|
|
499
|
-
allowed_specializations: Array<
|
|
444
|
+
allowed_specializations: Array<{
|
|
445
|
+
id: number;
|
|
446
|
+
name: Record<Locales, string>;
|
|
447
|
+
}>;
|
|
500
448
|
name: Record<Locales, string>;
|
|
501
449
|
};
|
|
502
450
|
}
|
|
@@ -509,7 +457,6 @@ interface Power {
|
|
|
509
457
|
passive_power_spell: NameIdKey;
|
|
510
458
|
rank: number;
|
|
511
459
|
}
|
|
512
|
-
|
|
513
460
|
//#endregion
|
|
514
461
|
//#region src/azerite-essence/azerite-essence.d.ts
|
|
515
462
|
/**
|
|
@@ -532,16 +479,15 @@ declare function azeriteEssenceMedia(azeriteEssenceId: number): Resource<Azerite
|
|
|
532
479
|
/**
|
|
533
480
|
* Search for azerite essences.
|
|
534
481
|
* @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
|
|
535
|
-
* @returns The search results. See {@link
|
|
482
|
+
* @returns The search results. See {@link AzeriteEssenceSearchResponse}.
|
|
536
483
|
*/
|
|
537
|
-
declare function azeriteEssenceSearch(options: AzeriteEssenceSearchParameters): Resource<
|
|
538
|
-
|
|
484
|
+
declare function azeriteEssenceSearch(options: AzeriteEssenceSearchParameters): Resource<AzeriteEssenceSearchResponse, AzeriteEssenceSearchParameters>;
|
|
539
485
|
//#endregion
|
|
540
486
|
//#region src/character-achievements/types.d.ts
|
|
541
487
|
interface CharacterAchievementsSummaryResponse extends ResponseBase {
|
|
542
488
|
achievements: Array<Achievement$1>;
|
|
543
489
|
category_progress: Array<CategoryProgress$1>;
|
|
544
|
-
character: Character
|
|
490
|
+
character: Character;
|
|
545
491
|
recent_events: Array<RecentEvent$1>;
|
|
546
492
|
statistics: Href;
|
|
547
493
|
total_points: number;
|
|
@@ -549,7 +495,7 @@ interface CharacterAchievementsSummaryResponse extends ResponseBase {
|
|
|
549
495
|
}
|
|
550
496
|
interface CharacterAchievementStatisticsResponse extends ResponseBase {
|
|
551
497
|
categories: Array<Category$2>;
|
|
552
|
-
character: Character
|
|
498
|
+
character: Character;
|
|
553
499
|
}
|
|
554
500
|
interface Achievement$1 {
|
|
555
501
|
achievement: NameIdKey;
|
|
@@ -558,19 +504,36 @@ interface Achievement$1 {
|
|
|
558
504
|
id: number;
|
|
559
505
|
}
|
|
560
506
|
interface Category$2 {
|
|
561
|
-
id
|
|
507
|
+
id?: number;
|
|
562
508
|
name: string;
|
|
563
|
-
statistics
|
|
564
|
-
sub_categories
|
|
509
|
+
statistics?: Array<Statistic>;
|
|
510
|
+
sub_categories?: Array<SubCategory>;
|
|
565
511
|
}
|
|
566
512
|
interface CategoryProgress$1 {
|
|
567
513
|
category: NameIdKey;
|
|
568
514
|
points: number;
|
|
569
515
|
quantity: number;
|
|
570
516
|
}
|
|
517
|
+
interface ChildCriterum$1 {
|
|
518
|
+
amount?: number;
|
|
519
|
+
child_criteria?: Array<ChildCriterum2>;
|
|
520
|
+
id: number;
|
|
521
|
+
is_completed: boolean;
|
|
522
|
+
}
|
|
523
|
+
interface ChildCriterum2 {
|
|
524
|
+
amount?: number;
|
|
525
|
+
child_criteria?: Array<ChildCriterum3>;
|
|
526
|
+
id: number;
|
|
527
|
+
is_completed: boolean;
|
|
528
|
+
}
|
|
529
|
+
interface ChildCriterum3 {
|
|
530
|
+
amount?: number;
|
|
531
|
+
id: number;
|
|
532
|
+
is_completed: boolean;
|
|
533
|
+
}
|
|
571
534
|
interface Criteria$1 {
|
|
572
535
|
amount?: number;
|
|
573
|
-
child_criteria?: Array<
|
|
536
|
+
child_criteria?: Array<ChildCriterum$1>;
|
|
574
537
|
id: number;
|
|
575
538
|
is_completed: boolean;
|
|
576
539
|
}
|
|
@@ -590,7 +553,6 @@ interface SubCategory {
|
|
|
590
553
|
name: string;
|
|
591
554
|
statistics: Array<Statistic>;
|
|
592
555
|
}
|
|
593
|
-
|
|
594
556
|
//#endregion
|
|
595
557
|
//#region src/character-achievements/character-achievements.d.ts
|
|
596
558
|
/**
|
|
@@ -605,17 +567,16 @@ declare function characterAchievementsSummary(realmSlug: string, characterName:
|
|
|
605
567
|
* @returns a character's statistics as they pertain to achievements.
|
|
606
568
|
*/
|
|
607
569
|
declare function characterAchievementStatistics(realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
|
|
608
|
-
|
|
609
570
|
//#endregion
|
|
610
571
|
//#region src/character-appearance/types.d.ts
|
|
611
572
|
interface CharacterAppearanceResponse extends ResponseBase {
|
|
612
573
|
active_spec: NameIdKey;
|
|
613
|
-
character: Character
|
|
574
|
+
character: Character;
|
|
614
575
|
customizations: Array<Customization>;
|
|
615
576
|
faction: Faction;
|
|
616
577
|
gender: Gender;
|
|
617
578
|
guild_crest: GuildCrest;
|
|
618
|
-
items: Array<Item$
|
|
579
|
+
items: Array<Item$1>;
|
|
619
580
|
playable_class: NameIdKey;
|
|
620
581
|
playable_race: NameIdKey;
|
|
621
582
|
}
|
|
@@ -642,22 +603,24 @@ interface GuildCrest {
|
|
|
642
603
|
border: BorderEmblem;
|
|
643
604
|
emblem: BorderEmblem;
|
|
644
605
|
}
|
|
645
|
-
interface Item$
|
|
606
|
+
interface Item$1 {
|
|
646
607
|
enchant: number;
|
|
647
608
|
id: number;
|
|
648
609
|
internal_slot_id: number;
|
|
649
|
-
item_appearance_modifier_id
|
|
610
|
+
item_appearance_modifier_id?: number;
|
|
611
|
+
secondary_id?: number;
|
|
612
|
+
secondary_item_appearance_modifier_id?: number;
|
|
613
|
+
secondary_subclass?: number;
|
|
650
614
|
slot: {
|
|
651
615
|
name: string;
|
|
652
616
|
type: string;
|
|
653
617
|
};
|
|
654
|
-
subclass
|
|
618
|
+
subclass?: number;
|
|
655
619
|
}
|
|
656
620
|
interface RGBWithId {
|
|
657
621
|
id: number;
|
|
658
622
|
rgba: Color;
|
|
659
623
|
}
|
|
660
|
-
|
|
661
624
|
//#endregion
|
|
662
625
|
//#region src/character-appearance/character-appearance.d.ts
|
|
663
626
|
/**
|
|
@@ -666,11 +629,11 @@ interface RGBWithId {
|
|
|
666
629
|
* @returns a summary of a character's appearance settings.
|
|
667
630
|
*/
|
|
668
631
|
declare function characterAppearanceSummary(realmSlug: string, characterName: string): Resource<CharacterAppearanceResponse>;
|
|
669
|
-
|
|
670
632
|
//#endregion
|
|
671
633
|
//#region src/character-collections/types.d.ts
|
|
672
634
|
interface CharacterCollectionsIndexResponse extends ResponseBase {
|
|
673
|
-
character: Character
|
|
635
|
+
character: Character;
|
|
636
|
+
decors: Href;
|
|
674
637
|
heirlooms: Href;
|
|
675
638
|
mounts: Href;
|
|
676
639
|
pets: Href;
|
|
@@ -721,16 +684,16 @@ interface Pet {
|
|
|
721
684
|
stats: Stats;
|
|
722
685
|
}
|
|
723
686
|
interface Quality {
|
|
724
|
-
name:
|
|
687
|
+
name: string;
|
|
725
688
|
type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
726
689
|
}
|
|
727
690
|
interface Slot {
|
|
728
691
|
appearances: Array<KeyBase & {
|
|
729
692
|
id: number;
|
|
730
693
|
}>;
|
|
731
|
-
slot:
|
|
694
|
+
slot: SlotSlot;
|
|
732
695
|
}
|
|
733
|
-
interface
|
|
696
|
+
interface SlotSlot {
|
|
734
697
|
name: string;
|
|
735
698
|
type: string;
|
|
736
699
|
}
|
|
@@ -744,7 +707,6 @@ interface Toy {
|
|
|
744
707
|
is_favorite?: boolean;
|
|
745
708
|
toy: NameIdKey;
|
|
746
709
|
}
|
|
747
|
-
|
|
748
710
|
//#endregion
|
|
749
711
|
//#region src/character-collections/character-collections.d.ts
|
|
750
712
|
/**
|
|
@@ -783,24 +745,27 @@ declare function characterToysCollectionSummary(realmSlug: string, characterName
|
|
|
783
745
|
* @returns a summary of the transmog unlocks a character has obtained.
|
|
784
746
|
*/
|
|
785
747
|
declare function characterTransmogCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterTransmogCollectionSummaryResponse>;
|
|
786
|
-
|
|
787
748
|
//#endregion
|
|
788
749
|
//#region src/character-encounters/types.d.ts
|
|
789
750
|
interface CharacterDungeonsResponse extends ResponseBase {
|
|
790
|
-
expansions: Array<
|
|
751
|
+
expansions: Array<ExpansionWithDungeonInstances>;
|
|
791
752
|
}
|
|
792
753
|
interface CharacterEncountersSummaryResponse extends ResponseBase {
|
|
793
|
-
character: Character
|
|
754
|
+
character: Character;
|
|
794
755
|
dungeons: Href;
|
|
795
756
|
raids: Href;
|
|
796
757
|
}
|
|
797
758
|
interface CharacterRaidsResponse extends ResponseBase {
|
|
798
|
-
character: Character
|
|
799
|
-
expansions: Array<
|
|
759
|
+
character: Character;
|
|
760
|
+
expansions: Array<ExpansionWithRaidInstances>;
|
|
800
761
|
}
|
|
801
762
|
interface DungeonDifficulties {
|
|
802
|
-
name
|
|
803
|
-
type
|
|
763
|
+
name?: string;
|
|
764
|
+
type?: 'HEROIC' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
|
|
765
|
+
}
|
|
766
|
+
interface DungeonInstance {
|
|
767
|
+
instance: NameIdKey;
|
|
768
|
+
modes: Array<DungeonMode>;
|
|
804
769
|
}
|
|
805
770
|
interface DungeonMode {
|
|
806
771
|
difficulty: DungeonDifficulties;
|
|
@@ -812,13 +777,13 @@ interface Encounter {
|
|
|
812
777
|
encounter: NameIdKey;
|
|
813
778
|
last_kill_timestamp: number;
|
|
814
779
|
}
|
|
815
|
-
interface
|
|
780
|
+
interface ExpansionWithDungeonInstances {
|
|
816
781
|
expansion: NameIdKey;
|
|
817
|
-
instances: Array<
|
|
782
|
+
instances: Array<DungeonInstance>;
|
|
818
783
|
}
|
|
819
|
-
interface
|
|
820
|
-
|
|
821
|
-
|
|
784
|
+
interface ExpansionWithRaidInstances {
|
|
785
|
+
expansion: NameIdKey;
|
|
786
|
+
instances: Array<RaidInstance>;
|
|
822
787
|
}
|
|
823
788
|
interface Progress {
|
|
824
789
|
completed_count: number;
|
|
@@ -826,19 +791,22 @@ interface Progress {
|
|
|
826
791
|
total_count: number;
|
|
827
792
|
}
|
|
828
793
|
interface RaidDifficulties {
|
|
829
|
-
name:
|
|
794
|
+
name: string;
|
|
830
795
|
type: 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
|
|
831
796
|
}
|
|
797
|
+
interface RaidInstance {
|
|
798
|
+
instance: NameIdKey;
|
|
799
|
+
modes: Array<RaidMode>;
|
|
800
|
+
}
|
|
832
801
|
interface RaidMode {
|
|
833
802
|
difficulty: RaidDifficulties;
|
|
834
803
|
progress: Progress;
|
|
835
804
|
status: Status;
|
|
836
805
|
}
|
|
837
806
|
interface Status {
|
|
838
|
-
name:
|
|
807
|
+
name: string;
|
|
839
808
|
type: 'COMPLETE' | 'IN_PROGRESS';
|
|
840
809
|
}
|
|
841
|
-
|
|
842
810
|
//#endregion
|
|
843
811
|
//#region src/character-encounters/character-encounters.d.ts
|
|
844
812
|
/**
|
|
@@ -859,11 +827,10 @@ declare function characterEncountersSummary(realmSlug: string, characterName: st
|
|
|
859
827
|
* @returns a summary of a character's completed raids.
|
|
860
828
|
*/
|
|
861
829
|
declare function characterRaids(realmSlug: string, characterName: string): Resource<CharacterRaidsResponse>;
|
|
862
|
-
|
|
863
830
|
//#endregion
|
|
864
831
|
//#region src/character-equipment/types.d.ts
|
|
865
832
|
interface CharacterEquipmentSummaryResponse extends ResponseBase {
|
|
866
|
-
character: Character
|
|
833
|
+
character: Character;
|
|
867
834
|
equipped_item_sets: Array<Set>;
|
|
868
835
|
equipped_items: Array<EquippedItem>;
|
|
869
836
|
}
|
|
@@ -925,7 +892,7 @@ interface EquippedItem {
|
|
|
925
892
|
modified_appearance_id?: number;
|
|
926
893
|
modified_crafting_stat?: Array<ModifiedCraftingStat>;
|
|
927
894
|
name: string;
|
|
928
|
-
name_description
|
|
895
|
+
name_description?: NameDescription;
|
|
929
896
|
quality: NameType;
|
|
930
897
|
quantity: number;
|
|
931
898
|
requirements?: Requirements$3;
|
|
@@ -939,8 +906,9 @@ interface EquippedItem {
|
|
|
939
906
|
unique_equipped?: string;
|
|
940
907
|
weapon?: Weapon$2;
|
|
941
908
|
}
|
|
942
|
-
interface ItemElement
|
|
909
|
+
interface ItemElement {
|
|
943
910
|
is_equipped?: boolean;
|
|
911
|
+
item: NameIdKey;
|
|
944
912
|
}
|
|
945
913
|
interface ModifiedCraftingStat {
|
|
946
914
|
id: number;
|
|
@@ -974,6 +942,8 @@ interface Set {
|
|
|
974
942
|
items: Array<ItemElement>;
|
|
975
943
|
}
|
|
976
944
|
interface Socket$1 {
|
|
945
|
+
context?: number;
|
|
946
|
+
display_color?: Color;
|
|
977
947
|
display_string: string;
|
|
978
948
|
item: NameIdKey;
|
|
979
949
|
media: KeyBase & {
|
|
@@ -996,13 +966,14 @@ interface Transmog {
|
|
|
996
966
|
display_string: string;
|
|
997
967
|
item: NameIdKey;
|
|
998
968
|
item_modified_appearance_id: number;
|
|
969
|
+
second_item?: NameIdKey;
|
|
970
|
+
second_item_modified_appearance_id?: number;
|
|
999
971
|
}
|
|
1000
972
|
interface Weapon$2 {
|
|
1001
973
|
attack_speed: DisplayStringValue;
|
|
1002
974
|
damage: Damage$2;
|
|
1003
975
|
dps: DisplayStringValue;
|
|
1004
976
|
}
|
|
1005
|
-
|
|
1006
977
|
//#endregion
|
|
1007
978
|
//#region src/character-equipment/character-equipment.d.ts
|
|
1008
979
|
/**
|
|
@@ -1011,11 +982,10 @@ interface Weapon$2 {
|
|
|
1011
982
|
* @returns a summary of the items equipped by a character.
|
|
1012
983
|
*/
|
|
1013
984
|
declare function characterEquipmentSummary(realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
|
|
1014
|
-
|
|
1015
985
|
//#endregion
|
|
1016
986
|
//#region src/character-hunter-pets/types.d.ts
|
|
1017
987
|
interface CharacterHunterPetsSummaryResponse extends ResponseBase {
|
|
1018
|
-
character: Character
|
|
988
|
+
character: Character;
|
|
1019
989
|
hunter_pets: Array<HunterPet>;
|
|
1020
990
|
}
|
|
1021
991
|
interface HunterPet {
|
|
@@ -1029,7 +999,6 @@ interface HunterPet {
|
|
|
1029
999
|
name: string;
|
|
1030
1000
|
slot: number;
|
|
1031
1001
|
}
|
|
1032
|
-
|
|
1033
1002
|
//#endregion
|
|
1034
1003
|
//#region src/character-hunter-pets/character-hunter-pets.d.ts
|
|
1035
1004
|
/**
|
|
@@ -1039,18 +1008,16 @@ interface HunterPet {
|
|
|
1039
1008
|
* @returns a summary of the character's hunter pets.
|
|
1040
1009
|
*/
|
|
1041
1010
|
declare function characterHunterPetsSummary(realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
|
|
1042
|
-
|
|
1043
1011
|
//#endregion
|
|
1044
1012
|
//#region src/character-media/types.d.ts
|
|
1045
1013
|
interface CharacterMediaSummaryResponse extends ResponseBase {
|
|
1046
1014
|
assets: Array<Asset$1>;
|
|
1047
|
-
character: Character
|
|
1015
|
+
character: Character;
|
|
1048
1016
|
}
|
|
1049
1017
|
interface Asset$1 {
|
|
1050
1018
|
key: string;
|
|
1051
1019
|
value: string;
|
|
1052
1020
|
}
|
|
1053
|
-
|
|
1054
1021
|
//#endregion
|
|
1055
1022
|
//#region src/character-media/character-media.d.ts
|
|
1056
1023
|
/**
|
|
@@ -1059,11 +1026,10 @@ interface Asset$1 {
|
|
|
1059
1026
|
* @returns a summary of the media assets available for a character (such as an avatar render).
|
|
1060
1027
|
*/
|
|
1061
1028
|
declare function characterMediaSummary(realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
|
|
1062
|
-
|
|
1063
1029
|
//#endregion
|
|
1064
1030
|
//#region src/character-mythic-keystone-profile/types.d.ts
|
|
1065
1031
|
interface CharacterMythicKeystoneProfileIndexResponse extends ResponseBase {
|
|
1066
|
-
character: Character
|
|
1032
|
+
character: Character;
|
|
1067
1033
|
current_period: CurrentPeriod;
|
|
1068
1034
|
seasons: Array<KeyBase & {
|
|
1069
1035
|
id: number;
|
|
@@ -1071,8 +1037,8 @@ interface CharacterMythicKeystoneProfileIndexResponse extends ResponseBase {
|
|
|
1071
1037
|
}
|
|
1072
1038
|
interface CharacterMythicKeystoneSeasonDetailsResponse extends ResponseBase {
|
|
1073
1039
|
best_runs: Array<BestRun>;
|
|
1074
|
-
character:
|
|
1075
|
-
mythic_rating: MythicRating
|
|
1040
|
+
character: Character;
|
|
1041
|
+
mythic_rating: MythicRating;
|
|
1076
1042
|
season: KeyBase & {
|
|
1077
1043
|
id: number;
|
|
1078
1044
|
};
|
|
@@ -1085,7 +1051,7 @@ interface BestRun {
|
|
|
1085
1051
|
keystone_affixes: Array<NameIdKey>;
|
|
1086
1052
|
keystone_level: number;
|
|
1087
1053
|
members: Array<Member$2>;
|
|
1088
|
-
mythic_rating: MythicRating
|
|
1054
|
+
mythic_rating: MythicRating;
|
|
1089
1055
|
}
|
|
1090
1056
|
interface CurrentPeriod {
|
|
1091
1057
|
period: KeyBase & {
|
|
@@ -1094,17 +1060,16 @@ interface CurrentPeriod {
|
|
|
1094
1060
|
}
|
|
1095
1061
|
interface Member$2 {
|
|
1096
1062
|
character: NameId & {
|
|
1097
|
-
realm: Realm
|
|
1063
|
+
realm: Realm;
|
|
1098
1064
|
};
|
|
1099
1065
|
equipped_item_level: number;
|
|
1100
1066
|
race: NameIdKey;
|
|
1101
1067
|
specialization: NameIdKey;
|
|
1102
1068
|
}
|
|
1103
|
-
interface MythicRating
|
|
1069
|
+
interface MythicRating {
|
|
1104
1070
|
color: Color;
|
|
1105
1071
|
rating: number;
|
|
1106
1072
|
}
|
|
1107
|
-
|
|
1108
1073
|
//#endregion
|
|
1109
1074
|
//#region src/character-mythic-keystone-profile/character-mythic-keystone-profile.d.ts
|
|
1110
1075
|
/**
|
|
@@ -1122,11 +1087,10 @@ declare function characterMythicKeystoneProfileIndex(realmSlug: string, characte
|
|
|
1122
1087
|
* @returns the Mythic Keystone season details for a character.
|
|
1123
1088
|
*/
|
|
1124
1089
|
declare function characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): Resource<CharacterMythicKeystoneSeasonDetailsResponse>;
|
|
1125
|
-
|
|
1126
1090
|
//#endregion
|
|
1127
1091
|
//#region src/character-professions/types.d.ts
|
|
1128
1092
|
interface CharacterProfessionsSummaryResponse extends ResponseBase {
|
|
1129
|
-
character: Character
|
|
1093
|
+
character: Character;
|
|
1130
1094
|
primaries: Array<Primary>;
|
|
1131
1095
|
secondaries: Array<Secondary>;
|
|
1132
1096
|
}
|
|
@@ -1146,7 +1110,6 @@ interface Tier$1 {
|
|
|
1146
1110
|
skill_points: number;
|
|
1147
1111
|
tier: NameId;
|
|
1148
1112
|
}
|
|
1149
|
-
|
|
1150
1113
|
//#endregion
|
|
1151
1114
|
//#region src/character-professions/character-professions.d.ts
|
|
1152
1115
|
/**
|
|
@@ -1155,7 +1118,6 @@ interface Tier$1 {
|
|
|
1155
1118
|
* @returns a summary of the professions for a character.
|
|
1156
1119
|
*/
|
|
1157
1120
|
declare function characterProfessionsSummary(realmSlug: string, characterName: string): Resource<CharacterProfessionsSummaryResponse>;
|
|
1158
|
-
|
|
1159
1121
|
//#endregion
|
|
1160
1122
|
//#region src/character-profile/types.d.ts
|
|
1161
1123
|
interface CharacterProfileStatusResponse extends ResponseBase {
|
|
@@ -1167,7 +1129,7 @@ interface CharacterProfileSummaryResponse extends ResponseBase {
|
|
|
1167
1129
|
achievements: Href;
|
|
1168
1130
|
achievements_statistics: Href;
|
|
1169
1131
|
active_spec: NameIdKey;
|
|
1170
|
-
active_title
|
|
1132
|
+
active_title?: NameIdKey & {
|
|
1171
1133
|
display_string: string;
|
|
1172
1134
|
};
|
|
1173
1135
|
appearance: Href;
|
|
@@ -1182,8 +1144,10 @@ interface CharacterProfileSummaryResponse extends ResponseBase {
|
|
|
1182
1144
|
faction: Faction;
|
|
1183
1145
|
gender: Gender;
|
|
1184
1146
|
guild: Guild$2;
|
|
1147
|
+
houses?: Array<Href>;
|
|
1185
1148
|
hunter_pets: Href;
|
|
1186
1149
|
id: number;
|
|
1150
|
+
is_remix: boolean;
|
|
1187
1151
|
last_login_timestamp: number;
|
|
1188
1152
|
level: number;
|
|
1189
1153
|
media: Href;
|
|
@@ -1194,7 +1158,7 @@ interface CharacterProfileSummaryResponse extends ResponseBase {
|
|
|
1194
1158
|
pvp_summary: Href;
|
|
1195
1159
|
quests: Href;
|
|
1196
1160
|
race: NameIdKey;
|
|
1197
|
-
realm: Realm
|
|
1161
|
+
realm: Realm;
|
|
1198
1162
|
reputations: Href;
|
|
1199
1163
|
specializations: Href;
|
|
1200
1164
|
statistics: Href;
|
|
@@ -1207,9 +1171,8 @@ interface CovenantProgress {
|
|
|
1207
1171
|
}
|
|
1208
1172
|
interface Guild$2 extends NameIdKey {
|
|
1209
1173
|
faction: Faction;
|
|
1210
|
-
realm: Realm
|
|
1174
|
+
realm: Realm;
|
|
1211
1175
|
}
|
|
1212
|
-
|
|
1213
1176
|
//#endregion
|
|
1214
1177
|
//#region src/character-profile/character-profile.d.ts
|
|
1215
1178
|
/**
|
|
@@ -1236,12 +1199,11 @@ declare function characterProfileStatus(realmSlug: string, characterName: string
|
|
|
1236
1199
|
* @returns a summary of the character profile for a character.
|
|
1237
1200
|
*/
|
|
1238
1201
|
declare function characterProfileSummary(realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
|
|
1239
|
-
|
|
1240
1202
|
//#endregion
|
|
1241
1203
|
//#region src/character-pvp/types.d.ts
|
|
1242
1204
|
interface CharacterPvpBracketStatisticsResponse extends ResponseBase {
|
|
1243
1205
|
bracket: Bracket$2;
|
|
1244
|
-
character: Character
|
|
1206
|
+
character: Character;
|
|
1245
1207
|
faction: Faction;
|
|
1246
1208
|
rating: number;
|
|
1247
1209
|
season: KeyBase & {
|
|
@@ -1254,7 +1216,7 @@ interface CharacterPvpBracketStatisticsResponse extends ResponseBase {
|
|
|
1254
1216
|
weekly_match_statistics: MatchStatistics;
|
|
1255
1217
|
}
|
|
1256
1218
|
interface CharacterPvpSummaryResponse extends ResponseBase {
|
|
1257
|
-
character: Character
|
|
1219
|
+
character: Character;
|
|
1258
1220
|
honor_level: number;
|
|
1259
1221
|
honorable_kills: number;
|
|
1260
1222
|
pvp_map_statistics: Array<PvpMapStatistic>;
|
|
@@ -1272,7 +1234,6 @@ interface PvpMapStatistic {
|
|
|
1272
1234
|
match_statistics: MatchStatistics;
|
|
1273
1235
|
world_map: NameId;
|
|
1274
1236
|
}
|
|
1275
|
-
|
|
1276
1237
|
//#endregion
|
|
1277
1238
|
//#region src/character-pvp/character-pvp.d.ts
|
|
1278
1239
|
/**
|
|
@@ -1288,19 +1249,17 @@ declare function characterPvpBracketStatistics(realmSlug: string, characterName:
|
|
|
1288
1249
|
* @returns a PvP summary for a character.
|
|
1289
1250
|
*/
|
|
1290
1251
|
declare function characterPvpSummary(realmSlug: string, characterName: string): Resource<CharacterPvpSummaryResponse>;
|
|
1291
|
-
|
|
1292
1252
|
//#endregion
|
|
1293
1253
|
//#region src/character-quests/types.d.ts
|
|
1294
1254
|
interface CharacterCompletedQuestsResponse extends ResponseBase {
|
|
1295
|
-
character: Character
|
|
1255
|
+
character: Character;
|
|
1296
1256
|
quests: Array<NameIdKey>;
|
|
1297
1257
|
}
|
|
1298
1258
|
interface CharacterQuestsResponse extends ResponseBase {
|
|
1299
|
-
character: Character
|
|
1259
|
+
character: Character;
|
|
1300
1260
|
completed: Href;
|
|
1301
1261
|
in_progress: Array<NameIdKey>;
|
|
1302
1262
|
}
|
|
1303
|
-
|
|
1304
1263
|
//#endregion
|
|
1305
1264
|
//#region src/character-quests/character-quests.d.ts
|
|
1306
1265
|
/**
|
|
@@ -1315,11 +1274,10 @@ declare function characterCompletedQuests(realmSlug: string, characterName: stri
|
|
|
1315
1274
|
* @returns a character's active quests as well as a link to the character's completed quests.
|
|
1316
1275
|
*/
|
|
1317
1276
|
declare function characterQuests(realmSlug: string, characterName: string): Resource<CharacterQuestsResponse>;
|
|
1318
|
-
|
|
1319
1277
|
//#endregion
|
|
1320
1278
|
//#region src/character-reputations/types.d.ts
|
|
1321
1279
|
interface CharacterReputationsSummaryResponse extends ResponseBase {
|
|
1322
|
-
character: Character
|
|
1280
|
+
character: Character;
|
|
1323
1281
|
reputations: Array<Reputation$1>;
|
|
1324
1282
|
}
|
|
1325
1283
|
interface Paragon {
|
|
@@ -1336,10 +1294,10 @@ interface Standing {
|
|
|
1336
1294
|
max: number;
|
|
1337
1295
|
name: string;
|
|
1338
1296
|
raw: number;
|
|
1339
|
-
|
|
1297
|
+
renown_level?: number;
|
|
1298
|
+
tier?: number;
|
|
1340
1299
|
value: number;
|
|
1341
1300
|
}
|
|
1342
|
-
|
|
1343
1301
|
//#endregion
|
|
1344
1302
|
//#region src/character-reputations/character-reputations.d.ts
|
|
1345
1303
|
/**
|
|
@@ -1348,11 +1306,10 @@ interface Standing {
|
|
|
1348
1306
|
* @returns a summary of a character's reputations.
|
|
1349
1307
|
*/
|
|
1350
1308
|
declare function characterReputationsSummary(realmSlug: string, characterName: string): Resource<CharacterReputationsSummaryResponse>;
|
|
1351
|
-
|
|
1352
1309
|
//#endregion
|
|
1353
1310
|
//#region src/character-soulbinds/types.d.ts
|
|
1354
1311
|
interface CharacterSoulbindsResponse extends ResponseBase {
|
|
1355
|
-
character: Character
|
|
1312
|
+
character: Character;
|
|
1356
1313
|
chosen_covenant: NameIdKey;
|
|
1357
1314
|
renown_level: number;
|
|
1358
1315
|
soulbinds: Array<Soulbind>;
|
|
@@ -1380,7 +1337,6 @@ interface TypeClass {
|
|
|
1380
1337
|
name: 'Endurance Conduit Slot' | 'Finesse Conduit Slot' | 'Potency Conduit Slot';
|
|
1381
1338
|
type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
|
|
1382
1339
|
}
|
|
1383
|
-
|
|
1384
1340
|
//#endregion
|
|
1385
1341
|
//#region src/character-soulbinds/character-soulbinds.d.ts
|
|
1386
1342
|
/**
|
|
@@ -1389,20 +1345,25 @@ interface TypeClass {
|
|
|
1389
1345
|
* @returns a character's soulbinds.
|
|
1390
1346
|
*/
|
|
1391
1347
|
declare function characterSoulbinds(realmSlug: string, characterName: string): Resource<CharacterSoulbindsResponse>;
|
|
1392
|
-
|
|
1393
1348
|
//#endregion
|
|
1394
1349
|
//#region src/character-specializations/types.d.ts
|
|
1395
1350
|
interface CharacterSpecializationsSummaryResponse extends ResponseBase {
|
|
1396
|
-
|
|
1351
|
+
active_hero_talent_tree: NameIdKey;
|
|
1397
1352
|
active_specialization: NameIdKey;
|
|
1398
|
-
character: Character
|
|
1353
|
+
character: Character;
|
|
1399
1354
|
specializations: Array<Specialization$1>;
|
|
1400
1355
|
}
|
|
1401
1356
|
interface Loadout {
|
|
1402
1357
|
is_active: boolean;
|
|
1403
|
-
selected_class_talent_tree:
|
|
1358
|
+
selected_class_talent_tree: KeyBase & {
|
|
1359
|
+
name: string;
|
|
1360
|
+
};
|
|
1404
1361
|
selected_class_talents: Array<SelectedTalent>;
|
|
1405
|
-
|
|
1362
|
+
selected_hero_talent_tree: NameIdKey;
|
|
1363
|
+
selected_hero_talents: Array<SelectedTalent>;
|
|
1364
|
+
selected_spec_talent_tree: KeyBase & {
|
|
1365
|
+
name: string;
|
|
1366
|
+
};
|
|
1406
1367
|
selected_spec_talents?: Array<SelectedTalent>;
|
|
1407
1368
|
talent_loadout_code: string;
|
|
1408
1369
|
}
|
|
@@ -1411,14 +1372,17 @@ interface PvpTalentSlot {
|
|
|
1411
1372
|
slot_number: number;
|
|
1412
1373
|
}
|
|
1413
1374
|
interface Selected {
|
|
1414
|
-
spell_tooltip: SpellTooltip$
|
|
1415
|
-
talent:
|
|
1375
|
+
spell_tooltip: SpellTooltip$3;
|
|
1376
|
+
talent: KeyBase & {
|
|
1377
|
+
id: number;
|
|
1378
|
+
name?: string;
|
|
1379
|
+
};
|
|
1416
1380
|
}
|
|
1417
1381
|
interface SelectedTalent {
|
|
1418
1382
|
default_points?: number;
|
|
1419
1383
|
id: number;
|
|
1420
1384
|
rank: number;
|
|
1421
|
-
tooltip
|
|
1385
|
+
tooltip?: Selected;
|
|
1422
1386
|
}
|
|
1423
1387
|
interface Specialization$1 {
|
|
1424
1388
|
glyphs?: Array<NameIdKey>;
|
|
@@ -1426,15 +1390,17 @@ interface Specialization$1 {
|
|
|
1426
1390
|
pvp_talent_slots?: Array<PvpTalentSlot>;
|
|
1427
1391
|
specialization: NameIdKey;
|
|
1428
1392
|
}
|
|
1429
|
-
interface SpellTooltip$
|
|
1430
|
-
cast_time
|
|
1393
|
+
interface SpellTooltip$3 {
|
|
1394
|
+
cast_time?: '1.5 sec cast' | '2.5 sec cast' | '3 sec cast' | 'Channeled' | 'Instant' | 'Passive';
|
|
1431
1395
|
cooldown?: string;
|
|
1432
|
-
description
|
|
1396
|
+
description?: string;
|
|
1433
1397
|
power_cost?: string;
|
|
1434
1398
|
range?: '8-30 yd range' | '15 yd range' | '30 yd range' | '40 yd range' | '50 yd range' | '55 yd range' | '100 yd range' | 'Melee Range';
|
|
1435
|
-
spell:
|
|
1399
|
+
spell: KeyBase & {
|
|
1400
|
+
id: number;
|
|
1401
|
+
name?: string;
|
|
1402
|
+
};
|
|
1436
1403
|
}
|
|
1437
|
-
|
|
1438
1404
|
//#endregion
|
|
1439
1405
|
//#region src/character-specializations/character-specializations.d.ts
|
|
1440
1406
|
/**
|
|
@@ -1443,7 +1409,6 @@ interface SpellTooltip$2 {
|
|
|
1443
1409
|
* @returns a summary of a character's specializations.
|
|
1444
1410
|
*/
|
|
1445
1411
|
declare function characterSpecializationsSummary(realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
|
|
1446
|
-
|
|
1447
1412
|
//#endregion
|
|
1448
1413
|
//#region src/character-statistics/types.d.ts
|
|
1449
1414
|
interface CharacterStatisticsSummaryResponse extends ResponseBase {
|
|
@@ -1453,7 +1418,7 @@ interface CharacterStatisticsSummaryResponse extends ResponseBase {
|
|
|
1453
1418
|
avoidance: Rating;
|
|
1454
1419
|
block: RatingWithValue;
|
|
1455
1420
|
bonus_armor: number;
|
|
1456
|
-
character: Character
|
|
1421
|
+
character: Character;
|
|
1457
1422
|
dodge: RatingWithValue;
|
|
1458
1423
|
health: number;
|
|
1459
1424
|
intellect: BaseEffectiveStat;
|
|
@@ -1473,7 +1438,7 @@ interface CharacterStatisticsSummaryResponse extends ResponseBase {
|
|
|
1473
1438
|
off_hand_speed: number;
|
|
1474
1439
|
parry: RatingWithValue;
|
|
1475
1440
|
power: number;
|
|
1476
|
-
power_type:
|
|
1441
|
+
power_type: NameIdKey;
|
|
1477
1442
|
ranged_crit: RatingWithValue;
|
|
1478
1443
|
ranged_haste: RatingWithValue;
|
|
1479
1444
|
speed: Rating;
|
|
@@ -1493,15 +1458,14 @@ interface BaseEffectiveStat {
|
|
|
1493
1458
|
effective: number;
|
|
1494
1459
|
}
|
|
1495
1460
|
interface Rating {
|
|
1496
|
-
rating: number;
|
|
1497
1461
|
rating_bonus: number;
|
|
1462
|
+
rating_normalized: number;
|
|
1498
1463
|
}
|
|
1499
1464
|
interface RatingWithValue {
|
|
1500
|
-
rating: number;
|
|
1501
1465
|
rating_bonus: number;
|
|
1466
|
+
rating_normalized: number;
|
|
1502
1467
|
value: number;
|
|
1503
1468
|
}
|
|
1504
|
-
|
|
1505
1469
|
//#endregion
|
|
1506
1470
|
//#region src/character-statistics/character-statistics.d.ts
|
|
1507
1471
|
/**
|
|
@@ -1510,17 +1474,15 @@ interface RatingWithValue {
|
|
|
1510
1474
|
* @returns a statistics summary for a character.
|
|
1511
1475
|
*/
|
|
1512
1476
|
declare function characterStatisticsSummary(realmSlug: string, characterName: string): Resource<CharacterStatisticsSummaryResponse>;
|
|
1513
|
-
|
|
1514
1477
|
//#endregion
|
|
1515
1478
|
//#region src/character-titles/types.d.ts
|
|
1516
1479
|
interface CharacterTitlesSummaryResponse extends ResponseBase {
|
|
1517
|
-
active_title
|
|
1480
|
+
active_title?: NameIdKey & {
|
|
1518
1481
|
display_string: string;
|
|
1519
1482
|
};
|
|
1520
|
-
character: Character
|
|
1483
|
+
character: Character;
|
|
1521
1484
|
titles: Array<NameIdKey>;
|
|
1522
1485
|
}
|
|
1523
|
-
|
|
1524
1486
|
//#endregion
|
|
1525
1487
|
//#region src/character-titles/character-titles.d.ts
|
|
1526
1488
|
/**
|
|
@@ -1529,7 +1491,6 @@ interface CharacterTitlesSummaryResponse extends ResponseBase {
|
|
|
1529
1491
|
* @returns a summary of titles a character has obtained.
|
|
1530
1492
|
*/
|
|
1531
1493
|
declare function characterTitlesSummary(realmSlug: string, characterName: string): Resource<CharacterTitlesSummaryResponse>;
|
|
1532
|
-
|
|
1533
1494
|
//#endregion
|
|
1534
1495
|
//#region src/realm/types.d.ts
|
|
1535
1496
|
/**
|
|
@@ -1542,24 +1503,23 @@ type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'L
|
|
|
1542
1503
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1543
1504
|
*/
|
|
1544
1505
|
interface RealmIndexResponse extends ResponseBase {
|
|
1545
|
-
realms: Array<Realm
|
|
1506
|
+
realms: Array<Realm>;
|
|
1546
1507
|
}
|
|
1508
|
+
type RealmLocales = 'deDE' | 'enGB' | 'enUS' | 'esES' | 'esMX' | 'frFR' | 'itIT' | 'koKR' | 'ptBR' | 'ptPT' | 'ruRU' | 'zhCN' | 'zhTW';
|
|
1547
1509
|
/**
|
|
1548
1510
|
* The response for a realm.
|
|
1549
1511
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1550
1512
|
*/
|
|
1551
1513
|
interface RealmResponse extends NameId, ResponseBase {
|
|
1552
1514
|
category: RealmCategory;
|
|
1553
|
-
connected_realm:
|
|
1554
|
-
href: string;
|
|
1555
|
-
};
|
|
1515
|
+
connected_realm: Href;
|
|
1556
1516
|
is_tournament: boolean;
|
|
1557
|
-
locale:
|
|
1517
|
+
locale: RealmLocales;
|
|
1558
1518
|
region: NameIdKey;
|
|
1559
1519
|
slug: string;
|
|
1560
1520
|
timezone: RealmTimezone;
|
|
1561
1521
|
type: {
|
|
1562
|
-
name:
|
|
1522
|
+
name: string;
|
|
1563
1523
|
type: RealmTypeCapitalized;
|
|
1564
1524
|
};
|
|
1565
1525
|
}
|
|
@@ -1576,39 +1536,36 @@ interface RealmSearchParameters extends BaseSearchParameters {
|
|
|
1576
1536
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1577
1537
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1578
1538
|
*/
|
|
1539
|
+
interface RealmSearchResponse extends SearchResponseWithoutResults {
|
|
1540
|
+
results: Array<RealmSearchResponseItem>;
|
|
1541
|
+
}
|
|
1542
|
+
/**
|
|
1543
|
+
* The timezone of a realm.
|
|
1544
|
+
*/
|
|
1545
|
+
type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
|
|
1546
|
+
/**
|
|
1547
|
+
* The type of a realm, capitalized and shortened).
|
|
1548
|
+
*/
|
|
1549
|
+
type RealmTypeCapitalized = 'NORMAL' | 'RP';
|
|
1579
1550
|
interface RealmSearchResponseItem extends KeyBase {
|
|
1580
1551
|
data: {
|
|
1581
|
-
category: Record<Locales, string
|
|
1552
|
+
category: Record<Locales, string>;
|
|
1582
1553
|
id: number;
|
|
1583
1554
|
is_tournament: boolean;
|
|
1584
|
-
locale:
|
|
1585
|
-
name: Record<Locales, string
|
|
1555
|
+
locale: RealmLocales;
|
|
1556
|
+
name: Record<Locales, string>;
|
|
1586
1557
|
region: {
|
|
1587
1558
|
id: number;
|
|
1588
|
-
name: Record<Locales, string
|
|
1559
|
+
name: Record<Locales, string>;
|
|
1589
1560
|
};
|
|
1590
1561
|
slug: string;
|
|
1591
1562
|
timezone: RealmTimezone;
|
|
1592
1563
|
type: {
|
|
1593
|
-
name: Record<Locales, string
|
|
1564
|
+
name: Record<Locales, string>;
|
|
1594
1565
|
type: RealmTypeCapitalized;
|
|
1595
1566
|
};
|
|
1596
1567
|
};
|
|
1597
1568
|
}
|
|
1598
|
-
/**
|
|
1599
|
-
* The timezone of a realm.
|
|
1600
|
-
*/
|
|
1601
|
-
type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
|
|
1602
|
-
/**
|
|
1603
|
-
* The type of a realm, not capitalized or shortened.
|
|
1604
|
-
*/
|
|
1605
|
-
type RealmType = 'Normal' | 'Roleplaying';
|
|
1606
|
-
/**
|
|
1607
|
-
* The type of a realm, capitalized and shortended).
|
|
1608
|
-
*/
|
|
1609
|
-
type RealmTypeCapitalized = 'NORMAL' | 'RP';
|
|
1610
|
-
type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
|
|
1611
|
-
|
|
1612
1569
|
//#endregion
|
|
1613
1570
|
//#region src/connected-realm/types.d.ts
|
|
1614
1571
|
/**
|
|
@@ -1616,32 +1573,26 @@ type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Su
|
|
|
1616
1573
|
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
1617
1574
|
*/
|
|
1618
1575
|
interface ConnectedRealmIndexResponse extends ResponseBase {
|
|
1619
|
-
connected_realms: Array<
|
|
1620
|
-
href: string;
|
|
1621
|
-
}>;
|
|
1576
|
+
connected_realms: Array<Href>;
|
|
1622
1577
|
}
|
|
1623
1578
|
/**
|
|
1624
1579
|
* Connected Realm API response.
|
|
1625
1580
|
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
1626
1581
|
*/
|
|
1627
1582
|
interface ConnectedRealmResponse extends ResponseBase {
|
|
1628
|
-
auctions:
|
|
1629
|
-
href: string;
|
|
1630
|
-
};
|
|
1583
|
+
auctions: Href;
|
|
1631
1584
|
has_queue: boolean;
|
|
1632
1585
|
id: number;
|
|
1633
|
-
mythic_leaderboards:
|
|
1634
|
-
href: string;
|
|
1635
|
-
};
|
|
1586
|
+
mythic_leaderboards: Href;
|
|
1636
1587
|
population: {
|
|
1637
|
-
name:
|
|
1588
|
+
name: string;
|
|
1638
1589
|
type: RealmPopulationCapitalized;
|
|
1639
1590
|
};
|
|
1640
1591
|
realm_locked_status?: RealmLockedStatus;
|
|
1641
|
-
realms: Array<Realm$
|
|
1592
|
+
realms: Array<Realm$4>;
|
|
1642
1593
|
status: {
|
|
1643
1594
|
name: RealmStatus;
|
|
1644
|
-
type:
|
|
1595
|
+
type: RealmStatusCapitalized;
|
|
1645
1596
|
};
|
|
1646
1597
|
}
|
|
1647
1598
|
/**
|
|
@@ -1651,13 +1602,16 @@ interface ConnectedRealmResponse extends ResponseBase {
|
|
|
1651
1602
|
*/
|
|
1652
1603
|
interface ConnectedRealmSearchParameters extends BaseSearchParameters {
|
|
1653
1604
|
'realms.timezone'?: RealmTimezone;
|
|
1654
|
-
'status.type'?:
|
|
1605
|
+
'status.type'?: RealmStatusCapitalized;
|
|
1655
1606
|
}
|
|
1656
1607
|
/**
|
|
1657
1608
|
* Connected Realm Search API response item.
|
|
1658
1609
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1659
1610
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1660
1611
|
*/
|
|
1612
|
+
interface ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
|
|
1613
|
+
results: Array<ConnectedRealmSearchResponseItem>;
|
|
1614
|
+
}
|
|
1661
1615
|
interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
1662
1616
|
data: {
|
|
1663
1617
|
has_queue: boolean;
|
|
@@ -1667,20 +1621,18 @@ interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
|
1667
1621
|
status: SearchRealmStatus;
|
|
1668
1622
|
};
|
|
1669
1623
|
}
|
|
1670
|
-
interface Realm$
|
|
1624
|
+
interface Realm$4 {
|
|
1671
1625
|
category: RealmCategory;
|
|
1672
|
-
connected_realm:
|
|
1673
|
-
href: string;
|
|
1674
|
-
};
|
|
1626
|
+
connected_realm: Href;
|
|
1675
1627
|
id: number;
|
|
1676
1628
|
is_tournament: boolean;
|
|
1677
|
-
locale:
|
|
1629
|
+
locale: RealmLocales;
|
|
1678
1630
|
name: string;
|
|
1679
1631
|
region: NameIdKey;
|
|
1680
1632
|
slug: string;
|
|
1681
1633
|
timezone: RealmTimezone;
|
|
1682
1634
|
type: {
|
|
1683
|
-
name:
|
|
1635
|
+
name: string;
|
|
1684
1636
|
type: RealmTypeCapitalized;
|
|
1685
1637
|
};
|
|
1686
1638
|
}
|
|
@@ -1688,23 +1640,23 @@ interface RealmLockedStatus {
|
|
|
1688
1640
|
is_locked_for_new_characters: boolean;
|
|
1689
1641
|
is_locked_for_pct: boolean;
|
|
1690
1642
|
}
|
|
1691
|
-
type RealmPopulation = 'Full' | 'High' | 'Low' | 'Medium' | 'New Players';
|
|
1692
1643
|
type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
|
|
1693
1644
|
type RealmStatus = 'Down' | 'Up';
|
|
1645
|
+
type RealmStatusCapitalized = 'DOWN' | 'UP';
|
|
1694
1646
|
interface SearchRealm {
|
|
1695
|
-
category: Record<Locales, string
|
|
1647
|
+
category: Record<Locales, string>;
|
|
1696
1648
|
id: number;
|
|
1697
1649
|
is_tournament: boolean;
|
|
1698
|
-
locale:
|
|
1699
|
-
name: Record<Locales, string
|
|
1650
|
+
locale: RealmLocales;
|
|
1651
|
+
name: Record<Locales, string>;
|
|
1700
1652
|
region: {
|
|
1701
1653
|
id: number;
|
|
1702
|
-
name: Record<Locales, string
|
|
1654
|
+
name: Record<Locales, string>;
|
|
1703
1655
|
};
|
|
1704
1656
|
slug: string;
|
|
1705
1657
|
timezone: RealmTimezone;
|
|
1706
1658
|
type: {
|
|
1707
|
-
name: Record<Locales, string
|
|
1659
|
+
name: Record<Locales, string>;
|
|
1708
1660
|
type: RealmTypeCapitalized;
|
|
1709
1661
|
};
|
|
1710
1662
|
}
|
|
@@ -1714,9 +1666,8 @@ interface SearchRealmPopulation {
|
|
|
1714
1666
|
}
|
|
1715
1667
|
interface SearchRealmStatus {
|
|
1716
1668
|
name: Record<Locales, string>;
|
|
1717
|
-
type:
|
|
1669
|
+
type: RealmStatusCapitalized;
|
|
1718
1670
|
}
|
|
1719
|
-
|
|
1720
1671
|
//#endregion
|
|
1721
1672
|
//#region src/connected-realm/connected-realm.d.ts
|
|
1722
1673
|
/**
|
|
@@ -1733,10 +1684,9 @@ declare function connectedRealmIndex(): Resource<ConnectedRealmIndexResponse>;
|
|
|
1733
1684
|
/**
|
|
1734
1685
|
* Search for connected realms.
|
|
1735
1686
|
* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
|
|
1736
|
-
* @returns The search results. See {@link
|
|
1687
|
+
* @returns The search results. See {@link ConnectedRealmSearchResponse}.
|
|
1737
1688
|
*/
|
|
1738
|
-
declare function connectedRealmSearch(options: ConnectedRealmSearchParameters): Resource<
|
|
1739
|
-
|
|
1689
|
+
declare function connectedRealmSearch(options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
|
|
1740
1690
|
//#endregion
|
|
1741
1691
|
//#region src/covenant/types.d.ts
|
|
1742
1692
|
/**
|
|
@@ -1752,7 +1702,7 @@ interface ConduitIndexResponse extends ResponseBase {
|
|
|
1752
1702
|
*/
|
|
1753
1703
|
interface ConduitResponse extends ResponseBase {
|
|
1754
1704
|
id: number;
|
|
1755
|
-
item:
|
|
1705
|
+
item: NameIdKey;
|
|
1756
1706
|
name: string;
|
|
1757
1707
|
ranks: Array<Rank$1>;
|
|
1758
1708
|
socket_type: SocketType;
|
|
@@ -1769,24 +1719,21 @@ interface CovenantIndexResponse extends ResponseBase {
|
|
|
1769
1719
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1770
1720
|
*/
|
|
1771
1721
|
interface CovenantMediaResponse extends ResponseBase {
|
|
1772
|
-
|
|
1773
|
-
description: string;
|
|
1774
|
-
id: number;
|
|
1775
|
-
media: Media$14;
|
|
1776
|
-
name: string;
|
|
1777
|
-
renown_rewards: Array<RenownReward>;
|
|
1778
|
-
signature_ability: SignatureAbility;
|
|
1779
|
-
soulbinds: Array<NameIdKey>;
|
|
1722
|
+
assets?: Array<MediaAsset>;
|
|
1780
1723
|
}
|
|
1781
1724
|
/**
|
|
1782
1725
|
* Interface for a response from the covenant endpoint.
|
|
1783
1726
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1784
1727
|
*/
|
|
1785
1728
|
interface CovenantResponse extends ResponseBase {
|
|
1729
|
+
class_abilities?: Array<ClassAbility>;
|
|
1786
1730
|
description: string;
|
|
1787
1731
|
id: number;
|
|
1732
|
+
media?: Media$14;
|
|
1788
1733
|
name: string;
|
|
1789
1734
|
renown_rewards: Array<RenownReward>;
|
|
1735
|
+
signature_ability?: SignatureAbility;
|
|
1736
|
+
soulbinds?: Array<NameIdKey>;
|
|
1790
1737
|
}
|
|
1791
1738
|
/**
|
|
1792
1739
|
* Interface for a response from the soulbind index endpoint.
|
|
@@ -1802,7 +1749,7 @@ interface SoulbindIndexResponse extends ResponseBase {
|
|
|
1802
1749
|
interface SoulbindResponse extends ResponseBase {
|
|
1803
1750
|
covenant: NameIdKey;
|
|
1804
1751
|
creature: NameIdKey;
|
|
1805
|
-
follower:
|
|
1752
|
+
follower: NameId;
|
|
1806
1753
|
id: number;
|
|
1807
1754
|
name: string;
|
|
1808
1755
|
talent_tree: NameIdKey;
|
|
@@ -1820,15 +1767,12 @@ interface ClassAbilitySpellTooltip {
|
|
|
1820
1767
|
range?: string;
|
|
1821
1768
|
spell: NameIdKey;
|
|
1822
1769
|
}
|
|
1823
|
-
interface Item$1 extends KeyBase {
|
|
1824
|
-
id: number;
|
|
1825
|
-
}
|
|
1826
1770
|
interface Media$14 extends KeyBase {
|
|
1827
1771
|
id: number;
|
|
1828
1772
|
}
|
|
1829
1773
|
interface Rank$1 {
|
|
1830
1774
|
id: number;
|
|
1831
|
-
spell_tooltip: SpellTooltip$
|
|
1775
|
+
spell_tooltip: SpellTooltip$2;
|
|
1832
1776
|
tier: number;
|
|
1833
1777
|
}
|
|
1834
1778
|
interface RenownReward {
|
|
@@ -1841,20 +1785,20 @@ interface SignatureAbility {
|
|
|
1841
1785
|
}
|
|
1842
1786
|
interface SignatureAbilitySpellTooltip {
|
|
1843
1787
|
cast_time: string;
|
|
1844
|
-
cooldown
|
|
1788
|
+
cooldown?: string;
|
|
1845
1789
|
description: string;
|
|
1790
|
+
range?: string;
|
|
1846
1791
|
spell: NameIdKey;
|
|
1847
1792
|
}
|
|
1848
1793
|
interface SocketType {
|
|
1849
1794
|
name: string;
|
|
1850
1795
|
type: string;
|
|
1851
1796
|
}
|
|
1852
|
-
interface SpellTooltip$
|
|
1797
|
+
interface SpellTooltip$2 {
|
|
1853
1798
|
cast_time: string;
|
|
1854
1799
|
description: string;
|
|
1855
|
-
spell:
|
|
1800
|
+
spell: NameIdKey;
|
|
1856
1801
|
}
|
|
1857
|
-
|
|
1858
1802
|
//#endregion
|
|
1859
1803
|
//#region src/covenant/covenant.d.ts
|
|
1860
1804
|
/**
|
|
@@ -1896,7 +1840,6 @@ declare function soulbind(soulbindId: number): Resource<SoulbindResponse>;
|
|
|
1896
1840
|
* @returns The soulbind index. See {@link SoulbindIndexResponse}.
|
|
1897
1841
|
*/
|
|
1898
1842
|
declare function soulbindIndex(): Resource<SoulbindIndexResponse>;
|
|
1899
|
-
|
|
1900
1843
|
//#endregion
|
|
1901
1844
|
//#region src/creature/types.d.ts
|
|
1902
1845
|
/**
|
|
@@ -1919,7 +1862,7 @@ interface CreatureFamilyIndexResponse extends ResponseBase {
|
|
|
1919
1862
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1920
1863
|
*/
|
|
1921
1864
|
interface CreatureFamilyMediaResponse extends ResponseBase {
|
|
1922
|
-
assets: Array<MediaAsset
|
|
1865
|
+
assets: Array<MediaAsset>;
|
|
1923
1866
|
id: number;
|
|
1924
1867
|
}
|
|
1925
1868
|
/**
|
|
@@ -1958,23 +1901,8 @@ interface CreatureSearchParameters extends BaseSearchParameters {
|
|
|
1958
1901
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1959
1902
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1960
1903
|
*/
|
|
1961
|
-
interface
|
|
1962
|
-
|
|
1963
|
-
creature_displays: Array<{
|
|
1964
|
-
id: number;
|
|
1965
|
-
}>;
|
|
1966
|
-
family?: {
|
|
1967
|
-
id: number;
|
|
1968
|
-
name: Record<Locales, string | undefined>;
|
|
1969
|
-
};
|
|
1970
|
-
id: number;
|
|
1971
|
-
is_tameable: boolean;
|
|
1972
|
-
name: Record<Locales, string | undefined>;
|
|
1973
|
-
type: {
|
|
1974
|
-
id: number;
|
|
1975
|
-
name: Record<Locales, string | undefined>;
|
|
1976
|
-
};
|
|
1977
|
-
};
|
|
1904
|
+
interface CreatureSearchResponse extends SearchResponseWithoutResults {
|
|
1905
|
+
results: Array<CreatureSearchResponseItem>;
|
|
1978
1906
|
}
|
|
1979
1907
|
/**
|
|
1980
1908
|
* The response for a creature type index.
|
|
@@ -1994,6 +1922,24 @@ interface CreatureTypeResponse extends ResponseBase {
|
|
|
1994
1922
|
interface CreatureDisplay$2 extends KeyBase {
|
|
1995
1923
|
id: number;
|
|
1996
1924
|
}
|
|
1925
|
+
interface CreatureSearchResponseItem extends KeyBase {
|
|
1926
|
+
data: {
|
|
1927
|
+
creature_displays: Array<{
|
|
1928
|
+
id: number;
|
|
1929
|
+
}>;
|
|
1930
|
+
family?: {
|
|
1931
|
+
id: number;
|
|
1932
|
+
name: Record<Locales, string>;
|
|
1933
|
+
};
|
|
1934
|
+
id: number;
|
|
1935
|
+
is_tameable: boolean;
|
|
1936
|
+
name: Record<Locales, string | undefined>;
|
|
1937
|
+
type: {
|
|
1938
|
+
id: number;
|
|
1939
|
+
name: Record<Locales, string>;
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
}
|
|
1997
1943
|
interface DisplayMediaAsset {
|
|
1998
1944
|
key: string;
|
|
1999
1945
|
value: string;
|
|
@@ -2001,7 +1947,6 @@ interface DisplayMediaAsset {
|
|
|
2001
1947
|
interface Media$13 extends KeyBase {
|
|
2002
1948
|
id: number;
|
|
2003
1949
|
}
|
|
2004
|
-
|
|
2005
1950
|
//#endregion
|
|
2006
1951
|
//#region src/creature/creature.d.ts
|
|
2007
1952
|
/**
|
|
@@ -2036,9 +1981,9 @@ declare function creatureFamilyMedia(creatureFamilyId: number): Resource<Creatur
|
|
|
2036
1981
|
/**
|
|
2037
1982
|
* Search for creatures.
|
|
2038
1983
|
* @param options The creature search parameters. See {@link CreatureSearchParameters}.
|
|
2039
|
-
* @returns The creature search results. See {@link
|
|
1984
|
+
* @returns The creature search results. See {@link CreatureSearchResponse}.
|
|
2040
1985
|
*/
|
|
2041
|
-
declare function creatureSearch(options: CreatureSearchParameters): Resource<
|
|
1986
|
+
declare function creatureSearch(options: CreatureSearchParameters): Resource<CreatureSearchResponse, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
|
|
2042
1987
|
/**
|
|
2043
1988
|
* Get a creature type by ID.
|
|
2044
1989
|
* @param creatureTypeId The creature type ID.
|
|
@@ -2050,7 +1995,6 @@ declare function creatureType(creatureTypeId: number): Resource<CreatureTypeResp
|
|
|
2050
1995
|
* @returns The creature type index. See {@link CreatureTypeIndexResponse}.
|
|
2051
1996
|
*/
|
|
2052
1997
|
declare function creatureTypeIndex(): Resource<CreatureTypeIndexResponse>;
|
|
2053
|
-
|
|
2054
1998
|
//#endregion
|
|
2055
1999
|
//#region src/guild-crest/types.d.ts
|
|
2056
2000
|
/**
|
|
@@ -2072,7 +2016,7 @@ interface GuildCrestComponentsIndexResponse extends ResponseBase {
|
|
|
2072
2016
|
}
|
|
2073
2017
|
interface Background {
|
|
2074
2018
|
id: number;
|
|
2075
|
-
rgba:
|
|
2019
|
+
rgba: Color;
|
|
2076
2020
|
}
|
|
2077
2021
|
interface Border$1 {
|
|
2078
2022
|
id: number;
|
|
@@ -2090,13 +2034,6 @@ interface GuildCrestAsset {
|
|
|
2090
2034
|
interface Media$12 extends KeyBase {
|
|
2091
2035
|
id: number;
|
|
2092
2036
|
}
|
|
2093
|
-
interface RGBA {
|
|
2094
|
-
a: number;
|
|
2095
|
-
b: number;
|
|
2096
|
-
g: number;
|
|
2097
|
-
r: number;
|
|
2098
|
-
}
|
|
2099
|
-
|
|
2100
2037
|
//#endregion
|
|
2101
2038
|
//#region src/guild-crest/guild-crest.d.ts
|
|
2102
2039
|
/**
|
|
@@ -2116,7 +2053,6 @@ declare function guildCrestComponentsIndex(): Resource<GuildCrestComponentsIndex
|
|
|
2116
2053
|
* @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
|
|
2117
2054
|
*/
|
|
2118
2055
|
declare function guildCrestEmblem(emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
|
|
2119
|
-
|
|
2120
2056
|
//#endregion
|
|
2121
2057
|
//#region src/guild/types.d.ts
|
|
2122
2058
|
interface GuildAchievementsResponse extends ResponseBase {
|
|
@@ -2142,7 +2078,7 @@ interface GuildResponse extends ResponseBase {
|
|
|
2142
2078
|
member_count: number;
|
|
2143
2079
|
name: string;
|
|
2144
2080
|
name_search: string;
|
|
2145
|
-
realm: Realm
|
|
2081
|
+
realm: Realm;
|
|
2146
2082
|
roster: Href;
|
|
2147
2083
|
}
|
|
2148
2084
|
interface GuildRosterResponse extends ResponseBase {
|
|
@@ -2159,7 +2095,8 @@ interface ActivityElement {
|
|
|
2159
2095
|
activity: {
|
|
2160
2096
|
type: string;
|
|
2161
2097
|
};
|
|
2162
|
-
character_achievement
|
|
2098
|
+
character_achievement?: CharacterAchievement;
|
|
2099
|
+
encounter_completed?: EncounterActivity;
|
|
2163
2100
|
timestamp: number;
|
|
2164
2101
|
}
|
|
2165
2102
|
interface Border {
|
|
@@ -2176,7 +2113,12 @@ interface CategoryProgress {
|
|
|
2176
2113
|
}
|
|
2177
2114
|
interface CharacterAchievement {
|
|
2178
2115
|
achievement: NameIdKey;
|
|
2179
|
-
character: Character
|
|
2116
|
+
character: Character;
|
|
2117
|
+
}
|
|
2118
|
+
interface ChildCriterum {
|
|
2119
|
+
amount: number;
|
|
2120
|
+
id: number;
|
|
2121
|
+
is_completed: boolean;
|
|
2180
2122
|
}
|
|
2181
2123
|
interface Crest {
|
|
2182
2124
|
background: {
|
|
@@ -2187,13 +2129,20 @@ interface Crest {
|
|
|
2187
2129
|
}
|
|
2188
2130
|
interface Criteria {
|
|
2189
2131
|
amount?: number;
|
|
2190
|
-
child_criteria?: Array<
|
|
2132
|
+
child_criteria?: Array<ChildCriterum>;
|
|
2191
2133
|
id: number;
|
|
2192
2134
|
is_completed: boolean;
|
|
2193
2135
|
}
|
|
2136
|
+
interface EncounterActivity {
|
|
2137
|
+
encounter: NameIdKey;
|
|
2138
|
+
mode: {
|
|
2139
|
+
name: string;
|
|
2140
|
+
type: 'MYTHIC';
|
|
2141
|
+
};
|
|
2142
|
+
}
|
|
2194
2143
|
interface Guild$1 extends NameIdKey {
|
|
2195
2144
|
faction: Faction;
|
|
2196
|
-
realm: Realm
|
|
2145
|
+
realm: Realm;
|
|
2197
2146
|
}
|
|
2198
2147
|
interface Member$1 {
|
|
2199
2148
|
character: RosterMemberCharacter;
|
|
@@ -2210,12 +2159,14 @@ interface RgbWithId {
|
|
|
2210
2159
|
id: number;
|
|
2211
2160
|
rgba: Color;
|
|
2212
2161
|
}
|
|
2213
|
-
interface RosterMemberCharacter extends Character
|
|
2162
|
+
interface RosterMemberCharacter extends Character {
|
|
2163
|
+
faction: {
|
|
2164
|
+
type: Factions;
|
|
2165
|
+
};
|
|
2214
2166
|
level: number;
|
|
2215
2167
|
playable_class: Playable;
|
|
2216
2168
|
playable_race: Playable;
|
|
2217
2169
|
}
|
|
2218
|
-
|
|
2219
2170
|
//#endregion
|
|
2220
2171
|
//#region src/guild/guild.d.ts
|
|
2221
2172
|
/**
|
|
@@ -2242,7 +2193,6 @@ declare function guildActivity(realmSlug: string, nameSlug: string): Resource<Gu
|
|
|
2242
2193
|
* @returns a single guild's roster by its name and realm.
|
|
2243
2194
|
*/
|
|
2244
2195
|
declare function guildRoster(realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
|
|
2245
|
-
|
|
2246
2196
|
//#endregion
|
|
2247
2197
|
//#region src/heirloom/types.d.ts
|
|
2248
2198
|
/**
|
|
@@ -2328,7 +2278,6 @@ interface Weapon$1 {
|
|
|
2328
2278
|
damage: Damage$1;
|
|
2329
2279
|
dps: AttackSpeedClass;
|
|
2330
2280
|
}
|
|
2331
|
-
|
|
2332
2281
|
//#endregion
|
|
2333
2282
|
//#region src/heirloom/heirloom.d.ts
|
|
2334
2283
|
/**
|
|
@@ -2342,7 +2291,6 @@ declare function heirloom(heirloomId: number): Resource<HeirloomResponse>;
|
|
|
2342
2291
|
* @returns The heirloom index. See {@link HeirloomIndexResponse}.
|
|
2343
2292
|
*/
|
|
2344
2293
|
declare function heirloomIndex(): Resource<HeirloomIndexResponse>;
|
|
2345
|
-
|
|
2346
2294
|
//#endregion
|
|
2347
2295
|
//#region src/item/types.d.ts
|
|
2348
2296
|
/**
|
|
@@ -2366,7 +2314,7 @@ interface ItemClassResponse extends ResponseBase {
|
|
|
2366
2314
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2367
2315
|
*/
|
|
2368
2316
|
interface ItemMediaResponse extends ResponseBase {
|
|
2369
|
-
assets: Array<MediaAsset
|
|
2317
|
+
assets: Array<MediaAsset>;
|
|
2370
2318
|
id: number;
|
|
2371
2319
|
}
|
|
2372
2320
|
/**
|
|
@@ -2374,8 +2322,11 @@ interface ItemMediaResponse extends ResponseBase {
|
|
|
2374
2322
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2375
2323
|
*/
|
|
2376
2324
|
interface ItemResponse extends NameId, ResponseBase {
|
|
2325
|
+
appearances?: Array<KeyBase & {
|
|
2326
|
+
id: number;
|
|
2327
|
+
}>;
|
|
2377
2328
|
description?: string;
|
|
2378
|
-
inventory_type:
|
|
2329
|
+
inventory_type: InventoryTypeName;
|
|
2379
2330
|
is_equippable: boolean;
|
|
2380
2331
|
is_stackable: boolean;
|
|
2381
2332
|
item_class: NameIdKey;
|
|
@@ -2404,32 +2355,8 @@ interface ItemSearchParameters extends BaseSearchParameters {
|
|
|
2404
2355
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2405
2356
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2406
2357
|
*/
|
|
2407
|
-
interface
|
|
2408
|
-
|
|
2409
|
-
id: number;
|
|
2410
|
-
inventory_type: InventoryType;
|
|
2411
|
-
is_equippable: boolean;
|
|
2412
|
-
is_stackable: boolean;
|
|
2413
|
-
item_class: {
|
|
2414
|
-
id: number;
|
|
2415
|
-
name: Record<Locales, string | undefined>;
|
|
2416
|
-
};
|
|
2417
|
-
item_subclass: {
|
|
2418
|
-
id: number;
|
|
2419
|
-
name: Record<Locales, string | undefined>;
|
|
2420
|
-
};
|
|
2421
|
-
level: number;
|
|
2422
|
-
max_count: number;
|
|
2423
|
-
media: {
|
|
2424
|
-
id: number;
|
|
2425
|
-
};
|
|
2426
|
-
name: Record<Locales, string | undefined>;
|
|
2427
|
-
purchase_price: number;
|
|
2428
|
-
purchase_quantity: number;
|
|
2429
|
-
quality: ItemQuality;
|
|
2430
|
-
required_level: number;
|
|
2431
|
-
sell_price: number;
|
|
2432
|
-
};
|
|
2358
|
+
interface ItemSearchResponse extends SearchResponseWithoutResults {
|
|
2359
|
+
results: Array<ItemSearchResponseItem>;
|
|
2433
2360
|
}
|
|
2434
2361
|
/**
|
|
2435
2362
|
* The response for an item set index.
|
|
@@ -2455,9 +2382,9 @@ interface ItemSetResponse extends ResponseBase {
|
|
|
2455
2382
|
interface ItemSubClassResponse extends ResponseBase {
|
|
2456
2383
|
class_id: number;
|
|
2457
2384
|
display_name: string;
|
|
2458
|
-
hide_subclass_in_tooltips
|
|
2385
|
+
hide_subclass_in_tooltips?: boolean;
|
|
2459
2386
|
subclass_id: number;
|
|
2460
|
-
verbose_name
|
|
2387
|
+
verbose_name?: string;
|
|
2461
2388
|
}
|
|
2462
2389
|
interface Armor {
|
|
2463
2390
|
display: Display;
|
|
@@ -2484,13 +2411,53 @@ interface Effect {
|
|
|
2484
2411
|
display_string: string;
|
|
2485
2412
|
required_count: number;
|
|
2486
2413
|
}
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2414
|
+
type InventoryType = 'BACK' | 'CHEST' | 'FEET' | 'FINGER' | 'HAND' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'SHOULDER' | 'THROWN' | 'TRINKET' | 'WAIST' | 'WRIST' | 'RANGED' | 'TWOHWEAPON' | 'WEAPON' | 'WEAPONMAINHAND' | 'WEAPONOFFHAND' | 'BAG' | 'NON_EQUIP' | 'SHIRT' | 'TABARD';
|
|
2415
|
+
interface InventoryTypeName {
|
|
2416
|
+
name: string;
|
|
2417
|
+
type: InventoryType;
|
|
2418
|
+
}
|
|
2419
|
+
interface InventoryTypeNameFromSearch {
|
|
2420
|
+
name: Record<Locales, string>;
|
|
2421
|
+
type: InventoryType;
|
|
2490
2422
|
}
|
|
2491
2423
|
interface ItemQuality {
|
|
2492
|
-
name:
|
|
2493
|
-
type:
|
|
2424
|
+
name: string;
|
|
2425
|
+
type: ItemQualityType;
|
|
2426
|
+
}
|
|
2427
|
+
interface ItemQualityFromSearch {
|
|
2428
|
+
name: Record<Locales, string>;
|
|
2429
|
+
type: ItemQualityType;
|
|
2430
|
+
}
|
|
2431
|
+
type ItemQualityType = 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
2432
|
+
interface ItemSearchResponseItem extends KeyBase {
|
|
2433
|
+
data: {
|
|
2434
|
+
appearances?: Array<{
|
|
2435
|
+
id: number;
|
|
2436
|
+
}>;
|
|
2437
|
+
id: number;
|
|
2438
|
+
inventory_type: InventoryTypeNameFromSearch;
|
|
2439
|
+
is_equippable: boolean;
|
|
2440
|
+
is_stackable: boolean;
|
|
2441
|
+
item_class: {
|
|
2442
|
+
id: number;
|
|
2443
|
+
name: Record<Locales, string>;
|
|
2444
|
+
};
|
|
2445
|
+
item_subclass: {
|
|
2446
|
+
id: number;
|
|
2447
|
+
name: Record<Locales, string>;
|
|
2448
|
+
};
|
|
2449
|
+
level: number;
|
|
2450
|
+
max_count: number;
|
|
2451
|
+
media: {
|
|
2452
|
+
id: number;
|
|
2453
|
+
};
|
|
2454
|
+
name: Record<Locales, string | undefined>;
|
|
2455
|
+
purchase_price: number;
|
|
2456
|
+
purchase_quantity: number;
|
|
2457
|
+
quality: ItemQualityFromSearch;
|
|
2458
|
+
required_level: number;
|
|
2459
|
+
sell_price: number;
|
|
2460
|
+
};
|
|
2494
2461
|
}
|
|
2495
2462
|
interface Media$10 extends KeyBase {
|
|
2496
2463
|
id: number;
|
|
@@ -2507,7 +2474,7 @@ interface PreviewItem {
|
|
|
2507
2474
|
crafting_reagent?: string;
|
|
2508
2475
|
description?: string;
|
|
2509
2476
|
durability?: Durability;
|
|
2510
|
-
inventory_type:
|
|
2477
|
+
inventory_type: InventoryTypeName;
|
|
2511
2478
|
is_subclass_hidden?: boolean;
|
|
2512
2479
|
item: Media$10;
|
|
2513
2480
|
item_class: NameIdKey;
|
|
@@ -2539,7 +2506,7 @@ interface RecipeItem {
|
|
|
2539
2506
|
type: string;
|
|
2540
2507
|
};
|
|
2541
2508
|
durability: Durability;
|
|
2542
|
-
inventory_type:
|
|
2509
|
+
inventory_type: InventoryTypeName;
|
|
2543
2510
|
item: Media$10;
|
|
2544
2511
|
item_class: NameIdKey;
|
|
2545
2512
|
item_subclass: NameIdKey;
|
|
@@ -2572,19 +2539,17 @@ interface Stat {
|
|
|
2572
2539
|
display: Display;
|
|
2573
2540
|
is_negated?: boolean;
|
|
2574
2541
|
type: {
|
|
2575
|
-
name:
|
|
2542
|
+
name: string;
|
|
2576
2543
|
type: StatTypeCapitalized;
|
|
2577
2544
|
};
|
|
2578
2545
|
value: number;
|
|
2579
2546
|
}
|
|
2580
|
-
type
|
|
2581
|
-
type StatTypeCapitalized = 'AGILITY' | 'CRIT_RATING' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
|
|
2547
|
+
type StatTypeCapitalized = 'AGILITY' | 'ARCANE_RESISTANCE' | 'CRIT_RATING' | 'FIRE_RESISTANCE' | 'FROST_RESISTANCE' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'NATURE_RESISTANCE' | 'SHADOW_RESISTANCE' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
|
|
2582
2548
|
interface Weapon {
|
|
2583
2549
|
attack_speed: Durability;
|
|
2584
2550
|
damage: Damage;
|
|
2585
2551
|
dps: Durability;
|
|
2586
2552
|
}
|
|
2587
|
-
|
|
2588
2553
|
//#endregion
|
|
2589
2554
|
//#region src/item/item.d.ts
|
|
2590
2555
|
/**
|
|
@@ -2613,9 +2578,9 @@ declare function itemMedia(itemId: number): Resource<ItemMediaResponse>;
|
|
|
2613
2578
|
/**
|
|
2614
2579
|
* Search for items.
|
|
2615
2580
|
* @param options The search parameters. See {@link ItemSearchParameters}.
|
|
2616
|
-
* @returns The search results. See {@link
|
|
2581
|
+
* @returns The search results. See {@link ItemSearchResponse}.
|
|
2617
2582
|
*/
|
|
2618
|
-
declare function itemSearch(options: ItemSearchParameters): Resource<
|
|
2583
|
+
declare function itemSearch(options: ItemSearchParameters): Resource<ItemSearchResponse, Omit<ItemSearchParameters, 'locale' | 'name'>>;
|
|
2619
2584
|
/**
|
|
2620
2585
|
* Get an item set by ID.
|
|
2621
2586
|
* @param itemSetId The item set ID.
|
|
@@ -2634,7 +2599,6 @@ declare function itemSetIndex(): Resource<ItemSetIndexResponse>;
|
|
|
2634
2599
|
* @returns The item subclass. See {@link ItemSubClassResponse}.
|
|
2635
2600
|
*/
|
|
2636
2601
|
declare function itemSubClass(itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
|
|
2637
|
-
|
|
2638
2602
|
//#endregion
|
|
2639
2603
|
//#region src/journal/types.d.ts
|
|
2640
2604
|
/**
|
|
@@ -2650,13 +2614,16 @@ interface JournalEncounterIndexResponse extends ResponseBase {
|
|
|
2650
2614
|
*/
|
|
2651
2615
|
interface JournalEncounterResponse extends NameId, ResponseBase {
|
|
2652
2616
|
category: Category$1;
|
|
2653
|
-
creatures
|
|
2654
|
-
description
|
|
2617
|
+
creatures?: Array<Creature>;
|
|
2618
|
+
description?: string;
|
|
2655
2619
|
faction?: Faction;
|
|
2656
|
-
instance:
|
|
2657
|
-
|
|
2620
|
+
instance: KeyBase & {
|
|
2621
|
+
id: number;
|
|
2622
|
+
name?: string;
|
|
2623
|
+
};
|
|
2624
|
+
items?: Array<Item>;
|
|
2658
2625
|
modes?: Array<Mode>;
|
|
2659
|
-
sections
|
|
2626
|
+
sections?: Array<JournalSection>;
|
|
2660
2627
|
}
|
|
2661
2628
|
/**
|
|
2662
2629
|
* The parameters for a journal encounter search.
|
|
@@ -2667,28 +2634,13 @@ interface JournalEncounterSearchParameters extends BaseSearchParameters {
|
|
|
2667
2634
|
instanceName: string;
|
|
2668
2635
|
locale: Locales;
|
|
2669
2636
|
}
|
|
2670
|
-
/**
|
|
2671
|
-
* The response for a journal encounter search.
|
|
2672
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2673
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2674
|
-
*/
|
|
2675
|
-
interface
|
|
2676
|
-
|
|
2677
|
-
category: Category$1;
|
|
2678
|
-
creatures: Array<JournalEncounterSearchCreature>;
|
|
2679
|
-
id: number;
|
|
2680
|
-
instance: {
|
|
2681
|
-
id: number;
|
|
2682
|
-
name: Record<Locales, string>;
|
|
2683
|
-
};
|
|
2684
|
-
items: Array<JournalEncounterSearchItem>;
|
|
2685
|
-
modes?: Array<{
|
|
2686
|
-
name: Record<Locales, string>;
|
|
2687
|
-
type: EncounterMode;
|
|
2688
|
-
}>;
|
|
2689
|
-
name: Record<Locales, string>;
|
|
2690
|
-
sections: Array<JournalSection>;
|
|
2691
|
-
};
|
|
2637
|
+
/**
|
|
2638
|
+
* The response for a journal encounter search.
|
|
2639
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2640
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2641
|
+
*/
|
|
2642
|
+
interface JournalEncounterSearchResponse extends SearchResponseWithoutResults {
|
|
2643
|
+
results: Array<JournalEncounterSearchResponseItem>;
|
|
2692
2644
|
}
|
|
2693
2645
|
/**
|
|
2694
2646
|
* The response for a journal expansion index.
|
|
@@ -2704,6 +2656,7 @@ interface JournalExpansionIndexResponse extends ResponseBase {
|
|
|
2704
2656
|
interface JournalExpansionResponse extends NameId, ResponseBase {
|
|
2705
2657
|
dungeons: Array<NameIdKey>;
|
|
2706
2658
|
raids: Array<NameIdKey>;
|
|
2659
|
+
world_bosses?: Array<NameIdKey>;
|
|
2707
2660
|
}
|
|
2708
2661
|
/**
|
|
2709
2662
|
* The response for a journal instance index.
|
|
@@ -2724,24 +2677,24 @@ interface JournalInstanceMediaResponse extends ResponseBase {
|
|
|
2724
2677
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2725
2678
|
*/
|
|
2726
2679
|
interface JournalInstanceResponse extends NameId, ResponseBase {
|
|
2727
|
-
area
|
|
2680
|
+
area?: NameId;
|
|
2728
2681
|
category: Category$1;
|
|
2729
|
-
description
|
|
2682
|
+
description?: string;
|
|
2730
2683
|
encounters: Array<NameIdKey>;
|
|
2731
|
-
expansion
|
|
2732
|
-
location
|
|
2733
|
-
map
|
|
2684
|
+
expansion?: NameIdKey;
|
|
2685
|
+
location?: NameId;
|
|
2686
|
+
map?: NameId;
|
|
2734
2687
|
media: Media$9;
|
|
2735
|
-
minimum_level
|
|
2736
|
-
modes
|
|
2737
|
-
order_index
|
|
2688
|
+
minimum_level?: number;
|
|
2689
|
+
modes?: Array<ModeElement>;
|
|
2690
|
+
order_index?: number;
|
|
2738
2691
|
}
|
|
2739
2692
|
interface Asset {
|
|
2740
2693
|
key: string;
|
|
2741
2694
|
value: string;
|
|
2742
2695
|
}
|
|
2743
2696
|
interface Category$1 {
|
|
2744
|
-
type
|
|
2697
|
+
type?: EncounterCategory;
|
|
2745
2698
|
}
|
|
2746
2699
|
interface Creature extends NameId {
|
|
2747
2700
|
creature_display: CreatureDisplay$1;
|
|
@@ -2750,7 +2703,7 @@ interface Creature extends NameId {
|
|
|
2750
2703
|
interface CreatureDisplay$1 extends KeyBase {
|
|
2751
2704
|
id: number;
|
|
2752
2705
|
}
|
|
2753
|
-
type EncounterCategory = 'DUNGEON' | 'RAID' | 'WORLD_BOSS';
|
|
2706
|
+
type EncounterCategory = 'DUNGEON' | 'EVENT' | 'RAID' | 'WORLD_BOSS';
|
|
2754
2707
|
type EncounterMode = 'HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
|
|
2755
2708
|
interface Item {
|
|
2756
2709
|
id: number;
|
|
@@ -2770,13 +2723,99 @@ interface JournalEncounterSearchItem {
|
|
|
2770
2723
|
name: Record<Locales, string>;
|
|
2771
2724
|
};
|
|
2772
2725
|
}
|
|
2726
|
+
interface JournalEncounterSearchResponseItem extends KeyBase {
|
|
2727
|
+
data: {
|
|
2728
|
+
category: Category$1;
|
|
2729
|
+
creatures: Array<JournalEncounterSearchCreature>;
|
|
2730
|
+
id: number;
|
|
2731
|
+
instance: {
|
|
2732
|
+
id: number;
|
|
2733
|
+
name?: Record<Locales, string>;
|
|
2734
|
+
};
|
|
2735
|
+
items?: Array<JournalEncounterSearchItem>;
|
|
2736
|
+
modes?: Array<{
|
|
2737
|
+
name: Record<Locales, string>;
|
|
2738
|
+
type: EncounterMode;
|
|
2739
|
+
}>;
|
|
2740
|
+
name: Record<Locales, string>;
|
|
2741
|
+
sections?: Array<JournalSection>;
|
|
2742
|
+
};
|
|
2743
|
+
}
|
|
2773
2744
|
interface JournalSection {
|
|
2774
|
-
body_text?: string;
|
|
2745
|
+
body_text?: null | string;
|
|
2775
2746
|
creature_display?: CreatureDisplay$1;
|
|
2776
2747
|
id: number;
|
|
2777
|
-
sections?: Array<
|
|
2778
|
-
spell?:
|
|
2779
|
-
|
|
2748
|
+
sections?: Array<JournalSubSection>;
|
|
2749
|
+
spell?: KeyBase & {
|
|
2750
|
+
id: number;
|
|
2751
|
+
name?: string;
|
|
2752
|
+
};
|
|
2753
|
+
title?: string;
|
|
2754
|
+
}
|
|
2755
|
+
interface JournalSubSection {
|
|
2756
|
+
body_text?: null | string;
|
|
2757
|
+
creature_display?: CreatureDisplay$1;
|
|
2758
|
+
id: number;
|
|
2759
|
+
sections?: Array<JournalSubSection2>;
|
|
2760
|
+
spell?: KeyBase & {
|
|
2761
|
+
id: number;
|
|
2762
|
+
name?: string;
|
|
2763
|
+
};
|
|
2764
|
+
title?: string;
|
|
2765
|
+
}
|
|
2766
|
+
interface JournalSubSection2 {
|
|
2767
|
+
body_text?: null | string;
|
|
2768
|
+
creature_display?: CreatureDisplay$1;
|
|
2769
|
+
id: number;
|
|
2770
|
+
sections?: Array<JournalSubSection3>;
|
|
2771
|
+
spell?: KeyBase & {
|
|
2772
|
+
id: number;
|
|
2773
|
+
name?: string;
|
|
2774
|
+
};
|
|
2775
|
+
title?: string;
|
|
2776
|
+
}
|
|
2777
|
+
interface JournalSubSection3 {
|
|
2778
|
+
body_text?: null | string;
|
|
2779
|
+
creature_display?: CreatureDisplay$1;
|
|
2780
|
+
id: number;
|
|
2781
|
+
sections?: Array<JournalSubSection4>;
|
|
2782
|
+
spell?: KeyBase & {
|
|
2783
|
+
id: number;
|
|
2784
|
+
name?: string;
|
|
2785
|
+
};
|
|
2786
|
+
title?: string;
|
|
2787
|
+
}
|
|
2788
|
+
interface JournalSubSection4 {
|
|
2789
|
+
body_text?: null | string;
|
|
2790
|
+
creature_display?: CreatureDisplay$1;
|
|
2791
|
+
id: number;
|
|
2792
|
+
sections?: Array<JournalSubSection5>;
|
|
2793
|
+
spell?: KeyBase & {
|
|
2794
|
+
id: number;
|
|
2795
|
+
name?: string;
|
|
2796
|
+
};
|
|
2797
|
+
title?: string;
|
|
2798
|
+
}
|
|
2799
|
+
interface JournalSubSection5 {
|
|
2800
|
+
body_text?: null | string;
|
|
2801
|
+
creature_display?: CreatureDisplay$1;
|
|
2802
|
+
id: number;
|
|
2803
|
+
sections?: Array<JournalSubSection6>;
|
|
2804
|
+
spell?: KeyBase & {
|
|
2805
|
+
id: number;
|
|
2806
|
+
name?: string;
|
|
2807
|
+
};
|
|
2808
|
+
title?: string;
|
|
2809
|
+
}
|
|
2810
|
+
interface JournalSubSection6 {
|
|
2811
|
+
body_text?: null | string;
|
|
2812
|
+
creature_display?: CreatureDisplay$1;
|
|
2813
|
+
id: number;
|
|
2814
|
+
spell?: KeyBase & {
|
|
2815
|
+
id: number;
|
|
2816
|
+
name?: string;
|
|
2817
|
+
};
|
|
2818
|
+
title?: string;
|
|
2780
2819
|
}
|
|
2781
2820
|
interface Media$9 extends KeyBase {
|
|
2782
2821
|
id: number;
|
|
@@ -2786,13 +2825,13 @@ interface Mode {
|
|
|
2786
2825
|
type: ModeType;
|
|
2787
2826
|
}
|
|
2788
2827
|
interface ModeElement {
|
|
2828
|
+
is_timewalking?: boolean;
|
|
2789
2829
|
is_tracked: boolean;
|
|
2790
2830
|
mode: Mode;
|
|
2791
2831
|
players: number;
|
|
2792
2832
|
}
|
|
2793
2833
|
type ModeName = '10 Player' | '10 Player (Heroic)' | '25 Player' | '25 Player (Heroic)' | 'Heroic' | 'Mythic' | 'Mythic+ Dungeons' | 'Normal' | 'Raid Finder';
|
|
2794
2834
|
type ModeType = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
|
|
2795
|
-
|
|
2796
2835
|
//#endregion
|
|
2797
2836
|
//#region src/journal/journal.d.ts
|
|
2798
2837
|
/**
|
|
@@ -2809,9 +2848,9 @@ declare function journalEncounterIndex(): Resource<JournalEncounterIndexResponse
|
|
|
2809
2848
|
/**
|
|
2810
2849
|
* Search for journal encounters.
|
|
2811
2850
|
* @param options The search parameters. See {@link JournalEncounterSearchParameters}.
|
|
2812
|
-
* @returns The search results. See {@link
|
|
2851
|
+
* @returns The search results. See {@link JournalEncounterSearchResponse}.
|
|
2813
2852
|
*/
|
|
2814
|
-
declare function journalEncounterSearch(options: JournalEncounterSearchParameters): Resource<
|
|
2853
|
+
declare function journalEncounterSearch(options: JournalEncounterSearchParameters): Resource<JournalEncounterSearchResponse, Omit<JournalEncounterSearchParameters, 'instanceName' | 'locale'>>;
|
|
2815
2854
|
/**
|
|
2816
2855
|
* Get a journal expansion by ID.
|
|
2817
2856
|
* @param journalExpansionId The journal expansion ID.
|
|
@@ -2840,7 +2879,6 @@ declare function journalInstanceIndex(): Resource<JournalInstanceIndexResponse>;
|
|
|
2840
2879
|
* @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
|
|
2841
2880
|
*/
|
|
2842
2881
|
declare function journalInstanceMedia(journalInstanceId: number): Resource<JournalInstanceMediaResponse>;
|
|
2843
|
-
|
|
2844
2882
|
//#endregion
|
|
2845
2883
|
//#region src/media-search/types.d.ts
|
|
2846
2884
|
/**
|
|
@@ -2856,27 +2894,23 @@ interface MediaSearchParameters extends BaseSearchParameters {
|
|
|
2856
2894
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2857
2895
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2858
2896
|
*/
|
|
2897
|
+
interface MediaSearchResponse extends SearchResponseWithoutResults {
|
|
2898
|
+
results: Array<MediaSearchResponseItem>;
|
|
2899
|
+
}
|
|
2859
2900
|
interface MediaSearchResponseItem extends KeyBase {
|
|
2860
2901
|
data: {
|
|
2861
2902
|
assets: Array<MediaAsset>;
|
|
2862
|
-
id
|
|
2903
|
+
id?: number;
|
|
2863
2904
|
};
|
|
2864
2905
|
}
|
|
2865
|
-
interface MediaAsset {
|
|
2866
|
-
file_data_id: number;
|
|
2867
|
-
key: string;
|
|
2868
|
-
value: string;
|
|
2869
|
-
}
|
|
2870
|
-
|
|
2871
2906
|
//#endregion
|
|
2872
2907
|
//#region src/media-search/media-search.d.ts
|
|
2873
2908
|
/**
|
|
2874
2909
|
* Search for media.
|
|
2875
2910
|
* @param options The search parameters. See {@link MediaSearchParameters}.
|
|
2876
|
-
* @returns The search results. See {@link
|
|
2911
|
+
* @returns The search results. See {@link MediaSearchResponse}.
|
|
2877
2912
|
*/
|
|
2878
|
-
declare function mediaSearch(options: MediaSearchParameters): Resource<
|
|
2879
|
-
|
|
2913
|
+
declare function mediaSearch(options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
|
|
2880
2914
|
//#endregion
|
|
2881
2915
|
//#region src/modified-crafting/types.d.ts
|
|
2882
2916
|
/**
|
|
@@ -2884,24 +2918,26 @@ declare function mediaSearch(options: MediaSearchParameters): Resource<SearchRes
|
|
|
2884
2918
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2885
2919
|
*/
|
|
2886
2920
|
interface ModifiedCraftingCategoryIndexResponse extends ResponseBase {
|
|
2887
|
-
categories: Array<
|
|
2921
|
+
categories: Array<KeyBase & {
|
|
2922
|
+
id: number;
|
|
2923
|
+
name?: string;
|
|
2924
|
+
}>;
|
|
2888
2925
|
}
|
|
2889
2926
|
/**
|
|
2890
2927
|
* The response for a modified crafting category.
|
|
2891
2928
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2892
2929
|
*/
|
|
2893
|
-
interface ModifiedCraftingCategoryResponse extends
|
|
2930
|
+
interface ModifiedCraftingCategoryResponse extends ResponseBase {
|
|
2931
|
+
id: number;
|
|
2932
|
+
name?: string;
|
|
2933
|
+
}
|
|
2894
2934
|
/**
|
|
2895
2935
|
* The response for a modified crafting index.
|
|
2896
2936
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2897
2937
|
*/
|
|
2898
2938
|
interface ModifiedCraftingIndexResponse extends ResponseBase {
|
|
2899
|
-
categories:
|
|
2900
|
-
|
|
2901
|
-
};
|
|
2902
|
-
slot_types: {
|
|
2903
|
-
href: string;
|
|
2904
|
-
};
|
|
2939
|
+
categories: Href;
|
|
2940
|
+
slot_types: Href;
|
|
2905
2941
|
}
|
|
2906
2942
|
/**
|
|
2907
2943
|
* The response for a modified crafting reagent slot type index.
|
|
@@ -2923,7 +2959,6 @@ interface SlotType extends KeyBase {
|
|
|
2923
2959
|
id: number;
|
|
2924
2960
|
name?: string;
|
|
2925
2961
|
}
|
|
2926
|
-
|
|
2927
2962
|
//#endregion
|
|
2928
2963
|
//#region src/modified-crafting/modified-crafting.d.ts
|
|
2929
2964
|
/**
|
|
@@ -2953,7 +2988,6 @@ declare function modifiedCraftingReagentSlotType(modifiedCraftingReagentSlotType
|
|
|
2953
2988
|
* @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
|
|
2954
2989
|
*/
|
|
2955
2990
|
declare function modifiedCraftingReagentSlotTypeIndex(): Resource<ModifiedCraftingReagentSlotTypeIndexResponse>;
|
|
2956
|
-
|
|
2957
2991
|
//#endregion
|
|
2958
2992
|
//#region src/mount/types.d.ts
|
|
2959
2993
|
/**
|
|
@@ -2969,11 +3003,17 @@ interface MountIndexResponse extends ResponseBase {
|
|
|
2969
3003
|
*/
|
|
2970
3004
|
interface MountResponse extends ResponseBase {
|
|
2971
3005
|
creature_displays: Array<CreatureDisplay>;
|
|
2972
|
-
description: string;
|
|
3006
|
+
description: null | string;
|
|
3007
|
+
faction?: Faction;
|
|
2973
3008
|
id: number;
|
|
2974
3009
|
name: string;
|
|
2975
|
-
|
|
2976
|
-
|
|
3010
|
+
requirements?: {
|
|
3011
|
+
classes?: Array<NameIdKey>;
|
|
3012
|
+
faction?: Faction;
|
|
3013
|
+
races?: Array<NameIdKey>;
|
|
3014
|
+
};
|
|
3015
|
+
should_exclude_if_uncollected?: boolean;
|
|
3016
|
+
source?: Source$2;
|
|
2977
3017
|
}
|
|
2978
3018
|
/**
|
|
2979
3019
|
* The search parameters for mounts.
|
|
@@ -2989,6 +3029,12 @@ interface MountSearchParameters extends BaseSearchParameters {
|
|
|
2989
3029
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2990
3030
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2991
3031
|
*/
|
|
3032
|
+
interface MountSearchResponse extends SearchResponseWithoutResults {
|
|
3033
|
+
results: Array<MountSearchResponseItem>;
|
|
3034
|
+
}
|
|
3035
|
+
interface CreatureDisplay extends KeyBase {
|
|
3036
|
+
id: number;
|
|
3037
|
+
}
|
|
2992
3038
|
interface MountSearchResponseItem extends KeyBase {
|
|
2993
3039
|
data: {
|
|
2994
3040
|
creature_displays: Array<{
|
|
@@ -2996,7 +3042,7 @@ interface MountSearchResponseItem extends KeyBase {
|
|
|
2996
3042
|
}>;
|
|
2997
3043
|
faction?: {
|
|
2998
3044
|
name: Record<Locales, string>;
|
|
2999
|
-
type:
|
|
3045
|
+
type: Factions;
|
|
3000
3046
|
};
|
|
3001
3047
|
id: number;
|
|
3002
3048
|
name: Record<Locales, string>;
|
|
@@ -3006,14 +3052,10 @@ interface MountSearchResponseItem extends KeyBase {
|
|
|
3006
3052
|
};
|
|
3007
3053
|
};
|
|
3008
3054
|
}
|
|
3009
|
-
interface CreatureDisplay extends KeyBase {
|
|
3010
|
-
id: number;
|
|
3011
|
-
}
|
|
3012
3055
|
interface Source$2 {
|
|
3013
3056
|
name: string;
|
|
3014
3057
|
type: string;
|
|
3015
3058
|
}
|
|
3016
|
-
|
|
3017
3059
|
//#endregion
|
|
3018
3060
|
//#region src/mount/mount.d.ts
|
|
3019
3061
|
/**
|
|
@@ -3030,10 +3072,9 @@ declare function mountIndex(): Resource<MountIndexResponse>;
|
|
|
3030
3072
|
/**
|
|
3031
3073
|
* Get a mount search.
|
|
3032
3074
|
* @param options The search parameters. See {@link MountSearchParameters}.
|
|
3033
|
-
* @returns The search results. See {@link
|
|
3075
|
+
* @returns The search results. See {@link MountSearchResponse}.
|
|
3034
3076
|
*/
|
|
3035
|
-
declare function mountSearch(options: MountSearchParameters): Resource<
|
|
3036
|
-
|
|
3077
|
+
declare function mountSearch(options: MountSearchParameters): Resource<MountSearchResponse, Omit<MountSearchParameters, 'locale' | 'name'>>;
|
|
3037
3078
|
//#endregion
|
|
3038
3079
|
//#region src/mythic-keystone-affix/types.d.ts
|
|
3039
3080
|
/**
|
|
@@ -3041,28 +3082,32 @@ declare function mountSearch(options: MountSearchParameters): Resource<SearchRes
|
|
|
3041
3082
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3042
3083
|
*/
|
|
3043
3084
|
interface MythicKeystoneAffixIndexResponse extends ResponseBase {
|
|
3044
|
-
affixes: Array<
|
|
3085
|
+
affixes: Array<KeyBase & {
|
|
3086
|
+
id: number;
|
|
3087
|
+
name: null | string;
|
|
3088
|
+
}>;
|
|
3045
3089
|
}
|
|
3046
3090
|
/**
|
|
3047
3091
|
* The response for a Mythic Keystone affix media.
|
|
3048
3092
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3049
3093
|
*/
|
|
3050
3094
|
interface MythicKeystoneAffixMediaResponse extends ResponseBase {
|
|
3051
|
-
assets
|
|
3095
|
+
assets?: Array<MediaAsset>;
|
|
3052
3096
|
id: number;
|
|
3053
3097
|
}
|
|
3054
3098
|
/**
|
|
3055
3099
|
* The response for a Mythic Keystone affix.
|
|
3056
3100
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3057
3101
|
*/
|
|
3058
|
-
interface MythicKeystoneAffixResponse extends
|
|
3059
|
-
description: string;
|
|
3102
|
+
interface MythicKeystoneAffixResponse extends ResponseBase {
|
|
3103
|
+
description: null | string;
|
|
3104
|
+
id: number;
|
|
3060
3105
|
media: Media$8;
|
|
3106
|
+
name: null | string;
|
|
3061
3107
|
}
|
|
3062
3108
|
interface Media$8 extends KeyBase {
|
|
3063
3109
|
id: number;
|
|
3064
3110
|
}
|
|
3065
|
-
|
|
3066
3111
|
//#endregion
|
|
3067
3112
|
//#region src/mythic-keystone-affix/mythic-keystone-affix.d.ts
|
|
3068
3113
|
/**
|
|
@@ -3082,7 +3127,6 @@ declare function mythicKeystoneAffixIndex(): Resource<MythicKeystoneAffixIndexRe
|
|
|
3082
3127
|
* @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
|
|
3083
3128
|
*/
|
|
3084
3129
|
declare function mythicKeystoneAffixMedia(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixMediaResponse>;
|
|
3085
|
-
|
|
3086
3130
|
//#endregion
|
|
3087
3131
|
//#region src/mythic-keystone-dungeon/types.d.ts
|
|
3088
3132
|
/**
|
|
@@ -3108,12 +3152,8 @@ interface MythicKeystoneDungeonResponse extends NameId, ResponseBase {
|
|
|
3108
3152
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3109
3153
|
*/
|
|
3110
3154
|
interface MythicKeystoneIndexResponse extends ResponseBase {
|
|
3111
|
-
dungeons:
|
|
3112
|
-
|
|
3113
|
-
};
|
|
3114
|
-
seasons: {
|
|
3115
|
-
href: string;
|
|
3116
|
-
};
|
|
3155
|
+
dungeons: Href;
|
|
3156
|
+
seasons: Href;
|
|
3117
3157
|
}
|
|
3118
3158
|
/**
|
|
3119
3159
|
* The response for a Mythic Keystone period index.
|
|
@@ -3161,7 +3201,6 @@ interface Period extends KeyBase {
|
|
|
3161
3201
|
interface Zone {
|
|
3162
3202
|
slug: string;
|
|
3163
3203
|
}
|
|
3164
|
-
|
|
3165
3204
|
//#endregion
|
|
3166
3205
|
//#region src/mythic-keystone-dungeon/mythic-keystone-dungeon.d.ts
|
|
3167
3206
|
/**
|
|
@@ -3202,7 +3241,6 @@ declare function mythicKeystoneSeason(mythicKeystoneSeasonId: number): Resource<
|
|
|
3202
3241
|
* @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
|
|
3203
3242
|
*/
|
|
3204
3243
|
declare function mythicKeystoneSeasonIndex(): Resource<MythicKeystoneSeasonIndexResponse>;
|
|
3205
|
-
|
|
3206
3244
|
//#endregion
|
|
3207
3245
|
//#region src/mythic-keystone-leaderboard/types.d.ts
|
|
3208
3246
|
/**
|
|
@@ -3217,9 +3255,7 @@ interface MythicKeystoneLeaderboardIndexResponse extends ResponseBase {
|
|
|
3217
3255
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3218
3256
|
*/
|
|
3219
3257
|
interface MythicKeystoneLeaderboardResponse extends ResponseBase {
|
|
3220
|
-
connected_realm:
|
|
3221
|
-
href: string;
|
|
3222
|
-
};
|
|
3258
|
+
connected_realm: Href;
|
|
3223
3259
|
keystone_affixes: Array<KeystoneAffixElement>;
|
|
3224
3260
|
leading_groups: Array<LeadingGroup>;
|
|
3225
3261
|
map: NameId;
|
|
@@ -3238,31 +3274,25 @@ interface LeadingGroup {
|
|
|
3238
3274
|
duration: number;
|
|
3239
3275
|
keystone_level: number;
|
|
3240
3276
|
members: Array<Member>;
|
|
3241
|
-
mythic_rating: MythicRating;
|
|
3242
3277
|
ranking: number;
|
|
3243
3278
|
}
|
|
3244
3279
|
interface Member {
|
|
3245
3280
|
faction: {
|
|
3246
|
-
type:
|
|
3281
|
+
type: Factions;
|
|
3247
3282
|
};
|
|
3248
3283
|
profile: Profile;
|
|
3249
3284
|
specialization: Specialization;
|
|
3250
3285
|
}
|
|
3251
|
-
interface MythicRating {
|
|
3252
|
-
color: Color;
|
|
3253
|
-
rating: number;
|
|
3254
|
-
}
|
|
3255
3286
|
interface Profile extends NameId {
|
|
3256
|
-
realm: Realm$
|
|
3287
|
+
realm: Realm$3;
|
|
3257
3288
|
}
|
|
3258
|
-
interface Realm$
|
|
3289
|
+
interface Realm$3 extends KeyBase {
|
|
3259
3290
|
id: number;
|
|
3260
3291
|
slug: string;
|
|
3261
3292
|
}
|
|
3262
3293
|
interface Specialization extends KeyBase {
|
|
3263
3294
|
id: number;
|
|
3264
3295
|
}
|
|
3265
|
-
|
|
3266
3296
|
//#endregion
|
|
3267
3297
|
//#region src/mythic-keystone-leaderboard/mythic-keystone-leaderboard.d.ts
|
|
3268
3298
|
/**
|
|
@@ -3279,7 +3309,6 @@ declare function mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId:
|
|
|
3279
3309
|
* @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
|
|
3280
3310
|
*/
|
|
3281
3311
|
declare function mythicKeystoneLeaderboardIndex(connectedRealmId: number): Resource<MythicKeystoneLeaderboardIndexResponse>;
|
|
3282
|
-
|
|
3283
3312
|
//#endregion
|
|
3284
3313
|
//#region src/mythic-raid-leaderboard/types.d.ts
|
|
3285
3314
|
/**
|
|
@@ -3294,26 +3323,25 @@ interface MythicRaidLeaderboardResponse extends ResponseBase {
|
|
|
3294
3323
|
}
|
|
3295
3324
|
interface Entry$1 {
|
|
3296
3325
|
faction: {
|
|
3297
|
-
type:
|
|
3326
|
+
type: Factions;
|
|
3298
3327
|
};
|
|
3299
3328
|
guild: Guild;
|
|
3300
3329
|
rank: number;
|
|
3301
|
-
region:
|
|
3330
|
+
region: Origins;
|
|
3302
3331
|
timestamp: number;
|
|
3303
3332
|
}
|
|
3304
3333
|
interface Guild extends NameId {
|
|
3305
|
-
realm: Realm$
|
|
3334
|
+
realm: Realm$2;
|
|
3306
3335
|
}
|
|
3307
3336
|
interface JournalInstance extends KeyBase {
|
|
3308
3337
|
id: number;
|
|
3309
3338
|
name: null;
|
|
3310
3339
|
}
|
|
3311
|
-
interface Realm$
|
|
3340
|
+
interface Realm$2 {
|
|
3312
3341
|
id: number;
|
|
3313
3342
|
name: null;
|
|
3314
3343
|
slug: string;
|
|
3315
3344
|
}
|
|
3316
|
-
|
|
3317
3345
|
//#endregion
|
|
3318
3346
|
//#region src/mythic-raid-leaderboard/mythic-raid-leaderboard.d.ts
|
|
3319
3347
|
/**
|
|
@@ -3322,8 +3350,7 @@ interface Realm$1 {
|
|
|
3322
3350
|
* @param faction The faction. Either 'alliance' or 'horde'.
|
|
3323
3351
|
* @returns The Mythic Raid leaderboard. See {@link MythicRaidLeaderboardResponse}.
|
|
3324
3352
|
*/
|
|
3325
|
-
declare function mythicRaidLeaderboard(raid: string, faction: Lowercase<
|
|
3326
|
-
|
|
3353
|
+
declare function mythicRaidLeaderboard(raid: string, faction: Lowercase<Factions>): Resource<MythicRaidLeaderboardResponse>;
|
|
3327
3354
|
//#endregion
|
|
3328
3355
|
//#region src/pet/types.d.ts
|
|
3329
3356
|
/**
|
|
@@ -3338,7 +3365,7 @@ interface PetAbilityIndexResponse extends ResponseBase {
|
|
|
3338
3365
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3339
3366
|
*/
|
|
3340
3367
|
interface PetAbilityMediaResponse extends ResponseBase {
|
|
3341
|
-
assets: Array<MediaAsset
|
|
3368
|
+
assets: Array<MediaAsset>;
|
|
3342
3369
|
id: number;
|
|
3343
3370
|
}
|
|
3344
3371
|
/**
|
|
@@ -3347,6 +3374,7 @@ interface PetAbilityMediaResponse extends ResponseBase {
|
|
|
3347
3374
|
*/
|
|
3348
3375
|
interface PetAbilityResponse extends NameId, ResponseBase {
|
|
3349
3376
|
battle_pet_type: BattlePetType;
|
|
3377
|
+
cooldown?: number;
|
|
3350
3378
|
media: Media$7;
|
|
3351
3379
|
rounds: number;
|
|
3352
3380
|
}
|
|
@@ -3362,7 +3390,7 @@ interface PetIndexResponse extends ResponseBase {
|
|
|
3362
3390
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3363
3391
|
*/
|
|
3364
3392
|
interface PetMediaResponse extends ResponseBase {
|
|
3365
|
-
assets: Array<MediaAsset
|
|
3393
|
+
assets: Array<MediaAsset>;
|
|
3366
3394
|
id: number;
|
|
3367
3395
|
}
|
|
3368
3396
|
/**
|
|
@@ -3370,10 +3398,10 @@ interface PetMediaResponse extends ResponseBase {
|
|
|
3370
3398
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3371
3399
|
*/
|
|
3372
3400
|
interface PetResponse extends NameId, ResponseBase {
|
|
3373
|
-
abilities
|
|
3401
|
+
abilities?: Array<Ability>;
|
|
3374
3402
|
battle_pet_type: BattlePetType;
|
|
3375
3403
|
creature: NameIdKey;
|
|
3376
|
-
description: string;
|
|
3404
|
+
description: null | string;
|
|
3377
3405
|
icon: string;
|
|
3378
3406
|
is_alliance_only: boolean;
|
|
3379
3407
|
is_battlepet: boolean;
|
|
@@ -3382,8 +3410,8 @@ interface PetResponse extends NameId, ResponseBase {
|
|
|
3382
3410
|
is_random_creature_display: boolean;
|
|
3383
3411
|
is_tradable: boolean;
|
|
3384
3412
|
media: Media$7;
|
|
3385
|
-
should_exclude_if_uncollected
|
|
3386
|
-
source
|
|
3413
|
+
should_exclude_if_uncollected?: boolean;
|
|
3414
|
+
source?: Source$1;
|
|
3387
3415
|
}
|
|
3388
3416
|
interface Ability {
|
|
3389
3417
|
ability: NameIdKey;
|
|
@@ -3400,7 +3428,6 @@ interface Source$1 {
|
|
|
3400
3428
|
name: string;
|
|
3401
3429
|
type: string;
|
|
3402
3430
|
}
|
|
3403
|
-
|
|
3404
3431
|
//#endregion
|
|
3405
3432
|
//#region src/pet/pet.d.ts
|
|
3406
3433
|
/**
|
|
@@ -3437,7 +3464,6 @@ declare function petIndex(): Resource<PetIndexResponse>;
|
|
|
3437
3464
|
* @returns The pet media. See {@link PetMediaResponse}.
|
|
3438
3465
|
*/
|
|
3439
3466
|
declare function petMedia(petId: number): Resource<PetMediaResponse>;
|
|
3440
|
-
|
|
3441
3467
|
//#endregion
|
|
3442
3468
|
//#region src/playable-class/types.d.ts
|
|
3443
3469
|
/**
|
|
@@ -3452,7 +3478,7 @@ interface PlayableClassIndexResponse extends ResponseBase {
|
|
|
3452
3478
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3453
3479
|
*/
|
|
3454
3480
|
interface PlayableClassMediaResponse extends ResponseBase {
|
|
3455
|
-
assets: Array<MediaAsset
|
|
3481
|
+
assets: Array<MediaAsset>;
|
|
3456
3482
|
id: number;
|
|
3457
3483
|
}
|
|
3458
3484
|
/**
|
|
@@ -3464,9 +3490,7 @@ interface PlayableClassResponse extends NameId, ResponseBase {
|
|
|
3464
3490
|
media: Media$6;
|
|
3465
3491
|
playable_races: Array<NameIdKey>;
|
|
3466
3492
|
power_type: NameIdKey;
|
|
3467
|
-
pvp_talent_slots:
|
|
3468
|
-
href: string;
|
|
3469
|
-
};
|
|
3493
|
+
pvp_talent_slots: Href;
|
|
3470
3494
|
specializations: Array<NameIdKey>;
|
|
3471
3495
|
}
|
|
3472
3496
|
/**
|
|
@@ -3483,7 +3507,6 @@ interface TalentSlot {
|
|
|
3483
3507
|
slot_number: number;
|
|
3484
3508
|
unlock_player_level: number;
|
|
3485
3509
|
}
|
|
3486
|
-
|
|
3487
3510
|
//#endregion
|
|
3488
3511
|
//#region src/playable-class/playable-class.d.ts
|
|
3489
3512
|
/**
|
|
@@ -3509,7 +3532,6 @@ declare function playableClassMedia(playableClassId: number): Resource<PlayableC
|
|
|
3509
3532
|
* @returns The playable class's PvP talent slots. See {@link PvpTalentSlotsResponse}.
|
|
3510
3533
|
*/
|
|
3511
3534
|
declare function pvpTalentSlots(playableClassId: number): Resource<PvpTalentSlotsResponse>;
|
|
3512
|
-
|
|
3513
3535
|
//#endregion
|
|
3514
3536
|
//#region src/playable-race/types.d.ts
|
|
3515
3537
|
/**
|
|
@@ -3529,8 +3551,8 @@ interface PlayableRaceResponse extends NameId, ResponseBase {
|
|
|
3529
3551
|
is_allied_race: boolean;
|
|
3530
3552
|
is_selectable: boolean;
|
|
3531
3553
|
playable_classes: Array<NameIdKey>;
|
|
3554
|
+
racial_spells: Array<NameIdKey>;
|
|
3532
3555
|
}
|
|
3533
|
-
|
|
3534
3556
|
//#endregion
|
|
3535
3557
|
//#region src/playable-race/playable-race.d.ts
|
|
3536
3558
|
/**
|
|
@@ -3544,7 +3566,6 @@ declare function playableRace(playableRaceId: number): Resource<PlayableRaceResp
|
|
|
3544
3566
|
* @returns The playable race index. See {@link PlayableRaceIndexResponse}.
|
|
3545
3567
|
*/
|
|
3546
3568
|
declare function playableRaceIndex(): Resource<PlayableRaceIndexResponse>;
|
|
3547
|
-
|
|
3548
3569
|
//#endregion
|
|
3549
3570
|
//#region src/playable-specialization/types.d.ts
|
|
3550
3571
|
/**
|
|
@@ -3560,7 +3581,7 @@ interface PlayableSpecializationIndexResponse extends ResponseBase {
|
|
|
3560
3581
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3561
3582
|
*/
|
|
3562
3583
|
interface PlayableSpecializationMediaResponse extends ResponseBase {
|
|
3563
|
-
assets: Array<MediaAsset
|
|
3584
|
+
assets: Array<MediaAsset>;
|
|
3564
3585
|
id: number;
|
|
3565
3586
|
}
|
|
3566
3587
|
/**
|
|
@@ -3569,6 +3590,7 @@ interface PlayableSpecializationMediaResponse extends ResponseBase {
|
|
|
3569
3590
|
*/
|
|
3570
3591
|
interface PlayableSpecializationResponse extends NameId, ResponseBase {
|
|
3571
3592
|
gender_description: GenderName;
|
|
3593
|
+
hero_talent_trees: Array<NameIdKey>;
|
|
3572
3594
|
media: Media$5;
|
|
3573
3595
|
playable_class: NameIdKey;
|
|
3574
3596
|
power_type: NameIdKey;
|
|
@@ -3585,20 +3607,19 @@ interface PrimaryStatType {
|
|
|
3585
3607
|
type: string;
|
|
3586
3608
|
}
|
|
3587
3609
|
interface PvpTalent {
|
|
3588
|
-
spell_tooltip: SpellTooltip;
|
|
3610
|
+
spell_tooltip: SpellTooltip$1;
|
|
3589
3611
|
talent: NameIdKey;
|
|
3590
3612
|
}
|
|
3591
3613
|
interface SpecTalentTree$1 extends KeyBase {
|
|
3592
3614
|
name: string;
|
|
3593
3615
|
}
|
|
3594
|
-
interface SpellTooltip {
|
|
3616
|
+
interface SpellTooltip$1 {
|
|
3595
3617
|
cast_time: string;
|
|
3596
3618
|
cooldown?: string;
|
|
3597
3619
|
description: string;
|
|
3598
|
-
power_cost?: string;
|
|
3620
|
+
power_cost?: null | string;
|
|
3599
3621
|
range?: string;
|
|
3600
3622
|
}
|
|
3601
|
-
|
|
3602
3623
|
//#endregion
|
|
3603
3624
|
//#region src/playable-specialization/playable-specialization.d.ts
|
|
3604
3625
|
/**
|
|
@@ -3618,7 +3639,6 @@ declare function playableSpecializationIndex(): Resource<PlayableSpecializationI
|
|
|
3618
3639
|
* @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
|
|
3619
3640
|
*/
|
|
3620
3641
|
declare function playableSpecializationMedia(specializationId: number): Resource<PlayableSpecializationMediaResponse>;
|
|
3621
|
-
|
|
3622
3642
|
//#endregion
|
|
3623
3643
|
//#region src/power-type/types.d.ts
|
|
3624
3644
|
/**
|
|
@@ -3633,7 +3653,6 @@ interface PowerTypeIndexResponse extends ResponseBase {
|
|
|
3633
3653
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3634
3654
|
*/
|
|
3635
3655
|
interface PowerTypeResponse extends NameId, ResponseBase {}
|
|
3636
|
-
|
|
3637
3656
|
//#endregion
|
|
3638
3657
|
//#region src/power-type/power-type.d.ts
|
|
3639
3658
|
/**
|
|
@@ -3647,7 +3666,6 @@ declare function powerType(powerTypeId: number): Resource<PowerTypeResponse>;
|
|
|
3647
3666
|
* @returns The power type index. See {@link PowerTypeIndexResponse}.
|
|
3648
3667
|
*/
|
|
3649
3668
|
declare function powerTypeIndex(): Resource<PowerTypeIndexResponse>;
|
|
3650
|
-
|
|
3651
3669
|
//#endregion
|
|
3652
3670
|
//#region src/profession/types.d.ts
|
|
3653
3671
|
/**
|
|
@@ -3662,7 +3680,7 @@ interface ProfessionIndexResponse extends ResponseBase {
|
|
|
3662
3680
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3663
3681
|
*/
|
|
3664
3682
|
interface ProfessionMediaResponse extends ResponseBase {
|
|
3665
|
-
assets: Array<MediaAsset
|
|
3683
|
+
assets: Array<MediaAsset>;
|
|
3666
3684
|
id: number;
|
|
3667
3685
|
}
|
|
3668
3686
|
/**
|
|
@@ -3689,7 +3707,7 @@ interface ProfessionSkillTierResponse extends NameId, ResponseBase {
|
|
|
3689
3707
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3690
3708
|
*/
|
|
3691
3709
|
interface RecipeMediaResponse extends ResponseBase {
|
|
3692
|
-
assets: Array<MediaAsset
|
|
3710
|
+
assets: Array<MediaAsset>;
|
|
3693
3711
|
id: number;
|
|
3694
3712
|
}
|
|
3695
3713
|
/**
|
|
@@ -3697,21 +3715,33 @@ interface RecipeMediaResponse extends ResponseBase {
|
|
|
3697
3715
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3698
3716
|
*/
|
|
3699
3717
|
interface RecipeResponse extends NameId, ResponseBase {
|
|
3700
|
-
crafted_item
|
|
3701
|
-
crafted_quantity
|
|
3718
|
+
crafted_item?: NameIdKey;
|
|
3719
|
+
crafted_quantity?: CraftedQuantity;
|
|
3720
|
+
description?: string;
|
|
3702
3721
|
media: Media$4;
|
|
3703
|
-
|
|
3722
|
+
modified_crafting_slots?: Array<ModifiedCraftSlot>;
|
|
3723
|
+
rank?: number;
|
|
3724
|
+
reagents?: Array<Reagent>;
|
|
3704
3725
|
}
|
|
3705
3726
|
interface Category {
|
|
3706
3727
|
name: string;
|
|
3707
3728
|
recipes: Array<NameIdKey>;
|
|
3708
3729
|
}
|
|
3709
3730
|
interface CraftedQuantity {
|
|
3710
|
-
|
|
3731
|
+
maximum?: number;
|
|
3732
|
+
minimum?: number;
|
|
3733
|
+
value?: number;
|
|
3711
3734
|
}
|
|
3712
3735
|
interface Media$4 extends KeyBase {
|
|
3713
3736
|
id: number;
|
|
3714
3737
|
}
|
|
3738
|
+
interface ModifiedCraftSlot {
|
|
3739
|
+
display_order: number;
|
|
3740
|
+
slot_type: KeyBase & {
|
|
3741
|
+
id: number;
|
|
3742
|
+
name?: string;
|
|
3743
|
+
};
|
|
3744
|
+
}
|
|
3715
3745
|
interface Reagent {
|
|
3716
3746
|
quantity: number;
|
|
3717
3747
|
reagent: NameIdKey;
|
|
@@ -3720,7 +3750,6 @@ interface Type {
|
|
|
3720
3750
|
name: string;
|
|
3721
3751
|
type: string;
|
|
3722
3752
|
}
|
|
3723
|
-
|
|
3724
3753
|
//#endregion
|
|
3725
3754
|
//#region src/profession/profession.d.ts
|
|
3726
3755
|
/**
|
|
@@ -3759,7 +3788,6 @@ declare function recipe(recipeId: number): Resource<RecipeResponse>;
|
|
|
3759
3788
|
* @returns The recipe media. See {@link RecipeMediaResponse}.
|
|
3760
3789
|
*/
|
|
3761
3790
|
declare function recipeMedia(recipeId: number): Resource<RecipeMediaResponse>;
|
|
3762
|
-
|
|
3763
3791
|
//#endregion
|
|
3764
3792
|
//#region src/pvp-season/types.d.ts
|
|
3765
3793
|
/**
|
|
@@ -3767,7 +3795,10 @@ declare function recipeMedia(recipeId: number): Resource<RecipeMediaResponse>;
|
|
|
3767
3795
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3768
3796
|
*/
|
|
3769
3797
|
interface PvpLeaderboardIndexResponse extends ResponseBase {
|
|
3770
|
-
leaderboards: Array<
|
|
3798
|
+
leaderboards: Array<KeyBase & {
|
|
3799
|
+
id?: number;
|
|
3800
|
+
name: string;
|
|
3801
|
+
}>;
|
|
3771
3802
|
season: Season;
|
|
3772
3803
|
}
|
|
3773
3804
|
/**
|
|
@@ -3802,33 +3833,30 @@ interface PvpSeasonIndexResponse extends ResponseBase {
|
|
|
3802
3833
|
*/
|
|
3803
3834
|
interface PvpSeasonResponse extends ResponseBase {
|
|
3804
3835
|
id: number;
|
|
3805
|
-
leaderboards:
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
href: string;
|
|
3810
|
-
};
|
|
3811
|
-
season_name?: string;
|
|
3836
|
+
leaderboards: Href;
|
|
3837
|
+
rewards: Href;
|
|
3838
|
+
season_end_timestamp?: number;
|
|
3839
|
+
season_name?: null | string;
|
|
3812
3840
|
season_start_timestamp: number;
|
|
3813
3841
|
}
|
|
3814
3842
|
interface Bracket$1 {
|
|
3815
3843
|
id: number;
|
|
3816
|
-
type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'SHUFFLE';
|
|
3844
|
+
type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'BLITZ' | 'SHUFFLE';
|
|
3817
3845
|
}
|
|
3818
|
-
interface Character extends NameId {
|
|
3819
|
-
realm: Realm;
|
|
3846
|
+
interface Character$1 extends NameId {
|
|
3847
|
+
realm: Realm$1;
|
|
3820
3848
|
}
|
|
3821
3849
|
interface Entry {
|
|
3822
|
-
character: Character;
|
|
3850
|
+
character: Character$1;
|
|
3823
3851
|
faction: {
|
|
3824
|
-
type:
|
|
3852
|
+
type: Factions;
|
|
3825
3853
|
};
|
|
3826
3854
|
rank: number;
|
|
3827
3855
|
rating: number;
|
|
3828
3856
|
season_match_statistics: SeasonMatchStatistics;
|
|
3829
3857
|
tier: Season;
|
|
3830
3858
|
}
|
|
3831
|
-
interface Realm extends KeyBase {
|
|
3859
|
+
interface Realm$1 extends KeyBase {
|
|
3832
3860
|
id: number;
|
|
3833
3861
|
slug: string;
|
|
3834
3862
|
}
|
|
@@ -3847,7 +3875,6 @@ interface SeasonMatchStatistics {
|
|
|
3847
3875
|
played: number;
|
|
3848
3876
|
won: number;
|
|
3849
3877
|
}
|
|
3850
|
-
|
|
3851
3878
|
//#endregion
|
|
3852
3879
|
//#region src/pvp-season/pvp-season.d.ts
|
|
3853
3880
|
/**
|
|
@@ -3880,7 +3907,6 @@ declare function pvpSeason(pvpSeasonId: number): Resource<PvpSeasonResponse>;
|
|
|
3880
3907
|
* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
|
|
3881
3908
|
*/
|
|
3882
3909
|
declare function pvpSeasonIndex(): Resource<PvpSeasonIndexResponse>;
|
|
3883
|
-
|
|
3884
3910
|
//#endregion
|
|
3885
3911
|
//#region src/pvp-tier/types.d.ts
|
|
3886
3912
|
/**
|
|
@@ -3895,7 +3921,7 @@ interface PvpTierIndexResponse extends ResponseBase {
|
|
|
3895
3921
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3896
3922
|
*/
|
|
3897
3923
|
interface PvpTierMediaResponse extends ResponseBase {
|
|
3898
|
-
assets: Array<MediaAsset
|
|
3924
|
+
assets: Array<MediaAsset>;
|
|
3899
3925
|
id: number;
|
|
3900
3926
|
}
|
|
3901
3927
|
/**
|
|
@@ -3916,7 +3942,6 @@ interface Bracket {
|
|
|
3916
3942
|
interface Media$3 extends KeyBase {
|
|
3917
3943
|
id: number;
|
|
3918
3944
|
}
|
|
3919
|
-
|
|
3920
3945
|
//#endregion
|
|
3921
3946
|
//#region src/pvp-tier/pvp-tier.d.ts
|
|
3922
3947
|
/**
|
|
@@ -3936,7 +3961,6 @@ declare function pvpTierIndex(): Resource<PvpTierIndexResponse>;
|
|
|
3936
3961
|
* @returns The PvP tier media. See {@link PvpTierMediaResponse}.
|
|
3937
3962
|
*/
|
|
3938
3963
|
declare function pvpTierMedia(pvpTierId: number): Resource<PvpTierMediaResponse>;
|
|
3939
|
-
|
|
3940
3964
|
//#endregion
|
|
3941
3965
|
//#region src/quest/types.d.ts
|
|
3942
3966
|
/**
|
|
@@ -3976,22 +4000,17 @@ interface QuestCategoryResponse extends ResponseBase {
|
|
|
3976
4000
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3977
4001
|
*/
|
|
3978
4002
|
interface QuestIndexResponse extends ResponseBase {
|
|
3979
|
-
areas:
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
categories: {
|
|
3983
|
-
href: string;
|
|
3984
|
-
};
|
|
3985
|
-
types: {
|
|
3986
|
-
href: string;
|
|
3987
|
-
};
|
|
4003
|
+
areas: Href;
|
|
4004
|
+
categories: Href;
|
|
4005
|
+
types: Href;
|
|
3988
4006
|
}
|
|
3989
4007
|
/**
|
|
3990
4008
|
* The response for a quest.
|
|
3991
4009
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3992
4010
|
*/
|
|
3993
4011
|
interface QuestResponse extends ResponseBase {
|
|
3994
|
-
area
|
|
4012
|
+
area?: NameIdKey;
|
|
4013
|
+
category: NameIdKey;
|
|
3995
4014
|
description: string;
|
|
3996
4015
|
id: number;
|
|
3997
4016
|
requirements: Requirements;
|
|
@@ -4022,10 +4041,15 @@ interface Reputation {
|
|
|
4022
4041
|
reward: NameIdKey;
|
|
4023
4042
|
value: number;
|
|
4024
4043
|
}
|
|
4044
|
+
interface ReputationRequirement {
|
|
4045
|
+
faction: NameIdKey;
|
|
4046
|
+
min_reputation: number;
|
|
4047
|
+
}
|
|
4025
4048
|
interface Requirements {
|
|
4026
4049
|
faction: Faction;
|
|
4027
4050
|
max_character_level: number;
|
|
4028
4051
|
min_character_level: number;
|
|
4052
|
+
reputations: Array<ReputationRequirement>;
|
|
4029
4053
|
}
|
|
4030
4054
|
interface Rewards {
|
|
4031
4055
|
experience: number;
|
|
@@ -4037,7 +4061,6 @@ interface Units {
|
|
|
4037
4061
|
gold: number;
|
|
4038
4062
|
silver: number;
|
|
4039
4063
|
}
|
|
4040
|
-
|
|
4041
4064
|
//#endregion
|
|
4042
4065
|
//#region src/quest/quest.d.ts
|
|
4043
4066
|
/**
|
|
@@ -4084,7 +4107,6 @@ declare function questType(questTypeId: number): Resource<QuestTypeResponse>;
|
|
|
4084
4107
|
* @returns The quest type index. See {@link QuestTypeIndexResponse}.
|
|
4085
4108
|
*/
|
|
4086
4109
|
declare function questTypeIndex(): Resource<QuestTypeIndexResponse>;
|
|
4087
|
-
|
|
4088
4110
|
//#endregion
|
|
4089
4111
|
//#region src/realm/realm.d.ts
|
|
4090
4112
|
/**
|
|
@@ -4101,10 +4123,9 @@ declare function realmIndex(): Resource<RealmIndexResponse>;
|
|
|
4101
4123
|
/**
|
|
4102
4124
|
* Search for realms.
|
|
4103
4125
|
* @param options The search parameters. See {@link RealmSearchParameters}.
|
|
4104
|
-
* @returns The search results. See {@link
|
|
4126
|
+
* @returns The search results. See {@link RealmSearchResponse}.
|
|
4105
4127
|
*/
|
|
4106
|
-
declare function realmSearch(options: RealmSearchParameters): Resource<
|
|
4107
|
-
|
|
4128
|
+
declare function realmSearch(options: RealmSearchParameters): Resource<RealmSearchResponse, RealmSearchParameters>;
|
|
4108
4129
|
//#endregion
|
|
4109
4130
|
//#region src/region/types.d.ts
|
|
4110
4131
|
/**
|
|
@@ -4112,9 +4133,7 @@ declare function realmSearch(options: RealmSearchParameters): Resource<SearchRes
|
|
|
4112
4133
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4113
4134
|
*/
|
|
4114
4135
|
interface RegionIndexResponse extends ResponseBase {
|
|
4115
|
-
regions: Array<
|
|
4116
|
-
href: string;
|
|
4117
|
-
}>;
|
|
4136
|
+
regions: Array<Href>;
|
|
4118
4137
|
}
|
|
4119
4138
|
/**
|
|
4120
4139
|
* The response for a region.
|
|
@@ -4124,7 +4143,6 @@ interface RegionResponse extends NameId, ResponseBase {
|
|
|
4124
4143
|
patch_string: string;
|
|
4125
4144
|
tag: string;
|
|
4126
4145
|
}
|
|
4127
|
-
|
|
4128
4146
|
//#endregion
|
|
4129
4147
|
//#region src/region/region.d.ts
|
|
4130
4148
|
/**
|
|
@@ -4138,7 +4156,6 @@ declare function region(regionId: number): Resource<RegionResponse>;
|
|
|
4138
4156
|
* @returns The region index. See {@link RegionIndexResponse}.
|
|
4139
4157
|
*/
|
|
4140
4158
|
declare function regionIndex(): Resource<RegionIndexResponse>;
|
|
4141
|
-
|
|
4142
4159
|
//#endregion
|
|
4143
4160
|
//#region src/reputations/types.d.ts
|
|
4144
4161
|
/**
|
|
@@ -4154,10 +4171,17 @@ interface ReputationFactionIndexResponse extends ResponseBase {
|
|
|
4154
4171
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4155
4172
|
*/
|
|
4156
4173
|
interface ReputationFactionResponse extends ResponseBase {
|
|
4157
|
-
|
|
4174
|
+
can_paragon?: boolean;
|
|
4175
|
+
description?: string;
|
|
4176
|
+
factions?: Array<NameIdKey>;
|
|
4177
|
+
header_shows_bar?: boolean;
|
|
4158
4178
|
id: number;
|
|
4179
|
+
is_header?: boolean;
|
|
4180
|
+
is_renown?: boolean;
|
|
4159
4181
|
name: string;
|
|
4160
|
-
|
|
4182
|
+
player_faction?: Faction;
|
|
4183
|
+
renown_tiers?: Array<RenownTier>;
|
|
4184
|
+
reputation_tiers?: ReputationTier;
|
|
4161
4185
|
}
|
|
4162
4186
|
/**
|
|
4163
4187
|
* The response for a reputation tier index.
|
|
@@ -4175,20 +4199,21 @@ interface ReputationTiersResponse extends ResponseBase {
|
|
|
4175
4199
|
id: number;
|
|
4176
4200
|
tiers: Array<Tier>;
|
|
4177
4201
|
}
|
|
4202
|
+
interface RenownTier {
|
|
4203
|
+
level: number;
|
|
4204
|
+
name: string;
|
|
4205
|
+
rewards: Array<NameIdKey>;
|
|
4206
|
+
}
|
|
4178
4207
|
interface ReputationTier extends KeyBase {
|
|
4179
4208
|
id: number;
|
|
4180
4209
|
name?: string;
|
|
4181
4210
|
}
|
|
4182
|
-
interface ReputationTiers extends KeyBase {
|
|
4183
|
-
id: number;
|
|
4184
|
-
}
|
|
4185
4211
|
interface Tier {
|
|
4186
4212
|
id: number;
|
|
4187
4213
|
max_value: number;
|
|
4188
4214
|
min_value: number;
|
|
4189
4215
|
name: string;
|
|
4190
4216
|
}
|
|
4191
|
-
|
|
4192
4217
|
//#endregion
|
|
4193
4218
|
//#region src/reputations/reputations.d.ts
|
|
4194
4219
|
/**
|
|
@@ -4213,7 +4238,6 @@ declare function reputationTiers(reputationTiersId: number): Resource<Reputation
|
|
|
4213
4238
|
* @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
|
|
4214
4239
|
*/
|
|
4215
4240
|
declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
|
|
4216
|
-
|
|
4217
4241
|
//#endregion
|
|
4218
4242
|
//#region src/spell/types.d.ts
|
|
4219
4243
|
/**
|
|
@@ -4221,7 +4245,7 @@ declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
|
|
|
4221
4245
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4222
4246
|
*/
|
|
4223
4247
|
interface SpellMediaResponse extends ResponseBase {
|
|
4224
|
-
assets: Array<MediaAsset
|
|
4248
|
+
assets: Array<MediaAsset>;
|
|
4225
4249
|
id: number;
|
|
4226
4250
|
}
|
|
4227
4251
|
/**
|
|
@@ -4246,19 +4270,21 @@ interface SpellSearchParameters extends BaseSearchParameters {
|
|
|
4246
4270
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4247
4271
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
4248
4272
|
*/
|
|
4273
|
+
interface SpellSearchResponse extends SearchResponseWithoutResults {
|
|
4274
|
+
results: Array<SpellSearchResponseItem>;
|
|
4275
|
+
}
|
|
4276
|
+
interface Media$2 extends KeyBase {
|
|
4277
|
+
id: number;
|
|
4278
|
+
}
|
|
4249
4279
|
interface SpellSearchResponseItem extends KeyBase {
|
|
4250
4280
|
data: {
|
|
4251
4281
|
id: number;
|
|
4252
4282
|
media: {
|
|
4253
4283
|
id: number;
|
|
4254
4284
|
};
|
|
4255
|
-
name: Record<Locales, string
|
|
4285
|
+
name: Record<Locales, string>;
|
|
4256
4286
|
};
|
|
4257
4287
|
}
|
|
4258
|
-
interface Media$2 extends KeyBase {
|
|
4259
|
-
id: number;
|
|
4260
|
-
}
|
|
4261
|
-
|
|
4262
4288
|
//#endregion
|
|
4263
4289
|
//#region src/spell/spell.d.ts
|
|
4264
4290
|
/**
|
|
@@ -4276,10 +4302,9 @@ declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
|
|
|
4276
4302
|
/**
|
|
4277
4303
|
* Get a spell search.
|
|
4278
4304
|
* @param options The spell search options. See {@link SpellSearchParameters}.
|
|
4279
|
-
* @returns The spell search. See {@link
|
|
4305
|
+
* @returns The spell search. See {@link SpellSearchResponse}.
|
|
4280
4306
|
*/
|
|
4281
|
-
declare function spellSearch(options: SpellSearchParameters): Resource<
|
|
4282
|
-
|
|
4307
|
+
declare function spellSearch(options: SpellSearchParameters): Resource<SpellSearchResponse, Omit<SpellSearchParameters, 'locale' | 'name'>>;
|
|
4283
4308
|
//#endregion
|
|
4284
4309
|
//#region src/talent/types.d.ts
|
|
4285
4310
|
/**
|
|
@@ -4297,6 +4322,7 @@ interface PvpTalentResponse extends ResponseBase {
|
|
|
4297
4322
|
compatible_slots: Array<number>;
|
|
4298
4323
|
description: string;
|
|
4299
4324
|
id: number;
|
|
4325
|
+
overrides_spell?: NameIdKey;
|
|
4300
4326
|
playable_specialization: NameIdKey;
|
|
4301
4327
|
spell: NameIdKey;
|
|
4302
4328
|
unlock_player_level: number;
|
|
@@ -4314,9 +4340,14 @@ interface TalentIndexResponse extends ResponseBase {
|
|
|
4314
4340
|
*/
|
|
4315
4341
|
interface TalentResponse extends ResponseBase {
|
|
4316
4342
|
id: number;
|
|
4317
|
-
|
|
4318
|
-
|
|
4319
|
-
|
|
4343
|
+
overrides_spell?: NameIdKey;
|
|
4344
|
+
playable_class?: KeyBase & {
|
|
4345
|
+
id: number;
|
|
4346
|
+
name?: string;
|
|
4347
|
+
};
|
|
4348
|
+
playable_specialization?: NameIdKey;
|
|
4349
|
+
rank_descriptions?: Array<RankDescription>;
|
|
4350
|
+
spell?: NameIdKey;
|
|
4320
4351
|
}
|
|
4321
4352
|
/**
|
|
4322
4353
|
* The response for a talent tree index.
|
|
@@ -4324,6 +4355,7 @@ interface TalentResponse extends ResponseBase {
|
|
|
4324
4355
|
*/
|
|
4325
4356
|
interface TalentTreeIndexResponse extends ResponseBase {
|
|
4326
4357
|
class_talent_trees: Array<TalentTree$1>;
|
|
4358
|
+
hero_talent_trees: Array<NameIdKey>;
|
|
4327
4359
|
spec_talent_trees: Array<TalentTree$1>;
|
|
4328
4360
|
}
|
|
4329
4361
|
/**
|
|
@@ -4341,9 +4373,8 @@ interface TalentTreeNodesResponse extends ResponseBase {
|
|
|
4341
4373
|
*/
|
|
4342
4374
|
interface TalentTreeResponse extends NameId, ResponseBase {
|
|
4343
4375
|
class_talent_nodes: Array<ClassTalentNode>;
|
|
4344
|
-
|
|
4345
|
-
|
|
4346
|
-
};
|
|
4376
|
+
hero_talent_trees: Array<HeroTalentTree>;
|
|
4377
|
+
media: KeyBase;
|
|
4347
4378
|
playable_class: NameIdKey;
|
|
4348
4379
|
playable_specialization: NameIdKey;
|
|
4349
4380
|
restriction_lines: Array<RestrictionLine>;
|
|
@@ -4370,12 +4401,31 @@ interface ClassTalentNodeRank {
|
|
|
4370
4401
|
rank: number;
|
|
4371
4402
|
tooltip?: Tooltip;
|
|
4372
4403
|
}
|
|
4373
|
-
interface
|
|
4404
|
+
interface HeroTalentTree extends NameId {
|
|
4405
|
+
hero_talent_nodes: Array<HeroTalentTreeNode>;
|
|
4406
|
+
media: KeyBase & {
|
|
4407
|
+
id: number;
|
|
4408
|
+
};
|
|
4409
|
+
playable_class: NameIdKey;
|
|
4410
|
+
playable_specializations: Array<NameIdKey>;
|
|
4411
|
+
}
|
|
4412
|
+
interface HeroTalentTreeNode {
|
|
4413
|
+
display_col: number;
|
|
4414
|
+
display_row: number;
|
|
4374
4415
|
id: number;
|
|
4375
|
-
|
|
4416
|
+
locked_by?: Array<number>;
|
|
4417
|
+
node_type: {
|
|
4418
|
+
id: number;
|
|
4419
|
+
type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
|
|
4420
|
+
};
|
|
4421
|
+
ranks: Array<Rank>;
|
|
4422
|
+
raw_position_x: number;
|
|
4423
|
+
raw_position_y: number;
|
|
4424
|
+
unlocks?: Array<number>;
|
|
4376
4425
|
}
|
|
4377
|
-
interface
|
|
4426
|
+
interface NodeType {
|
|
4378
4427
|
id: number;
|
|
4428
|
+
type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
|
|
4379
4429
|
}
|
|
4380
4430
|
interface PurpleSpellTooltip {
|
|
4381
4431
|
cast_time: string;
|
|
@@ -4384,11 +4434,12 @@ interface PurpleSpellTooltip {
|
|
|
4384
4434
|
}
|
|
4385
4435
|
interface Rank {
|
|
4386
4436
|
choice_of_tooltips?: Array<Tooltip>;
|
|
4437
|
+
default_points?: number;
|
|
4387
4438
|
rank: number;
|
|
4388
4439
|
tooltip?: Tooltip;
|
|
4389
4440
|
}
|
|
4390
4441
|
interface RankDescription {
|
|
4391
|
-
description: null;
|
|
4442
|
+
description: null | string;
|
|
4392
4443
|
rank: number;
|
|
4393
4444
|
}
|
|
4394
4445
|
interface RestrictionLine {
|
|
@@ -4419,10 +4470,12 @@ interface TalentNode {
|
|
|
4419
4470
|
display_col: number;
|
|
4420
4471
|
display_row: number;
|
|
4421
4472
|
id: number;
|
|
4473
|
+
locked_by?: Array<number>;
|
|
4422
4474
|
node_type: NodeType;
|
|
4423
4475
|
ranks: Array<Rank>;
|
|
4424
4476
|
raw_position_x: number;
|
|
4425
4477
|
raw_position_y: number;
|
|
4478
|
+
unlocks?: Array<number>;
|
|
4426
4479
|
}
|
|
4427
4480
|
interface TalentTree$1 extends KeyBase {
|
|
4428
4481
|
name: string;
|
|
@@ -4439,7 +4492,6 @@ interface TooltipSpellTooltip {
|
|
|
4439
4492
|
range?: string;
|
|
4440
4493
|
spell: NameIdKey;
|
|
4441
4494
|
}
|
|
4442
|
-
|
|
4443
4495
|
//#endregion
|
|
4444
4496
|
//#region src/talent/talent.d.ts
|
|
4445
4497
|
/**
|
|
@@ -4482,7 +4534,6 @@ declare function talentTreeIndex(): Resource<TalentTreeIndexResponse>;
|
|
|
4482
4534
|
* @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
|
|
4483
4535
|
*/
|
|
4484
4536
|
declare function talentTreeNodes(talentTreeId: number): Resource<TalentTreeNodesResponse>;
|
|
4485
|
-
|
|
4486
4537
|
//#endregion
|
|
4487
4538
|
//#region src/tech-talent/types.d.ts
|
|
4488
4539
|
/**
|
|
@@ -4497,16 +4548,26 @@ interface TechTalentIndexResponse extends ResponseBase {
|
|
|
4497
4548
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4498
4549
|
*/
|
|
4499
4550
|
interface TechTalentMediaResponse extends ResponseBase {
|
|
4500
|
-
assets: Array<MediaAsset
|
|
4551
|
+
assets: Array<MediaAsset>;
|
|
4501
4552
|
}
|
|
4502
4553
|
/**
|
|
4503
4554
|
* The response for a tech talent.
|
|
4504
4555
|
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4505
4556
|
*/
|
|
4506
4557
|
interface TechTalentResponse extends NameId, ResponseBase {
|
|
4558
|
+
description?: string;
|
|
4507
4559
|
display_order: number;
|
|
4508
4560
|
media: Media$1;
|
|
4509
|
-
|
|
4561
|
+
prerequisite_talent?: NameIdKey;
|
|
4562
|
+
socket_type?: {
|
|
4563
|
+
name: string;
|
|
4564
|
+
type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
|
|
4565
|
+
};
|
|
4566
|
+
spell_tooltip?: SpellTooltip;
|
|
4567
|
+
talent_tree: KeyBase & {
|
|
4568
|
+
id: number;
|
|
4569
|
+
name?: string;
|
|
4570
|
+
};
|
|
4510
4571
|
tier: number;
|
|
4511
4572
|
}
|
|
4512
4573
|
/**
|
|
@@ -4523,17 +4584,24 @@ interface TechTalentTreeIndexResponse extends ResponseBase {
|
|
|
4523
4584
|
interface TechTalentTreeResponse extends ResponseBase {
|
|
4524
4585
|
id: number;
|
|
4525
4586
|
max_tiers: number;
|
|
4526
|
-
playable_class
|
|
4587
|
+
playable_class?: NameIdKey;
|
|
4527
4588
|
talents: Array<NameIdKey>;
|
|
4528
4589
|
}
|
|
4529
4590
|
interface Media$1 extends KeyBase {
|
|
4530
4591
|
id: number;
|
|
4531
4592
|
}
|
|
4593
|
+
interface SpellTooltip {
|
|
4594
|
+
cast_time: string;
|
|
4595
|
+
cooldown?: string;
|
|
4596
|
+
description: null | string;
|
|
4597
|
+
power_cost?: null | string;
|
|
4598
|
+
range?: string;
|
|
4599
|
+
spell: NameIdKey;
|
|
4600
|
+
}
|
|
4532
4601
|
interface TalentTree extends KeyBase {
|
|
4533
4602
|
id: number;
|
|
4534
4603
|
name?: string;
|
|
4535
4604
|
}
|
|
4536
|
-
|
|
4537
4605
|
//#endregion
|
|
4538
4606
|
//#region src/tech-talent/tech-talent.d.ts
|
|
4539
4607
|
/**
|
|
@@ -4564,7 +4632,6 @@ declare function techTalentTree(techTalentTreeId: number): Resource<TechTalentTr
|
|
|
4564
4632
|
* @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
|
|
4565
4633
|
*/
|
|
4566
4634
|
declare function techTalentTreeIndex(): Resource<TechTalentTreeIndexResponse>;
|
|
4567
|
-
|
|
4568
4635
|
//#endregion
|
|
4569
4636
|
//#region src/title/types.d.ts
|
|
4570
4637
|
/**
|
|
@@ -4580,8 +4647,19 @@ interface TitleIndexResponse extends ResponseBase {
|
|
|
4580
4647
|
*/
|
|
4581
4648
|
interface TitleResponse extends NameId, ResponseBase {
|
|
4582
4649
|
gender_name: GenderName;
|
|
4650
|
+
source?: TitleSource;
|
|
4651
|
+
}
|
|
4652
|
+
interface TitleSource {
|
|
4653
|
+
achievements?: Array<NameIdKey>;
|
|
4654
|
+
quests?: Array<NameIdKey>;
|
|
4655
|
+
type: {
|
|
4656
|
+
name: 'Achievement';
|
|
4657
|
+
type: 'ACHIEVEMENT';
|
|
4658
|
+
} | {
|
|
4659
|
+
name: 'Quest';
|
|
4660
|
+
type: 'QUEST';
|
|
4661
|
+
};
|
|
4583
4662
|
}
|
|
4584
|
-
|
|
4585
4663
|
//#endregion
|
|
4586
4664
|
//#region src/title/title.d.ts
|
|
4587
4665
|
/**
|
|
@@ -4595,7 +4673,6 @@ declare function title(titleId: number): Resource<TitleResponse>;
|
|
|
4595
4673
|
* @returns The title index. See {@link TitleIndexResponse}.
|
|
4596
4674
|
*/
|
|
4597
4675
|
declare function titleIndex(): Resource<TitleIndexResponse>;
|
|
4598
|
-
|
|
4599
4676
|
//#endregion
|
|
4600
4677
|
//#region src/toy/types.d.ts
|
|
4601
4678
|
/**
|
|
@@ -4613,8 +4690,9 @@ interface ToyResponse extends ResponseBase {
|
|
|
4613
4690
|
id: number;
|
|
4614
4691
|
item: NameIdKey;
|
|
4615
4692
|
media: Media;
|
|
4693
|
+
should_exclude_if_uncollected?: boolean;
|
|
4616
4694
|
source: Source;
|
|
4617
|
-
source_description
|
|
4695
|
+
source_description?: string;
|
|
4618
4696
|
}
|
|
4619
4697
|
interface Media extends KeyBase {
|
|
4620
4698
|
id: number;
|
|
@@ -4623,7 +4701,6 @@ interface Source {
|
|
|
4623
4701
|
name: string;
|
|
4624
4702
|
type: string;
|
|
4625
4703
|
}
|
|
4626
|
-
|
|
4627
4704
|
//#endregion
|
|
4628
4705
|
//#region src/toy/toy.d.ts
|
|
4629
4706
|
/**
|
|
@@ -4637,7 +4714,6 @@ declare function toy(toyId: number): Resource<ToyResponse>;
|
|
|
4637
4714
|
* @returns The toy index. See {@link ToyIndexResponse}.
|
|
4638
4715
|
*/
|
|
4639
4716
|
declare function toyIndex(): Resource<ToyIndexResponse>;
|
|
4640
|
-
|
|
4641
4717
|
//#endregion
|
|
4642
4718
|
//#region src/wow-token/types.d.ts
|
|
4643
4719
|
/**
|
|
@@ -4648,7 +4724,6 @@ interface WowTokenResponse extends ResponseBase {
|
|
|
4648
4724
|
last_updated_timestamp: number;
|
|
4649
4725
|
price: number;
|
|
4650
4726
|
}
|
|
4651
|
-
|
|
4652
4727
|
//#endregion
|
|
4653
4728
|
//#region src/wow-token/wow-token.d.ts
|
|
4654
4729
|
/**
|
|
@@ -4656,7 +4731,6 @@ interface WowTokenResponse extends ResponseBase {
|
|
|
4656
4731
|
* @returns The WoW token price. See {@link WowTokenResponse}.
|
|
4657
4732
|
*/
|
|
4658
4733
|
declare function wowToken(): Resource<WowTokenResponse>;
|
|
4659
|
-
|
|
4660
4734
|
//#endregion
|
|
4661
4735
|
//#region src/index.d.ts
|
|
4662
4736
|
/**
|
|
@@ -4845,7 +4919,6 @@ declare const wow: {
|
|
|
4845
4919
|
toyIndex: typeof toyIndex;
|
|
4846
4920
|
wowToken: typeof wowToken;
|
|
4847
4921
|
};
|
|
4848
|
-
|
|
4849
4922
|
//#endregion
|
|
4850
|
-
export { AccountCollectionsIndexResponse, AccountHeirloomsCollectionSummaryResponse, AccountMountsCollectionSummaryResponse, AccountPetsCollectionSummaryResponse, AccountProfileSummaryResponse, AccountToysCollectionSummaryResponse, AccountTransmogsCollectionSummaryResponse, AchievementCategoryIndexResponse, AchievementCategoryResponse, AchievementIndexResponse, AchievementMediaResponse, AchievementResponse, AuctionHouseCommoditiesResponse, AuctionHouseResponse, AzeriteEssenceIndexResponse, AzeriteEssenceMediaResponse, AzeriteEssenceResponse, AzeriteEssenceSearchParameters,
|
|
4923
|
+
export { AccountCollectionsIndexResponse, AccountHeirloomsCollectionSummaryResponse, AccountMountsCollectionSummaryResponse, AccountPetsCollectionSummaryResponse, AccountProfileSummaryResponse, AccountToysCollectionSummaryResponse, AccountTransmogsCollectionSummaryResponse, AchievementCategoryIndexResponse, AchievementCategoryResponse, AchievementIndexResponse, AchievementMediaResponse, AchievementResponse, AuctionHouseCommoditiesResponse, AuctionHouseResponse, AzeriteEssenceIndexResponse, AzeriteEssenceMediaResponse, AzeriteEssenceResponse, AzeriteEssenceSearchParameters, AzeriteEssenceSearchResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterAppearanceResponse, CharacterCollectionsIndexResponse, CharacterCompletedQuestsResponse, CharacterDungeonsResponse, CharacterEncountersSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHeirloomsCollectionSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse, CharacterMountsCollectionSummaryResponse, CharacterMythicKeystoneProfileIndexResponse, CharacterMythicKeystoneSeasonDetailsResponse, CharacterPetsCollectionSummaryResponse, CharacterProfessionsSummaryResponse, CharacterProfileStatusResponse, CharacterProfileSummaryResponse, CharacterPvpBracketStatisticsResponse, CharacterPvpSummaryResponse, CharacterQuestsResponse, CharacterRaidsResponse, CharacterReputationsSummaryResponse, CharacterSoulbindsResponse, CharacterSpecializationsSummaryResponse, CharacterStatisticsSummaryResponse, CharacterTitlesSummaryResponse, CharacterToysCollectionSummaryResponse, CharacterTransmogCollectionSummaryResponse, ConduitIndexResponse, ConduitResponse, ConnectedRealmIndexResponse, ConnectedRealmResponse, ConnectedRealmSearchParameters, ConnectedRealmSearchResponse, CovenantIndexResponse, CovenantMediaResponse, CovenantResponse, CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponse, CreatureTypeIndexResponse, CreatureTypeResponse, GuildAchievementsResponse, GuildActivityResponse, GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse, GuildResponse, GuildRosterResponse, HeirloomIndexResponse, HeirloomResponse, ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponse, ItemSetIndexResponse, ItemSetResponse, ItemSubClassResponse, JournalEncounterIndexResponse, JournalEncounterResponse, JournalEncounterSearchParameters, JournalEncounterSearchResponse, JournalExpansionIndexResponse, JournalExpansionResponse, JournalInstanceIndexResponse, JournalInstanceMediaResponse, JournalInstanceResponse, MediaSearchParameters, MediaSearchResponse, ModifiedCraftingCategoryIndexResponse, ModifiedCraftingCategoryResponse, ModifiedCraftingIndexResponse, ModifiedCraftingReagentSlotTypeIndexResponse, ModifiedCraftingReagentSlotTypeResponse, MountIndexResponse, MountResponse, MountSearchParameters, MountSearchResponse, MythicKeystoneAffixIndexResponse, MythicKeystoneAffixMediaResponse, MythicKeystoneAffixResponse, MythicKeystoneDungeonIndexResponse, MythicKeystoneDungeonResponse, MythicKeystoneIndexResponse, MythicKeystoneLeaderboardIndexResponse, MythicKeystoneLeaderboardResponse, MythicKeystonePeriodIndexResponse, MythicKeystonePeriodResponse, MythicKeystoneSeasonIndexResponse, MythicKeystoneSeasonResponse, MythicRaidLeaderboardResponse, PetAbilityIndexResponse, PetAbilityMediaResponse, PetAbilityResponse, PetIndexResponse, PetMediaResponse, PetResponse, PlayableClassIndexResponse, PlayableClassMediaResponse, PlayableClassResponse, PlayableRaceIndexResponse, PlayableRaceResponse, PlayableSpecializationIndexResponse, PlayableSpecializationMediaResponse, PlayableSpecializationResponse, PowerTypeIndexResponse, PowerTypeResponse, ProfessionIndexResponse, ProfessionMediaResponse, ProfessionResponse, ProfessionSkillTierResponse, ProtectedCharacterProfileSummaryResponse, PvpLeaderboardIndexResponse, PvpLeaderboardResponse, PvpRewardsIndexResponse, PvpSeasonIndexResponse, PvpSeasonResponse, PvpTalentIndexResponse, PvpTalentResponse, PvpTalentSlotsResponse, PvpTierIndexResponse, PvpTierMediaResponse, PvpTierResponse, QuestAreaIndexResponse, QuestAreaResponse, QuestCategoryIndexResponse, QuestCategoryResponse, QuestIndexResponse, QuestResponse, QuestTypeIndexResponse, QuestTypeResponse, RealmCategory, RealmIndexResponse, RealmLocales, RealmResponse, RealmSearchParameters, RealmSearchResponse, RealmTimezone, RealmTypeCapitalized, RecipeMediaResponse, RecipeResponse, RegionIndexResponse, RegionResponse, ReputationFactionIndexResponse, ReputationFactionResponse, ReputationTiersIndexResponse, ReputationTiersResponse, SoulbindIndexResponse, SoulbindResponse, SpellMediaResponse, SpellResponse, SpellSearchParameters, SpellSearchResponse, TalentIndexResponse, TalentResponse, TalentTreeIndexResponse, TalentTreeNodesResponse, TalentTreeResponse, TechTalentIndexResponse, TechTalentMediaResponse, TechTalentResponse, TechTalentTreeIndexResponse, TechTalentTreeResponse, TitleIndexResponse, TitleResponse, ToyIndexResponse, ToyResponse, WowTokenResponse, accountCollectionsIndex, accountHeirloomsCollectionSummary, accountMountsCollectionSummary, accountPetsCollectionSummary, accountProfileSummary, accountToysCollectionSummary, accountTransmogsCollectionSummary, achievement, achievementCategory, achievementCategoryIndex, achievementIndex, achievementMedia, auctions, azeriteEssence, azeriteEssenceIndex, azeriteEssenceMedia, azeriteEssenceSearch, characterAchievementStatistics, characterAchievementsSummary, characterAppearanceSummary, characterCollectionsIndex, characterCompletedQuests, characterDungeons, characterEncountersSummary, characterEquipmentSummary, characterHeirloomsCollectionSummary, characterHunterPetsSummary, characterMediaSummary, characterMountsCollectionSummary, characterMythicKeystoneProfileIndex, characterMythicKeystoneSeasonDetails, characterPetsCollectionSummary, characterProfessionsSummary, characterProfileStatus, characterProfileSummary, characterPvpBracketStatistics, characterPvpSummary, characterQuests, characterRaids, characterReputationsSummary, characterSoulbinds, characterSpecializationsSummary, characterStatisticsSummary, characterTitlesSummary, characterToysCollectionSummary, characterTransmogCollectionSummary, commodities, conduit, conduitIndex, connectedRealm, connectedRealmIndex, connectedRealmSearch, covenant, covenantIndex, covenantMedia, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, wow as default, wow, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, heirloom, heirloomIndex, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass, journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia, mediaSearch, modifiedCraftingCategory, modifiedCraftingCategoryIndex, modifiedCraftingIndex, modifiedCraftingReagentSlotType, modifiedCraftingReagentSlotTypeIndex, mount, mountIndex, mountSearch, mythicKeystoneAffix, mythicKeystoneAffixIndex, mythicKeystoneAffixMedia, mythicKeystoneDungeon, mythicKeystoneDungeonIndex, mythicKeystoneIndex, mythicKeystoneLeaderboard, mythicKeystoneLeaderboardIndex, mythicKeystonePeriod, mythicKeystonePeriodIndex, mythicKeystoneSeason, mythicKeystoneSeasonIndex, mythicRaidLeaderboard, pet, petAbility, petAbilityIndex, petAbilityMedia, petIndex, petMedia, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, playableSpecialization, playableSpecializationIndex, playableSpecializationMedia, powerType, powerTypeIndex, profession, professionIndex, professionMedia, professionSkillTier, protectedCharacterProfileSummary, pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, pvpTalent, pvpTalentIndex, pvpTalentSlots, pvpTier, pvpTierIndex, pvpTierMedia, quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex, realm, realmIndex, realmSearch, recipe, recipeMedia, region, regionIndex, reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex, soulbind, soulbindIndex, spell, spellMedia, spellSearch, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes, techTalent, techTalentIndex, techTalentMedia, techTalentTree, techTalentTreeIndex, title, titleIndex, toy, toyIndex, wowToken };
|
|
4851
4924
|
//# sourceMappingURL=index.d.ts.map
|