@blizzard-api/wow 3.0.6 → 4.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/account-profile/index.d.ts +2 -0
- package/dist/account-profile/index.js +104 -0
- package/dist/account-profile/index.js.map +1 -0
- package/dist/achievements/index.d.ts +2 -0
- package/dist/achievements/index.js +61 -0
- package/dist/achievements/index.js.map +1 -0
- package/dist/auction-house/index.d.ts +2 -0
- package/dist/auction-house/index.js +27 -0
- package/dist/auction-house/index.js.map +1 -0
- package/dist/azerite-essence/index.d.ts +2 -0
- package/dist/azerite-essence/index.js +54 -0
- package/dist/azerite-essence/index.js.map +1 -0
- package/dist/character-achievements/index.d.ts +2 -0
- package/dist/character-achievements/index.js +28 -0
- package/dist/character-achievements/index.js.map +1 -0
- package/dist/character-appearance/index.d.ts +2 -0
- package/dist/character-appearance/index.js +16 -0
- package/dist/character-appearance/index.js.map +1 -0
- package/dist/character-collections/index.d.ts +2 -0
- package/dist/character-collections/index.js +72 -0
- package/dist/character-collections/index.js.map +1 -0
- package/dist/character-encounters/index.d.ts +2 -0
- package/dist/character-encounters/index.js +39 -0
- package/dist/character-encounters/index.js.map +1 -0
- package/dist/character-equipment/index.d.ts +2 -0
- package/dist/character-equipment/index.js +16 -0
- package/dist/character-equipment/index.js.map +1 -0
- package/dist/character-hunter-pets/index.d.ts +2 -0
- package/dist/character-hunter-pets/index.js +17 -0
- package/dist/character-hunter-pets/index.js.map +1 -0
- package/dist/character-media/index.d.ts +2 -0
- package/dist/character-media/index.js +16 -0
- package/dist/character-media/index.js.map +1 -0
- package/dist/character-mythic-keystone-profile/index.d.ts +2 -0
- package/dist/character-mythic-keystone-profile/index.js +30 -0
- package/dist/character-mythic-keystone-profile/index.js.map +1 -0
- package/dist/character-professions/index.d.ts +2 -0
- package/dist/character-professions/index.js +16 -0
- package/dist/character-professions/index.js.map +1 -0
- package/dist/character-profile/index.d.ts +2 -0
- package/dist/character-profile/index.js +39 -0
- package/dist/character-profile/index.js.map +1 -0
- package/dist/character-pvp/index.d.ts +2 -0
- package/dist/character-pvp/index.js +28 -0
- package/dist/character-pvp/index.js.map +1 -0
- package/dist/character-quests/index.d.ts +2 -0
- package/dist/character-quests/index.js +27 -0
- package/dist/character-quests/index.js.map +1 -0
- package/dist/character-reputations/index.d.ts +2 -0
- package/dist/character-reputations/index.js +16 -0
- package/dist/character-reputations/index.js.map +1 -0
- package/dist/character-soulbinds/index.d.ts +2 -0
- package/dist/character-soulbinds/index.js +16 -0
- package/dist/character-soulbinds/index.js.map +1 -0
- package/dist/character-specializations/index.d.ts +2 -0
- package/dist/character-specializations/index.js +16 -0
- package/dist/character-specializations/index.js.map +1 -0
- package/dist/character-statistics/index.d.ts +2 -0
- package/dist/character-statistics/index.js +16 -0
- package/dist/character-statistics/index.js.map +1 -0
- package/dist/character-titles/index.d.ts +2 -0
- package/dist/character-titles/index.js +16 -0
- package/dist/character-titles/index.js.map +1 -0
- package/dist/connected-realm/index.d.ts +2 -0
- package/dist/connected-realm/index.js +44 -0
- package/dist/connected-realm/index.js.map +1 -0
- package/dist/covenant/index.d.ts +2 -0
- package/dist/covenant/index.js +80 -0
- package/dist/covenant/index.js.map +1 -0
- package/dist/creature/index.d.ts +2 -0
- package/dist/creature/index.js +97 -0
- package/dist/creature/index.js.map +1 -0
- package/dist/guild/index.d.ts +2 -0
- package/dist/guild/index.js +50 -0
- package/dist/guild/index.js.map +1 -0
- package/dist/guild-crest/index.d.ts +2 -0
- package/dist/guild-crest/index.js +38 -0
- package/dist/guild-crest/index.js.map +1 -0
- package/dist/heirloom/index.d.ts +2 -0
- package/dist/heirloom/index.js +27 -0
- package/dist/heirloom/index.js.map +1 -0
- package/dist/housing-decor/index.d.ts +2 -0
- package/dist/housing-decor/index.js +155 -0
- package/dist/housing-decor/index.js.map +1 -0
- package/dist/index--WL1Ol2r.d.ts +192 -0
- package/dist/index-0hpJYoWw.d.ts +86 -0
- package/dist/index-2xjdPrIp.d.ts +34 -0
- package/dist/index-8go905Or2.d.ts +46 -0
- package/dist/index-B-v4jmT8.d.ts +120 -0
- package/dist/index-BAx6xlRe.d.ts +43 -0
- package/dist/index-BJYdOuJB2.d.ts +21 -0
- package/dist/index-BM5t9AbX2.d.ts +72 -0
- package/dist/index-BOz0BCUN2.d.ts +233 -0
- package/dist/index-BUSzkCHP2.d.ts +38 -0
- package/dist/index-BWGWNZX7.d.ts +62 -0
- package/dist/index-BXawY6VA2.d.ts +150 -0
- package/dist/index-B_OrLUY42.d.ts +102 -0
- package/dist/index-BcKDDvwF.d.ts +85 -0
- package/dist/index-Bd_PavJU.d.ts +56 -0
- package/dist/index-BgkVcJkr2.d.ts +60 -0
- package/dist/index-BuORTLmA.d.ts +29 -0
- package/dist/index-C2BXkcO8.d.ts +36 -0
- package/dist/index-C9JT3jCN2.d.ts +77 -0
- package/dist/index-CE4iGLJf2.d.ts +128 -0
- package/dist/index-CH3CudPP.d.ts +91 -0
- package/dist/index-CJSqSpru.d.ts +145 -0
- package/dist/index-CMDZfaJk.d.ts +161 -0
- package/dist/index-CP1gTrDv.d.ts +312 -0
- package/dist/index-CQXTvcKu2.d.ts +72 -0
- package/dist/index-CS_QQdEk.d.ts +22 -0
- package/dist/index-CWFif_SP2.d.ts +31 -0
- package/dist/index-ChVDi11Z.d.ts +54 -0
- package/dist/index-CmJhDVVk.d.ts +157 -0
- package/dist/index-Cry2-cm82.d.ts +123 -0
- package/dist/index-Cto5KQ-A2.d.ts +71 -0
- package/dist/index-D9u-Oxk6.d.ts +69 -0
- package/dist/index-DDHIN-u0.d.ts +36 -0
- package/dist/index-DJZZaqMF.d.ts +66 -0
- package/dist/index-DLD2tbdk.d.ts +68 -0
- package/dist/index-DScltfEW.d.ts +89 -0
- package/dist/index-DZqv9GTd.d.ts +125 -0
- package/dist/index-DiU4f1cd2.d.ts +45 -0
- package/dist/index-DlkM3Nrw2.d.ts +45 -0
- package/dist/index-Do1l3j1C.d.ts +283 -0
- package/dist/index-DpfeUoRy.d.ts +149 -0
- package/dist/index-DvzdYkdL.d.ts +89 -0
- package/dist/index-DwuFoDTp.d.ts +159 -0
- package/dist/index-DxEXkR_n.d.ts +81 -0
- package/dist/index-Dzfv2QaX.d.ts +65 -0
- package/dist/index-J46u_PSy2.d.ts +117 -0
- package/dist/index-LhUh1Lk5.d.ts +30 -0
- package/dist/index-SfMQ7bBi2.d.ts +86 -0
- package/dist/index-Xyv-CG_n.d.ts +160 -0
- package/dist/index-ZAJGdEvm.d.ts +102 -0
- package/dist/index-fbBIJXcV.d.ts +69 -0
- package/dist/index-fn_f7xiC.d.ts +21 -0
- package/dist/index-h17WWDmt.d.ts +118 -0
- package/dist/index-m4fmIRKg.d.ts +35 -0
- package/dist/index.d.ts +69 -4738
- package/dist/index.js +68 -2137
- package/dist/index.js.map +1 -1
- package/dist/item/index.d.ts +2 -0
- package/dist/item/index.js +98 -0
- package/dist/item/index.js.map +1 -0
- package/dist/journal/index.d.ts +2 -0
- package/dist/journal/index.js +96 -0
- package/dist/journal/index.js.map +1 -0
- package/dist/media-search/index.d.ts +2 -0
- package/dist/media-search/index.js +22 -0
- package/dist/media-search/index.js.map +1 -0
- package/dist/modified-crafting/index.d.ts +2 -0
- package/dist/modified-crafting/index.js +58 -0
- package/dist/modified-crafting/index.js.map +1 -0
- package/dist/mount/index.d.ts +2 -0
- package/dist/mount/index.js +43 -0
- package/dist/mount/index.js.map +1 -0
- package/dist/mythic-keystone-affix/index.d.ts +2 -0
- package/dist/mythic-keystone-affix/index.js +38 -0
- package/dist/mythic-keystone-affix/index.js.map +1 -0
- package/dist/mythic-keystone-dungeon/index.d.ts +2 -0
- package/dist/mythic-keystone-dungeon/index.js +79 -0
- package/dist/mythic-keystone-dungeon/index.js.map +1 -0
- package/dist/mythic-keystone-leaderboard/index.d.ts +2 -0
- package/dist/mythic-keystone-leaderboard/index.js +30 -0
- package/dist/mythic-keystone-leaderboard/index.js.map +1 -0
- package/dist/mythic-raid-leaderboard/index.d.ts +2 -0
- package/dist/mythic-raid-leaderboard/index.js +18 -0
- package/dist/mythic-raid-leaderboard/index.js.map +1 -0
- package/dist/pet/index.d.ts +2 -0
- package/dist/pet/index.js +70 -0
- package/dist/pet/index.js.map +1 -0
- package/dist/playable-class/index.d.ts +2 -0
- package/dist/playable-class/index.js +49 -0
- package/dist/playable-class/index.js.map +1 -0
- package/dist/playable-race/index.d.ts +2 -0
- package/dist/playable-race/index.js +27 -0
- package/dist/playable-race/index.js.map +1 -0
- package/dist/playable-specialization/index.d.ts +2 -0
- package/dist/playable-specialization/index.js +38 -0
- package/dist/playable-specialization/index.js.map +1 -0
- package/dist/power-type/index.d.ts +2 -0
- package/dist/power-type/index.js +27 -0
- package/dist/power-type/index.js.map +1 -0
- package/dist/profession/index.d.ts +2 -0
- package/dist/profession/index.js +72 -0
- package/dist/profession/index.js.map +1 -0
- package/dist/pvp-season/index.d.ts +2 -0
- package/dist/pvp-season/index.js +61 -0
- package/dist/pvp-season/index.js.map +1 -0
- package/dist/pvp-tier/index.d.ts +2 -0
- package/dist/pvp-tier/index.js +38 -0
- package/dist/pvp-tier/index.js.map +1 -0
- package/dist/quest/index.d.ts +2 -0
- package/dist/quest/index.js +90 -0
- package/dist/quest/index.js.map +1 -0
- package/dist/realm/index.d.ts +24 -0
- package/dist/realm/index.js +43 -0
- package/dist/realm/index.js.map +1 -0
- package/dist/region/index.d.ts +2 -0
- package/dist/region/index.js +27 -0
- package/dist/region/index.js.map +1 -0
- package/dist/reputations/index.d.ts +2 -0
- package/dist/reputations/index.js +48 -0
- package/dist/reputations/index.js.map +1 -0
- package/dist/spell/index.d.ts +2 -0
- package/dist/spell/index.js +44 -0
- package/dist/spell/index.js.map +1 -0
- package/dist/talent/index.d.ts +2 -0
- package/dist/talent/index.js +81 -0
- package/dist/talent/index.js.map +1 -0
- package/dist/tech-talent/index.d.ts +2 -0
- package/dist/tech-talent/index.js +59 -0
- package/dist/tech-talent/index.js.map +1 -0
- package/dist/title/index.d.ts +2 -0
- package/dist/title/index.js +27 -0
- package/dist/title/index.js.map +1 -0
- package/dist/toy/index.d.ts +2 -0
- package/dist/toy/index.js +27 -0
- package/dist/toy/index.js.map +1 -0
- package/dist/types-Z0ZgMUXA.d.ts +79 -0
- package/dist/wow-token/index.d.ts +2 -0
- package/dist/wow-token/index.js +16 -0
- package/dist/wow-token/index.js.map +1 -0
- package/package.json +16 -7
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Faction, Factions, Href, KeyBase, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/pvp-season/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The response for a PvP leaderboard index.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
*/
|
|
8
|
+
interface PvpLeaderboardIndexResponse extends ResponseBase {
|
|
9
|
+
leaderboards: Array<KeyBase & {
|
|
10
|
+
id?: number;
|
|
11
|
+
name: string;
|
|
12
|
+
}>;
|
|
13
|
+
season: Season;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* The response for a PvP leaderboard.
|
|
17
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
18
|
+
*/
|
|
19
|
+
interface PvpLeaderboardResponse extends ResponseBase {
|
|
20
|
+
bracket: Bracket;
|
|
21
|
+
entries: Array<Entry>;
|
|
22
|
+
name: string;
|
|
23
|
+
season: Season;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* The response for PvP rewards index.
|
|
27
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
28
|
+
*/
|
|
29
|
+
interface PvpRewardsIndexResponse extends ResponseBase {
|
|
30
|
+
rewards: Array<Reward>;
|
|
31
|
+
season: Season;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* The response for a PvP season index.
|
|
35
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
36
|
+
*/
|
|
37
|
+
interface PvpSeasonIndexResponse extends ResponseBase {
|
|
38
|
+
current_season: Season;
|
|
39
|
+
seasons: Array<Season>;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* The response for a PvP season.
|
|
43
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
44
|
+
*/
|
|
45
|
+
interface PvpSeasonResponse extends ResponseBase {
|
|
46
|
+
id: number;
|
|
47
|
+
leaderboards: Href;
|
|
48
|
+
rewards: Href;
|
|
49
|
+
season_end_timestamp?: number;
|
|
50
|
+
season_name?: null | string;
|
|
51
|
+
season_start_timestamp: number;
|
|
52
|
+
}
|
|
53
|
+
interface Bracket {
|
|
54
|
+
id: number;
|
|
55
|
+
type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'BLITZ' | 'SHUFFLE';
|
|
56
|
+
}
|
|
57
|
+
interface Character$1 extends NameId {
|
|
58
|
+
realm: Realm$1;
|
|
59
|
+
}
|
|
60
|
+
interface Entry {
|
|
61
|
+
character: Character$1;
|
|
62
|
+
faction: {
|
|
63
|
+
type: Factions;
|
|
64
|
+
};
|
|
65
|
+
rank: number;
|
|
66
|
+
rating: number;
|
|
67
|
+
season_match_statistics: SeasonMatchStatistics;
|
|
68
|
+
tier: Season;
|
|
69
|
+
}
|
|
70
|
+
interface Realm$1 extends KeyBase {
|
|
71
|
+
id: number;
|
|
72
|
+
slug: string;
|
|
73
|
+
}
|
|
74
|
+
interface Reward {
|
|
75
|
+
achievement: NameIdKey;
|
|
76
|
+
bracket: Bracket;
|
|
77
|
+
faction?: Faction;
|
|
78
|
+
rating_cutoff: number;
|
|
79
|
+
specialization?: NameIdKey;
|
|
80
|
+
}
|
|
81
|
+
interface Season extends KeyBase {
|
|
82
|
+
id: number;
|
|
83
|
+
}
|
|
84
|
+
interface SeasonMatchStatistics {
|
|
85
|
+
lost: number;
|
|
86
|
+
played: number;
|
|
87
|
+
won: number;
|
|
88
|
+
}
|
|
89
|
+
//#endregion
|
|
90
|
+
//#region src/pvp-season/index.d.ts
|
|
91
|
+
/**
|
|
92
|
+
* Get a PvP leaderboard by PvP season ID and bracket.
|
|
93
|
+
* @param pvpSeasonId The PvP season ID.
|
|
94
|
+
* @param bracket The PvP bracket.
|
|
95
|
+
* @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
|
|
96
|
+
*/
|
|
97
|
+
declare function pvpLeaderboard(pvpSeasonId: number, bracket: string): Resource<PvpLeaderboardResponse>;
|
|
98
|
+
/**
|
|
99
|
+
* Get a PvP leaderboard index by PvP season ID.
|
|
100
|
+
* @param pvpSeasonId The PvP season ID.
|
|
101
|
+
* @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
|
|
102
|
+
*/
|
|
103
|
+
declare function pvpLeaderboardIndex(pvpSeasonId: number): Resource<PvpLeaderboardIndexResponse>;
|
|
104
|
+
/**
|
|
105
|
+
* Get a PvP reward index by PvP season ID.
|
|
106
|
+
* @param pvpSeasonId The PvP season ID.
|
|
107
|
+
* @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
|
|
108
|
+
*/
|
|
109
|
+
declare function pvpRewardsIndex(pvpSeasonId: number): Resource<PvpRewardsIndexResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* Get a PvP season by ID.
|
|
112
|
+
* @param pvpSeasonId The PvP season ID.
|
|
113
|
+
* @returns The PvP season. See {@link PvpSeasonResponse}.
|
|
114
|
+
*/
|
|
115
|
+
declare function pvpSeason(pvpSeasonId: number): Resource<PvpSeasonResponse>;
|
|
116
|
+
/**
|
|
117
|
+
* Get a PvP season index.
|
|
118
|
+
* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
|
|
119
|
+
*/
|
|
120
|
+
declare function pvpSeasonIndex(): Resource<PvpSeasonIndexResponse>;
|
|
121
|
+
//#endregion
|
|
122
|
+
export { pvpSeasonIndex as a, PvpRewardsIndexResponse as c, pvpSeason as i, PvpSeasonIndexResponse as l, pvpLeaderboardIndex as n, PvpLeaderboardIndexResponse as o, pvpRewardsIndex as r, PvpLeaderboardResponse as s, pvpLeaderboard as t, PvpSeasonResponse as u };
|
|
123
|
+
//# sourceMappingURL=index-Cry2-cm82.d.ts.map
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { BaseSearchParameters, KeyBase, Locales, MediaAsset, NameId, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/spell/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The response for a spell media.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
*/
|
|
8
|
+
interface SpellMediaResponse extends ResponseBase {
|
|
9
|
+
assets: Array<MediaAsset>;
|
|
10
|
+
id: number;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* The response for a spell.
|
|
14
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
15
|
+
*/
|
|
16
|
+
interface SpellResponse extends NameId, ResponseBase {
|
|
17
|
+
description: null | string;
|
|
18
|
+
media: Media;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* The search parameters for spells.
|
|
22
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
23
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
24
|
+
*/
|
|
25
|
+
interface SpellSearchParameters extends BaseSearchParameters {
|
|
26
|
+
locale: Locales;
|
|
27
|
+
name: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* The response for a spell search.
|
|
31
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
32
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
33
|
+
*/
|
|
34
|
+
interface SpellSearchResponse extends SearchResponseWithoutResults {
|
|
35
|
+
results: Array<SpellSearchResponseItem>;
|
|
36
|
+
}
|
|
37
|
+
interface Media extends KeyBase {
|
|
38
|
+
id: number;
|
|
39
|
+
}
|
|
40
|
+
interface SpellSearchResponseItem extends KeyBase {
|
|
41
|
+
data: {
|
|
42
|
+
id: number;
|
|
43
|
+
media: {
|
|
44
|
+
id: number;
|
|
45
|
+
};
|
|
46
|
+
name: Record<Locales, string>;
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
//#endregion
|
|
50
|
+
//#region src/spell/index.d.ts
|
|
51
|
+
/**
|
|
52
|
+
* Get a spell by ID.
|
|
53
|
+
* @param spellId The spell ID.
|
|
54
|
+
* @returns The spell. See {@link SpellResponse}.
|
|
55
|
+
*/
|
|
56
|
+
declare function spell(spellId: number): Resource<SpellResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* Get spell media by ID.
|
|
59
|
+
* @param spellId The spell ID.
|
|
60
|
+
* @returns The spell media. See {@link SpellMediaResponse}.
|
|
61
|
+
*/
|
|
62
|
+
declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
|
|
63
|
+
/**
|
|
64
|
+
* Get a spell search.
|
|
65
|
+
* @param options The spell search options. See {@link SpellSearchParameters}.
|
|
66
|
+
* @returns The spell search. See {@link SpellSearchResponse}.
|
|
67
|
+
*/
|
|
68
|
+
declare function spellSearch(options: SpellSearchParameters): Resource<SpellSearchResponse, Omit<SpellSearchParameters, 'locale' | 'name'>>;
|
|
69
|
+
//#endregion
|
|
70
|
+
export { SpellResponse as a, SpellMediaResponse as i, spellMedia as n, SpellSearchParameters as o, spellSearch as r, SpellSearchResponse as s, spell as t };
|
|
71
|
+
//# sourceMappingURL=index-Cto5KQ-A2.d.ts.map
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import { Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/auction-house/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* Interface for a response from the auction house commodities endpoint.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
*/
|
|
8
|
+
interface AuctionHouseCommoditiesResponse extends ResponseBase {
|
|
9
|
+
auctions: Array<AuctionHouseCommodity>;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Interface for a response from the auction house endpoint.
|
|
13
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
14
|
+
*/
|
|
15
|
+
interface AuctionHouseResponse extends ResponseBase {
|
|
16
|
+
auctions: Array<AuctionHousePosting>;
|
|
17
|
+
commodities: {
|
|
18
|
+
href: string;
|
|
19
|
+
};
|
|
20
|
+
connected_realm: {
|
|
21
|
+
href: string;
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
interface AuctionHouseCommodity {
|
|
25
|
+
id: number;
|
|
26
|
+
item: {
|
|
27
|
+
id: number;
|
|
28
|
+
};
|
|
29
|
+
quantity: number;
|
|
30
|
+
time_left: AuctionHouseTimeLeft;
|
|
31
|
+
unit_price: number;
|
|
32
|
+
}
|
|
33
|
+
interface AuctionHousePosting {
|
|
34
|
+
bid?: number;
|
|
35
|
+
buyout: number;
|
|
36
|
+
id: number;
|
|
37
|
+
item: {
|
|
38
|
+
bonus_lists?: Array<number>;
|
|
39
|
+
context?: number;
|
|
40
|
+
id: number;
|
|
41
|
+
modifiers?: Array<{
|
|
42
|
+
type: number;
|
|
43
|
+
value: number;
|
|
44
|
+
}>;
|
|
45
|
+
pet_breed_id?: number;
|
|
46
|
+
pet_level?: number;
|
|
47
|
+
pet_quality_id?: number;
|
|
48
|
+
pet_species_id?: number;
|
|
49
|
+
};
|
|
50
|
+
quantity: number;
|
|
51
|
+
time_left: AuctionHouseTimeLeft;
|
|
52
|
+
}
|
|
53
|
+
type AuctionHouseTimeLeft = 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
|
|
54
|
+
//#endregion
|
|
55
|
+
//#region src/auction-house/index.d.ts
|
|
56
|
+
/**
|
|
57
|
+
* Get auction house data for a connected realm.
|
|
58
|
+
* @param connectedRealmId The ID of the connected realm.
|
|
59
|
+
* @returns The auction house data. See {@link AuctionHouseResponse}.
|
|
60
|
+
*/
|
|
61
|
+
declare function auctions(connectedRealmId: number): Resource<AuctionHouseResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Get auction house data for all connected realms.
|
|
64
|
+
* @returns The auction house data. See {@link AuctionHouseResponse}.
|
|
65
|
+
*/
|
|
66
|
+
declare function commodities(): Resource<AuctionHouseCommoditiesResponse>;
|
|
67
|
+
//#endregion
|
|
68
|
+
export { AuctionHouseResponse as i, commodities as n, AuctionHouseCommoditiesResponse as r, auctions as t };
|
|
69
|
+
//# sourceMappingURL=index-D9u-Oxk6.d.ts.map
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { BaseSearchParameters, KeyBase, MediaAsset, Resource, SearchResponseWithoutResults } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/media-search/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The search parameters for media.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
8
|
+
*/
|
|
9
|
+
interface MediaSearchParameters extends BaseSearchParameters {
|
|
10
|
+
tags?: string;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* The response for a media search.
|
|
14
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
15
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
16
|
+
*/
|
|
17
|
+
interface MediaSearchResponse extends SearchResponseWithoutResults {
|
|
18
|
+
results: Array<MediaSearchResponseItem>;
|
|
19
|
+
}
|
|
20
|
+
interface MediaSearchResponseItem extends KeyBase {
|
|
21
|
+
data: {
|
|
22
|
+
assets?: Array<MediaAsset>;
|
|
23
|
+
id?: number;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
//#endregion
|
|
27
|
+
//#region src/media-search/index.d.ts
|
|
28
|
+
/**
|
|
29
|
+
* Search for media.
|
|
30
|
+
* @param options The search parameters. See {@link MediaSearchParameters}.
|
|
31
|
+
* @returns The search results. See {@link MediaSearchResponse}.
|
|
32
|
+
*/
|
|
33
|
+
declare function mediaSearch(options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
|
|
34
|
+
//#endregion
|
|
35
|
+
export { MediaSearchParameters as n, MediaSearchResponse as r, mediaSearch as t };
|
|
36
|
+
//# sourceMappingURL=index-DDHIN-u0.d.ts.map
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { Character, Color, Faction, Gender, KeyBase, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/character-appearance/types.d.ts
|
|
4
|
+
interface CharacterAppearanceResponse extends ResponseBase {
|
|
5
|
+
active_spec: NameIdKey;
|
|
6
|
+
character: Character;
|
|
7
|
+
customizations: Array<Customization>;
|
|
8
|
+
faction: Faction;
|
|
9
|
+
gender: Gender;
|
|
10
|
+
guild_crest: GuildCrest;
|
|
11
|
+
items: Array<Item>;
|
|
12
|
+
playable_class: NameIdKey;
|
|
13
|
+
playable_race: NameIdKey;
|
|
14
|
+
}
|
|
15
|
+
interface BorderEmblem {
|
|
16
|
+
color: RGBWithId;
|
|
17
|
+
id: number;
|
|
18
|
+
media: KeyBase & {
|
|
19
|
+
id: number;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
interface Choice {
|
|
23
|
+
display_order: number;
|
|
24
|
+
id: number;
|
|
25
|
+
name?: null | string;
|
|
26
|
+
}
|
|
27
|
+
interface Customization {
|
|
28
|
+
choice: Choice;
|
|
29
|
+
option: NameId;
|
|
30
|
+
}
|
|
31
|
+
interface GuildCrest {
|
|
32
|
+
background: {
|
|
33
|
+
color: RGBWithId;
|
|
34
|
+
};
|
|
35
|
+
border: BorderEmblem;
|
|
36
|
+
emblem: BorderEmblem;
|
|
37
|
+
}
|
|
38
|
+
interface Item {
|
|
39
|
+
enchant: number;
|
|
40
|
+
id: number;
|
|
41
|
+
internal_slot_id: number;
|
|
42
|
+
item_appearance_modifier_id?: number;
|
|
43
|
+
secondary_id?: number;
|
|
44
|
+
secondary_item_appearance_modifier_id?: number;
|
|
45
|
+
secondary_subclass?: number;
|
|
46
|
+
slot: {
|
|
47
|
+
name: string;
|
|
48
|
+
type: string;
|
|
49
|
+
};
|
|
50
|
+
subclass?: number;
|
|
51
|
+
}
|
|
52
|
+
interface RGBWithId {
|
|
53
|
+
id: number;
|
|
54
|
+
rgba: Color;
|
|
55
|
+
}
|
|
56
|
+
//#endregion
|
|
57
|
+
//#region src/character-appearance/index.d.ts
|
|
58
|
+
/**
|
|
59
|
+
* @param realmSlug The slug of the realm.
|
|
60
|
+
* @param characterName The lowercase name of the character.
|
|
61
|
+
* @returns a summary of a character's appearance settings.
|
|
62
|
+
*/
|
|
63
|
+
declare function characterAppearanceSummary(realmSlug: string, characterName: string): Resource<CharacterAppearanceResponse>;
|
|
64
|
+
//#endregion
|
|
65
|
+
export { CharacterAppearanceResponse as n, characterAppearanceSummary as t };
|
|
66
|
+
//# sourceMappingURL=index-DJZZaqMF.d.ts.map
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { Character, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/character-specializations/types.d.ts
|
|
4
|
+
interface CharacterSpecializationsSummaryResponse extends ResponseBase {
|
|
5
|
+
active_hero_talent_tree: NameIdKey;
|
|
6
|
+
active_specialization: NameIdKey;
|
|
7
|
+
character: Character;
|
|
8
|
+
specializations: Array<Specialization>;
|
|
9
|
+
}
|
|
10
|
+
interface Loadout {
|
|
11
|
+
is_active: boolean;
|
|
12
|
+
selected_class_talent_tree: KeyBase & {
|
|
13
|
+
name: string;
|
|
14
|
+
};
|
|
15
|
+
selected_class_talents: Array<SelectedTalent>;
|
|
16
|
+
selected_hero_talent_tree: NameIdKey;
|
|
17
|
+
selected_hero_talents: Array<SelectedTalent>;
|
|
18
|
+
selected_spec_talent_tree: KeyBase & {
|
|
19
|
+
name: string;
|
|
20
|
+
};
|
|
21
|
+
selected_spec_talents?: Array<SelectedTalent>;
|
|
22
|
+
talent_loadout_code: string;
|
|
23
|
+
}
|
|
24
|
+
interface PvpTalentSlot {
|
|
25
|
+
selected: Selected;
|
|
26
|
+
slot_number: number;
|
|
27
|
+
}
|
|
28
|
+
interface Selected {
|
|
29
|
+
spell_tooltip: SpellTooltip;
|
|
30
|
+
talent: KeyBase & {
|
|
31
|
+
id: number;
|
|
32
|
+
name?: string;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
interface SelectedTalent {
|
|
36
|
+
default_points?: number;
|
|
37
|
+
id: number;
|
|
38
|
+
rank: number;
|
|
39
|
+
tooltip?: Selected;
|
|
40
|
+
}
|
|
41
|
+
interface Specialization {
|
|
42
|
+
glyphs?: Array<NameIdKey>;
|
|
43
|
+
loadouts: Array<Loadout>;
|
|
44
|
+
pvp_talent_slots?: Array<PvpTalentSlot>;
|
|
45
|
+
specialization: NameIdKey;
|
|
46
|
+
}
|
|
47
|
+
interface SpellTooltip {
|
|
48
|
+
cast_time?: string;
|
|
49
|
+
cooldown?: string;
|
|
50
|
+
description?: string;
|
|
51
|
+
power_cost?: string;
|
|
52
|
+
range?: string;
|
|
53
|
+
spell: KeyBase & {
|
|
54
|
+
id: number;
|
|
55
|
+
name?: string;
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
//#endregion
|
|
59
|
+
//#region src/character-specializations/index.d.ts
|
|
60
|
+
/**
|
|
61
|
+
* @param realmSlug The slug of the realm.
|
|
62
|
+
* @param characterName The lowercase name of the character.
|
|
63
|
+
* @returns a summary of a character's specializations.
|
|
64
|
+
*/
|
|
65
|
+
declare function characterSpecializationsSummary(realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
|
|
66
|
+
//#endregion
|
|
67
|
+
export { CharacterSpecializationsSummaryResponse as n, characterSpecializationsSummary as t };
|
|
68
|
+
//# sourceMappingURL=index-DLD2tbdk.d.ts.map
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { Character, Href, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/character-achievements/types.d.ts
|
|
4
|
+
interface CharacterAchievementsSummaryResponse extends ResponseBase {
|
|
5
|
+
achievements: Array<Achievement>;
|
|
6
|
+
category_progress: Array<CategoryProgress>;
|
|
7
|
+
character: Character;
|
|
8
|
+
recent_events: Array<RecentEvent>;
|
|
9
|
+
statistics: Href;
|
|
10
|
+
total_points: number;
|
|
11
|
+
total_quantity: number;
|
|
12
|
+
}
|
|
13
|
+
interface CharacterAchievementStatisticsResponse extends ResponseBase {
|
|
14
|
+
categories: Array<Category>;
|
|
15
|
+
character: Character;
|
|
16
|
+
}
|
|
17
|
+
interface Achievement {
|
|
18
|
+
achievement: NameIdKey;
|
|
19
|
+
completed_timestamp?: number;
|
|
20
|
+
criteria?: Criteria;
|
|
21
|
+
id: number;
|
|
22
|
+
}
|
|
23
|
+
interface Category {
|
|
24
|
+
id?: number;
|
|
25
|
+
name: string;
|
|
26
|
+
statistics?: Array<Statistic>;
|
|
27
|
+
sub_categories?: Array<SubCategory>;
|
|
28
|
+
}
|
|
29
|
+
interface CategoryProgress {
|
|
30
|
+
category: NameIdKey;
|
|
31
|
+
points: number;
|
|
32
|
+
quantity: number;
|
|
33
|
+
}
|
|
34
|
+
interface ChildCriterum {
|
|
35
|
+
amount?: number;
|
|
36
|
+
child_criteria?: Array<ChildCriterum2>;
|
|
37
|
+
id: number;
|
|
38
|
+
is_completed: boolean;
|
|
39
|
+
}
|
|
40
|
+
interface ChildCriterum2 {
|
|
41
|
+
amount?: number;
|
|
42
|
+
child_criteria?: Array<ChildCriterum3>;
|
|
43
|
+
id: number;
|
|
44
|
+
is_completed: boolean;
|
|
45
|
+
}
|
|
46
|
+
interface ChildCriterum3 {
|
|
47
|
+
amount?: number;
|
|
48
|
+
id: number;
|
|
49
|
+
is_completed: boolean;
|
|
50
|
+
}
|
|
51
|
+
interface Criteria {
|
|
52
|
+
amount?: number;
|
|
53
|
+
child_criteria?: Array<ChildCriterum>;
|
|
54
|
+
id: number;
|
|
55
|
+
is_completed: boolean;
|
|
56
|
+
}
|
|
57
|
+
interface RecentEvent {
|
|
58
|
+
achievement: NameIdKey;
|
|
59
|
+
timestamp: number;
|
|
60
|
+
}
|
|
61
|
+
interface Statistic {
|
|
62
|
+
description?: null | string;
|
|
63
|
+
id: number;
|
|
64
|
+
last_updated_timestamp: number;
|
|
65
|
+
name: string;
|
|
66
|
+
quantity: number;
|
|
67
|
+
}
|
|
68
|
+
interface SubCategory {
|
|
69
|
+
id: number;
|
|
70
|
+
name: string;
|
|
71
|
+
statistics: Array<Statistic>;
|
|
72
|
+
}
|
|
73
|
+
//#endregion
|
|
74
|
+
//#region src/character-achievements/index.d.ts
|
|
75
|
+
/**
|
|
76
|
+
* @param realmSlug The slug of the realm.
|
|
77
|
+
* @param characterName The lowercase name of the character.
|
|
78
|
+
* @returns a summary of the achievements a character has completed.
|
|
79
|
+
*/
|
|
80
|
+
declare function characterAchievementsSummary(realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
|
|
81
|
+
/**
|
|
82
|
+
* @param realmSlug The slug of the realm.
|
|
83
|
+
* @param characterName The lowercase name of the character.
|
|
84
|
+
* @returns a character's statistics as they pertain to achievements.
|
|
85
|
+
*/
|
|
86
|
+
declare function characterAchievementStatistics(realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
|
|
87
|
+
//#endregion
|
|
88
|
+
export { CharacterAchievementsSummaryResponse as i, characterAchievementsSummary as n, CharacterAchievementStatisticsResponse as r, characterAchievementStatistics as t };
|
|
89
|
+
//# sourceMappingURL=index-DScltfEW.d.ts.map
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { c as RealmTypeCapitalized, r as RealmLocales, s as RealmTimezone, t as RealmCategory } from "./types-Z0ZgMUXA.js";
|
|
2
|
+
import { BaseSearchParameters, Href, KeyBase, Locales, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
|
|
3
|
+
|
|
4
|
+
//#region src/connected-realm/types.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* Connected Realm Index API response.
|
|
7
|
+
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
8
|
+
*/
|
|
9
|
+
interface ConnectedRealmIndexResponse extends ResponseBase {
|
|
10
|
+
connected_realms: Array<Href>;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Connected Realm API response.
|
|
14
|
+
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
15
|
+
*/
|
|
16
|
+
interface ConnectedRealmResponse extends ResponseBase {
|
|
17
|
+
auctions: Href;
|
|
18
|
+
has_queue: boolean;
|
|
19
|
+
id: number;
|
|
20
|
+
mythic_leaderboards: Href;
|
|
21
|
+
population: {
|
|
22
|
+
name: string;
|
|
23
|
+
type: RealmPopulationCapitalized;
|
|
24
|
+
};
|
|
25
|
+
realm_locked_status?: RealmLockedStatus;
|
|
26
|
+
realms: Array<Realm$1>;
|
|
27
|
+
status: {
|
|
28
|
+
name: string;
|
|
29
|
+
type: RealmStatusCapitalized;
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Connected Realm Search API parameters.
|
|
34
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
35
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
36
|
+
*/
|
|
37
|
+
interface ConnectedRealmSearchParameters extends BaseSearchParameters {
|
|
38
|
+
'realms.timezone'?: RealmTimezone;
|
|
39
|
+
'status.type'?: RealmStatusCapitalized;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Connected Realm Search API response item.
|
|
43
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
44
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
45
|
+
*/
|
|
46
|
+
interface ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
|
|
47
|
+
results: Array<ConnectedRealmSearchResponseItem>;
|
|
48
|
+
}
|
|
49
|
+
interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
50
|
+
data: {
|
|
51
|
+
has_queue: boolean;
|
|
52
|
+
id: number;
|
|
53
|
+
population: SearchRealmPopulation;
|
|
54
|
+
realms: Array<SearchRealm>;
|
|
55
|
+
status: SearchRealmStatus;
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
interface Realm$1 {
|
|
59
|
+
category: RealmCategory;
|
|
60
|
+
connected_realm: Href;
|
|
61
|
+
id: number;
|
|
62
|
+
is_tournament: boolean;
|
|
63
|
+
locale: RealmLocales;
|
|
64
|
+
name: string;
|
|
65
|
+
region: NameIdKey;
|
|
66
|
+
slug: string;
|
|
67
|
+
timezone: RealmTimezone;
|
|
68
|
+
type: {
|
|
69
|
+
name: string;
|
|
70
|
+
type: RealmTypeCapitalized;
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
interface RealmLockedStatus {
|
|
74
|
+
is_locked_for_new_characters: boolean;
|
|
75
|
+
is_locked_for_pct: boolean;
|
|
76
|
+
}
|
|
77
|
+
type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
|
|
78
|
+
type RealmStatusCapitalized = 'DOWN' | 'UP';
|
|
79
|
+
interface SearchRealm {
|
|
80
|
+
category: Record<Locales, string>;
|
|
81
|
+
id: number;
|
|
82
|
+
is_tournament: boolean;
|
|
83
|
+
locale: RealmLocales;
|
|
84
|
+
name: Record<Locales, string>;
|
|
85
|
+
region: {
|
|
86
|
+
id: number;
|
|
87
|
+
name: Record<Locales, string>;
|
|
88
|
+
};
|
|
89
|
+
slug: string;
|
|
90
|
+
timezone: RealmTimezone;
|
|
91
|
+
type: {
|
|
92
|
+
name: Record<Locales, string>;
|
|
93
|
+
type: RealmTypeCapitalized;
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
interface SearchRealmPopulation {
|
|
97
|
+
name: Record<Locales, string>;
|
|
98
|
+
type: RealmPopulationCapitalized;
|
|
99
|
+
}
|
|
100
|
+
interface SearchRealmStatus {
|
|
101
|
+
name: Record<Locales, string>;
|
|
102
|
+
type: RealmStatusCapitalized;
|
|
103
|
+
}
|
|
104
|
+
//#endregion
|
|
105
|
+
//#region src/connected-realm/index.d.ts
|
|
106
|
+
/**
|
|
107
|
+
* Get a connected realm by ID.
|
|
108
|
+
* @param connectedRealmId The connected realm ID.
|
|
109
|
+
* @returns The connected realm. See {@link ConnectedRealmResponse}.
|
|
110
|
+
*/
|
|
111
|
+
declare function connectedRealm(connectedRealmId: number): Resource<ConnectedRealmResponse>;
|
|
112
|
+
/**
|
|
113
|
+
* Get a connected realm index.
|
|
114
|
+
* @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
|
|
115
|
+
*/
|
|
116
|
+
declare function connectedRealmIndex(): Resource<ConnectedRealmIndexResponse>;
|
|
117
|
+
/**
|
|
118
|
+
* Search for connected realms.
|
|
119
|
+
* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
|
|
120
|
+
* @returns The search results. See {@link ConnectedRealmSearchResponse}.
|
|
121
|
+
*/
|
|
122
|
+
declare function connectedRealmSearch(options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
|
|
123
|
+
//#endregion
|
|
124
|
+
export { ConnectedRealmResponse as a, ConnectedRealmIndexResponse as i, connectedRealmIndex as n, ConnectedRealmSearchParameters as o, connectedRealmSearch as r, ConnectedRealmSearchResponse as s, connectedRealm as t };
|
|
125
|
+
//# sourceMappingURL=index-DZqv9GTd.d.ts.map
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { GenderName, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/title/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The response for a title index.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
*/
|
|
8
|
+
interface TitleIndexResponse extends ResponseBase {
|
|
9
|
+
titles: Array<NameIdKey>;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* The response for a title.
|
|
13
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
14
|
+
*/
|
|
15
|
+
interface TitleResponse extends NameId, ResponseBase {
|
|
16
|
+
gender_name: GenderName;
|
|
17
|
+
source?: TitleSource;
|
|
18
|
+
}
|
|
19
|
+
interface TitleSource {
|
|
20
|
+
achievements?: Array<NameIdKey>;
|
|
21
|
+
quests?: Array<NameIdKey>;
|
|
22
|
+
type: {
|
|
23
|
+
name: string;
|
|
24
|
+
type: 'ACHIEVEMENT';
|
|
25
|
+
} | {
|
|
26
|
+
name: string;
|
|
27
|
+
type: 'QUEST';
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
//#endregion
|
|
31
|
+
//#region src/title/index.d.ts
|
|
32
|
+
/**
|
|
33
|
+
* Get a title by ID.
|
|
34
|
+
* @param titleId The title ID.
|
|
35
|
+
* @returns The title. See {@link TitleResponse}.
|
|
36
|
+
*/
|
|
37
|
+
declare function title(titleId: number): Resource<TitleResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Get a title index.
|
|
40
|
+
* @returns The title index. See {@link TitleIndexResponse}.
|
|
41
|
+
*/
|
|
42
|
+
declare function titleIndex(): Resource<TitleIndexResponse>;
|
|
43
|
+
//#endregion
|
|
44
|
+
export { TitleResponse as i, titleIndex as n, TitleIndexResponse as r, title as t };
|
|
45
|
+
//# sourceMappingURL=index-DiU4f1cd2.d.ts.map
|