@blizzard-api/classic-wow 2.1.3 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,117 +1,12 @@
1
- import { BaseSearchParameters, BlizzardNamespaces, Locales, Resource, SearchResponse } from "@blizzard-api/core";
1
+ import { BaseSearchParameters, BlizzardNamespaces, Character, Color, Faction, Gender, GenderName, Href, KeyBase, Locales, MediaAsset, NameId, NameIdKey, Realm, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
2
2
 
3
- //#region ../wow/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 extends NameIdKey {
91
- realm: Realm$1;
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$1 extends NameIdKey {
104
- slug: string;
105
- } //#endregion
106
3
  //#region src/auction-house/types.d.ts
107
4
  interface AuctionHouseIndexResponse extends ResponseBase {
108
5
  auctions: Array<NameIdKey>;
109
6
  }
110
7
  interface AuctionsResponse extends NameId, ResponseBase {
111
8
  auctions: Array<Auction>;
112
- connected_realm: {
113
- href: string;
114
- };
9
+ connected_realm: Href;
115
10
  }
116
11
  interface Auction {
117
12
  bid: number;
@@ -125,7 +20,6 @@ interface Auction {
125
20
  quantity: number;
126
21
  time_left: 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
127
22
  }
128
-
129
23
  //#endregion
130
24
  //#region src/auction-house/auction-house.d.ts
131
25
  /**
@@ -147,15 +41,13 @@ declare function auctionHouseIndex(namespace: Extract<BlizzardNamespaces, 'dynam
147
41
  * @returns The auction house data. See {@link AuctionsResponse}.
148
42
  */
149
43
  declare function auctions(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number, auctionHouseId: number): Resource<AuctionsResponse>;
150
-
151
44
  //#endregion
152
- //#region ../wow/src/character-achievements/types.d.ts
153
- interface CharacterAchievementsSummaryResponse$1 extends ResponseBase {
45
+ //#region src/character-achievements/types.d.ts
46
+ interface CharacterAchievementsSummaryResponse extends ResponseBase {
154
47
  achievements: Array<Achievement$1>;
155
48
  category_progress: Array<CategoryProgress$1>;
156
49
  character: Character;
157
50
  recent_events: Array<RecentEvent$1>;
158
- statistics: Href;
159
51
  total_points: number;
160
52
  total_quantity: number;
161
53
  }
@@ -172,17 +64,34 @@ interface Achievement$1 {
172
64
  interface Category {
173
65
  id: number;
174
66
  name: string;
175
- statistics: Array<Statistic>;
176
- sub_categories: Array<SubCategory>;
67
+ statistics?: Array<Statistic>;
68
+ sub_categories?: Array<SubCategory>;
177
69
  }
178
70
  interface CategoryProgress$1 {
179
71
  category: NameIdKey;
180
72
  points: number;
181
73
  quantity: number;
182
74
  }
75
+ interface ChildCriterum$1 {
76
+ amount?: number;
77
+ child_criteria?: Array<ChildCriterum2>;
78
+ id: number;
79
+ is_completed: boolean;
80
+ }
81
+ interface ChildCriterum2 {
82
+ amount?: number;
83
+ child_criteria?: Array<ChildCriterum3>;
84
+ id: number;
85
+ is_completed: boolean;
86
+ }
87
+ interface ChildCriterum3 {
88
+ amount?: number;
89
+ id: number;
90
+ is_completed: boolean;
91
+ }
183
92
  interface Criteria$1 {
184
93
  amount?: number;
185
- child_criteria?: Array<Criteria$1>;
94
+ child_criteria?: Array<ChildCriterum$1>;
186
95
  id: number;
187
96
  is_completed: boolean;
188
97
  }
@@ -202,11 +111,6 @@ interface SubCategory {
202
111
  name: string;
203
112
  statistics: Array<Statistic>;
204
113
  }
205
-
206
- //#endregion
207
- //#region src/character-achievements/types.d.ts
208
- type CharacterAchievementsSummaryResponse = Omit<CharacterAchievementsSummaryResponse$1, 'statistics'>;
209
-
210
114
  //#endregion
211
115
  //#region src/character-achievements/character-achievements.d.ts
212
116
  /**
@@ -223,9 +127,8 @@ declare function characterAchievementsSummary(namespace: Extract<BlizzardNamespa
223
127
  * @returns a character's statistics as they pertain to achievements.
224
128
  */
225
129
  declare function characterAchievementStatistics(namespace: Extract<BlizzardNamespaces, 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
226
-
227
130
  //#endregion
228
- //#region ../wow/src/character-equipment/types.d.ts
131
+ //#region src/character-equipment/types.d.ts
229
132
  interface CharacterEquipmentSummaryResponse extends ResponseBase {
230
133
  character: Character;
231
134
  equipped_item_sets: Array<Set>;
@@ -257,20 +160,24 @@ interface Effect {
257
160
  required_count: number;
258
161
  }
259
162
  interface Enchantment {
260
- display_string: string;
163
+ display_string?: string;
261
164
  enchantment_id: number;
262
165
  enchantment_slot: EnchantmentSlot;
263
166
  source_item?: NameIdKey;
167
+ spell?: {
168
+ description: string;
169
+ spell: NameIdKey;
170
+ };
264
171
  }
265
172
  interface EnchantmentSlot {
266
173
  id: number;
267
- type: string;
174
+ type?: string;
268
175
  }
269
176
  interface EquippedItem {
270
177
  armor?: Armor$1;
271
178
  binding: NameType;
272
179
  bonus_list?: Array<number>;
273
- context: number;
180
+ context?: number;
274
181
  description?: string;
275
182
  durability?: DisplayStringValue;
276
183
  enchantments?: Array<Enchantment>;
@@ -281,7 +188,7 @@ interface EquippedItem {
281
188
  };
282
189
  item_class: NameIdKey;
283
190
  item_subclass: NameIdKey;
284
- level: DisplayStringValue;
191
+ level?: DisplayStringValue;
285
192
  limit_category?: string;
286
193
  media: KeyBase & {
287
194
  id: number;
@@ -289,7 +196,7 @@ interface EquippedItem {
289
196
  modified_appearance_id?: number;
290
197
  modified_crafting_stat?: Array<ModifiedCraftingStat>;
291
198
  name: string;
292
- name_description: NameDescription;
199
+ name_description?: NameDescription;
293
200
  quality: NameType;
294
201
  quantity: number;
295
202
  requirements?: Requirements$1;
@@ -301,10 +208,12 @@ interface EquippedItem {
301
208
  stats?: Array<Stat$1>;
302
209
  transmog?: Transmog;
303
210
  unique_equipped?: string;
211
+ upgrade_id?: number;
304
212
  weapon?: Weapon$1;
305
213
  }
306
- interface ItemElement extends NameIdKey {
214
+ interface ItemElement {
307
215
  is_equipped?: boolean;
216
+ item: NameIdKey;
308
217
  }
309
218
  interface ModifiedCraftingStat {
310
219
  id: number;
@@ -332,10 +241,10 @@ interface SellPrice {
332
241
  value: number;
333
242
  }
334
243
  interface Set {
335
- display_string: string;
336
- effects: Array<Effect>;
337
- item_set: NameIdKey;
338
- items: Array<ItemElement>;
244
+ display_string?: string;
245
+ effects?: Array<Effect>;
246
+ item_set?: NameIdKey;
247
+ items?: Array<ItemElement>;
339
248
  }
340
249
  interface Socket {
341
250
  display_string: string;
@@ -366,7 +275,6 @@ interface Weapon$1 {
366
275
  damage: Damage$1;
367
276
  dps: DisplayStringValue;
368
277
  }
369
-
370
278
  //#endregion
371
279
  //#region src/character-equipment/character-equipment.d.ts
372
280
  /**
@@ -377,9 +285,8 @@ interface Weapon$1 {
377
285
  * @returns The character equipment summary.
378
286
  */
379
287
  declare function characterEquipmentSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
380
-
381
288
  //#endregion
382
- //#region ../wow/src/character-hunter-pets/types.d.ts
289
+ //#region src/character-hunter-pets/types.d.ts
383
290
  interface CharacterHunterPetsSummaryResponse extends ResponseBase {
384
291
  character: Character;
385
292
  hunter_pets: Array<HunterPet>;
@@ -395,7 +302,6 @@ interface HunterPet {
395
302
  name: string;
396
303
  slot: number;
397
304
  }
398
-
399
305
  //#endregion
400
306
  //#region src/character-hunter-pets/character-hunter-pets.d.ts
401
307
  /**
@@ -406,9 +312,8 @@ interface HunterPet {
406
312
  * @returns a summary of the character's hunter pets.
407
313
  */
408
314
  declare function characterHunterPetsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
409
-
410
315
  //#endregion
411
- //#region ../wow/src/character-media/types.d.ts
316
+ //#region src/character-media/types.d.ts
412
317
  interface CharacterMediaSummaryResponse extends ResponseBase {
413
318
  assets: Array<Asset>;
414
319
  character: Character;
@@ -417,7 +322,6 @@ interface Asset {
417
322
  key: string;
418
323
  value: string;
419
324
  }
420
-
421
325
  //#endregion
422
326
  //#region src/character-media/character-media.d.ts
423
327
  /**
@@ -427,14 +331,12 @@ interface Asset {
427
331
  * @returns a summary of the media assets available for a character (such as an avatar render).
428
332
  */
429
333
  declare function characterMediaSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
430
-
431
334
  //#endregion
432
335
  //#region ../wow/src/character-profile/types.d.ts
433
336
  interface CharacterProfileStatusResponse extends ResponseBase {
434
337
  id: number;
435
338
  is_valid: boolean;
436
339
  }
437
-
438
340
  //#endregion
439
341
  //#region src/character-profile/types.d.ts
440
342
  interface CharacterProfileSummaryResponse extends ResponseBase {
@@ -452,7 +354,8 @@ interface CharacterProfileSummaryResponse extends ResponseBase {
452
354
  experience: number;
453
355
  faction: Faction;
454
356
  gender: Gender;
455
- guild: Guild$2;
357
+ guild: Guild$1;
358
+ hunter_pets?: Href;
456
359
  id: number;
457
360
  is_ghost?: boolean;
458
361
  is_self_found?: boolean;
@@ -462,16 +365,15 @@ interface CharacterProfileSummaryResponse extends ResponseBase {
462
365
  name: string;
463
366
  pvp_summary: Href;
464
367
  race: NameIdKey;
465
- realm: Realm$1;
368
+ realm: Realm;
466
369
  specializations: Href;
467
370
  statistics: Href;
468
371
  titles: Href;
469
372
  }
470
- interface Guild$2 extends NameIdKey {
373
+ interface Guild$1 extends NameIdKey {
471
374
  faction: Faction;
472
- realm: Realm$1;
375
+ realm: Realm;
473
376
  }
474
-
475
377
  //#endregion
476
378
  //#region src/character-profile/character-profile.d.ts
477
379
  /**
@@ -500,22 +402,28 @@ declare function characterProfileStatus(namespace: Extract<BlizzardNamespaces, '
500
402
  * @returns a summary of the character profile for a character.
501
403
  */
502
404
  declare function characterProfileSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
503
-
504
405
  //#endregion
505
406
  //#region src/character-specialization/types.d.ts
506
407
  interface CharacterSpecializationsSummaryResponse extends ResponseBase {
408
+ active_specialization?: NameIdKey;
507
409
  character: Character;
508
410
  specialization_groups: Array<SpecializationGroup>;
411
+ specializations?: Array<ClassicProgressionSpecialization>;
509
412
  }
510
- interface Specialization {
413
+ interface ClassicProgressionSpecialization {
414
+ specialization: NameIdKey;
511
415
  specialization_name: string;
512
- spent_points: number;
513
- talents: Array<TalentElement>;
416
+ talents?: Array<TalentElement>;
514
417
  }
515
418
  interface SpecializationGroup {
516
419
  glyphs?: Array<NameId>;
517
420
  is_active: boolean;
518
- specializations?: Array<Specialization>;
421
+ specializations?: Array<SpecializationGroupItem>;
422
+ }
423
+ interface SpecializationGroupItem {
424
+ specialization_name: string;
425
+ spent_points: number;
426
+ talents: Array<TalentElement>;
519
427
  }
520
428
  interface SpellTooltip {
521
429
  cast_time: 'Channeled' | 'Instant' | 'Instant cast' | 'Passive';
@@ -527,12 +435,11 @@ interface SpellTooltip {
527
435
  }
528
436
  interface TalentElement {
529
437
  spell_tooltip: SpellTooltip;
530
- talent: {
438
+ talent: NameId | {
531
439
  id: number;
532
440
  };
533
- talent_rank: number;
441
+ talent_rank?: number;
534
442
  }
535
-
536
443
  //#endregion
537
444
  //#region src/character-specialization/character-specialization.d.ts
538
445
  /**
@@ -542,12 +449,11 @@ interface TalentElement {
542
449
  * @returns a summary of a character's specializations.
543
450
  */
544
451
  declare function characterSpecializationsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
545
-
546
452
  //#endregion
547
453
  //#region src/character-statistics/types.d.ts
548
454
  interface CharacterStatisticsSummaryResponse extends ResponseBase {
549
455
  agility: BaseEffectiveStat;
550
- arcane_resistance: BaseEffectiveStat;
456
+ arcane_resistance?: BaseEffectiveStat;
551
457
  armor: BaseEffectiveStat;
552
458
  attack_power: number;
553
459
  block: RatingWithValue;
@@ -555,9 +461,9 @@ interface CharacterStatisticsSummaryResponse extends ResponseBase {
555
461
  character: Character;
556
462
  defense?: BaseEffectiveStat;
557
463
  dodge: RatingWithValue;
558
- fire_resistance: BaseEffectiveStat;
464
+ fire_resistance?: BaseEffectiveStat;
559
465
  health: number;
560
- holy_resistance: BaseEffectiveStat;
466
+ holy_resistance?: BaseEffectiveStat;
561
467
  intellect: BaseEffectiveStat;
562
468
  main_hand_damage_max: number;
563
469
  main_hand_damage_min: number;
@@ -568,17 +474,17 @@ interface CharacterStatisticsSummaryResponse extends ResponseBase {
568
474
  mastery?: RatingWithValue;
569
475
  melee_crit: RatingWithValue;
570
476
  melee_haste?: RatingWithValue;
571
- nature_resistance: BaseEffectiveStat;
477
+ nature_resistance?: BaseEffectiveStat;
572
478
  off_hand_damage_max: number;
573
479
  off_hand_damage_min: number;
574
480
  off_hand_dps: number;
575
481
  off_hand_speed: number;
576
482
  parry: RatingWithValue;
577
483
  power: number;
578
- power_type: Character;
484
+ power_type: NameIdKey;
579
485
  ranged_crit: RatingWithValue;
580
486
  ranged_haste?: RatingWithValue;
581
- shadow_resistance: BaseEffectiveStat;
487
+ shadow_resistance?: BaseEffectiveStat;
582
488
  spell_crit: RatingWithValue;
583
489
  spell_haste?: RatingWithValue;
584
490
  spell_penetration: number;
@@ -592,11 +498,10 @@ interface BaseEffectiveStat {
592
498
  effective: number;
593
499
  }
594
500
  interface RatingWithValue {
595
- rating: number;
596
501
  rating_bonus: number;
502
+ rating_normalized: number;
597
503
  value: number;
598
504
  }
599
-
600
505
  //#endregion
601
506
  //#region src/character-statistics/character-statistics.d.ts
602
507
  /**
@@ -606,9 +511,8 @@ interface RatingWithValue {
606
511
  * @returns a statistics summary for a character.
607
512
  */
608
513
  declare function characterStatisticsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterStatisticsSummaryResponse>;
609
-
610
514
  //#endregion
611
- //#region ../wow/src/realm/types.d.ts
515
+ //#region src/realm/types.d.ts
612
516
  /**
613
517
  * The category of a realm.
614
518
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -619,24 +523,23 @@ type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'L
619
523
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
620
524
  */
621
525
  interface RealmIndexResponse extends ResponseBase {
622
- realms: Array<Realm$1>;
526
+ realms: Array<Realm>;
623
527
  }
528
+ type RealmLocales = 'deDE' | 'enGB' | 'enUS' | 'esES' | 'esMX' | 'frFR' | 'itIT' | 'koKR' | 'ptBR' | 'ptPT' | 'ruRU' | 'zhCN' | 'zhTW';
624
529
  /**
625
530
  * The response for a realm.
626
531
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
627
532
  */
628
533
  interface RealmResponse extends NameId, ResponseBase {
629
534
  category: RealmCategory;
630
- connected_realm: {
631
- href: string;
632
- };
535
+ connected_realm: Href;
633
536
  is_tournament: boolean;
634
- locale: WithoutUnderscore<Locales>;
537
+ locale: RealmLocales;
635
538
  region: NameIdKey;
636
539
  slug: string;
637
540
  timezone: RealmTimezone;
638
541
  type: {
639
- name: RealmType;
542
+ name: string;
640
543
  type: RealmTypeCapitalized;
641
544
  };
642
545
  }
@@ -653,72 +556,63 @@ interface RealmSearchParameters extends BaseSearchParameters {
653
556
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
654
557
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
655
558
  */
559
+ interface RealmSearchResponse extends SearchResponseWithoutResults {
560
+ results: Array<RealmSearchResponseItem>;
561
+ }
562
+ /**
563
+ * The timezone of a realm.
564
+ */
565
+ type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
566
+ type RealmTypeCapitalized = 'NORMAL' | 'RP';
567
+ /**
568
+ * The type of a realm, capitalized and shortended).
569
+ */
656
570
  interface RealmSearchResponseItem extends KeyBase {
657
571
  data: {
658
- category: Record<Locales, string | undefined>;
572
+ category: Record<Locales, string>;
659
573
  id: number;
660
574
  is_tournament: boolean;
661
- locale: WithoutUnderscore<Locales>;
662
- name: Record<Locales, string | undefined>;
575
+ locale: RealmLocales;
576
+ name: Record<Locales, string>;
663
577
  region: {
664
578
  id: number;
665
- name: Record<Locales, string | undefined>;
579
+ name: Record<Locales, string>;
666
580
  };
667
581
  slug: string;
668
582
  timezone: RealmTimezone;
669
583
  type: {
670
- name: Record<Locales, string | undefined>;
584
+ name: string;
671
585
  type: RealmTypeCapitalized;
672
586
  };
673
587
  };
674
588
  }
675
- /**
676
- * The timezone of a realm.
677
- */
678
- type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
679
- /**
680
- * The type of a realm, not capitalized or shortened.
681
- */
682
- type RealmType = 'Normal' | 'Roleplaying';
683
- /**
684
- * The type of a realm, capitalized and shortended).
685
- */
686
- type RealmTypeCapitalized = 'NORMAL' | 'RP';
687
- type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
688
-
689
589
  //#endregion
690
- //#region ../wow/src/connected-realm/types.d.ts
590
+ //#region src/connected-realm/types.d.ts
691
591
  /**
692
592
  * Connected Realm Index API response.
693
593
  * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
694
594
  */
695
595
  interface ConnectedRealmIndexResponse extends ResponseBase {
696
- connected_realms: Array<{
697
- href: string;
698
- }>;
596
+ connected_realms: Array<Href>;
699
597
  }
700
598
  /**
701
599
  * Connected Realm API response.
702
600
  * @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
703
601
  */
704
602
  interface ConnectedRealmResponse extends ResponseBase {
705
- auctions: {
706
- href: string;
707
- };
603
+ auctions: Href;
708
604
  has_queue: boolean;
709
605
  id: number;
710
- mythic_leaderboards: {
711
- href: string;
712
- };
713
606
  population: {
714
- name: RealmPopulation;
607
+ name: string;
715
608
  type: RealmPopulationCapitalized;
716
609
  };
610
+ pvp_season?: Href;
717
611
  realm_locked_status?: RealmLockedStatus;
718
- realms: Array<Realm>;
612
+ realms: Array<Realm$1>;
719
613
  status: {
720
614
  name: RealmStatus;
721
- type: Uppercase<RealmStatus>;
615
+ type: RealmStatusCapitalized;
722
616
  };
723
617
  }
724
618
  /**
@@ -728,13 +622,16 @@ interface ConnectedRealmResponse extends ResponseBase {
728
622
  */
729
623
  interface ConnectedRealmSearchParameters extends BaseSearchParameters {
730
624
  'realms.timezone'?: RealmTimezone;
731
- 'status.type'?: Uppercase<RealmStatus>;
625
+ 'status.type'?: RealmStatusCapitalized;
732
626
  }
733
627
  /**
734
628
  * Connected Realm Search API response item.
735
629
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
736
630
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
737
631
  */
632
+ interface ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
633
+ results: Array<ConnectedRealmSearchResponseItem>;
634
+ }
738
635
  interface ConnectedRealmSearchResponseItem extends KeyBase {
739
636
  data: {
740
637
  has_queue: boolean;
@@ -744,20 +641,18 @@ interface ConnectedRealmSearchResponseItem extends KeyBase {
744
641
  status: SearchRealmStatus;
745
642
  };
746
643
  }
747
- interface Realm {
644
+ interface Realm$1 {
748
645
  category: RealmCategory;
749
- connected_realm: {
750
- href: string;
751
- };
646
+ connected_realm: Href;
752
647
  id: number;
753
648
  is_tournament: boolean;
754
- locale: WithoutUnderscore<Locales>;
649
+ locale: RealmLocales;
755
650
  name: string;
756
651
  region: NameIdKey;
757
652
  slug: string;
758
653
  timezone: RealmTimezone;
759
654
  type: {
760
- name: RealmType;
655
+ name: string;
761
656
  type: RealmTypeCapitalized;
762
657
  };
763
658
  }
@@ -765,23 +660,23 @@ interface RealmLockedStatus {
765
660
  is_locked_for_new_characters: boolean;
766
661
  is_locked_for_pct: boolean;
767
662
  }
768
- type RealmPopulation = 'Full' | 'High' | 'Low' | 'Medium' | 'New Players';
769
- type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
663
+ type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOCKED' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
770
664
  type RealmStatus = 'Down' | 'Up';
665
+ type RealmStatusCapitalized = 'DOWN' | 'UP';
771
666
  interface SearchRealm {
772
- category: Record<Locales, string | undefined>;
667
+ category: Record<Locales, string>;
773
668
  id: number;
774
669
  is_tournament: boolean;
775
- locale: WithoutUnderscore<Locales>;
670
+ locale: RealmLocales;
776
671
  name: Record<Locales, string | undefined>;
777
672
  region: {
778
673
  id: number;
779
- name: Record<Locales, string | undefined>;
674
+ name: Record<Locales, string>;
780
675
  };
781
676
  slug: string;
782
677
  timezone: RealmTimezone;
783
678
  type: {
784
- name: Record<Locales, string | undefined>;
679
+ name: Record<Locales, string>;
785
680
  type: RealmTypeCapitalized;
786
681
  };
787
682
  }
@@ -791,9 +686,8 @@ interface SearchRealmPopulation {
791
686
  }
792
687
  interface SearchRealmStatus {
793
688
  name: Record<Locales, string>;
794
- type: Uppercase<RealmStatus>;
689
+ type: RealmStatusCapitalized;
795
690
  }
796
-
797
691
  //#endregion
798
692
  //#region src/connected-realm/connected-realm.d.ts
799
693
  /**
@@ -813,12 +707,11 @@ declare function connectedRealmIndex(namespace: Extract<BlizzardNamespaces, 'dyn
813
707
  * Performs a search of connected realms.
814
708
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
815
709
  * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
816
- * @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
710
+ * @returns The search results. See {@link ConnectedRealmSearchResponse}.
817
711
  */
818
- declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: ConnectedRealmSearchParameters): Resource<SearchResponse<ConnectedRealmSearchResponseItem>, ConnectedRealmSearchParameters>;
819
-
712
+ declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
820
713
  //#endregion
821
- //#region ../wow/src/creature/types.d.ts
714
+ //#region src/creature/types.d.ts
822
715
  /**
823
716
  * The response for creature display media.
824
717
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -839,7 +732,7 @@ interface CreatureFamilyIndexResponse extends ResponseBase {
839
732
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
840
733
  */
841
734
  interface CreatureFamilyMediaResponse extends ResponseBase {
842
- assets: Array<MediaAsset$1>;
735
+ assets: Array<MediaAsset>;
843
736
  id: number;
844
737
  }
845
738
  /**
@@ -848,9 +741,9 @@ interface CreatureFamilyMediaResponse extends ResponseBase {
848
741
  */
849
742
  interface CreatureFamilyResponse extends ResponseBase {
850
743
  id: number;
851
- media: Media$3;
744
+ media?: Media$3;
852
745
  name: string;
853
- specialization: NameIdKey;
746
+ specialization?: NameIdKey;
854
747
  }
855
748
  /**
856
749
  * The response for a creature.
@@ -878,23 +771,8 @@ interface CreatureSearchParameters extends BaseSearchParameters {
878
771
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
879
772
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
880
773
  */
881
- interface CreatureSearchResponseItem extends KeyBase {
882
- data: {
883
- creature_displays: Array<{
884
- id: number;
885
- }>;
886
- family?: {
887
- id: number;
888
- name: Record<Locales, string | undefined>;
889
- };
890
- id: number;
891
- is_tameable: boolean;
892
- name: Record<Locales, string | undefined>;
893
- type: {
894
- id: number;
895
- name: Record<Locales, string | undefined>;
896
- };
897
- };
774
+ interface CreatureSearchResponse extends SearchResponseWithoutResults {
775
+ results: Array<CreatureSearchResponseItem>;
898
776
  }
899
777
  /**
900
778
  * The response for a creature type index.
@@ -914,6 +792,24 @@ interface CreatureTypeResponse extends ResponseBase {
914
792
  interface CreatureDisplay extends KeyBase {
915
793
  id: number;
916
794
  }
795
+ interface CreatureSearchResponseItem extends KeyBase {
796
+ data: {
797
+ creature_displays: Array<{
798
+ id: number;
799
+ }>;
800
+ family?: {
801
+ id: number;
802
+ name: Record<Locales, string>;
803
+ };
804
+ id: number;
805
+ is_tameable: boolean;
806
+ name: Record<Locales, string | undefined>;
807
+ type: {
808
+ id: number;
809
+ name: Record<Locales, string>;
810
+ };
811
+ };
812
+ }
917
813
  interface DisplayMediaAsset {
918
814
  key: string;
919
815
  value: string;
@@ -921,7 +817,6 @@ interface DisplayMediaAsset {
921
817
  interface Media$3 extends KeyBase {
922
818
  id: number;
923
819
  }
924
-
925
820
  //#endregion
926
821
  //#region src/creature/creature.d.ts
927
822
  /**
@@ -962,9 +857,9 @@ declare function creatureFamilyMedia(namespace: Extract<BlizzardNamespaces, 'sta
962
857
  * Performs a search of creatures.
963
858
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
964
859
  * @param options The creature search parameters. See {@link CreatureSearchParameters}.
965
- * @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
860
+ * @returns The creature search results. See {@link CreatureSearchResponse}.
966
861
  */
967
- declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: CreatureSearchParameters): Resource<SearchResponse<CreatureSearchResponseItem>, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
862
+ declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: CreatureSearchParameters): Resource<CreatureSearchResponse, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
968
863
  /**
969
864
  * Returns a creature type by ID.
970
865
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
@@ -978,9 +873,8 @@ declare function creatureType(namespace: Extract<BlizzardNamespaces, 'static-cla
978
873
  * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
979
874
  */
980
875
  declare function creatureTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<CreatureTypeIndexResponse>;
981
-
982
876
  //#endregion
983
- //#region ../wow/src/guild-crest/types.d.ts
877
+ //#region src/guild-crest/types.d.ts
984
878
  /**
985
879
  * The response for a guild crest border or emblem.
986
880
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1000,16 +894,16 @@ interface GuildCrestComponentsIndexResponse extends ResponseBase {
1000
894
  }
1001
895
  interface Background {
1002
896
  id: number;
1003
- rgba: RGBA;
897
+ rgba: Color;
1004
898
  }
1005
899
  interface Border$1 {
1006
900
  id: number;
1007
901
  media: Media$2;
1008
902
  }
1009
903
  interface Colors {
1010
- backgrounds: Array<Background>;
1011
- borders: Array<Background>;
1012
- emblems: Array<Background>;
904
+ backgrounds?: Array<Background>;
905
+ borders?: Array<Background>;
906
+ emblems?: Array<Background>;
1013
907
  }
1014
908
  interface GuildCrestAsset {
1015
909
  key: string;
@@ -1018,13 +912,6 @@ interface GuildCrestAsset {
1018
912
  interface Media$2 extends KeyBase {
1019
913
  id: number;
1020
914
  }
1021
- interface RGBA {
1022
- a: number;
1023
- b: number;
1024
- g: number;
1025
- r: number;
1026
- }
1027
-
1028
915
  //#endregion
1029
916
  //#region src/guild-crest/guild-crest.d.ts
1030
917
  /**
@@ -1047,37 +934,54 @@ declare function guildCrestComponentsIndex(namespace: Extract<BlizzardNamespaces
1047
934
  * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
1048
935
  */
1049
936
  declare function guildCrestEmblem(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
1050
-
1051
937
  //#endregion
1052
- //#region ../wow/src/guild/types.d.ts
938
+ //#region src/guild/types.d.ts
939
+ interface GuildAchievementsClassicEraResponse extends ResponseBase {
940
+ guild: Guild;
941
+ }
1053
942
  interface GuildAchievementsResponse extends ResponseBase {
1054
943
  achievements: Array<Achievement>;
1055
944
  category_progress: Array<CategoryProgress>;
1056
- guild: Guild$1;
945
+ guild: Guild;
1057
946
  recent_events: Array<RecentEvent>;
1058
947
  total_points: number;
1059
948
  total_quantity: number;
1060
949
  }
1061
- interface GuildResponse$1 extends ResponseBase {
950
+ interface GuildActivityResponse extends ResponseBase {
951
+ activities?: Array<ActivityElement>;
952
+ guild: Guild;
953
+ }
954
+ interface GuildResponse extends ResponseBase {
1062
955
  achievement_points: number;
1063
956
  achievements: Href;
1064
957
  activity: Href;
1065
958
  created_timestamp: number;
1066
- crest: Crest;
959
+ crest?: Crest;
1067
960
  faction: Faction;
1068
961
  id: number;
1069
962
  member_count: number;
1070
963
  name: string;
1071
964
  name_search: string;
1072
- realm: Realm$1;
965
+ realm: Realm;
1073
966
  roster: Href;
1074
967
  }
968
+ interface GuildRosterResponse extends ResponseBase {
969
+ guild: Guild;
970
+ members: Array<Member>;
971
+ }
1075
972
  interface Achievement {
1076
973
  achievement: NameIdKey;
1077
974
  completed_timestamp?: number;
1078
975
  criteria?: Criteria;
1079
976
  id: number;
1080
977
  }
978
+ interface ActivityElement {
979
+ activity: {
980
+ type: string;
981
+ };
982
+ character_achievement: CharacterAchievement;
983
+ timestamp: number;
984
+ }
1081
985
  interface Border {
1082
986
  color: RgbWithId;
1083
987
  id: number;
@@ -1090,6 +994,15 @@ interface CategoryProgress {
1090
994
  points: number;
1091
995
  quantity: number;
1092
996
  }
997
+ interface CharacterAchievement {
998
+ achievement: NameIdKey;
999
+ character: Character;
1000
+ }
1001
+ interface ChildCriterum {
1002
+ amount: number;
1003
+ id: number;
1004
+ is_completed: boolean;
1005
+ }
1093
1006
  interface Crest {
1094
1007
  background: {
1095
1008
  color: RgbWithId;
@@ -1099,53 +1012,13 @@ interface Crest {
1099
1012
  }
1100
1013
  interface Criteria {
1101
1014
  amount?: number;
1102
- child_criteria?: Array<Criteria>;
1015
+ child_criteria?: Array<ChildCriterum>;
1103
1016
  id: number;
1104
1017
  is_completed: boolean;
1105
1018
  }
1106
- interface Guild$1 extends NameIdKey {
1107
- faction: Faction;
1108
- realm: Realm$1;
1109
- }
1110
- interface RecentEvent {
1111
- achievement: NameIdKey;
1112
- timestamp: number;
1113
- }
1114
- interface RgbWithId {
1115
- id: number;
1116
- rgba: Color;
1117
- }
1118
-
1119
- //#endregion
1120
- //#region src/guild/types.d.ts
1121
- interface GuildAchievementsClassicEraResponse extends ResponseBase {
1122
- guild: Guild;
1123
- }
1124
- interface GuildActivityResponse extends ResponseBase {
1125
- activities?: Array<ActivityElement>;
1126
- guild: Guild;
1127
- }
1128
- type GuildResponse = Omit<GuildResponse$1, 'crest'> & {
1129
- crest?: GuildResponse$1['crest'];
1130
- };
1131
- interface GuildRosterResponse extends ResponseBase {
1132
- guild: Guild;
1133
- members: Array<Member>;
1134
- }
1135
- interface ActivityElement {
1136
- activity: {
1137
- type: string;
1138
- };
1139
- character_achievement: CharacterAchievement;
1140
- timestamp: number;
1141
- }
1142
- interface CharacterAchievement {
1143
- achievement: NameIdKey;
1144
- character: Character;
1145
- }
1146
1019
  interface Guild extends NameIdKey {
1147
1020
  faction: Faction;
1148
- realm: Realm$1;
1021
+ realm: Realm;
1149
1022
  }
1150
1023
  interface Member {
1151
1024
  character: RosterMemberCharacter;
@@ -1154,12 +1027,19 @@ interface Member {
1154
1027
  interface Playable extends KeyBase {
1155
1028
  id: number;
1156
1029
  }
1030
+ interface RecentEvent {
1031
+ achievement: NameIdKey;
1032
+ timestamp: number;
1033
+ }
1034
+ interface RgbWithId {
1035
+ id: number;
1036
+ rgba: Color;
1037
+ }
1157
1038
  interface RosterMemberCharacter extends Character {
1158
1039
  level: number;
1159
1040
  playable_class: Playable;
1160
1041
  playable_race: Playable;
1161
1042
  }
1162
-
1163
1043
  //#endregion
1164
1044
  //#region src/guild/guild.d.ts
1165
1045
  /**
@@ -1190,9 +1070,8 @@ declare function guildActivity(namespace: Extract<BlizzardNamespaces, 'profile-c
1190
1070
  * @returns a single guild's roster by its name and realm.
1191
1071
  */
1192
1072
  declare function guildRoster(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
1193
-
1194
1073
  //#endregion
1195
- //#region ../wow/src/item/types.d.ts
1074
+ //#region src/item/types.d.ts
1196
1075
  /**
1197
1076
  * The response for an item class index.
1198
1077
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1214,7 +1093,7 @@ interface ItemClassResponse extends ResponseBase {
1214
1093
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1215
1094
  */
1216
1095
  interface ItemMediaResponse extends ResponseBase {
1217
- assets: Array<MediaAsset$1>;
1096
+ assets: Array<MediaAsset>;
1218
1097
  id: number;
1219
1098
  }
1220
1099
  /**
@@ -1252,38 +1131,9 @@ interface ItemSearchParameters extends BaseSearchParameters {
1252
1131
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1253
1132
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1254
1133
  */
1255
- interface ItemSearchResponseItem extends KeyBase {
1256
- data: {
1257
- id: number;
1258
- inventory_type: InventoryType;
1259
- is_equippable: boolean;
1260
- is_stackable: boolean;
1261
- item_class: {
1262
- id: number;
1263
- name: Record<Locales, string | undefined>;
1264
- };
1265
- item_subclass: {
1266
- id: number;
1267
- name: Record<Locales, string | undefined>;
1268
- };
1269
- level: number;
1270
- max_count: number;
1271
- media: {
1272
- id: number;
1273
- };
1274
- name: Record<Locales, string | undefined>;
1275
- purchase_price: number;
1276
- purchase_quantity: number;
1277
- quality: ItemQuality;
1278
- required_level: number;
1279
- sell_price: number;
1280
- };
1134
+ interface ItemSearchResponse extends SearchResponseWithoutResults {
1135
+ results: Array<ItemSearchResponseItem>;
1281
1136
  }
1282
- /**
1283
- * The response for an item set index.
1284
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1285
- */
1286
-
1287
1137
  /**
1288
1138
  * The response for an item subclass.
1289
1139
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1317,13 +1167,40 @@ interface Durability {
1317
1167
  value: number;
1318
1168
  }
1319
1169
  interface InventoryType {
1320
- name: Record<Locales, string | undefined>;
1170
+ name: Record<Locales, string>;
1321
1171
  type: 'BACK' | 'BAG' | 'CHEST' | 'FEET' | 'FINGER' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'NON_EQUIP' | 'SHIRT' | 'SHOULDER' | 'TABARD' | 'TRINKET' | 'TWOHWEAPON' | 'WAIST' | 'WRIST';
1322
1172
  }
1323
1173
  interface ItemQuality {
1324
- name: Record<Locales, string | undefined>;
1174
+ name: Record<Locales, string>;
1325
1175
  type: 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
1326
1176
  }
1177
+ interface ItemSearchResponseItem extends KeyBase {
1178
+ data: {
1179
+ id: number;
1180
+ inventory_type: InventoryType;
1181
+ is_equippable: boolean;
1182
+ is_stackable: boolean;
1183
+ item_class: {
1184
+ id: number;
1185
+ name: Record<Locales, string>;
1186
+ };
1187
+ item_subclass: {
1188
+ id: number;
1189
+ name: Record<Locales, string>;
1190
+ };
1191
+ level: number;
1192
+ max_count: number;
1193
+ media: {
1194
+ id: number;
1195
+ };
1196
+ name: Record<Locales, string>;
1197
+ purchase_price: number;
1198
+ purchase_quantity: number;
1199
+ quality: ItemQuality;
1200
+ required_level: number;
1201
+ sell_price: number;
1202
+ };
1203
+ }
1327
1204
  interface Media$1 extends KeyBase {
1328
1205
  id: number;
1329
1206
  }
@@ -1416,7 +1293,6 @@ interface Weapon {
1416
1293
  damage: Damage;
1417
1294
  dps: Durability;
1418
1295
  }
1419
-
1420
1296
  //#endregion
1421
1297
  //#region src/item/item.d.ts
1422
1298
  /**
@@ -1450,9 +1326,9 @@ declare function itemMedia(namespace: Extract<BlizzardNamespaces, 'static-classi
1450
1326
  * Search for items.
1451
1327
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1452
1328
  * @param options The search parameters. See {@link ItemSearchParameters}.
1453
- * @returns The search results. See {@link SearchResponse}.
1329
+ * @returns The search results. See {@link ItemSearchResponse}.
1454
1330
  */
1455
- declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, 'locale' | 'name'>>;
1331
+ declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: ItemSearchParameters): Resource<ItemSearchResponse, Omit<ItemSearchParameters, 'locale' | 'name'>>;
1456
1332
  /**
1457
1333
  * Get an item subclass by ID.
1458
1334
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
@@ -1461,9 +1337,8 @@ declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-class
1461
1337
  * @returns The item subclass. See {@link ItemSubClassResponse}.
1462
1338
  */
1463
1339
  declare function itemSubClass(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
1464
-
1465
1340
  //#endregion
1466
- //#region ../wow/src/media-search/types.d.ts
1341
+ //#region src/media-search/types.d.ts
1467
1342
  /**
1468
1343
  * The search parameters for media.
1469
1344
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1477,30 +1352,26 @@ interface MediaSearchParameters extends BaseSearchParameters {
1477
1352
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1478
1353
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
1479
1354
  */
1355
+ interface MediaSearchResponse extends SearchResponseWithoutResults {
1356
+ results: Array<MediaSearchResponseItem>;
1357
+ }
1480
1358
  interface MediaSearchResponseItem extends KeyBase {
1481
1359
  data: {
1482
1360
  assets: Array<MediaAsset>;
1483
1361
  id: number;
1484
1362
  };
1485
1363
  }
1486
- interface MediaAsset {
1487
- file_data_id: number;
1488
- key: string;
1489
- value: string;
1490
- }
1491
-
1492
1364
  //#endregion
1493
1365
  //#region src/media-search/media-search.d.ts
1494
1366
  /**
1495
1367
  * Search for media.
1496
1368
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1497
1369
  * @param options The search parameters. See {@link MediaSearchParameters}.
1498
- * @returns The search results. See {@link SearchResponse}.
1370
+ * @returns The search results. See {@link MediaSearchResponse}.
1499
1371
  */
1500
- declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: MediaSearchParameters): Resource<SearchResponse<MediaSearchResponseItem>, MediaSearchParameters>;
1501
-
1372
+ declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
1502
1373
  //#endregion
1503
- //#region ../wow/src/playable-class/types.d.ts
1374
+ //#region src/playable-class/types.d.ts
1504
1375
  /**
1505
1376
  * The response for a playable class index.
1506
1377
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1513,33 +1384,25 @@ interface PlayableClassIndexResponse extends ResponseBase {
1513
1384
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1514
1385
  */
1515
1386
  interface PlayableClassMediaResponse extends ResponseBase {
1516
- assets: Array<MediaAsset$1>;
1387
+ assets: Array<MediaAsset>;
1517
1388
  id: number;
1518
1389
  }
1519
-
1520
- //#endregion
1521
- //#region src/playable-class/types.d.ts
1522
- /**
1523
- * The response for a playable class.
1524
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1525
- */
1526
1390
  /**
1527
1391
  * The response for a playable class.
1528
1392
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft-classic/game-data-apis}
1529
1393
  */
1530
1394
  interface PlayableClassResponse extends NameId, ResponseBase {
1395
+ additional_power_types?: Array<NameIdKey>;
1531
1396
  gender_name: GenderName;
1532
1397
  media: Media;
1533
1398
  playable_races: Array<NameIdKey>;
1534
1399
  power_type: NameIdKey;
1535
- pvp_talent_slots: {
1536
- href: string;
1537
- };
1400
+ pvp_talent_slots: Href;
1401
+ specializations?: Array<NameIdKey>;
1538
1402
  }
1539
1403
  interface Media extends KeyBase {
1540
1404
  id: number;
1541
1405
  }
1542
-
1543
1406
  //#endregion
1544
1407
  //#region src/playable-class/playable-class.d.ts
1545
1408
  /**
@@ -1562,9 +1425,8 @@ declare function playableClassIndex(namespace: Extract<BlizzardNamespaces, 'stat
1562
1425
  * @returns The playable class media. See {@link PlayableClassMediaResponse}.
1563
1426
  */
1564
1427
  declare function playableClassMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableClassId: number): Resource<PlayableClassMediaResponse>;
1565
-
1566
1428
  //#endregion
1567
- //#region ../wow/src/playable-race/types.d.ts
1429
+ //#region src/playable-race/types.d.ts
1568
1430
  /**
1569
1431
  * The playable race index response.
1570
1432
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1582,8 +1444,8 @@ interface PlayableRaceResponse extends NameId, ResponseBase {
1582
1444
  is_allied_race: boolean;
1583
1445
  is_selectable: boolean;
1584
1446
  playable_classes: Array<NameIdKey>;
1447
+ racial_spells: Array<NameIdKey>;
1585
1448
  }
1586
-
1587
1449
  //#endregion
1588
1450
  //#region src/playable-race/playable-race.d.ts
1589
1451
  /**
@@ -1599,9 +1461,8 @@ declare function playableRace(namespace: Extract<BlizzardNamespaces, 'static-cla
1599
1461
  * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
1600
1462
  */
1601
1463
  declare function playableRaceIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PlayableRaceIndexResponse>;
1602
-
1603
1464
  //#endregion
1604
- //#region ../wow/src/power-type/types.d.ts
1465
+ //#region src/power-type/types.d.ts
1605
1466
  /**
1606
1467
  * The response for a power type index.
1607
1468
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1614,7 +1475,6 @@ interface PowerTypeIndexResponse extends ResponseBase {
1614
1475
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1615
1476
  */
1616
1477
  interface PowerTypeResponse extends NameId, ResponseBase {}
1617
-
1618
1478
  //#endregion
1619
1479
  //#region src/power-type/power-type.d.ts
1620
1480
  /**
@@ -1630,9 +1490,8 @@ declare function powerType(namespace: Extract<BlizzardNamespaces, 'static-classi
1630
1490
  * @returns The power type index. See {@link PowerTypeIndexResponse}.
1631
1491
  */
1632
1492
  declare function powerTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PowerTypeIndexResponse>;
1633
-
1634
1493
  //#endregion
1635
- //#region ../wow/src/pvp-season/types.d.ts
1494
+ //#region src/pvp-season/types.d.ts
1636
1495
  /**
1637
1496
  * The response for a PvP season index.
1638
1497
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -1647,19 +1506,14 @@ interface PvpSeasonIndexResponse extends ResponseBase {
1647
1506
  */
1648
1507
  interface PvpSeasonResponse extends ResponseBase {
1649
1508
  id: number;
1650
- leaderboards: {
1651
- href: string;
1652
- };
1653
- rewards: {
1654
- href: string;
1655
- };
1509
+ leaderboards: Href;
1510
+ rewards: Href;
1656
1511
  season_name?: string;
1657
1512
  season_start_timestamp: number;
1658
1513
  }
1659
1514
  interface Season extends KeyBase {
1660
1515
  id: number;
1661
1516
  }
1662
-
1663
1517
  //#endregion
1664
1518
  //#region src/pvp-season/pvp-season.d.ts
1665
1519
  /**
@@ -1721,7 +1575,6 @@ declare function pvpSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-class
1721
1575
  * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
1722
1576
  */
1723
1577
  declare function pvpSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<PvpSeasonIndexResponse>;
1724
-
1725
1578
  //#endregion
1726
1579
  //#region src/realm/realm.d.ts
1727
1580
  /**
@@ -1741,20 +1594,17 @@ declare function realmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-clas
1741
1594
  * Search for realms.
1742
1595
  * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1743
1596
  * @param options The search parameters. See {@link RealmSearchParameters}.
1744
- * @returns The search results. See {@link SearchResponse}.
1597
+ * @returns The search results. See {@link RealmSearchResponse}.
1745
1598
  */
1746
- declare function realmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: RealmSearchParameters): Resource<SearchResponse<RealmSearchResponseItem>, RealmSearchParameters>;
1747
-
1599
+ declare function realmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: RealmSearchParameters): Resource<RealmSearchResponse, RealmSearchParameters>;
1748
1600
  //#endregion
1749
- //#region ../wow/src/region/types.d.ts
1601
+ //#region src/region/types.d.ts
1750
1602
  /**
1751
1603
  * The response for a region index.
1752
1604
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
1753
1605
  */
1754
1606
  interface RegionIndexResponse extends ResponseBase {
1755
- regions: Array<{
1756
- href: string;
1757
- }>;
1607
+ regions: Array<Href>;
1758
1608
  }
1759
1609
  /**
1760
1610
  * The response for a region.
@@ -1764,7 +1614,6 @@ interface RegionResponse extends NameId, ResponseBase {
1764
1614
  patch_string: string;
1765
1615
  tag: string;
1766
1616
  }
1767
-
1768
1617
  //#endregion
1769
1618
  //#region src/region/region.d.ts
1770
1619
  /**
@@ -1780,7 +1629,6 @@ declare function region(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1
1780
1629
  * @returns The region index. See {@link RegionIndexResponse}.
1781
1630
  */
1782
1631
  declare function regionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<RegionIndexResponse>;
1783
-
1784
1632
  //#endregion
1785
1633
  //#region src/index.d.ts
1786
1634
  declare const classicWow: {
@@ -1841,7 +1689,6 @@ declare const classicWow: {
1841
1689
  region: typeof region;
1842
1690
  regionIndex: typeof regionIndex;
1843
1691
  };
1844
-
1845
1692
  //#endregion
1846
- export { AuctionHouseIndexResponse, AuctionsResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse, CharacterProfileStatusResponse, CharacterProfileSummaryResponse, CharacterSpecializationsSummaryResponse, CharacterStatisticsSummaryResponse, ConnectedRealmIndexResponse, ConnectedRealmResponse, ConnectedRealmSearchParameters, ConnectedRealmSearchResponseItem, CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponseItem, CreatureTypeIndexResponse, CreatureTypeResponse, GuildAchievementsClassicEraResponse, GuildAchievementsResponse, GuildActivityResponse, GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse, GuildResponse, GuildRosterResponse, ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponseItem, ItemSubClassResponse, MediaSearchParameters, MediaSearchResponseItem, PlayableClassIndexResponse, PlayableClassMediaResponse, PlayableClassResponse, PlayableRaceIndexResponse, PlayableRaceResponse, PowerTypeIndexResponse, PowerTypeResponse, PvpSeasonIndexResponse, PvpSeasonResponse, RealmCategory, RealmIndexResponse, RealmResponse, RealmSearchParameters, RealmSearchResponseItem, RealmTimezone, RealmType, RealmTypeCapitalized, RegionIndexResponse, RegionResponse, WithoutUnderscore, auctionHouseIndex, auctions, characterAchievementStatistics, characterAchievementsSummary, characterEquipmentSummary, characterHunterPetsSummary, characterMediaSummary, characterProfileStatus, characterProfileSummary, characterSpecializationsSummary, characterStatisticsSummary, classicWow, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, classicWow as default, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSubClass, mediaSearch, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, powerType, powerTypeIndex, pvpLeaderboard, pvpLeaderboardIndex, pvpRegionIndex, pvpRegionalSeason, pvpRegionalSeasonIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, realm, realmIndex, realmSearch, region, regionIndex };
1693
+ export { AuctionHouseIndexResponse, AuctionsResponse, CharacterAchievementStatisticsResponse, CharacterAchievementsSummaryResponse, CharacterEquipmentSummaryResponse, CharacterHunterPetsSummaryResponse, CharacterMediaSummaryResponse, type CharacterProfileStatusResponse, CharacterProfileSummaryResponse, CharacterSpecializationsSummaryResponse, CharacterStatisticsSummaryResponse, ConnectedRealmIndexResponse, ConnectedRealmResponse, ConnectedRealmSearchParameters, ConnectedRealmSearchResponse, CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponse, CreatureTypeIndexResponse, CreatureTypeResponse, GuildAchievementsClassicEraResponse, GuildAchievementsResponse, GuildActivityResponse, GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse, GuildResponse, GuildRosterResponse, ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponse, ItemSubClassResponse, MediaSearchParameters, MediaSearchResponse, PlayableClassIndexResponse, PlayableClassMediaResponse, PlayableClassResponse, PlayableRaceIndexResponse, PlayableRaceResponse, PowerTypeIndexResponse, PowerTypeResponse, PvpSeasonIndexResponse, PvpSeasonResponse, RealmCategory, RealmIndexResponse, RealmLocales, RealmResponse, RealmSearchParameters, RealmSearchResponse, RealmTimezone, RealmTypeCapitalized, RegionIndexResponse, RegionResponse, auctionHouseIndex, auctions, characterAchievementStatistics, characterAchievementsSummary, characterEquipmentSummary, characterHunterPetsSummary, characterMediaSummary, characterProfileStatus, characterProfileSummary, characterSpecializationsSummary, characterStatisticsSummary, classicWow, classicWow as default, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSubClass, mediaSearch, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, powerType, powerTypeIndex, pvpLeaderboard, pvpLeaderboardIndex, pvpRegionIndex, pvpRegionalSeason, pvpRegionalSeasonIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, realm, realmIndex, realmSearch, region, regionIndex };
1847
1694
  //# sourceMappingURL=index.d.ts.map