@blizzard-api/wow 2.0.4 → 2.0.5

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 CHANGED
@@ -1,1489 +1,2597 @@
1
- // src/account-profile/account-profile.ts
2
- var accountProfileBase = "/profile/user/wow";
1
+ //#region src/account-profile/account-profile.ts
2
+ const accountProfileBase = "/profile/user/wow";
3
+ /**
4
+
5
+ * 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}
6
+
7
+ * @param token The OAuth 2.0 access token to use for authentication.
8
+
9
+ * @returns an index of collection types for an account.
10
+
11
+ */
3
12
  function accountCollectionsIndex(token) {
4
- return {
5
- namespace: "profile",
6
- path: `${accountProfileBase}/collections`,
7
- token
8
- };
13
+ return {
14
+ namespace: "profile",
15
+ path: `${accountProfileBase}/collections`,
16
+ token
17
+ };
9
18
  }
19
+ /**
20
+
21
+ * 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}
22
+
23
+ * @param token The OAuth 2.0 access token to use for authentication.
24
+
25
+ * @returns a summary of the heirlooms an account has obtained.
26
+
27
+ */
10
28
  function accountHeirloomsCollectionSummary(token) {
11
- return {
12
- namespace: "profile",
13
- path: `${accountProfileBase}/collections/heirlooms`,
14
- token
15
- };
29
+ return {
30
+ namespace: "profile",
31
+ path: `${accountProfileBase}/collections/heirlooms`,
32
+ token
33
+ };
16
34
  }
35
+ /**
36
+
37
+ * 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}
38
+
39
+ * @param token The OAuth 2.0 access token to use for authentication.
40
+
41
+ * @returns a summary of the mounts an account has obtained.
42
+
43
+ */
17
44
  function accountMountsCollectionSummary(token) {
18
- return {
19
- namespace: "profile",
20
- path: `${accountProfileBase}/collections/mounts`,
21
- token
22
- };
45
+ return {
46
+ namespace: "profile",
47
+ path: `${accountProfileBase}/collections/mounts`,
48
+ token
49
+ };
23
50
  }
51
+ /**
52
+
53
+ * 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}
54
+
55
+ * @param token The OAuth 2.0 access token to use for authentication.
56
+
57
+ * @returns a summary of the battle pets an account has obtained.
58
+
59
+ */
24
60
  function accountPetsCollectionSummary(token) {
25
- return {
26
- namespace: "profile",
27
- path: `${accountProfileBase}/collections/pets`,
28
- token
29
- };
61
+ return {
62
+ namespace: "profile",
63
+ path: `${accountProfileBase}/collections/pets`,
64
+ token
65
+ };
30
66
  }
67
+ /**
68
+
69
+ * 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}
70
+
71
+ * @param token The OAuth 2.0 access token to use for authentication.
72
+
73
+ * @returns a profile summary for an account.
74
+
75
+ */
31
76
  function accountProfileSummary(token) {
32
- return {
33
- namespace: "profile",
34
- path: `${accountProfileBase}`,
35
- token
36
- };
77
+ return {
78
+ namespace: "profile",
79
+ path: `${accountProfileBase}`,
80
+ token
81
+ };
37
82
  }
83
+ /**
84
+
85
+ * 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}
86
+
87
+ * @param token The OAuth 2.0 access token to use for authentication.
88
+
89
+ * @returns a summary of the toys an account has obtained.
90
+
91
+ */
38
92
  function accountToysCollectionSummary(token) {
39
- return {
40
- namespace: "profile",
41
- path: `${accountProfileBase}/collections/toys`,
42
- token
43
- };
93
+ return {
94
+ namespace: "profile",
95
+ path: `${accountProfileBase}/collections/toys`,
96
+ token
97
+ };
44
98
  }
99
+ /**
100
+
101
+ * 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}
102
+
103
+ * @param token The OAuth 2.0 access token to use for authentication.
104
+
105
+ * @returns a summary of the transmog unlocks an account has obtained.
106
+
107
+ */
45
108
  function accountTransmogsCollectionSummary(token) {
46
- return {
47
- namespace: "profile",
48
- path: `${accountProfileBase}/collections/transmogs`,
49
- token
50
- };
109
+ return {
110
+ namespace: "profile",
111
+ path: `${accountProfileBase}/collections/transmogs`,
112
+ token
113
+ };
51
114
  }
115
+ /**
116
+
117
+ * 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}
118
+
119
+ * @param realmId The realm ID.
120
+
121
+ * @param characterId The character ID.
122
+
123
+ * @param token The OAuth 2.0 access token to use for authentication.
124
+
125
+ * @returns a protected profile summary for a character.
126
+
127
+ */
52
128
  function protectedCharacterProfileSummary(realmId, characterId, token) {
53
- return {
54
- namespace: "profile",
55
- path: `${accountProfileBase}/protected-character/${realmId}-${characterId}`,
56
- token
57
- };
129
+ return {
130
+ namespace: "profile",
131
+ path: `${accountProfileBase}/protected-character/${realmId}-${characterId}`,
132
+ token
133
+ };
58
134
  }
59
135
 
60
- // src/base.ts
61
- var base = "/data/wow";
62
- var mediaBase = `${base}/media`;
63
- var searchBase = `${base}/search`;
136
+ //#endregion
137
+ //#region src/base.ts
138
+ /**
139
+
140
+ * @file base.ts
141
+
142
+ * @module base
143
+
144
+ * @description Contains base constants and interfaces for the Blizzard API.
145
+
146
+ */
147
+ /**
148
+
149
+ * The base request path for the Blizzard API for world of warcraft.
150
+
151
+ */
152
+ const base = "/data/wow";
153
+ /**
154
+
155
+ * The base request path for media in the Blizzard API for world of warcraft.
64
156
 
65
- // src/achievements/achievements.ts
66
- var achievementBase = `${base}/achievement`;
67
- var achievementCategoryBase = `${base}/achievement-category`;
157
+ */
158
+ const mediaBase = `${base}/media`;
159
+ /**
160
+
161
+ * The base request path for search in the Blizzard API for world of warcraft.
162
+
163
+ */
164
+ const searchBase = `${base}/search`;
165
+
166
+ //#endregion
167
+ //#region src/achievements/achievements.ts
168
+ const achievementBase = `${base}/achievement`;
169
+ const achievementCategoryBase = `${base}/achievement-category`;
170
+ /**
171
+
172
+ * Get an achievement by ID.
173
+
174
+ * @param achievementId The achievement ID.
175
+
176
+ * @returns The achievement. See {@link AchievementResponse}.
177
+
178
+ */
68
179
  function achievement(achievementId) {
69
- return {
70
- namespace: "static",
71
- path: `${achievementBase}/${achievementId}`
72
- };
180
+ return {
181
+ namespace: "static",
182
+ path: `${achievementBase}/${achievementId}`
183
+ };
73
184
  }
185
+ /**
186
+
187
+ * Get an achievement category by ID.
188
+
189
+ * @param achievementCategoryId The achievement category ID.
190
+
191
+ * @returns The achievement category. See {@link AchievementCategoryResponse}.
192
+
193
+ */
74
194
  function achievementCategory(achievementCategoryId) {
75
- return {
76
- namespace: "static",
77
- path: `${achievementCategoryBase}/${achievementCategoryId}`
78
- };
195
+ return {
196
+ namespace: "static",
197
+ path: `${achievementCategoryBase}/${achievementCategoryId}`
198
+ };
79
199
  }
200
+ /**
201
+
202
+ * Get an achievement category index.
203
+
204
+ * @returns The achievement category index. See {@link AchievementCategoryIndexResponse}.
205
+
206
+ */
80
207
  function achievementCategoryIndex() {
81
- return {
82
- namespace: "static",
83
- path: `${achievementCategoryBase}/index`
84
- };
208
+ return {
209
+ namespace: "static",
210
+ path: `${achievementCategoryBase}/index`
211
+ };
85
212
  }
213
+ /**
214
+
215
+ * Get an achievement index.
216
+
217
+ * @returns The achievement index. See {@link AchievementIndexResponse}.
218
+
219
+ */
86
220
  function achievementIndex() {
87
- return {
88
- namespace: "static",
89
- path: `${achievementBase}/index`
90
- };
221
+ return {
222
+ namespace: "static",
223
+ path: `${achievementBase}/index`
224
+ };
91
225
  }
226
+ /**
227
+
228
+ * Get achievement media by ID.
229
+
230
+ * @param achievementId The achievement ID.
231
+
232
+ * @returns The achievement media. See {@link AchievementMediaResponse}.
233
+
234
+ */
92
235
  function achievementMedia(achievementId) {
93
- return { namespace: "static", path: `${mediaBase}/achievement/${achievementId}` };
236
+ return {
237
+ namespace: "static",
238
+ path: `${mediaBase}/achievement/${achievementId}`
239
+ };
94
240
  }
95
241
 
96
- // src/auction-house/auction-house.ts
242
+ //#endregion
243
+ //#region src/auction-house/auction-house.ts
244
+ /**
245
+ * Get auction house data for a connected realm.
246
+ * @param connectedRealmId The ID of the connected realm.
247
+ * @returns The auction house data. See {@link AuctionHouseResponse}.
248
+ */
97
249
  function auctions(connectedRealmId) {
98
- return {
99
- namespace: "dynamic",
100
- path: `${base}/connected-realm/${connectedRealmId}/auctions`
101
- };
102
- }
250
+ return {
251
+ namespace: "dynamic",
252
+ path: `${base}/connected-realm/${connectedRealmId}/auctions`
253
+ };
254
+ }
255
+ /**
256
+ * Get auction house data for all connected realms.
257
+ * @returns The auction house data. See {@link AuctionHouseResponse}.
258
+ */
103
259
  function commodities() {
104
- return {
105
- namespace: "dynamic",
106
- path: `${base}/auctions/commodities`
107
- };
260
+ return {
261
+ namespace: "dynamic",
262
+ path: `${base}/auctions/commodities`
263
+ };
108
264
  }
109
265
 
110
- // src/azerite-essence/azerite-essence.ts
266
+ //#endregion
267
+ //#region src/azerite-essence/azerite-essence.ts
268
+ /**
269
+ * Get an azerite essence by ID.
270
+ * @param azeriteEssenceId The azerite essence ID.
271
+ * @returns The azerite essence. See {@link AzeriteEssenceResponse}.
272
+ */
111
273
  function azeriteEssence(azeriteEssenceId) {
112
- return {
113
- namespace: "static",
114
- path: `${base}/azerite-essence/${azeriteEssenceId}`
115
- };
116
- }
274
+ return {
275
+ namespace: "static",
276
+ path: `${base}/azerite-essence/${azeriteEssenceId}`
277
+ };
278
+ }
279
+ /**
280
+ * Get an azerite essence index.
281
+ * @returns The azerite essence index. See {@link AzeriteEssenceIndexResponse}.
282
+ */
117
283
  function azeriteEssenceIndex() {
118
- return {
119
- namespace: "static",
120
- path: `${base}/azerite-essence/index`
121
- };
122
- }
284
+ return {
285
+ namespace: "static",
286
+ path: `${base}/azerite-essence/index`
287
+ };
288
+ }
289
+ /**
290
+ * Get azerite essence media by ID.
291
+ * @param azeriteEssenceId The azerite essence ID.
292
+ * @returns The azerite essence media. See {@link AzeriteEssenceMediaResponse}.
293
+ */
123
294
  function azeriteEssenceMedia(azeriteEssenceId) {
124
- return { namespace: "static", path: `${mediaBase}/azerite-essence/${azeriteEssenceId}` };
125
- }
295
+ return {
296
+ namespace: "static",
297
+ path: `${mediaBase}/azerite-essence/${azeriteEssenceId}`
298
+ };
299
+ }
300
+ /**
301
+ * Search for azerite essences.
302
+ * @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
303
+ * @returns The search results. See {@link SearchResponse}.
304
+ */
126
305
  function azeriteEssenceSearch(options) {
127
- return {
128
- namespace: "static",
129
- parameters: {
130
- _page: options._page,
131
- "allowed_specializations.id": options["allowed_specializations.id"],
132
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
133
- },
134
- path: `${searchBase}/azerite-essence`
135
- };
136
- }
137
-
138
- // src/character-achievements/character-achievements.ts
139
- var basePath = "/profile/wow/character";
306
+ return {
307
+ namespace: "static",
308
+ parameters: {
309
+ _page: options._page,
310
+ "allowed_specializations.id": options["allowed_specializations.id"],
311
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
312
+ },
313
+ path: `${searchBase}/azerite-essence`
314
+ };
315
+ }
316
+
317
+ //#endregion
318
+ //#region src/character-achievements/character-achievements.ts
319
+ const basePath$2 = "/profile/wow/character";
320
+ /**
321
+
322
+ * @param realmSlug The slug of the realm.
323
+
324
+ * @param characterName The lowercase name of the character.
325
+
326
+ * @returns a summary of the achievements a character has completed.
327
+
328
+ */
140
329
  function characterAchievementsSummary(realmSlug, characterName) {
141
- return {
142
- namespace: "profile",
143
- path: `${basePath}/${realmSlug}/${characterName.toLowerCase()}/achievements`
144
- };
330
+ return {
331
+ namespace: "profile",
332
+ path: `${basePath$2}/${realmSlug}/${characterName.toLowerCase()}/achievements`
333
+ };
145
334
  }
335
+ /**
336
+
337
+ * @param realmSlug The slug of the realm.
338
+
339
+ * @param characterName The lowercase name of the character.
340
+
341
+ * @returns a character's statistics as they pertain to achievements.
342
+
343
+ */
146
344
  function characterAchievementStatistics(realmSlug, characterName) {
147
- return {
148
- namespace: "profile",
149
- path: `${basePath}/${realmSlug}/${characterName.toLowerCase()}/achievements/statistics`
150
- };
345
+ return {
346
+ namespace: "profile",
347
+ path: `${basePath$2}/${realmSlug}/${characterName.toLowerCase()}/achievements/statistics`
348
+ };
151
349
  }
152
350
 
153
- // src/character-appearance/character-appearance.ts
351
+ //#endregion
352
+ //#region src/character-appearance/character-appearance.ts
353
+ /**
354
+
355
+ * @param realmSlug The slug of the realm.
356
+
357
+ * @param characterName The lowercase name of the character.
358
+
359
+ * @returns a summary of a character's appearance settings.
360
+
361
+ */
154
362
  function characterAppearanceSummary(realmSlug, characterName) {
155
- return {
156
- namespace: "profile",
157
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/appearance`
158
- };
363
+ return {
364
+ namespace: "profile",
365
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/appearance`
366
+ };
159
367
  }
160
368
 
161
- // src/character-collections/character-collections.ts
162
- var basePath2 = "/profile/wow/character";
369
+ //#endregion
370
+ //#region src/character-collections/character-collections.ts
371
+ const basePath$1 = "/profile/wow/character";
372
+ /**
373
+
374
+ * @param realmSlug The slug of the realm.
375
+
376
+ * @param characterName The lowercase name of the character.
377
+
378
+ * @returns an index of collection types for a character.
379
+
380
+ */
163
381
  function characterCollectionsIndex(realmSlug, characterName) {
164
- return {
165
- namespace: "profile",
166
- path: `${basePath2}/${realmSlug}/${characterName}/collections`
167
- };
382
+ return {
383
+ namespace: "profile",
384
+ path: `${basePath$1}/${realmSlug}/${characterName}/collections`
385
+ };
168
386
  }
387
+ /**
388
+
389
+ * @param realmSlug The slug of the realm.
390
+
391
+ * @param characterName The lowercase name of the character.
392
+
393
+ * @returns a summary of the heirlooms a character has obtained.
394
+
395
+ */
169
396
  function characterHeirloomsCollectionSummary(realmSlug, characterName) {
170
- return {
171
- namespace: "profile",
172
- path: `${basePath2}/${realmSlug}/${characterName}/collections/heirlooms`
173
- };
397
+ return {
398
+ namespace: "profile",
399
+ path: `${basePath$1}/${realmSlug}/${characterName}/collections/heirlooms`
400
+ };
174
401
  }
402
+ /**
403
+
404
+ * @param realmSlug The slug of the realm.
405
+
406
+ * @param characterName The lowercase name of the character.
407
+
408
+ * @returns a summary of the mounts a character has obtained.
409
+
410
+ */
175
411
  function characterMountsCollectionSummary(realmSlug, characterName) {
176
- return {
177
- namespace: "profile",
178
- path: `${basePath2}/${realmSlug}/${characterName}/collections/mounts`
179
- };
412
+ return {
413
+ namespace: "profile",
414
+ path: `${basePath$1}/${realmSlug}/${characterName}/collections/mounts`
415
+ };
180
416
  }
417
+ /**
418
+
419
+ * @param realmSlug The slug of the realm.
420
+
421
+ * @param characterName The lowercase name of the character.
422
+
423
+ * @returns a summary of the battle pets a character has obtained.
424
+
425
+ */
181
426
  function characterPetsCollectionSummary(realmSlug, characterName) {
182
- return {
183
- namespace: "profile",
184
- path: `${basePath2}/${realmSlug}/${characterName}/collections/pets`
185
- };
427
+ return {
428
+ namespace: "profile",
429
+ path: `${basePath$1}/${realmSlug}/${characterName}/collections/pets`
430
+ };
186
431
  }
432
+ /**
433
+
434
+ * @param realmSlug The slug of the realm.
435
+
436
+ * @param characterName The lowercase name of the character.
437
+
438
+ * @returns a summary of the toys a character has obtained.
439
+
440
+ */
187
441
  function characterToysCollectionSummary(realmSlug, characterName) {
188
- return {
189
- namespace: "profile",
190
- path: `${basePath2}/${realmSlug}/${characterName}/collections/toys`
191
- };
442
+ return {
443
+ namespace: "profile",
444
+ path: `${basePath$1}/${realmSlug}/${characterName}/collections/toys`
445
+ };
192
446
  }
447
+ /**
448
+
449
+ * @param realmSlug The slug of the realm.
450
+
451
+ * @param characterName The lowercase name of the character.
452
+
453
+ * @returns a summary of the transmog unlocks a character has obtained.
454
+
455
+ */
193
456
  function characterTransmogCollectionSummary(realmSlug, characterName) {
194
- return {
195
- namespace: "profile",
196
- path: `${basePath2}/${realmSlug}/${characterName}/collections/transmogs`
197
- };
457
+ return {
458
+ namespace: "profile",
459
+ path: `${basePath$1}/${realmSlug}/${characterName}/collections/transmogs`
460
+ };
198
461
  }
199
462
 
200
- // src/character-encounters/character-encounters.ts
201
- var bathPase = "profile/wow/character";
463
+ //#endregion
464
+ //#region src/character-encounters/character-encounters.ts
465
+ const bathPase = "profile/wow/character";
466
+ /**
467
+
468
+ * @param realmSlug The slug of the realm.
469
+
470
+ * @param characterName The lowercase name of the character.
471
+
472
+ * @returns a summary of a character's completed dungeons.
473
+
474
+ */
202
475
  function characterDungeons(realmSlug, characterName) {
203
- return {
204
- namespace: "profile",
205
- path: `${bathPase}/${realmSlug}/${characterName.toLowerCase()}/encounters/dungeons`
206
- };
476
+ return {
477
+ namespace: "profile",
478
+ path: `${bathPase}/${realmSlug}/${characterName.toLowerCase()}/encounters/dungeons`
479
+ };
207
480
  }
481
+ /**
482
+
483
+ * @param realmSlug The slug of the realm.
484
+
485
+ * @param characterName The lowercase name of the character.
486
+
487
+ * @returns a summary of a character's encounters.
488
+
489
+ */
208
490
  function characterEncountersSummary(realmSlug, characterName) {
209
- return {
210
- namespace: "profile",
211
- path: `${bathPase}/${realmSlug}/${characterName.toLowerCase()}/encounters`
212
- };
491
+ return {
492
+ namespace: "profile",
493
+ path: `${bathPase}/${realmSlug}/${characterName.toLowerCase()}/encounters`
494
+ };
213
495
  }
496
+ /**
497
+
498
+ * @param realmSlug The slug of the realm.
499
+
500
+ * @param characterName The lowercase name of the character.
501
+
502
+ * @returns a summary of a character's completed raids.
503
+
504
+ */
214
505
  function characterRaids(realmSlug, characterName) {
215
- return {
216
- namespace: "profile",
217
- path: `${bathPase}/${realmSlug}/${characterName.toLowerCase()}/encounters/raids`
218
- };
506
+ return {
507
+ namespace: "profile",
508
+ path: `${bathPase}/${realmSlug}/${characterName.toLowerCase()}/encounters/raids`
509
+ };
219
510
  }
220
511
 
221
- // src/character-equipment/character-equipment.ts
512
+ //#endregion
513
+ //#region src/character-equipment/character-equipment.ts
514
+ /**
515
+
516
+ * @param realmSlug The slug of the realm.
517
+
518
+ * @param characterName The lowercase name of the character.
519
+
520
+ * @returns a summary of the items equipped by a character.
521
+
522
+ */
222
523
  function characterEquipmentSummary(realmSlug, characterName) {
223
- return {
224
- namespace: "profile",
225
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/equipment`
226
- };
524
+ return {
525
+ namespace: "profile",
526
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/equipment`
527
+ };
227
528
  }
228
529
 
229
- // src/character-hunter-pets/character-hunter-pets.ts
530
+ //#endregion
531
+ //#region src/character-hunter-pets/character-hunter-pets.ts
532
+ /**
533
+
534
+ * If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
535
+
536
+ * @param realmSlug The slug of the realm.
537
+
538
+ * @param characterName The lowercase name of the character.
539
+
540
+ * @returns a summary of the character's hunter pets.
541
+
542
+ */
230
543
  function characterHunterPetsSummary(realmSlug, characterName) {
231
- return {
232
- namespace: "profile",
233
- path: `/profile/wow/character/${realmSlug}/${characterName}/hunter-pets`
234
- };
544
+ return {
545
+ namespace: "profile",
546
+ path: `/profile/wow/character/${realmSlug}/${characterName}/hunter-pets`
547
+ };
235
548
  }
236
549
 
237
- // src/character-media/character-media.ts
550
+ //#endregion
551
+ //#region src/character-media/character-media.ts
552
+ /**
553
+
554
+ * @param realmSlug The slug of the realm.
555
+
556
+ * @param characterName The lowercase name of the character.
557
+
558
+ * @returns a summary of the media assets available for a character (such as an avatar render).
559
+
560
+ */
238
561
  function characterMediaSummary(realmSlug, characterName) {
239
- return {
240
- namespace: "profile",
241
- path: `/profile/wow/character/${realmSlug}/${characterName}/character-media`
242
- };
562
+ return {
563
+ namespace: "profile",
564
+ path: `/profile/wow/character/${realmSlug}/${characterName}/character-media`
565
+ };
243
566
  }
244
567
 
245
- // src/character-mythic-keystone-profile/character-mythic-keystone-profile.ts
568
+ //#endregion
569
+ //#region src/character-mythic-keystone-profile/character-mythic-keystone-profile.ts
570
+ /**
571
+
572
+ * @param realmSlug The slug of the realm.
573
+
574
+ * @param characterName The lowercase name of the character.
575
+
576
+ * @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.
577
+
578
+ */
246
579
  function characterMythicKeystoneProfileIndex(realmSlug, characterName) {
247
- return {
248
- namespace: "profile",
249
- path: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile`
250
- };
580
+ return {
581
+ namespace: "profile",
582
+ path: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile`
583
+ };
251
584
  }
585
+ /**
586
+
587
+ * Returns the Mythic Keystone season details for a character.
588
+
589
+ * Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
590
+
591
+ * @param realmSlug The slug of the realm.
592
+
593
+ * @param characterName The lowercase name of the character.
594
+
595
+ * @param seasonId The ID of the season.
596
+
597
+ * @returns the Mythic Keystone season details for a character.
598
+
599
+ */
252
600
  function characterMythicKeystoneSeasonDetails(realmSlug, characterName, seasonId) {
253
- return {
254
- namespace: "profile",
255
- path: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile/season/${seasonId}`
256
- };
601
+ return {
602
+ namespace: "profile",
603
+ path: `/profile/wow/character/${realmSlug}/${characterName}/mythic-keystone-profile/season/${seasonId}`
604
+ };
257
605
  }
258
606
 
259
- // src/character-professions/character-professions.ts
607
+ //#endregion
608
+ //#region src/character-professions/character-professions.ts
609
+ /**
610
+
611
+ * @param realmSlug The slug of the realm.
612
+
613
+ * @param characterName The lowercase name of the character.
614
+
615
+ * @returns a summary of the professions for a character.
616
+
617
+ */
260
618
  function characterProfessionsSummary(realmSlug, characterName) {
261
- return {
262
- namespace: "profile",
263
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/professions`
264
- };
619
+ return {
620
+ namespace: "profile",
621
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/professions`
622
+ };
265
623
  }
266
624
 
267
- // src/character-profile/character-profile.ts
625
+ //#endregion
626
+ //#region src/character-profile/character-profile.ts
627
+ /**
628
+
629
+ * 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:
630
+
631
+ * - an HTTP 404 Not Found error is returned
632
+
633
+ * - the is_valid value is false
634
+
635
+ * - the returned character ID doesn't match the previously recorded value for the character
636
+
637
+ *
638
+
639
+ * The following example illustrates how to use this endpoint:
640
+
641
+ *
642
+
643
+ * 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
644
+
645
+ * 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
646
+
647
+ * 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
648
+
649
+ * 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
650
+
651
+ * @param realmSlug The slug of the realm.
652
+
653
+ * @param characterName The lowercase name of the character.
654
+
655
+ * @returns the status of the character profile for a character.
656
+
657
+ */
268
658
  function characterProfileStatus(realmSlug, characterName) {
269
- return {
270
- namespace: "profile",
271
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/status`
272
- };
659
+ return {
660
+ namespace: "profile",
661
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/status`
662
+ };
273
663
  }
664
+ /**
665
+
666
+ * Returns a summary of the character profile for a character.
667
+
668
+ * @param realmSlug The slug of the realm.
669
+
670
+ * @param characterName The lowercase name of the character.
671
+
672
+ * @returns a summary of the character profile for a character.
673
+
674
+ */
274
675
  function characterProfileSummary(realmSlug, characterName) {
275
- return {
276
- namespace: "profile",
277
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}`
278
- };
676
+ return {
677
+ namespace: "profile",
678
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}`
679
+ };
279
680
  }
280
681
 
281
- // src/character-pvp/character-pvp.ts
682
+ //#endregion
683
+ //#region src/character-pvp/character-pvp.ts
684
+ /**
685
+
686
+ * @param realmSlug The slug of the realm.
687
+
688
+ * @param characterName The lowercase name of the character.
689
+
690
+ * @returns a PvP summary for a character.
691
+
692
+ */
282
693
  function characterPvpSummary(realmSlug, characterName) {
283
- return {
284
- namespace: "profile",
285
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/pvp-summary`
286
- };
694
+ return {
695
+ namespace: "profile",
696
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/pvp-summary`
697
+ };
287
698
  }
288
699
 
289
- // src/character-quests/character-quests.ts
700
+ //#endregion
701
+ //#region src/character-quests/character-quests.ts
702
+ /**
703
+
704
+ * @param realmSlug The slug of the realm.
705
+
706
+ * @param characterName The lowercase name of the character.
707
+
708
+ * @returns a list of quests that a character has completed.
709
+
710
+ */
290
711
  function characterCompletedQuests(realmSlug, characterName) {
291
- return {
292
- namespace: "profile",
293
- path: `/profile/wow/character/${realmSlug}/${characterName}/quests/completed`
294
- };
712
+ return {
713
+ namespace: "profile",
714
+ path: `/profile/wow/character/${realmSlug}/${characterName}/quests/completed`
715
+ };
295
716
  }
717
+ /**
718
+
719
+ * @param realmSlug The slug of the realm.
720
+
721
+ * @param characterName The lowercase name of the character.
722
+
723
+ * @returns a character's active quests as well as a link to the character's completed quests.
724
+
725
+ */
296
726
  function characterQuests(realmSlug, characterName) {
297
- return {
298
- namespace: "profile",
299
- path: `/profile/wow/character/${realmSlug}/${characterName}/quests`
300
- };
727
+ return {
728
+ namespace: "profile",
729
+ path: `/profile/wow/character/${realmSlug}/${characterName}/quests`
730
+ };
301
731
  }
302
732
 
303
- // src/character-reputations/character-reputations.ts
733
+ //#endregion
734
+ //#region src/character-reputations/character-reputations.ts
735
+ /**
736
+
737
+ * @param realmSlug The slug of the realm.
738
+
739
+ * @param characterName The lowercase name of the character.
740
+
741
+ * @returns a summary of a character's reputations.
742
+
743
+ */
304
744
  function characterReputationsSummary(realmSlug, characterName) {
305
- return {
306
- namespace: "profile",
307
- path: `/profile/wow/character/${realmSlug}/${characterName}/reputations`
308
- };
745
+ return {
746
+ namespace: "profile",
747
+ path: `/profile/wow/character/${realmSlug}/${characterName}/reputations`
748
+ };
309
749
  }
310
750
 
311
- // src/character-soulbinds/character-soulbinds.ts
751
+ //#endregion
752
+ //#region src/character-soulbinds/character-soulbinds.ts
753
+ /**
754
+
755
+ * @param realmSlug The slug of the realm.
756
+
757
+ * @param characterName The lowercase name of the character.
758
+
759
+ * @returns a character's soulbinds.
760
+
761
+ */
312
762
  function characterSoulbinds(realmSlug, characterName) {
313
- return {
314
- namespace: "profile",
315
- path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/soulbinds`
316
- };
763
+ return {
764
+ namespace: "profile",
765
+ path: `/profile/wow/character/${realmSlug}/${characterName.toLowerCase()}/soulbinds`
766
+ };
317
767
  }
318
768
 
319
- // src/character-specializations/character-specializations.ts
769
+ //#endregion
770
+ //#region src/character-specializations/character-specializations.ts
771
+ /**
772
+
773
+ * @param realmSlug The slug of the realm.
774
+
775
+ * @param characterName The lowercase name of the character.
776
+
777
+ * @returns a summary of a character's specializations.
778
+
779
+ */
320
780
  function characterSpecializationsSummary(realmSlug, characterName) {
321
- return {
322
- namespace: "profile",
323
- path: `/profile/wow/character/${realmSlug}/${characterName}/specializations`
324
- };
781
+ return {
782
+ namespace: "profile",
783
+ path: `/profile/wow/character/${realmSlug}/${characterName}/specializations`
784
+ };
325
785
  }
326
786
 
327
- // src/character-statistics/character-statistics.ts
787
+ //#endregion
788
+ //#region src/character-statistics/character-statistics.ts
789
+ /**
790
+
791
+ * @param realmSlug The slug of the realm.
792
+
793
+ * @param characterName The lowercase name of the character.
794
+
795
+ * @returns a statistics summary for a character.
796
+
797
+ */
328
798
  function characterStatisticsSummary(realmSlug, characterName) {
329
- return {
330
- namespace: "profile",
331
- path: `/profile/wow/character/${realmSlug}/${characterName}/statistics`
332
- };
799
+ return {
800
+ namespace: "profile",
801
+ path: `/profile/wow/character/${realmSlug}/${characterName}/statistics`
802
+ };
333
803
  }
334
804
 
335
- // src/character-titles/character-titles.ts
805
+ //#endregion
806
+ //#region src/character-titles/character-titles.ts
807
+ /**
808
+
809
+ * @param realmSlug The slug of the realm.
810
+
811
+ * @param characterName The lowercase name of the character.
812
+
813
+ * @returns a summary of titles a character has obtained.
814
+
815
+ */
336
816
  function characterTitlesSummary(realmSlug, characterName) {
337
- return {
338
- namespace: "profile",
339
- path: `/profile/wow/character/${realmSlug}/${characterName}/titles`
340
- };
817
+ return {
818
+ namespace: "profile",
819
+ path: `/profile/wow/character/${realmSlug}/${characterName}/titles`
820
+ };
341
821
  }
342
822
 
343
- // src/connected-realm/connected-realm.ts
823
+ //#endregion
824
+ //#region src/connected-realm/connected-realm.ts
825
+ /**
826
+ * Get a connected realm by ID.
827
+ * @param connectedRealmId The connected realm ID.
828
+ * @returns The connected realm. See {@link ConnectedRealmResponse}.
829
+ */
344
830
  function connectedRealm(connectedRealmId) {
345
- return {
346
- namespace: "dynamic",
347
- path: `${base}/connected-realm/${connectedRealmId}`
348
- };
349
- }
831
+ return {
832
+ namespace: "dynamic",
833
+ path: `${base}/connected-realm/${connectedRealmId}`
834
+ };
835
+ }
836
+ /**
837
+ * Get a connected realm index.
838
+ * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
839
+ */
350
840
  function connectedRealmIndex() {
351
- return {
352
- namespace: "dynamic",
353
- path: `${base}/connected-realm/index`
354
- };
355
- }
841
+ return {
842
+ namespace: "dynamic",
843
+ path: `${base}/connected-realm/index`
844
+ };
845
+ }
846
+ /**
847
+ * Search for connected realms.
848
+ * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
849
+ * @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
850
+ */
356
851
  function connectedRealmSearch(options) {
357
- return {
358
- namespace: "dynamic",
359
- parameters: {
360
- _page: options._page,
361
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
362
- "realms.timezone": options["realms.timezone"],
363
- "status.type": options["status.type"]
364
- },
365
- path: `${base}/search/connected-realm`
366
- };
367
- }
368
-
369
- // src/covenant/covenant.ts
370
- function conduit(conduitId) {
371
- return {
372
- namespace: "static",
373
- path: `${base}/covenant/conduit/${conduitId}`
374
- };
852
+ return {
853
+ namespace: "dynamic",
854
+ parameters: {
855
+ _page: options._page,
856
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
857
+ "realms.timezone": options["realms.timezone"],
858
+ "status.type": options["status.type"]
859
+ },
860
+ path: `${base}/search/connected-realm`
861
+ };
375
862
  }
863
+
864
+ //#endregion
865
+ //#region src/covenant/covenant.ts
866
+ /**
867
+ * Get a conduit by ID.
868
+ * @param conduitId The conduit ID.
869
+ * @returns The conduit. See {@link ConduitResponse}.
870
+ */
871
+ function conduit(conduitId) {
872
+ return {
873
+ namespace: "static",
874
+ path: `${base}/covenant/conduit/${conduitId}`
875
+ };
876
+ }
877
+ /**
878
+ * Get a conduit index.
879
+ * @returns The conduit index. See {@link ConduitIndexResponse}.
880
+ */
376
881
  function conduitIndex() {
377
- return {
378
- namespace: "static",
379
- path: `${base}/covenant/conduit/index`
380
- };
381
- }
882
+ return {
883
+ namespace: "static",
884
+ path: `${base}/covenant/conduit/index`
885
+ };
886
+ }
887
+ /**
888
+ * Get a covenant by ID.
889
+ * @param covenantId The covenant ID.
890
+ * @returns The covenant. See {@link CovenantResponse}.
891
+ */
382
892
  function covenant(covenantId) {
383
- return {
384
- namespace: "static",
385
- path: `${base}/covenant/${covenantId}`
386
- };
387
- }
893
+ return {
894
+ namespace: "static",
895
+ path: `${base}/covenant/${covenantId}`
896
+ };
897
+ }
898
+ /**
899
+ * Get a covenant index.
900
+ * @returns The covenant index. See {@link CovenantIndexResponse}.
901
+ */
388
902
  function covenantIndex() {
389
- return {
390
- namespace: "static",
391
- path: `${base}/covenant/index`
392
- };
393
- }
903
+ return {
904
+ namespace: "static",
905
+ path: `${base}/covenant/index`
906
+ };
907
+ }
908
+ /**
909
+ * Get covenant media by ID.
910
+ * @param covenantId The covenant ID.
911
+ * @returns The covenant media. See {@link CovenantMediaResponse}.
912
+ */
394
913
  function covenantMedia(covenantId) {
395
- return {
396
- namespace: "static",
397
- path: `${mediaBase}/covenant/${covenantId}`
398
- };
399
- }
914
+ return {
915
+ namespace: "static",
916
+ path: `${mediaBase}/covenant/${covenantId}`
917
+ };
918
+ }
919
+ /**
920
+ * Get a soulbind by ID.
921
+ * @param soulbindId The soulbind ID.
922
+ * @returns The soulbind. See {@link SoulbindResponse}.
923
+ */
400
924
  function soulbind(soulbindId) {
401
- return {
402
- namespace: "static",
403
- path: `${base}/covenant/soulbind/${soulbindId}`
404
- };
405
- }
925
+ return {
926
+ namespace: "static",
927
+ path: `${base}/covenant/soulbind/${soulbindId}`
928
+ };
929
+ }
930
+ /**
931
+ * Get a soulbind index.
932
+ * @returns The soulbind index. See {@link SoulbindIndexResponse}.
933
+ */
406
934
  function soulbindIndex() {
407
- return {
408
- namespace: "static",
409
- path: `${base}/covenant/soulbind/index`
410
- };
935
+ return {
936
+ namespace: "static",
937
+ path: `${base}/covenant/soulbind/index`
938
+ };
411
939
  }
412
940
 
413
- // src/creature/creature.ts
941
+ //#endregion
942
+ //#region src/creature/creature.ts
943
+ /**
944
+ * Get a creature by ID.
945
+ * @param creatureId The creature ID.
946
+ * @returns The creature. See {@link CreatureResponse}.
947
+ */
414
948
  function creature(creatureId) {
415
- return {
416
- namespace: "static",
417
- path: `${base}/creature/${creatureId}`
418
- };
419
- }
949
+ return {
950
+ namespace: "static",
951
+ path: `${base}/creature/${creatureId}`
952
+ };
953
+ }
954
+ /**
955
+ * Get creature display media by ID.
956
+ * @param creatureDisplayId The creature display ID.
957
+ * @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
958
+ */
420
959
  function creatureDisplayMedia(creatureDisplayId) {
421
- return {
422
- namespace: "static",
423
- path: `${mediaBase}/creature-display/${creatureDisplayId}`
424
- };
425
- }
960
+ return {
961
+ namespace: "static",
962
+ path: `${mediaBase}/creature-display/${creatureDisplayId}`
963
+ };
964
+ }
965
+ /**
966
+ * Get a creature family by ID.
967
+ * @param creatureFamilyId The creature family ID.
968
+ * @returns The creature family. See {@link CreatureFamilyResponse}.
969
+ */
426
970
  function creatureFamily(creatureFamilyId) {
427
- return {
428
- namespace: "static",
429
- path: `${base}/creature-family/${creatureFamilyId}`
430
- };
431
- }
971
+ return {
972
+ namespace: "static",
973
+ path: `${base}/creature-family/${creatureFamilyId}`
974
+ };
975
+ }
976
+ /**
977
+ * Get a creature family index.
978
+ * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
979
+ */
432
980
  function creatureFamilyIndex() {
433
- return {
434
- namespace: "static",
435
- path: `${base}/creature-family/index`
436
- };
437
- }
981
+ return {
982
+ namespace: "static",
983
+ path: `${base}/creature-family/index`
984
+ };
985
+ }
986
+ /**
987
+ * Get creature family media by ID.
988
+ * @param creatureFamilyId The creature family ID.
989
+ * @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
990
+ */
438
991
  function creatureFamilyMedia(creatureFamilyId) {
439
- return {
440
- namespace: "static",
441
- path: `${mediaBase}/creature-family/${creatureFamilyId}`
442
- };
443
- }
992
+ return {
993
+ namespace: "static",
994
+ path: `${mediaBase}/creature-family/${creatureFamilyId}`
995
+ };
996
+ }
997
+ /**
998
+ * Search for creatures.
999
+ * @param options The creature search parameters. See {@link CreatureSearchParameters}.
1000
+ * @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
1001
+ */
444
1002
  function creatureSearch(options) {
445
- return {
446
- namespace: "static",
447
- parameters: {
448
- _page: options._page,
449
- [`name.${options.locale}`]: options.name,
450
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
451
- },
452
- path: `${searchBase}/creature`
453
- };
454
- }
1003
+ return {
1004
+ namespace: "static",
1005
+ parameters: {
1006
+ _page: options._page,
1007
+ [`name.${options.locale}`]: options.name,
1008
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
1009
+ },
1010
+ path: `${searchBase}/creature`
1011
+ };
1012
+ }
1013
+ /**
1014
+ * Get a creature type by ID.
1015
+ * @param creatureTypeId The creature type ID.
1016
+ * @returns The creature type. See {@link CreatureTypeResponse}.
1017
+ */
455
1018
  function creatureType(creatureTypeId) {
456
- return {
457
- namespace: "static",
458
- path: `${base}/creature-type/${creatureTypeId}`
459
- };
460
- }
1019
+ return {
1020
+ namespace: "static",
1021
+ path: `${base}/creature-type/${creatureTypeId}`
1022
+ };
1023
+ }
1024
+ /**
1025
+ * Get a creature type index.
1026
+ * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
1027
+ */
461
1028
  function creatureTypeIndex() {
462
- return {
463
- namespace: "static",
464
- path: `${base}/creature-type/index`
465
- };
1029
+ return {
1030
+ namespace: "static",
1031
+ path: `${base}/creature-type/index`
1032
+ };
466
1033
  }
467
1034
 
468
- // src/guild-crest/guild-crest.ts
1035
+ //#endregion
1036
+ //#region src/guild-crest/guild-crest.ts
1037
+ /**
1038
+ * Get a guild crest border by ID.
1039
+ * @param borderId The guild crest border ID.
1040
+ * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
1041
+ */
469
1042
  function guildCrestBorder(borderId) {
470
- return {
471
- namespace: "static",
472
- path: `${mediaBase}/guild-crest/border/${borderId}`
473
- };
474
- }
1043
+ return {
1044
+ namespace: "static",
1045
+ path: `${mediaBase}/guild-crest/border/${borderId}`
1046
+ };
1047
+ }
1048
+ /**
1049
+ * Get the guild crest components index.
1050
+ * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
1051
+ */
475
1052
  function guildCrestComponentsIndex() {
476
- return {
477
- namespace: "static",
478
- path: `${base}/guild-crest/index`
479
- };
480
- }
1053
+ return {
1054
+ namespace: "static",
1055
+ path: `${base}/guild-crest/index`
1056
+ };
1057
+ }
1058
+ /**
1059
+ * Get a guild crest emblem by ID.
1060
+ * @param emblemId The guild crest emblem ID.
1061
+ * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
1062
+ */
481
1063
  function guildCrestEmblem(emblemId) {
482
- return {
483
- namespace: "static",
484
- path: `${mediaBase}/guild-crest/emblem/${emblemId}`
485
- };
1064
+ return {
1065
+ namespace: "static",
1066
+ path: `${mediaBase}/guild-crest/emblem/${emblemId}`
1067
+ };
486
1068
  }
487
1069
 
488
- // src/guild/guild.ts
489
- var basePath3 = "/data/wow/guild";
1070
+ //#endregion
1071
+ //#region src/guild/guild.ts
1072
+ const basePath = "/data/wow/guild";
1073
+ /**
1074
+
1075
+ * @param realmSlug The slug of the realm.
1076
+
1077
+ * @param nameSlug The lowercase name of the guild.
1078
+
1079
+ * @returns a single guild by its name and realm.
1080
+
1081
+ */
490
1082
  function guild(realmSlug, nameSlug) {
491
- return {
492
- namespace: "profile",
493
- path: `${basePath3}/${realmSlug}/${nameSlug}`
494
- };
1083
+ return {
1084
+ namespace: "profile",
1085
+ path: `${basePath}/${realmSlug}/${nameSlug}`
1086
+ };
495
1087
  }
1088
+ /**
1089
+
1090
+ * @param realmSlug The slug of the realm.
1091
+
1092
+ * @param nameSlug The lowercase name of the guild.
1093
+
1094
+ * @returns a single guild's achievements by name and realm.
1095
+
1096
+ */
496
1097
  function guildAchievements(realmSlug, nameSlug) {
497
- return {
498
- namespace: "profile",
499
- path: `${basePath3}/${realmSlug}/${nameSlug}/achievements`
500
- };
1098
+ return {
1099
+ namespace: "profile",
1100
+ path: `${basePath}/${realmSlug}/${nameSlug}/achievements`
1101
+ };
501
1102
  }
1103
+ /**
1104
+
1105
+ * @param realmSlug The slug of the realm.
1106
+
1107
+ * @param nameSlug The lowercase name of the guild.
1108
+
1109
+ * @returns a single guild's activity by name and realm.
1110
+
1111
+ */
502
1112
  function guildActivity(realmSlug, nameSlug) {
503
- return {
504
- namespace: "profile",
505
- path: `${basePath3}/${realmSlug}/${nameSlug}/activity`
506
- };
1113
+ return {
1114
+ namespace: "profile",
1115
+ path: `${basePath}/${realmSlug}/${nameSlug}/activity`
1116
+ };
507
1117
  }
1118
+ /**
1119
+
1120
+ * @param realmSlug The slug of the realm.
1121
+
1122
+ * @param nameSlug The lowercase name of the guild.
1123
+
1124
+ * @returns a single guild's roster by its name and realm.
1125
+
1126
+ */
508
1127
  function guildRoster(realmSlug, nameSlug) {
509
- return {
510
- namespace: "profile",
511
- path: `${basePath3}/${realmSlug}/${nameSlug}/roster`
512
- };
1128
+ return {
1129
+ namespace: "profile",
1130
+ path: `${basePath}/${realmSlug}/${nameSlug}/roster`
1131
+ };
513
1132
  }
514
1133
 
515
- // src/heirloom/heirloom.ts
1134
+ //#endregion
1135
+ //#region src/heirloom/heirloom.ts
1136
+ /**
1137
+ * Get a heirloom by ID.
1138
+ * @param heirloomId The heirloom ID.
1139
+ * @returns The heirloom. See {@link HeirloomResponse}.
1140
+ */
516
1141
  function heirloom(heirloomId) {
517
- return {
518
- namespace: "static",
519
- path: `${base}/heirloom/${heirloomId}`
520
- };
521
- }
1142
+ return {
1143
+ namespace: "static",
1144
+ path: `${base}/heirloom/${heirloomId}`
1145
+ };
1146
+ }
1147
+ /**
1148
+ * Get the heirloom index.
1149
+ * @returns The heirloom index. See {@link HeirloomIndexResponse}.
1150
+ */
522
1151
  function heirloomIndex() {
523
- return {
524
- namespace: "static",
525
- path: `${base}/heirloom/index`
526
- };
1152
+ return {
1153
+ namespace: "static",
1154
+ path: `${base}/heirloom/index`
1155
+ };
527
1156
  }
528
1157
 
529
- // src/item/item.ts
1158
+ //#endregion
1159
+ //#region src/item/item.ts
1160
+ /**
1161
+ * Get an item by ID.
1162
+ * @param itemId The item ID.
1163
+ * @returns The item. See {@link ItemResponse}.
1164
+ */
530
1165
  function item(itemId) {
531
- return {
532
- namespace: "static",
533
- path: `${base}/item/${itemId}`
534
- };
535
- }
1166
+ return {
1167
+ namespace: "static",
1168
+ path: `${base}/item/${itemId}`
1169
+ };
1170
+ }
1171
+ /**
1172
+ * Get an item class by ID.
1173
+ * @param itemClassId The item class ID.
1174
+ * @returns The item class. See {@link ItemClassResponse}.
1175
+ */
536
1176
  function itemClass(itemClassId) {
537
- return {
538
- namespace: "static",
539
- path: `${base}/item-class/${itemClassId}`
540
- };
541
- }
1177
+ return {
1178
+ namespace: "static",
1179
+ path: `${base}/item-class/${itemClassId}`
1180
+ };
1181
+ }
1182
+ /**
1183
+ * Get an item class index.
1184
+ * @returns The item class index. See {@link ItemClassIndexResponse}.
1185
+ */
542
1186
  function itemClassIndex() {
543
- return {
544
- namespace: "static",
545
- path: `${base}/item-class/index`
546
- };
547
- }
1187
+ return {
1188
+ namespace: "static",
1189
+ path: `${base}/item-class/index`
1190
+ };
1191
+ }
1192
+ /**
1193
+ * Get item media by ID.
1194
+ * @param itemId The item ID.
1195
+ * @returns The item media. See {@link ItemMediaResponse}.
1196
+ */
548
1197
  function itemMedia(itemId) {
549
- return {
550
- namespace: "static",
551
- path: `${mediaBase}/item/${itemId}`
552
- };
553
- }
1198
+ return {
1199
+ namespace: "static",
1200
+ path: `${mediaBase}/item/${itemId}`
1201
+ };
1202
+ }
1203
+ /**
1204
+ * Search for items.
1205
+ * @param options The search parameters. See {@link ItemSearchParameters}.
1206
+ * @returns The search results. See {@link SearchResponse}.
1207
+ */
554
1208
  function itemSearch(options) {
555
- return {
556
- namespace: "static",
557
- parameters: {
558
- _page: options._page,
559
- [`name.${options.locale}`]: options.name,
560
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
561
- },
562
- path: `${searchBase}/item`
563
- };
564
- }
1209
+ return {
1210
+ namespace: "static",
1211
+ parameters: {
1212
+ _page: options._page,
1213
+ [`name.${options.locale}`]: options.name,
1214
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
1215
+ },
1216
+ path: `${searchBase}/item`
1217
+ };
1218
+ }
1219
+ /**
1220
+ * Get an item set by ID.
1221
+ * @param itemSetId The item set ID.
1222
+ * @returns The item set. See {@link ItemSetResponse}.
1223
+ */
565
1224
  function itemSet(itemSetId) {
566
- return {
567
- namespace: "static",
568
- path: `${base}/item-set/${itemSetId}`
569
- };
570
- }
1225
+ return {
1226
+ namespace: "static",
1227
+ path: `${base}/item-set/${itemSetId}`
1228
+ };
1229
+ }
1230
+ /**
1231
+ * Get an item set index.
1232
+ * @returns The item set index. See {@link ItemSetIndexResponse}.
1233
+ */
571
1234
  function itemSetIndex() {
572
- return {
573
- namespace: "static",
574
- path: `${base}/item-set/index`
575
- };
576
- }
1235
+ return {
1236
+ namespace: "static",
1237
+ path: `${base}/item-set/index`
1238
+ };
1239
+ }
1240
+ /**
1241
+ * Get an item subclass by ID.
1242
+ * @param itemClassId The item class ID.
1243
+ * @param itemSubclassId The item subclass ID.
1244
+ * @returns The item subclass. See {@link ItemSubClassResponse}.
1245
+ */
577
1246
  function itemSubClass(itemClassId, itemSubclassId) {
578
- return {
579
- namespace: "static",
580
- path: `${base}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`
581
- };
1247
+ return {
1248
+ namespace: "static",
1249
+ path: `${base}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`
1250
+ };
582
1251
  }
583
1252
 
584
- // src/journal/journal.ts
1253
+ //#endregion
1254
+ //#region src/journal/journal.ts
1255
+ /**
1256
+ * Get a journal encounter by ID.
1257
+ * @param journalEncounterId The journal encounter ID.
1258
+ * @returns The journal encounter. See {@link JournalEncounterResponse}.
1259
+ */
585
1260
  function journalEncounter(journalEncounterId) {
586
- return {
587
- namespace: "static",
588
- path: `${base}/journal-encounter/${journalEncounterId}`
589
- };
590
- }
1261
+ return {
1262
+ namespace: "static",
1263
+ path: `${base}/journal-encounter/${journalEncounterId}`
1264
+ };
1265
+ }
1266
+ /**
1267
+ * Get the journal encounter index.
1268
+ * @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
1269
+ */
591
1270
  function journalEncounterIndex() {
592
- return {
593
- namespace: "static",
594
- path: `${base}/journal-encounter/index`
595
- };
596
- }
1271
+ return {
1272
+ namespace: "static",
1273
+ path: `${base}/journal-encounter/index`
1274
+ };
1275
+ }
1276
+ /**
1277
+ * Search for journal encounters.
1278
+ * @param options The search parameters. See {@link JournalEncounterSearchParameters}.
1279
+ * @returns The search results. See {@link SearchResponse}.
1280
+ */
597
1281
  function journalEncounterSearch(options) {
598
- return {
599
- namespace: "static",
600
- parameters: {
601
- _page: options._page,
602
- [`instance.name.${options.locale}`]: options.instanceName,
603
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
604
- },
605
- path: `${searchBase}/journal-encounter`
606
- };
607
- }
1282
+ return {
1283
+ namespace: "static",
1284
+ parameters: {
1285
+ _page: options._page,
1286
+ [`instance.name.${options.locale}`]: options.instanceName,
1287
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
1288
+ },
1289
+ path: `${searchBase}/journal-encounter`
1290
+ };
1291
+ }
1292
+ /**
1293
+ * Get a journal expansion by ID.
1294
+ * @param journalExpansionId The journal expansion ID.
1295
+ * @returns The journal expansion. See {@link JournalExpansionResponse}.
1296
+ */
608
1297
  function journalExpansion(journalExpansionId) {
609
- return {
610
- namespace: "static",
611
- path: `${base}/journal-expansion/${journalExpansionId}`
612
- };
613
- }
1298
+ return {
1299
+ namespace: "static",
1300
+ path: `${base}/journal-expansion/${journalExpansionId}`
1301
+ };
1302
+ }
1303
+ /**
1304
+ * Get the journal expansion index.
1305
+ * @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
1306
+ */
614
1307
  function journalExpansionIndex() {
615
- return {
616
- namespace: "static",
617
- path: `${base}/journal-expansion/index`
618
- };
619
- }
1308
+ return {
1309
+ namespace: "static",
1310
+ path: `${base}/journal-expansion/index`
1311
+ };
1312
+ }
1313
+ /**
1314
+ * Get a journal instance by ID.
1315
+ * @param journalInstanceId The journal instance ID.
1316
+ * @returns The journal instance. See {@link JournalInstanceResponse}.
1317
+ */
620
1318
  function journalInstance(journalInstanceId) {
621
- return {
622
- namespace: "static",
623
- path: `${base}/journal-instance/${journalInstanceId}`
624
- };
625
- }
1319
+ return {
1320
+ namespace: "static",
1321
+ path: `${base}/journal-instance/${journalInstanceId}`
1322
+ };
1323
+ }
1324
+ /**
1325
+ * Get the journal instance index.
1326
+ * @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
1327
+ */
626
1328
  function journalInstanceIndex() {
627
- return {
628
- namespace: "static",
629
- path: `${base}/journal-instance/index`
630
- };
631
- }
1329
+ return {
1330
+ namespace: "static",
1331
+ path: `${base}/journal-instance/index`
1332
+ };
1333
+ }
1334
+ /**
1335
+ * Get journal instance media by ID.
1336
+ * @param journalInstanceId The journal instance ID.
1337
+ * @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
1338
+ */
632
1339
  function journalInstanceMedia(journalInstanceId) {
633
- return {
634
- namespace: "static",
635
- path: `${mediaBase}/journal-instance/${journalInstanceId}`
636
- };
1340
+ return {
1341
+ namespace: "static",
1342
+ path: `${mediaBase}/journal-instance/${journalInstanceId}`
1343
+ };
637
1344
  }
638
1345
 
639
- // src/media-search/media-search.ts
1346
+ //#endregion
1347
+ //#region src/media-search/media-search.ts
1348
+ /**
1349
+ * Search for media.
1350
+ * @param options The search parameters. See {@link MediaSearchParameters}.
1351
+ * @returns The search results. See {@link SearchResponse}.
1352
+ */
640
1353
  function mediaSearch(options) {
641
- return {
642
- namespace: "static",
643
- parameters: {
644
- _page: options._page,
645
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
646
- tags: options.tags
647
- },
648
- path: `${searchBase}/media`
649
- };
650
- }
651
-
652
- // src/modified-crafting/modified-crafting.ts
653
- function modifiedCraftingCategory(modifiedCraftingCategoryId) {
654
- return {
655
- namespace: "static",
656
- path: `${base}/modified-crafting/category/${modifiedCraftingCategoryId}`
657
- };
1354
+ return {
1355
+ namespace: "static",
1356
+ parameters: {
1357
+ _page: options._page,
1358
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
1359
+ tags: options.tags
1360
+ },
1361
+ path: `${searchBase}/media`
1362
+ };
658
1363
  }
1364
+
1365
+ //#endregion
1366
+ //#region src/modified-crafting/modified-crafting.ts
1367
+ /**
1368
+ * Get a modified crafting category by ID.
1369
+ * @param modifiedCraftingCategoryId The modified crafting category ID.
1370
+ * @returns The modified crafting category. See {@link ModifiedCraftingCategoryResponse}.
1371
+ */
1372
+ function modifiedCraftingCategory(modifiedCraftingCategoryId) {
1373
+ return {
1374
+ namespace: "static",
1375
+ path: `${base}/modified-crafting/category/${modifiedCraftingCategoryId}`
1376
+ };
1377
+ }
1378
+ /**
1379
+ * Get a modified crafting category index.
1380
+ * @returns The modified crafting category index. See {@link ModifiedCraftingCategoryIndexResponse}.
1381
+ */
659
1382
  function modifiedCraftingCategoryIndex() {
660
- return {
661
- namespace: "static",
662
- path: `${base}/modified-crafting/category/index`
663
- };
664
- }
1383
+ return {
1384
+ namespace: "static",
1385
+ path: `${base}/modified-crafting/category/index`
1386
+ };
1387
+ }
1388
+ /**
1389
+ * Get a modified crafting index.
1390
+ * @returns The modified crafting index. See {@link ModifiedCraftingIndexResponse}.
1391
+ */
665
1392
  function modifiedCraftingIndex() {
666
- return {
667
- namespace: "static",
668
- path: `${base}/modified-crafting/index`
669
- };
670
- }
1393
+ return {
1394
+ namespace: "static",
1395
+ path: `${base}/modified-crafting/index`
1396
+ };
1397
+ }
1398
+ /**
1399
+ * Get a modified crafting reagent slot type by ID.
1400
+ * @param modifiedCraftingReagentSlotTypeId The modified crafting reagent slot type ID.
1401
+ * @returns The modified crafting reagent slot type. See {@link ModifiedCraftingReagentSlotTypeResponse}.
1402
+ */
671
1403
  function modifiedCraftingReagentSlotType(modifiedCraftingReagentSlotTypeId) {
672
- return {
673
- namespace: "static",
674
- path: `${base}/modified-crafting/reagent-slot-type/${modifiedCraftingReagentSlotTypeId}`
675
- };
676
- }
1404
+ return {
1405
+ namespace: "static",
1406
+ path: `${base}/modified-crafting/reagent-slot-type/${modifiedCraftingReagentSlotTypeId}`
1407
+ };
1408
+ }
1409
+ /**
1410
+ * Get a modified crafting reagent slot type index.
1411
+ * @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
1412
+ */
677
1413
  function modifiedCraftingReagentSlotTypeIndex() {
678
- return {
679
- namespace: "static",
680
- path: `${base}/modified-crafting/reagent-slot-type/index`
681
- };
1414
+ return {
1415
+ namespace: "static",
1416
+ path: `${base}/modified-crafting/reagent-slot-type/index`
1417
+ };
682
1418
  }
683
1419
 
684
- // src/mount/mount.ts
1420
+ //#endregion
1421
+ //#region src/mount/mount.ts
1422
+ /**
1423
+ * Get a mount by ID.
1424
+ * @param mountId The mount ID.
1425
+ * @returns The mount. See {@link MountResponse}.
1426
+ */
685
1427
  function mount(mountId) {
686
- return {
687
- namespace: "static",
688
- path: `${base}/mount/${mountId}`
689
- };
690
- }
1428
+ return {
1429
+ namespace: "static",
1430
+ path: `${base}/mount/${mountId}`
1431
+ };
1432
+ }
1433
+ /**
1434
+ * Get a mount index.
1435
+ * @returns The mount index. See {@link MountIndexResponse}.
1436
+ */
691
1437
  function mountIndex() {
692
- return {
693
- namespace: "static",
694
- path: `${base}/mount/index`
695
- };
696
- }
1438
+ return {
1439
+ namespace: "static",
1440
+ path: `${base}/mount/index`
1441
+ };
1442
+ }
1443
+ /**
1444
+ * Get a mount search.
1445
+ * @param options The search parameters. See {@link MountSearchParameters}.
1446
+ * @returns The search results. See {@link SearchResponse}.
1447
+ */
697
1448
  function mountSearch(options) {
698
- return {
699
- namespace: "static",
700
- parameters: {
701
- _page: options._page,
702
- [`name.${options.locale}`]: options.name,
703
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
704
- },
705
- path: `${searchBase}/mount`
706
- };
707
- }
708
-
709
- // src/mythic-keystone-affix/mythic-keystone-affix.ts
710
- function mythicKeystoneAffix(mythicKeystoneAffixId) {
711
- return {
712
- namespace: "static",
713
- path: `${base}/keystone-affix/${mythicKeystoneAffixId}`
714
- };
1449
+ return {
1450
+ namespace: "static",
1451
+ parameters: {
1452
+ _page: options._page,
1453
+ [`name.${options.locale}`]: options.name,
1454
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
1455
+ },
1456
+ path: `${searchBase}/mount`
1457
+ };
715
1458
  }
1459
+
1460
+ //#endregion
1461
+ //#region src/mythic-keystone-affix/mythic-keystone-affix.ts
1462
+ /**
1463
+ * Get a list of all Mythic Keystone affixes.
1464
+ * @param mythicKeystoneAffixId The ID of the Mythic Keystone affix.
1465
+ * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
1466
+ */
1467
+ function mythicKeystoneAffix(mythicKeystoneAffixId) {
1468
+ return {
1469
+ namespace: "static",
1470
+ path: `${base}/keystone-affix/${mythicKeystoneAffixId}`
1471
+ };
1472
+ }
1473
+ /**
1474
+ * Get a list of all Mythic Keystone affixes.
1475
+ * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
1476
+ */
716
1477
  function mythicKeystoneAffixIndex() {
717
- return {
718
- namespace: "static",
719
- path: `${base}/keystone-affix/index`
720
- };
721
- }
1478
+ return {
1479
+ namespace: "static",
1480
+ path: `${base}/keystone-affix/index`
1481
+ };
1482
+ }
1483
+ /**
1484
+ * Get a list of all Mythic Keystone affix media.
1485
+ * @param mythicKeystoneAffixId The ID of the Mythic Keystone affix.
1486
+ * @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
1487
+ */
722
1488
  function mythicKeystoneAffixMedia(mythicKeystoneAffixId) {
723
- return {
724
- namespace: "static",
725
- path: `${mediaBase}/keystone-affix/${mythicKeystoneAffixId}`
726
- };
1489
+ return {
1490
+ namespace: "static",
1491
+ path: `${mediaBase}/keystone-affix/${mythicKeystoneAffixId}`
1492
+ };
727
1493
  }
728
1494
 
729
- // src/mythic-keystone-dungeon/mythic-keystone-dungeon.ts
1495
+ //#endregion
1496
+ //#region src/mythic-keystone-dungeon/mythic-keystone-dungeon.ts
1497
+ /**
1498
+ * Get a Mythic Keystone dungeon by ID.
1499
+ * @param mythicKeystoneDungeonId The Mythic Keystone dungeon ID.
1500
+ * @returns The Mythic Keystone dungeon. See {@link MythicKeystoneDungeonResponse}.
1501
+ */
730
1502
  function mythicKeystoneDungeon(mythicKeystoneDungeonId) {
731
- return {
732
- namespace: "dynamic",
733
- path: `${base}/mythic-keystone/dungeon/${mythicKeystoneDungeonId}`
734
- };
735
- }
1503
+ return {
1504
+ namespace: "dynamic",
1505
+ path: `${base}/mythic-keystone/dungeon/${mythicKeystoneDungeonId}`
1506
+ };
1507
+ }
1508
+ /**
1509
+ * Get a Mythic Keystone dungeon index.
1510
+ * @returns The Mythic Keystone dungeon index. See {@link MythicKeystoneDungeonIndexResponse}.
1511
+ */
736
1512
  function mythicKeystoneDungeonIndex() {
737
- return {
738
- namespace: "dynamic",
739
- path: `${base}/mythic-keystone/dungeon/index`
740
- };
741
- }
1513
+ return {
1514
+ namespace: "dynamic",
1515
+ path: `${base}/mythic-keystone/dungeon/index`
1516
+ };
1517
+ }
1518
+ /**
1519
+ * Get a Mythic Keystone index.
1520
+ * @returns The Mythic Keystone index. See {@link MythicKeystoneIndexResponse}.
1521
+ */
742
1522
  function mythicKeystoneIndex() {
743
- return {
744
- namespace: "dynamic",
745
- path: `${base}/mythic-keystone/index`
746
- };
747
- }
1523
+ return {
1524
+ namespace: "dynamic",
1525
+ path: `${base}/mythic-keystone/index`
1526
+ };
1527
+ }
1528
+ /**
1529
+ * Get a Mythic Keystone period by ID.
1530
+ * @param mythicKeystonePeriodId The Mythic Keystone period ID.
1531
+ * @returns The Mythic Keystone period. See {@link MythicKeystonePeriodResponse}.
1532
+ */
748
1533
  function mythicKeystonePeriod(mythicKeystonePeriodId) {
749
- return {
750
- namespace: "dynamic",
751
- path: `${base}/mythic-keystone/period/${mythicKeystonePeriodId}`
752
- };
753
- }
1534
+ return {
1535
+ namespace: "dynamic",
1536
+ path: `${base}/mythic-keystone/period/${mythicKeystonePeriodId}`
1537
+ };
1538
+ }
1539
+ /**
1540
+ * Get a Mythic Keystone period index.
1541
+ * @returns The Mythic Keystone period index. See {@link MythicKeystonePeriodIndexResponse}.
1542
+ */
754
1543
  function mythicKeystonePeriodIndex() {
755
- return {
756
- namespace: "dynamic",
757
- path: `${base}/mythic-keystone/period/index`
758
- };
759
- }
1544
+ return {
1545
+ namespace: "dynamic",
1546
+ path: `${base}/mythic-keystone/period/index`
1547
+ };
1548
+ }
1549
+ /**
1550
+ * Get a Mythic Keystone season by ID.
1551
+ * @param mythicKeystoneSeasonId The Mythic Keystone season ID.
1552
+ * @returns The Mythic Keystone season. See {@link MythicKeystoneSeasonResponse}.
1553
+ */
760
1554
  function mythicKeystoneSeason(mythicKeystoneSeasonId) {
761
- return {
762
- namespace: "dynamic",
763
- path: `${base}/mythic-keystone/season/${mythicKeystoneSeasonId}`
764
- };
765
- }
1555
+ return {
1556
+ namespace: "dynamic",
1557
+ path: `${base}/mythic-keystone/season/${mythicKeystoneSeasonId}`
1558
+ };
1559
+ }
1560
+ /**
1561
+ * Get a Mythic Keystone season index.
1562
+ * @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
1563
+ */
766
1564
  function mythicKeystoneSeasonIndex() {
767
- return {
768
- namespace: "dynamic",
769
- path: `${base}/mythic-keystone/season/index`
770
- };
1565
+ return {
1566
+ namespace: "dynamic",
1567
+ path: `${base}/mythic-keystone/season/index`
1568
+ };
771
1569
  }
772
1570
 
773
- // src/mythic-keystone-leaderboard/mythic-keystone-leaderboard.ts
1571
+ //#endregion
1572
+ //#region src/mythic-keystone-leaderboard/mythic-keystone-leaderboard.ts
1573
+ /**
1574
+ * Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
1575
+ * @param connectedRealmId The connected realm ID.
1576
+ * @param dungeonId The dungeon ID.
1577
+ * @param period The period ID.
1578
+ * @returns The Mythic Keystone leaderboard. See {@link MythicKeystoneLeaderboardResponse}.
1579
+ */
774
1580
  function mythicKeystoneLeaderboard(connectedRealmId, dungeonId, period) {
775
- return {
776
- namespace: "dynamic",
777
- path: `${base}/connected-realm/${connectedRealmId}/mythic-leaderboard/${dungeonId}/period/${period}`
778
- };
779
- }
1581
+ return {
1582
+ namespace: "dynamic",
1583
+ path: `${base}/connected-realm/${connectedRealmId}/mythic-leaderboard/${dungeonId}/period/${period}`
1584
+ };
1585
+ }
1586
+ /**
1587
+ * Get a Mythic Keystone leaderboard index by connected realm ID.
1588
+ * @param connectedRealmId The connected realm ID.
1589
+ * @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
1590
+ */
780
1591
  function mythicKeystoneLeaderboardIndex(connectedRealmId) {
781
- return {
782
- namespace: "dynamic",
783
- path: `${base}/connected-realm/${connectedRealmId}/mythic-leaderboard/index`
784
- };
1592
+ return {
1593
+ namespace: "dynamic",
1594
+ path: `${base}/connected-realm/${connectedRealmId}/mythic-leaderboard/index`
1595
+ };
785
1596
  }
786
1597
 
787
- // src/mythic-raid-leaderboard/mythic-raid-leaderboard.ts
1598
+ //#endregion
1599
+ //#region src/mythic-raid-leaderboard/mythic-raid-leaderboard.ts
1600
+ /**
1601
+ * Get a Mythic Raid leaderboard by raid and faction.
1602
+ * @param raid The slug of the raid.
1603
+ * @param faction The faction. Either 'alliance' or 'horde'.
1604
+ * @returns The Mythic Raid leaderboard. See {@link MythicRaidLeaderboardResponse}.
1605
+ */
788
1606
  function mythicRaidLeaderboard(raid, faction) {
789
- return {
790
- namespace: "dynamic",
791
- path: `${base}/leaderboard/hall-of-fame/${raid}/${faction}`
792
- };
1607
+ return {
1608
+ namespace: "dynamic",
1609
+ path: `${base}/leaderboard/hall-of-fame/${raid}/${faction}`
1610
+ };
793
1611
  }
794
1612
 
795
- // src/pet/pet.ts
1613
+ //#endregion
1614
+ //#region src/pet/pet.ts
1615
+ /**
1616
+ * Get a pet by ID.
1617
+ * @param petId The pet ID.
1618
+ * @returns The pet. See {@link PetResponse}.
1619
+ */
796
1620
  function pet(petId) {
797
- return {
798
- namespace: "static",
799
- path: `${base}/pet/${petId}`
800
- };
801
- }
1621
+ return {
1622
+ namespace: "static",
1623
+ path: `${base}/pet/${petId}`
1624
+ };
1625
+ }
1626
+ /**
1627
+ * Get a pet ability by ID.
1628
+ * @param petAbilityId The pet ability ID.
1629
+ * @returns The pet ability. See {@link PetAbilityResponse}.
1630
+ */
802
1631
  function petAbility(petAbilityId) {
803
- return {
804
- namespace: "static",
805
- path: `${base}/pet-ability/${petAbilityId}`
806
- };
807
- }
1632
+ return {
1633
+ namespace: "static",
1634
+ path: `${base}/pet-ability/${petAbilityId}`
1635
+ };
1636
+ }
1637
+ /**
1638
+ * Get a pet ability index.
1639
+ * @returns The pet ability index. See {@link PetAbilityIndexResponse}.
1640
+ */
808
1641
  function petAbilityIndex() {
809
- return {
810
- namespace: "static",
811
- path: `${base}/pet-ability/index`
812
- };
813
- }
1642
+ return {
1643
+ namespace: "static",
1644
+ path: `${base}/pet-ability/index`
1645
+ };
1646
+ }
1647
+ /**
1648
+ * Get a pet ability media by ID.
1649
+ * @param petAbilityId The pet ability ID.
1650
+ * @returns The pet ability media. See {@link PetAbilityMediaResponse}.
1651
+ */
814
1652
  function petAbilityMedia(petAbilityId) {
815
- return {
816
- namespace: "static",
817
- path: `${mediaBase}/pet-ability/${petAbilityId}`
818
- };
819
- }
1653
+ return {
1654
+ namespace: "static",
1655
+ path: `${mediaBase}/pet-ability/${petAbilityId}`
1656
+ };
1657
+ }
1658
+ /**
1659
+ * Get a pet index.
1660
+ * @returns The pet index. See {@link PetIndexResponse}.
1661
+ */
820
1662
  function petIndex() {
821
- return {
822
- namespace: "static",
823
- path: `${base}/pet/index`
824
- };
825
- }
1663
+ return {
1664
+ namespace: "static",
1665
+ path: `${base}/pet/index`
1666
+ };
1667
+ }
1668
+ /**
1669
+ * Get a pet media by ID.
1670
+ * @param petId The pet ID.
1671
+ * @returns The pet media. See {@link PetMediaResponse}.
1672
+ */
826
1673
  function petMedia(petId) {
827
- return {
828
- namespace: "static",
829
- path: `${mediaBase}/pet/${petId}`
830
- };
1674
+ return {
1675
+ namespace: "static",
1676
+ path: `${mediaBase}/pet/${petId}`
1677
+ };
831
1678
  }
832
1679
 
833
- // src/playable-class/playable-class.ts
1680
+ //#endregion
1681
+ //#region src/playable-class/playable-class.ts
1682
+ /**
1683
+ * Get a playable class by ID.
1684
+ * @param playableClassId The playable class ID.
1685
+ * @returns The playable class. See {@link PlayableClassResponse}.
1686
+ */
834
1687
  function playableClass(playableClassId) {
835
- return {
836
- namespace: "static",
837
- path: `${base}/playable-class/${playableClassId}`
838
- };
839
- }
1688
+ return {
1689
+ namespace: "static",
1690
+ path: `${base}/playable-class/${playableClassId}`
1691
+ };
1692
+ }
1693
+ /**
1694
+ * Get a playable class index.
1695
+ * @returns The playable class index. See {@link PlayableClassIndexResponse}.
1696
+ */
840
1697
  function playableClassIndex() {
841
- return {
842
- namespace: "static",
843
- path: `${base}/playable-class/index`
844
- };
845
- }
1698
+ return {
1699
+ namespace: "static",
1700
+ path: `${base}/playable-class/index`
1701
+ };
1702
+ }
1703
+ /**
1704
+ * Get playable class media by ID.
1705
+ * @param playableClassId The playable class ID.
1706
+ * @returns The playable class media. See {@link PlayableClassMediaResponse}.
1707
+ */
846
1708
  function playableClassMedia(playableClassId) {
847
- return {
848
- namespace: "static",
849
- path: `${mediaBase}/playable-class/${playableClassId}`
850
- };
851
- }
1709
+ return {
1710
+ namespace: "static",
1711
+ path: `${mediaBase}/playable-class/${playableClassId}`
1712
+ };
1713
+ }
1714
+ /**
1715
+ * Get a playable class's PvP talent slots by ID.
1716
+ * @param playableClassId The playable class ID.
1717
+ * @returns The playable class's PvP talent slots. See {@link PvpTalentSlotsResponse}.
1718
+ */
852
1719
  function pvpTalentSlots(playableClassId) {
853
- return {
854
- namespace: "static",
855
- path: `${base}/playable-class/${playableClassId}/pvp-talent-slots`
856
- };
1720
+ return {
1721
+ namespace: "static",
1722
+ path: `${base}/playable-class/${playableClassId}/pvp-talent-slots`
1723
+ };
857
1724
  }
858
1725
 
859
- // src/playable-race/playable-race.ts
1726
+ //#endregion
1727
+ //#region src/playable-race/playable-race.ts
1728
+ /**
1729
+ * Get a playable race by ID.
1730
+ * @param playableRaceId The playable race ID.
1731
+ * @returns The playable race. See {@link PlayableRaceResponse}.
1732
+ */
860
1733
  function playableRace(playableRaceId) {
861
- return {
862
- namespace: "static",
863
- path: `${base}/playable-race/${playableRaceId}`
864
- };
865
- }
1734
+ return {
1735
+ namespace: "static",
1736
+ path: `${base}/playable-race/${playableRaceId}`
1737
+ };
1738
+ }
1739
+ /**
1740
+ * Get a playable race index.
1741
+ * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
1742
+ */
866
1743
  function playableRaceIndex() {
867
- return {
868
- namespace: "static",
869
- path: `${base}/playable-race/index`
870
- };
1744
+ return {
1745
+ namespace: "static",
1746
+ path: `${base}/playable-race/index`
1747
+ };
871
1748
  }
872
1749
 
873
- // src/playable-specialization/playable-specialization.ts
1750
+ //#endregion
1751
+ //#region src/playable-specialization/playable-specialization.ts
1752
+ /**
1753
+ * Get a playable specialization by ID.
1754
+ * @param specializationId The playable specialization ID.
1755
+ * @returns The playable specialization. See {@link PlayableSpecializationResponse}.
1756
+ */
874
1757
  function playableSpecialization(specializationId) {
875
- return {
876
- namespace: "static",
877
- path: `${base}/playable-specialization/${specializationId}`
878
- };
879
- }
1758
+ return {
1759
+ namespace: "static",
1760
+ path: `${base}/playable-specialization/${specializationId}`
1761
+ };
1762
+ }
1763
+ /**
1764
+ * Get a playable specialization index.
1765
+ * @returns The playable specialization index. See {@link PlayableSpecializationIndexResponse}.
1766
+ */
880
1767
  function playableSpecializationIndex() {
881
- return {
882
- namespace: "static",
883
- path: `${base}/playable-specialization/index`
884
- };
885
- }
1768
+ return {
1769
+ namespace: "static",
1770
+ path: `${base}/playable-specialization/index`
1771
+ };
1772
+ }
1773
+ /**
1774
+ * Get a playable specialization media by ID.
1775
+ * @param specializationId The playable specialization ID.
1776
+ * @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
1777
+ */
886
1778
  function playableSpecializationMedia(specializationId) {
887
- return {
888
- namespace: "static",
889
- path: `${mediaBase}/playable-specialization/${specializationId}`
890
- };
1779
+ return {
1780
+ namespace: "static",
1781
+ path: `${mediaBase}/playable-specialization/${specializationId}`
1782
+ };
891
1783
  }
892
1784
 
893
- // src/power-type/power-type.ts
1785
+ //#endregion
1786
+ //#region src/power-type/power-type.ts
1787
+ /**
1788
+ * Get a power type by ID.
1789
+ * @param powerTypeId The power type ID.
1790
+ * @returns The power type. See {@link PowerTypeResponse}.
1791
+ */
894
1792
  function powerType(powerTypeId) {
895
- return {
896
- namespace: "static",
897
- path: `${base}/power-type/${powerTypeId}`
898
- };
899
- }
1793
+ return {
1794
+ namespace: "static",
1795
+ path: `${base}/power-type/${powerTypeId}`
1796
+ };
1797
+ }
1798
+ /**
1799
+ * Get a power type index.
1800
+ * @returns The power type index. See {@link PowerTypeIndexResponse}.
1801
+ */
900
1802
  function powerTypeIndex() {
901
- return {
902
- namespace: "static",
903
- path: `${base}/power-type/index`
904
- };
1803
+ return {
1804
+ namespace: "static",
1805
+ path: `${base}/power-type/index`
1806
+ };
905
1807
  }
906
1808
 
907
- // src/profession/profession.ts
1809
+ //#endregion
1810
+ //#region src/profession/profession.ts
1811
+ /**
1812
+ * Get a profession by ID.
1813
+ * @param professionId The profession ID.
1814
+ * @returns The profession. See {@link ProfessionResponse}.
1815
+ */
908
1816
  function profession(professionId) {
909
- return {
910
- namespace: "static",
911
- path: `${base}/profession/${professionId}`
912
- };
913
- }
1817
+ return {
1818
+ namespace: "static",
1819
+ path: `${base}/profession/${professionId}`
1820
+ };
1821
+ }
1822
+ /**
1823
+ * Get a profession index.
1824
+ * @returns The profession index. See {@link ProfessionIndexResponse}.
1825
+ */
914
1826
  function professionIndex() {
915
- return {
916
- namespace: "static",
917
- path: `${base}/profession/index`
918
- };
919
- }
1827
+ return {
1828
+ namespace: "static",
1829
+ path: `${base}/profession/index`
1830
+ };
1831
+ }
1832
+ /**
1833
+ * Get profession media by ID.
1834
+ * @param professionId The profession ID.
1835
+ * @returns The profession media. See {@link ProfessionMediaResponse}.
1836
+ */
920
1837
  function professionMedia(professionId) {
921
- return {
922
- namespace: "static",
923
- path: `${mediaBase}/profession/${professionId}`
924
- };
925
- }
1838
+ return {
1839
+ namespace: "static",
1840
+ path: `${mediaBase}/profession/${professionId}`
1841
+ };
1842
+ }
1843
+ /**
1844
+ * Get a profession's skill tier by ID.
1845
+ * @param professionId The profession ID.
1846
+ * @param skillTierId The skill tier ID.
1847
+ * @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
1848
+ */
926
1849
  function professionSkillTier(professionId, skillTierId) {
927
- return {
928
- namespace: "static",
929
- path: `${base}/profession/${professionId}/skill-tier/${skillTierId}`
930
- };
931
- }
1850
+ return {
1851
+ namespace: "static",
1852
+ path: `${base}/profession/${professionId}/skill-tier/${skillTierId}`
1853
+ };
1854
+ }
1855
+ /**
1856
+ * Get a recipe by ID.
1857
+ * @param recipeId The recipe ID.
1858
+ * @returns The recipe. See {@link RecipeResponse}.
1859
+ */
932
1860
  function recipe(recipeId) {
933
- return {
934
- namespace: "static",
935
- path: `${base}/recipe/${recipeId}`
936
- };
937
- }
1861
+ return {
1862
+ namespace: "static",
1863
+ path: `${base}/recipe/${recipeId}`
1864
+ };
1865
+ }
1866
+ /**
1867
+ * Get recipe media by ID.
1868
+ * @param recipeId The recipe ID.
1869
+ * @returns The recipe media. See {@link RecipeMediaResponse}.
1870
+ */
938
1871
  function recipeMedia(recipeId) {
939
- return {
940
- namespace: "static",
941
- path: `${mediaBase}/recipe/${recipeId}`
942
- };
1872
+ return {
1873
+ namespace: "static",
1874
+ path: `${mediaBase}/recipe/${recipeId}`
1875
+ };
943
1876
  }
944
1877
 
945
- // src/pvp-season/pvp-season.ts
1878
+ //#endregion
1879
+ //#region src/pvp-season/pvp-season.ts
1880
+ /**
1881
+ * Get a PvP leaderboard by PvP season ID and bracket.
1882
+ * @param pvpSeasonId The PvP season ID.
1883
+ * @param bracket The PvP bracket.
1884
+ * @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
1885
+ */
946
1886
  function pvpLeaderboard(pvpSeasonId, bracket) {
947
- return {
948
- namespace: "dynamic",
949
- path: `${base}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${bracket}`
950
- };
951
- }
1887
+ return {
1888
+ namespace: "dynamic",
1889
+ path: `${base}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${bracket}`
1890
+ };
1891
+ }
1892
+ /**
1893
+ * Get a PvP leaderboard index by PvP season ID.
1894
+ * @param pvpSeasonId The PvP season ID.
1895
+ * @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
1896
+ */
952
1897
  function pvpLeaderboardIndex(pvpSeasonId) {
953
- return {
954
- namespace: "dynamic",
955
- path: `${base}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`
956
- };
957
- }
1898
+ return {
1899
+ namespace: "dynamic",
1900
+ path: `${base}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`
1901
+ };
1902
+ }
1903
+ /**
1904
+ * Get a PvP reward index by PvP season ID.
1905
+ * @param pvpSeasonId The PvP season ID.
1906
+ * @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
1907
+ */
958
1908
  function pvpRewardsIndex(pvpSeasonId) {
959
- return {
960
- namespace: "dynamic",
961
- path: `${base}/pvp-season/${pvpSeasonId}/pvp-reward/index`
962
- };
963
- }
1909
+ return {
1910
+ namespace: "dynamic",
1911
+ path: `${base}/pvp-season/${pvpSeasonId}/pvp-reward/index`
1912
+ };
1913
+ }
1914
+ /**
1915
+ * Get a PvP season by ID.
1916
+ * @param pvpSeasonId The PvP season ID.
1917
+ * @returns The PvP season. See {@link PvpSeasonResponse}.
1918
+ */
964
1919
  function pvpSeason(pvpSeasonId) {
965
- return {
966
- namespace: "dynamic",
967
- path: `${base}/pvp-season/${pvpSeasonId}`
968
- };
969
- }
1920
+ return {
1921
+ namespace: "dynamic",
1922
+ path: `${base}/pvp-season/${pvpSeasonId}`
1923
+ };
1924
+ }
1925
+ /**
1926
+ * Get a PvP season index.
1927
+ * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
1928
+ */
970
1929
  function pvpSeasonIndex() {
971
- return {
972
- namespace: "dynamic",
973
- path: `${base}/pvp-season/index`
974
- };
1930
+ return {
1931
+ namespace: "dynamic",
1932
+ path: `${base}/pvp-season/index`
1933
+ };
975
1934
  }
976
1935
 
977
- // src/pvp-tier/pvp-tier.ts
1936
+ //#endregion
1937
+ //#region src/pvp-tier/pvp-tier.ts
1938
+ /**
1939
+ * Get a PvP tier by ID.
1940
+ * @param pvpTierId The PvP tier ID.
1941
+ * @returns The PvP tier. See {@link PvpTierResponse}.
1942
+ */
978
1943
  function pvpTier(pvpTierId) {
979
- return {
980
- namespace: "static",
981
- path: `${base}/pvp-tier/${pvpTierId}`
982
- };
983
- }
1944
+ return {
1945
+ namespace: "static",
1946
+ path: `${base}/pvp-tier/${pvpTierId}`
1947
+ };
1948
+ }
1949
+ /**
1950
+ * Get a PvP tier index.
1951
+ * @returns The PvP tier index. See {@link PvpTierIndexResponse}.
1952
+ */
984
1953
  function pvpTierIndex() {
985
- return {
986
- namespace: "static",
987
- path: `${base}/pvp-tier/index`
988
- };
989
- }
1954
+ return {
1955
+ namespace: "static",
1956
+ path: `${base}/pvp-tier/index`
1957
+ };
1958
+ }
1959
+ /**
1960
+ * Get PvP tier media by ID.
1961
+ * @param pvpTierId The PvP tier ID.
1962
+ * @returns The PvP tier media. See {@link PvpTierMediaResponse}.
1963
+ */
990
1964
  function pvpTierMedia(pvpTierId) {
991
- return {
992
- namespace: "static",
993
- path: `${mediaBase}/pvp-tier/${pvpTierId}`
994
- };
1965
+ return {
1966
+ namespace: "static",
1967
+ path: `${mediaBase}/pvp-tier/${pvpTierId}`
1968
+ };
995
1969
  }
996
1970
 
997
- // src/quest/quest.ts
1971
+ //#endregion
1972
+ //#region src/quest/quest.ts
1973
+ /**
1974
+ * Get a quest by ID.
1975
+ * @param questId The quest ID.
1976
+ * @returns The quest. See {@link QuestResponse}.
1977
+ */
998
1978
  function quest(questId) {
999
- return {
1000
- namespace: "static",
1001
- path: `${base}/quest/${questId}`
1002
- };
1003
- }
1979
+ return {
1980
+ namespace: "static",
1981
+ path: `${base}/quest/${questId}`
1982
+ };
1983
+ }
1984
+ /**
1985
+ * Get a quest area by ID.
1986
+ * @param questAreaId The quest area ID.
1987
+ * @returns The quest area. See {@link QuestAreaResponse}.
1988
+ */
1004
1989
  function questArea(questAreaId) {
1005
- return {
1006
- namespace: "static",
1007
- path: `${base}/quest/area/${questAreaId}`
1008
- };
1009
- }
1990
+ return {
1991
+ namespace: "static",
1992
+ path: `${base}/quest/area/${questAreaId}`
1993
+ };
1994
+ }
1995
+ /**
1996
+ * Get a quest area index.
1997
+ * @returns The quest area index. See {@link QuestAreaIndexResponse}.
1998
+ */
1010
1999
  function questAreaIndex() {
1011
- return {
1012
- namespace: "static",
1013
- path: `${base}/quest/area/index`
1014
- };
1015
- }
2000
+ return {
2001
+ namespace: "static",
2002
+ path: `${base}/quest/area/index`
2003
+ };
2004
+ }
2005
+ /**
2006
+ * Get a quest category by ID.
2007
+ * @param questCategoryId The quest category ID.
2008
+ * @returns The quest category. See {@link QuestCategoryResponse}.
2009
+ */
1016
2010
  function questCategory(questCategoryId) {
1017
- return {
1018
- namespace: "static",
1019
- path: `${base}/quest/category/${questCategoryId}`
1020
- };
1021
- }
2011
+ return {
2012
+ namespace: "static",
2013
+ path: `${base}/quest/category/${questCategoryId}`
2014
+ };
2015
+ }
2016
+ /**
2017
+ * Get a quest category index.
2018
+ * @returns The quest category index. See {@link QuestCategoryIndexResponse}.
2019
+ */
1022
2020
  function questCategoryIndex() {
1023
- return {
1024
- namespace: "static",
1025
- path: `${base}/quest/category/index`
1026
- };
1027
- }
2021
+ return {
2022
+ namespace: "static",
2023
+ path: `${base}/quest/category/index`
2024
+ };
2025
+ }
2026
+ /**
2027
+ * Get a quest index.
2028
+ * @returns The quest index. See {@link QuestIndexResponse}.
2029
+ */
1028
2030
  function questIndex() {
1029
- return {
1030
- namespace: "static",
1031
- path: `${base}/quest/index`
1032
- };
1033
- }
2031
+ return {
2032
+ namespace: "static",
2033
+ path: `${base}/quest/index`
2034
+ };
2035
+ }
2036
+ /**
2037
+ * Get a quest type by ID.
2038
+ * @param questTypeId The quest type ID.
2039
+ * @returns The quest type. See {@link QuestTypeResponse}.
2040
+ */
1034
2041
  function questType(questTypeId) {
1035
- return {
1036
- namespace: "static",
1037
- path: `${base}/quest/type/${questTypeId}`
1038
- };
1039
- }
2042
+ return {
2043
+ namespace: "static",
2044
+ path: `${base}/quest/type/${questTypeId}`
2045
+ };
2046
+ }
2047
+ /**
2048
+ * Get a quest type index.
2049
+ * @returns The quest type index. See {@link QuestTypeIndexResponse}.
2050
+ */
1040
2051
  function questTypeIndex() {
1041
- return {
1042
- namespace: "static",
1043
- path: `${base}/quest/type/index`
1044
- };
2052
+ return {
2053
+ namespace: "static",
2054
+ path: `${base}/quest/type/index`
2055
+ };
1045
2056
  }
1046
2057
 
1047
- // src/realm/realm.ts
2058
+ //#endregion
2059
+ //#region src/realm/realm.ts
2060
+ /**
2061
+ * Get a realm by slug.
2062
+ * @param realmSlug The realm slug.
2063
+ * @returns The realm. See {@link RealmResponse}.
2064
+ */
1048
2065
  function realm(realmSlug) {
1049
- return {
1050
- namespace: "dynamic",
1051
- path: `${base}/realm/${realmSlug}`
1052
- };
1053
- }
2066
+ return {
2067
+ namespace: "dynamic",
2068
+ path: `${base}/realm/${realmSlug}`
2069
+ };
2070
+ }
2071
+ /**
2072
+ * Get a realm index.
2073
+ * @returns The realm index. See {@link RealmIndexResponse}.
2074
+ */
1054
2075
  function realmIndex() {
1055
- return {
1056
- namespace: "dynamic",
1057
- path: `${base}/realm/index`
1058
- };
1059
- }
2076
+ return {
2077
+ namespace: "dynamic",
2078
+ path: `${base}/realm/index`
2079
+ };
2080
+ }
2081
+ /**
2082
+ * Search for realms.
2083
+ * @param options The search parameters. See {@link RealmSearchParameters}.
2084
+ * @returns The search results. See {@link SearchResponse}.
2085
+ */
1060
2086
  function realmSearch(options) {
1061
- return {
1062
- namespace: "dynamic",
1063
- parameters: {
1064
- _page: options._page,
1065
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
1066
- timezone: options.timezone
1067
- },
1068
- path: `${searchBase}/realm`
1069
- };
1070
- }
1071
-
1072
- // src/region/region.ts
1073
- function region(regionId) {
1074
- return {
1075
- namespace: "dynamic",
1076
- path: `${base}/region/${regionId}`
1077
- };
2087
+ return {
2088
+ namespace: "dynamic",
2089
+ parameters: {
2090
+ _page: options._page,
2091
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
2092
+ timezone: options.timezone
2093
+ },
2094
+ path: `${searchBase}/realm`
2095
+ };
1078
2096
  }
2097
+
2098
+ //#endregion
2099
+ //#region src/region/region.ts
2100
+ /**
2101
+ * Get a region by ID.
2102
+ * @param regionId The region ID.
2103
+ * @returns The region. See {@link RegionResponse}.
2104
+ */
2105
+ function region(regionId) {
2106
+ return {
2107
+ namespace: "dynamic",
2108
+ path: `${base}/region/${regionId}`
2109
+ };
2110
+ }
2111
+ /**
2112
+ * Get a region index.
2113
+ * @returns The region index. See {@link RegionIndexResponse}.
2114
+ */
1079
2115
  function regionIndex() {
1080
- return {
1081
- namespace: "dynamic",
1082
- path: `${base}/region/index`
1083
- };
2116
+ return {
2117
+ namespace: "dynamic",
2118
+ path: `${base}/region/index`
2119
+ };
1084
2120
  }
1085
2121
 
1086
- // src/reputations/reputations.ts
2122
+ //#endregion
2123
+ //#region src/reputations/reputations.ts
2124
+ /**
2125
+ * Get a reputation faction by ID.
2126
+ * @param reputationFactionId The reputation faction ID.
2127
+ * @returns The reputation faction. See {@link ReputationFactionResponse}.
2128
+ */
1087
2129
  function reputationFaction(reputationFactionId) {
1088
- return {
1089
- namespace: "static",
1090
- path: `${base}/reputation-faction/${reputationFactionId}`
1091
- };
1092
- }
2130
+ return {
2131
+ namespace: "static",
2132
+ path: `${base}/reputation-faction/${reputationFactionId}`
2133
+ };
2134
+ }
2135
+ /**
2136
+ * Get a reputation faction index.
2137
+ * @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
2138
+ */
1093
2139
  function reputationFactionIndex() {
1094
- return {
1095
- namespace: "static",
1096
- path: `${base}/reputation-faction/index`
1097
- };
1098
- }
2140
+ return {
2141
+ namespace: "static",
2142
+ path: `${base}/reputation-faction/index`
2143
+ };
2144
+ }
2145
+ /**
2146
+ * Get a reputation tier by ID.
2147
+ * @param reputationTiersId The reputation tier ID.
2148
+ * @returns The reputation tier. See {@link ReputationTiersResponse}.
2149
+ */
1099
2150
  function reputationTiers(reputationTiersId) {
1100
- return {
1101
- namespace: "static",
1102
- path: `${base}/reputation-tiers/${reputationTiersId}`
1103
- };
1104
- }
2151
+ return {
2152
+ namespace: "static",
2153
+ path: `${base}/reputation-tiers/${reputationTiersId}`
2154
+ };
2155
+ }
2156
+ /**
2157
+ * Get a reputation tier index.
2158
+ * @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
2159
+ */
1105
2160
  function reputationTiersIndex() {
1106
- return {
1107
- namespace: "static",
1108
- path: `${base}/reputation-tiers/index`
1109
- };
2161
+ return {
2162
+ namespace: "static",
2163
+ path: `${base}/reputation-tiers/index`
2164
+ };
1110
2165
  }
1111
2166
 
1112
- // src/spell/spell.ts
2167
+ //#endregion
2168
+ //#region src/spell/spell.ts
2169
+ /**
2170
+ * Get a spell by ID.
2171
+ * @param spellId The spell ID.
2172
+ * @returns The spell. See {@link SpellResponse}.
2173
+ */
1113
2174
  function spell(spellId) {
1114
- return {
1115
- namespace: "static",
1116
- path: `${base}/spell/${spellId}`
1117
- };
1118
- }
2175
+ return {
2176
+ namespace: "static",
2177
+ path: `${base}/spell/${spellId}`
2178
+ };
2179
+ }
2180
+ /**
2181
+ * Get spell media by ID.
2182
+ * @param spellId The spell ID.
2183
+ * @returns The spell media. See {@link SpellMediaResponse}.
2184
+ */
1119
2185
  function spellMedia(spellId) {
1120
- return {
1121
- namespace: "static",
1122
- path: `${mediaBase}/spell/${spellId}`
1123
- };
1124
- }
2186
+ return {
2187
+ namespace: "static",
2188
+ path: `${mediaBase}/spell/${spellId}`
2189
+ };
2190
+ }
2191
+ /**
2192
+ * Get a spell search.
2193
+ * @param options The spell search options. See {@link SpellSearchParameters}.
2194
+ * @returns The spell search. See {@link SearchResponse}.
2195
+ */
1125
2196
  function spellSearch(options) {
1126
- return {
1127
- namespace: "static",
1128
- parameters: {
1129
- _page: options._page,
1130
- [`name.${options.locale}`]: options.name,
1131
- orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
1132
- },
1133
- path: `${searchBase}/spell`
1134
- };
1135
- }
1136
-
1137
- // src/talent/talent.ts
1138
- function pvpTalent(pvpTalentId) {
1139
- return {
1140
- namespace: "static",
1141
- path: `${base}/pvp-talent/${pvpTalentId}`
1142
- };
2197
+ return {
2198
+ namespace: "static",
2199
+ parameters: {
2200
+ _page: options._page,
2201
+ [`name.${options.locale}`]: options.name,
2202
+ orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
2203
+ },
2204
+ path: `${searchBase}/spell`
2205
+ };
1143
2206
  }
2207
+
2208
+ //#endregion
2209
+ //#region src/talent/talent.ts
2210
+ /**
2211
+ * Get a PvP talent by ID.
2212
+ * @param pvpTalentId The PvP talent ID.
2213
+ * @returns The PvP talent. See {@link PvpTalentResponse}.
2214
+ */
2215
+ function pvpTalent(pvpTalentId) {
2216
+ return {
2217
+ namespace: "static",
2218
+ path: `${base}/pvp-talent/${pvpTalentId}`
2219
+ };
2220
+ }
2221
+ /**
2222
+ * Get a PvP talent index.
2223
+ * @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
2224
+ */
1144
2225
  function pvpTalentIndex() {
1145
- return {
1146
- namespace: "static",
1147
- path: `${base}/pvp-talent/index`
1148
- };
1149
- }
2226
+ return {
2227
+ namespace: "static",
2228
+ path: `${base}/pvp-talent/index`
2229
+ };
2230
+ }
2231
+ /**
2232
+ * Get a talent by ID.
2233
+ * @param talentId The talent ID.
2234
+ * @returns The talent. See {@link TalentResponse}.
2235
+ */
1150
2236
  function talent(talentId) {
1151
- return {
1152
- namespace: "static",
1153
- path: `${base}/talent/${talentId}`
1154
- };
1155
- }
2237
+ return {
2238
+ namespace: "static",
2239
+ path: `${base}/talent/${talentId}`
2240
+ };
2241
+ }
2242
+ /**
2243
+ * Get a talent index.
2244
+ * @returns The talent index. See {@link TalentIndexResponse}.
2245
+ */
1156
2246
  function talentIndex() {
1157
- return {
1158
- namespace: "static",
1159
- path: `${base}/talent/index`
1160
- };
1161
- }
2247
+ return {
2248
+ namespace: "static",
2249
+ path: `${base}/talent/index`
2250
+ };
2251
+ }
2252
+ /**
2253
+ * Get a talent tree by ID.
2254
+ * @param talentTreeId The talent tree ID.
2255
+ * @param specId The playable specialization ID.
2256
+ * @returns The talent tree. See {@link TalentTreeResponse}.
2257
+ */
1162
2258
  function talentTree(talentTreeId, specId) {
1163
- return {
1164
- namespace: "static",
1165
- path: `${base}/talent-tree/${talentTreeId}/playable-specialization/${specId}`
1166
- };
1167
- }
2259
+ return {
2260
+ namespace: "static",
2261
+ path: `${base}/talent-tree/${talentTreeId}/playable-specialization/${specId}`
2262
+ };
2263
+ }
2264
+ /**
2265
+ * Get a talent tree index.
2266
+ * @returns The talent tree index. See {@link TalentTreeIndexResponse}.
2267
+ */
1168
2268
  function talentTreeIndex() {
1169
- return {
1170
- namespace: "static",
1171
- path: `${base}/talent-tree/index`
1172
- };
1173
- }
2269
+ return {
2270
+ namespace: "static",
2271
+ path: `${base}/talent-tree/index`
2272
+ };
2273
+ }
2274
+ /**
2275
+ * Get talent tree nodes by talent tree ID.
2276
+ * @param talentTreeId The talent tree ID.
2277
+ * @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
2278
+ */
1174
2279
  function talentTreeNodes(talentTreeId) {
1175
- return {
1176
- namespace: "static",
1177
- path: `${base}/talent-tree/${talentTreeId}`
1178
- };
2280
+ return {
2281
+ namespace: "static",
2282
+ path: `${base}/talent-tree/${talentTreeId}`
2283
+ };
1179
2284
  }
1180
2285
 
1181
- // src/tech-talent/tech-talent.ts
2286
+ //#endregion
2287
+ //#region src/tech-talent/tech-talent.ts
2288
+ /**
2289
+ * Get a tech talent by ID.
2290
+ * @param techTalentId The tech talent ID.
2291
+ * @returns The tech talent. See {@link TechTalentResponse}.
2292
+ */
1182
2293
  function techTalent(techTalentId) {
1183
- return {
1184
- namespace: "static",
1185
- path: `${base}/tech-talent/${techTalentId}`
1186
- };
1187
- }
2294
+ return {
2295
+ namespace: "static",
2296
+ path: `${base}/tech-talent/${techTalentId}`
2297
+ };
2298
+ }
2299
+ /**
2300
+ * Get a tech talent index.
2301
+ * @returns The tech talent index. See {@link TechTalentIndexResponse}.
2302
+ */
1188
2303
  function techTalentIndex() {
1189
- return {
1190
- namespace: "static",
1191
- path: `${base}/tech-talent/index`
1192
- };
1193
- }
2304
+ return {
2305
+ namespace: "static",
2306
+ path: `${base}/tech-talent/index`
2307
+ };
2308
+ }
2309
+ /**
2310
+ * Get tech talent media by ID.
2311
+ * @param techTalentId The tech talent ID.
2312
+ * @returns The tech talent media. See {@link TechTalentMediaResponse}.
2313
+ */
1194
2314
  function techTalentMedia(techTalentId) {
1195
- return {
1196
- namespace: "static",
1197
- path: `${mediaBase}/tech-talent/${techTalentId}`
1198
- };
1199
- }
2315
+ return {
2316
+ namespace: "static",
2317
+ path: `${mediaBase}/tech-talent/${techTalentId}`
2318
+ };
2319
+ }
2320
+ /**
2321
+ * Get a tech talent tree by ID.
2322
+ * @param techTalentTreeId The tech talent tree ID.
2323
+ * @returns The tech talent tree. See {@link TechTalentTreeResponse}.
2324
+ */
1200
2325
  function techTalentTree(techTalentTreeId) {
1201
- return {
1202
- namespace: "static",
1203
- path: `${base}/tech-talent-tree/${techTalentTreeId}`
1204
- };
1205
- }
2326
+ return {
2327
+ namespace: "static",
2328
+ path: `${base}/tech-talent-tree/${techTalentTreeId}`
2329
+ };
2330
+ }
2331
+ /**
2332
+ * Get a tech talent tree index.
2333
+ * @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
2334
+ */
1206
2335
  function techTalentTreeIndex() {
1207
- return {
1208
- namespace: "static",
1209
- path: `${base}/tech-talent-tree/index`
1210
- };
2336
+ return {
2337
+ namespace: "static",
2338
+ path: `${base}/tech-talent-tree/index`
2339
+ };
1211
2340
  }
1212
2341
 
1213
- // src/title/title.ts
2342
+ //#endregion
2343
+ //#region src/title/title.ts
2344
+ /**
2345
+ * Get a title by ID.
2346
+ * @param titleId The title ID.
2347
+ * @returns The title. See {@link TitleResponse}.
2348
+ */
1214
2349
  function title(titleId) {
1215
- return {
1216
- namespace: "static",
1217
- path: `${base}/title/${titleId}`
1218
- };
1219
- }
2350
+ return {
2351
+ namespace: "static",
2352
+ path: `${base}/title/${titleId}`
2353
+ };
2354
+ }
2355
+ /**
2356
+ * Get a title index.
2357
+ * @returns The title index. See {@link TitleIndexResponse}.
2358
+ */
1220
2359
  function titleIndex() {
1221
- return {
1222
- namespace: "static",
1223
- path: `${base}/title/index`
1224
- };
2360
+ return {
2361
+ namespace: "static",
2362
+ path: `${base}/title/index`
2363
+ };
1225
2364
  }
1226
2365
 
1227
- // src/toy/toy.ts
2366
+ //#endregion
2367
+ //#region src/toy/toy.ts
2368
+ /**
2369
+ * Get a toy by ID.
2370
+ * @param toyId The toy ID.
2371
+ * @returns The toy. See {@link ToyResponse}.
2372
+ */
1228
2373
  function toy(toyId) {
1229
- return {
1230
- namespace: "static",
1231
- path: `${base}/toy/${toyId}`
1232
- };
1233
- }
2374
+ return {
2375
+ namespace: "static",
2376
+ path: `${base}/toy/${toyId}`
2377
+ };
2378
+ }
2379
+ /**
2380
+ * Get a toy index.
2381
+ * @returns The toy index. See {@link ToyIndexResponse}.
2382
+ */
1234
2383
  function toyIndex() {
1235
- return {
1236
- namespace: "static",
1237
- path: `${base}/toy/index`
1238
- };
2384
+ return {
2385
+ namespace: "static",
2386
+ path: `${base}/toy/index`
2387
+ };
1239
2388
  }
1240
2389
 
1241
- // src/wow-token/wow-token.ts
2390
+ //#endregion
2391
+ //#region src/wow-token/wow-token.ts
2392
+ /**
2393
+ * Get the current WoW token price.
2394
+ * @returns The WoW token price. See {@link WowTokenResponse}.
2395
+ */
1242
2396
  function wowToken() {
1243
- return {
1244
- namespace: "dynamic",
1245
- path: `${base}/token/index`
1246
- };
1247
- }
1248
-
1249
- // src/index.ts
1250
- var wow = {
1251
- //Account Profile
1252
- accountCollectionsIndex,
1253
- accountHeirloomsCollectionSummary,
1254
- accountMountsCollectionSummary,
1255
- accountPetsCollectionSummary,
1256
- accountProfileSummary,
1257
- accountToysCollectionSummary,
1258
- accountTransmogsCollectionSummary,
1259
- protectedCharacterProfileSummary,
1260
- //Achievements
1261
- achievement,
1262
- achievementCategory,
1263
- achievementCategoryIndex,
1264
- achievementIndex,
1265
- achievementMedia,
1266
- //Auction House
1267
- auctions,
1268
- commodities,
1269
- //Azerite Essence
1270
- azeriteEssence,
1271
- azeriteEssenceIndex,
1272
- azeriteEssenceMedia,
1273
- azeriteEssenceSearch,
1274
- //Character Achievements
1275
- characterAchievementsSummary,
1276
- characterAchievementStatistics,
1277
- //Character Appearance
1278
- characterAppearanceSummary,
1279
- //Character Collections
1280
- characterCollectionsIndex,
1281
- characterHeirloomsCollectionSummary,
1282
- characterMountsCollectionSummary,
1283
- characterPetsCollectionSummary,
1284
- characterToysCollectionSummary,
1285
- characterTransmogCollectionSummary,
1286
- //Character Encounters
1287
- characterDungeons,
1288
- characterEncountersSummary,
1289
- characterRaids,
1290
- //Character Equipment
1291
- characterEquipmentSummary,
1292
- //Character Hunter Pets
1293
- characterHunterPetsSummary,
1294
- //Character Media
1295
- characterMediaSummary,
1296
- //Character Mythic Keystone Profile
1297
- characterMythicKeystoneProfileIndex,
1298
- characterMythicKeystoneSeasonDetails,
1299
- //Character Professions
1300
- characterProfessionsSummary,
1301
- //Character Profile
1302
- characterProfileStatus,
1303
- characterProfileSummary,
1304
- //Character PvP
1305
- characterPvpSummary,
1306
- //Character Quests
1307
- characterCompletedQuests,
1308
- characterQuests,
1309
- //Character Reputations
1310
- characterReputationsSummary,
1311
- //Character Soulbinds
1312
- characterSoulbinds,
1313
- //Character Specializations
1314
- characterSpecializationsSummary,
1315
- //Character Statistics
1316
- characterStatisticsSummary,
1317
- //Character Titles
1318
- characterTitlesSummary,
1319
- //Connected Realm
1320
- connectedRealm,
1321
- connectedRealmIndex,
1322
- connectedRealmSearch,
1323
- //Covenant
1324
- conduit,
1325
- conduitIndex,
1326
- covenant,
1327
- covenantIndex,
1328
- covenantMedia,
1329
- soulbind,
1330
- soulbindIndex,
1331
- //Creature
1332
- creature,
1333
- creatureDisplayMedia,
1334
- creatureFamily,
1335
- creatureFamilyIndex,
1336
- creatureFamilyMedia,
1337
- creatureSearch,
1338
- creatureType,
1339
- creatureTypeIndex,
1340
- //Guild
1341
- guild,
1342
- guildAchievements,
1343
- guildActivity,
1344
- guildRoster,
1345
- //Guild Crest
1346
- guildCrestBorder,
1347
- guildCrestComponentsIndex,
1348
- guildCrestEmblem,
1349
- //Heirloom
1350
- heirloom,
1351
- heirloomIndex,
1352
- //Item
1353
- item,
1354
- itemClass,
1355
- itemClassIndex,
1356
- itemMedia,
1357
- itemSearch,
1358
- itemSet,
1359
- itemSetIndex,
1360
- itemSubClass,
1361
- //Journal
1362
- journalEncounter,
1363
- journalEncounterIndex,
1364
- journalEncounterSearch,
1365
- journalExpansion,
1366
- journalExpansionIndex,
1367
- journalInstance,
1368
- journalInstanceIndex,
1369
- journalInstanceMedia,
1370
- //Media Search
1371
- mediaSearch,
1372
- //Modified Crafting
1373
- modifiedCraftingCategory,
1374
- modifiedCraftingCategoryIndex,
1375
- modifiedCraftingIndex,
1376
- modifiedCraftingReagentSlotType,
1377
- modifiedCraftingReagentSlotTypeIndex,
1378
- //Mount
1379
- mount,
1380
- mountIndex,
1381
- mountSearch,
1382
- //Mythic Keystone Affix
1383
- mythicKeystoneAffix,
1384
- mythicKeystoneAffixIndex,
1385
- mythicKeystoneAffixMedia,
1386
- //Mythic Keystone Dungeon
1387
- mythicKeystoneDungeon,
1388
- mythicKeystoneDungeonIndex,
1389
- mythicKeystoneIndex,
1390
- mythicKeystonePeriod,
1391
- mythicKeystonePeriodIndex,
1392
- mythicKeystoneSeason,
1393
- mythicKeystoneSeasonIndex,
1394
- //Mythic Keystone Leaderboard
1395
- mythicKeystoneLeaderboard,
1396
- mythicKeystoneLeaderboardIndex,
1397
- //Mythic Raid Leaderboard
1398
- mythicRaidLeaderboard,
1399
- //Pet
1400
- pet,
1401
- petAbility,
1402
- petAbilityIndex,
1403
- petAbilityMedia,
1404
- petIndex,
1405
- petMedia,
1406
- //Playable Class
1407
- playableClass,
1408
- playableClassIndex,
1409
- playableClassMedia,
1410
- pvpTalentSlots,
1411
- //Playable
1412
- playableRace,
1413
- playableRaceIndex,
1414
- //Playable Specialization
1415
- playableSpecialization,
1416
- playableSpecializationIndex,
1417
- playableSpecializationMedia,
1418
- //Power Type
1419
- powerType,
1420
- powerTypeIndex,
1421
- //Profession
1422
- profession,
1423
- professionIndex,
1424
- professionMedia,
1425
- professionSkillTier,
1426
- recipe,
1427
- recipeMedia,
1428
- //Pvp Season
1429
- pvpLeaderboard,
1430
- pvpLeaderboardIndex,
1431
- pvpRewardsIndex,
1432
- pvpSeason,
1433
- pvpSeasonIndex,
1434
- //Pvp Tier
1435
- pvpTier,
1436
- pvpTierIndex,
1437
- pvpTierMedia,
1438
- //Quest
1439
- quest,
1440
- questArea,
1441
- questAreaIndex,
1442
- questCategory,
1443
- questCategoryIndex,
1444
- questIndex,
1445
- questType,
1446
- questTypeIndex,
1447
- //Realm
1448
- realm,
1449
- realmIndex,
1450
- realmSearch,
1451
- //Region
1452
- region,
1453
- regionIndex,
1454
- //Reputations
1455
- reputationFaction,
1456
- reputationFactionIndex,
1457
- reputationTiers,
1458
- reputationTiersIndex,
1459
- //Spell
1460
- spell,
1461
- spellMedia,
1462
- spellSearch,
1463
- //Talent
1464
- pvpTalent,
1465
- pvpTalentIndex,
1466
- talentIndex,
1467
- talentTree,
1468
- talentTreeIndex,
1469
- talentTreeNodes,
1470
- //Tech Talent
1471
- techTalent,
1472
- techTalentIndex,
1473
- techTalentMedia,
1474
- techTalentTree,
1475
- techTalentTreeIndex,
1476
- //Title
1477
- title,
1478
- titleIndex,
1479
- //Toy
1480
- toy,
1481
- toyIndex,
1482
- //WoW Token
1483
- wowToken
2397
+ return {
2398
+ namespace: "dynamic",
2399
+ path: `${base}/token/index`
2400
+ };
2401
+ }
2402
+
2403
+ //#endregion
2404
+ //#region src/index.ts
2405
+ /**
2406
+
2407
+ * The Blizzard API for World of Warcraft.
2408
+
2409
+ * @see https://develop.battle.net/documentation/world-of-warcraft
2410
+
2411
+ */
2412
+ const wow = {
2413
+ accountCollectionsIndex,
2414
+ accountHeirloomsCollectionSummary,
2415
+ accountMountsCollectionSummary,
2416
+ accountPetsCollectionSummary,
2417
+ accountProfileSummary,
2418
+ accountToysCollectionSummary,
2419
+ accountTransmogsCollectionSummary,
2420
+ protectedCharacterProfileSummary,
2421
+ achievement,
2422
+ achievementCategory,
2423
+ achievementCategoryIndex,
2424
+ achievementIndex,
2425
+ achievementMedia,
2426
+ auctions,
2427
+ commodities,
2428
+ azeriteEssence,
2429
+ azeriteEssenceIndex,
2430
+ azeriteEssenceMedia,
2431
+ azeriteEssenceSearch,
2432
+ characterAchievementsSummary,
2433
+ characterAchievementStatistics,
2434
+ characterAppearanceSummary,
2435
+ characterCollectionsIndex,
2436
+ characterHeirloomsCollectionSummary,
2437
+ characterMountsCollectionSummary,
2438
+ characterPetsCollectionSummary,
2439
+ characterToysCollectionSummary,
2440
+ characterTransmogCollectionSummary,
2441
+ characterDungeons,
2442
+ characterEncountersSummary,
2443
+ characterRaids,
2444
+ characterEquipmentSummary,
2445
+ characterHunterPetsSummary,
2446
+ characterMediaSummary,
2447
+ characterMythicKeystoneProfileIndex,
2448
+ characterMythicKeystoneSeasonDetails,
2449
+ characterProfessionsSummary,
2450
+ characterProfileStatus,
2451
+ characterProfileSummary,
2452
+ characterPvpSummary,
2453
+ characterCompletedQuests,
2454
+ characterQuests,
2455
+ characterReputationsSummary,
2456
+ characterSoulbinds,
2457
+ characterSpecializationsSummary,
2458
+ characterStatisticsSummary,
2459
+ characterTitlesSummary,
2460
+ connectedRealm,
2461
+ connectedRealmIndex,
2462
+ connectedRealmSearch,
2463
+ conduit,
2464
+ conduitIndex,
2465
+ covenant,
2466
+ covenantIndex,
2467
+ covenantMedia,
2468
+ soulbind,
2469
+ soulbindIndex,
2470
+ creature,
2471
+ creatureDisplayMedia,
2472
+ creatureFamily,
2473
+ creatureFamilyIndex,
2474
+ creatureFamilyMedia,
2475
+ creatureSearch,
2476
+ creatureType,
2477
+ creatureTypeIndex,
2478
+ guild,
2479
+ guildAchievements,
2480
+ guildActivity,
2481
+ guildRoster,
2482
+ guildCrestBorder,
2483
+ guildCrestComponentsIndex,
2484
+ guildCrestEmblem,
2485
+ heirloom,
2486
+ heirloomIndex,
2487
+ item,
2488
+ itemClass,
2489
+ itemClassIndex,
2490
+ itemMedia,
2491
+ itemSearch,
2492
+ itemSet,
2493
+ itemSetIndex,
2494
+ itemSubClass,
2495
+ journalEncounter,
2496
+ journalEncounterIndex,
2497
+ journalEncounterSearch,
2498
+ journalExpansion,
2499
+ journalExpansionIndex,
2500
+ journalInstance,
2501
+ journalInstanceIndex,
2502
+ journalInstanceMedia,
2503
+ mediaSearch,
2504
+ modifiedCraftingCategory,
2505
+ modifiedCraftingCategoryIndex,
2506
+ modifiedCraftingIndex,
2507
+ modifiedCraftingReagentSlotType,
2508
+ modifiedCraftingReagentSlotTypeIndex,
2509
+ mount,
2510
+ mountIndex,
2511
+ mountSearch,
2512
+ mythicKeystoneAffix,
2513
+ mythicKeystoneAffixIndex,
2514
+ mythicKeystoneAffixMedia,
2515
+ mythicKeystoneDungeon,
2516
+ mythicKeystoneDungeonIndex,
2517
+ mythicKeystoneIndex,
2518
+ mythicKeystonePeriod,
2519
+ mythicKeystonePeriodIndex,
2520
+ mythicKeystoneSeason,
2521
+ mythicKeystoneSeasonIndex,
2522
+ mythicKeystoneLeaderboard,
2523
+ mythicKeystoneLeaderboardIndex,
2524
+ mythicRaidLeaderboard,
2525
+ pet,
2526
+ petAbility,
2527
+ petAbilityIndex,
2528
+ petAbilityMedia,
2529
+ petIndex,
2530
+ petMedia,
2531
+ playableClass,
2532
+ playableClassIndex,
2533
+ playableClassMedia,
2534
+ pvpTalentSlots,
2535
+ playableRace,
2536
+ playableRaceIndex,
2537
+ playableSpecialization,
2538
+ playableSpecializationIndex,
2539
+ playableSpecializationMedia,
2540
+ powerType,
2541
+ powerTypeIndex,
2542
+ profession,
2543
+ professionIndex,
2544
+ professionMedia,
2545
+ professionSkillTier,
2546
+ recipe,
2547
+ recipeMedia,
2548
+ pvpLeaderboard,
2549
+ pvpLeaderboardIndex,
2550
+ pvpRewardsIndex,
2551
+ pvpSeason,
2552
+ pvpSeasonIndex,
2553
+ pvpTier,
2554
+ pvpTierIndex,
2555
+ pvpTierMedia,
2556
+ quest,
2557
+ questArea,
2558
+ questAreaIndex,
2559
+ questCategory,
2560
+ questCategoryIndex,
2561
+ questIndex,
2562
+ questType,
2563
+ questTypeIndex,
2564
+ realm,
2565
+ realmIndex,
2566
+ realmSearch,
2567
+ region,
2568
+ regionIndex,
2569
+ reputationFaction,
2570
+ reputationFactionIndex,
2571
+ reputationTiers,
2572
+ reputationTiersIndex,
2573
+ spell,
2574
+ spellMedia,
2575
+ spellSearch,
2576
+ pvpTalent,
2577
+ pvpTalentIndex,
2578
+ talentIndex,
2579
+ talentTree,
2580
+ talentTreeIndex,
2581
+ talentTreeNodes,
2582
+ techTalent,
2583
+ techTalentIndex,
2584
+ techTalentMedia,
2585
+ techTalentTree,
2586
+ techTalentTreeIndex,
2587
+ title,
2588
+ titleIndex,
2589
+ toy,
2590
+ toyIndex,
2591
+ wowToken
1484
2592
  };
1485
2593
  var src_default = wow;
1486
2594
 
2595
+ //#endregion
1487
2596
  export { 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, src_default 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 };
1488
- //# sourceMappingURL=index.js.map
1489
2597
  //# sourceMappingURL=index.js.map