@blizzard-api/classic-wow 3.0.4 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/auction-house/index.d.ts +2 -0
- package/dist/auction-house/index.js +35 -0
- package/dist/auction-house/index.js.map +1 -0
- package/dist/character-achievements/index.d.ts +2 -0
- package/dist/character-achievements/index.js +30 -0
- package/dist/character-achievements/index.js.map +1 -0
- package/dist/character-equipment/index.d.ts +2 -0
- package/dist/character-equipment/index.js +19 -0
- package/dist/character-equipment/index.js.map +1 -0
- package/dist/character-hunter-pets/index.d.ts +2 -0
- package/dist/character-hunter-pets/index.js +19 -0
- package/dist/character-hunter-pets/index.js.map +1 -0
- package/dist/character-media/index.d.ts +2 -0
- package/dist/character-media/index.js +18 -0
- package/dist/character-media/index.js.map +1 -0
- package/dist/character-profile/index.d.ts +2 -0
- package/dist/character-profile/index.js +42 -0
- package/dist/character-profile/index.js.map +1 -0
- package/dist/character-specialization/index.d.ts +2 -0
- package/dist/character-specialization/index.js +18 -0
- package/dist/character-specialization/index.js.map +1 -0
- package/dist/character-statistics/index.d.ts +2 -0
- package/dist/character-statistics/index.js +18 -0
- package/dist/character-statistics/index.js.map +1 -0
- package/dist/connected-realm/index.d.ts +2 -0
- package/dist/connected-realm/index.js +47 -0
- package/dist/connected-realm/index.js.map +1 -0
- package/dist/creature/index.d.ts +2 -0
- package/dist/creature/index.js +105 -0
- package/dist/creature/index.js.map +1 -0
- package/dist/guild/index.d.ts +2 -0
- package/dist/guild/index.js +54 -0
- package/dist/guild/index.js.map +1 -0
- package/dist/guild-crest/index.d.ts +2 -0
- package/dist/guild-crest/index.js +41 -0
- package/dist/guild-crest/index.js.map +1 -0
- package/dist/index--VDjAqSZ.d.ts +23 -0
- package/dist/index-0TuKK7MU.d.ts +75 -0
- package/dist/index-B-LUShkQ.d.ts +167 -0
- package/dist/index-BHX6BR24.d.ts +163 -0
- package/dist/index-BQ-NY0vY.d.ts +128 -0
- package/dist/index-BZ8QSRSe.d.ts +90 -0
- package/dist/index-BrwXCy4D.d.ts +40 -0
- package/dist/index-BtfmrbYY.d.ts +31 -0
- package/dist/index-C7VwaWu6.d.ts +66 -0
- package/dist/index-Ce02MoQO.d.ts +37 -0
- package/dist/index-DDSvssGG.d.ts +59 -0
- package/dist/index-DSc_fuNb.d.ts +46 -0
- package/dist/index-DUgdQv4k.d.ts +36 -0
- package/dist/index-DajMx-uR.d.ts +143 -0
- package/dist/index-Djpr-_AW.d.ts +65 -0
- package/dist/index-DmVmLB_p.d.ts +51 -0
- package/dist/index-i0vuifJx.d.ts +33 -0
- package/dist/index-u8N9Fa6T.d.ts +290 -0
- package/dist/index-y_6cJbJi.d.ts +89 -0
- package/dist/index.d.ts +22 -1632
- package/dist/index.js +20 -753
- package/dist/index.js.map +1 -1
- package/dist/item/index.d.ts +2 -0
- package/dist/item/index.js +83 -0
- package/dist/item/index.js.map +1 -0
- package/dist/media-search/index.d.ts +2 -0
- package/dist/media-search/index.js +23 -0
- package/dist/media-search/index.js.map +1 -0
- package/dist/playable-class/index.d.ts +2 -0
- package/dist/playable-class/index.js +41 -0
- package/dist/playable-class/index.js.map +1 -0
- package/dist/playable-race/index.d.ts +2 -0
- package/dist/playable-race/index.js +29 -0
- package/dist/playable-race/index.js.map +1 -0
- package/dist/power-type/index.d.ts +2 -0
- package/dist/power-type/index.js +29 -0
- package/dist/power-type/index.js.map +1 -0
- package/dist/pvp-season/index.d.ts +2 -0
- package/dist/pvp-season/index.js +105 -0
- package/dist/pvp-season/index.js.map +1 -0
- package/dist/realm/index.d.ts +27 -0
- package/dist/realm/index.js +46 -0
- package/dist/realm/index.js.map +1 -0
- package/dist/region/index.d.ts +2 -0
- package/dist/region/index.js +29 -0
- package/dist/region/index.js.map +1 -0
- package/dist/types-gA98D5Xw.d.ts +79 -0
- package/package.json +16 -7
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { BlizzardNamespaces, Faction, Gender, Href, NameIdKey, Realm, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region ../wow/src/character-profile/types.d.ts
|
|
4
|
+
interface CharacterProfileStatusResponse extends ResponseBase {
|
|
5
|
+
id: number;
|
|
6
|
+
is_valid: boolean;
|
|
7
|
+
}
|
|
8
|
+
//#endregion
|
|
9
|
+
//#region src/character-profile/types.d.ts
|
|
10
|
+
interface CharacterProfileSummaryResponse extends ResponseBase {
|
|
11
|
+
achievement_points?: number;
|
|
12
|
+
achievements?: Href;
|
|
13
|
+
active_spec: NameIdKey;
|
|
14
|
+
active_title?: {
|
|
15
|
+
name: string;
|
|
16
|
+
};
|
|
17
|
+
appearance: Href;
|
|
18
|
+
average_item_level: number;
|
|
19
|
+
character_class: NameIdKey;
|
|
20
|
+
equipment: Href;
|
|
21
|
+
equipped_item_level: number;
|
|
22
|
+
experience: number;
|
|
23
|
+
faction: Faction;
|
|
24
|
+
gender: Gender;
|
|
25
|
+
guild?: Guild;
|
|
26
|
+
hunter_pets?: Href;
|
|
27
|
+
id: number;
|
|
28
|
+
is_ghost?: boolean;
|
|
29
|
+
is_self_found?: boolean;
|
|
30
|
+
last_login_timestamp: number;
|
|
31
|
+
level: number;
|
|
32
|
+
media: Href;
|
|
33
|
+
name: string;
|
|
34
|
+
pvp_summary: Href;
|
|
35
|
+
race: NameIdKey;
|
|
36
|
+
realm: Realm;
|
|
37
|
+
specializations: Href;
|
|
38
|
+
statistics: Href;
|
|
39
|
+
titles: Href;
|
|
40
|
+
}
|
|
41
|
+
interface Guild extends NameIdKey {
|
|
42
|
+
faction: Faction;
|
|
43
|
+
realm: Realm;
|
|
44
|
+
}
|
|
45
|
+
//#endregion
|
|
46
|
+
//#region src/character-profile/index.d.ts
|
|
47
|
+
/**
|
|
48
|
+
* 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:
|
|
49
|
+
* - an HTTP 404 Not Found error is returned
|
|
50
|
+
* - the is_valid value is false
|
|
51
|
+
* - the returned character ID doesn't match the previously recorded value for the character
|
|
52
|
+
*
|
|
53
|
+
* The following example illustrates how to use this endpoint:
|
|
54
|
+
*
|
|
55
|
+
* 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
|
|
56
|
+
* 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
|
|
57
|
+
* 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
|
|
58
|
+
* 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
|
|
59
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
60
|
+
* @param realmSlug The slug of the realm.
|
|
61
|
+
* @param characterName The lowercase name of the character.
|
|
62
|
+
* @returns the status of the character profile for a character.
|
|
63
|
+
*/
|
|
64
|
+
declare function characterProfileStatus(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<typeof namespace extends 'profile-classic1x' ? CharacterProfileStatusResponse : never>;
|
|
65
|
+
/**
|
|
66
|
+
* Returns a summary of the character profile for a character.
|
|
67
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
68
|
+
* @param realmSlug The slug of the realm.
|
|
69
|
+
* @param characterName The lowercase name of the character.
|
|
70
|
+
* @returns a summary of the character profile for a character.
|
|
71
|
+
*/
|
|
72
|
+
declare function characterProfileSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterProfileSummaryResponse>;
|
|
73
|
+
//#endregion
|
|
74
|
+
export { CharacterProfileStatusResponse as i, characterProfileSummary as n, CharacterProfileSummaryResponse as r, characterProfileStatus as t };
|
|
75
|
+
//# sourceMappingURL=index-0TuKK7MU.d.ts.map
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
import { BaseSearchParameters, BlizzardNamespaces, KeyBase, Locales, MediaAsset, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/creature/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The response for creature display media.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
*/
|
|
8
|
+
interface CreatureDisplayMediaResponse extends ResponseBase {
|
|
9
|
+
assets: Array<DisplayMediaAsset>;
|
|
10
|
+
id: number;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* The response for a creature family index.
|
|
14
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
15
|
+
*/
|
|
16
|
+
interface CreatureFamilyIndexResponse extends ResponseBase {
|
|
17
|
+
creature_families: Array<NameIdKey>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* The response for creature family media.
|
|
21
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
22
|
+
*/
|
|
23
|
+
interface CreatureFamilyMediaResponse extends ResponseBase {
|
|
24
|
+
assets: Array<MediaAsset>;
|
|
25
|
+
id: number;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* The response for a creature family.
|
|
29
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
30
|
+
*/
|
|
31
|
+
interface CreatureFamilyResponse extends ResponseBase {
|
|
32
|
+
id: number;
|
|
33
|
+
media?: Media;
|
|
34
|
+
name: string;
|
|
35
|
+
specialization?: NameIdKey;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* The response for a creature.
|
|
39
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
40
|
+
*/
|
|
41
|
+
interface CreatureResponse extends ResponseBase {
|
|
42
|
+
creature_displays: Array<CreatureDisplay>;
|
|
43
|
+
family: NameIdKey;
|
|
44
|
+
id: number;
|
|
45
|
+
is_tameable: boolean;
|
|
46
|
+
name: string;
|
|
47
|
+
type: NameIdKey;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* The search parameters for a creature.
|
|
51
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
52
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
53
|
+
*/
|
|
54
|
+
interface CreatureSearchParameters extends BaseSearchParameters {
|
|
55
|
+
locale: Locales;
|
|
56
|
+
name: string;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* The response for a creature search.
|
|
60
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
61
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
62
|
+
*/
|
|
63
|
+
interface CreatureSearchResponse extends SearchResponseWithoutResults {
|
|
64
|
+
results: Array<CreatureSearchResponseItem>;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* The response for a creature type index.
|
|
68
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
69
|
+
*/
|
|
70
|
+
interface CreatureTypeIndexResponse extends ResponseBase {
|
|
71
|
+
creature_types: Array<NameIdKey>;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* The response for a creature type.
|
|
75
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
76
|
+
*/
|
|
77
|
+
interface CreatureTypeResponse extends ResponseBase {
|
|
78
|
+
id: number;
|
|
79
|
+
name: string;
|
|
80
|
+
}
|
|
81
|
+
interface CreatureDisplay extends KeyBase {
|
|
82
|
+
id: number;
|
|
83
|
+
}
|
|
84
|
+
interface CreatureSearchResponseItem extends KeyBase {
|
|
85
|
+
data: {
|
|
86
|
+
creature_displays: Array<{
|
|
87
|
+
id: number;
|
|
88
|
+
}>;
|
|
89
|
+
family?: {
|
|
90
|
+
id: number;
|
|
91
|
+
name: Record<Locales, string>;
|
|
92
|
+
};
|
|
93
|
+
id: number;
|
|
94
|
+
is_tameable: boolean;
|
|
95
|
+
name: Record<Locales, string | undefined>;
|
|
96
|
+
type: {
|
|
97
|
+
id: number;
|
|
98
|
+
name: Record<Locales, string>;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
interface DisplayMediaAsset {
|
|
103
|
+
key: string;
|
|
104
|
+
value: string;
|
|
105
|
+
}
|
|
106
|
+
interface Media extends KeyBase {
|
|
107
|
+
id: number;
|
|
108
|
+
}
|
|
109
|
+
//#endregion
|
|
110
|
+
//#region src/creature/index.d.ts
|
|
111
|
+
/**
|
|
112
|
+
* Returns a creature by ID.
|
|
113
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
114
|
+
* @param creatureId The creature ID.
|
|
115
|
+
* @returns The creature. See {@link CreatureResponse}.
|
|
116
|
+
*/
|
|
117
|
+
declare function creature(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureId: number): Resource<CreatureResponse>;
|
|
118
|
+
/**
|
|
119
|
+
* Returns media for a creature display by ID.
|
|
120
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
121
|
+
* @param creatureDisplayId The creature display ID.
|
|
122
|
+
* @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
|
|
123
|
+
*/
|
|
124
|
+
declare function creatureDisplayMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureDisplayId: number): Resource<CreatureDisplayMediaResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* Returns a creature family by ID.
|
|
127
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
128
|
+
* @param creatureFamilyId The creature family ID.
|
|
129
|
+
* @returns The creature family. See {@link CreatureFamilyResponse}.
|
|
130
|
+
*/
|
|
131
|
+
declare function creatureFamily(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureFamilyId: number): Resource<CreatureFamilyResponse>;
|
|
132
|
+
/**
|
|
133
|
+
* Returns an index of creature families.
|
|
134
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
135
|
+
* @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
|
|
136
|
+
*/
|
|
137
|
+
declare function creatureFamilyIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<CreatureFamilyIndexResponse>;
|
|
138
|
+
/**
|
|
139
|
+
* Returns media for a creature family by ID.
|
|
140
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
141
|
+
* @param creatureFamilyId The creature family ID.
|
|
142
|
+
* @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
|
|
143
|
+
*/
|
|
144
|
+
declare function creatureFamilyMedia(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureFamilyId: number): Resource<CreatureFamilyMediaResponse>;
|
|
145
|
+
/**
|
|
146
|
+
* Performs a search of creatures.
|
|
147
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
148
|
+
* @param options The creature search parameters. See {@link CreatureSearchParameters}.
|
|
149
|
+
* @returns The creature search results. See {@link CreatureSearchResponse}.
|
|
150
|
+
*/
|
|
151
|
+
declare function creatureSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: CreatureSearchParameters): Resource<CreatureSearchResponse, Omit<CreatureSearchParameters, 'locale' | 'name'>>;
|
|
152
|
+
/**
|
|
153
|
+
* Returns a creature type by ID.
|
|
154
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
155
|
+
* @param creatureTypeId The creature type ID.
|
|
156
|
+
* @returns The creature type. See {@link CreatureTypeResponse}.
|
|
157
|
+
*/
|
|
158
|
+
declare function creatureType(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, creatureTypeId: number): Resource<CreatureTypeResponse>;
|
|
159
|
+
/**
|
|
160
|
+
* Returns an index of creature types.
|
|
161
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
162
|
+
* @returns The creature type index. See {@link CreatureTypeIndexResponse}.
|
|
163
|
+
*/
|
|
164
|
+
declare function creatureTypeIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<CreatureTypeIndexResponse>;
|
|
165
|
+
//#endregion
|
|
166
|
+
export { CreatureTypeResponse as _, creatureFamilyMedia as a, creatureTypeIndex as c, CreatureFamilyMediaResponse as d, CreatureFamilyResponse as f, CreatureTypeIndexResponse as g, CreatureSearchResponse as h, creatureFamilyIndex as i, CreatureDisplayMediaResponse as l, CreatureSearchParameters as m, creatureDisplayMedia as n, creatureSearch as o, CreatureResponse as p, creatureFamily as r, creatureType as s, creature as t, CreatureFamilyIndexResponse as u };
|
|
167
|
+
//# sourceMappingURL=index-B-LUShkQ.d.ts.map
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
import { BlizzardNamespaces, Character, Color, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/character-equipment/types.d.ts
|
|
4
|
+
interface CharacterEquipmentSummaryResponse extends ResponseBase {
|
|
5
|
+
character: Character;
|
|
6
|
+
equipped_item_sets: Array<Set>;
|
|
7
|
+
equipped_items: Array<EquippedItem>;
|
|
8
|
+
}
|
|
9
|
+
interface Armor {
|
|
10
|
+
display: NameDescription;
|
|
11
|
+
value: number;
|
|
12
|
+
}
|
|
13
|
+
interface Damage {
|
|
14
|
+
damage_class: NameType;
|
|
15
|
+
display_string: string;
|
|
16
|
+
max_value: number;
|
|
17
|
+
min_value: number;
|
|
18
|
+
}
|
|
19
|
+
interface DisplayStrings {
|
|
20
|
+
copper: string;
|
|
21
|
+
gold: string;
|
|
22
|
+
header: string;
|
|
23
|
+
silver: string;
|
|
24
|
+
}
|
|
25
|
+
interface DisplayStringValue {
|
|
26
|
+
display_string: string;
|
|
27
|
+
value: number;
|
|
28
|
+
}
|
|
29
|
+
interface Effect {
|
|
30
|
+
display_string: string;
|
|
31
|
+
is_active?: boolean;
|
|
32
|
+
required_count: number;
|
|
33
|
+
}
|
|
34
|
+
interface Enchantment {
|
|
35
|
+
display_string?: string;
|
|
36
|
+
enchantment_id: number;
|
|
37
|
+
enchantment_slot: EnchantmentSlot;
|
|
38
|
+
source_item?: NameIdKey;
|
|
39
|
+
spell?: {
|
|
40
|
+
description: string;
|
|
41
|
+
spell: NameIdKey;
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
interface EnchantmentSlot {
|
|
45
|
+
id: number;
|
|
46
|
+
type?: string;
|
|
47
|
+
}
|
|
48
|
+
interface EquippedItem {
|
|
49
|
+
armor?: Armor;
|
|
50
|
+
binding: NameType;
|
|
51
|
+
bonus_list?: Array<number>;
|
|
52
|
+
context?: number;
|
|
53
|
+
description?: string;
|
|
54
|
+
durability?: DisplayStringValue;
|
|
55
|
+
enchantments?: Array<Enchantment>;
|
|
56
|
+
inventory_type: NameType;
|
|
57
|
+
is_subclass_hidden?: boolean;
|
|
58
|
+
item: KeyBase & {
|
|
59
|
+
id: number;
|
|
60
|
+
};
|
|
61
|
+
item_class: NameIdKey;
|
|
62
|
+
item_subclass: NameIdKey;
|
|
63
|
+
level?: DisplayStringValue;
|
|
64
|
+
limit_category?: string;
|
|
65
|
+
media: KeyBase & {
|
|
66
|
+
id: number;
|
|
67
|
+
};
|
|
68
|
+
modified_appearance_id?: number;
|
|
69
|
+
modified_crafting_stat?: Array<ModifiedCraftingStat>;
|
|
70
|
+
name: string;
|
|
71
|
+
name_description?: NameDescription;
|
|
72
|
+
quality: NameType;
|
|
73
|
+
quantity: number;
|
|
74
|
+
requirements?: Requirements;
|
|
75
|
+
sell_price?: SellPrice;
|
|
76
|
+
set?: Set;
|
|
77
|
+
slot: NameType;
|
|
78
|
+
sockets?: Array<Socket>;
|
|
79
|
+
spells?: Array<Spell>;
|
|
80
|
+
stats?: Array<Stat>;
|
|
81
|
+
transmog?: Transmog;
|
|
82
|
+
unique_equipped?: string;
|
|
83
|
+
upgrade_id?: number;
|
|
84
|
+
weapon?: Weapon;
|
|
85
|
+
}
|
|
86
|
+
interface ItemElement {
|
|
87
|
+
is_equipped?: boolean;
|
|
88
|
+
item: NameIdKey;
|
|
89
|
+
}
|
|
90
|
+
interface ModifiedCraftingStat {
|
|
91
|
+
id: number;
|
|
92
|
+
name: string;
|
|
93
|
+
type: string;
|
|
94
|
+
}
|
|
95
|
+
interface NameDescription {
|
|
96
|
+
color: Color;
|
|
97
|
+
display_string: string;
|
|
98
|
+
}
|
|
99
|
+
interface NameType {
|
|
100
|
+
name: string;
|
|
101
|
+
type: string;
|
|
102
|
+
}
|
|
103
|
+
interface PlayableClasses {
|
|
104
|
+
display_string: string;
|
|
105
|
+
links: Array<NameIdKey>;
|
|
106
|
+
}
|
|
107
|
+
interface Requirements {
|
|
108
|
+
level: DisplayStringValue;
|
|
109
|
+
playable_classes?: PlayableClasses;
|
|
110
|
+
}
|
|
111
|
+
interface SellPrice {
|
|
112
|
+
display_strings: DisplayStrings;
|
|
113
|
+
value: number;
|
|
114
|
+
}
|
|
115
|
+
interface Set {
|
|
116
|
+
display_string?: string;
|
|
117
|
+
effects?: Array<Effect>;
|
|
118
|
+
item_set?: NameIdKey;
|
|
119
|
+
items?: Array<ItemElement>;
|
|
120
|
+
}
|
|
121
|
+
interface Socket {
|
|
122
|
+
display_string: string;
|
|
123
|
+
item: NameIdKey;
|
|
124
|
+
media: KeyBase & {
|
|
125
|
+
id: number;
|
|
126
|
+
};
|
|
127
|
+
socket_type: NameType;
|
|
128
|
+
}
|
|
129
|
+
interface Spell {
|
|
130
|
+
description: string;
|
|
131
|
+
display_color?: Color;
|
|
132
|
+
spell: NameIdKey;
|
|
133
|
+
}
|
|
134
|
+
interface Stat {
|
|
135
|
+
display: NameDescription;
|
|
136
|
+
is_equip_bonus?: boolean;
|
|
137
|
+
is_negated?: boolean;
|
|
138
|
+
type: NameType;
|
|
139
|
+
value: number;
|
|
140
|
+
}
|
|
141
|
+
interface Transmog {
|
|
142
|
+
display_string: string;
|
|
143
|
+
item: NameIdKey;
|
|
144
|
+
item_modified_appearance_id: number;
|
|
145
|
+
}
|
|
146
|
+
interface Weapon {
|
|
147
|
+
attack_speed: DisplayStringValue;
|
|
148
|
+
damage: Damage;
|
|
149
|
+
dps: DisplayStringValue;
|
|
150
|
+
}
|
|
151
|
+
//#endregion
|
|
152
|
+
//#region src/character-equipment/index.d.ts
|
|
153
|
+
/**
|
|
154
|
+
* Returns a summary of the items equipped by a character.
|
|
155
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
156
|
+
* @param realmSlug The realm slug.
|
|
157
|
+
* @param characterName The character name.
|
|
158
|
+
* @returns The character equipment summary.
|
|
159
|
+
*/
|
|
160
|
+
declare function characterEquipmentSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterEquipmentSummaryResponse>;
|
|
161
|
+
//#endregion
|
|
162
|
+
export { CharacterEquipmentSummaryResponse as n, characterEquipmentSummary as t };
|
|
163
|
+
//# sourceMappingURL=index-BHX6BR24.d.ts.map
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { c as RealmTypeCapitalized, r as RealmLocales, s as RealmTimezone, t as RealmCategory } from "./types-gA98D5Xw.js";
|
|
2
|
+
import { BaseSearchParameters, BlizzardNamespaces, Href, KeyBase, Locales, NameIdKey, Resource, ResponseBase, SearchResponseWithoutResults } from "@blizzard-api/core";
|
|
3
|
+
|
|
4
|
+
//#region src/connected-realm/types.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* Connected Realm Index API response.
|
|
7
|
+
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
8
|
+
*/
|
|
9
|
+
interface ConnectedRealmIndexResponse extends ResponseBase {
|
|
10
|
+
connected_realms: Array<Href>;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Connected Realm API response.
|
|
14
|
+
* @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
|
|
15
|
+
*/
|
|
16
|
+
interface ConnectedRealmResponse extends ResponseBase {
|
|
17
|
+
auctions: Href;
|
|
18
|
+
has_queue: boolean;
|
|
19
|
+
id: number;
|
|
20
|
+
population: {
|
|
21
|
+
name: string;
|
|
22
|
+
type: RealmPopulationCapitalized;
|
|
23
|
+
};
|
|
24
|
+
pvp_season?: Href;
|
|
25
|
+
realm_locked_status?: RealmLockedStatus;
|
|
26
|
+
realms: Array<Realm$1>;
|
|
27
|
+
status: {
|
|
28
|
+
name: string;
|
|
29
|
+
type: RealmStatusCapitalized;
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Connected Realm Search API parameters.
|
|
34
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
35
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
36
|
+
*/
|
|
37
|
+
interface ConnectedRealmSearchParameters extends BaseSearchParameters {
|
|
38
|
+
'realms.timezone'?: RealmTimezone;
|
|
39
|
+
'status.type'?: RealmStatusCapitalized;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Connected Realm Search API response item.
|
|
43
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
44
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
|
|
45
|
+
*/
|
|
46
|
+
interface ConnectedRealmSearchResponse extends SearchResponseWithoutResults {
|
|
47
|
+
results: Array<ConnectedRealmSearchResponseItem>;
|
|
48
|
+
}
|
|
49
|
+
interface ConnectedRealmSearchResponseItem extends KeyBase {
|
|
50
|
+
data: {
|
|
51
|
+
has_queue: boolean;
|
|
52
|
+
id: number;
|
|
53
|
+
population: SearchRealmPopulation;
|
|
54
|
+
realms: Array<SearchRealm>;
|
|
55
|
+
status: SearchRealmStatus;
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
interface Realm$1 {
|
|
59
|
+
category: RealmCategory;
|
|
60
|
+
connected_realm: Href;
|
|
61
|
+
id: number;
|
|
62
|
+
is_tournament: boolean;
|
|
63
|
+
locale: RealmLocales;
|
|
64
|
+
name: string;
|
|
65
|
+
region: NameIdKey;
|
|
66
|
+
slug: string;
|
|
67
|
+
timezone: RealmTimezone;
|
|
68
|
+
type: {
|
|
69
|
+
name: string;
|
|
70
|
+
type: RealmTypeCapitalized;
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
interface RealmLockedStatus {
|
|
74
|
+
is_locked_for_new_characters: boolean;
|
|
75
|
+
is_locked_for_pct: boolean;
|
|
76
|
+
}
|
|
77
|
+
type RealmPopulationCapitalized = 'FULL' | 'HIGH' | 'LOCKED' | 'LOW' | 'MEDIUM' | 'RECOMMENDED';
|
|
78
|
+
type RealmStatusCapitalized = 'DOWN' | 'UP';
|
|
79
|
+
interface SearchRealm {
|
|
80
|
+
category: Record<Locales, string>;
|
|
81
|
+
id: number;
|
|
82
|
+
is_tournament: boolean;
|
|
83
|
+
locale: RealmLocales;
|
|
84
|
+
name: Record<Locales, string | undefined>;
|
|
85
|
+
region: {
|
|
86
|
+
id: number;
|
|
87
|
+
name: Record<Locales, string>;
|
|
88
|
+
};
|
|
89
|
+
slug: string;
|
|
90
|
+
timezone: RealmTimezone;
|
|
91
|
+
type: {
|
|
92
|
+
name: Record<Locales, string>;
|
|
93
|
+
type: RealmTypeCapitalized;
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
interface SearchRealmPopulation {
|
|
97
|
+
name: Record<Locales, string>;
|
|
98
|
+
type: RealmPopulationCapitalized;
|
|
99
|
+
}
|
|
100
|
+
interface SearchRealmStatus {
|
|
101
|
+
name: Record<Locales, string>;
|
|
102
|
+
type: RealmStatusCapitalized;
|
|
103
|
+
}
|
|
104
|
+
//#endregion
|
|
105
|
+
//#region src/connected-realm/index.d.ts
|
|
106
|
+
/**
|
|
107
|
+
* Returns a connected realm by ID.
|
|
108
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
109
|
+
* @param connectedRealmId The connected realm ID.
|
|
110
|
+
* @returns The connected realm. See {@link ConnectedRealmResponse}.
|
|
111
|
+
*/
|
|
112
|
+
declare function connectedRealm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, connectedRealmId: number): Resource<ConnectedRealmResponse>;
|
|
113
|
+
/**
|
|
114
|
+
* Returns an index of connected realms.
|
|
115
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
116
|
+
* @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
|
|
117
|
+
*/
|
|
118
|
+
declare function connectedRealmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<ConnectedRealmIndexResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* Performs a search of connected realms.
|
|
121
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
122
|
+
* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
|
|
123
|
+
* @returns The search results. See {@link ConnectedRealmSearchResponse}.
|
|
124
|
+
*/
|
|
125
|
+
declare function connectedRealmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: ConnectedRealmSearchParameters): Resource<ConnectedRealmSearchResponse, ConnectedRealmSearchParameters>;
|
|
126
|
+
//#endregion
|
|
127
|
+
export { ConnectedRealmResponse as a, ConnectedRealmIndexResponse as i, connectedRealmIndex as n, ConnectedRealmSearchParameters as o, connectedRealmSearch as r, ConnectedRealmSearchResponse as s, connectedRealm as t };
|
|
128
|
+
//# sourceMappingURL=index-BQ-NY0vY.d.ts.map
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { BlizzardNamespaces, Character, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/character-achievements/types.d.ts
|
|
4
|
+
interface CharacterAchievementsSummaryResponse extends ResponseBase {
|
|
5
|
+
achievements: Array<Achievement>;
|
|
6
|
+
category_progress: Array<CategoryProgress>;
|
|
7
|
+
character: Character;
|
|
8
|
+
recent_events: Array<RecentEvent>;
|
|
9
|
+
total_points: number;
|
|
10
|
+
total_quantity: number;
|
|
11
|
+
}
|
|
12
|
+
interface CharacterAchievementStatisticsResponse extends ResponseBase {
|
|
13
|
+
categories: Array<Category>;
|
|
14
|
+
character: Character;
|
|
15
|
+
}
|
|
16
|
+
interface Achievement {
|
|
17
|
+
achievement: NameIdKey;
|
|
18
|
+
completed_timestamp?: number;
|
|
19
|
+
criteria?: Criteria;
|
|
20
|
+
id: number;
|
|
21
|
+
}
|
|
22
|
+
interface Category {
|
|
23
|
+
id: number;
|
|
24
|
+
name: string;
|
|
25
|
+
statistics?: Array<Statistic>;
|
|
26
|
+
sub_categories?: Array<SubCategory>;
|
|
27
|
+
}
|
|
28
|
+
interface CategoryProgress {
|
|
29
|
+
category: NameIdKey;
|
|
30
|
+
points: number;
|
|
31
|
+
quantity: number;
|
|
32
|
+
}
|
|
33
|
+
interface ChildCriterum {
|
|
34
|
+
amount?: number;
|
|
35
|
+
child_criteria?: Array<ChildCriterum2>;
|
|
36
|
+
id: number;
|
|
37
|
+
is_completed: boolean;
|
|
38
|
+
}
|
|
39
|
+
interface ChildCriterum2 {
|
|
40
|
+
amount?: number;
|
|
41
|
+
child_criteria?: Array<ChildCriterum3>;
|
|
42
|
+
id: number;
|
|
43
|
+
is_completed: boolean;
|
|
44
|
+
}
|
|
45
|
+
interface ChildCriterum3 {
|
|
46
|
+
amount?: number;
|
|
47
|
+
id: number;
|
|
48
|
+
is_completed: boolean;
|
|
49
|
+
}
|
|
50
|
+
interface Criteria {
|
|
51
|
+
amount?: number;
|
|
52
|
+
child_criteria?: Array<ChildCriterum>;
|
|
53
|
+
id: number;
|
|
54
|
+
is_completed: boolean;
|
|
55
|
+
}
|
|
56
|
+
interface RecentEvent {
|
|
57
|
+
achievement: NameIdKey;
|
|
58
|
+
timestamp: number;
|
|
59
|
+
}
|
|
60
|
+
interface Statistic {
|
|
61
|
+
description?: null | string;
|
|
62
|
+
id: number;
|
|
63
|
+
last_updated_timestamp: number;
|
|
64
|
+
name: string;
|
|
65
|
+
quantity: number;
|
|
66
|
+
}
|
|
67
|
+
interface SubCategory {
|
|
68
|
+
id: number;
|
|
69
|
+
name: string;
|
|
70
|
+
statistics: Array<Statistic>;
|
|
71
|
+
}
|
|
72
|
+
//#endregion
|
|
73
|
+
//#region src/character-achievements/index.d.ts
|
|
74
|
+
/**
|
|
75
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}. Note: This API is not supported for classic era realms.
|
|
76
|
+
* @param realmSlug The slug of the realm.
|
|
77
|
+
* @param characterName The lowercase name of the character.
|
|
78
|
+
* @returns a summary of the achievements a character has completed.
|
|
79
|
+
*/
|
|
80
|
+
declare function characterAchievementsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterAchievementsSummaryResponse>;
|
|
81
|
+
/**
|
|
82
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}. Note: This API is not supported for classic era realms.
|
|
83
|
+
* @param realmSlug The slug of the realm.
|
|
84
|
+
* @param characterName The lowercase name of the character.
|
|
85
|
+
* @returns a character's statistics as they pertain to achievements.
|
|
86
|
+
*/
|
|
87
|
+
declare function characterAchievementStatistics(namespace: Extract<BlizzardNamespaces, 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterAchievementStatisticsResponse>;
|
|
88
|
+
//#endregion
|
|
89
|
+
export { CharacterAchievementsSummaryResponse as i, characterAchievementsSummary as n, CharacterAchievementStatisticsResponse as r, characterAchievementStatistics as t };
|
|
90
|
+
//# sourceMappingURL=index-BZ8QSRSe.d.ts.map
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { BlizzardNamespaces, Faction, GenderName, NameId, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/playable-race/types.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The playable race index response.
|
|
6
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
7
|
+
*/
|
|
8
|
+
interface PlayableRaceIndexResponse extends ResponseBase {
|
|
9
|
+
races: Array<NameIdKey>;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* The playable race response.
|
|
13
|
+
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
|
|
14
|
+
*/
|
|
15
|
+
interface PlayableRaceResponse extends NameId, ResponseBase {
|
|
16
|
+
faction: Faction;
|
|
17
|
+
gender_name: GenderName;
|
|
18
|
+
is_allied_race: boolean;
|
|
19
|
+
is_selectable: boolean;
|
|
20
|
+
playable_classes: Array<NameIdKey>;
|
|
21
|
+
racial_spells: Array<NameIdKey>;
|
|
22
|
+
}
|
|
23
|
+
//#endregion
|
|
24
|
+
//#region src/playable-race/index.d.ts
|
|
25
|
+
/**
|
|
26
|
+
* Get a playable race by ID.
|
|
27
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
28
|
+
* @param playableRaceId The playable race ID.
|
|
29
|
+
* @returns The playable race. See {@link PlayableRaceResponse}.
|
|
30
|
+
*/
|
|
31
|
+
declare function playableRace(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, playableRaceId: number): Resource<PlayableRaceResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* Get a playable race index.
|
|
34
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
35
|
+
* @returns The playable race index. See {@link PlayableRaceIndexResponse}.
|
|
36
|
+
*/
|
|
37
|
+
declare function playableRaceIndex(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>): Resource<PlayableRaceIndexResponse>;
|
|
38
|
+
//#endregion
|
|
39
|
+
export { PlayableRaceResponse as i, playableRaceIndex as n, PlayableRaceIndexResponse as r, playableRace as t };
|
|
40
|
+
//# sourceMappingURL=index-BrwXCy4D.d.ts.map
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { BlizzardNamespaces, Character, KeyBase, NameIdKey, Resource, ResponseBase } from "@blizzard-api/core";
|
|
2
|
+
|
|
3
|
+
//#region src/character-hunter-pets/types.d.ts
|
|
4
|
+
interface CharacterHunterPetsSummaryResponse extends ResponseBase {
|
|
5
|
+
character: Character;
|
|
6
|
+
hunter_pets: Array<HunterPet>;
|
|
7
|
+
}
|
|
8
|
+
interface HunterPet {
|
|
9
|
+
creature: NameIdKey;
|
|
10
|
+
creature_display: KeyBase & {
|
|
11
|
+
id: number;
|
|
12
|
+
};
|
|
13
|
+
is_active?: boolean;
|
|
14
|
+
is_summoned?: boolean;
|
|
15
|
+
level: number;
|
|
16
|
+
name: string;
|
|
17
|
+
slot: number;
|
|
18
|
+
}
|
|
19
|
+
//#endregion
|
|
20
|
+
//#region src/character-hunter-pets/index.d.ts
|
|
21
|
+
/**
|
|
22
|
+
* If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
|
|
23
|
+
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
|
|
24
|
+
* @param realmSlug The slug of the realm.
|
|
25
|
+
* @param characterName The lowercase name of the character.
|
|
26
|
+
* @returns a summary of the character's hunter pets.
|
|
27
|
+
*/
|
|
28
|
+
declare function characterHunterPetsSummary(namespace: Extract<BlizzardNamespaces, 'profile-classic1x' | 'profile-classic'>, realmSlug: string, characterName: string): Resource<CharacterHunterPetsSummaryResponse>;
|
|
29
|
+
//#endregion
|
|
30
|
+
export { CharacterHunterPetsSummaryResponse as n, characterHunterPetsSummary as t };
|
|
31
|
+
//# sourceMappingURL=index-BtfmrbYY.d.ts.map
|