@blizzard-api/wow 1.2.2 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -2
- package/dist/index.js.map +1 -1
- package/package.json +5 -9
- package/dist/index.cjs +0 -1674
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts +0 -4600
package/dist/index.d.cts
DELETED
|
@@ -1,4600 +0,0 @@
|
|
|
1
|
-
import { ProtectedResource, Resource, BaseSearchParameters, Locales, SearchResponse, Origins } from '@blizzard-api/core';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
*
|
|
5
|
-
*/
|
|
6
|
-
interface Href {
|
|
7
|
-
href: string;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Base interface for Blizzard API responses.
|
|
11
|
-
*/
|
|
12
|
-
interface ResponseBase {
|
|
13
|
-
_links: {
|
|
14
|
-
self: Href;
|
|
15
|
-
};
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Base record interface containing key.href property that often appear in Blizzard API responses.
|
|
19
|
-
*/
|
|
20
|
-
interface KeyBase {
|
|
21
|
-
key: Href;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Base record interface containing name and id properties that often appear together in Blizzard API responses.
|
|
25
|
-
*/
|
|
26
|
-
interface NameId {
|
|
27
|
-
id: number;
|
|
28
|
-
name: string;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Base record containing both {@link KeyBase} and {@link NameId} interfaces.
|
|
32
|
-
*/
|
|
33
|
-
interface NameIdKey extends KeyBase, NameId {
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* A record containing the RGBA values of a color.
|
|
37
|
-
*/
|
|
38
|
-
interface Color {
|
|
39
|
-
a: number;
|
|
40
|
-
b: number;
|
|
41
|
-
g: number;
|
|
42
|
-
r: number;
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* The media asset associated with a character or entity in World of Warcraft.
|
|
46
|
-
*/
|
|
47
|
-
interface MediaAsset$1 {
|
|
48
|
-
file_data_id: number;
|
|
49
|
-
key: string;
|
|
50
|
-
value: string;
|
|
51
|
-
}
|
|
52
|
-
/**
|
|
53
|
-
* The playable gender names/descriptions in World of Warcraft.
|
|
54
|
-
*/
|
|
55
|
-
interface GenderName {
|
|
56
|
-
female: string;
|
|
57
|
-
male: string;
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* The playable genders in World of Warcraft.
|
|
61
|
-
*/
|
|
62
|
-
declare const Genders: {
|
|
63
|
-
readonly FEMALE: "FEMALE";
|
|
64
|
-
readonly MALE: "MALE";
|
|
65
|
-
};
|
|
66
|
-
/**
|
|
67
|
-
* The gender associated with a character or entity in World of Warcraft.
|
|
68
|
-
*/
|
|
69
|
-
interface Gender {
|
|
70
|
-
name: Capitalize<Lowercase<keyof typeof Genders>>;
|
|
71
|
-
type: keyof typeof Genders;
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* The playable factions in World of Warcraft.
|
|
75
|
-
*/
|
|
76
|
-
declare const Factions: {
|
|
77
|
-
readonly ALLIANCE: "ALLIANCE";
|
|
78
|
-
readonly HORDE: "HORDE";
|
|
79
|
-
};
|
|
80
|
-
/**
|
|
81
|
-
* The faction associated with a character or entity in World of Warcraft.
|
|
82
|
-
*/
|
|
83
|
-
interface Faction {
|
|
84
|
-
name: Capitalize<Lowercase<keyof typeof Factions>>;
|
|
85
|
-
type: keyof typeof Factions;
|
|
86
|
-
}
|
|
87
|
-
/**
|
|
88
|
-
* The standard structure to represent a World of Warcraft Realm.
|
|
89
|
-
*/
|
|
90
|
-
interface Realm$4 extends NameIdKey {
|
|
91
|
-
slug: string;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* The standard structure to represent a World of Warcraft Character.
|
|
95
|
-
*/
|
|
96
|
-
interface Character$2 extends NameIdKey {
|
|
97
|
-
realm: Realm$4;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
interface AccountProfileSummaryResponse {
|
|
101
|
-
_links: Links;
|
|
102
|
-
collections: Href;
|
|
103
|
-
id: number;
|
|
104
|
-
wow_accounts?: Array<WowAccount>;
|
|
105
|
-
}
|
|
106
|
-
interface Links {
|
|
107
|
-
profile: Href;
|
|
108
|
-
self: Href;
|
|
109
|
-
user: Href;
|
|
110
|
-
}
|
|
111
|
-
interface WowAccount {
|
|
112
|
-
characters: Array<Character$1>;
|
|
113
|
-
id: number;
|
|
114
|
-
}
|
|
115
|
-
interface Character$1 {
|
|
116
|
-
character: Href;
|
|
117
|
-
faction: Faction;
|
|
118
|
-
gender: Gender;
|
|
119
|
-
id: number;
|
|
120
|
-
level: number;
|
|
121
|
-
name: string;
|
|
122
|
-
playable_class: NameIdKey;
|
|
123
|
-
playable_race: NameIdKey;
|
|
124
|
-
protected_character: Href;
|
|
125
|
-
realm: Realm$4;
|
|
126
|
-
}
|
|
127
|
-
interface ProtectedCharacterProfileSummaryResponse {
|
|
128
|
-
_links: Links;
|
|
129
|
-
bind_position: Position;
|
|
130
|
-
character: NameIdKey & Realm$4;
|
|
131
|
-
id: number;
|
|
132
|
-
money: number;
|
|
133
|
-
name: string;
|
|
134
|
-
position: Position;
|
|
135
|
-
protected_stats: ProtectedStats;
|
|
136
|
-
wow_account: number;
|
|
137
|
-
}
|
|
138
|
-
interface Position {
|
|
139
|
-
facing: number;
|
|
140
|
-
map: NameId;
|
|
141
|
-
x: number;
|
|
142
|
-
y: number;
|
|
143
|
-
z: number;
|
|
144
|
-
zone: NameId;
|
|
145
|
-
}
|
|
146
|
-
interface ProtectedStats {
|
|
147
|
-
level_gold_gained: number;
|
|
148
|
-
level_gold_lost: number;
|
|
149
|
-
level_item_value_gained: number;
|
|
150
|
-
level_number_deaths: number;
|
|
151
|
-
total_gold_gained: number;
|
|
152
|
-
total_gold_lost: number;
|
|
153
|
-
total_item_value_gained: number;
|
|
154
|
-
total_number_deaths: number;
|
|
155
|
-
}
|
|
156
|
-
interface AccountCollectionsIndexResponse {
|
|
157
|
-
_links: Links;
|
|
158
|
-
heirlooms: Href;
|
|
159
|
-
mounts: Href;
|
|
160
|
-
pets: Href;
|
|
161
|
-
toys: Href;
|
|
162
|
-
transmogs: Href;
|
|
163
|
-
}
|
|
164
|
-
interface AccountHeirloomsCollectionSummaryResponse {
|
|
165
|
-
_links: Links;
|
|
166
|
-
heirlooms: Array<Heirloom$1>;
|
|
167
|
-
}
|
|
168
|
-
interface Heirloom$1 {
|
|
169
|
-
heirloom: NameIdKey;
|
|
170
|
-
upgrade: {
|
|
171
|
-
level: number;
|
|
172
|
-
};
|
|
173
|
-
}
|
|
174
|
-
interface AccountMountsCollectionSummaryResponse {
|
|
175
|
-
_links: Links;
|
|
176
|
-
mounts: Array<Mount$1>;
|
|
177
|
-
}
|
|
178
|
-
interface Mount$1 {
|
|
179
|
-
is_favorite?: boolean;
|
|
180
|
-
mount: NameIdKey;
|
|
181
|
-
}
|
|
182
|
-
interface AccountPetsCollectionSummaryResponse {
|
|
183
|
-
_links: Links;
|
|
184
|
-
pets: Array<Pet$1>;
|
|
185
|
-
unlocked_battle_pet_slots: number;
|
|
186
|
-
}
|
|
187
|
-
interface Pet$1 {
|
|
188
|
-
active_slot?: number;
|
|
189
|
-
creature_display?: {
|
|
190
|
-
id: number;
|
|
191
|
-
} & KeyBase;
|
|
192
|
-
id: number;
|
|
193
|
-
is_active?: boolean;
|
|
194
|
-
is_favorite?: boolean;
|
|
195
|
-
level: number;
|
|
196
|
-
name?: string;
|
|
197
|
-
quality: Quality$1;
|
|
198
|
-
species: NameIdKey;
|
|
199
|
-
stats: Stats$1;
|
|
200
|
-
}
|
|
201
|
-
interface Quality$1 {
|
|
202
|
-
name: 'Common' | 'Poor' | 'Rare' | 'Uncommon';
|
|
203
|
-
type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
204
|
-
}
|
|
205
|
-
interface Stats$1 {
|
|
206
|
-
breed_id: number;
|
|
207
|
-
health: number;
|
|
208
|
-
power: number;
|
|
209
|
-
speed: number;
|
|
210
|
-
}
|
|
211
|
-
interface AccountToysCollectionSummaryResponse {
|
|
212
|
-
_links: Links;
|
|
213
|
-
toys: Array<Toy$1>;
|
|
214
|
-
}
|
|
215
|
-
interface Toy$1 {
|
|
216
|
-
is_favorite?: boolean;
|
|
217
|
-
toy: NameIdKey;
|
|
218
|
-
}
|
|
219
|
-
interface AccountTransmogsCollectionSummaryResponse {
|
|
220
|
-
_links: Links;
|
|
221
|
-
appearance_sets: Array<NameIdKey>;
|
|
222
|
-
slots: Array<Slot$1>;
|
|
223
|
-
}
|
|
224
|
-
interface Slot$1 {
|
|
225
|
-
appearances: Array<{
|
|
226
|
-
id: number;
|
|
227
|
-
} & KeyBase>;
|
|
228
|
-
slot: Slot$1;
|
|
229
|
-
}
|
|
230
|
-
interface Slot$1 {
|
|
231
|
-
name: string;
|
|
232
|
-
type: string;
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
/**
|
|
236
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
237
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
238
|
-
* @returns a profile summary for an account.
|
|
239
|
-
*/
|
|
240
|
-
declare function accountProfileSummary(token: string): ProtectedResource<AccountProfileSummaryResponse>;
|
|
241
|
-
/**
|
|
242
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
243
|
-
* @param realmId The realm ID.
|
|
244
|
-
* @param characterId The character ID.
|
|
245
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
246
|
-
* @returns a protected profile summary for a character.
|
|
247
|
-
*/
|
|
248
|
-
declare function protectedCharacterProfileSummary(realmId: number, characterId: number, token: string): ProtectedResource<ProtectedCharacterProfileSummaryResponse>;
|
|
249
|
-
/**
|
|
250
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
251
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
252
|
-
* @returns an index of collection types for an account.
|
|
253
|
-
*/
|
|
254
|
-
declare function accountCollectionsIndex(token: string): ProtectedResource<AccountCollectionsIndexResponse>;
|
|
255
|
-
/**
|
|
256
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
257
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
258
|
-
* @returns a summary of the heirlooms an account has obtained.
|
|
259
|
-
*/
|
|
260
|
-
declare function accountHeirloomsCollectionSummary(token: string): ProtectedResource<AccountHeirloomsCollectionSummaryResponse>;
|
|
261
|
-
/**
|
|
262
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
263
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
264
|
-
* @returns a summary of the mounts an account has obtained.
|
|
265
|
-
*/
|
|
266
|
-
declare function accountMountsCollectionSummary(token: string): ProtectedResource<AccountMountsCollectionSummaryResponse>;
|
|
267
|
-
/**
|
|
268
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
269
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
270
|
-
* @returns a summary of the battle pets an account has obtained.
|
|
271
|
-
*/
|
|
272
|
-
declare function accountPetsCollectionSummary(token: string): ProtectedResource<AccountPetsCollectionSummaryResponse>;
|
|
273
|
-
/**
|
|
274
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
275
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
276
|
-
* @returns a summary of the toys an account has obtained.
|
|
277
|
-
*/
|
|
278
|
-
declare function accountToysCollectionSummary(token: string): ProtectedResource<AccountToysCollectionSummaryResponse>;
|
|
279
|
-
/**
|
|
280
|
-
* Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See {@link https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow}
|
|
281
|
-
* @param token The OAuth 2.0 access token to use for authentication.
|
|
282
|
-
* @returns a summary of the transmog unlocks an account has obtained.
|
|
283
|
-
*/
|
|
284
|
-
declare function accountTransmogsCollectionSummary(token: string): ProtectedResource<AccountTransmogsCollectionSummaryResponse>;
|
|
285
|
-
|
|
286
|
-
/**
|
|
287
|
-
* Interface for a response from the achievement category endpoint.
|
|
288
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
289
|
-
*/
|
|
290
|
-
interface AchievementCategoryResponse extends ResponseBase, NameId {
|
|
291
|
-
achievements: Array<NameIdKey>;
|
|
292
|
-
aggregates_by_faction: {
|
|
293
|
-
alliance: {
|
|
294
|
-
points: number;
|
|
295
|
-
quantity: number;
|
|
296
|
-
};
|
|
297
|
-
horde: {
|
|
298
|
-
points: number;
|
|
299
|
-
quantity: number;
|
|
300
|
-
};
|
|
301
|
-
};
|
|
302
|
-
display_order: number;
|
|
303
|
-
isGuildCategory: boolean;
|
|
304
|
-
parent_category: NameIdKey;
|
|
305
|
-
}
|
|
306
|
-
/**
|
|
307
|
-
* Interface for a response from the achievement category index endpoint.
|
|
308
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
309
|
-
*/
|
|
310
|
-
interface AchievementCategoryIndexResponse extends ResponseBase {
|
|
311
|
-
categories: Array<NameIdKey>;
|
|
312
|
-
guild_categories: Array<NameIdKey>;
|
|
313
|
-
root_categories: Array<NameIdKey>;
|
|
314
|
-
}
|
|
315
|
-
/**
|
|
316
|
-
* Interface for a response from the achievement endpoint.
|
|
317
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
318
|
-
*/
|
|
319
|
-
interface AchievementResponse extends ResponseBase, NameId {
|
|
320
|
-
category: NameIdKey;
|
|
321
|
-
criteria: {
|
|
322
|
-
amount: number;
|
|
323
|
-
description: string;
|
|
324
|
-
id: number;
|
|
325
|
-
};
|
|
326
|
-
description: string;
|
|
327
|
-
display_order: number;
|
|
328
|
-
is_account_wide: boolean;
|
|
329
|
-
media: KeyBase;
|
|
330
|
-
points: number;
|
|
331
|
-
}
|
|
332
|
-
/**
|
|
333
|
-
* Interface for a response from the achievement index endpoint.
|
|
334
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
335
|
-
*/
|
|
336
|
-
interface AchievementIndexResponse extends ResponseBase {
|
|
337
|
-
achievements: Array<NameIdKey>;
|
|
338
|
-
}
|
|
339
|
-
interface AchievementMediaItem {
|
|
340
|
-
file_data_id: number;
|
|
341
|
-
key: string;
|
|
342
|
-
value: string;
|
|
343
|
-
}
|
|
344
|
-
/**
|
|
345
|
-
* Interface for a response from the achievement media endpoint.
|
|
346
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
347
|
-
*/
|
|
348
|
-
interface AchievementMediaResponse extends ResponseBase {
|
|
349
|
-
assets: Array<AchievementMediaItem>;
|
|
350
|
-
id: number;
|
|
351
|
-
}
|
|
352
|
-
|
|
353
|
-
/**
|
|
354
|
-
* Get an achievement category by ID.
|
|
355
|
-
* @param achievementCategoryId The achievement category ID.
|
|
356
|
-
* @returns The achievement category. See {@link AchievementCategoryResponse}.
|
|
357
|
-
*/
|
|
358
|
-
declare function achievementCategory(achievementCategoryId: number): Resource<AchievementCategoryResponse>;
|
|
359
|
-
/**
|
|
360
|
-
* Get an achievement category index.
|
|
361
|
-
* @returns The achievement category index. See {@link AchievementCategoryIndexResponse}.
|
|
362
|
-
*/
|
|
363
|
-
declare function achievementCategoryIndex(): Resource<AchievementCategoryIndexResponse>;
|
|
364
|
-
/**
|
|
365
|
-
* Get an achievement by ID.
|
|
366
|
-
* @param achievementId The achievement ID.
|
|
367
|
-
* @returns The achievement. See {@link AchievementResponse}.
|
|
368
|
-
*/
|
|
369
|
-
declare function achievement(achievementId: number): Resource<AchievementResponse>;
|
|
370
|
-
/**
|
|
371
|
-
* Get an achievement index.
|
|
372
|
-
* @returns The achievement index. See {@link AchievementIndexResponse}.
|
|
373
|
-
*/
|
|
374
|
-
declare function achievementIndex(): Resource<AchievementIndexResponse>;
|
|
375
|
-
/**
|
|
376
|
-
* Get achievement media by ID.
|
|
377
|
-
* @param achievementId The achievement ID.
|
|
378
|
-
* @returns The achievement media. See {@link AchievementMediaResponse}.
|
|
379
|
-
*/
|
|
380
|
-
declare function achievementMedia(achievementId: number): Resource<AchievementMediaResponse>;
|
|
381
|
-
|
|
382
|
-
type AuctionHouseTimeLeft = 'LONG' | 'MEDIUM' | 'SHORT' | 'VERY_LONG';
|
|
383
|
-
interface AuctionHousePosting {
|
|
384
|
-
bid: number;
|
|
385
|
-
buyout: number;
|
|
386
|
-
id: number;
|
|
387
|
-
item: {
|
|
388
|
-
bonus_lists: Array<number>;
|
|
389
|
-
context: number;
|
|
390
|
-
id: number;
|
|
391
|
-
modifiers: Array<{
|
|
392
|
-
type: number;
|
|
393
|
-
value: number;
|
|
394
|
-
}>;
|
|
395
|
-
};
|
|
396
|
-
quantity: number;
|
|
397
|
-
time_left: AuctionHouseTimeLeft;
|
|
398
|
-
}
|
|
399
|
-
/**
|
|
400
|
-
* Interface for a response from the auction house endpoint.
|
|
401
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
402
|
-
*/
|
|
403
|
-
interface AuctionHouseResponse extends ResponseBase {
|
|
404
|
-
auctions: Array<AuctionHousePosting>;
|
|
405
|
-
commodities: {
|
|
406
|
-
href: string;
|
|
407
|
-
};
|
|
408
|
-
connected_realm: {
|
|
409
|
-
href: string;
|
|
410
|
-
};
|
|
411
|
-
}
|
|
412
|
-
interface AuctionHouseCommodity {
|
|
413
|
-
id: number;
|
|
414
|
-
item: {
|
|
415
|
-
id: number;
|
|
416
|
-
};
|
|
417
|
-
quantity: number;
|
|
418
|
-
time_left: AuctionHouseTimeLeft;
|
|
419
|
-
unit_price: number;
|
|
420
|
-
}
|
|
421
|
-
/**
|
|
422
|
-
* Interface for a response from the auction house commodities endpoint.
|
|
423
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
424
|
-
*/
|
|
425
|
-
interface AuctionHouseCommoditiesResponse extends ResponseBase {
|
|
426
|
-
auctions: Array<AuctionHouseCommodity>;
|
|
427
|
-
}
|
|
428
|
-
|
|
429
|
-
/**
|
|
430
|
-
* Get auction house data for a connected realm.
|
|
431
|
-
* @param connectedRealmId The ID of the connected realm.
|
|
432
|
-
* @returns The auction house data. See {@link AuctionHouseResponse}.
|
|
433
|
-
*/
|
|
434
|
-
declare function auctions(connectedRealmId: number): Resource<AuctionHouseResponse>;
|
|
435
|
-
/**
|
|
436
|
-
* Get auction house data for all connected realms.
|
|
437
|
-
* @returns The auction house data. See {@link AuctionHouseResponse}.
|
|
438
|
-
*/
|
|
439
|
-
declare function commodities(): Resource<AuctionHouseCommoditiesResponse>;
|
|
440
|
-
|
|
441
|
-
/**
|
|
442
|
-
* Interface for a response from the azerite essence index endpoint.
|
|
443
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
444
|
-
*/
|
|
445
|
-
interface AzeriteEssenceIndexResponse extends ResponseBase {
|
|
446
|
-
azerite_essences: Array<NameIdKey>;
|
|
447
|
-
}
|
|
448
|
-
/**
|
|
449
|
-
* Interface for a response from the azerite essence endpoint.
|
|
450
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
451
|
-
*/
|
|
452
|
-
interface AzeriteEssenceResponse extends ResponseBase, NameId {
|
|
453
|
-
allowed_specializations: Array<NameIdKey>;
|
|
454
|
-
media: Media$f;
|
|
455
|
-
powers: Array<Power>;
|
|
456
|
-
}
|
|
457
|
-
interface Media$f extends KeyBase {
|
|
458
|
-
id: number;
|
|
459
|
-
}
|
|
460
|
-
interface Power {
|
|
461
|
-
id: number;
|
|
462
|
-
main_power_spell: NameIdKey;
|
|
463
|
-
passive_power_spell: NameIdKey;
|
|
464
|
-
rank: number;
|
|
465
|
-
}
|
|
466
|
-
/**
|
|
467
|
-
* Interface for a response from the azerite essence media endpoint.
|
|
468
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
469
|
-
*/
|
|
470
|
-
interface AzeriteEssenceMediaResponse extends ResponseBase {
|
|
471
|
-
assets: Array<MediaAsset$1>;
|
|
472
|
-
id: number;
|
|
473
|
-
}
|
|
474
|
-
/**
|
|
475
|
-
* Interface for search parameters for azerite essences.
|
|
476
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
477
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
478
|
-
*/
|
|
479
|
-
interface AzeriteEssenceSearchParameters extends BaseSearchParameters {
|
|
480
|
-
'allowed_specializations.id'?: number;
|
|
481
|
-
}
|
|
482
|
-
/**
|
|
483
|
-
* Interface for a response item from the azerite essence search endpoint.
|
|
484
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
485
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
486
|
-
*/
|
|
487
|
-
interface AzeriteEssenceSearchResponseItem extends KeyBase {
|
|
488
|
-
data: {
|
|
489
|
-
allowed_specializations: Array<NameId>;
|
|
490
|
-
name: Record<Locales, string>;
|
|
491
|
-
};
|
|
492
|
-
}
|
|
493
|
-
|
|
494
|
-
/**
|
|
495
|
-
* Get an azerite essence by ID.
|
|
496
|
-
* @param azeriteEssenceId The azerite essence ID.
|
|
497
|
-
* @returns The azerite essence. See {@link AzeriteEssenceResponse}.
|
|
498
|
-
*/
|
|
499
|
-
declare function azeriteEssence(azeriteEssenceId: number): Resource<AzeriteEssenceResponse>;
|
|
500
|
-
/**
|
|
501
|
-
* Get an azerite essence index.
|
|
502
|
-
* @returns The azerite essence index. See {@link AzeriteEssenceIndexResponse}.
|
|
503
|
-
*/
|
|
504
|
-
declare function azeriteEssenceIndex(): Resource<AzeriteEssenceIndexResponse>;
|
|
505
|
-
/**
|
|
506
|
-
* Get azerite essence media by ID.
|
|
507
|
-
* @param azeriteEssenceId The azerite essence ID.
|
|
508
|
-
* @returns The azerite essence media. See {@link AzeriteEssenceMediaResponse}.
|
|
509
|
-
*/
|
|
510
|
-
declare function azeriteEssenceMedia(azeriteEssenceId: number): Resource<AzeriteEssenceMediaResponse>;
|
|
511
|
-
/**
|
|
512
|
-
* Search for azerite essences.
|
|
513
|
-
* @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
|
|
514
|
-
* @returns The search results. See {@link SearchResponse}.
|
|
515
|
-
*/
|
|
516
|
-
declare function azeriteEssenceSearch(options: AzeriteEssenceSearchParameters): Resource<SearchResponse<AzeriteEssenceSearchResponseItem>, AzeriteEssenceSearchParameters>;
|
|
517
|
-
|
|
518
|
-
interface CharacterAchievementsSummaryResponse extends ResponseBase {
|
|
519
|
-
achievements: Array<Achievement$1>;
|
|
520
|
-
category_progress: Array<CategoryProgress$1>;
|
|
521
|
-
character: Character$2;
|
|
522
|
-
recent_events: Array<RecentEvent$1>;
|
|
523
|
-
statistics: Href;
|
|
524
|
-
total_points: number;
|
|
525
|
-
total_quantity: number;
|
|
526
|
-
}
|
|
527
|
-
interface Achievement$1 {
|
|
528
|
-
achievement: NameIdKey;
|
|
529
|
-
completed_timestamp?: number;
|
|
530
|
-
criteria?: Criteria$1;
|
|
531
|
-
id: number;
|
|
532
|
-
}
|
|
533
|
-
interface Criteria$1 {
|
|
534
|
-
amount?: number;
|
|
535
|
-
child_criteria?: Array<Criteria$1>;
|
|
536
|
-
id: number;
|
|
537
|
-
is_completed: boolean;
|
|
538
|
-
}
|
|
539
|
-
interface CategoryProgress$1 {
|
|
540
|
-
category: NameIdKey;
|
|
541
|
-
points: number;
|
|
542
|
-
quantity: number;
|
|
543
|
-
}
|
|
544
|
-
interface RecentEvent$1 {
|
|
545
|
-
achievement: NameIdKey;
|
|
546
|
-
timestamp: number;
|
|
547
|
-
}
|
|
548
|
-
interface CharacterAchievementStatisticsResponse extends ResponseBase {
|
|
549
|
-
categories: Array<Category$2>;
|
|
550
|
-
character: Character$2;
|
|
551
|
-
}
|
|
552
|
-
interface Category$2 {
|
|
553
|
-
id: number;
|
|
554
|
-
name: string;
|
|
555
|
-
statistics: Array<Statistic>;
|
|
556
|
-
sub_categories: Array<SubCategory>;
|
|
557
|
-
}
|
|
558
|
-
interface SubCategory {
|
|
559
|
-
id: number;
|
|
560
|
-
name: string;
|
|
561
|
-
statistics: Array<Statistic>;
|
|
562
|
-
}
|
|
563
|
-
interface Statistic {
|
|
564
|
-
description?: string;
|
|
565
|
-
id: number;
|
|
566
|
-
last_updated_timestamp: number;
|
|
567
|
-
name: string;
|
|
568
|
-
quantity: number;
|
|
569
|
-
}
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
* @param realmSlug The slug of the realm.
|
|
573
|
-
* @param characterName The lowercase name of the character.
|
|
574
|
-
* @returns a summary of the achievements a character has completed.
|
|
575
|
-
*/
|
|
576
|
-
declare function characterAchievementsSummary(realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
|
|
577
|
-
/**
|
|
578
|
-
* @param realmSlug The slug of the realm.
|
|
579
|
-
* @param characterName The lowercase name of the character.
|
|
580
|
-
* @returns a character's statistics as they pertain to achievements.
|
|
581
|
-
*/
|
|
582
|
-
declare function characterAchievementStatistics(realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
|
|
583
|
-
|
|
584
|
-
interface CharacterAppearanceResponse extends ResponseBase {
|
|
585
|
-
active_spec: NameIdKey;
|
|
586
|
-
character: Character$2;
|
|
587
|
-
customizations: Array<Customization>;
|
|
588
|
-
faction: Faction;
|
|
589
|
-
gender: Gender;
|
|
590
|
-
guild_crest: GuildCrest;
|
|
591
|
-
items: Array<Item$2>;
|
|
592
|
-
playable_class: NameIdKey;
|
|
593
|
-
playable_race: NameIdKey;
|
|
594
|
-
}
|
|
595
|
-
interface Customization {
|
|
596
|
-
choice: Choice;
|
|
597
|
-
option: NameId;
|
|
598
|
-
}
|
|
599
|
-
interface Choice {
|
|
600
|
-
display_order: number;
|
|
601
|
-
id: number;
|
|
602
|
-
name?: string;
|
|
603
|
-
}
|
|
604
|
-
interface GuildCrest {
|
|
605
|
-
background: {
|
|
606
|
-
color: RGBWithId;
|
|
607
|
-
};
|
|
608
|
-
border: BorderEmblem;
|
|
609
|
-
emblem: BorderEmblem;
|
|
610
|
-
}
|
|
611
|
-
interface RGBWithId {
|
|
612
|
-
id: number;
|
|
613
|
-
rgba: Color;
|
|
614
|
-
}
|
|
615
|
-
interface BorderEmblem {
|
|
616
|
-
color: RGBWithId;
|
|
617
|
-
id: number;
|
|
618
|
-
media: {
|
|
619
|
-
id: number;
|
|
620
|
-
} & KeyBase;
|
|
621
|
-
}
|
|
622
|
-
interface Item$2 {
|
|
623
|
-
enchant: number;
|
|
624
|
-
id: number;
|
|
625
|
-
internal_slot_id: number;
|
|
626
|
-
item_appearance_modifier_id: number;
|
|
627
|
-
slot: {
|
|
628
|
-
name: string;
|
|
629
|
-
type: string;
|
|
630
|
-
};
|
|
631
|
-
subclass: number;
|
|
632
|
-
}
|
|
633
|
-
|
|
634
|
-
/**
|
|
635
|
-
* @param realmSlug The slug of the realm.
|
|
636
|
-
* @param characterName The lowercase name of the character.
|
|
637
|
-
* @returns a summary of a character's appearance settings.
|
|
638
|
-
*/
|
|
639
|
-
declare function characterAppearanceSummary(realmSlug: string, characterName: string): Resource<CharacterAppearanceResponse>;
|
|
640
|
-
|
|
641
|
-
interface CharacterCollectionsIndexResponse extends ResponseBase {
|
|
642
|
-
character: Character$2;
|
|
643
|
-
heirlooms: Href;
|
|
644
|
-
mounts: Href;
|
|
645
|
-
pets: Href;
|
|
646
|
-
toys: Href;
|
|
647
|
-
transmogs: Href;
|
|
648
|
-
}
|
|
649
|
-
interface CharacterHeirloomsCollectionSummaryResponse extends ResponseBase {
|
|
650
|
-
heirlooms: Array<Heirloom>;
|
|
651
|
-
}
|
|
652
|
-
interface Heirloom {
|
|
653
|
-
heirloom: NameIdKey;
|
|
654
|
-
upgrade: {
|
|
655
|
-
level: number;
|
|
656
|
-
};
|
|
657
|
-
}
|
|
658
|
-
interface CharacterMountsCollectionSummaryResponse extends ResponseBase {
|
|
659
|
-
mounts: Array<Mount>;
|
|
660
|
-
}
|
|
661
|
-
interface Mount {
|
|
662
|
-
is_character_specific?: boolean;
|
|
663
|
-
is_favorite?: boolean;
|
|
664
|
-
is_useable: boolean;
|
|
665
|
-
mount: NameIdKey;
|
|
666
|
-
}
|
|
667
|
-
interface CharacterPetsCollectionSummaryResponse extends ResponseBase {
|
|
668
|
-
pets: Array<Pet>;
|
|
669
|
-
unlocked_battle_pet_slots: number;
|
|
670
|
-
}
|
|
671
|
-
interface Pet {
|
|
672
|
-
active_slot?: number;
|
|
673
|
-
creature_display?: {
|
|
674
|
-
id: number;
|
|
675
|
-
} & KeyBase;
|
|
676
|
-
id: number;
|
|
677
|
-
is_active?: boolean;
|
|
678
|
-
is_favorite?: boolean;
|
|
679
|
-
level: number;
|
|
680
|
-
name?: string;
|
|
681
|
-
quality: Quality;
|
|
682
|
-
species: NameIdKey;
|
|
683
|
-
stats: Stats;
|
|
684
|
-
}
|
|
685
|
-
interface Quality {
|
|
686
|
-
name: 'Common' | 'Poor' | 'Rare' | 'Uncommon';
|
|
687
|
-
type: 'COMMON' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
688
|
-
}
|
|
689
|
-
interface Stats {
|
|
690
|
-
breed_id: number;
|
|
691
|
-
health: number;
|
|
692
|
-
power: number;
|
|
693
|
-
speed: number;
|
|
694
|
-
}
|
|
695
|
-
interface CharacterToysCollectionSummaryResponse extends ResponseBase {
|
|
696
|
-
toys: Array<Toy>;
|
|
697
|
-
}
|
|
698
|
-
interface Toy {
|
|
699
|
-
is_favorite?: boolean;
|
|
700
|
-
toy: NameIdKey;
|
|
701
|
-
}
|
|
702
|
-
interface CharacterTransmogCollectionSummaryResponse extends ResponseBase {
|
|
703
|
-
appearance_sets: Array<NameIdKey>;
|
|
704
|
-
slots: Array<Slot>;
|
|
705
|
-
}
|
|
706
|
-
interface Slot {
|
|
707
|
-
appearances: Array<{
|
|
708
|
-
id: number;
|
|
709
|
-
} & KeyBase>;
|
|
710
|
-
slot: Slot;
|
|
711
|
-
}
|
|
712
|
-
interface Slot {
|
|
713
|
-
name: string;
|
|
714
|
-
type: string;
|
|
715
|
-
}
|
|
716
|
-
|
|
717
|
-
/**
|
|
718
|
-
* @param realmSlug The slug of the realm.
|
|
719
|
-
* @param characterName The lowercase name of the character.
|
|
720
|
-
* @returns an index of collection types for a character.
|
|
721
|
-
*/
|
|
722
|
-
declare function characterCollectionsIndex(realmSlug: string, characterName: string): Resource<CharacterCollectionsIndexResponse>;
|
|
723
|
-
/**
|
|
724
|
-
* @param realmSlug The slug of the realm.
|
|
725
|
-
* @param characterName The lowercase name of the character.
|
|
726
|
-
* @returns a summary of the heirlooms a character has obtained.
|
|
727
|
-
*/
|
|
728
|
-
declare function characterHeirloomsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterHeirloomsCollectionSummaryResponse>;
|
|
729
|
-
/**
|
|
730
|
-
* @param realmSlug The slug of the realm.
|
|
731
|
-
* @param characterName The lowercase name of the character.
|
|
732
|
-
* @returns a summary of the mounts a character has obtained.
|
|
733
|
-
*/
|
|
734
|
-
declare function characterMountsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterMountsCollectionSummaryResponse>;
|
|
735
|
-
/**
|
|
736
|
-
* @param realmSlug The slug of the realm.
|
|
737
|
-
* @param characterName The lowercase name of the character.
|
|
738
|
-
* @returns a summary of the battle pets a character has obtained.
|
|
739
|
-
*/
|
|
740
|
-
declare function characterPetsCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterPetsCollectionSummaryResponse>;
|
|
741
|
-
/**
|
|
742
|
-
* @param realmSlug The slug of the realm.
|
|
743
|
-
* @param characterName The lowercase name of the character.
|
|
744
|
-
* @returns a summary of the toys a character has obtained.
|
|
745
|
-
*/
|
|
746
|
-
declare function characterToysCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterToysCollectionSummaryResponse>;
|
|
747
|
-
/**
|
|
748
|
-
* @param realmSlug The slug of the realm.
|
|
749
|
-
* @param characterName The lowercase name of the character.
|
|
750
|
-
* @returns a summary of the transmog unlocks a character has obtained.
|
|
751
|
-
*/
|
|
752
|
-
declare function characterTransmogCollectionSummary(realmSlug: string, characterName: string): Resource<CharacterTransmogCollectionSummaryResponse>;
|
|
753
|
-
|
|
754
|
-
interface CharacterEncountersSummaryResponse extends ResponseBase {
|
|
755
|
-
character: Character$2;
|
|
756
|
-
dungeons: Href;
|
|
757
|
-
raids: Href;
|
|
758
|
-
}
|
|
759
|
-
interface CharacterDungeonsResponse extends ResponseBase {
|
|
760
|
-
expansions: Array<Expansion<DungeonMode>>;
|
|
761
|
-
}
|
|
762
|
-
interface Expansion<T> {
|
|
763
|
-
expansion: NameIdKey;
|
|
764
|
-
instances: Array<Instance<T>>;
|
|
765
|
-
}
|
|
766
|
-
interface Instance<T> {
|
|
767
|
-
instance: NameIdKey;
|
|
768
|
-
modes: Array<T>;
|
|
769
|
-
}
|
|
770
|
-
interface DungeonMode {
|
|
771
|
-
difficulty: DungeonDifficulties;
|
|
772
|
-
progress: Progress;
|
|
773
|
-
status: Status;
|
|
774
|
-
}
|
|
775
|
-
interface Status {
|
|
776
|
-
name: 'Complete' | 'In Progress';
|
|
777
|
-
type: 'COMPLETE' | 'IN_PROGRESS';
|
|
778
|
-
}
|
|
779
|
-
interface DungeonDifficulties {
|
|
780
|
-
name: 'Heroic' | 'Mythic' | 'Mythic+ Dungeons' | 'Normal';
|
|
781
|
-
type: 'HEROIC' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
|
|
782
|
-
}
|
|
783
|
-
interface Progress {
|
|
784
|
-
completed_count: number;
|
|
785
|
-
encounters: Array<Encounter>;
|
|
786
|
-
total_count: number;
|
|
787
|
-
}
|
|
788
|
-
interface Encounter {
|
|
789
|
-
completed_count: number;
|
|
790
|
-
encounter: NameIdKey;
|
|
791
|
-
last_kill_timestamp: number;
|
|
792
|
-
}
|
|
793
|
-
interface CharacterRaidsResponse extends ResponseBase {
|
|
794
|
-
character: Character$2;
|
|
795
|
-
expansions: Array<Expansion<RaidMode>>;
|
|
796
|
-
}
|
|
797
|
-
interface RaidMode {
|
|
798
|
-
difficulty: RaidDifficulties;
|
|
799
|
-
progress: Progress;
|
|
800
|
-
status: Status;
|
|
801
|
-
}
|
|
802
|
-
interface RaidDifficulties {
|
|
803
|
-
name: '10 Player' | '10 Player (Heroic)' | '25 Player' | '25 Player (Heroic)' | 'Heroic' | 'Mythic' | 'Normal' | 'Raid Finder';
|
|
804
|
-
type: 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
|
|
805
|
-
}
|
|
806
|
-
|
|
807
|
-
/**
|
|
808
|
-
* @param realmSlug The slug of the realm.
|
|
809
|
-
* @param characterName The lowercase name of the character.
|
|
810
|
-
* @returns a summary of a character's encounters.
|
|
811
|
-
*/
|
|
812
|
-
declare function characterEncountersSummary(realmSlug: string, characterName: string): Resource<CharacterEncountersSummaryResponse>;
|
|
813
|
-
/**
|
|
814
|
-
* @param realmSlug The slug of the realm.
|
|
815
|
-
* @param characterName The lowercase name of the character.
|
|
816
|
-
* @returns a summary of a character's completed dungeons.
|
|
817
|
-
*/
|
|
818
|
-
declare function characterDungeons(realmSlug: string, characterName: string): Resource<CharacterDungeonsResponse>;
|
|
819
|
-
/**
|
|
820
|
-
* @param realmSlug The slug of the realm.
|
|
821
|
-
* @param characterName The lowercase name of the character.
|
|
822
|
-
* @returns a summary of a character's completed raids.
|
|
823
|
-
*/
|
|
824
|
-
declare function characterRaids(realmSlug: string, characterName: string): Resource<CharacterRaidsResponse>;
|
|
825
|
-
|
|
826
|
-
interface CharacterEquipmentSummaryResponse extends ResponseBase {
|
|
827
|
-
character: Character$2;
|
|
828
|
-
equipped_item_sets: Array<Set>;
|
|
829
|
-
equipped_items: Array<EquippedItem>;
|
|
830
|
-
}
|
|
831
|
-
interface Set {
|
|
832
|
-
display_string: string;
|
|
833
|
-
effects: Array<Effect$1>;
|
|
834
|
-
item_set: NameIdKey;
|
|
835
|
-
items: Array<ItemElement>;
|
|
836
|
-
}
|
|
837
|
-
interface Effect$1 {
|
|
838
|
-
display_string: string;
|
|
839
|
-
is_active: boolean;
|
|
840
|
-
required_count: number;
|
|
841
|
-
}
|
|
842
|
-
interface ItemElement extends NameIdKey {
|
|
843
|
-
is_equipped?: boolean;
|
|
844
|
-
}
|
|
845
|
-
interface EquippedItem {
|
|
846
|
-
armor?: Armor$1;
|
|
847
|
-
binding: NameType;
|
|
848
|
-
bonus_list?: Array<number>;
|
|
849
|
-
context: number;
|
|
850
|
-
description?: string;
|
|
851
|
-
durability?: DisplayStringValue;
|
|
852
|
-
enchantments?: Array<Enchantment>;
|
|
853
|
-
inventory_type: NameType;
|
|
854
|
-
is_subclass_hidden?: boolean;
|
|
855
|
-
item: {
|
|
856
|
-
id: number;
|
|
857
|
-
} & KeyBase;
|
|
858
|
-
item_class: NameIdKey;
|
|
859
|
-
item_subclass: NameIdKey;
|
|
860
|
-
level: DisplayStringValue;
|
|
861
|
-
limit_category?: string;
|
|
862
|
-
media: {
|
|
863
|
-
id: number;
|
|
864
|
-
} & KeyBase;
|
|
865
|
-
modified_appearance_id?: number;
|
|
866
|
-
modified_crafting_stat?: Array<ModifiedCraftingStat>;
|
|
867
|
-
name: string;
|
|
868
|
-
name_description: NameDescription;
|
|
869
|
-
quality: NameType;
|
|
870
|
-
quantity: number;
|
|
871
|
-
requirements?: Requirements$3;
|
|
872
|
-
sell_price?: SellPrice;
|
|
873
|
-
set?: Set;
|
|
874
|
-
slot: NameType;
|
|
875
|
-
sockets?: Array<Socket$1>;
|
|
876
|
-
spells?: Array<Spell$1>;
|
|
877
|
-
stats?: Array<Stat$2>;
|
|
878
|
-
transmog?: Transmog;
|
|
879
|
-
unique_equipped?: string;
|
|
880
|
-
weapon?: Weapon$2;
|
|
881
|
-
}
|
|
882
|
-
interface Armor$1 {
|
|
883
|
-
display: NameDescription;
|
|
884
|
-
value: number;
|
|
885
|
-
}
|
|
886
|
-
interface NameDescription {
|
|
887
|
-
color: Color;
|
|
888
|
-
display_string: string;
|
|
889
|
-
}
|
|
890
|
-
interface NameType {
|
|
891
|
-
name: string;
|
|
892
|
-
type: string;
|
|
893
|
-
}
|
|
894
|
-
interface DisplayStringValue {
|
|
895
|
-
display_string: string;
|
|
896
|
-
value: number;
|
|
897
|
-
}
|
|
898
|
-
interface Enchantment {
|
|
899
|
-
display_string: string;
|
|
900
|
-
enchantment_id: number;
|
|
901
|
-
enchantment_slot: EnchantmentSlot;
|
|
902
|
-
source_item?: NameIdKey;
|
|
903
|
-
}
|
|
904
|
-
interface EnchantmentSlot {
|
|
905
|
-
id: number;
|
|
906
|
-
type: string;
|
|
907
|
-
}
|
|
908
|
-
interface ModifiedCraftingStat {
|
|
909
|
-
id: number;
|
|
910
|
-
name: string;
|
|
911
|
-
type: string;
|
|
912
|
-
}
|
|
913
|
-
interface Requirements$3 {
|
|
914
|
-
level: DisplayStringValue;
|
|
915
|
-
playable_classes?: PlayableClasses;
|
|
916
|
-
}
|
|
917
|
-
interface PlayableClasses {
|
|
918
|
-
display_string: string;
|
|
919
|
-
links: Array<NameIdKey>;
|
|
920
|
-
}
|
|
921
|
-
interface SellPrice {
|
|
922
|
-
display_strings: DisplayStrings;
|
|
923
|
-
value: number;
|
|
924
|
-
}
|
|
925
|
-
interface DisplayStrings {
|
|
926
|
-
copper: string;
|
|
927
|
-
gold: string;
|
|
928
|
-
header: string;
|
|
929
|
-
silver: string;
|
|
930
|
-
}
|
|
931
|
-
interface Socket$1 {
|
|
932
|
-
display_string: string;
|
|
933
|
-
item: NameIdKey;
|
|
934
|
-
media: {
|
|
935
|
-
id: number;
|
|
936
|
-
} & KeyBase;
|
|
937
|
-
socket_type: NameType;
|
|
938
|
-
}
|
|
939
|
-
interface Spell$1 {
|
|
940
|
-
description: string;
|
|
941
|
-
spell: NameIdKey;
|
|
942
|
-
}
|
|
943
|
-
interface Stat$2 {
|
|
944
|
-
display: NameDescription;
|
|
945
|
-
is_equip_bonus?: boolean;
|
|
946
|
-
is_negated?: boolean;
|
|
947
|
-
type: NameType;
|
|
948
|
-
value: number;
|
|
949
|
-
}
|
|
950
|
-
interface Transmog {
|
|
951
|
-
display_string: string;
|
|
952
|
-
item: NameIdKey;
|
|
953
|
-
item_modified_appearance_id: number;
|
|
954
|
-
}
|
|
955
|
-
interface Weapon$2 {
|
|
956
|
-
attack_speed: DisplayStringValue;
|
|
957
|
-
damage: Damage$2;
|
|
958
|
-
dps: DisplayStringValue;
|
|
959
|
-
}
|
|
960
|
-
interface Damage$2 {
|
|
961
|
-
damage_class: NameType;
|
|
962
|
-
display_string: string;
|
|
963
|
-
max_value: number;
|
|
964
|
-
min_value: number;
|
|
965
|
-
}
|
|
966
|
-
|
|
967
|
-
/**
|
|
968
|
-
* @param realmSlug The slug of the realm.
|
|
969
|
-
* @param characterName The lowercase name of the character.
|
|
970
|
-
* @returns a summary of the items equipped by a character.
|
|
971
|
-
*/
|
|
972
|
-
declare function characterEquipmentSummary(realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
|
|
973
|
-
|
|
974
|
-
interface CharacterHunterPetsSummaryResponse extends ResponseBase {
|
|
975
|
-
character: Character$2;
|
|
976
|
-
hunter_pets: Array<HunterPet>;
|
|
977
|
-
}
|
|
978
|
-
interface HunterPet {
|
|
979
|
-
creature: NameIdKey;
|
|
980
|
-
creature_display: {
|
|
981
|
-
id: number;
|
|
982
|
-
} & KeyBase;
|
|
983
|
-
is_active?: boolean;
|
|
984
|
-
is_summoned?: boolean;
|
|
985
|
-
level: number;
|
|
986
|
-
name: string;
|
|
987
|
-
slot: number;
|
|
988
|
-
}
|
|
989
|
-
|
|
990
|
-
/**
|
|
991
|
-
* If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
|
|
992
|
-
* @param realmSlug The slug of the realm.
|
|
993
|
-
* @param characterName The lowercase name of the character.
|
|
994
|
-
* @returns a summary of the character's hunter pets.
|
|
995
|
-
*/
|
|
996
|
-
declare function characterHunterPetsSummary(realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
|
|
997
|
-
|
|
998
|
-
interface CharacterMediaSummaryResponse extends ResponseBase {
|
|
999
|
-
assets: Array<Asset$1>;
|
|
1000
|
-
character: Character$2;
|
|
1001
|
-
}
|
|
1002
|
-
interface Asset$1 {
|
|
1003
|
-
key: string;
|
|
1004
|
-
value: string;
|
|
1005
|
-
}
|
|
1006
|
-
|
|
1007
|
-
/**
|
|
1008
|
-
* @param realmSlug The slug of the realm.
|
|
1009
|
-
* @param characterName The lowercase name of the character.
|
|
1010
|
-
* @returns a summary of the media assets available for a character (such as an avatar render).
|
|
1011
|
-
*/
|
|
1012
|
-
declare function characterMediaSummary(realmSlug: string, characterName: string): Resource<CharacterMediaSummaryResponse>;
|
|
1013
|
-
|
|
1014
|
-
interface CharacterMythicKeystoneProfileIndexResponse extends ResponseBase {
|
|
1015
|
-
character: Character$2;
|
|
1016
|
-
current_period: CurrentPeriod;
|
|
1017
|
-
seasons: Array<{
|
|
1018
|
-
id: number;
|
|
1019
|
-
} & KeyBase>;
|
|
1020
|
-
}
|
|
1021
|
-
interface CurrentPeriod {
|
|
1022
|
-
period: {
|
|
1023
|
-
id: number;
|
|
1024
|
-
} & KeyBase;
|
|
1025
|
-
}
|
|
1026
|
-
interface CharacterMythicKeystoneSeasonDetailsResponse extends ResponseBase {
|
|
1027
|
-
best_runs: Array<BestRun>;
|
|
1028
|
-
character: NameIdKey;
|
|
1029
|
-
mythic_rating: MythicRating$1;
|
|
1030
|
-
season: {
|
|
1031
|
-
id: number;
|
|
1032
|
-
} & KeyBase;
|
|
1033
|
-
}
|
|
1034
|
-
interface BestRun {
|
|
1035
|
-
completed_timestamp: number;
|
|
1036
|
-
dungeon: NameIdKey;
|
|
1037
|
-
duration: number;
|
|
1038
|
-
is_completed_within_time: boolean;
|
|
1039
|
-
keystone_affixes: Array<NameIdKey>;
|
|
1040
|
-
keystone_level: number;
|
|
1041
|
-
members: Array<Member$2>;
|
|
1042
|
-
mythic_rating: MythicRating$1;
|
|
1043
|
-
}
|
|
1044
|
-
interface Member$2 {
|
|
1045
|
-
character: {
|
|
1046
|
-
realm: Realm$4;
|
|
1047
|
-
} & NameId;
|
|
1048
|
-
equipped_item_level: number;
|
|
1049
|
-
race: NameIdKey;
|
|
1050
|
-
specialization: NameIdKey;
|
|
1051
|
-
}
|
|
1052
|
-
interface MythicRating$1 {
|
|
1053
|
-
color: Color;
|
|
1054
|
-
rating: number;
|
|
1055
|
-
}
|
|
1056
|
-
|
|
1057
|
-
/**
|
|
1058
|
-
* @param realmSlug The slug of the realm.
|
|
1059
|
-
* @param characterName The lowercase name of the character.
|
|
1060
|
-
* @returns Returns the Mythic Keystone season details for a character. Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
|
|
1061
|
-
*/
|
|
1062
|
-
declare function characterMythicKeystoneProfileIndex(realmSlug: string, characterName: string): Resource<CharacterMythicKeystoneProfileIndexResponse>;
|
|
1063
|
-
/**
|
|
1064
|
-
* Returns the Mythic Keystone season details for a character.
|
|
1065
|
-
* Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
|
|
1066
|
-
* @param realmSlug The slug of the realm.
|
|
1067
|
-
* @param characterName The lowercase name of the character.
|
|
1068
|
-
* @param seasonId The ID of the season.
|
|
1069
|
-
* @returns the Mythic Keystone season details for a character.
|
|
1070
|
-
*/
|
|
1071
|
-
declare function characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): Resource<CharacterMythicKeystoneSeasonDetailsResponse>;
|
|
1072
|
-
|
|
1073
|
-
interface CharacterProfessionsSummaryResponse extends ResponseBase {
|
|
1074
|
-
character: Character$2;
|
|
1075
|
-
primaries: Array<Primary>;
|
|
1076
|
-
secondaries: Array<Secondary>;
|
|
1077
|
-
}
|
|
1078
|
-
interface Primary {
|
|
1079
|
-
profession: NameIdKey;
|
|
1080
|
-
tiers: Array<Tier$1>;
|
|
1081
|
-
}
|
|
1082
|
-
interface Secondary {
|
|
1083
|
-
max_skill_points?: number;
|
|
1084
|
-
profession: NameIdKey;
|
|
1085
|
-
skill_points?: number;
|
|
1086
|
-
tiers?: Array<Tier$1>;
|
|
1087
|
-
}
|
|
1088
|
-
interface Tier$1 {
|
|
1089
|
-
known_recipes?: Array<NameIdKey>;
|
|
1090
|
-
max_skill_points: number;
|
|
1091
|
-
skill_points: number;
|
|
1092
|
-
tier: NameId;
|
|
1093
|
-
}
|
|
1094
|
-
|
|
1095
|
-
/**
|
|
1096
|
-
* @param realmSlug The slug of the realm.
|
|
1097
|
-
* @param characterName The lowercase name of the character.
|
|
1098
|
-
* @returns a summary of the professions for a character.
|
|
1099
|
-
*/
|
|
1100
|
-
declare function characterProfessionsSummary(realmSlug: string, characterName: string): Resource<CharacterProfessionsSummaryResponse>;
|
|
1101
|
-
|
|
1102
|
-
interface CharacterProfileSummaryResponse extends ResponseBase {
|
|
1103
|
-
achievement_points: number;
|
|
1104
|
-
achievements: Href;
|
|
1105
|
-
achievements_statistics: Href;
|
|
1106
|
-
active_spec: NameIdKey;
|
|
1107
|
-
active_title: {
|
|
1108
|
-
display_string: string;
|
|
1109
|
-
} & NameIdKey;
|
|
1110
|
-
appearance: Href;
|
|
1111
|
-
average_item_level: number;
|
|
1112
|
-
character_class: NameIdKey;
|
|
1113
|
-
collections: Href;
|
|
1114
|
-
covenant_progress: CovenantProgress;
|
|
1115
|
-
encounters: Href;
|
|
1116
|
-
equipment: Href;
|
|
1117
|
-
equipped_item_level: number;
|
|
1118
|
-
experience: number;
|
|
1119
|
-
faction: Faction;
|
|
1120
|
-
gender: Faction;
|
|
1121
|
-
guild: Guild$2;
|
|
1122
|
-
hunter_pets: Href;
|
|
1123
|
-
id: number;
|
|
1124
|
-
last_login_timestamp: number;
|
|
1125
|
-
level: number;
|
|
1126
|
-
media: Href;
|
|
1127
|
-
mythic_keystone_profile: Href;
|
|
1128
|
-
name: string;
|
|
1129
|
-
name_search: string;
|
|
1130
|
-
professions: Href;
|
|
1131
|
-
pvp_summary: Href;
|
|
1132
|
-
quests: Href;
|
|
1133
|
-
race: NameIdKey;
|
|
1134
|
-
realm: Realm$4;
|
|
1135
|
-
reputations: Href;
|
|
1136
|
-
specializations: Href;
|
|
1137
|
-
statistics: Href;
|
|
1138
|
-
titles: Href;
|
|
1139
|
-
}
|
|
1140
|
-
interface CovenantProgress {
|
|
1141
|
-
chosen_covenant: NameIdKey;
|
|
1142
|
-
renown_level: number;
|
|
1143
|
-
soulbinds: Href;
|
|
1144
|
-
}
|
|
1145
|
-
interface Guild$2 extends NameIdKey {
|
|
1146
|
-
faction: Faction;
|
|
1147
|
-
realm: Realm$4;
|
|
1148
|
-
}
|
|
1149
|
-
interface CharacterProfileStatusResponse extends ResponseBase {
|
|
1150
|
-
id: number;
|
|
1151
|
-
is_valid: boolean;
|
|
1152
|
-
}
|
|
1153
|
-
|
|
1154
|
-
/**
|
|
1155
|
-
* @param realmSlug The slug of the realm.
|
|
1156
|
-
* @param characterName The lowercase name of the character.
|
|
1157
|
-
* @returns a summary of the character profile for a character.
|
|
1158
|
-
*/
|
|
1159
|
-
declare function characterProfileSummary(realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
|
|
1160
|
-
/**
|
|
1161
|
-
* Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
|
|
1162
|
-
* - an HTTP 404 Not Found error is returned
|
|
1163
|
-
* - the is_valid value is false
|
|
1164
|
-
* - the returned character ID doesn't match the previously recorded value for the character
|
|
1165
|
-
*
|
|
1166
|
-
* The following example illustrates how to use this endpoint:
|
|
1167
|
-
*
|
|
1168
|
-
* 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
|
|
1169
|
-
* 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
|
|
1170
|
-
* 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
|
|
1171
|
-
* 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
|
|
1172
|
-
*
|
|
1173
|
-
* @param realmSlug The slug of the realm.
|
|
1174
|
-
* @param characterName The lowercase name of the character.
|
|
1175
|
-
* @returns the status of the character profile for a character.
|
|
1176
|
-
*/
|
|
1177
|
-
declare function characterProfileStatus(realmSlug: string, characterName: string): Resource<CharacterProfileStatusResponse>;
|
|
1178
|
-
|
|
1179
|
-
interface CharacterPvpSummaryResponse extends ResponseBase {
|
|
1180
|
-
character: Character$2;
|
|
1181
|
-
honor_level: number;
|
|
1182
|
-
honorable_kills: number;
|
|
1183
|
-
pvp_map_statistics: Array<PvpMapStatistic>;
|
|
1184
|
-
}
|
|
1185
|
-
interface PvpMapStatistic {
|
|
1186
|
-
match_statistics: MatchStatistics;
|
|
1187
|
-
world_map: NameId;
|
|
1188
|
-
}
|
|
1189
|
-
interface MatchStatistics {
|
|
1190
|
-
lost: number;
|
|
1191
|
-
played: number;
|
|
1192
|
-
won: number;
|
|
1193
|
-
}
|
|
1194
|
-
|
|
1195
|
-
/**
|
|
1196
|
-
* @param realmSlug The slug of the realm.
|
|
1197
|
-
* @param characterName The lowercase name of the character.
|
|
1198
|
-
* @returns a PvP summary for a character.
|
|
1199
|
-
*/
|
|
1200
|
-
declare function characterPvpSummary(realmSlug: string, characterName: string): Resource<CharacterPvpSummaryResponse>;
|
|
1201
|
-
|
|
1202
|
-
interface CharacterQuestsResponse extends ResponseBase {
|
|
1203
|
-
character: Character$2;
|
|
1204
|
-
completed: Href;
|
|
1205
|
-
in_progress: Array<NameIdKey>;
|
|
1206
|
-
}
|
|
1207
|
-
interface CharacterCompletedQuestsResponse extends ResponseBase {
|
|
1208
|
-
character: Character$2;
|
|
1209
|
-
quests: Array<NameIdKey>;
|
|
1210
|
-
}
|
|
1211
|
-
|
|
1212
|
-
/**
|
|
1213
|
-
* @param realmSlug The slug of the realm.
|
|
1214
|
-
* @param characterName The lowercase name of the character.
|
|
1215
|
-
* @returns a character's active quests as well as a link to the character's completed quests.
|
|
1216
|
-
*/
|
|
1217
|
-
declare function characterQuests(realmSlug: string, characterName: string): Resource<CharacterQuestsResponse>;
|
|
1218
|
-
/**
|
|
1219
|
-
* @param realmSlug The slug of the realm.
|
|
1220
|
-
* @param characterName The lowercase name of the character.
|
|
1221
|
-
* @returns a list of quests that a character has completed.
|
|
1222
|
-
*/
|
|
1223
|
-
declare function characterCompletedQuests(realmSlug: string, characterName: string): Resource<CharacterCompletedQuestsResponse>;
|
|
1224
|
-
|
|
1225
|
-
interface CharacterReputationsSummaryResponse extends ResponseBase {
|
|
1226
|
-
character: Character$2;
|
|
1227
|
-
reputations: Array<Reputation$1>;
|
|
1228
|
-
}
|
|
1229
|
-
interface Reputation$1 {
|
|
1230
|
-
faction: NameIdKey;
|
|
1231
|
-
paragon?: Paragon;
|
|
1232
|
-
standing: Standing;
|
|
1233
|
-
}
|
|
1234
|
-
interface Paragon {
|
|
1235
|
-
max: number;
|
|
1236
|
-
raw: number;
|
|
1237
|
-
value: number;
|
|
1238
|
-
}
|
|
1239
|
-
interface Standing {
|
|
1240
|
-
max: number;
|
|
1241
|
-
name: string;
|
|
1242
|
-
raw: number;
|
|
1243
|
-
tier: number;
|
|
1244
|
-
value: number;
|
|
1245
|
-
}
|
|
1246
|
-
|
|
1247
|
-
/**
|
|
1248
|
-
* @param realmSlug The slug of the realm.
|
|
1249
|
-
* @param characterName The lowercase name of the character.
|
|
1250
|
-
* @returns a summary of a character's reputations.
|
|
1251
|
-
*/
|
|
1252
|
-
declare function characterReputationsSummary(realmSlug: string, characterName: string): Resource<CharacterReputationsSummaryResponse>;
|
|
1253
|
-
|
|
1254
|
-
interface CharacterSoulbindsResponse extends ResponseBase {
|
|
1255
|
-
character: Character$2;
|
|
1256
|
-
chosen_covenant: NameIdKey;
|
|
1257
|
-
renown_level: number;
|
|
1258
|
-
soulbinds: Array<Soulbind>;
|
|
1259
|
-
}
|
|
1260
|
-
interface Soulbind {
|
|
1261
|
-
is_active?: boolean;
|
|
1262
|
-
soulbind: NameIdKey;
|
|
1263
|
-
traits: Array<Trait>;
|
|
1264
|
-
}
|
|
1265
|
-
interface Trait {
|
|
1266
|
-
conduit_socket?: ConduitSocket;
|
|
1267
|
-
display_order: number;
|
|
1268
|
-
tier: number;
|
|
1269
|
-
trait?: NameIdKey;
|
|
1270
|
-
}
|
|
1271
|
-
interface ConduitSocket {
|
|
1272
|
-
socket: Socket;
|
|
1273
|
-
type: TypeClass;
|
|
1274
|
-
}
|
|
1275
|
-
interface Socket {
|
|
1276
|
-
conduit: NameIdKey;
|
|
1277
|
-
rank: number;
|
|
1278
|
-
}
|
|
1279
|
-
interface TypeClass {
|
|
1280
|
-
name: 'Endurance Conduit Slot' | 'Finesse Conduit Slot' | 'Potency Conduit Slot';
|
|
1281
|
-
type: 'ENDURANCE' | 'FINESSE' | 'POTENCY';
|
|
1282
|
-
}
|
|
1283
|
-
|
|
1284
|
-
/**
|
|
1285
|
-
* @param realmSlug The slug of the realm.
|
|
1286
|
-
* @param characterName The lowercase name of the character.
|
|
1287
|
-
* @returns a character's soulbinds.
|
|
1288
|
-
*/
|
|
1289
|
-
declare function characterSoulbinds(realmSlug: string, characterName: string): Resource<CharacterSoulbindsResponse>;
|
|
1290
|
-
|
|
1291
|
-
interface CharacterSpecializationsSummaryResponse extends ResponseBase {
|
|
1292
|
-
active_hero_talent: NameIdKey;
|
|
1293
|
-
active_specialization: NameIdKey;
|
|
1294
|
-
character: Character$2;
|
|
1295
|
-
specializations: Array<Specialization$1>;
|
|
1296
|
-
}
|
|
1297
|
-
interface Specialization$1 {
|
|
1298
|
-
glyphs?: Array<NameIdKey>;
|
|
1299
|
-
loadouts: Array<Loadout>;
|
|
1300
|
-
pvp_talent_slots?: Array<PvpTalentSlot>;
|
|
1301
|
-
specialization: NameIdKey;
|
|
1302
|
-
}
|
|
1303
|
-
interface Loadout {
|
|
1304
|
-
is_active: boolean;
|
|
1305
|
-
selected_class_talent_tree: NameIdKey;
|
|
1306
|
-
selected_class_talents: Array<SelectedTalent>;
|
|
1307
|
-
selected_spec_talent_tree: NameIdKey;
|
|
1308
|
-
selected_spec_talents?: Array<SelectedTalent>;
|
|
1309
|
-
talent_loadout_code: string;
|
|
1310
|
-
}
|
|
1311
|
-
interface SelectedTalent {
|
|
1312
|
-
default_points?: number;
|
|
1313
|
-
id: number;
|
|
1314
|
-
rank: number;
|
|
1315
|
-
tooltip: Selected;
|
|
1316
|
-
}
|
|
1317
|
-
interface Selected {
|
|
1318
|
-
spell_tooltip: SpellTooltip$2;
|
|
1319
|
-
talent: NameIdKey;
|
|
1320
|
-
}
|
|
1321
|
-
interface SpellTooltip$2 {
|
|
1322
|
-
cast_time: '1.5 sec cast' | '2.5 sec cast' | '3 sec cast' | 'Channeled' | 'Instant' | 'Passive';
|
|
1323
|
-
cooldown?: string;
|
|
1324
|
-
description: string;
|
|
1325
|
-
power_cost?: string;
|
|
1326
|
-
range?: '8-30 yd range' | '15 yd range' | '30 yd range' | '40 yd range' | '50 yd range' | '55 yd range' | '100 yd range' | 'Melee Range';
|
|
1327
|
-
spell: NameIdKey;
|
|
1328
|
-
}
|
|
1329
|
-
interface PvpTalentSlot {
|
|
1330
|
-
selected: Selected;
|
|
1331
|
-
slot_number: number;
|
|
1332
|
-
}
|
|
1333
|
-
|
|
1334
|
-
/**
|
|
1335
|
-
* @param realmSlug The slug of the realm.
|
|
1336
|
-
* @param characterName The lowercase name of the character.
|
|
1337
|
-
* @returns a summary of a character's specializations.
|
|
1338
|
-
*/
|
|
1339
|
-
declare function characterSpecializationsSummary(realmSlug: string, characterName: string): Resource<CharacterSpecializationsSummaryResponse>;
|
|
1340
|
-
|
|
1341
|
-
interface CharacterStatisticsSummaryResponse extends ResponseBase {
|
|
1342
|
-
agility: BaseEffectiveStat;
|
|
1343
|
-
armor: BaseEffectiveStat;
|
|
1344
|
-
attack_power: number;
|
|
1345
|
-
avoidance: Rating;
|
|
1346
|
-
block: RatingWithValue;
|
|
1347
|
-
bonus_armor: number;
|
|
1348
|
-
character: Character$2;
|
|
1349
|
-
dodge: RatingWithValue;
|
|
1350
|
-
health: number;
|
|
1351
|
-
intellect: BaseEffectiveStat;
|
|
1352
|
-
lifesteal: RatingWithValue;
|
|
1353
|
-
main_hand_damage_max: number;
|
|
1354
|
-
main_hand_damage_min: number;
|
|
1355
|
-
main_hand_dps: number;
|
|
1356
|
-
main_hand_speed: number;
|
|
1357
|
-
mana_regen: number;
|
|
1358
|
-
mana_regen_combat: number;
|
|
1359
|
-
mastery: RatingWithValue;
|
|
1360
|
-
melee_crit: RatingWithValue;
|
|
1361
|
-
melee_haste: RatingWithValue;
|
|
1362
|
-
off_hand_damage_max: number;
|
|
1363
|
-
off_hand_damage_min: number;
|
|
1364
|
-
off_hand_dps: number;
|
|
1365
|
-
off_hand_speed: number;
|
|
1366
|
-
parry: RatingWithValue;
|
|
1367
|
-
power: number;
|
|
1368
|
-
power_type: Character$2;
|
|
1369
|
-
ranged_crit: RatingWithValue;
|
|
1370
|
-
ranged_haste: RatingWithValue;
|
|
1371
|
-
speed: Rating;
|
|
1372
|
-
spell_crit: RatingWithValue;
|
|
1373
|
-
spell_haste: RatingWithValue;
|
|
1374
|
-
spell_penetration: number;
|
|
1375
|
-
spell_power: number;
|
|
1376
|
-
stamina: BaseEffectiveStat;
|
|
1377
|
-
strength: BaseEffectiveStat;
|
|
1378
|
-
versatility: number;
|
|
1379
|
-
versatility_damage_done_bonus: number;
|
|
1380
|
-
versatility_damage_taken_bonus: number;
|
|
1381
|
-
versatility_healing_done_bonus: number;
|
|
1382
|
-
}
|
|
1383
|
-
interface BaseEffectiveStat {
|
|
1384
|
-
base: number;
|
|
1385
|
-
effective: number;
|
|
1386
|
-
}
|
|
1387
|
-
interface Rating {
|
|
1388
|
-
rating: number;
|
|
1389
|
-
rating_bonus: number;
|
|
1390
|
-
}
|
|
1391
|
-
interface RatingWithValue {
|
|
1392
|
-
rating: number;
|
|
1393
|
-
rating_bonus: number;
|
|
1394
|
-
value: number;
|
|
1395
|
-
}
|
|
1396
|
-
|
|
1397
|
-
/**
|
|
1398
|
-
* @param realmSlug The slug of the realm.
|
|
1399
|
-
* @param characterName The lowercase name of the character.
|
|
1400
|
-
* @returns a statistics summary for a character.
|
|
1401
|
-
*/
|
|
1402
|
-
declare function characterStatisticsSummary(realmSlug: string, characterName: string): Resource<CharacterStatisticsSummaryResponse>;
|
|
1403
|
-
|
|
1404
|
-
interface CharacterTitlesSummaryResponse extends ResponseBase {
|
|
1405
|
-
active_title: {
|
|
1406
|
-
display_string: string;
|
|
1407
|
-
} & NameIdKey;
|
|
1408
|
-
character: Character$2;
|
|
1409
|
-
titles: Array<NameIdKey>;
|
|
1410
|
-
}
|
|
1411
|
-
|
|
1412
|
-
/**
|
|
1413
|
-
* @param realmSlug The slug of the realm.
|
|
1414
|
-
* @param characterName The lowercase name of the character.
|
|
1415
|
-
* @returns a summary of titles a character has obtained.
|
|
1416
|
-
*/
|
|
1417
|
-
declare function characterTitlesSummary(realmSlug: string, characterName: string): Resource<CharacterTitlesSummaryResponse>;
|
|
1418
|
-
|
|
1419
|
-
type WithoutUnderscore<T extends string> = T extends `${infer Prefix}_${infer Suffix}` ? `${Prefix}${Suffix}` : never;
|
|
1420
|
-
/**
|
|
1421
|
-
* The category of a realm.
|
|
1422
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1423
|
-
*/
|
|
1424
|
-
type RealmCategory = 'Brazil' | 'English' | 'French' | 'German' | 'Italian' | 'Latin America' | 'Oceanic' | 'PS' | 'Russian' | 'Spanish' | 'United States' | '한국';
|
|
1425
|
-
/**
|
|
1426
|
-
* The timezone of a realm.
|
|
1427
|
-
*/
|
|
1428
|
-
type RealmTimezone = 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/New_York' | 'America/Sao_Paulo' | 'Asia/Seoul' | 'Australia/Melbourne' | 'Europe/Paris';
|
|
1429
|
-
/**
|
|
1430
|
-
* The type of a realm, capitalized and shortended).
|
|
1431
|
-
*/
|
|
1432
|
-
type RealmTypeCapitalized = 'NORMAL' | 'RP';
|
|
1433
|
-
/**
|
|
1434
|
-
* The type of a realm, not capitalized or shortened.
|
|
1435
|
-
*/
|
|
1436
|
-
type RealmType = 'Normal' | 'Roleplaying';
|
|
1437
|
-
/**
|
|
1438
|
-
* The response for a realm index.
|
|
1439
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1440
|
-
*/
|
|
1441
|
-
interface RealmIndexResponse extends ResponseBase {
|
|
1442
|
-
realms: Array<Realm$4>;
|
|
1443
|
-
}
|
|
1444
|
-
/**
|
|
1445
|
-
* The response for a realm.
|
|
1446
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1447
|
-
*/
|
|
1448
|
-
interface RealmResponse extends ResponseBase, NameId {
|
|
1449
|
-
category: RealmCategory;
|
|
1450
|
-
connected_realm: {
|
|
1451
|
-
href: string;
|
|
1452
|
-
};
|
|
1453
|
-
is_tournament: boolean;
|
|
1454
|
-
locale: WithoutUnderscore<Locales>;
|
|
1455
|
-
region: NameIdKey;
|
|
1456
|
-
slug: string;
|
|
1457
|
-
timezone: RealmTimezone;
|
|
1458
|
-
type: {
|
|
1459
|
-
name: RealmType;
|
|
1460
|
-
type: RealmTypeCapitalized;
|
|
1461
|
-
};
|
|
1462
|
-
}
|
|
1463
|
-
/**
|
|
1464
|
-
* The search parameters for realms.
|
|
1465
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1466
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1467
|
-
*/
|
|
1468
|
-
interface RealmSearchParameters extends BaseSearchParameters {
|
|
1469
|
-
timezone?: RealmTimezone;
|
|
1470
|
-
}
|
|
1471
|
-
/**
|
|
1472
|
-
* The response for a realm search.
|
|
1473
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1474
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1475
|
-
*/
|
|
1476
|
-
interface RealmSearchResponseItem extends KeyBase {
|
|
1477
|
-
data: {
|
|
1478
|
-
category: Record<Locales, string | undefined>;
|
|
1479
|
-
id: number;
|
|
1480
|
-
is_tournament: boolean;
|
|
1481
|
-
locale: WithoutUnderscore<Locales>;
|
|
1482
|
-
name: Record<Locales, string | undefined>;
|
|
1483
|
-
region: {
|
|
1484
|
-
id: number;
|
|
1485
|
-
name: Record<Locales, string | undefined>;
|
|
1486
|
-
};
|
|
1487
|
-
slug: string;
|
|
1488
|
-
timezone: RealmTimezone;
|
|
1489
|
-
type: {
|
|
1490
|
-
name: Record<Locales, string | undefined>;
|
|
1491
|
-
type: RealmTypeCapitalized;
|
|
1492
|
-
};
|
|
1493
|
-
};
|
|
1494
|
-
}
|
|
1495
|
-
|
|
1496
|
-
type RealmPopulation = 'Full' | 'High' | 'Low' | 'Medium' | 'New Players';
|
|
1497
|
-
type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
|
|
1498
|
-
type RealmStatus = 'Down' | 'Up';
|
|
1499
|
-
/**
|
|
1500
|
-
* Connected Realm Index API response.
|
|
1501
|
-
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
1502
|
-
*/
|
|
1503
|
-
interface ConnectedRealmIndexResponse extends ResponseBase {
|
|
1504
|
-
connected_realms: Array<{
|
|
1505
|
-
href: string;
|
|
1506
|
-
}>;
|
|
1507
|
-
}
|
|
1508
|
-
interface Realm$3 {
|
|
1509
|
-
category: RealmCategory;
|
|
1510
|
-
connected_realm: {
|
|
1511
|
-
href: string;
|
|
1512
|
-
};
|
|
1513
|
-
id: number;
|
|
1514
|
-
is_tournament: boolean;
|
|
1515
|
-
locale: WithoutUnderscore<Locales>;
|
|
1516
|
-
name: string;
|
|
1517
|
-
region: NameIdKey;
|
|
1518
|
-
slug: string;
|
|
1519
|
-
timezone: RealmTimezone;
|
|
1520
|
-
type: {
|
|
1521
|
-
name: RealmType;
|
|
1522
|
-
type: RealmTypeCapitalized;
|
|
1523
|
-
};
|
|
1524
|
-
}
|
|
1525
|
-
interface RealmLockedStatus {
|
|
1526
|
-
is_locked_for_new_characters: boolean;
|
|
1527
|
-
is_locked_for_pct: boolean;
|
|
1528
|
-
}
|
|
1529
|
-
/**
|
|
1530
|
-
* Connected Realm API response.
|
|
1531
|
-
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
1532
|
-
*/
|
|
1533
|
-
interface ConnectedRealmResponse extends ResponseBase {
|
|
1534
|
-
auctions: {
|
|
1535
|
-
href: string;
|
|
1536
|
-
};
|
|
1537
|
-
has_queue: boolean;
|
|
1538
|
-
id: number;
|
|
1539
|
-
mythic_leaderboards: {
|
|
1540
|
-
href: string;
|
|
1541
|
-
};
|
|
1542
|
-
population: {
|
|
1543
|
-
name: RealmPopulation;
|
|
1544
|
-
type: RealmPopulationCapitalized;
|
|
1545
|
-
};
|
|
1546
|
-
realm_locked_status?: RealmLockedStatus;
|
|
1547
|
-
realms: Array<Realm$3>;
|
|
1548
|
-
status: {
|
|
1549
|
-
name: RealmStatus;
|
|
1550
|
-
type: Uppercase<RealmStatus>;
|
|
1551
|
-
};
|
|
1552
|
-
}
|
|
1553
|
-
/**
|
|
1554
|
-
* Connected Realm Search API parameters.
|
|
1555
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1556
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1557
|
-
*/
|
|
1558
|
-
interface ConnectedRealmSearchParameters extends BaseSearchParameters {
|
|
1559
|
-
'realms.timezone'?: RealmTimezone;
|
|
1560
|
-
'status.type'?: Uppercase<RealmStatus>;
|
|
1561
|
-
}
|
|
1562
|
-
interface SearchRealm {
|
|
1563
|
-
category: Record<Locales, string | undefined>;
|
|
1564
|
-
id: number;
|
|
1565
|
-
is_tournament: boolean;
|
|
1566
|
-
locale: WithoutUnderscore<Locales>;
|
|
1567
|
-
name: Record<Locales, string | undefined>;
|
|
1568
|
-
region: {
|
|
1569
|
-
id: number;
|
|
1570
|
-
name: Record<Locales, string | undefined>;
|
|
1571
|
-
};
|
|
1572
|
-
slug: string;
|
|
1573
|
-
timezone: RealmTimezone;
|
|
1574
|
-
type: {
|
|
1575
|
-
name: Record<Locales, string | undefined>;
|
|
1576
|
-
type: RealmTypeCapitalized;
|
|
1577
|
-
};
|
|
1578
|
-
}
|
|
1579
|
-
interface SearchRealmStatus {
|
|
1580
|
-
name: Record<Locales, string>;
|
|
1581
|
-
type: Uppercase<RealmStatus>;
|
|
1582
|
-
}
|
|
1583
|
-
interface SearchRealmPopulation {
|
|
1584
|
-
name: Record<Locales, string>;
|
|
1585
|
-
type: RealmPopulationCapitalized;
|
|
1586
|
-
}
|
|
1587
|
-
/**
|
|
1588
|
-
* Connected Realm Search API response item.
|
|
1589
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1590
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1591
|
-
*/
|
|
1592
|
-
interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
1593
|
-
data: {
|
|
1594
|
-
has_queue: boolean;
|
|
1595
|
-
id: number;
|
|
1596
|
-
population: SearchRealmPopulation;
|
|
1597
|
-
realms: Array<SearchRealm>;
|
|
1598
|
-
status: SearchRealmStatus;
|
|
1599
|
-
};
|
|
1600
|
-
}
|
|
1601
|
-
|
|
1602
|
-
/**
|
|
1603
|
-
* Get a connected realm index.
|
|
1604
|
-
* @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
|
|
1605
|
-
*/
|
|
1606
|
-
declare function connectedRealmIndex(): Resource<ConnectedRealmIndexResponse>;
|
|
1607
|
-
/**
|
|
1608
|
-
* Get a connected realm by ID.
|
|
1609
|
-
* @param connectedRealmId The connected realm ID.
|
|
1610
|
-
* @returns The connected realm. See {@link ConnectedRealmResponse}.
|
|
1611
|
-
*/
|
|
1612
|
-
declare function connectedRealm(connectedRealmId: number): Resource<ConnectedRealmResponse>;
|
|
1613
|
-
/**
|
|
1614
|
-
* Search for connected realms.
|
|
1615
|
-
* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
|
|
1616
|
-
* @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
|
|
1617
|
-
*/
|
|
1618
|
-
declare function connectedRealmSearch(options: ConnectedRealmSearchParameters): Resource<SearchResponse<ConnectedRealmSearchResponseItem>, ConnectedRealmSearchParameters>;
|
|
1619
|
-
|
|
1620
|
-
/**
|
|
1621
|
-
* Interface for a response from the conduit index endpoint.
|
|
1622
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1623
|
-
*/
|
|
1624
|
-
interface ConduitIndexResponse extends ResponseBase {
|
|
1625
|
-
conduits: Array<NameIdKey>;
|
|
1626
|
-
}
|
|
1627
|
-
/**
|
|
1628
|
-
* Interface for a response from the conduit endpoint.
|
|
1629
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1630
|
-
*/
|
|
1631
|
-
interface ConduitResponse extends ResponseBase {
|
|
1632
|
-
id: number;
|
|
1633
|
-
item: Item$1;
|
|
1634
|
-
name: string;
|
|
1635
|
-
ranks: Array<Rank$1>;
|
|
1636
|
-
socket_type: SocketType;
|
|
1637
|
-
}
|
|
1638
|
-
interface Item$1 extends KeyBase {
|
|
1639
|
-
id: number;
|
|
1640
|
-
}
|
|
1641
|
-
interface Rank$1 {
|
|
1642
|
-
id: number;
|
|
1643
|
-
spell_tooltip: SpellTooltip$1;
|
|
1644
|
-
tier: number;
|
|
1645
|
-
}
|
|
1646
|
-
interface SpellTooltip$1 {
|
|
1647
|
-
cast_time: string;
|
|
1648
|
-
description: string;
|
|
1649
|
-
spell: Item$1;
|
|
1650
|
-
}
|
|
1651
|
-
interface SocketType {
|
|
1652
|
-
name: string;
|
|
1653
|
-
type: string;
|
|
1654
|
-
}
|
|
1655
|
-
/**
|
|
1656
|
-
* Interface for a response from the covenant index endpoint.
|
|
1657
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1658
|
-
*/
|
|
1659
|
-
interface CovenantIndexResponse extends ResponseBase {
|
|
1660
|
-
covenants: Array<NameIdKey>;
|
|
1661
|
-
}
|
|
1662
|
-
/**
|
|
1663
|
-
* Interface for a response from the covenant endpoint.
|
|
1664
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1665
|
-
*/
|
|
1666
|
-
interface CovenantResponse extends ResponseBase {
|
|
1667
|
-
description: string;
|
|
1668
|
-
id: number;
|
|
1669
|
-
name: string;
|
|
1670
|
-
renown_rewards: Array<RenownReward>;
|
|
1671
|
-
}
|
|
1672
|
-
interface RenownReward {
|
|
1673
|
-
level: number;
|
|
1674
|
-
reward: NameIdKey;
|
|
1675
|
-
}
|
|
1676
|
-
/**
|
|
1677
|
-
* Interface for a response from the covenant media endpoint.
|
|
1678
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1679
|
-
*/
|
|
1680
|
-
interface CovenantMediaResponse extends ResponseBase {
|
|
1681
|
-
class_abilities: Array<ClassAbility>;
|
|
1682
|
-
description: string;
|
|
1683
|
-
id: number;
|
|
1684
|
-
media: Media$e;
|
|
1685
|
-
name: string;
|
|
1686
|
-
renown_rewards: Array<RenownReward>;
|
|
1687
|
-
signature_ability: SignatureAbility;
|
|
1688
|
-
soulbinds: Array<NameIdKey>;
|
|
1689
|
-
}
|
|
1690
|
-
interface ClassAbility {
|
|
1691
|
-
id: number;
|
|
1692
|
-
playable_class: NameIdKey;
|
|
1693
|
-
spell_tooltip: ClassAbilitySpellTooltip;
|
|
1694
|
-
}
|
|
1695
|
-
interface ClassAbilitySpellTooltip {
|
|
1696
|
-
cast_time: string;
|
|
1697
|
-
cooldown?: string;
|
|
1698
|
-
description: string;
|
|
1699
|
-
power_cost?: null | string;
|
|
1700
|
-
range?: string;
|
|
1701
|
-
spell: NameIdKey;
|
|
1702
|
-
}
|
|
1703
|
-
interface Media$e extends KeyBase {
|
|
1704
|
-
id: number;
|
|
1705
|
-
}
|
|
1706
|
-
interface SignatureAbility {
|
|
1707
|
-
id: number;
|
|
1708
|
-
spell_tooltip: SignatureAbilitySpellTooltip;
|
|
1709
|
-
}
|
|
1710
|
-
interface SignatureAbilitySpellTooltip {
|
|
1711
|
-
cast_time: string;
|
|
1712
|
-
cooldown: string;
|
|
1713
|
-
description: string;
|
|
1714
|
-
spell: NameIdKey;
|
|
1715
|
-
}
|
|
1716
|
-
/**
|
|
1717
|
-
* Interface for a response from the soulbind endpoint.
|
|
1718
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1719
|
-
*/
|
|
1720
|
-
interface SoulbindResponse extends ResponseBase {
|
|
1721
|
-
covenant: NameIdKey;
|
|
1722
|
-
creature: NameIdKey;
|
|
1723
|
-
follower: NameIdKey;
|
|
1724
|
-
id: number;
|
|
1725
|
-
name: string;
|
|
1726
|
-
talent_tree: NameIdKey;
|
|
1727
|
-
}
|
|
1728
|
-
/**
|
|
1729
|
-
* Interface for a response from the soulbind index endpoint.
|
|
1730
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1731
|
-
*/
|
|
1732
|
-
interface SoulbindIndexResponse extends ResponseBase {
|
|
1733
|
-
soulbinds: Array<NameIdKey>;
|
|
1734
|
-
}
|
|
1735
|
-
|
|
1736
|
-
/**
|
|
1737
|
-
* Get a conduit by ID.
|
|
1738
|
-
* @param conduitId The conduit ID.
|
|
1739
|
-
* @returns The conduit. See {@link ConduitResponse}.
|
|
1740
|
-
*/
|
|
1741
|
-
declare function conduit(conduitId: number): Resource<ConduitResponse>;
|
|
1742
|
-
/**
|
|
1743
|
-
* Get a conduit index.
|
|
1744
|
-
* @returns The conduit index. See {@link ConduitIndexResponse}.
|
|
1745
|
-
*/
|
|
1746
|
-
declare function conduitIndex(): Resource<ConduitIndexResponse>;
|
|
1747
|
-
/**
|
|
1748
|
-
* Get a covenant by ID.
|
|
1749
|
-
* @param covenantId The covenant ID.
|
|
1750
|
-
* @returns The covenant. See {@link CovenantResponse}.
|
|
1751
|
-
*/
|
|
1752
|
-
declare function covenant(covenantId: number): Resource<CovenantResponse>;
|
|
1753
|
-
/**
|
|
1754
|
-
* Get a covenant index.
|
|
1755
|
-
* @returns The covenant index. See {@link CovenantIndexResponse}.
|
|
1756
|
-
*/
|
|
1757
|
-
declare function covenantIndex(): Resource<CovenantIndexResponse>;
|
|
1758
|
-
/**
|
|
1759
|
-
* Get covenant media by ID.
|
|
1760
|
-
* @param covenantId The covenant ID.
|
|
1761
|
-
* @returns The covenant media. See {@link CovenantMediaResponse}.
|
|
1762
|
-
*/
|
|
1763
|
-
declare function covenantMedia(covenantId: number): Resource<CovenantMediaResponse>;
|
|
1764
|
-
/**
|
|
1765
|
-
* Get a soulbind by ID.
|
|
1766
|
-
* @param soulbindId The soulbind ID.
|
|
1767
|
-
* @returns The soulbind. See {@link SoulbindResponse}.
|
|
1768
|
-
*/
|
|
1769
|
-
declare function soulbind(soulbindId: number): Resource<SoulbindResponse>;
|
|
1770
|
-
/**
|
|
1771
|
-
* Get a soulbind index.
|
|
1772
|
-
* @returns The soulbind index. See {@link SoulbindIndexResponse}.
|
|
1773
|
-
*/
|
|
1774
|
-
declare function soulbindIndex(): Resource<SoulbindIndexResponse>;
|
|
1775
|
-
|
|
1776
|
-
/**
|
|
1777
|
-
* The response for a creature.
|
|
1778
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1779
|
-
*/
|
|
1780
|
-
interface CreatureResponse extends ResponseBase {
|
|
1781
|
-
creature_displays: Array<CreatureDisplay$2>;
|
|
1782
|
-
family: NameIdKey;
|
|
1783
|
-
id: number;
|
|
1784
|
-
is_tameable: boolean;
|
|
1785
|
-
name: string;
|
|
1786
|
-
type: NameIdKey;
|
|
1787
|
-
}
|
|
1788
|
-
interface CreatureDisplay$2 extends KeyBase {
|
|
1789
|
-
id: number;
|
|
1790
|
-
}
|
|
1791
|
-
/**
|
|
1792
|
-
* The response for creature display media.
|
|
1793
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1794
|
-
*/
|
|
1795
|
-
interface CreatureDisplayMediaResponse extends ResponseBase {
|
|
1796
|
-
assets: Array<DisplayMediaAsset>;
|
|
1797
|
-
id: number;
|
|
1798
|
-
}
|
|
1799
|
-
interface DisplayMediaAsset {
|
|
1800
|
-
key: string;
|
|
1801
|
-
value: string;
|
|
1802
|
-
}
|
|
1803
|
-
/**
|
|
1804
|
-
* The response for a creature family index.
|
|
1805
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1806
|
-
*/
|
|
1807
|
-
interface CreatureFamilyIndexResponse extends ResponseBase {
|
|
1808
|
-
creature_families: Array<NameIdKey>;
|
|
1809
|
-
}
|
|
1810
|
-
/**
|
|
1811
|
-
* The response for a creature family.
|
|
1812
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1813
|
-
*/
|
|
1814
|
-
interface CreatureFamilyResponse extends ResponseBase {
|
|
1815
|
-
id: number;
|
|
1816
|
-
media: Media$d;
|
|
1817
|
-
name: string;
|
|
1818
|
-
specialization: NameIdKey;
|
|
1819
|
-
}
|
|
1820
|
-
interface Media$d extends KeyBase {
|
|
1821
|
-
id: number;
|
|
1822
|
-
}
|
|
1823
|
-
/**
|
|
1824
|
-
* The response for creature family media.
|
|
1825
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1826
|
-
*/
|
|
1827
|
-
interface CreatureFamilyMediaResponse extends ResponseBase {
|
|
1828
|
-
assets: Array<MediaAsset$1>;
|
|
1829
|
-
id: number;
|
|
1830
|
-
}
|
|
1831
|
-
/**
|
|
1832
|
-
* The response for a creature type index.
|
|
1833
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1834
|
-
*/
|
|
1835
|
-
interface CreatureTypeIndexResponse extends ResponseBase {
|
|
1836
|
-
creature_types: Array<NameIdKey>;
|
|
1837
|
-
}
|
|
1838
|
-
/**
|
|
1839
|
-
* The response for a creature type.
|
|
1840
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1841
|
-
*/
|
|
1842
|
-
interface CreatureTypeResponse extends ResponseBase {
|
|
1843
|
-
id: number;
|
|
1844
|
-
name: string;
|
|
1845
|
-
}
|
|
1846
|
-
/**
|
|
1847
|
-
* The search parameters for a creature.
|
|
1848
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1849
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1850
|
-
*/
|
|
1851
|
-
interface CreatureSearchParameters extends BaseSearchParameters {
|
|
1852
|
-
locale: Locales;
|
|
1853
|
-
name: string;
|
|
1854
|
-
}
|
|
1855
|
-
/**
|
|
1856
|
-
* The response for a creature search.
|
|
1857
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
1858
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
1859
|
-
*/
|
|
1860
|
-
interface CreatureSearchResponseItem extends KeyBase {
|
|
1861
|
-
data: {
|
|
1862
|
-
creature_displays: Array<{
|
|
1863
|
-
id: number;
|
|
1864
|
-
}>;
|
|
1865
|
-
family?: {
|
|
1866
|
-
id: number;
|
|
1867
|
-
name: Record<Locales, string | undefined>;
|
|
1868
|
-
};
|
|
1869
|
-
id: number;
|
|
1870
|
-
is_tameable: boolean;
|
|
1871
|
-
name: Record<Locales, string | undefined>;
|
|
1872
|
-
type: {
|
|
1873
|
-
id: number;
|
|
1874
|
-
name: Record<Locales, string | undefined>;
|
|
1875
|
-
};
|
|
1876
|
-
};
|
|
1877
|
-
}
|
|
1878
|
-
|
|
1879
|
-
/**
|
|
1880
|
-
* Get a creature by ID.
|
|
1881
|
-
* @param creatureId The creature ID.
|
|
1882
|
-
* @returns The creature. See {@link CreatureResponse}.
|
|
1883
|
-
*/
|
|
1884
|
-
declare function creature(creatureId: number): Resource<CreatureResponse>;
|
|
1885
|
-
/**
|
|
1886
|
-
* Get creature display media by ID.
|
|
1887
|
-
* @param creatureDisplayId The creature display ID.
|
|
1888
|
-
* @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
|
|
1889
|
-
*/
|
|
1890
|
-
declare function creatureDisplayMedia(creatureDisplayId: number): Resource<CreatureDisplayMediaResponse>;
|
|
1891
|
-
/**
|
|
1892
|
-
* Get a creature family by ID.
|
|
1893
|
-
* @param creatureFamilyId The creature family ID.
|
|
1894
|
-
* @returns The creature family. See {@link CreatureFamilyResponse}.
|
|
1895
|
-
*/
|
|
1896
|
-
declare function creatureFamily(creatureFamilyId: number): Resource<CreatureFamilyResponse>;
|
|
1897
|
-
/**
|
|
1898
|
-
* Get a creature family index.
|
|
1899
|
-
* @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
|
|
1900
|
-
*/
|
|
1901
|
-
declare function creatureFamilyIndex(): Resource<CreatureFamilyIndexResponse>;
|
|
1902
|
-
/**
|
|
1903
|
-
* Get creature family media by ID.
|
|
1904
|
-
* @param creatureFamilyId The creature family ID.
|
|
1905
|
-
* @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
|
|
1906
|
-
*/
|
|
1907
|
-
declare function creatureFamilyMedia(creatureFamilyId: number): Resource<CreatureFamilyMediaResponse>;
|
|
1908
|
-
/**
|
|
1909
|
-
* Get a creature type by ID.
|
|
1910
|
-
* @param creatureTypeId The creature type ID.
|
|
1911
|
-
* @returns The creature type. See {@link CreatureTypeResponse}.
|
|
1912
|
-
*/
|
|
1913
|
-
declare function creatureType(creatureTypeId: number): Resource<CreatureTypeResponse>;
|
|
1914
|
-
/**
|
|
1915
|
-
* Get a creature type index.
|
|
1916
|
-
* @returns The creature type index. See {@link CreatureTypeIndexResponse}.
|
|
1917
|
-
*/
|
|
1918
|
-
declare function creatureTypeIndex(): Resource<CreatureTypeIndexResponse>;
|
|
1919
|
-
/**
|
|
1920
|
-
* Search for creatures.
|
|
1921
|
-
* @param options The creature search parameters. See {@link CreatureSearchParameters}.
|
|
1922
|
-
* @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
|
|
1923
|
-
*/
|
|
1924
|
-
declare function creatureSearch(options: CreatureSearchParameters): Resource<SearchResponse<CreatureSearchResponseItem>, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
|
|
1925
|
-
|
|
1926
|
-
interface GuildResponse extends ResponseBase {
|
|
1927
|
-
achievement_points: number;
|
|
1928
|
-
achievements: Href;
|
|
1929
|
-
activity: Href;
|
|
1930
|
-
created_timestamp: number;
|
|
1931
|
-
crest: Crest;
|
|
1932
|
-
faction: Faction;
|
|
1933
|
-
id: number;
|
|
1934
|
-
member_count: number;
|
|
1935
|
-
name: string;
|
|
1936
|
-
name_search: string;
|
|
1937
|
-
realm: Realm$4;
|
|
1938
|
-
roster: Href;
|
|
1939
|
-
}
|
|
1940
|
-
interface Crest {
|
|
1941
|
-
background: {
|
|
1942
|
-
color: RgbWithId;
|
|
1943
|
-
};
|
|
1944
|
-
border: Border$1;
|
|
1945
|
-
emblem: Border$1;
|
|
1946
|
-
}
|
|
1947
|
-
interface RgbWithId {
|
|
1948
|
-
id: number;
|
|
1949
|
-
rgba: Color;
|
|
1950
|
-
}
|
|
1951
|
-
interface Border$1 {
|
|
1952
|
-
color: RgbWithId;
|
|
1953
|
-
id: number;
|
|
1954
|
-
media: {
|
|
1955
|
-
id: number;
|
|
1956
|
-
} & KeyBase;
|
|
1957
|
-
}
|
|
1958
|
-
interface GuildActivityResponse extends ResponseBase {
|
|
1959
|
-
activities: Array<ActivityElement>;
|
|
1960
|
-
guild: Guild$1;
|
|
1961
|
-
}
|
|
1962
|
-
interface ActivityElement {
|
|
1963
|
-
activity: {
|
|
1964
|
-
type: string;
|
|
1965
|
-
};
|
|
1966
|
-
character_achievement: CharacterAchievement;
|
|
1967
|
-
timestamp: number;
|
|
1968
|
-
}
|
|
1969
|
-
interface CharacterAchievement {
|
|
1970
|
-
achievement: NameIdKey;
|
|
1971
|
-
character: Character$2;
|
|
1972
|
-
}
|
|
1973
|
-
interface Guild$1 extends NameIdKey {
|
|
1974
|
-
faction: Faction;
|
|
1975
|
-
realm: Realm$4;
|
|
1976
|
-
}
|
|
1977
|
-
interface GuildAchievementsResponse extends ResponseBase {
|
|
1978
|
-
achievements: Array<Achievement>;
|
|
1979
|
-
category_progress: Array<CategoryProgress>;
|
|
1980
|
-
guild: Guild$1;
|
|
1981
|
-
recent_events: Array<RecentEvent>;
|
|
1982
|
-
total_points: number;
|
|
1983
|
-
total_quantity: number;
|
|
1984
|
-
}
|
|
1985
|
-
interface Achievement {
|
|
1986
|
-
achievement: NameIdKey;
|
|
1987
|
-
completed_timestamp?: number;
|
|
1988
|
-
criteria?: Criteria;
|
|
1989
|
-
id: number;
|
|
1990
|
-
}
|
|
1991
|
-
interface Criteria {
|
|
1992
|
-
amount?: number;
|
|
1993
|
-
child_criteria?: Array<Criteria>;
|
|
1994
|
-
id: number;
|
|
1995
|
-
is_completed: boolean;
|
|
1996
|
-
}
|
|
1997
|
-
interface CategoryProgress {
|
|
1998
|
-
category: NameIdKey;
|
|
1999
|
-
points: number;
|
|
2000
|
-
quantity: number;
|
|
2001
|
-
}
|
|
2002
|
-
interface RecentEvent {
|
|
2003
|
-
achievement: NameIdKey;
|
|
2004
|
-
timestamp: number;
|
|
2005
|
-
}
|
|
2006
|
-
interface GuildRosterResponse extends ResponseBase {
|
|
2007
|
-
guild: Guild$1;
|
|
2008
|
-
members: Array<Member$1>;
|
|
2009
|
-
}
|
|
2010
|
-
interface Member$1 {
|
|
2011
|
-
character: RosterMemberCharacter;
|
|
2012
|
-
rank: number;
|
|
2013
|
-
}
|
|
2014
|
-
interface RosterMemberCharacter extends Character$2 {
|
|
2015
|
-
level: number;
|
|
2016
|
-
playable_class: Playable;
|
|
2017
|
-
playable_race: Playable;
|
|
2018
|
-
}
|
|
2019
|
-
interface Playable extends KeyBase {
|
|
2020
|
-
id: number;
|
|
2021
|
-
}
|
|
2022
|
-
|
|
2023
|
-
/**
|
|
2024
|
-
* @param realmSlug The slug of the realm.
|
|
2025
|
-
* @param nameSlug The lowercase name of the guild.
|
|
2026
|
-
* @returns a single guild by its name and realm.
|
|
2027
|
-
*/
|
|
2028
|
-
declare function guild(realmSlug: string, nameSlug: string): Resource<GuildResponse>;
|
|
2029
|
-
/**
|
|
2030
|
-
* @param realmSlug The slug of the realm.
|
|
2031
|
-
* @param nameSlug The lowercase name of the guild.
|
|
2032
|
-
* @returns a single guild's activity by name and realm.
|
|
2033
|
-
*/
|
|
2034
|
-
declare function guildActivity(realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
|
|
2035
|
-
/**
|
|
2036
|
-
* @param realmSlug The slug of the realm.
|
|
2037
|
-
* @param nameSlug The lowercase name of the guild.
|
|
2038
|
-
* @returns a single guild's achievements by name and realm.
|
|
2039
|
-
*/
|
|
2040
|
-
declare function guildAchievements(realmSlug: string, nameSlug: string): Resource<GuildAchievementsResponse>;
|
|
2041
|
-
/**
|
|
2042
|
-
* @param realmSlug The slug of the realm.
|
|
2043
|
-
* @param nameSlug The lowercase name of the guild.
|
|
2044
|
-
* @returns a single guild's roster by its name and realm.
|
|
2045
|
-
*/
|
|
2046
|
-
declare function guildRoster(realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
|
|
2047
|
-
|
|
2048
|
-
/**
|
|
2049
|
-
* The response for the guild crest components index.
|
|
2050
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2051
|
-
*/
|
|
2052
|
-
interface GuildCrestComponentsIndexResponse extends ResponseBase {
|
|
2053
|
-
borders: Array<Border>;
|
|
2054
|
-
colors: Colors;
|
|
2055
|
-
emblems: Array<Border>;
|
|
2056
|
-
}
|
|
2057
|
-
interface Border {
|
|
2058
|
-
id: number;
|
|
2059
|
-
media: Media$c;
|
|
2060
|
-
}
|
|
2061
|
-
interface Media$c extends KeyBase {
|
|
2062
|
-
id: number;
|
|
2063
|
-
}
|
|
2064
|
-
interface Colors {
|
|
2065
|
-
backgrounds: Array<Background>;
|
|
2066
|
-
borders: Array<Background>;
|
|
2067
|
-
emblems: Array<Background>;
|
|
2068
|
-
}
|
|
2069
|
-
interface Background {
|
|
2070
|
-
id: number;
|
|
2071
|
-
rgba: RGBA;
|
|
2072
|
-
}
|
|
2073
|
-
interface RGBA {
|
|
2074
|
-
a: number;
|
|
2075
|
-
b: number;
|
|
2076
|
-
g: number;
|
|
2077
|
-
r: number;
|
|
2078
|
-
}
|
|
2079
|
-
/**
|
|
2080
|
-
* The response for a guild crest border or emblem.
|
|
2081
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2082
|
-
*/
|
|
2083
|
-
interface GuildCrestBorderEmblemResponse extends ResponseBase {
|
|
2084
|
-
assets: Array<GuildCrestAsset>;
|
|
2085
|
-
id: number;
|
|
2086
|
-
}
|
|
2087
|
-
interface GuildCrestAsset {
|
|
2088
|
-
key: string;
|
|
2089
|
-
value: string;
|
|
2090
|
-
}
|
|
2091
|
-
|
|
2092
|
-
/**
|
|
2093
|
-
* Get the guild crest components index.
|
|
2094
|
-
* @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
|
|
2095
|
-
*/
|
|
2096
|
-
declare function guildCrestComponentsIndex(): Resource<GuildCrestComponentsIndexResponse>;
|
|
2097
|
-
/**
|
|
2098
|
-
* Get a guild crest border by ID.
|
|
2099
|
-
* @param borderId The guild crest border ID.
|
|
2100
|
-
* @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
|
|
2101
|
-
*/
|
|
2102
|
-
declare function guildCrestBorder(borderId: number): Resource<GuildCrestBorderEmblemResponse>;
|
|
2103
|
-
/**
|
|
2104
|
-
* Get a guild crest emblem by ID.
|
|
2105
|
-
* @param emblemId The guild crest emblem ID.
|
|
2106
|
-
* @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
|
|
2107
|
-
*/
|
|
2108
|
-
declare function guildCrestEmblem(emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
|
|
2109
|
-
|
|
2110
|
-
/**
|
|
2111
|
-
* The response for the heirloom index.
|
|
2112
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2113
|
-
*/
|
|
2114
|
-
interface HeirloomIndexResponse extends ResponseBase {
|
|
2115
|
-
heirlooms: Array<NameIdKey>;
|
|
2116
|
-
}
|
|
2117
|
-
/**
|
|
2118
|
-
* The response for a heirloom.
|
|
2119
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2120
|
-
*/
|
|
2121
|
-
interface HeirloomResponse extends ResponseBase {
|
|
2122
|
-
id: number;
|
|
2123
|
-
item: NameIdKey;
|
|
2124
|
-
media: Media$b;
|
|
2125
|
-
source: Source$3;
|
|
2126
|
-
source_description: string;
|
|
2127
|
-
upgrades: Array<Upgrade>;
|
|
2128
|
-
}
|
|
2129
|
-
interface Media$b extends KeyBase {
|
|
2130
|
-
id: number;
|
|
2131
|
-
}
|
|
2132
|
-
interface Source$3 {
|
|
2133
|
-
name: string;
|
|
2134
|
-
type: string;
|
|
2135
|
-
}
|
|
2136
|
-
interface Upgrade {
|
|
2137
|
-
item: UpgradeItem;
|
|
2138
|
-
level: number;
|
|
2139
|
-
}
|
|
2140
|
-
interface UpgradeItem {
|
|
2141
|
-
binding: Source$3;
|
|
2142
|
-
bonus_list: Array<number>;
|
|
2143
|
-
context: number;
|
|
2144
|
-
inventory_type: Source$3;
|
|
2145
|
-
item: Media$b;
|
|
2146
|
-
item_class: NameIdKey;
|
|
2147
|
-
item_subclass: NameIdKey;
|
|
2148
|
-
level: AttackSpeedClass;
|
|
2149
|
-
media: Media$b;
|
|
2150
|
-
name: string;
|
|
2151
|
-
quality: Source$3;
|
|
2152
|
-
requirements: Requirements$2;
|
|
2153
|
-
stats: Array<Stat$1>;
|
|
2154
|
-
upgrades: Upgrades;
|
|
2155
|
-
weapon: Weapon$1;
|
|
2156
|
-
}
|
|
2157
|
-
interface AttackSpeedClass {
|
|
2158
|
-
display_string: string;
|
|
2159
|
-
value: number;
|
|
2160
|
-
}
|
|
2161
|
-
interface Requirements$2 {
|
|
2162
|
-
level: RequirementsLevel;
|
|
2163
|
-
}
|
|
2164
|
-
interface RequirementsLevel {
|
|
2165
|
-
display_string: string;
|
|
2166
|
-
}
|
|
2167
|
-
interface Stat$1 {
|
|
2168
|
-
display: Display$1;
|
|
2169
|
-
is_equip_bonus?: boolean;
|
|
2170
|
-
type: Source$3;
|
|
2171
|
-
value: number;
|
|
2172
|
-
}
|
|
2173
|
-
interface Display$1 {
|
|
2174
|
-
color: Color;
|
|
2175
|
-
display_string: string;
|
|
2176
|
-
}
|
|
2177
|
-
interface Upgrades {
|
|
2178
|
-
display_string: string;
|
|
2179
|
-
max_value: number;
|
|
2180
|
-
value: number;
|
|
2181
|
-
}
|
|
2182
|
-
interface Weapon$1 {
|
|
2183
|
-
attack_speed: AttackSpeedClass;
|
|
2184
|
-
damage: Damage$1;
|
|
2185
|
-
dps: AttackSpeedClass;
|
|
2186
|
-
}
|
|
2187
|
-
interface Damage$1 {
|
|
2188
|
-
damage_class: Source$3;
|
|
2189
|
-
display_string: string;
|
|
2190
|
-
max_value: number;
|
|
2191
|
-
min_value: number;
|
|
2192
|
-
}
|
|
2193
|
-
|
|
2194
|
-
/**
|
|
2195
|
-
* Get a heirloom by ID.
|
|
2196
|
-
* @param heirloomId The heirloom ID.
|
|
2197
|
-
* @returns The heirloom. See {@link HeirloomResponse}.
|
|
2198
|
-
*/
|
|
2199
|
-
declare function heirloom(heirloomId: number): Resource<HeirloomResponse>;
|
|
2200
|
-
/**
|
|
2201
|
-
* Get the heirloom index.
|
|
2202
|
-
* @returns The heirloom index. See {@link HeirloomIndexResponse}.
|
|
2203
|
-
*/
|
|
2204
|
-
declare function heirloomIndex(): Resource<HeirloomIndexResponse>;
|
|
2205
|
-
|
|
2206
|
-
interface ItemQuality {
|
|
2207
|
-
name: Record<Locales, string | undefined>;
|
|
2208
|
-
type: 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
|
|
2209
|
-
}
|
|
2210
|
-
interface InventoryType {
|
|
2211
|
-
name: Record<Locales, string | undefined>;
|
|
2212
|
-
type: 'BACK' | 'BAG' | 'CHEST' | 'FEET' | 'FINGER' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'NON_EQUIP' | 'SHIRT' | 'SHOULDER' | 'TABARD' | 'TRINKET' | 'TWOHWEAPON' | 'WAIST' | 'WRIST';
|
|
2213
|
-
}
|
|
2214
|
-
type StatTypeCapitalized = 'AGILITY' | 'CRIT_RATING' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
|
|
2215
|
-
type StatType = 'Agility' | 'Critical Strike' | 'Haste' | 'Intellect' | 'Mastery' | 'Stamina' | 'Strength' | 'Versatility';
|
|
2216
|
-
/**
|
|
2217
|
-
* The response for an item.
|
|
2218
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2219
|
-
*/
|
|
2220
|
-
interface ItemResponse extends ResponseBase, NameId {
|
|
2221
|
-
description?: string;
|
|
2222
|
-
inventory_type: InventoryType;
|
|
2223
|
-
is_equippable: boolean;
|
|
2224
|
-
is_stackable: boolean;
|
|
2225
|
-
item_class: NameIdKey;
|
|
2226
|
-
item_subclass: NameIdKey;
|
|
2227
|
-
level: number;
|
|
2228
|
-
max_count: number;
|
|
2229
|
-
media: Media$a;
|
|
2230
|
-
preview_item: PreviewItem;
|
|
2231
|
-
purchase_price: number;
|
|
2232
|
-
purchase_quantity: number;
|
|
2233
|
-
quality: ItemQuality;
|
|
2234
|
-
required_level: number;
|
|
2235
|
-
sell_price: number;
|
|
2236
|
-
}
|
|
2237
|
-
interface Media$a extends KeyBase {
|
|
2238
|
-
id: number;
|
|
2239
|
-
}
|
|
2240
|
-
interface PreviewItem {
|
|
2241
|
-
armor?: Armor;
|
|
2242
|
-
binding?: {
|
|
2243
|
-
name: string;
|
|
2244
|
-
type: string;
|
|
2245
|
-
};
|
|
2246
|
-
bonus_list?: Array<number>;
|
|
2247
|
-
container_slots?: Durability;
|
|
2248
|
-
context?: number;
|
|
2249
|
-
crafting_reagent?: string;
|
|
2250
|
-
description?: string;
|
|
2251
|
-
durability?: Durability;
|
|
2252
|
-
inventory_type: InventoryType;
|
|
2253
|
-
is_subclass_hidden?: boolean;
|
|
2254
|
-
item: Media$a;
|
|
2255
|
-
item_class: NameIdKey;
|
|
2256
|
-
item_subclass: NameIdKey;
|
|
2257
|
-
level?: Durability;
|
|
2258
|
-
media: Media$a;
|
|
2259
|
-
name: string;
|
|
2260
|
-
quality: ItemQuality;
|
|
2261
|
-
recipe?: Recipe;
|
|
2262
|
-
requirements?: Requirements$1;
|
|
2263
|
-
sell_price?: number;
|
|
2264
|
-
shield_block?: Armor;
|
|
2265
|
-
spells?: Array<Spell>;
|
|
2266
|
-
stats?: Array<Stat>;
|
|
2267
|
-
unique_equipped?: 'Unique';
|
|
2268
|
-
weapon?: Weapon;
|
|
2269
|
-
}
|
|
2270
|
-
interface Armor {
|
|
2271
|
-
display: Display;
|
|
2272
|
-
value: number;
|
|
2273
|
-
}
|
|
2274
|
-
interface Durability {
|
|
2275
|
-
display_string: string;
|
|
2276
|
-
value: number;
|
|
2277
|
-
}
|
|
2278
|
-
interface Requirements$1 {
|
|
2279
|
-
level: Durability;
|
|
2280
|
-
}
|
|
2281
|
-
interface Spell {
|
|
2282
|
-
description: string;
|
|
2283
|
-
spell: NameIdKey;
|
|
2284
|
-
}
|
|
2285
|
-
interface Stat {
|
|
2286
|
-
display: Display;
|
|
2287
|
-
is_negated?: boolean;
|
|
2288
|
-
type: {
|
|
2289
|
-
name: StatType;
|
|
2290
|
-
type: StatTypeCapitalized;
|
|
2291
|
-
};
|
|
2292
|
-
value: number;
|
|
2293
|
-
}
|
|
2294
|
-
interface Display {
|
|
2295
|
-
color: Color;
|
|
2296
|
-
display_string: string;
|
|
2297
|
-
}
|
|
2298
|
-
interface Weapon {
|
|
2299
|
-
attack_speed: Durability;
|
|
2300
|
-
damage: Damage;
|
|
2301
|
-
dps: Durability;
|
|
2302
|
-
}
|
|
2303
|
-
interface Damage {
|
|
2304
|
-
damage_class: {
|
|
2305
|
-
name: string;
|
|
2306
|
-
type: string;
|
|
2307
|
-
};
|
|
2308
|
-
display_string: string;
|
|
2309
|
-
max_value: number;
|
|
2310
|
-
min_value: number;
|
|
2311
|
-
}
|
|
2312
|
-
interface Recipe {
|
|
2313
|
-
item: RecipeItem;
|
|
2314
|
-
reagents: Array<{
|
|
2315
|
-
quantity: number;
|
|
2316
|
-
} & NameIdKey>;
|
|
2317
|
-
reagents_display_string: string;
|
|
2318
|
-
}
|
|
2319
|
-
interface RecipeItem {
|
|
2320
|
-
armor?: Armor;
|
|
2321
|
-
binding: {
|
|
2322
|
-
name: string;
|
|
2323
|
-
type: string;
|
|
2324
|
-
};
|
|
2325
|
-
durability: Durability;
|
|
2326
|
-
inventory_type: InventoryType;
|
|
2327
|
-
item: Media$a;
|
|
2328
|
-
item_class: NameIdKey;
|
|
2329
|
-
item_subclass: NameIdKey;
|
|
2330
|
-
level: Durability;
|
|
2331
|
-
media: Media$a;
|
|
2332
|
-
name: string;
|
|
2333
|
-
quality: ItemQuality;
|
|
2334
|
-
requirements: Requirements$1;
|
|
2335
|
-
sell_price: {
|
|
2336
|
-
display_strings: RecipeItemDisplayStrings;
|
|
2337
|
-
value: number;
|
|
2338
|
-
};
|
|
2339
|
-
stats: Array<Stat>;
|
|
2340
|
-
weapon?: Weapon;
|
|
2341
|
-
}
|
|
2342
|
-
interface RecipeItemDisplayStrings {
|
|
2343
|
-
copper: string;
|
|
2344
|
-
gold: string;
|
|
2345
|
-
header: string;
|
|
2346
|
-
silver: string;
|
|
2347
|
-
}
|
|
2348
|
-
/**
|
|
2349
|
-
* The response for an item class index.
|
|
2350
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2351
|
-
*/
|
|
2352
|
-
interface ItemClassIndexResponse extends ResponseBase {
|
|
2353
|
-
item_classes: Array<NameIdKey>;
|
|
2354
|
-
}
|
|
2355
|
-
/**
|
|
2356
|
-
* The response for an item class.
|
|
2357
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2358
|
-
*/
|
|
2359
|
-
interface ItemClassResponse extends ResponseBase {
|
|
2360
|
-
class_id: number;
|
|
2361
|
-
item_subclasses: Array<NameIdKey>;
|
|
2362
|
-
name: string;
|
|
2363
|
-
}
|
|
2364
|
-
/**
|
|
2365
|
-
* The response for an item media.
|
|
2366
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2367
|
-
*/
|
|
2368
|
-
interface ItemMediaResponse extends ResponseBase {
|
|
2369
|
-
assets: Array<MediaAsset$1>;
|
|
2370
|
-
id: number;
|
|
2371
|
-
}
|
|
2372
|
-
/**
|
|
2373
|
-
* The response for an item subclass.
|
|
2374
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2375
|
-
*/
|
|
2376
|
-
interface ItemSubClassResponse extends ResponseBase {
|
|
2377
|
-
class_id: number;
|
|
2378
|
-
display_name: string;
|
|
2379
|
-
hide_subclass_in_tooltips: boolean;
|
|
2380
|
-
subclass_id: number;
|
|
2381
|
-
verbose_name: string;
|
|
2382
|
-
}
|
|
2383
|
-
/**
|
|
2384
|
-
* The response for an item set index.
|
|
2385
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2386
|
-
*/
|
|
2387
|
-
interface ItemSetIndexResponse extends ResponseBase {
|
|
2388
|
-
item_sets: Array<NameIdKey>;
|
|
2389
|
-
}
|
|
2390
|
-
/**
|
|
2391
|
-
* The response for an item set.
|
|
2392
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2393
|
-
*/
|
|
2394
|
-
interface ItemSetResponse extends ResponseBase {
|
|
2395
|
-
effects: Array<Effect>;
|
|
2396
|
-
id: number;
|
|
2397
|
-
items: Array<NameIdKey>;
|
|
2398
|
-
name: string;
|
|
2399
|
-
}
|
|
2400
|
-
interface Effect {
|
|
2401
|
-
display_string: string;
|
|
2402
|
-
required_count: number;
|
|
2403
|
-
}
|
|
2404
|
-
/**
|
|
2405
|
-
* The parameters for an item search.
|
|
2406
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2407
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2408
|
-
*/
|
|
2409
|
-
interface ItemSearchParameters extends BaseSearchParameters {
|
|
2410
|
-
locale: Locales;
|
|
2411
|
-
name: string;
|
|
2412
|
-
}
|
|
2413
|
-
/**
|
|
2414
|
-
* The response for an item search.
|
|
2415
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2416
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2417
|
-
*/
|
|
2418
|
-
interface ItemSearchResponseItem extends KeyBase {
|
|
2419
|
-
data: {
|
|
2420
|
-
id: number;
|
|
2421
|
-
inventory_type: InventoryType;
|
|
2422
|
-
is_equippable: boolean;
|
|
2423
|
-
is_stackable: boolean;
|
|
2424
|
-
item_class: {
|
|
2425
|
-
id: number;
|
|
2426
|
-
name: Record<Locales, string | undefined>;
|
|
2427
|
-
};
|
|
2428
|
-
item_subclass: {
|
|
2429
|
-
id: number;
|
|
2430
|
-
name: Record<Locales, string | undefined>;
|
|
2431
|
-
};
|
|
2432
|
-
level: number;
|
|
2433
|
-
max_count: number;
|
|
2434
|
-
media: {
|
|
2435
|
-
id: number;
|
|
2436
|
-
};
|
|
2437
|
-
name: Record<Locales, string | undefined>;
|
|
2438
|
-
purchase_price: number;
|
|
2439
|
-
purchase_quantity: number;
|
|
2440
|
-
quality: ItemQuality;
|
|
2441
|
-
required_level: number;
|
|
2442
|
-
sell_price: number;
|
|
2443
|
-
};
|
|
2444
|
-
}
|
|
2445
|
-
|
|
2446
|
-
/**
|
|
2447
|
-
* Get an item by ID.
|
|
2448
|
-
* @param itemId The item ID.
|
|
2449
|
-
* @returns The item. See {@link ItemResponse}.
|
|
2450
|
-
*/
|
|
2451
|
-
declare function item(itemId: number): Resource<ItemResponse>;
|
|
2452
|
-
/**
|
|
2453
|
-
* Get an item class by ID.
|
|
2454
|
-
* @param itemClassId The item class ID.
|
|
2455
|
-
* @returns The item class. See {@link ItemClassResponse}.
|
|
2456
|
-
*/
|
|
2457
|
-
declare function itemClass(itemClassId: number): Resource<ItemClassResponse>;
|
|
2458
|
-
/**
|
|
2459
|
-
* Get an item subclass by ID.
|
|
2460
|
-
* @param itemClassId The item class ID.
|
|
2461
|
-
* @param itemSubclassId The item subclass ID.
|
|
2462
|
-
* @returns The item subclass. See {@link ItemSubClassResponse}.
|
|
2463
|
-
*/
|
|
2464
|
-
declare function itemSubClass(itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
|
|
2465
|
-
/**
|
|
2466
|
-
* Get an item class index.
|
|
2467
|
-
* @returns The item class index. See {@link ItemClassIndexResponse}.
|
|
2468
|
-
*/
|
|
2469
|
-
declare function itemClassIndex(): Resource<ItemClassIndexResponse>;
|
|
2470
|
-
/**
|
|
2471
|
-
* Get item media by ID.
|
|
2472
|
-
* @param itemId The item ID.
|
|
2473
|
-
* @returns The item media. See {@link ItemMediaResponse}.
|
|
2474
|
-
*/
|
|
2475
|
-
declare function itemMedia(itemId: number): Resource<ItemMediaResponse>;
|
|
2476
|
-
/**
|
|
2477
|
-
* Get an item set by ID.
|
|
2478
|
-
* @param itemSetId The item set ID.
|
|
2479
|
-
* @returns The item set. See {@link ItemSetResponse}.
|
|
2480
|
-
*/
|
|
2481
|
-
declare function itemSet(itemSetId: number): Resource<ItemSetResponse>;
|
|
2482
|
-
/**
|
|
2483
|
-
* Get an item set index.
|
|
2484
|
-
* @returns The item set index. See {@link ItemSetIndexResponse}.
|
|
2485
|
-
*/
|
|
2486
|
-
declare function itemSetIndex(): Resource<ItemSetIndexResponse>;
|
|
2487
|
-
/**
|
|
2488
|
-
* Search for items.
|
|
2489
|
-
* @param options The search parameters. See {@link ItemSearchParameters}.
|
|
2490
|
-
* @returns The search results. See {@link SearchResponse}.
|
|
2491
|
-
*/
|
|
2492
|
-
declare function itemSearch(options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, 'locale' | 'name'>>;
|
|
2493
|
-
|
|
2494
|
-
type EncounterCategory = 'DUNGEON' | 'RAID' | 'WORLD_BOSS';
|
|
2495
|
-
type EncounterMode = 'HEROIC' | 'LFR' | 'MYTHIC' | 'NORMAL';
|
|
2496
|
-
type ModeName = '10 Player' | '10 Player (Heroic)' | '25 Player' | '25 Player (Heroic)' | 'Heroic' | 'Mythic' | 'Mythic+ Dungeons' | 'Normal' | 'Raid Finder';
|
|
2497
|
-
type ModeType = 'HEROIC' | 'LEGACY_10_MAN' | 'LEGACY_10_MAN_HEROIC' | 'LEGACY_25_MAN' | 'LEGACY_25_MAN_HEROIC' | 'LFR' | 'MYTHIC' | 'MYTHIC_KEYSTONE' | 'NORMAL';
|
|
2498
|
-
/**
|
|
2499
|
-
* The response for a journal encounter index.
|
|
2500
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2501
|
-
*/
|
|
2502
|
-
interface JournalEncounterIndexResponse extends ResponseBase {
|
|
2503
|
-
encounters: Array<NameIdKey>;
|
|
2504
|
-
}
|
|
2505
|
-
/**
|
|
2506
|
-
* The response for a journal encounter.
|
|
2507
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2508
|
-
*/
|
|
2509
|
-
interface JournalEncounterResponse extends ResponseBase, NameId {
|
|
2510
|
-
category: Category$1;
|
|
2511
|
-
creatures: Array<Creature>;
|
|
2512
|
-
description: string;
|
|
2513
|
-
faction?: Faction;
|
|
2514
|
-
instance: NameIdKey;
|
|
2515
|
-
items: Array<Item>;
|
|
2516
|
-
modes?: Array<Mode>;
|
|
2517
|
-
sections: Array<JournalSection>;
|
|
2518
|
-
}
|
|
2519
|
-
interface Category$1 {
|
|
2520
|
-
type: EncounterCategory;
|
|
2521
|
-
}
|
|
2522
|
-
interface Creature extends NameId {
|
|
2523
|
-
creature_display: CreatureDisplay$1;
|
|
2524
|
-
description?: string;
|
|
2525
|
-
}
|
|
2526
|
-
interface CreatureDisplay$1 extends KeyBase {
|
|
2527
|
-
id: number;
|
|
2528
|
-
}
|
|
2529
|
-
interface Item {
|
|
2530
|
-
id: number;
|
|
2531
|
-
item: NameIdKey;
|
|
2532
|
-
}
|
|
2533
|
-
interface Mode {
|
|
2534
|
-
name: ModeName;
|
|
2535
|
-
type: ModeType;
|
|
2536
|
-
}
|
|
2537
|
-
interface JournalSection {
|
|
2538
|
-
body_text?: string;
|
|
2539
|
-
creature_display?: CreatureDisplay$1;
|
|
2540
|
-
id: number;
|
|
2541
|
-
sections?: Array<JournalSection>;
|
|
2542
|
-
spell?: NameIdKey;
|
|
2543
|
-
title: string;
|
|
2544
|
-
}
|
|
2545
|
-
/**
|
|
2546
|
-
* The response for a journal expansion index.
|
|
2547
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2548
|
-
*/
|
|
2549
|
-
interface JournalExpansionIndexResponse extends ResponseBase {
|
|
2550
|
-
tiers: Array<NameIdKey>;
|
|
2551
|
-
}
|
|
2552
|
-
/**
|
|
2553
|
-
* The response for a journal expansion.
|
|
2554
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2555
|
-
*/
|
|
2556
|
-
interface JournalExpansionResponse extends ResponseBase, NameId {
|
|
2557
|
-
dungeons: Array<NameIdKey>;
|
|
2558
|
-
raids: Array<NameIdKey>;
|
|
2559
|
-
}
|
|
2560
|
-
/**
|
|
2561
|
-
* The response for a journal instance index.
|
|
2562
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2563
|
-
*/
|
|
2564
|
-
interface JournalInstanceIndexResponse extends ResponseBase {
|
|
2565
|
-
instances: Array<NameIdKey>;
|
|
2566
|
-
}
|
|
2567
|
-
/**
|
|
2568
|
-
* The response for a journal instance.
|
|
2569
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2570
|
-
*/
|
|
2571
|
-
interface JournalInstanceResponse extends ResponseBase, NameId {
|
|
2572
|
-
area: NameId;
|
|
2573
|
-
category: Category$1;
|
|
2574
|
-
description: string;
|
|
2575
|
-
encounters: Array<NameIdKey>;
|
|
2576
|
-
expansion: NameIdKey;
|
|
2577
|
-
location: NameId;
|
|
2578
|
-
map: NameId;
|
|
2579
|
-
media: Media$9;
|
|
2580
|
-
minimum_level: number;
|
|
2581
|
-
modes: Array<ModeElement>;
|
|
2582
|
-
order_index: number;
|
|
2583
|
-
}
|
|
2584
|
-
interface Media$9 extends KeyBase {
|
|
2585
|
-
id: number;
|
|
2586
|
-
}
|
|
2587
|
-
interface ModeElement {
|
|
2588
|
-
is_tracked: boolean;
|
|
2589
|
-
mode: Mode;
|
|
2590
|
-
players: number;
|
|
2591
|
-
}
|
|
2592
|
-
/**
|
|
2593
|
-
* The response for journal instance media.
|
|
2594
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2595
|
-
*/
|
|
2596
|
-
interface JournalInstanceMediaResponse extends ResponseBase {
|
|
2597
|
-
assets: Array<Asset>;
|
|
2598
|
-
}
|
|
2599
|
-
interface Asset {
|
|
2600
|
-
key: string;
|
|
2601
|
-
value: string;
|
|
2602
|
-
}
|
|
2603
|
-
/**
|
|
2604
|
-
* The parameters for a journal encounter search.
|
|
2605
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2606
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2607
|
-
*/
|
|
2608
|
-
interface JournalEncounterSearchParameters extends BaseSearchParameters {
|
|
2609
|
-
instanceName: string;
|
|
2610
|
-
locale: Locales;
|
|
2611
|
-
}
|
|
2612
|
-
/**
|
|
2613
|
-
* The response for a journal encounter search.
|
|
2614
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2615
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2616
|
-
*/
|
|
2617
|
-
interface JournalEncounterSearchResponseItem extends KeyBase {
|
|
2618
|
-
data: {
|
|
2619
|
-
category: Category$1;
|
|
2620
|
-
creatures: Array<JournalEncounterSearchCreature>;
|
|
2621
|
-
id: number;
|
|
2622
|
-
instance: {
|
|
2623
|
-
id: number;
|
|
2624
|
-
name: Record<Locales, string>;
|
|
2625
|
-
};
|
|
2626
|
-
items: Array<JournalEncounterSearchItem>;
|
|
2627
|
-
modes?: Array<{
|
|
2628
|
-
name: Record<Locales, string>;
|
|
2629
|
-
type: EncounterMode;
|
|
2630
|
-
}>;
|
|
2631
|
-
name: Record<Locales, string>;
|
|
2632
|
-
sections: Array<JournalSection>;
|
|
2633
|
-
};
|
|
2634
|
-
}
|
|
2635
|
-
interface JournalEncounterSearchCreature {
|
|
2636
|
-
creature_display: {
|
|
2637
|
-
id: number;
|
|
2638
|
-
};
|
|
2639
|
-
id: number;
|
|
2640
|
-
name: Record<Locales, string>;
|
|
2641
|
-
}
|
|
2642
|
-
interface JournalEncounterSearchItem {
|
|
2643
|
-
id: number;
|
|
2644
|
-
item: {
|
|
2645
|
-
id: number;
|
|
2646
|
-
name: Record<Locales, string>;
|
|
2647
|
-
};
|
|
2648
|
-
}
|
|
2649
|
-
|
|
2650
|
-
/**
|
|
2651
|
-
* Get a journal encounter by ID.
|
|
2652
|
-
* @param journalEncounterId The journal encounter ID.
|
|
2653
|
-
* @returns The journal encounter. See {@link JournalEncounterResponse}.
|
|
2654
|
-
*/
|
|
2655
|
-
declare function journalEncounter(journalEncounterId: number): Resource<JournalEncounterResponse>;
|
|
2656
|
-
/**
|
|
2657
|
-
* Get the journal encounter index.
|
|
2658
|
-
* @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
|
|
2659
|
-
*/
|
|
2660
|
-
declare function journalEncounterIndex(): Resource<JournalEncounterIndexResponse>;
|
|
2661
|
-
/**
|
|
2662
|
-
* Search for journal encounters.
|
|
2663
|
-
* @param options The search parameters. See {@link JournalEncounterSearchParameters}.
|
|
2664
|
-
* @returns The search results. See {@link SearchResponse}.
|
|
2665
|
-
*/
|
|
2666
|
-
declare function journalEncounterSearch(options: JournalEncounterSearchParameters): Resource<SearchResponse<JournalEncounterSearchResponseItem>, Omit<JournalEncounterSearchParameters, 'instanceName' | 'locale'>>;
|
|
2667
|
-
/**
|
|
2668
|
-
* Get a journal expansion by ID.
|
|
2669
|
-
* @param journalExpansionId The journal expansion ID.
|
|
2670
|
-
* @returns The journal expansion. See {@link JournalExpansionResponse}.
|
|
2671
|
-
*/
|
|
2672
|
-
declare function journalExpansion(journalExpansionId: number): Resource<JournalExpansionResponse>;
|
|
2673
|
-
/**
|
|
2674
|
-
* Get the journal expansion index.
|
|
2675
|
-
* @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
|
|
2676
|
-
*/
|
|
2677
|
-
declare function journalExpansionIndex(): Resource<JournalExpansionIndexResponse>;
|
|
2678
|
-
/**
|
|
2679
|
-
* Get a journal instance by ID.
|
|
2680
|
-
* @param journalInstanceId The journal instance ID.
|
|
2681
|
-
* @returns The journal instance. See {@link JournalInstanceResponse}.
|
|
2682
|
-
*/
|
|
2683
|
-
declare function journalInstance(journalInstanceId: number): Resource<JournalInstanceResponse>;
|
|
2684
|
-
/**
|
|
2685
|
-
* Get the journal instance index.
|
|
2686
|
-
* @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
|
|
2687
|
-
*/
|
|
2688
|
-
declare function journalInstanceIndex(): Resource<JournalInstanceIndexResponse>;
|
|
2689
|
-
/**
|
|
2690
|
-
* Get journal instance media by ID.
|
|
2691
|
-
* @param journalInstanceId The journal instance ID.
|
|
2692
|
-
* @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
|
|
2693
|
-
*/
|
|
2694
|
-
declare function journalInstanceMedia(journalInstanceId: number): Resource<JournalInstanceMediaResponse>;
|
|
2695
|
-
|
|
2696
|
-
/**
|
|
2697
|
-
* The search parameters for media.
|
|
2698
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2699
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2700
|
-
*/
|
|
2701
|
-
interface MediaSearchParameters extends BaseSearchParameters {
|
|
2702
|
-
tags?: string;
|
|
2703
|
-
}
|
|
2704
|
-
/**
|
|
2705
|
-
* The response for a media search.
|
|
2706
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2707
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2708
|
-
*/
|
|
2709
|
-
interface MediaSearchResponseItem extends KeyBase {
|
|
2710
|
-
data: {
|
|
2711
|
-
assets: Array<MediaAsset>;
|
|
2712
|
-
id: number;
|
|
2713
|
-
};
|
|
2714
|
-
}
|
|
2715
|
-
interface MediaAsset {
|
|
2716
|
-
file_data_id: number;
|
|
2717
|
-
key: string;
|
|
2718
|
-
value: string;
|
|
2719
|
-
}
|
|
2720
|
-
|
|
2721
|
-
/**
|
|
2722
|
-
* Search for media.
|
|
2723
|
-
* @param options The search parameters. See {@link MediaSearchParameters}.
|
|
2724
|
-
* @returns The search results. See {@link SearchResponse}.
|
|
2725
|
-
*/
|
|
2726
|
-
declare function mediaSearch(options: MediaSearchParameters): Resource<SearchResponse<MediaSearchResponseItem>, MediaSearchParameters>;
|
|
2727
|
-
|
|
2728
|
-
/**
|
|
2729
|
-
* The response for a modified crafting category.
|
|
2730
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2731
|
-
*/
|
|
2732
|
-
interface ModifiedCraftingCategoryResponse extends ResponseBase, NameId {
|
|
2733
|
-
}
|
|
2734
|
-
/**
|
|
2735
|
-
* The response for a modified crafting category index.
|
|
2736
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2737
|
-
*/
|
|
2738
|
-
interface ModifiedCraftingCategoryIndexResponse extends ResponseBase {
|
|
2739
|
-
categories: Array<NameIdKey>;
|
|
2740
|
-
}
|
|
2741
|
-
/**
|
|
2742
|
-
* The response for a modified crafting index.
|
|
2743
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2744
|
-
*/
|
|
2745
|
-
interface ModifiedCraftingIndexResponse extends ResponseBase {
|
|
2746
|
-
categories: {
|
|
2747
|
-
href: string;
|
|
2748
|
-
};
|
|
2749
|
-
slot_types: {
|
|
2750
|
-
href: string;
|
|
2751
|
-
};
|
|
2752
|
-
}
|
|
2753
|
-
/**
|
|
2754
|
-
* The response for a modified crafting reagent slot type index.
|
|
2755
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2756
|
-
*/
|
|
2757
|
-
interface ModifiedCraftingReagentSlotTypeIndexResponse extends ResponseBase {
|
|
2758
|
-
slot_types: Array<SlotType>;
|
|
2759
|
-
}
|
|
2760
|
-
interface SlotType extends KeyBase {
|
|
2761
|
-
id: number;
|
|
2762
|
-
name?: string;
|
|
2763
|
-
}
|
|
2764
|
-
/**
|
|
2765
|
-
* The response for a modified crafting reagent slot type.
|
|
2766
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2767
|
-
*/
|
|
2768
|
-
interface ModifiedCraftingReagentSlotTypeResponse extends ResponseBase {
|
|
2769
|
-
compatible_categories: Array<NameIdKey>;
|
|
2770
|
-
description: string;
|
|
2771
|
-
id: number;
|
|
2772
|
-
}
|
|
2773
|
-
|
|
2774
|
-
/**
|
|
2775
|
-
* Get a modified crafting category by ID.
|
|
2776
|
-
* @param modifiedCraftingCategoryId The modified crafting category ID.
|
|
2777
|
-
* @returns The modified crafting category. See {@link ModifiedCraftingCategoryResponse}.
|
|
2778
|
-
*/
|
|
2779
|
-
declare function modifiedCraftingCategory(modifiedCraftingCategoryId: number): Resource<ModifiedCraftingCategoryResponse>;
|
|
2780
|
-
/**
|
|
2781
|
-
* Get a modified crafting category index.
|
|
2782
|
-
* @returns The modified crafting category index. See {@link ModifiedCraftingCategoryIndexResponse}.
|
|
2783
|
-
*/
|
|
2784
|
-
declare function modifiedCraftingCategoryIndex(): Resource<ModifiedCraftingCategoryIndexResponse>;
|
|
2785
|
-
/**
|
|
2786
|
-
* Get a modified crafting index.
|
|
2787
|
-
* @returns The modified crafting index. See {@link ModifiedCraftingIndexResponse}.
|
|
2788
|
-
*/
|
|
2789
|
-
declare function modifiedCraftingIndex(): Resource<ModifiedCraftingIndexResponse>;
|
|
2790
|
-
/**
|
|
2791
|
-
* Get a modified crafting reagent slot type by ID.
|
|
2792
|
-
* @param modifiedCraftingReagentSlotTypeId The modified crafting reagent slot type ID.
|
|
2793
|
-
* @returns The modified crafting reagent slot type. See {@link ModifiedCraftingReagentSlotTypeResponse}.
|
|
2794
|
-
*/
|
|
2795
|
-
declare function modifiedCraftingReagentSlotType(modifiedCraftingReagentSlotTypeId: number): Resource<ModifiedCraftingReagentSlotTypeResponse>;
|
|
2796
|
-
/**
|
|
2797
|
-
* Get a modified crafting reagent slot type index.
|
|
2798
|
-
* @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
|
|
2799
|
-
*/
|
|
2800
|
-
declare function modifiedCraftingReagentSlotTypeIndex(): Resource<ModifiedCraftingReagentSlotTypeIndexResponse>;
|
|
2801
|
-
|
|
2802
|
-
/**
|
|
2803
|
-
* The response for a mount index.
|
|
2804
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2805
|
-
*/
|
|
2806
|
-
interface MountIndexResponse extends ResponseBase {
|
|
2807
|
-
mounts: Array<NameIdKey>;
|
|
2808
|
-
}
|
|
2809
|
-
/**
|
|
2810
|
-
* The response for a mount.
|
|
2811
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2812
|
-
*/
|
|
2813
|
-
interface MountResponse extends ResponseBase {
|
|
2814
|
-
creature_displays: Array<CreatureDisplay>;
|
|
2815
|
-
description: string;
|
|
2816
|
-
id: number;
|
|
2817
|
-
name: string;
|
|
2818
|
-
should_exclude_if_uncollected: boolean;
|
|
2819
|
-
source: Source$2;
|
|
2820
|
-
}
|
|
2821
|
-
interface CreatureDisplay extends KeyBase {
|
|
2822
|
-
id: number;
|
|
2823
|
-
}
|
|
2824
|
-
interface Source$2 {
|
|
2825
|
-
name: string;
|
|
2826
|
-
type: string;
|
|
2827
|
-
}
|
|
2828
|
-
/**
|
|
2829
|
-
* The search parameters for mounts.
|
|
2830
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2831
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2832
|
-
*/
|
|
2833
|
-
interface MountSearchParameters extends BaseSearchParameters {
|
|
2834
|
-
locale: Locales;
|
|
2835
|
-
name: string;
|
|
2836
|
-
}
|
|
2837
|
-
/**
|
|
2838
|
-
* The response for a mount search.
|
|
2839
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2840
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
2841
|
-
*/
|
|
2842
|
-
interface MountSearchResponseItem extends KeyBase {
|
|
2843
|
-
data: {
|
|
2844
|
-
creature_displays: Array<{
|
|
2845
|
-
id: number;
|
|
2846
|
-
}>;
|
|
2847
|
-
faction?: {
|
|
2848
|
-
name: Record<Locales, string>;
|
|
2849
|
-
type: keyof typeof Factions;
|
|
2850
|
-
};
|
|
2851
|
-
id: number;
|
|
2852
|
-
name: Record<Locales, string>;
|
|
2853
|
-
source: {
|
|
2854
|
-
name: Record<Locales, string>;
|
|
2855
|
-
type: string;
|
|
2856
|
-
};
|
|
2857
|
-
};
|
|
2858
|
-
}
|
|
2859
|
-
|
|
2860
|
-
/**
|
|
2861
|
-
* Get a mount by ID.
|
|
2862
|
-
* @param mountId The mount ID.
|
|
2863
|
-
* @returns The mount. See {@link MountResponse}.
|
|
2864
|
-
*/
|
|
2865
|
-
declare function mount(mountId: number): Resource<MountResponse>;
|
|
2866
|
-
/**
|
|
2867
|
-
* Get a mount index.
|
|
2868
|
-
* @returns The mount index. See {@link MountIndexResponse}.
|
|
2869
|
-
*/
|
|
2870
|
-
declare function mountIndex(): Resource<MountIndexResponse>;
|
|
2871
|
-
/**
|
|
2872
|
-
* Get a mount search.
|
|
2873
|
-
* @param options The search parameters. See {@link MountSearchParameters}.
|
|
2874
|
-
* @returns The search results. See {@link SearchResponse}.
|
|
2875
|
-
*/
|
|
2876
|
-
declare function mountSearch(options: MountSearchParameters): Resource<SearchResponse<MountSearchResponseItem>, Omit<MountSearchParameters, 'locale' | 'name'>>;
|
|
2877
|
-
|
|
2878
|
-
/**
|
|
2879
|
-
* The response for a Mythic Keystone affix index.
|
|
2880
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2881
|
-
*/
|
|
2882
|
-
interface MythicKeystoneAffixIndexResponse extends ResponseBase {
|
|
2883
|
-
affixes: Array<NameIdKey>;
|
|
2884
|
-
}
|
|
2885
|
-
/**
|
|
2886
|
-
* The response for a Mythic Keystone affix.
|
|
2887
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2888
|
-
*/
|
|
2889
|
-
interface MythicKeystoneAffixResponse extends ResponseBase, NameId {
|
|
2890
|
-
description: string;
|
|
2891
|
-
media: Media$8;
|
|
2892
|
-
}
|
|
2893
|
-
interface Media$8 extends KeyBase {
|
|
2894
|
-
id: number;
|
|
2895
|
-
}
|
|
2896
|
-
/**
|
|
2897
|
-
* The response for a Mythic Keystone affix media.
|
|
2898
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2899
|
-
*/
|
|
2900
|
-
interface MythicKeystoneAffixMediaResponse extends ResponseBase {
|
|
2901
|
-
assets: Array<MediaAsset$1>;
|
|
2902
|
-
id: number;
|
|
2903
|
-
}
|
|
2904
|
-
|
|
2905
|
-
/**
|
|
2906
|
-
* Get a list of all Mythic Keystone affixes.
|
|
2907
|
-
* @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
|
|
2908
|
-
*/
|
|
2909
|
-
declare function mythicKeystoneAffix(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixResponse>;
|
|
2910
|
-
/**
|
|
2911
|
-
* Get a list of all Mythic Keystone affixes.
|
|
2912
|
-
* @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
|
|
2913
|
-
*/
|
|
2914
|
-
declare function mythicKeystoneAffixIndex(): Resource<MythicKeystoneAffixIndexResponse>;
|
|
2915
|
-
/**
|
|
2916
|
-
* Get a list of all Mythic Keystone affix media.
|
|
2917
|
-
* @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
|
|
2918
|
-
*/
|
|
2919
|
-
declare function mythicKeystoneAffixMedia(mythicKeystoneAffixId: number): Resource<MythicKeystoneAffixMediaResponse>;
|
|
2920
|
-
|
|
2921
|
-
/**
|
|
2922
|
-
* The response for a Mythic Keystone dungeon index.
|
|
2923
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2924
|
-
*/
|
|
2925
|
-
interface MythicKeystoneDungeonIndexResponse extends ResponseBase {
|
|
2926
|
-
dungeons: Array<NameIdKey>;
|
|
2927
|
-
}
|
|
2928
|
-
/**
|
|
2929
|
-
* The response for a Mythic Keystone dungeon.
|
|
2930
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2931
|
-
*/
|
|
2932
|
-
interface MythicKeystoneDungeonResponse extends ResponseBase, NameId {
|
|
2933
|
-
dungeon: NameIdKey;
|
|
2934
|
-
is_tracked: boolean;
|
|
2935
|
-
keystone_upgrades: Array<KeystoneUpgrade>;
|
|
2936
|
-
map: NameId;
|
|
2937
|
-
zone: Zone;
|
|
2938
|
-
}
|
|
2939
|
-
interface KeystoneUpgrade {
|
|
2940
|
-
qualifying_duration: number;
|
|
2941
|
-
upgrade_level: number;
|
|
2942
|
-
}
|
|
2943
|
-
interface Zone {
|
|
2944
|
-
slug: string;
|
|
2945
|
-
}
|
|
2946
|
-
/**
|
|
2947
|
-
* The response for a Mythic Keystone index.
|
|
2948
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2949
|
-
*/
|
|
2950
|
-
interface MythicKeystoneIndexResponse extends ResponseBase {
|
|
2951
|
-
dungeons: {
|
|
2952
|
-
href: string;
|
|
2953
|
-
};
|
|
2954
|
-
seasons: {
|
|
2955
|
-
href: string;
|
|
2956
|
-
};
|
|
2957
|
-
}
|
|
2958
|
-
/**
|
|
2959
|
-
* The response for a Mythic Keystone period index.
|
|
2960
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2961
|
-
*/
|
|
2962
|
-
interface MythicKeystonePeriodIndexResponse extends ResponseBase {
|
|
2963
|
-
current_period: Period;
|
|
2964
|
-
periods: Array<Period>;
|
|
2965
|
-
}
|
|
2966
|
-
interface Period extends KeyBase {
|
|
2967
|
-
id: number;
|
|
2968
|
-
}
|
|
2969
|
-
/**
|
|
2970
|
-
* The response for a Mythic Keystone period.
|
|
2971
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2972
|
-
*/
|
|
2973
|
-
interface MythicKeystonePeriodResponse extends ResponseBase {
|
|
2974
|
-
end_timestamp: number;
|
|
2975
|
-
id: number;
|
|
2976
|
-
start_timestamp: number;
|
|
2977
|
-
}
|
|
2978
|
-
/**
|
|
2979
|
-
* The response for a Mythic Keystone season index.
|
|
2980
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2981
|
-
*/
|
|
2982
|
-
interface MythicKeystoneSeasonIndexResponse extends ResponseBase {
|
|
2983
|
-
current_season: Period;
|
|
2984
|
-
seasons: Array<Period>;
|
|
2985
|
-
}
|
|
2986
|
-
/**
|
|
2987
|
-
* The response for a Mythic Keystone season.
|
|
2988
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
2989
|
-
*/
|
|
2990
|
-
interface MythicKeystoneSeasonResponse extends ResponseBase {
|
|
2991
|
-
end_timestamp: number;
|
|
2992
|
-
id: number;
|
|
2993
|
-
periods: Array<Period>;
|
|
2994
|
-
season_name: null | string;
|
|
2995
|
-
start_timestamp: number;
|
|
2996
|
-
}
|
|
2997
|
-
|
|
2998
|
-
/**
|
|
2999
|
-
* Get a Mythic Keystone dungeon by ID.
|
|
3000
|
-
* @param mythicKeystoneDungeonId The Mythic Keystone dungeon ID.
|
|
3001
|
-
* @returns The Mythic Keystone dungeon. See {@link MythicKeystoneDungeonResponse}.
|
|
3002
|
-
*/
|
|
3003
|
-
declare function mythicKeystoneDungeon(mythicKeystoneDungeonId: number): Resource<MythicKeystoneDungeonResponse>;
|
|
3004
|
-
/**
|
|
3005
|
-
* Get a Mythic Keystone dungeon index.
|
|
3006
|
-
* @returns The Mythic Keystone dungeon index. See {@link MythicKeystoneDungeonIndexResponse}.
|
|
3007
|
-
*/
|
|
3008
|
-
declare function mythicKeystoneDungeonIndex(): Resource<MythicKeystoneDungeonIndexResponse>;
|
|
3009
|
-
/**
|
|
3010
|
-
* Get a Mythic Keystone index.
|
|
3011
|
-
* @returns The Mythic Keystone index. See {@link MythicKeystoneIndexResponse}.
|
|
3012
|
-
*/
|
|
3013
|
-
declare function mythicKeystoneIndex(): Resource<MythicKeystoneIndexResponse>;
|
|
3014
|
-
/**
|
|
3015
|
-
* Get a Mythic Keystone period by ID.
|
|
3016
|
-
* @param mythicKeystonePeriodId The Mythic Keystone period ID.
|
|
3017
|
-
* @returns The Mythic Keystone period. See {@link MythicKeystonePeriodResponse}.
|
|
3018
|
-
*/
|
|
3019
|
-
declare function mythicKeystonePeriod(mythicKeystonePeriodId: number): Resource<MythicKeystonePeriodResponse>;
|
|
3020
|
-
/**
|
|
3021
|
-
* Get a Mythic Keystone period index.
|
|
3022
|
-
* @returns The Mythic Keystone period index. See {@link MythicKeystonePeriodIndexResponse}.
|
|
3023
|
-
*/
|
|
3024
|
-
declare function mythicKeystonePeriodIndex(): Resource<MythicKeystonePeriodIndexResponse>;
|
|
3025
|
-
/**
|
|
3026
|
-
* Get a Mythic Keystone season by ID.
|
|
3027
|
-
* @param mythicKeystoneSeasonId The Mythic Keystone season ID.
|
|
3028
|
-
* @returns The Mythic Keystone season. See {@link MythicKeystoneSeasonResponse}.
|
|
3029
|
-
*/
|
|
3030
|
-
declare function mythicKeystoneSeason(mythicKeystoneSeasonId: number): Resource<MythicKeystoneSeasonResponse>;
|
|
3031
|
-
/**
|
|
3032
|
-
* Get a Mythic Keystone season index.
|
|
3033
|
-
* @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
|
|
3034
|
-
*/
|
|
3035
|
-
declare function mythicKeystoneSeasonIndex(): Resource<MythicKeystoneSeasonIndexResponse>;
|
|
3036
|
-
|
|
3037
|
-
/**
|
|
3038
|
-
* The response for a Mythic Keystone leaderboard index.
|
|
3039
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3040
|
-
*/
|
|
3041
|
-
interface MythicKeystoneLeaderboardIndexResponse extends ResponseBase {
|
|
3042
|
-
current_leaderboards: Array<NameIdKey>;
|
|
3043
|
-
}
|
|
3044
|
-
/**
|
|
3045
|
-
* The response for a Mythic Keystone leaderboard.
|
|
3046
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3047
|
-
*/
|
|
3048
|
-
interface MythicKeystoneLeaderboardResponse extends ResponseBase {
|
|
3049
|
-
connected_realm: {
|
|
3050
|
-
href: string;
|
|
3051
|
-
};
|
|
3052
|
-
keystone_affixes: Array<KeystoneAffixElement>;
|
|
3053
|
-
leading_groups: Array<LeadingGroup>;
|
|
3054
|
-
map: NameId;
|
|
3055
|
-
map_challenge_mode_id: number;
|
|
3056
|
-
name: string;
|
|
3057
|
-
period: number;
|
|
3058
|
-
period_end_timestamp: number;
|
|
3059
|
-
period_start_timestamp: number;
|
|
3060
|
-
}
|
|
3061
|
-
interface KeystoneAffixElement {
|
|
3062
|
-
keystone_affix: NameIdKey;
|
|
3063
|
-
starting_level: number;
|
|
3064
|
-
}
|
|
3065
|
-
interface LeadingGroup {
|
|
3066
|
-
completed_timestamp: number;
|
|
3067
|
-
duration: number;
|
|
3068
|
-
keystone_level: number;
|
|
3069
|
-
members: Array<Member>;
|
|
3070
|
-
mythic_rating: MythicRating;
|
|
3071
|
-
ranking: number;
|
|
3072
|
-
}
|
|
3073
|
-
interface Member {
|
|
3074
|
-
faction: {
|
|
3075
|
-
type: keyof typeof Factions;
|
|
3076
|
-
};
|
|
3077
|
-
profile: Profile;
|
|
3078
|
-
specialization: Specialization;
|
|
3079
|
-
}
|
|
3080
|
-
interface Profile extends NameId {
|
|
3081
|
-
realm: Realm$2;
|
|
3082
|
-
}
|
|
3083
|
-
interface Realm$2 extends KeyBase {
|
|
3084
|
-
id: number;
|
|
3085
|
-
slug: string;
|
|
3086
|
-
}
|
|
3087
|
-
interface Specialization extends KeyBase {
|
|
3088
|
-
id: number;
|
|
3089
|
-
}
|
|
3090
|
-
interface MythicRating {
|
|
3091
|
-
color: Color;
|
|
3092
|
-
rating: number;
|
|
3093
|
-
}
|
|
3094
|
-
|
|
3095
|
-
/**
|
|
3096
|
-
* Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
|
|
3097
|
-
* @param connectedRealmId The connected realm ID.
|
|
3098
|
-
* @param dungeonId The dungeon ID.
|
|
3099
|
-
* @param period The period ID.
|
|
3100
|
-
* @returns The Mythic Keystone leaderboard. See {@link MythicKeystoneLeaderboardResponse}.
|
|
3101
|
-
*/
|
|
3102
|
-
declare function mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId: number, period: number): Resource<MythicKeystoneLeaderboardResponse>;
|
|
3103
|
-
/**
|
|
3104
|
-
* Get a Mythic Keystone leaderboard index by connected realm ID.
|
|
3105
|
-
* @param connectedRealmId The connected realm ID.
|
|
3106
|
-
* @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
|
|
3107
|
-
*/
|
|
3108
|
-
declare function mythicKeystoneLeaderboardIndex(connectedRealmId: number): Resource<MythicKeystoneLeaderboardIndexResponse>;
|
|
3109
|
-
|
|
3110
|
-
/**
|
|
3111
|
-
* The response for a Mythic Raid leaderboard.
|
|
3112
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3113
|
-
*/
|
|
3114
|
-
interface MythicRaidLeaderboardResponse extends ResponseBase {
|
|
3115
|
-
criteria_type: string;
|
|
3116
|
-
entries: Array<Entry$1>;
|
|
3117
|
-
journal_instance: JournalInstance;
|
|
3118
|
-
slug: string;
|
|
3119
|
-
}
|
|
3120
|
-
interface Entry$1 {
|
|
3121
|
-
faction: {
|
|
3122
|
-
type: keyof typeof Factions;
|
|
3123
|
-
};
|
|
3124
|
-
guild: Guild;
|
|
3125
|
-
rank: number;
|
|
3126
|
-
region: 'cn' | Origins;
|
|
3127
|
-
timestamp: number;
|
|
3128
|
-
}
|
|
3129
|
-
interface Guild extends NameId {
|
|
3130
|
-
realm: Realm$1;
|
|
3131
|
-
}
|
|
3132
|
-
interface Realm$1 {
|
|
3133
|
-
id: number;
|
|
3134
|
-
name: null;
|
|
3135
|
-
slug: string;
|
|
3136
|
-
}
|
|
3137
|
-
interface JournalInstance extends KeyBase {
|
|
3138
|
-
id: number;
|
|
3139
|
-
name: null;
|
|
3140
|
-
}
|
|
3141
|
-
|
|
3142
|
-
/**
|
|
3143
|
-
* Get a Mythic Raid leaderboard by raid and faction.
|
|
3144
|
-
* @param raid The slug of the raid.
|
|
3145
|
-
* @param faction The faction. Either 'alliance' or 'horde'.
|
|
3146
|
-
* @returns The Mythic Raid leaderboard. See {@link MythicRaidLeaderboardResponse}.
|
|
3147
|
-
*/
|
|
3148
|
-
declare function mythicRaidLeaderboard(raid: string, faction: Lowercase<keyof typeof Factions>): Resource<MythicRaidLeaderboardResponse>;
|
|
3149
|
-
|
|
3150
|
-
/**
|
|
3151
|
-
* The response for a pet index.
|
|
3152
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3153
|
-
*/
|
|
3154
|
-
interface PetIndexResponse extends ResponseBase {
|
|
3155
|
-
pets: Array<NameIdKey>;
|
|
3156
|
-
}
|
|
3157
|
-
/**
|
|
3158
|
-
* The response for a pet.
|
|
3159
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3160
|
-
*/
|
|
3161
|
-
interface PetResponse extends ResponseBase, NameId {
|
|
3162
|
-
abilities: Array<Ability>;
|
|
3163
|
-
battle_pet_type: BattlePetType;
|
|
3164
|
-
creature: NameIdKey;
|
|
3165
|
-
description: string;
|
|
3166
|
-
icon: string;
|
|
3167
|
-
is_alliance_only: boolean;
|
|
3168
|
-
is_battlepet: boolean;
|
|
3169
|
-
is_capturable: boolean;
|
|
3170
|
-
is_horde_only: boolean;
|
|
3171
|
-
is_random_creature_display: boolean;
|
|
3172
|
-
is_tradable: boolean;
|
|
3173
|
-
media: Media$7;
|
|
3174
|
-
should_exclude_if_uncollected: boolean;
|
|
3175
|
-
source: Source$1;
|
|
3176
|
-
}
|
|
3177
|
-
interface Ability {
|
|
3178
|
-
ability: NameIdKey;
|
|
3179
|
-
required_level: number;
|
|
3180
|
-
slot: number;
|
|
3181
|
-
}
|
|
3182
|
-
interface BattlePetType extends NameId {
|
|
3183
|
-
type: string;
|
|
3184
|
-
}
|
|
3185
|
-
interface Media$7 extends KeyBase {
|
|
3186
|
-
id: number;
|
|
3187
|
-
}
|
|
3188
|
-
interface Source$1 {
|
|
3189
|
-
name: string;
|
|
3190
|
-
type: string;
|
|
3191
|
-
}
|
|
3192
|
-
/**
|
|
3193
|
-
* The response for a pet search.
|
|
3194
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3195
|
-
*/
|
|
3196
|
-
interface PetMediaResponse extends ResponseBase {
|
|
3197
|
-
assets: Array<MediaAsset$1>;
|
|
3198
|
-
id: number;
|
|
3199
|
-
}
|
|
3200
|
-
/**
|
|
3201
|
-
* The response for a pet ability index.
|
|
3202
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3203
|
-
*/
|
|
3204
|
-
interface PetAbilityIndexResponse extends ResponseBase {
|
|
3205
|
-
abilities: Array<NameIdKey>;
|
|
3206
|
-
}
|
|
3207
|
-
/**
|
|
3208
|
-
* The response for a pet ability.
|
|
3209
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3210
|
-
*/
|
|
3211
|
-
interface PetAbilityResponse extends ResponseBase, NameId {
|
|
3212
|
-
battle_pet_type: BattlePetType;
|
|
3213
|
-
media: Media$7;
|
|
3214
|
-
rounds: number;
|
|
3215
|
-
}
|
|
3216
|
-
/**
|
|
3217
|
-
* The response for a pet ability media.
|
|
3218
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3219
|
-
*/
|
|
3220
|
-
interface PetAbilityMediaResponse extends ResponseBase {
|
|
3221
|
-
assets: Array<MediaAsset$1>;
|
|
3222
|
-
id: number;
|
|
3223
|
-
}
|
|
3224
|
-
|
|
3225
|
-
/**
|
|
3226
|
-
* Get a pet by ID.
|
|
3227
|
-
* @param petId The pet ID.
|
|
3228
|
-
* @returns The pet. See {@link PetResponse}.
|
|
3229
|
-
*/
|
|
3230
|
-
declare function pet(petId: number): Resource<PetResponse>;
|
|
3231
|
-
/**
|
|
3232
|
-
* Get a pet index.
|
|
3233
|
-
* @returns The pet index. See {@link PetIndexResponse}.
|
|
3234
|
-
*/
|
|
3235
|
-
declare function petIndex(): Resource<PetIndexResponse>;
|
|
3236
|
-
/**
|
|
3237
|
-
* Get a pet media by ID.
|
|
3238
|
-
* @param petId The pet ID.
|
|
3239
|
-
* @returns The pet media. See {@link PetMediaResponse}.
|
|
3240
|
-
*/
|
|
3241
|
-
declare function petMedia(petId: number): Resource<PetMediaResponse>;
|
|
3242
|
-
/**
|
|
3243
|
-
* Get a pet ability by ID.
|
|
3244
|
-
* @param petAbilityId The pet ability ID.
|
|
3245
|
-
* @returns The pet ability. See {@link PetAbilityResponse}.
|
|
3246
|
-
*/
|
|
3247
|
-
declare function petAbility(petAbilityId: number): Resource<PetAbilityResponse>;
|
|
3248
|
-
/**
|
|
3249
|
-
* Get a pet ability index.
|
|
3250
|
-
* @returns The pet ability index. See {@link PetAbilityIndexResponse}.
|
|
3251
|
-
*/
|
|
3252
|
-
declare function petAbilityIndex(): Resource<PetAbilityIndexResponse>;
|
|
3253
|
-
/**
|
|
3254
|
-
* Get a pet ability media by ID.
|
|
3255
|
-
* @param petAbilityId The pet ability ID.
|
|
3256
|
-
* @returns The pet ability media. See {@link PetAbilityMediaResponse}.
|
|
3257
|
-
*/
|
|
3258
|
-
declare function petAbilityMedia(petAbilityId: number): Resource<PetAbilityMediaResponse>;
|
|
3259
|
-
|
|
3260
|
-
/**
|
|
3261
|
-
* The response for a playable class index.
|
|
3262
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3263
|
-
*/
|
|
3264
|
-
interface PlayableClassIndexResponse extends ResponseBase {
|
|
3265
|
-
classes: Array<NameIdKey>;
|
|
3266
|
-
}
|
|
3267
|
-
/**
|
|
3268
|
-
* The response for a playable class.
|
|
3269
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3270
|
-
*/
|
|
3271
|
-
interface PlayableClassResponse extends ResponseBase, NameId {
|
|
3272
|
-
gender_name: GenderName;
|
|
3273
|
-
media: Media$6;
|
|
3274
|
-
playable_races: Array<NameIdKey>;
|
|
3275
|
-
power_type: NameIdKey;
|
|
3276
|
-
pvp_talent_slots: {
|
|
3277
|
-
href: string;
|
|
3278
|
-
};
|
|
3279
|
-
specializations: Array<NameIdKey>;
|
|
3280
|
-
}
|
|
3281
|
-
interface Media$6 extends KeyBase {
|
|
3282
|
-
id: number;
|
|
3283
|
-
}
|
|
3284
|
-
/**
|
|
3285
|
-
* The response for playable class media.
|
|
3286
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3287
|
-
*/
|
|
3288
|
-
interface PlayableClassMediaResponse extends ResponseBase {
|
|
3289
|
-
assets: Array<MediaAsset$1>;
|
|
3290
|
-
id: number;
|
|
3291
|
-
}
|
|
3292
|
-
/**
|
|
3293
|
-
* The response for a playable class's PvP talent slots.
|
|
3294
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3295
|
-
*/
|
|
3296
|
-
interface PvpTalentSlotsResponse extends ResponseBase {
|
|
3297
|
-
talent_slots: Array<TalentSlot>;
|
|
3298
|
-
}
|
|
3299
|
-
interface TalentSlot {
|
|
3300
|
-
slot_number: number;
|
|
3301
|
-
unlock_player_level: number;
|
|
3302
|
-
}
|
|
3303
|
-
|
|
3304
|
-
/**
|
|
3305
|
-
* Get a playable class by ID.
|
|
3306
|
-
* @param playableClassId The playable class ID.
|
|
3307
|
-
* @returns The playable class. See {@link PlayableClassResponse}.
|
|
3308
|
-
*/
|
|
3309
|
-
declare function playableClass(playableClassId: number): Resource<PlayableClassResponse>;
|
|
3310
|
-
/**
|
|
3311
|
-
* Get a playable class index.
|
|
3312
|
-
* @returns The playable class index. See {@link PlayableClassIndexResponse}.
|
|
3313
|
-
*/
|
|
3314
|
-
declare function playableClassIndex(): Resource<PlayableClassIndexResponse>;
|
|
3315
|
-
/**
|
|
3316
|
-
* Get playable class media by ID.
|
|
3317
|
-
* @param playableClassId The playable class ID.
|
|
3318
|
-
* @returns The playable class media. See {@link PlayableClassMediaResponse}.
|
|
3319
|
-
*/
|
|
3320
|
-
declare function playableClassMedia(playableClassId: number): Resource<PlayableClassMediaResponse>;
|
|
3321
|
-
/**
|
|
3322
|
-
* Get a playable class's PvP talent slots by ID.
|
|
3323
|
-
* @param playableClassId The playable class ID.
|
|
3324
|
-
* @returns The playable class's PvP talent slots. See {@link PvpTalentSlotsResponse}.
|
|
3325
|
-
*/
|
|
3326
|
-
declare function pvpTalentSlots(playableClassId: number): Resource<PvpTalentSlotsResponse>;
|
|
3327
|
-
|
|
3328
|
-
/**
|
|
3329
|
-
* The playable race index response.
|
|
3330
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3331
|
-
*/
|
|
3332
|
-
interface PlayableRaceIndexResponse extends ResponseBase {
|
|
3333
|
-
races: Array<NameIdKey>;
|
|
3334
|
-
}
|
|
3335
|
-
/**
|
|
3336
|
-
* The playable race response.
|
|
3337
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3338
|
-
*/
|
|
3339
|
-
interface PlayableRaceResponse extends ResponseBase, NameId {
|
|
3340
|
-
faction: Faction;
|
|
3341
|
-
gender_name: GenderName;
|
|
3342
|
-
is_allied_race: boolean;
|
|
3343
|
-
is_selectable: boolean;
|
|
3344
|
-
playable_classes: Array<NameIdKey>;
|
|
3345
|
-
}
|
|
3346
|
-
|
|
3347
|
-
/**
|
|
3348
|
-
* Get a playable race by ID.
|
|
3349
|
-
* @param playableRaceId The playable race ID.
|
|
3350
|
-
* @returns The playable race. See {@link PlayableRaceResponse}.
|
|
3351
|
-
*/
|
|
3352
|
-
declare function playableRace(playableRaceId: number): Resource<PlayableRaceResponse>;
|
|
3353
|
-
/**
|
|
3354
|
-
* Get a playable race index.
|
|
3355
|
-
* @returns The playable race index. See {@link PlayableRaceIndexResponse}.
|
|
3356
|
-
*/
|
|
3357
|
-
declare function playableRaceIndex(): Resource<PlayableRaceIndexResponse>;
|
|
3358
|
-
|
|
3359
|
-
/**
|
|
3360
|
-
* The response for a playable specialization index.
|
|
3361
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3362
|
-
*/
|
|
3363
|
-
interface PlayableSpecializationIndexResponse extends ResponseBase {
|
|
3364
|
-
character_specializations: Array<NameIdKey>;
|
|
3365
|
-
pet_specializations: Array<NameIdKey>;
|
|
3366
|
-
}
|
|
3367
|
-
/**
|
|
3368
|
-
* The response for a playable specialization.
|
|
3369
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3370
|
-
*/
|
|
3371
|
-
interface PlayableSpecializationResponse extends ResponseBase, NameId {
|
|
3372
|
-
gender_description: GenderName;
|
|
3373
|
-
media: Media$5;
|
|
3374
|
-
playable_class: NameIdKey;
|
|
3375
|
-
power_type: NameIdKey;
|
|
3376
|
-
primary_stat_type: PrimaryStatType;
|
|
3377
|
-
pvp_talents: Array<PvpTalent>;
|
|
3378
|
-
role: PrimaryStatType;
|
|
3379
|
-
spec_talent_tree: SpecTalentTree$1;
|
|
3380
|
-
}
|
|
3381
|
-
interface Media$5 extends KeyBase {
|
|
3382
|
-
id: number;
|
|
3383
|
-
}
|
|
3384
|
-
interface PrimaryStatType {
|
|
3385
|
-
name: string;
|
|
3386
|
-
type: string;
|
|
3387
|
-
}
|
|
3388
|
-
interface PvpTalent {
|
|
3389
|
-
spell_tooltip: SpellTooltip;
|
|
3390
|
-
talent: NameIdKey;
|
|
3391
|
-
}
|
|
3392
|
-
interface SpellTooltip {
|
|
3393
|
-
cast_time: string;
|
|
3394
|
-
cooldown?: string;
|
|
3395
|
-
description: string;
|
|
3396
|
-
power_cost?: string;
|
|
3397
|
-
range?: string;
|
|
3398
|
-
}
|
|
3399
|
-
interface SpecTalentTree$1 extends KeyBase {
|
|
3400
|
-
name: string;
|
|
3401
|
-
}
|
|
3402
|
-
/**
|
|
3403
|
-
* The response for a playable specialization media.
|
|
3404
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3405
|
-
*/
|
|
3406
|
-
interface PlayableSpecializationMediaResponse extends ResponseBase {
|
|
3407
|
-
assets: Array<MediaAsset$1>;
|
|
3408
|
-
id: number;
|
|
3409
|
-
}
|
|
3410
|
-
|
|
3411
|
-
/**
|
|
3412
|
-
* Get a playable specialization by ID.
|
|
3413
|
-
* @param specializationId The playable specialization ID.
|
|
3414
|
-
* @returns The playable specialization. See {@link PlayableSpecializationResponse}.
|
|
3415
|
-
*/
|
|
3416
|
-
declare function playableSpecialization(specializationId: number): Resource<PlayableSpecializationResponse>;
|
|
3417
|
-
/**
|
|
3418
|
-
* Get a playable specialization index.
|
|
3419
|
-
* @returns The playable specialization index. See {@link PlayableSpecializationIndexResponse}.
|
|
3420
|
-
*/
|
|
3421
|
-
declare function playableSpecializationIndex(): Resource<PlayableSpecializationIndexResponse>;
|
|
3422
|
-
/**
|
|
3423
|
-
* Get a playable specialization media by ID.
|
|
3424
|
-
* @param specializationId The playable specialization ID.
|
|
3425
|
-
* @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
|
|
3426
|
-
*/
|
|
3427
|
-
declare function playableSpecializationMedia(specializationId: number): Resource<PlayableSpecializationMediaResponse>;
|
|
3428
|
-
|
|
3429
|
-
/**
|
|
3430
|
-
* The response for a power type index.
|
|
3431
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3432
|
-
*/
|
|
3433
|
-
interface PowerTypeIndexResponse extends ResponseBase {
|
|
3434
|
-
power_types: Array<NameIdKey>;
|
|
3435
|
-
}
|
|
3436
|
-
/**
|
|
3437
|
-
* The response for a power type.
|
|
3438
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3439
|
-
*/
|
|
3440
|
-
interface PowerTypeResponse extends ResponseBase, NameId {
|
|
3441
|
-
}
|
|
3442
|
-
|
|
3443
|
-
/**
|
|
3444
|
-
* Get a power type by ID.
|
|
3445
|
-
* @param powerTypeId The power type ID.
|
|
3446
|
-
* @returns The power type. See {@link PowerTypeResponse}.
|
|
3447
|
-
*/
|
|
3448
|
-
declare function powerType(powerTypeId: number): Resource<PowerTypeResponse>;
|
|
3449
|
-
/**
|
|
3450
|
-
* Get a power type index.
|
|
3451
|
-
* @returns The power type index. See {@link PowerTypeIndexResponse}.
|
|
3452
|
-
*/
|
|
3453
|
-
declare function powerTypeIndex(): Resource<PowerTypeIndexResponse>;
|
|
3454
|
-
|
|
3455
|
-
/**
|
|
3456
|
-
* The response for a profession index.
|
|
3457
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3458
|
-
*/
|
|
3459
|
-
interface ProfessionIndexResponse extends ResponseBase {
|
|
3460
|
-
professions: Array<NameIdKey>;
|
|
3461
|
-
}
|
|
3462
|
-
/**
|
|
3463
|
-
* The response for a profession.
|
|
3464
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3465
|
-
*/
|
|
3466
|
-
interface ProfessionResponse extends ResponseBase, NameId {
|
|
3467
|
-
description: string;
|
|
3468
|
-
media: Media$4;
|
|
3469
|
-
skill_tiers: Array<NameIdKey>;
|
|
3470
|
-
type: Type;
|
|
3471
|
-
}
|
|
3472
|
-
interface Media$4 extends KeyBase {
|
|
3473
|
-
id: number;
|
|
3474
|
-
}
|
|
3475
|
-
interface Type {
|
|
3476
|
-
name: string;
|
|
3477
|
-
type: string;
|
|
3478
|
-
}
|
|
3479
|
-
/**
|
|
3480
|
-
* The response for a profession skill tier.
|
|
3481
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3482
|
-
*/
|
|
3483
|
-
interface ProfessionSkillTierResponse extends ResponseBase, NameId {
|
|
3484
|
-
categories: Array<Category>;
|
|
3485
|
-
maximum_skill_level: number;
|
|
3486
|
-
minimum_skill_level: number;
|
|
3487
|
-
}
|
|
3488
|
-
interface Category {
|
|
3489
|
-
name: string;
|
|
3490
|
-
recipes: Array<NameIdKey>;
|
|
3491
|
-
}
|
|
3492
|
-
/**
|
|
3493
|
-
* The response for a profession media.
|
|
3494
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3495
|
-
*/
|
|
3496
|
-
interface ProfessionMediaResponse extends ResponseBase {
|
|
3497
|
-
assets: Array<MediaAsset$1>;
|
|
3498
|
-
id: number;
|
|
3499
|
-
}
|
|
3500
|
-
/**
|
|
3501
|
-
* The response for a recipe.
|
|
3502
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3503
|
-
*/
|
|
3504
|
-
interface RecipeResponse extends ResponseBase, NameId {
|
|
3505
|
-
crafted_item: NameIdKey;
|
|
3506
|
-
crafted_quantity: CraftedQuantity;
|
|
3507
|
-
media: Media$4;
|
|
3508
|
-
reagents: Array<Reagent>;
|
|
3509
|
-
}
|
|
3510
|
-
interface CraftedQuantity {
|
|
3511
|
-
value: number;
|
|
3512
|
-
}
|
|
3513
|
-
interface Reagent {
|
|
3514
|
-
quantity: number;
|
|
3515
|
-
reagent: NameIdKey;
|
|
3516
|
-
}
|
|
3517
|
-
/**
|
|
3518
|
-
* The response for a recipe media.
|
|
3519
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3520
|
-
*/
|
|
3521
|
-
interface RecipeMediaResponse extends ResponseBase {
|
|
3522
|
-
assets: Array<MediaAsset$1>;
|
|
3523
|
-
id: number;
|
|
3524
|
-
}
|
|
3525
|
-
|
|
3526
|
-
/**
|
|
3527
|
-
* Get a profession by ID.
|
|
3528
|
-
* @param professionId The profession ID.
|
|
3529
|
-
* @returns The profession. See {@link ProfessionResponse}.
|
|
3530
|
-
*/
|
|
3531
|
-
declare function profession(professionId: number): Resource<ProfessionResponse>;
|
|
3532
|
-
/**
|
|
3533
|
-
* Get a profession index.
|
|
3534
|
-
* @returns The profession index. See {@link ProfessionIndexResponse}.
|
|
3535
|
-
*/
|
|
3536
|
-
declare function professionIndex(): Resource<ProfessionIndexResponse>;
|
|
3537
|
-
/**
|
|
3538
|
-
* Get profession media by ID.
|
|
3539
|
-
* @param professionId The profession ID.
|
|
3540
|
-
* @returns The profession media. See {@link ProfessionMediaResponse}.
|
|
3541
|
-
*/
|
|
3542
|
-
declare function professionMedia(professionId: number): Resource<ProfessionMediaResponse>;
|
|
3543
|
-
/**
|
|
3544
|
-
* Get a profession's skill tier by ID.
|
|
3545
|
-
* @param professionId The profession ID.
|
|
3546
|
-
* @param skillTierId The skill tier ID.
|
|
3547
|
-
* @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
|
|
3548
|
-
*/
|
|
3549
|
-
declare function professionSkillTier(professionId: number, skillTierId: number): Resource<ProfessionSkillTierResponse>;
|
|
3550
|
-
/**
|
|
3551
|
-
* Get a recipe by ID.
|
|
3552
|
-
* @param recipeId The recipe ID.
|
|
3553
|
-
* @returns The recipe. See {@link RecipeResponse}.
|
|
3554
|
-
*/
|
|
3555
|
-
declare function recipe(recipeId: number): Resource<RecipeResponse>;
|
|
3556
|
-
/**
|
|
3557
|
-
* Get recipe media by ID.
|
|
3558
|
-
* @param recipeId The recipe ID.
|
|
3559
|
-
* @returns The recipe media. See {@link RecipeMediaResponse}.
|
|
3560
|
-
*/
|
|
3561
|
-
declare function recipeMedia(recipeId: number): Resource<RecipeMediaResponse>;
|
|
3562
|
-
|
|
3563
|
-
/**
|
|
3564
|
-
* The response for a PvP leaderboard.
|
|
3565
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3566
|
-
*/
|
|
3567
|
-
interface PvpLeaderboardResponse extends ResponseBase {
|
|
3568
|
-
bracket: Bracket$1;
|
|
3569
|
-
entries: Array<Entry>;
|
|
3570
|
-
name: string;
|
|
3571
|
-
season: Season;
|
|
3572
|
-
}
|
|
3573
|
-
interface Entry {
|
|
3574
|
-
character: Character;
|
|
3575
|
-
faction: {
|
|
3576
|
-
type: keyof typeof Factions;
|
|
3577
|
-
};
|
|
3578
|
-
rank: number;
|
|
3579
|
-
rating: number;
|
|
3580
|
-
season_match_statistics: SeasonMatchStatistics;
|
|
3581
|
-
tier: Season;
|
|
3582
|
-
}
|
|
3583
|
-
interface Character extends NameId {
|
|
3584
|
-
realm: Realm;
|
|
3585
|
-
}
|
|
3586
|
-
interface Realm extends KeyBase {
|
|
3587
|
-
id: number;
|
|
3588
|
-
slug: string;
|
|
3589
|
-
}
|
|
3590
|
-
interface SeasonMatchStatistics {
|
|
3591
|
-
lost: number;
|
|
3592
|
-
played: number;
|
|
3593
|
-
won: number;
|
|
3594
|
-
}
|
|
3595
|
-
/**
|
|
3596
|
-
* The response for a PvP leaderboard index.
|
|
3597
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3598
|
-
*/
|
|
3599
|
-
interface PvpLeaderboardIndexResponse extends ResponseBase {
|
|
3600
|
-
leaderboards: Array<NameIdKey>;
|
|
3601
|
-
season: Season;
|
|
3602
|
-
}
|
|
3603
|
-
/**
|
|
3604
|
-
* The response for PvP rewards index.
|
|
3605
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3606
|
-
*/
|
|
3607
|
-
interface PvpRewardsIndexResponse extends ResponseBase {
|
|
3608
|
-
rewards: Array<Reward>;
|
|
3609
|
-
season: Season;
|
|
3610
|
-
}
|
|
3611
|
-
interface Reward {
|
|
3612
|
-
achievement: NameIdKey;
|
|
3613
|
-
bracket: Bracket$1;
|
|
3614
|
-
faction?: Faction;
|
|
3615
|
-
rating_cutoff: number;
|
|
3616
|
-
specialization?: NameIdKey;
|
|
3617
|
-
}
|
|
3618
|
-
interface Bracket$1 {
|
|
3619
|
-
id: number;
|
|
3620
|
-
type: 'ARENA_3v3' | 'BATTLEGROUNDS' | 'SHUFFLE';
|
|
3621
|
-
}
|
|
3622
|
-
/**
|
|
3623
|
-
* The response for a PvP season index.
|
|
3624
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3625
|
-
*/
|
|
3626
|
-
interface PvpSeasonIndexResponse extends ResponseBase {
|
|
3627
|
-
current_season: Season;
|
|
3628
|
-
seasons: Array<Season>;
|
|
3629
|
-
}
|
|
3630
|
-
interface Season extends KeyBase {
|
|
3631
|
-
id: number;
|
|
3632
|
-
}
|
|
3633
|
-
/**
|
|
3634
|
-
* The response for a PvP season.
|
|
3635
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3636
|
-
*/
|
|
3637
|
-
interface PvpSeasonResponse extends ResponseBase {
|
|
3638
|
-
id: number;
|
|
3639
|
-
leaderboards: {
|
|
3640
|
-
href: string;
|
|
3641
|
-
};
|
|
3642
|
-
rewards: {
|
|
3643
|
-
href: string;
|
|
3644
|
-
};
|
|
3645
|
-
season_name?: string;
|
|
3646
|
-
season_start_timestamp: number;
|
|
3647
|
-
}
|
|
3648
|
-
|
|
3649
|
-
/**
|
|
3650
|
-
* Get a PvP leaderboard by PvP season ID and bracket.
|
|
3651
|
-
* @param pvpSeasonId The PvP season ID.
|
|
3652
|
-
* @param bracket The PvP bracket.
|
|
3653
|
-
* @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
|
|
3654
|
-
*/
|
|
3655
|
-
declare function pvpLeaderboard(pvpSeasonId: number, bracket: string): Resource<PvpLeaderboardResponse>;
|
|
3656
|
-
/**
|
|
3657
|
-
* Get a PvP leaderboard index by PvP season ID.
|
|
3658
|
-
* @param pvpSeasonId The PvP season ID.
|
|
3659
|
-
* @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
|
|
3660
|
-
*/
|
|
3661
|
-
declare function pvpLeaderboardIndex(pvpSeasonId: number): Resource<PvpLeaderboardIndexResponse>;
|
|
3662
|
-
/**
|
|
3663
|
-
* Get a PvP reward index by PvP season ID.
|
|
3664
|
-
* @param pvpSeasonId The PvP season ID.
|
|
3665
|
-
* @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
|
|
3666
|
-
*/
|
|
3667
|
-
declare function pvpRewardsIndex(pvpSeasonId: number): Resource<PvpRewardsIndexResponse>;
|
|
3668
|
-
/**
|
|
3669
|
-
* Get a PvP season by ID.
|
|
3670
|
-
* @param pvpSeasonId The PvP season ID.
|
|
3671
|
-
* @returns The PvP season. See {@link PvpSeasonResponse}.
|
|
3672
|
-
*/
|
|
3673
|
-
declare function pvpSeason(pvpSeasonId: number): Resource<PvpSeasonResponse>;
|
|
3674
|
-
/**
|
|
3675
|
-
* Get a PvP season index.
|
|
3676
|
-
* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
|
|
3677
|
-
*/
|
|
3678
|
-
declare function pvpSeasonIndex(): Resource<PvpSeasonIndexResponse>;
|
|
3679
|
-
|
|
3680
|
-
/**
|
|
3681
|
-
* The response for a PvP tier index.
|
|
3682
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3683
|
-
*/
|
|
3684
|
-
interface PvpTierIndexResponse extends ResponseBase {
|
|
3685
|
-
tiers: Array<NameIdKey>;
|
|
3686
|
-
}
|
|
3687
|
-
/**
|
|
3688
|
-
* The response for a PvP tier.
|
|
3689
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3690
|
-
*/
|
|
3691
|
-
interface PvpTierResponse extends ResponseBase, NameId {
|
|
3692
|
-
bracket: Bracket;
|
|
3693
|
-
max_rating: number;
|
|
3694
|
-
media: Media$3;
|
|
3695
|
-
min_rating: number;
|
|
3696
|
-
rating_type: number;
|
|
3697
|
-
}
|
|
3698
|
-
interface Bracket {
|
|
3699
|
-
id: number;
|
|
3700
|
-
type: string;
|
|
3701
|
-
}
|
|
3702
|
-
interface Media$3 extends KeyBase {
|
|
3703
|
-
id: number;
|
|
3704
|
-
}
|
|
3705
|
-
/**
|
|
3706
|
-
* The response for a PvP tier media.
|
|
3707
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3708
|
-
*/
|
|
3709
|
-
interface PvpTierMediaResponse extends ResponseBase {
|
|
3710
|
-
assets: Array<MediaAsset$1>;
|
|
3711
|
-
id: number;
|
|
3712
|
-
}
|
|
3713
|
-
|
|
3714
|
-
/**
|
|
3715
|
-
* Get a PvP tier by ID.
|
|
3716
|
-
* @param pvpTierId The PvP tier ID.
|
|
3717
|
-
* @returns The PvP tier. See {@link PvpTierResponse}.
|
|
3718
|
-
*/
|
|
3719
|
-
declare function pvpTier(pvpTierId: number): Resource<PvpTierResponse>;
|
|
3720
|
-
/**
|
|
3721
|
-
* Get a PvP tier index.
|
|
3722
|
-
* @returns The PvP tier index. See {@link PvpTierIndexResponse}.
|
|
3723
|
-
*/
|
|
3724
|
-
declare function pvpTierIndex(): Resource<PvpTierIndexResponse>;
|
|
3725
|
-
/**
|
|
3726
|
-
* Get PvP tier media by ID.
|
|
3727
|
-
* @param pvpTierId The PvP tier ID.
|
|
3728
|
-
* @returns The PvP tier media. See {@link PvpTierMediaResponse}.
|
|
3729
|
-
*/
|
|
3730
|
-
declare function pvpTierMedia(pvpTierId: number): Resource<PvpTierMediaResponse>;
|
|
3731
|
-
|
|
3732
|
-
/**
|
|
3733
|
-
* The response for a quest index.
|
|
3734
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3735
|
-
*/
|
|
3736
|
-
interface QuestIndexResponse extends ResponseBase {
|
|
3737
|
-
areas: {
|
|
3738
|
-
href: string;
|
|
3739
|
-
};
|
|
3740
|
-
categories: {
|
|
3741
|
-
href: string;
|
|
3742
|
-
};
|
|
3743
|
-
types: {
|
|
3744
|
-
href: string;
|
|
3745
|
-
};
|
|
3746
|
-
}
|
|
3747
|
-
/**
|
|
3748
|
-
* The response for a quest.
|
|
3749
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3750
|
-
*/
|
|
3751
|
-
interface QuestResponse extends ResponseBase {
|
|
3752
|
-
area: NameIdKey;
|
|
3753
|
-
description: string;
|
|
3754
|
-
id: number;
|
|
3755
|
-
requirements: Requirements;
|
|
3756
|
-
rewards: Rewards;
|
|
3757
|
-
title: string;
|
|
3758
|
-
}
|
|
3759
|
-
interface Requirements {
|
|
3760
|
-
faction: Faction;
|
|
3761
|
-
max_character_level: number;
|
|
3762
|
-
min_character_level: number;
|
|
3763
|
-
}
|
|
3764
|
-
interface Rewards {
|
|
3765
|
-
experience: number;
|
|
3766
|
-
money: Money;
|
|
3767
|
-
reputations: Array<Reputation>;
|
|
3768
|
-
}
|
|
3769
|
-
interface Money {
|
|
3770
|
-
units: Units;
|
|
3771
|
-
value: number;
|
|
3772
|
-
}
|
|
3773
|
-
interface Units {
|
|
3774
|
-
copper: number;
|
|
3775
|
-
gold: number;
|
|
3776
|
-
silver: number;
|
|
3777
|
-
}
|
|
3778
|
-
interface Reputation {
|
|
3779
|
-
reward: NameIdKey;
|
|
3780
|
-
value: number;
|
|
3781
|
-
}
|
|
3782
|
-
/**
|
|
3783
|
-
* The response for a quest area index.
|
|
3784
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3785
|
-
*/
|
|
3786
|
-
interface QuestAreaIndexResponse extends ResponseBase {
|
|
3787
|
-
areas: Array<NameIdKey>;
|
|
3788
|
-
}
|
|
3789
|
-
/**
|
|
3790
|
-
* The response for a quest area.
|
|
3791
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3792
|
-
*/
|
|
3793
|
-
interface QuestAreaResponse extends ResponseBase {
|
|
3794
|
-
area: string;
|
|
3795
|
-
id: number;
|
|
3796
|
-
quests: Array<NameIdKey>;
|
|
3797
|
-
}
|
|
3798
|
-
/**
|
|
3799
|
-
* The response for a quest category index.
|
|
3800
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3801
|
-
*/
|
|
3802
|
-
interface QuestCategoryIndexResponse extends ResponseBase {
|
|
3803
|
-
categories: Array<NameIdKey>;
|
|
3804
|
-
}
|
|
3805
|
-
/**
|
|
3806
|
-
* The response for a quest category.
|
|
3807
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3808
|
-
*/
|
|
3809
|
-
interface QuestCategoryResponse extends ResponseBase {
|
|
3810
|
-
category: string;
|
|
3811
|
-
id: number;
|
|
3812
|
-
quests: Array<NameIdKey>;
|
|
3813
|
-
}
|
|
3814
|
-
/**
|
|
3815
|
-
* The response for a quest type index.
|
|
3816
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3817
|
-
*/
|
|
3818
|
-
interface QuestTypeIndexResponse extends ResponseBase {
|
|
3819
|
-
types: Array<NameIdKey>;
|
|
3820
|
-
}
|
|
3821
|
-
/**
|
|
3822
|
-
* The response for a quest type.
|
|
3823
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3824
|
-
*/
|
|
3825
|
-
interface QuestTypeResponse extends ResponseBase {
|
|
3826
|
-
id: number;
|
|
3827
|
-
quests: Array<NameIdKey>;
|
|
3828
|
-
type: string;
|
|
3829
|
-
}
|
|
3830
|
-
|
|
3831
|
-
/**
|
|
3832
|
-
* Get a quest by ID.
|
|
3833
|
-
* @param questId The quest ID.
|
|
3834
|
-
* @returns The quest. See {@link QuestResponse}.
|
|
3835
|
-
*/
|
|
3836
|
-
declare function quest(questId: number): Resource<QuestResponse>;
|
|
3837
|
-
/**
|
|
3838
|
-
* Get a quest index.
|
|
3839
|
-
* @returns The quest index. See {@link QuestIndexResponse}.
|
|
3840
|
-
*/
|
|
3841
|
-
declare function questIndex(): Resource<QuestIndexResponse>;
|
|
3842
|
-
/**
|
|
3843
|
-
* Get a quest area by ID.
|
|
3844
|
-
* @param questAreaId The quest area ID.
|
|
3845
|
-
* @returns The quest area. See {@link QuestAreaResponse}.
|
|
3846
|
-
*/
|
|
3847
|
-
declare function questArea(questAreaId: number): Resource<QuestAreaResponse>;
|
|
3848
|
-
/**
|
|
3849
|
-
* Get a quest area index.
|
|
3850
|
-
* @returns The quest area index. See {@link QuestAreaIndexResponse}.
|
|
3851
|
-
*/
|
|
3852
|
-
declare function questAreaIndex(): Resource<QuestAreaIndexResponse>;
|
|
3853
|
-
/**
|
|
3854
|
-
* Get a quest category by ID.
|
|
3855
|
-
* @param questCategoryId The quest category ID.
|
|
3856
|
-
* @returns The quest category. See {@link QuestCategoryResponse}.
|
|
3857
|
-
*/
|
|
3858
|
-
declare function questCategory(questCategoryId: number): Resource<QuestCategoryResponse>;
|
|
3859
|
-
/**
|
|
3860
|
-
* Get a quest category index.
|
|
3861
|
-
* @returns The quest category index. See {@link QuestCategoryIndexResponse}.
|
|
3862
|
-
*/
|
|
3863
|
-
declare function questCategoryIndex(): Resource<QuestCategoryIndexResponse>;
|
|
3864
|
-
/**
|
|
3865
|
-
* Get a quest type by ID.
|
|
3866
|
-
* @param questTypeId The quest type ID.
|
|
3867
|
-
* @returns The quest type. See {@link QuestTypeResponse}.
|
|
3868
|
-
*/
|
|
3869
|
-
declare function questType(questTypeId: number): Resource<QuestTypeResponse>;
|
|
3870
|
-
/**
|
|
3871
|
-
* Get a quest type index.
|
|
3872
|
-
* @returns The quest type index. See {@link QuestTypeIndexResponse}.
|
|
3873
|
-
*/
|
|
3874
|
-
declare function questTypeIndex(): Resource<QuestTypeIndexResponse>;
|
|
3875
|
-
|
|
3876
|
-
/**
|
|
3877
|
-
* Get a realm by slug.
|
|
3878
|
-
* @param realmSlug The realm slug.
|
|
3879
|
-
* @returns The realm. See {@link RealmResponse}.
|
|
3880
|
-
*/
|
|
3881
|
-
declare function realm(realmSlug: string): Resource<RealmResponse>;
|
|
3882
|
-
/**
|
|
3883
|
-
* Get a realm index.
|
|
3884
|
-
* @returns The realm index. See {@link RealmIndexResponse}.
|
|
3885
|
-
*/
|
|
3886
|
-
declare function realmIndex(): Resource<RealmIndexResponse>;
|
|
3887
|
-
/**
|
|
3888
|
-
* Search for realms.
|
|
3889
|
-
* @param options The search parameters. See {@link RealmSearchParameters}.
|
|
3890
|
-
* @returns The search results. See {@link SearchResponse}.
|
|
3891
|
-
*/
|
|
3892
|
-
declare function realmSearch(options: RealmSearchParameters): Resource<SearchResponse<RealmSearchResponseItem>, RealmSearchParameters>;
|
|
3893
|
-
|
|
3894
|
-
/**
|
|
3895
|
-
* The response for a region index.
|
|
3896
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3897
|
-
*/
|
|
3898
|
-
interface RegionIndexResponse extends ResponseBase {
|
|
3899
|
-
regions: Array<{
|
|
3900
|
-
href: string;
|
|
3901
|
-
}>;
|
|
3902
|
-
}
|
|
3903
|
-
/**
|
|
3904
|
-
* The response for a region.
|
|
3905
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3906
|
-
*/
|
|
3907
|
-
interface RegionResponse extends ResponseBase, NameId {
|
|
3908
|
-
patch_string: string;
|
|
3909
|
-
tag: string;
|
|
3910
|
-
}
|
|
3911
|
-
|
|
3912
|
-
/**
|
|
3913
|
-
* Get a region by ID.
|
|
3914
|
-
* @param regionId The region ID.
|
|
3915
|
-
* @returns The region. See {@link RegionResponse}.
|
|
3916
|
-
*/
|
|
3917
|
-
declare function region(regionId: number): Resource<RegionResponse>;
|
|
3918
|
-
/**
|
|
3919
|
-
* Get a region index.
|
|
3920
|
-
* @returns The region index. See {@link RegionIndexResponse}.
|
|
3921
|
-
*/
|
|
3922
|
-
declare function regionIndex(): Resource<RegionIndexResponse>;
|
|
3923
|
-
|
|
3924
|
-
/**
|
|
3925
|
-
* The response for a reputation faction index.
|
|
3926
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3927
|
-
*/
|
|
3928
|
-
interface ReputationFactionIndexResponse extends ResponseBase {
|
|
3929
|
-
factions: Array<NameIdKey>;
|
|
3930
|
-
root_factions: Array<NameIdKey>;
|
|
3931
|
-
}
|
|
3932
|
-
/**
|
|
3933
|
-
* The response for a reputation faction.
|
|
3934
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3935
|
-
*/
|
|
3936
|
-
interface ReputationFactionResponse extends ResponseBase {
|
|
3937
|
-
description: string;
|
|
3938
|
-
id: number;
|
|
3939
|
-
name: string;
|
|
3940
|
-
reputation_tiers: ReputationTiers;
|
|
3941
|
-
}
|
|
3942
|
-
interface ReputationTiers extends KeyBase {
|
|
3943
|
-
id: number;
|
|
3944
|
-
}
|
|
3945
|
-
/**
|
|
3946
|
-
* The response for a reputation tier index.
|
|
3947
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3948
|
-
*/
|
|
3949
|
-
interface ReputationTiersIndexResponse extends ResponseBase {
|
|
3950
|
-
reputation_tiers: Array<ReputationTier>;
|
|
3951
|
-
}
|
|
3952
|
-
interface ReputationTier extends KeyBase {
|
|
3953
|
-
id: number;
|
|
3954
|
-
name?: string;
|
|
3955
|
-
}
|
|
3956
|
-
/**
|
|
3957
|
-
* The response for a reputation tier.
|
|
3958
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3959
|
-
*/
|
|
3960
|
-
interface ReputationTiersResponse extends ResponseBase {
|
|
3961
|
-
faction?: NameIdKey;
|
|
3962
|
-
id: number;
|
|
3963
|
-
tiers: Array<Tier>;
|
|
3964
|
-
}
|
|
3965
|
-
interface Tier {
|
|
3966
|
-
id: number;
|
|
3967
|
-
max_value: number;
|
|
3968
|
-
min_value: number;
|
|
3969
|
-
name: string;
|
|
3970
|
-
}
|
|
3971
|
-
|
|
3972
|
-
/**
|
|
3973
|
-
* Get a reputation faction by ID.
|
|
3974
|
-
* @param reputationFactionId The reputation faction ID.
|
|
3975
|
-
* @returns The reputation faction. See {@link ReputationFactionResponse}.
|
|
3976
|
-
*/
|
|
3977
|
-
declare function reputationFaction(reputationFactionId: number): Resource<ReputationFactionResponse>;
|
|
3978
|
-
/**
|
|
3979
|
-
* Get a reputation faction index.
|
|
3980
|
-
* @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
|
|
3981
|
-
*/
|
|
3982
|
-
declare function reputationFactionIndex(): Resource<ReputationFactionIndexResponse>;
|
|
3983
|
-
/**
|
|
3984
|
-
* Get a reputation tier by ID.
|
|
3985
|
-
* @param reputationTiersId The reputation tier ID.
|
|
3986
|
-
* @returns The reputation tier. See {@link ReputationTiersResponse}.
|
|
3987
|
-
*/
|
|
3988
|
-
declare function reputationTiers(reputationTiersId: number): Resource<ReputationTiersResponse>;
|
|
3989
|
-
/**
|
|
3990
|
-
* Get a reputation tier index.
|
|
3991
|
-
* @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
|
|
3992
|
-
*/
|
|
3993
|
-
declare function reputationTiersIndex(): Resource<ReputationTiersIndexResponse>;
|
|
3994
|
-
|
|
3995
|
-
/**
|
|
3996
|
-
* The response for a spell.
|
|
3997
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
3998
|
-
*/
|
|
3999
|
-
interface SpellResponse extends ResponseBase, NameId {
|
|
4000
|
-
description: null | string;
|
|
4001
|
-
media: Media$2;
|
|
4002
|
-
}
|
|
4003
|
-
interface Media$2 extends KeyBase {
|
|
4004
|
-
id: number;
|
|
4005
|
-
}
|
|
4006
|
-
/**
|
|
4007
|
-
* The response for a spell media.
|
|
4008
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4009
|
-
*/
|
|
4010
|
-
interface SpellMediaResponse extends ResponseBase {
|
|
4011
|
-
assets: Array<MediaAsset$1>;
|
|
4012
|
-
id: number;
|
|
4013
|
-
}
|
|
4014
|
-
/**
|
|
4015
|
-
* The search parameters for spells.
|
|
4016
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4017
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
4018
|
-
*/
|
|
4019
|
-
interface SpellSearchParameters extends BaseSearchParameters {
|
|
4020
|
-
locale: Locales;
|
|
4021
|
-
name: string;
|
|
4022
|
-
}
|
|
4023
|
-
/**
|
|
4024
|
-
* The response for a spell search.
|
|
4025
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4026
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
4027
|
-
*/
|
|
4028
|
-
interface SpellSearchResponseItem extends KeyBase {
|
|
4029
|
-
data: {
|
|
4030
|
-
id: number;
|
|
4031
|
-
media: {
|
|
4032
|
-
id: number;
|
|
4033
|
-
};
|
|
4034
|
-
name: Record<Locales, string | undefined>;
|
|
4035
|
-
};
|
|
4036
|
-
}
|
|
4037
|
-
|
|
4038
|
-
/**
|
|
4039
|
-
* Get a spell by ID.
|
|
4040
|
-
* @param spellId The spell ID.
|
|
4041
|
-
* @returns The spell. See {@link SpellResponse}.
|
|
4042
|
-
*/
|
|
4043
|
-
declare function spell(spellId: number): Resource<SpellResponse>;
|
|
4044
|
-
/**
|
|
4045
|
-
* Get spell media by ID.
|
|
4046
|
-
* @param spellId The spell ID.
|
|
4047
|
-
* @returns The spell media. See {@link SpellMediaResponse}.
|
|
4048
|
-
*/
|
|
4049
|
-
declare function spellMedia(spellId: number): Resource<SpellMediaResponse>;
|
|
4050
|
-
/**
|
|
4051
|
-
* Get a spell search.
|
|
4052
|
-
* @param options The spell search options. See {@link SpellSearchParameters}.
|
|
4053
|
-
* @returns The spell search. See {@link SearchResponse}.
|
|
4054
|
-
*/
|
|
4055
|
-
declare function spellSearch(options: SpellSearchParameters): Resource<SearchResponse<SpellSearchResponseItem>, Omit<SpellSearchParameters, 'locale' | 'name'>>;
|
|
4056
|
-
|
|
4057
|
-
/**
|
|
4058
|
-
* The response for a pvp talent index.
|
|
4059
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4060
|
-
*/
|
|
4061
|
-
interface PvpTalentIndexResponse extends ResponseBase {
|
|
4062
|
-
pvp_talents: Array<NameIdKey>;
|
|
4063
|
-
}
|
|
4064
|
-
/**
|
|
4065
|
-
* The response for a pvp talent.
|
|
4066
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4067
|
-
*/
|
|
4068
|
-
interface PvpTalentResponse extends ResponseBase {
|
|
4069
|
-
compatible_slots: Array<number>;
|
|
4070
|
-
description: string;
|
|
4071
|
-
id: number;
|
|
4072
|
-
playable_specialization: NameIdKey;
|
|
4073
|
-
spell: NameIdKey;
|
|
4074
|
-
unlock_player_level: number;
|
|
4075
|
-
}
|
|
4076
|
-
/**
|
|
4077
|
-
* The response for a talent index.
|
|
4078
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4079
|
-
*/
|
|
4080
|
-
interface TalentIndexResponse extends ResponseBase {
|
|
4081
|
-
talents: Array<NameIdKey>;
|
|
4082
|
-
}
|
|
4083
|
-
/**
|
|
4084
|
-
* The response for a talent.
|
|
4085
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4086
|
-
*/
|
|
4087
|
-
interface TalentResponse extends ResponseBase {
|
|
4088
|
-
id: number;
|
|
4089
|
-
playable_class: PlayableClass;
|
|
4090
|
-
rank_descriptions: Array<RankDescription>;
|
|
4091
|
-
spell: NameIdKey;
|
|
4092
|
-
}
|
|
4093
|
-
interface PlayableClass extends KeyBase {
|
|
4094
|
-
id: number;
|
|
4095
|
-
}
|
|
4096
|
-
interface RankDescription {
|
|
4097
|
-
description: null;
|
|
4098
|
-
rank: number;
|
|
4099
|
-
}
|
|
4100
|
-
/**
|
|
4101
|
-
* The response for a talent tree index.
|
|
4102
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4103
|
-
*/
|
|
4104
|
-
interface TalentTreeIndexResponse extends ResponseBase {
|
|
4105
|
-
class_talent_trees: Array<TalentTree$1>;
|
|
4106
|
-
spec_talent_trees: Array<TalentTree$1>;
|
|
4107
|
-
}
|
|
4108
|
-
interface TalentTree$1 extends KeyBase {
|
|
4109
|
-
name: string;
|
|
4110
|
-
}
|
|
4111
|
-
/**
|
|
4112
|
-
* The response for a talent tree.
|
|
4113
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4114
|
-
*/
|
|
4115
|
-
interface TalentTreeResponse extends ResponseBase, NameId {
|
|
4116
|
-
class_talent_nodes: Array<ClassTalentNode>;
|
|
4117
|
-
media: {
|
|
4118
|
-
href: string;
|
|
4119
|
-
};
|
|
4120
|
-
playable_class: NameIdKey;
|
|
4121
|
-
playable_specialization: NameIdKey;
|
|
4122
|
-
restriction_lines: Array<RestrictionLine>;
|
|
4123
|
-
spec_talent_nodes: Array<SpecTalentNode>;
|
|
4124
|
-
}
|
|
4125
|
-
interface ClassTalentNode {
|
|
4126
|
-
display_col: number;
|
|
4127
|
-
display_row: number;
|
|
4128
|
-
id: number;
|
|
4129
|
-
locked_by?: Array<number>;
|
|
4130
|
-
node_type: NodeType;
|
|
4131
|
-
ranks: Array<ClassTalentNodeRank>;
|
|
4132
|
-
raw_position_x: number;
|
|
4133
|
-
raw_position_y: number;
|
|
4134
|
-
unlocks?: Array<number>;
|
|
4135
|
-
}
|
|
4136
|
-
interface NodeType {
|
|
4137
|
-
id: number;
|
|
4138
|
-
type: 'ACTIVE' | 'CHOICE' | 'PASSIVE';
|
|
4139
|
-
}
|
|
4140
|
-
interface ClassTalentNodeRank {
|
|
4141
|
-
choice_of_tooltips?: Array<Tooltip>;
|
|
4142
|
-
default_points?: number;
|
|
4143
|
-
rank: number;
|
|
4144
|
-
tooltip?: Tooltip;
|
|
4145
|
-
}
|
|
4146
|
-
interface Tooltip {
|
|
4147
|
-
spell_tooltip: TooltipSpellTooltip;
|
|
4148
|
-
talent: NameIdKey;
|
|
4149
|
-
}
|
|
4150
|
-
interface TooltipSpellTooltip {
|
|
4151
|
-
cast_time: string;
|
|
4152
|
-
cooldown?: string;
|
|
4153
|
-
description: string;
|
|
4154
|
-
power_cost?: string;
|
|
4155
|
-
range?: string;
|
|
4156
|
-
spell: NameIdKey;
|
|
4157
|
-
}
|
|
4158
|
-
interface RestrictionLine {
|
|
4159
|
-
is_for_class: boolean;
|
|
4160
|
-
required_points: number;
|
|
4161
|
-
restricted_row: number;
|
|
4162
|
-
}
|
|
4163
|
-
interface SpecTalentNode {
|
|
4164
|
-
display_col: number;
|
|
4165
|
-
display_row: number;
|
|
4166
|
-
id: number;
|
|
4167
|
-
locked_by?: Array<number>;
|
|
4168
|
-
node_type: NodeType;
|
|
4169
|
-
ranks: Array<SpecTalentNodeRank>;
|
|
4170
|
-
raw_position_x: number;
|
|
4171
|
-
raw_position_y: number;
|
|
4172
|
-
unlocks?: Array<number>;
|
|
4173
|
-
}
|
|
4174
|
-
interface SpecTalentNodeRank {
|
|
4175
|
-
choice_of_tooltips?: Array<ChoiceOfTooltip>;
|
|
4176
|
-
rank: number;
|
|
4177
|
-
tooltip?: Tooltip;
|
|
4178
|
-
}
|
|
4179
|
-
interface ChoiceOfTooltip {
|
|
4180
|
-
spell_tooltip: PurpleSpellTooltip;
|
|
4181
|
-
talent: NameIdKey;
|
|
4182
|
-
}
|
|
4183
|
-
interface PurpleSpellTooltip {
|
|
4184
|
-
cast_time: string;
|
|
4185
|
-
description: string;
|
|
4186
|
-
spell: NameIdKey;
|
|
4187
|
-
}
|
|
4188
|
-
/**
|
|
4189
|
-
* The response for a talent tree nodes.
|
|
4190
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4191
|
-
*/
|
|
4192
|
-
interface TalentTreeNodesResponse extends ResponseBase {
|
|
4193
|
-
id: number;
|
|
4194
|
-
spec_talent_trees: Array<SpecTalentTree>;
|
|
4195
|
-
talent_nodes: Array<TalentNode>;
|
|
4196
|
-
}
|
|
4197
|
-
interface SpecTalentTree extends KeyBase {
|
|
4198
|
-
name: string;
|
|
4199
|
-
}
|
|
4200
|
-
interface TalentNode {
|
|
4201
|
-
display_col: number;
|
|
4202
|
-
display_row: number;
|
|
4203
|
-
id: number;
|
|
4204
|
-
node_type: NodeType;
|
|
4205
|
-
ranks: Array<Rank>;
|
|
4206
|
-
raw_position_x: number;
|
|
4207
|
-
raw_position_y: number;
|
|
4208
|
-
}
|
|
4209
|
-
interface Rank {
|
|
4210
|
-
choice_of_tooltips?: Array<Tooltip>;
|
|
4211
|
-
rank: number;
|
|
4212
|
-
tooltip?: Tooltip;
|
|
4213
|
-
}
|
|
4214
|
-
|
|
4215
|
-
/**
|
|
4216
|
-
* Get a PvP talent by ID.
|
|
4217
|
-
* @param pvpTalentId The PvP talent ID.
|
|
4218
|
-
* @returns The PvP talent. See {@link PvpTalentResponse}.
|
|
4219
|
-
*/
|
|
4220
|
-
declare function pvpTalent(pvpTalentId: number): Resource<PvpTalentResponse>;
|
|
4221
|
-
/**
|
|
4222
|
-
* Get a PvP talent index.
|
|
4223
|
-
* @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
|
|
4224
|
-
*/
|
|
4225
|
-
declare function pvpTalentIndex(): Resource<PvpTalentIndexResponse>;
|
|
4226
|
-
/**
|
|
4227
|
-
* Get a talent by ID.
|
|
4228
|
-
* @param talentId The talent ID.
|
|
4229
|
-
* @returns The talent. See {@link TalentResponse}.
|
|
4230
|
-
*/
|
|
4231
|
-
declare function talent(talentId: number): Resource<TalentResponse>;
|
|
4232
|
-
/**
|
|
4233
|
-
* Get a talent index.
|
|
4234
|
-
* @returns The talent index. See {@link TalentIndexResponse}.
|
|
4235
|
-
*/
|
|
4236
|
-
declare function talentIndex(): Resource<TalentIndexResponse>;
|
|
4237
|
-
/**
|
|
4238
|
-
* Get a talent tree by ID.
|
|
4239
|
-
* @param talentTreeId The talent tree ID.
|
|
4240
|
-
* @param specId The playable specialization ID.
|
|
4241
|
-
* @returns The talent tree. See {@link TalentTreeResponse}.
|
|
4242
|
-
*/
|
|
4243
|
-
declare function talentTree(talentTreeId: number, specId: number): Resource<TalentTreeResponse>;
|
|
4244
|
-
/**
|
|
4245
|
-
* Get a talent tree index.
|
|
4246
|
-
* @returns The talent tree index. See {@link TalentTreeIndexResponse}.
|
|
4247
|
-
*/
|
|
4248
|
-
declare function talentTreeIndex(): Resource<TalentTreeIndexResponse>;
|
|
4249
|
-
/**
|
|
4250
|
-
* Get talent tree nodes by talent tree ID.
|
|
4251
|
-
* @param talentTreeId The talent tree ID.
|
|
4252
|
-
* @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
|
|
4253
|
-
*/
|
|
4254
|
-
declare function talentTreeNodes(talentTreeId: number): Resource<TalentTreeNodesResponse>;
|
|
4255
|
-
|
|
4256
|
-
/**
|
|
4257
|
-
* The response for a tech talent index.
|
|
4258
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4259
|
-
*/
|
|
4260
|
-
interface TechTalentIndexResponse extends ResponseBase {
|
|
4261
|
-
talents: Array<NameIdKey>;
|
|
4262
|
-
}
|
|
4263
|
-
/**
|
|
4264
|
-
* The response for a tech talent.
|
|
4265
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4266
|
-
*/
|
|
4267
|
-
interface TechTalentResponse extends ResponseBase, NameId {
|
|
4268
|
-
display_order: number;
|
|
4269
|
-
media: Media$1;
|
|
4270
|
-
talent_tree: Media$1;
|
|
4271
|
-
tier: number;
|
|
4272
|
-
}
|
|
4273
|
-
interface Media$1 extends KeyBase {
|
|
4274
|
-
id: number;
|
|
4275
|
-
}
|
|
4276
|
-
/**
|
|
4277
|
-
* The response for a tech talent media.
|
|
4278
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4279
|
-
*/
|
|
4280
|
-
interface TechTalentMediaResponse extends ResponseBase {
|
|
4281
|
-
assets: Array<MediaAsset$1>;
|
|
4282
|
-
}
|
|
4283
|
-
/**
|
|
4284
|
-
* The response for a tech talent tree index.
|
|
4285
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4286
|
-
*/
|
|
4287
|
-
interface TechTalentTreeIndexResponse extends ResponseBase {
|
|
4288
|
-
talent_trees: Array<TalentTree>;
|
|
4289
|
-
}
|
|
4290
|
-
interface TalentTree extends KeyBase {
|
|
4291
|
-
id: number;
|
|
4292
|
-
name?: string;
|
|
4293
|
-
}
|
|
4294
|
-
/**
|
|
4295
|
-
* The response for a tech talent tree.
|
|
4296
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4297
|
-
*/
|
|
4298
|
-
interface TechTalentTreeResponse extends ResponseBase {
|
|
4299
|
-
id: number;
|
|
4300
|
-
max_tiers: number;
|
|
4301
|
-
playable_class: NameIdKey;
|
|
4302
|
-
talents: Array<NameIdKey>;
|
|
4303
|
-
}
|
|
4304
|
-
|
|
4305
|
-
/**
|
|
4306
|
-
* Get a tech talent by ID.
|
|
4307
|
-
* @param techTalentId The tech talent ID.
|
|
4308
|
-
* @returns The tech talent. See {@link TechTalentResponse}.
|
|
4309
|
-
*/
|
|
4310
|
-
declare function techTalent(techTalentId: number): Resource<TechTalentResponse>;
|
|
4311
|
-
/**
|
|
4312
|
-
* Get a tech talent index.
|
|
4313
|
-
* @returns The tech talent index. See {@link TechTalentIndexResponse}.
|
|
4314
|
-
*/
|
|
4315
|
-
declare function techTalentIndex(): Resource<TechTalentIndexResponse>;
|
|
4316
|
-
/**
|
|
4317
|
-
* Get tech talent media by ID.
|
|
4318
|
-
* @param techTalentId The tech talent ID.
|
|
4319
|
-
* @returns The tech talent media. See {@link TechTalentMediaResponse}.
|
|
4320
|
-
*/
|
|
4321
|
-
declare function techTalentMedia(techTalentId: number): Resource<TechTalentMediaResponse>;
|
|
4322
|
-
/**
|
|
4323
|
-
* Get a tech talent tree by ID.
|
|
4324
|
-
* @param techTalentTreeId The tech talent tree ID.
|
|
4325
|
-
* @returns The tech talent tree. See {@link TechTalentTreeResponse}.
|
|
4326
|
-
*/
|
|
4327
|
-
declare function techTalentTree(techTalentTreeId: number): Resource<TechTalentTreeResponse>;
|
|
4328
|
-
/**
|
|
4329
|
-
* Get a tech talent tree index.
|
|
4330
|
-
* @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
|
|
4331
|
-
*/
|
|
4332
|
-
declare function techTalentTreeIndex(): Resource<TechTalentTreeIndexResponse>;
|
|
4333
|
-
|
|
4334
|
-
/**
|
|
4335
|
-
* The response for a title index.
|
|
4336
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4337
|
-
*/
|
|
4338
|
-
interface TitleIndexResponse extends ResponseBase {
|
|
4339
|
-
titles: Array<NameIdKey>;
|
|
4340
|
-
}
|
|
4341
|
-
/**
|
|
4342
|
-
* The response for a title.
|
|
4343
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4344
|
-
*/
|
|
4345
|
-
interface TitleResponse extends ResponseBase, NameId {
|
|
4346
|
-
gender_name: GenderName;
|
|
4347
|
-
}
|
|
4348
|
-
|
|
4349
|
-
/**
|
|
4350
|
-
* Get a title by ID.
|
|
4351
|
-
* @param titleId The title ID.
|
|
4352
|
-
* @returns The title. See {@link TitleResponse}.
|
|
4353
|
-
*/
|
|
4354
|
-
declare function title(titleId: number): Resource<TitleResponse>;
|
|
4355
|
-
/**
|
|
4356
|
-
* Get a title index.
|
|
4357
|
-
* @returns The title index. See {@link TitleIndexResponse}.
|
|
4358
|
-
*/
|
|
4359
|
-
declare function titleIndex(): Resource<TitleIndexResponse>;
|
|
4360
|
-
|
|
4361
|
-
/**
|
|
4362
|
-
* The response for a toy index.
|
|
4363
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4364
|
-
*/
|
|
4365
|
-
interface ToyIndexResponse extends ResponseBase {
|
|
4366
|
-
toys: Array<NameIdKey>;
|
|
4367
|
-
}
|
|
4368
|
-
/**
|
|
4369
|
-
* The response for a toy.
|
|
4370
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4371
|
-
*/
|
|
4372
|
-
interface ToyResponse extends ResponseBase {
|
|
4373
|
-
id: number;
|
|
4374
|
-
item: NameIdKey;
|
|
4375
|
-
media: Media;
|
|
4376
|
-
source: Source;
|
|
4377
|
-
source_description: string;
|
|
4378
|
-
}
|
|
4379
|
-
interface Media extends KeyBase {
|
|
4380
|
-
id: number;
|
|
4381
|
-
}
|
|
4382
|
-
interface Source {
|
|
4383
|
-
name: string;
|
|
4384
|
-
type: string;
|
|
4385
|
-
}
|
|
4386
|
-
|
|
4387
|
-
/**
|
|
4388
|
-
* Get a toy by ID.
|
|
4389
|
-
* @param toyId The toy ID.
|
|
4390
|
-
* @returns The toy. See {@link ToyResponse}.
|
|
4391
|
-
*/
|
|
4392
|
-
declare function toy(toyId: number): Resource<ToyResponse>;
|
|
4393
|
-
/**
|
|
4394
|
-
* Get a toy index.
|
|
4395
|
-
* @returns The toy index. See {@link ToyIndexResponse}.
|
|
4396
|
-
*/
|
|
4397
|
-
declare function toyIndex(): Resource<ToyIndexResponse>;
|
|
4398
|
-
|
|
4399
|
-
/**
|
|
4400
|
-
* The response for a WoW token.
|
|
4401
|
-
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
4402
|
-
*/
|
|
4403
|
-
interface WowTokenResponse extends ResponseBase {
|
|
4404
|
-
last_updated_timestamp: number;
|
|
4405
|
-
price: number;
|
|
4406
|
-
}
|
|
4407
|
-
|
|
4408
|
-
/**
|
|
4409
|
-
* Get the current WoW token price.
|
|
4410
|
-
* @returns The WoW token price. See {@link WowTokenResponse}.
|
|
4411
|
-
*/
|
|
4412
|
-
declare function wowToken(): Resource<WowTokenResponse>;
|
|
4413
|
-
|
|
4414
|
-
/**
|
|
4415
|
-
* The Blizzard API for World of Warcraft.
|
|
4416
|
-
* @see https://develop.battle.net/documentation/world-of-warcraft
|
|
4417
|
-
*/
|
|
4418
|
-
declare const wow: {
|
|
4419
|
-
accountCollectionsIndex: typeof accountCollectionsIndex;
|
|
4420
|
-
accountHeirloomsCollectionSummary: typeof accountHeirloomsCollectionSummary;
|
|
4421
|
-
accountMountsCollectionSummary: typeof accountMountsCollectionSummary;
|
|
4422
|
-
accountPetsCollectionSummary: typeof accountPetsCollectionSummary;
|
|
4423
|
-
accountProfileSummary: typeof accountProfileSummary;
|
|
4424
|
-
accountToysCollectionSummary: typeof accountToysCollectionSummary;
|
|
4425
|
-
accountTransmogsCollectionSummary: typeof accountTransmogsCollectionSummary;
|
|
4426
|
-
protectedCharacterProfileSummary: typeof protectedCharacterProfileSummary;
|
|
4427
|
-
achievement: typeof achievement;
|
|
4428
|
-
achievementCategory: typeof achievementCategory;
|
|
4429
|
-
achievementCategoryIndex: typeof achievementCategoryIndex;
|
|
4430
|
-
achievementIndex: typeof achievementIndex;
|
|
4431
|
-
achievementMedia: typeof achievementMedia;
|
|
4432
|
-
auctions: typeof auctions;
|
|
4433
|
-
commodities: typeof commodities;
|
|
4434
|
-
azeriteEssence: typeof azeriteEssence;
|
|
4435
|
-
azeriteEssenceIndex: typeof azeriteEssenceIndex;
|
|
4436
|
-
azeriteEssenceMedia: typeof azeriteEssenceMedia;
|
|
4437
|
-
azeriteEssenceSearch: typeof azeriteEssenceSearch;
|
|
4438
|
-
characterAchievementsSummary: typeof characterAchievementsSummary;
|
|
4439
|
-
characterAchievementStatistics: typeof characterAchievementStatistics;
|
|
4440
|
-
characterAppearanceSummary: typeof characterAppearanceSummary;
|
|
4441
|
-
characterCollectionsIndex: typeof characterCollectionsIndex;
|
|
4442
|
-
characterHeirloomsCollectionSummary: typeof characterHeirloomsCollectionSummary;
|
|
4443
|
-
characterMountsCollectionSummary: typeof characterMountsCollectionSummary;
|
|
4444
|
-
characterPetsCollectionSummary: typeof characterPetsCollectionSummary;
|
|
4445
|
-
characterToysCollectionSummary: typeof characterToysCollectionSummary;
|
|
4446
|
-
characterTransmogCollectionSummary: typeof characterTransmogCollectionSummary;
|
|
4447
|
-
characterDungeons: typeof characterDungeons;
|
|
4448
|
-
characterEncountersSummary: typeof characterEncountersSummary;
|
|
4449
|
-
characterRaids: typeof characterRaids;
|
|
4450
|
-
characterEquipmentSummary: typeof characterEquipmentSummary;
|
|
4451
|
-
characterHunterPetsSummary: typeof characterHunterPetsSummary;
|
|
4452
|
-
characterMediaSummary: typeof characterMediaSummary;
|
|
4453
|
-
characterMythicKeystoneProfileIndex: typeof characterMythicKeystoneProfileIndex;
|
|
4454
|
-
characterMythicKeystoneSeasonDetails: typeof characterMythicKeystoneSeasonDetails;
|
|
4455
|
-
characterProfessionsSummary: typeof characterProfessionsSummary;
|
|
4456
|
-
characterProfileStatus: typeof characterProfileStatus;
|
|
4457
|
-
characterProfileSummary: typeof characterProfileSummary;
|
|
4458
|
-
characterPvpSummary: typeof characterPvpSummary;
|
|
4459
|
-
characterCompletedQuests: typeof characterCompletedQuests;
|
|
4460
|
-
characterQuests: typeof characterQuests;
|
|
4461
|
-
characterReputationsSummary: typeof characterReputationsSummary;
|
|
4462
|
-
characterSoulbinds: typeof characterSoulbinds;
|
|
4463
|
-
characterSpecializationsSummary: typeof characterSpecializationsSummary;
|
|
4464
|
-
characterStatisticsSummary: typeof characterStatisticsSummary;
|
|
4465
|
-
characterTitlesSummary: typeof characterTitlesSummary;
|
|
4466
|
-
connectedRealm: typeof connectedRealm;
|
|
4467
|
-
connectedRealmIndex: typeof connectedRealmIndex;
|
|
4468
|
-
connectedRealmSearch: typeof connectedRealmSearch;
|
|
4469
|
-
conduit: typeof conduit;
|
|
4470
|
-
conduitIndex: typeof conduitIndex;
|
|
4471
|
-
covenant: typeof covenant;
|
|
4472
|
-
covenantIndex: typeof covenantIndex;
|
|
4473
|
-
covenantMedia: typeof covenantMedia;
|
|
4474
|
-
soulbind: typeof soulbind;
|
|
4475
|
-
soulbindIndex: typeof soulbindIndex;
|
|
4476
|
-
creature: typeof creature;
|
|
4477
|
-
creatureDisplayMedia: typeof creatureDisplayMedia;
|
|
4478
|
-
creatureFamily: typeof creatureFamily;
|
|
4479
|
-
creatureFamilyIndex: typeof creatureFamilyIndex;
|
|
4480
|
-
creatureFamilyMedia: typeof creatureFamilyMedia;
|
|
4481
|
-
creatureSearch: typeof creatureSearch;
|
|
4482
|
-
creatureType: typeof creatureType;
|
|
4483
|
-
creatureTypeIndex: typeof creatureTypeIndex;
|
|
4484
|
-
guild: typeof guild;
|
|
4485
|
-
guildAchievements: typeof guildAchievements;
|
|
4486
|
-
guildActivity: typeof guildActivity;
|
|
4487
|
-
guildRoster: typeof guildRoster;
|
|
4488
|
-
guildCrestBorder: typeof guildCrestBorder;
|
|
4489
|
-
guildCrestComponentsIndex: typeof guildCrestComponentsIndex;
|
|
4490
|
-
guildCrestEmblem: typeof guildCrestEmblem;
|
|
4491
|
-
heirloom: typeof heirloom;
|
|
4492
|
-
heirloomIndex: typeof heirloomIndex;
|
|
4493
|
-
item: typeof item;
|
|
4494
|
-
itemClass: typeof itemClass;
|
|
4495
|
-
itemClassIndex: typeof itemClassIndex;
|
|
4496
|
-
itemMedia: typeof itemMedia;
|
|
4497
|
-
itemSearch: typeof itemSearch;
|
|
4498
|
-
itemSet: typeof itemSet;
|
|
4499
|
-
itemSetIndex: typeof itemSetIndex;
|
|
4500
|
-
itemSubClass: typeof itemSubClass;
|
|
4501
|
-
journalEncounter: typeof journalEncounter;
|
|
4502
|
-
journalEncounterIndex: typeof journalEncounterIndex;
|
|
4503
|
-
journalEncounterSearch: typeof journalEncounterSearch;
|
|
4504
|
-
journalExpansion: typeof journalExpansion;
|
|
4505
|
-
journalExpansionIndex: typeof journalExpansionIndex;
|
|
4506
|
-
journalInstance: typeof journalInstance;
|
|
4507
|
-
journalInstanceIndex: typeof journalInstanceIndex;
|
|
4508
|
-
journalInstanceMedia: typeof journalInstanceMedia;
|
|
4509
|
-
mediaSearch: typeof mediaSearch;
|
|
4510
|
-
modifiedCraftingCategory: typeof modifiedCraftingCategory;
|
|
4511
|
-
modifiedCraftingCategoryIndex: typeof modifiedCraftingCategoryIndex;
|
|
4512
|
-
modifiedCraftingIndex: typeof modifiedCraftingIndex;
|
|
4513
|
-
modifiedCraftingReagentSlotType: typeof modifiedCraftingReagentSlotType;
|
|
4514
|
-
modifiedCraftingReagentSlotTypeIndex: typeof modifiedCraftingReagentSlotTypeIndex;
|
|
4515
|
-
mount: typeof mount;
|
|
4516
|
-
mountIndex: typeof mountIndex;
|
|
4517
|
-
mountSearch: typeof mountSearch;
|
|
4518
|
-
mythicKeystoneAffix: typeof mythicKeystoneAffix;
|
|
4519
|
-
mythicKeystoneAffixIndex: typeof mythicKeystoneAffixIndex;
|
|
4520
|
-
mythicKeystoneAffixMedia: typeof mythicKeystoneAffixMedia;
|
|
4521
|
-
mythicKeystoneDungeon: typeof mythicKeystoneDungeon;
|
|
4522
|
-
mythicKeystoneDungeonIndex: typeof mythicKeystoneDungeonIndex;
|
|
4523
|
-
mythicKeystoneIndex: typeof mythicKeystoneIndex;
|
|
4524
|
-
mythicKeystonePeriod: typeof mythicKeystonePeriod;
|
|
4525
|
-
mythicKeystonePeriodIndex: typeof mythicKeystonePeriodIndex;
|
|
4526
|
-
mythicKeystoneSeason: typeof mythicKeystoneSeason;
|
|
4527
|
-
mythicKeystoneSeasonIndex: typeof mythicKeystoneSeasonIndex;
|
|
4528
|
-
mythicKeystoneLeaderboard: typeof mythicKeystoneLeaderboard;
|
|
4529
|
-
mythicKeystoneLeaderboardIndex: typeof mythicKeystoneLeaderboardIndex;
|
|
4530
|
-
mythicRaidLeaderboard: typeof mythicRaidLeaderboard;
|
|
4531
|
-
pet: typeof pet;
|
|
4532
|
-
petAbility: typeof petAbility;
|
|
4533
|
-
petAbilityIndex: typeof petAbilityIndex;
|
|
4534
|
-
petAbilityMedia: typeof petAbilityMedia;
|
|
4535
|
-
petIndex: typeof petIndex;
|
|
4536
|
-
petMedia: typeof petMedia;
|
|
4537
|
-
playableClass: typeof playableClass;
|
|
4538
|
-
playableClassIndex: typeof playableClassIndex;
|
|
4539
|
-
playableClassMedia: typeof playableClassMedia;
|
|
4540
|
-
pvpTalentSlots: typeof pvpTalentSlots;
|
|
4541
|
-
playableRace: typeof playableRace;
|
|
4542
|
-
playableRaceIndex: typeof playableRaceIndex;
|
|
4543
|
-
playableSpecialization: typeof playableSpecialization;
|
|
4544
|
-
playableSpecializationIndex: typeof playableSpecializationIndex;
|
|
4545
|
-
playableSpecializationMedia: typeof playableSpecializationMedia;
|
|
4546
|
-
powerType: typeof powerType;
|
|
4547
|
-
powerTypeIndex: typeof powerTypeIndex;
|
|
4548
|
-
profession: typeof profession;
|
|
4549
|
-
professionIndex: typeof professionIndex;
|
|
4550
|
-
professionMedia: typeof professionMedia;
|
|
4551
|
-
professionSkillTier: typeof professionSkillTier;
|
|
4552
|
-
recipe: typeof recipe;
|
|
4553
|
-
recipeMedia: typeof recipeMedia;
|
|
4554
|
-
pvpLeaderboard: typeof pvpLeaderboard;
|
|
4555
|
-
pvpLeaderboardIndex: typeof pvpLeaderboardIndex;
|
|
4556
|
-
pvpRewardsIndex: typeof pvpRewardsIndex;
|
|
4557
|
-
pvpSeason: typeof pvpSeason;
|
|
4558
|
-
pvpSeasonIndex: typeof pvpSeasonIndex;
|
|
4559
|
-
pvpTier: typeof pvpTier;
|
|
4560
|
-
pvpTierIndex: typeof pvpTierIndex;
|
|
4561
|
-
pvpTierMedia: typeof pvpTierMedia;
|
|
4562
|
-
quest: typeof quest;
|
|
4563
|
-
questArea: typeof questArea;
|
|
4564
|
-
questAreaIndex: typeof questAreaIndex;
|
|
4565
|
-
questCategory: typeof questCategory;
|
|
4566
|
-
questCategoryIndex: typeof questCategoryIndex;
|
|
4567
|
-
questIndex: typeof questIndex;
|
|
4568
|
-
questType: typeof questType;
|
|
4569
|
-
questTypeIndex: typeof questTypeIndex;
|
|
4570
|
-
realm: typeof realm;
|
|
4571
|
-
realmIndex: typeof realmIndex;
|
|
4572
|
-
realmSearch: typeof realmSearch;
|
|
4573
|
-
region: typeof region;
|
|
4574
|
-
regionIndex: typeof regionIndex;
|
|
4575
|
-
reputationFaction: typeof reputationFaction;
|
|
4576
|
-
reputationFactionIndex: typeof reputationFactionIndex;
|
|
4577
|
-
reputationTiers: typeof reputationTiers;
|
|
4578
|
-
reputationTiersIndex: typeof reputationTiersIndex;
|
|
4579
|
-
spell: typeof spell;
|
|
4580
|
-
spellMedia: typeof spellMedia;
|
|
4581
|
-
spellSearch: typeof spellSearch;
|
|
4582
|
-
pvpTalent: typeof pvpTalent;
|
|
4583
|
-
pvpTalentIndex: typeof pvpTalentIndex;
|
|
4584
|
-
talentIndex: typeof talentIndex;
|
|
4585
|
-
talentTree: typeof talentTree;
|
|
4586
|
-
talentTreeIndex: typeof talentTreeIndex;
|
|
4587
|
-
talentTreeNodes: typeof talentTreeNodes;
|
|
4588
|
-
techTalent: typeof techTalent;
|
|
4589
|
-
techTalentIndex: typeof techTalentIndex;
|
|
4590
|
-
techTalentMedia: typeof techTalentMedia;
|
|
4591
|
-
techTalentTree: typeof techTalentTree;
|
|
4592
|
-
techTalentTreeIndex: typeof techTalentTreeIndex;
|
|
4593
|
-
title: typeof title;
|
|
4594
|
-
titleIndex: typeof titleIndex;
|
|
4595
|
-
toy: typeof toy;
|
|
4596
|
-
toyIndex: typeof toyIndex;
|
|
4597
|
-
wowToken: typeof wowToken;
|
|
4598
|
-
};
|
|
4599
|
-
|
|
4600
|
-
export { type AccountCollectionsIndexResponse, type AccountHeirloomsCollectionSummaryResponse, type AccountMountsCollectionSummaryResponse, type AccountPetsCollectionSummaryResponse, type AccountProfileSummaryResponse, type AccountToysCollectionSummaryResponse, type AccountTransmogsCollectionSummaryResponse, type AchievementCategoryIndexResponse, type AchievementCategoryResponse, type AchievementIndexResponse, type AchievementMediaResponse, type AchievementResponse, type AuctionHouseCommoditiesResponse, type AuctionHouseResponse, type AzeriteEssenceIndexResponse, type AzeriteEssenceMediaResponse, type AzeriteEssenceResponse, type AzeriteEssenceSearchParameters, type AzeriteEssenceSearchResponseItem, type CharacterAchievementStatisticsResponse, type CharacterAchievementsSummaryResponse, type CharacterAppearanceResponse, type CharacterCollectionsIndexResponse, type CharacterCompletedQuestsResponse, type CharacterDungeonsResponse, type CharacterEncountersSummaryResponse, type CharacterEquipmentSummaryResponse, type CharacterHeirloomsCollectionSummaryResponse, type CharacterHunterPetsSummaryResponse, type CharacterMediaSummaryResponse, type CharacterMountsCollectionSummaryResponse, type CharacterMythicKeystoneProfileIndexResponse, type CharacterMythicKeystoneSeasonDetailsResponse, type CharacterPetsCollectionSummaryResponse, type CharacterProfessionsSummaryResponse, type CharacterProfileStatusResponse, type CharacterProfileSummaryResponse, type CharacterPvpSummaryResponse, type CharacterQuestsResponse, type CharacterRaidsResponse, type CharacterReputationsSummaryResponse, type CharacterSoulbindsResponse, type CharacterSpecializationsSummaryResponse, type CharacterStatisticsSummaryResponse, type CharacterTitlesSummaryResponse, type CharacterToysCollectionSummaryResponse, type CharacterTransmogCollectionSummaryResponse, type ConduitIndexResponse, type ConduitResponse, type ConnectedRealmIndexResponse, type ConnectedRealmResponse, type ConnectedRealmSearchParameters, type ConnectedRealmSearchResponseItem, type CovenantIndexResponse, type CovenantMediaResponse, type CovenantResponse, type CreatureDisplayMediaResponse, type CreatureFamilyIndexResponse, type CreatureFamilyMediaResponse, type CreatureFamilyResponse, type CreatureResponse, type CreatureSearchParameters, type CreatureSearchResponseItem, type CreatureTypeIndexResponse, type CreatureTypeResponse, type GuildAchievementsResponse, type GuildActivityResponse, type GuildCrestBorderEmblemResponse, type GuildCrestComponentsIndexResponse, type GuildResponse, type GuildRosterResponse, type HeirloomIndexResponse, type HeirloomResponse, type ItemClassIndexResponse, type ItemClassResponse, type ItemMediaResponse, type ItemResponse, type ItemSearchParameters, type ItemSearchResponseItem, type ItemSetIndexResponse, type ItemSetResponse, type ItemSubClassResponse, type JournalEncounterIndexResponse, type JournalEncounterResponse, type JournalEncounterSearchParameters, type JournalEncounterSearchResponseItem, type JournalExpansionIndexResponse, type JournalExpansionResponse, type JournalInstanceIndexResponse, type JournalInstanceMediaResponse, type JournalInstanceResponse, type MediaSearchParameters, type MediaSearchResponseItem, type ModifiedCraftingCategoryIndexResponse, type ModifiedCraftingCategoryResponse, type ModifiedCraftingIndexResponse, type ModifiedCraftingReagentSlotTypeIndexResponse, type ModifiedCraftingReagentSlotTypeResponse, type MountIndexResponse, type MountResponse, type MountSearchParameters, type MountSearchResponseItem, type MythicKeystoneAffixIndexResponse, type MythicKeystoneAffixMediaResponse, type MythicKeystoneAffixResponse, type MythicKeystoneDungeonIndexResponse, type MythicKeystoneDungeonResponse, type MythicKeystoneIndexResponse, type MythicKeystoneLeaderboardIndexResponse, type MythicKeystoneLeaderboardResponse, type MythicKeystonePeriodIndexResponse, type MythicKeystonePeriodResponse, type MythicKeystoneSeasonIndexResponse, type MythicKeystoneSeasonResponse, type MythicRaidLeaderboardResponse, type PetAbilityIndexResponse, type PetAbilityMediaResponse, type PetAbilityResponse, type PetIndexResponse, type PetMediaResponse, type PetResponse, type PlayableClassIndexResponse, type PlayableClassMediaResponse, type PlayableClassResponse, type PlayableRaceIndexResponse, type PlayableRaceResponse, type PlayableSpecializationIndexResponse, type PlayableSpecializationMediaResponse, type PlayableSpecializationResponse, type PowerTypeIndexResponse, type PowerTypeResponse, type ProfessionIndexResponse, type ProfessionMediaResponse, type ProfessionResponse, type ProfessionSkillTierResponse, type ProtectedCharacterProfileSummaryResponse, type PvpLeaderboardIndexResponse, type PvpLeaderboardResponse, type PvpRewardsIndexResponse, type PvpSeasonIndexResponse, type PvpSeasonResponse, type PvpTalentIndexResponse, type PvpTalentResponse, type PvpTalentSlotsResponse, type PvpTierIndexResponse, type PvpTierMediaResponse, type PvpTierResponse, type QuestAreaIndexResponse, type QuestAreaResponse, type QuestCategoryIndexResponse, type QuestCategoryResponse, type QuestIndexResponse, type QuestResponse, type QuestTypeIndexResponse, type QuestTypeResponse, type RealmCategory, type RealmIndexResponse, type RealmResponse, type RealmSearchParameters, type RealmSearchResponseItem, type RealmTimezone, type RealmType, type RealmTypeCapitalized, type RecipeMediaResponse, type RecipeResponse, type RegionIndexResponse, type RegionResponse, type ReputationFactionIndexResponse, type ReputationFactionResponse, type ReputationTiersIndexResponse, type ReputationTiersResponse, type SoulbindIndexResponse, type SoulbindResponse, type SpellMediaResponse, type SpellResponse, type SpellSearchParameters, type SpellSearchResponseItem, type TalentIndexResponse, type TalentResponse, type TalentTreeIndexResponse, type TalentTreeNodesResponse, type TalentTreeResponse, type TechTalentIndexResponse, type TechTalentMediaResponse, type TechTalentResponse, type TechTalentTreeIndexResponse, type TechTalentTreeResponse, type TitleIndexResponse, type TitleResponse, type ToyIndexResponse, type ToyResponse, type WithoutUnderscore, type WowTokenResponse, accountCollectionsIndex, accountHeirloomsCollectionSummary, accountMountsCollectionSummary, accountPetsCollectionSummary, accountProfileSummary, accountToysCollectionSummary, accountTransmogsCollectionSummary, achievement, achievementCategory, achievementCategoryIndex, achievementIndex, achievementMedia, auctions, azeriteEssence, azeriteEssenceIndex, azeriteEssenceMedia, azeriteEssenceSearch, characterAchievementStatistics, characterAchievementsSummary, characterAppearanceSummary, characterCollectionsIndex, characterCompletedQuests, characterDungeons, characterEncountersSummary, characterEquipmentSummary, characterHeirloomsCollectionSummary, characterHunterPetsSummary, characterMediaSummary, characterMountsCollectionSummary, characterMythicKeystoneProfileIndex, characterMythicKeystoneSeasonDetails, characterPetsCollectionSummary, characterProfessionsSummary, characterProfileStatus, characterProfileSummary, characterPvpSummary, characterQuests, characterRaids, characterReputationsSummary, characterSoulbinds, characterSpecializationsSummary, characterStatisticsSummary, characterTitlesSummary, characterToysCollectionSummary, characterTransmogCollectionSummary, commodities, conduit, conduitIndex, connectedRealm, connectedRealmIndex, connectedRealmSearch, covenant, covenantIndex, covenantMedia, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, wow as default, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, heirloom, heirloomIndex, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass, journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia, mediaSearch, modifiedCraftingCategory, modifiedCraftingCategoryIndex, modifiedCraftingIndex, modifiedCraftingReagentSlotType, modifiedCraftingReagentSlotTypeIndex, mount, mountIndex, mountSearch, mythicKeystoneAffix, mythicKeystoneAffixIndex, mythicKeystoneAffixMedia, mythicKeystoneDungeon, mythicKeystoneDungeonIndex, mythicKeystoneIndex, mythicKeystoneLeaderboard, mythicKeystoneLeaderboardIndex, mythicKeystonePeriod, mythicKeystonePeriodIndex, mythicKeystoneSeason, mythicKeystoneSeasonIndex, mythicRaidLeaderboard, pet, petAbility, petAbilityIndex, petAbilityMedia, petIndex, petMedia, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, playableSpecialization, playableSpecializationIndex, playableSpecializationMedia, powerType, powerTypeIndex, profession, professionIndex, professionMedia, professionSkillTier, protectedCharacterProfileSummary, pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, pvpTalent, pvpTalentIndex, pvpTalentSlots, pvpTier, pvpTierIndex, pvpTierMedia, quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex, realm, realmIndex, realmSearch, recipe, recipeMedia, region, regionIndex, reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex, soulbind, soulbindIndex, spell, spellMedia, spellSearch, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes, techTalent, techTalentIndex, techTalentMedia, techTalentTree, techTalentTreeIndex, title, titleIndex, toy, toyIndex, wow, wowToken };
|