@blizzard-api/classic-wow 1.0.0 → 1.1.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,5 +1,4 @@
1
- import * as _blizzard_api_core from '@blizzard-api/core';
2
- import { Locales, BaseSearchParameters } from '@blizzard-api/core';
1
+ import { BlizzardNamespaces, Resource, Locales, BaseSearchParameters, SearchResponse } from '@blizzard-api/core';
3
2
 
4
3
  /**
5
4
  * Base interface for Blizzard API responses.
@@ -92,6 +91,26 @@ interface Auction {
92
91
  time_left: 'SHORT' | 'MEDIUM' | 'LONG' | 'VERY_LONG';
93
92
  }
94
93
 
94
+ /**
95
+ * Returns an index of auction houses for a connected realm.
96
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
97
+ * @param connectedRealmId The ID of the connected realm.
98
+ * @returns The auction house index. See {@link AuctionHouseIndexResponse}.
99
+ */
100
+ declare function auctionHouseIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, connectedRealmId: number): Resource<AuctionHouseIndexResponse>;
101
+ /**
102
+ * Returns all active auctions for a specific auction house on a connected realm.
103
+ *
104
+ * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
105
+ *
106
+ * Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
107
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
108
+ * @param connectedRealmId The ID of the connected realm.
109
+ * @param auctionHouseId The ID of the auction house.
110
+ * @returns The auction house data. See {@link AuctionsResponse}.
111
+ */
112
+ declare function auctions(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, connectedRealmId: number, auctionHouseId: number): Resource<AuctionsResponse>;
113
+
95
114
  type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
96
115
  /**
97
116
  * The category of a realm.
@@ -278,6 +297,27 @@ interface ConnectedRealmSearchResponseItem extends KeyBase {
278
297
  };
279
298
  }
280
299
 
300
+ /**
301
+ * Returns an index of connected realms.
302
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
303
+ * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
304
+ */
305
+ declare function connectedRealmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<ConnectedRealmIndexResponse>;
306
+ /**
307
+ * Returns a connected realm by ID.
308
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
309
+ * @param connectedRealmId The connected realm ID.
310
+ * @returns The connected realm. See {@link ConnectedRealmResponse}.
311
+ */
312
+ declare function connectedRealm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, connectedRealmId: number): Resource<ConnectedRealmResponse>;
313
+ /**
314
+ * Performs a search of connected realms.
315
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
316
+ * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
317
+ * @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
318
+ */
319
+ declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, options: ConnectedRealmSearchParameters): Resource<SearchResponse<ConnectedRealmSearchResponseItem>, ConnectedRealmSearchParameters>;
320
+
281
321
  /**
282
322
  * The response for a creature.
283
323
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -381,6 +421,61 @@ interface CreatureSearchResponseItem extends KeyBase {
381
421
  };
382
422
  }
383
423
 
424
+ /**
425
+ * Returns a creature by ID.
426
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
427
+ * @param creatureId The creature ID.
428
+ * @returns The creature. See {@link CreatureResponse}.
429
+ */
430
+ declare function creature(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureId: number): Resource<CreatureResponse>;
431
+ /**
432
+ * Returns media for a creature display by ID.
433
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
434
+ * @param creatureDisplayId The creature display ID.
435
+ * @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
436
+ */
437
+ declare function creatureDisplayMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureDisplayId: number): Resource<CreatureDisplayMediaResponse>;
438
+ /**
439
+ * Returns a creature family by ID.
440
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
441
+ * @param creatureFamilyId The creature family ID.
442
+ * @returns The creature family. See {@link CreatureFamilyResponse}.
443
+ */
444
+ declare function creatureFamily(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureFamilyId: number): Resource<CreatureFamilyResponse>;
445
+ /**
446
+ * Returns an index of creature families.
447
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
448
+ * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
449
+ */
450
+ declare function creatureFamilyIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<CreatureFamilyIndexResponse>;
451
+ /**
452
+ * Returns media for a creature family by ID.
453
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
454
+ * @param creatureFamilyId The creature family ID.
455
+ * @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
456
+ */
457
+ declare function creatureFamilyMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureFamilyId: number): Resource<CreatureFamilyMediaResponse>;
458
+ /**
459
+ * Returns a creature type by ID.
460
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
461
+ * @param creatureTypeId The creature type ID.
462
+ * @returns The creature type. See {@link CreatureTypeResponse}.
463
+ */
464
+ declare function creatureType(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, creatureTypeId: number): Resource<CreatureTypeResponse>;
465
+ /**
466
+ * Returns an index of creature types.
467
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
468
+ * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
469
+ */
470
+ declare function creatureTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<CreatureTypeIndexResponse>;
471
+ /**
472
+ * Performs a search of creatures.
473
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
474
+ * @param options The creature search parameters. See {@link CreatureSearchParameters}.
475
+ * @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
476
+ */
477
+ declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: CreatureSearchParameters): Resource<SearchResponse<CreatureSearchResponseItem>, Omit<CreatureSearchParameters, 'name' | 'locale'>>;
478
+
384
479
  /**
385
480
  * The response for the guild crest components index.
386
481
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -425,6 +520,27 @@ interface GuildCrestAsset {
425
520
  value: string;
426
521
  }
427
522
 
523
+ /**
524
+ * Returns an index of guild crest media.
525
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
526
+ * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
527
+ */
528
+ declare function guildCrestComponentsIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<GuildCrestComponentsIndexResponse>;
529
+ /**
530
+ * Returns media for a guild crest border by ID.
531
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
532
+ * @param borderId The guild crest border ID.
533
+ * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
534
+ */
535
+ declare function guildCrestBorder(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, borderId: number): Resource<GuildCrestBorderEmblemResponse>;
536
+ /**
537
+ * Returns media for a guild crest emblem by ID.
538
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
539
+ * @param emblemId The guild crest emblem ID.
540
+ * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
541
+ */
542
+ declare function guildCrestEmblem(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
543
+
428
544
  interface ItemQuality {
429
545
  name: Record<Locales, string | undefined>;
430
546
  type: 'POOR' | 'COMMON' | 'UNCOMMON' | 'RARE' | 'EPIC' | 'LEGENDARY' | 'ARTIFACT' | 'HEIRLOOM';
@@ -644,6 +760,49 @@ interface ItemSearchResponseItem extends KeyBase {
644
760
  };
645
761
  }
646
762
 
763
+ /**
764
+ * Get an item class index.
765
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
766
+ * @returns The item class index. See {@link ItemClassIndexResponse}.
767
+ */
768
+ declare function itemClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<ItemClassIndexResponse>;
769
+ /**
770
+ * Get an item class by ID.
771
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
772
+ * @param itemClassId The item class ID.
773
+ * @returns The item class. See {@link ItemClassResponse}.
774
+ */
775
+ declare function itemClass(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemClassId: number): Resource<ItemClassResponse>;
776
+ /**
777
+ * Get an item subclass by ID.
778
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
779
+ * @param itemClassId The item class ID.
780
+ * @param itemSubclassId The item subclass ID.
781
+ * @returns The item subclass. See {@link ItemSubClassResponse}.
782
+ */
783
+ declare function itemSubClass(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
784
+ /**
785
+ * Get an item by ID.
786
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
787
+ * @param itemId The item ID.
788
+ * @returns The item. See {@link ItemResponse}.
789
+ */
790
+ declare function item(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemId: number): Resource<ItemResponse>;
791
+ /**
792
+ * Get item media by ID.
793
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
794
+ * @param itemId The item ID.
795
+ * @returns The item media. See {@link ItemMediaResponse}.
796
+ */
797
+ declare function itemMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, itemId: number): Resource<ItemMediaResponse>;
798
+ /**
799
+ * Search for items.
800
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
801
+ * @param options The search parameters. See {@link ItemSearchParameters}.
802
+ * @returns The search results. See {@link SearchResponse}.
803
+ */
804
+ declare function itemSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, 'name' | 'locale'>>;
805
+
647
806
  /**
648
807
  * The search parameters for media.
649
808
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -669,6 +828,13 @@ interface MediaAsset {
669
828
  value: string;
670
829
  }
671
830
 
831
+ /**
832
+ * Search for media.
833
+ * @param options The search parameters. See {@link MediaSearchParameters}.
834
+ * @returns The search results. See {@link SearchResponse}.
835
+ */
836
+ declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, options: MediaSearchParameters): Resource<SearchResponse<MediaSearchResponseItem>, MediaSearchParameters>;
837
+
672
838
  /**
673
839
  * The response for a playable class index.
674
840
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -702,6 +868,27 @@ interface Media extends KeyBase {
702
868
  id: number;
703
869
  }
704
870
 
871
+ /**
872
+ * Get a playable class by ID.
873
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
874
+ * @param playableClassId The playable class ID.
875
+ * @returns The playable class. See {@link PlayableClassResponse}.
876
+ */
877
+ declare function playableClass(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, playableClassId: number): Resource<PlayableClassResponse>;
878
+ /**
879
+ * Get a playable class index.
880
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
881
+ * @returns The playable class index. See {@link PlayableClassIndexResponse}.
882
+ */
883
+ declare function playableClassIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<PlayableClassIndexResponse>;
884
+ /**
885
+ * Get playable class media by ID.
886
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
887
+ * @param playableClassId The playable class ID.
888
+ * @returns The playable class media. See {@link PlayableClassMediaResponse}.
889
+ */
890
+ declare function playableClassMedia(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, playableClassId: number): Resource<PlayableClassMediaResponse>;
891
+
705
892
  /**
706
893
  * The playable race index response.
707
894
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -721,6 +908,20 @@ interface PlayableRaceResponse extends ResponseBase, NameId {
721
908
  playable_classes: Array<NameIdKey>;
722
909
  }
723
910
 
911
+ /**
912
+ * Get a playable race by ID.
913
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
914
+ * @param playableRaceId The playable race ID.
915
+ * @returns The playable race. See {@link PlayableRaceResponse}.
916
+ */
917
+ declare function playableRace(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, playableRaceId: number): Resource<PlayableRaceResponse>;
918
+ /**
919
+ * Get a playable race index.
920
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
921
+ * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
922
+ */
923
+ declare function playableRaceIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<PlayableRaceIndexResponse>;
924
+
724
925
  /**
725
926
  * The response for a power type index.
726
927
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -735,6 +936,20 @@ interface PowerTypeIndexResponse extends ResponseBase {
735
936
  interface PowerTypeResponse extends ResponseBase, NameId {
736
937
  }
737
938
 
939
+ /**
940
+ * Get a power type by ID.
941
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
942
+ * @param powerTypeId The power type ID.
943
+ * @returns The power type. See {@link PowerTypeResponse}.
944
+ */
945
+ declare function powerType(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>, powerTypeId: number): Resource<PowerTypeResponse>;
946
+ /**
947
+ * Get a power type index.
948
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
949
+ * @returns The power type index. See {@link PowerTypeIndexResponse}.
950
+ */
951
+ declare function powerTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic' | 'static-classic1x'>): Resource<PowerTypeIndexResponse>;
952
+
738
953
  /**
739
954
  * The response for a PvP season index.
740
955
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -762,6 +977,81 @@ interface PvpSeasonResponse extends ResponseBase {
762
977
  season_name?: string;
763
978
  }
764
979
 
980
+ /**
981
+ * Get a PvP season index.
982
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
983
+ * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
984
+ */
985
+ declare function pvpSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<PvpSeasonIndexResponse>;
986
+ /**
987
+ * Get a PvP season by ID.
988
+ * @param pvpSeasonId The PvP season ID.
989
+ * @returns The PvP season. See {@link PvpSeasonResponse}.
990
+ */
991
+ declare function pvpSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpSeasonId: number): Resource<PvpSeasonResponse>;
992
+ /**
993
+ * Returns an index of PvP Regions.
994
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
995
+ */
996
+ declare function pvpRegionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<unknown>;
997
+ /**
998
+ * Returns an index of PvP Seasons in a PvP region.
999
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1000
+ * @param pvpRegionId The PvP region ID.
1001
+ * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
1002
+ */
1003
+ declare function pvpRegionalSeasonIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number): Resource<PvpSeasonIndexResponse>;
1004
+ /**
1005
+ * Returns a PvP season by region ID and season ID.
1006
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1007
+ * @param pvpRegionId The PvP region ID.
1008
+ * @param pvpSeasonId The PvP season ID.
1009
+ */
1010
+ declare function pvpRegionalSeason(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
1011
+ /**
1012
+ * Returns an index of PvP leaderboards for a PvP season in a given PvP region.
1013
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1014
+ * @param pvpRegionId The PvP region ID.
1015
+ * @param pvpSeasonId The PvP season ID.
1016
+ */
1017
+ declare function pvpLeaderboardIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
1018
+ /**
1019
+ * Get a PvP leaderboard by PvP season ID and bracket.
1020
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1021
+ * @param pvpRegionId The PvP region ID.
1022
+ * @param pvpSeasonId The PvP season ID.
1023
+ * @param pvpBracket The PvP bracket.
1024
+ */
1025
+ declare function pvpLeaderboard(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number, pvpBracket: string): Resource<unknown>;
1026
+ /**
1027
+ * Returns an index of PvP rewards for a PvP season in a given PvP region.
1028
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1029
+ * @param pvpRegionId The PvP region ID.
1030
+ * @param pvpSeasonId The PvP season ID.
1031
+ */
1032
+ declare function pvpRewardsIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, pvpRegionId: number, pvpSeasonId: number): Resource<unknown>;
1033
+
1034
+ /**
1035
+ * Get a realm by slug.
1036
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1037
+ * @param realmSlug The realm slug.
1038
+ * @returns The realm. See {@link RealmResponse}.
1039
+ */
1040
+ declare function realm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, realmSlug: string): Resource<RealmResponse>;
1041
+ /**
1042
+ * Get a realm index.
1043
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1044
+ * @returns The realm index. See {@link RealmIndexResponse}.
1045
+ */
1046
+ declare function realmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<RealmIndexResponse>;
1047
+ /**
1048
+ * Search for realms.
1049
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1050
+ * @param options The search parameters. See {@link RealmSearchParameters}.
1051
+ * @returns The search results. See {@link SearchResponse}.
1052
+ */
1053
+ declare function realmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, options: RealmSearchParameters): Resource<SearchResponse<RealmSearchResponseItem>, RealmSearchParameters>;
1054
+
765
1055
  /**
766
1056
  * The response for a region index.
767
1057
  * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
@@ -780,265 +1070,64 @@ interface RegionResponse extends ResponseBase, NameId {
780
1070
  patch_string: string;
781
1071
  }
782
1072
 
1073
+ /**
1074
+ * Get a region by ID.
1075
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1076
+ * @param regionId The region ID.
1077
+ * @returns The region. See {@link RegionResponse}.
1078
+ */
1079
+ declare function region(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>, regionId: number): Resource<RegionResponse>;
1080
+ /**
1081
+ * Get a region index.
1082
+ * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
1083
+ * @returns The region index. See {@link RegionIndexResponse}.
1084
+ */
1085
+ declare function regionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic' | 'dynamic-classic1x'>): Resource<RegionIndexResponse>;
1086
+
783
1087
  declare const classicWow: {
784
- region: (namespace: "dynamic-classic" | "dynamic-classic1x", regionId: number) => {
785
- path: string;
786
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
787
- parameters?: Record<string, never> | undefined;
788
- _responseType?: RegionResponse | undefined;
789
- };
790
- regionIndex: (namespace: "dynamic-classic" | "dynamic-classic1x") => {
791
- path: string;
792
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
793
- parameters?: Record<string, never> | undefined;
794
- _responseType?: RegionIndexResponse | undefined;
795
- };
796
- realm: (namespace: "dynamic-classic" | "dynamic-classic1x", realmSlug: string) => {
797
- path: string;
798
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
799
- parameters?: Record<string, never> | undefined;
800
- _responseType?: RealmResponse | undefined;
801
- };
802
- realmIndex: (namespace: "dynamic-classic" | "dynamic-classic1x") => {
803
- path: string;
804
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
805
- parameters?: Record<string, never> | undefined;
806
- _responseType?: RealmIndexResponse | undefined;
807
- };
808
- realmSearch: (namespace: "dynamic-classic" | "dynamic-classic1x", options: RealmSearchParameters) => {
809
- path: string;
810
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
811
- parameters?: RealmSearchParameters | undefined;
812
- _responseType?: _blizzard_api_core.SearchResponse<RealmSearchResponseItem> | undefined;
813
- };
814
- pvpSeasonIndex: (namespace: "dynamic-classic" | "dynamic-classic1x") => {
815
- path: string;
816
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
817
- parameters?: Record<string, never> | undefined;
818
- _responseType?: PvpSeasonIndexResponse | undefined;
819
- };
820
- pvpSeason: (namespace: "dynamic-classic" | "dynamic-classic1x", pvpSeasonId: number) => {
821
- path: string;
822
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
823
- parameters?: Record<string, never> | undefined;
824
- _responseType?: PvpSeasonResponse | undefined;
825
- };
826
- pvpRegionIndex: (namespace: "dynamic-classic" | "dynamic-classic1x") => {
827
- path: string;
828
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
829
- parameters?: Record<string, never> | undefined;
830
- _responseType?: unknown;
831
- };
832
- pvpRegionalSeasonIndex: (namespace: "dynamic-classic" | "dynamic-classic1x", pvpRegionId: number) => {
833
- path: string;
834
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
835
- parameters?: Record<string, never> | undefined;
836
- _responseType?: PvpSeasonIndexResponse | undefined;
837
- };
838
- pvpRegionalSeason: (namespace: "dynamic-classic" | "dynamic-classic1x", pvpRegionId: number, pvpSeasonId: number) => {
839
- path: string;
840
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
841
- parameters?: Record<string, never> | undefined;
842
- _responseType?: unknown;
843
- };
844
- pvpLeaderboardIndex: (namespace: "dynamic-classic" | "dynamic-classic1x", pvpRegionId: number, pvpSeasonId: number) => {
845
- path: string;
846
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
847
- parameters?: Record<string, never> | undefined;
848
- _responseType?: unknown;
849
- };
850
- pvpLeaderboard: (namespace: "dynamic-classic" | "dynamic-classic1x", pvpRegionId: number, pvpSeasonId: number, pvpBracket: string) => {
851
- path: string;
852
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
853
- parameters?: Record<string, never> | undefined;
854
- _responseType?: unknown;
855
- };
856
- pvpRewardsIndex: (namespace: "dynamic-classic" | "dynamic-classic1x", pvpRegionId: number, pvpSeasonId: number) => {
857
- path: string;
858
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
859
- parameters?: Record<string, never> | undefined;
860
- _responseType?: unknown;
861
- };
862
- powerType: (namespace: "static-classic" | "static-classic1x", powerTypeId: number) => {
863
- path: string;
864
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
865
- parameters?: Record<string, never> | undefined;
866
- _responseType?: PowerTypeResponse | undefined;
867
- };
868
- powerTypeIndex: (namespace: "static-classic" | "static-classic1x") => {
869
- path: string;
870
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
871
- parameters?: Record<string, never> | undefined;
872
- _responseType?: PowerTypeIndexResponse | undefined;
873
- };
874
- playableRace: (namespace: "static-classic" | "static-classic1x", playableRaceId: number) => {
875
- path: string;
876
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
877
- parameters?: Record<string, never> | undefined;
878
- _responseType?: PlayableRaceResponse | undefined;
879
- };
880
- playableRaceIndex: (namespace: "static-classic" | "static-classic1x") => {
881
- path: string;
882
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
883
- parameters?: Record<string, never> | undefined;
884
- _responseType?: PlayableRaceIndexResponse | undefined;
885
- };
886
- playableClass: (namespace: "static-classic" | "static-classic1x", playableClassId: number) => {
887
- path: string;
888
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
889
- parameters?: Record<string, never> | undefined;
890
- _responseType?: PlayableClassResponse | undefined;
891
- };
892
- playableClassIndex: (namespace: "static-classic" | "static-classic1x") => {
893
- path: string;
894
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
895
- parameters?: Record<string, never> | undefined;
896
- _responseType?: PlayableClassIndexResponse | undefined;
897
- };
898
- playableClassMedia: (namespace: "static-classic" | "static-classic1x", playableClassId: number) => {
899
- path: string;
900
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
901
- parameters?: Record<string, never> | undefined;
902
- _responseType?: PlayableClassMediaResponse | undefined;
903
- };
904
- mediaSearch: (namespace: "static-classic" | "static-classic1x", options: MediaSearchParameters) => {
905
- path: string;
906
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
907
- parameters?: MediaSearchParameters | undefined;
908
- _responseType?: _blizzard_api_core.SearchResponse<MediaSearchResponseItem> | undefined;
909
- };
910
- itemClassIndex: (namespace: "static-classic" | "static-classic1x") => {
911
- path: string;
912
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
913
- parameters?: Record<string, never> | undefined;
914
- _responseType?: ItemClassIndexResponse | undefined;
915
- };
916
- itemClass: (namespace: "static-classic" | "static-classic1x", itemClassId: number) => {
917
- path: string;
918
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
919
- parameters?: Record<string, never> | undefined;
920
- _responseType?: ItemClassResponse | undefined;
921
- };
922
- itemSubClass: (namespace: "static-classic" | "static-classic1x", itemClassId: number, itemSubclassId: number) => {
923
- path: string;
924
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
925
- parameters?: Record<string, never> | undefined;
926
- _responseType?: ItemSubClassResponse | undefined;
927
- };
928
- item: (namespace: "static-classic" | "static-classic1x", itemId: number) => {
929
- path: string;
930
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
931
- parameters?: Record<string, never> | undefined;
932
- _responseType?: ItemResponse | undefined;
933
- };
934
- itemMedia: (namespace: "static-classic" | "static-classic1x", itemId: number) => {
935
- path: string;
936
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
937
- parameters?: Record<string, never> | undefined;
938
- _responseType?: ItemMediaResponse | undefined;
939
- };
940
- itemSearch: (namespace: "static-classic" | "static-classic1x", options: ItemSearchParameters) => {
941
- path: string;
942
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
943
- parameters?: Omit<ItemSearchParameters, "name" | "locale"> | undefined;
944
- _responseType?: _blizzard_api_core.SearchResponse<ItemSearchResponseItem> | undefined;
945
- };
946
- guildCrestComponentsIndex: (namespace: "static-classic" | "static-classic1x") => {
947
- path: string;
948
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
949
- parameters?: Record<string, never> | undefined;
950
- _responseType?: GuildCrestComponentsIndexResponse | undefined;
951
- };
952
- guildCrestBorder: (namespace: "static-classic" | "static-classic1x", borderId: number) => {
953
- path: string;
954
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
955
- parameters?: Record<string, never> | undefined;
956
- _responseType?: GuildCrestBorderEmblemResponse | undefined;
957
- };
958
- guildCrestEmblem: (namespace: "static-classic" | "static-classic1x", emblemId: number) => {
959
- path: string;
960
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
961
- parameters?: Record<string, never> | undefined;
962
- _responseType?: GuildCrestBorderEmblemResponse | undefined;
963
- };
964
- creature: (namespace: "static-classic" | "static-classic1x", creatureId: number) => {
965
- path: string;
966
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
967
- parameters?: Record<string, never> | undefined;
968
- _responseType?: CreatureResponse | undefined;
969
- };
970
- creatureDisplayMedia: (namespace: "static-classic" | "static-classic1x", creatureDisplayId: number) => {
971
- path: string;
972
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
973
- parameters?: Record<string, never> | undefined;
974
- _responseType?: CreatureDisplayMediaResponse | undefined;
975
- };
976
- creatureFamily: (namespace: "static-classic" | "static-classic1x", creatureFamilyId: number) => {
977
- path: string;
978
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
979
- parameters?: Record<string, never> | undefined;
980
- _responseType?: CreatureFamilyResponse | undefined;
981
- };
982
- creatureFamilyIndex: (namespace: "static-classic" | "static-classic1x") => {
983
- path: string;
984
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
985
- parameters?: Record<string, never> | undefined;
986
- _responseType?: CreatureFamilyIndexResponse | undefined;
987
- };
988
- creatureFamilyMedia: (namespace: "static-classic" | "static-classic1x", creatureFamilyId: number) => {
989
- path: string;
990
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
991
- parameters?: Record<string, never> | undefined;
992
- _responseType?: CreatureFamilyMediaResponse | undefined;
993
- };
994
- creatureType: (namespace: "static-classic" | "static-classic1x", creatureTypeId: number) => {
995
- path: string;
996
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
997
- parameters?: Record<string, never> | undefined;
998
- _responseType?: CreatureTypeResponse | undefined;
999
- };
1000
- creatureTypeIndex: (namespace: "static-classic" | "static-classic1x") => {
1001
- path: string;
1002
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1003
- parameters?: Record<string, never> | undefined;
1004
- _responseType?: CreatureTypeIndexResponse | undefined;
1005
- };
1006
- creatureSearch: (namespace: "static-classic" | "static-classic1x", options: CreatureSearchParameters) => {
1007
- path: string;
1008
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1009
- parameters?: Omit<CreatureSearchParameters, "name" | "locale"> | undefined;
1010
- _responseType?: _blizzard_api_core.SearchResponse<CreatureSearchResponseItem> | undefined;
1011
- };
1012
- connectedRealmIndex: (namespace: "dynamic-classic" | "dynamic-classic1x") => {
1013
- path: string;
1014
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1015
- parameters?: Record<string, never> | undefined;
1016
- _responseType?: ConnectedRealmIndexResponse | undefined;
1017
- };
1018
- connectedRealm: (namespace: "dynamic-classic" | "dynamic-classic1x", connectedRealmId: number) => {
1019
- path: string;
1020
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1021
- parameters?: Record<string, never> | undefined;
1022
- _responseType?: ConnectedRealmResponse | undefined;
1023
- };
1024
- connectedRealmSearch: (namespace: "dynamic-classic" | "dynamic-classic1x", options: ConnectedRealmSearchParameters) => {
1025
- path: string;
1026
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1027
- parameters?: ConnectedRealmSearchParameters | undefined;
1028
- _responseType?: _blizzard_api_core.SearchResponse<ConnectedRealmSearchResponseItem> | undefined;
1029
- };
1030
- auctionHouseIndex: (namespace: "dynamic-classic" | "dynamic-classic1x", connectedRealmId: number) => {
1031
- path: string;
1032
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1033
- parameters?: Record<string, never> | undefined;
1034
- _responseType?: AuctionHouseIndexResponse | undefined;
1035
- };
1036
- auctions: (namespace: "dynamic-classic" | "dynamic-classic1x", connectedRealmId: number, auctionHouseId: number) => {
1037
- path: string;
1038
- namespace?: _blizzard_api_core.BlizzardNamespaces | undefined;
1039
- parameters?: Record<string, never> | undefined;
1040
- _responseType?: AuctionsResponse | undefined;
1041
- };
1088
+ auctionHouseIndex: typeof auctionHouseIndex;
1089
+ auctions: typeof auctions;
1090
+ connectedRealm: typeof connectedRealm;
1091
+ connectedRealmIndex: typeof connectedRealmIndex;
1092
+ connectedRealmSearch: typeof connectedRealmSearch;
1093
+ creature: typeof creature;
1094
+ creatureDisplayMedia: typeof creatureDisplayMedia;
1095
+ creatureFamily: typeof creatureFamily;
1096
+ creatureFamilyIndex: typeof creatureFamilyIndex;
1097
+ creatureFamilyMedia: typeof creatureFamilyMedia;
1098
+ creatureType: typeof creatureType;
1099
+ creatureTypeIndex: typeof creatureTypeIndex;
1100
+ creatureSearch: typeof creatureSearch;
1101
+ guildCrestComponentsIndex: typeof guildCrestComponentsIndex;
1102
+ guildCrestBorder: typeof guildCrestBorder;
1103
+ guildCrestEmblem: typeof guildCrestEmblem;
1104
+ itemClassIndex: typeof itemClassIndex;
1105
+ itemClass: typeof itemClass;
1106
+ itemSubClass: typeof itemSubClass;
1107
+ item: typeof item;
1108
+ itemMedia: typeof itemMedia;
1109
+ itemSearch: typeof itemSearch;
1110
+ mediaSearch: typeof mediaSearch;
1111
+ playableClass: typeof playableClass;
1112
+ playableClassIndex: typeof playableClassIndex;
1113
+ playableClassMedia: typeof playableClassMedia;
1114
+ playableRace: typeof playableRace;
1115
+ playableRaceIndex: typeof playableRaceIndex;
1116
+ powerType: typeof powerType;
1117
+ powerTypeIndex: typeof powerTypeIndex;
1118
+ pvpSeasonIndex: typeof pvpSeasonIndex;
1119
+ pvpSeason: typeof pvpSeason;
1120
+ pvpRegionIndex: typeof pvpRegionIndex;
1121
+ pvpRegionalSeasonIndex: typeof pvpRegionalSeasonIndex;
1122
+ pvpRegionalSeason: typeof pvpRegionalSeason;
1123
+ pvpLeaderboardIndex: typeof pvpLeaderboardIndex;
1124
+ pvpLeaderboard: typeof pvpLeaderboard;
1125
+ pvpRewardsIndex: typeof pvpRewardsIndex;
1126
+ realm: typeof realm;
1127
+ realmIndex: typeof realmIndex;
1128
+ realmSearch: typeof realmSearch;
1129
+ region: typeof region;
1130
+ regionIndex: typeof regionIndex;
1042
1131
  };
1043
1132
 
1044
- export { type AuctionHouseIndexResponse, type AuctionsResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSubClassResponse, type MediaSearchParameters, type MediaSearchResponseItem, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RegionIndexResponse, type RegionResponse, type WithoutUnderscore, classicWow };
1133
+ export { type AuctionHouseIndexResponse, type AuctionsResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSubClassResponse, type MediaSearchParameters, type MediaSearchResponseItem, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RegionIndexResponse, type RegionResponse, type WithoutUnderscore, auctionHouseIndex, auctions, classicWow, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSubClass, mediaSearch, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, powerType, powerTypeIndex, pvpLeaderboard, pvpLeaderboardIndex, pvpRegionIndex, pvpRegionalSeason, pvpRegionalSeasonIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, realm, realmIndex, realmSearch, region, regionIndex };