wynn-api-types 3.7.2
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/LICENSE +21 -0
- package/README.md +28 -0
- package/index.d.ts +3798 -0
- package/package.json +48 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,3798 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
'/player': {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* List online players
|
|
16
|
+
* @description <Note>
|
|
17
|
+
* This endpoint is cached for <Badge intent="success" minimal>30 seconds</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
18
|
+
* </Note>
|
|
19
|
+
*
|
|
20
|
+
* <Warning>
|
|
21
|
+
* Online player list is subject to [Access Rules](/privacy), which can hide some players from the list. Rely on the field `total` to have the accurate player count.
|
|
22
|
+
* </Warning>
|
|
23
|
+
*/
|
|
24
|
+
get: operations['list-online-players'];
|
|
25
|
+
put?: never;
|
|
26
|
+
post?: never;
|
|
27
|
+
delete?: never;
|
|
28
|
+
options?: never;
|
|
29
|
+
head?: never;
|
|
30
|
+
patch?: never;
|
|
31
|
+
trace?: never;
|
|
32
|
+
};
|
|
33
|
+
'/player/whoami': {
|
|
34
|
+
parameters: {
|
|
35
|
+
query?: never;
|
|
36
|
+
header?: never;
|
|
37
|
+
path?: never;
|
|
38
|
+
cookie?: never;
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Who Am I
|
|
42
|
+
* @description <Note>
|
|
43
|
+
* This endpoint is not cached. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
44
|
+
* </Note>
|
|
45
|
+
*
|
|
46
|
+
* <Warning>
|
|
47
|
+
* Try it will not return usable data for this route. It depends on authentication and IP-aware context, so test it against the live API outside the docs.
|
|
48
|
+
* </Warning>
|
|
49
|
+
*
|
|
50
|
+
* Data returned here depends on the accounts you used to join Wynncraft. Those accounts represent who we think you are and are used for account-aware features such as store auto-login and map live position viewing.
|
|
51
|
+
*/
|
|
52
|
+
get: operations['get-player-identity'];
|
|
53
|
+
put?: never;
|
|
54
|
+
post?: never;
|
|
55
|
+
delete?: never;
|
|
56
|
+
options?: never;
|
|
57
|
+
head?: never;
|
|
58
|
+
patch?: never;
|
|
59
|
+
trace?: never;
|
|
60
|
+
};
|
|
61
|
+
'/player/{username}/characters': {
|
|
62
|
+
parameters: {
|
|
63
|
+
query?: never;
|
|
64
|
+
header?: never;
|
|
65
|
+
path?: never;
|
|
66
|
+
cookie?: never;
|
|
67
|
+
};
|
|
68
|
+
/**
|
|
69
|
+
* List a player's characters
|
|
70
|
+
* @description <Note>
|
|
71
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
72
|
+
* </Note>
|
|
73
|
+
*
|
|
74
|
+
* <Warning>
|
|
75
|
+
* This response can be restricted by player [Access Rules](/privacy).
|
|
76
|
+
* </Warning>
|
|
77
|
+
* <Info>
|
|
78
|
+
* It is recommended to request players by UUID. Username lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one player matches the query.
|
|
79
|
+
* </Info>
|
|
80
|
+
*
|
|
81
|
+
* Returns the player's characters keyed by character UUID.
|
|
82
|
+
*/
|
|
83
|
+
get: operations['list-player-characters'];
|
|
84
|
+
put?: never;
|
|
85
|
+
post?: never;
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
'/player/{username}/characters/{uuid}': {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* Get detailed character data
|
|
101
|
+
* @description <Note>
|
|
102
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
103
|
+
* </Note>
|
|
104
|
+
*
|
|
105
|
+
* <Warning>
|
|
106
|
+
* Character data is subject to [Access Rules](/privacy), which can hide some stats. Check the `restrictions` object to see which access rules affected the response. You can also check the `removedStat` field to check when the character skeleton customization affect the response.
|
|
107
|
+
* </Warning>
|
|
108
|
+
* <Info>
|
|
109
|
+
* It is recommended to request players by UUID. Username lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one player matches the query.
|
|
110
|
+
* </Info>
|
|
111
|
+
*
|
|
112
|
+
* Returns the full stat payload for a single character.
|
|
113
|
+
*/
|
|
114
|
+
get: operations['get-player-character'];
|
|
115
|
+
put?: never;
|
|
116
|
+
post?: never;
|
|
117
|
+
delete?: never;
|
|
118
|
+
options?: never;
|
|
119
|
+
head?: never;
|
|
120
|
+
patch?: never;
|
|
121
|
+
trace?: never;
|
|
122
|
+
};
|
|
123
|
+
'/player/{username}/characters/{uuid}/abilities': {
|
|
124
|
+
parameters: {
|
|
125
|
+
query?: never;
|
|
126
|
+
header?: never;
|
|
127
|
+
path?: never;
|
|
128
|
+
cookie?: never;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* Get character ability map
|
|
132
|
+
* @description <Note>
|
|
133
|
+
* This endpoint is cached for <Badge intent="warning" minimal>10 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
134
|
+
* </Note>
|
|
135
|
+
* <Warning>
|
|
136
|
+
* Ability Tree is subject to [Access Rules](/privacy), which can make it unavailable.
|
|
137
|
+
* </Warning>
|
|
138
|
+
* <Info>
|
|
139
|
+
* It is recommended to request players by UUID. Username lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one player matches the query.
|
|
140
|
+
* </Info>
|
|
141
|
+
* This endpoint only lists abilities the player has enabled and performs pathfinding on the fly.
|
|
142
|
+
*
|
|
143
|
+
* To render a full in-game style ability tree, combine this response with:
|
|
144
|
+
* - [GET /ability/tree/{tree}](api:GET/ability/tree/{tree})
|
|
145
|
+
* - [GET /ability/map/{tree}](api:GET/ability/map/{tree})
|
|
146
|
+
*/
|
|
147
|
+
get: operations['get-player-character-abilities'];
|
|
148
|
+
put?: never;
|
|
149
|
+
post?: never;
|
|
150
|
+
delete?: never;
|
|
151
|
+
options?: never;
|
|
152
|
+
head?: never;
|
|
153
|
+
patch?: never;
|
|
154
|
+
trace?: never;
|
|
155
|
+
};
|
|
156
|
+
'/oauth/me': {
|
|
157
|
+
parameters: {
|
|
158
|
+
query?: never;
|
|
159
|
+
header?: never;
|
|
160
|
+
path?: never;
|
|
161
|
+
cookie?: never;
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* Get OAuth2 identity
|
|
165
|
+
* @description <Warning>
|
|
166
|
+
* Try it will not return usable data for this route. It depends on a live OAuth2 authentication context outside the docs.
|
|
167
|
+
* </Warning>
|
|
168
|
+
*
|
|
169
|
+
* <Info>
|
|
170
|
+
* Get started with OAuth by reading [our guide](/oauth2/creating-an-application).
|
|
171
|
+
* </Info>
|
|
172
|
+
*
|
|
173
|
+
* This endpoint returns the authenticated OAuth2 application context and the linked player profiles available to the authorized user.
|
|
174
|
+
*
|
|
175
|
+
* <Info>
|
|
176
|
+
* The `profiles` object contains the player profiles that belong to the authorizing user. Access-rule bypass through OAuth2 only applies to those linked profiles when the user granted permission for it.
|
|
177
|
+
* </Info>
|
|
178
|
+
*/
|
|
179
|
+
get: operations['get-oauth-identity'];
|
|
180
|
+
put?: never;
|
|
181
|
+
post?: never;
|
|
182
|
+
delete?: never;
|
|
183
|
+
options?: never;
|
|
184
|
+
head?: never;
|
|
185
|
+
patch?: never;
|
|
186
|
+
trace?: never;
|
|
187
|
+
};
|
|
188
|
+
'/oauth/token': {
|
|
189
|
+
parameters: {
|
|
190
|
+
query?: never;
|
|
191
|
+
header?: never;
|
|
192
|
+
path?: never;
|
|
193
|
+
cookie?: never;
|
|
194
|
+
};
|
|
195
|
+
get?: never;
|
|
196
|
+
put?: never;
|
|
197
|
+
/**
|
|
198
|
+
* Exchange OAuth2 token
|
|
199
|
+
* @description <Warning>
|
|
200
|
+
* This endpoint expects `application/x-www-form-urlencoded`.
|
|
201
|
+
* </Warning>
|
|
202
|
+
* <Warning>
|
|
203
|
+
* Try it will not return usable data for this route. It depends on a live OAuth2 authentication context outside the docs.
|
|
204
|
+
* </Warning>
|
|
205
|
+
* <Info>
|
|
206
|
+
* Get started with OAuth by reading [our guide](/oauth2/creating-an-application).
|
|
207
|
+
* </Info>
|
|
208
|
+
* <Info>
|
|
209
|
+
* Only the `authorization_code` grant type is supported. Authorization codes are one-time use and expire after 5 minutes.
|
|
210
|
+
* </Info>
|
|
211
|
+
*
|
|
212
|
+
* PKCE is supported for both Private and Public applications but Public applications must send `code_verifier` and must not send `client_secret`.
|
|
213
|
+
*
|
|
214
|
+
* Private applications must send `client_secret`.
|
|
215
|
+
*
|
|
216
|
+
* Only `S256` PKCE is supported.
|
|
217
|
+
*/
|
|
218
|
+
post: operations['exchange-oauth-token'];
|
|
219
|
+
delete?: never;
|
|
220
|
+
options?: never;
|
|
221
|
+
head?: never;
|
|
222
|
+
patch?: never;
|
|
223
|
+
trace?: never;
|
|
224
|
+
};
|
|
225
|
+
'/guild/list/guild': {
|
|
226
|
+
parameters: {
|
|
227
|
+
query?: never;
|
|
228
|
+
header?: never;
|
|
229
|
+
path?: never;
|
|
230
|
+
cookie?: never;
|
|
231
|
+
};
|
|
232
|
+
/**
|
|
233
|
+
* List guilds
|
|
234
|
+
* @description <Note>
|
|
235
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
236
|
+
* </Note>
|
|
237
|
+
*/
|
|
238
|
+
get: operations['list-guilds'];
|
|
239
|
+
put?: never;
|
|
240
|
+
post?: never;
|
|
241
|
+
delete?: never;
|
|
242
|
+
options?: never;
|
|
243
|
+
head?: never;
|
|
244
|
+
patch?: never;
|
|
245
|
+
trace?: never;
|
|
246
|
+
};
|
|
247
|
+
'/guild/list/territory': {
|
|
248
|
+
parameters: {
|
|
249
|
+
query?: never;
|
|
250
|
+
header?: never;
|
|
251
|
+
path?: never;
|
|
252
|
+
cookie?: never;
|
|
253
|
+
};
|
|
254
|
+
/**
|
|
255
|
+
* List territories
|
|
256
|
+
* @description <Note>
|
|
257
|
+
* This endpoint is cached for <Badge intent="success" minimal>10 seconds</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
258
|
+
* </Note>
|
|
259
|
+
* <Warning>
|
|
260
|
+
* The `resources` field is refreshed every <Badge intent="warning" minimal>1 minute</Badge>. All other territory fields continue to refresh every <Badge intent="success" minimal>10 seconds</Badge>.
|
|
261
|
+
* </Warning>
|
|
262
|
+
*/
|
|
263
|
+
get: operations['list-guild-territories'];
|
|
264
|
+
put?: never;
|
|
265
|
+
post?: never;
|
|
266
|
+
delete?: never;
|
|
267
|
+
options?: never;
|
|
268
|
+
head?: never;
|
|
269
|
+
patch?: never;
|
|
270
|
+
trace?: never;
|
|
271
|
+
};
|
|
272
|
+
'/guild/seasons': {
|
|
273
|
+
parameters: {
|
|
274
|
+
query?: never;
|
|
275
|
+
header?: never;
|
|
276
|
+
path?: never;
|
|
277
|
+
cookie?: never;
|
|
278
|
+
};
|
|
279
|
+
/**
|
|
280
|
+
* List guild seasons
|
|
281
|
+
* @description <Note>
|
|
282
|
+
* This endpoint is cached for <Badge intent="warning" minimal>10 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
283
|
+
* </Note>
|
|
284
|
+
*
|
|
285
|
+
* Only enabled seasons whose `initDate` is in the past are returned.
|
|
286
|
+
*
|
|
287
|
+
* Use this endpoint to inspect public guild season rules, including SR gain values and reward thresholds.
|
|
288
|
+
*/
|
|
289
|
+
get: operations['list-guild-seasons'];
|
|
290
|
+
put?: never;
|
|
291
|
+
post?: never;
|
|
292
|
+
delete?: never;
|
|
293
|
+
options?: never;
|
|
294
|
+
head?: never;
|
|
295
|
+
patch?: never;
|
|
296
|
+
trace?: never;
|
|
297
|
+
};
|
|
298
|
+
'/guild/prefix/{query}': {
|
|
299
|
+
parameters: {
|
|
300
|
+
query?: never;
|
|
301
|
+
header?: never;
|
|
302
|
+
path?: never;
|
|
303
|
+
cookie?: never;
|
|
304
|
+
};
|
|
305
|
+
/**
|
|
306
|
+
* Get guild by prefix
|
|
307
|
+
* @description <Note>
|
|
308
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
309
|
+
* </Note>
|
|
310
|
+
* <Info>
|
|
311
|
+
* Prefix lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one guild matches the query.
|
|
312
|
+
* </Info>
|
|
313
|
+
* Prefix queries are useful when your input is a guild tag rather than a full guild name.
|
|
314
|
+
*
|
|
315
|
+
* Use the `identifier` query parameter with either `username` or `uuid` to control how guild members are identified in the response.
|
|
316
|
+
*/
|
|
317
|
+
get: operations['get-guild-by-prefix'];
|
|
318
|
+
put?: never;
|
|
319
|
+
post?: never;
|
|
320
|
+
delete?: never;
|
|
321
|
+
options?: never;
|
|
322
|
+
head?: never;
|
|
323
|
+
patch?: never;
|
|
324
|
+
trace?: never;
|
|
325
|
+
};
|
|
326
|
+
'/guild/uuid/{query}': {
|
|
327
|
+
parameters: {
|
|
328
|
+
query?: never;
|
|
329
|
+
header?: never;
|
|
330
|
+
path?: never;
|
|
331
|
+
cookie?: never;
|
|
332
|
+
};
|
|
333
|
+
/**
|
|
334
|
+
* Get guild by UUID
|
|
335
|
+
* @description <Note>
|
|
336
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
337
|
+
* </Note>
|
|
338
|
+
* Use the `identifier` query parameter with either `username` or `uuid` to control how guild members are identified in the response.
|
|
339
|
+
*/
|
|
340
|
+
get: operations['get-guild-by-uuid'];
|
|
341
|
+
put?: never;
|
|
342
|
+
post?: never;
|
|
343
|
+
delete?: never;
|
|
344
|
+
options?: never;
|
|
345
|
+
head?: never;
|
|
346
|
+
patch?: never;
|
|
347
|
+
trace?: never;
|
|
348
|
+
};
|
|
349
|
+
'/guild/{query}': {
|
|
350
|
+
parameters: {
|
|
351
|
+
query?: never;
|
|
352
|
+
header?: never;
|
|
353
|
+
path?: never;
|
|
354
|
+
cookie?: never;
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* Get guild by name
|
|
358
|
+
* @description <Note>
|
|
359
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>GUILD</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
360
|
+
* </Note>
|
|
361
|
+
* Name queries are case-insensitive.
|
|
362
|
+
* Use the `identifier` query parameter with either `username` or `uuid` to control how guild members are identified in the response.
|
|
363
|
+
*/
|
|
364
|
+
get: operations['get-guild-by-name'];
|
|
365
|
+
put?: never;
|
|
366
|
+
post?: never;
|
|
367
|
+
delete?: never;
|
|
368
|
+
options?: never;
|
|
369
|
+
head?: never;
|
|
370
|
+
patch?: never;
|
|
371
|
+
trace?: never;
|
|
372
|
+
};
|
|
373
|
+
'/item/database': {
|
|
374
|
+
parameters: {
|
|
375
|
+
query?: never;
|
|
376
|
+
header?: never;
|
|
377
|
+
path?: never;
|
|
378
|
+
cookie?: never;
|
|
379
|
+
};
|
|
380
|
+
/**
|
|
381
|
+
* List item database entries
|
|
382
|
+
* @description <Note>
|
|
383
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
384
|
+
* </Note>
|
|
385
|
+
*
|
|
386
|
+
* Items use the [API Markup parser](/welcome#api-markup-parser) for Major IDs.
|
|
387
|
+
*
|
|
388
|
+
* <Info>
|
|
389
|
+
* `fullResult` bypasses pagination and returns the `results` object for all objects at once.
|
|
390
|
+
* </Info>
|
|
391
|
+
*
|
|
392
|
+
* This endpoint uses the generic pagination response format.
|
|
393
|
+
*
|
|
394
|
+
* <Footer>
|
|
395
|
+
* Enum values in these docs are based on the item metadata available on April 23, 2026. New item content can add or change values over time.
|
|
396
|
+
* </Footer>
|
|
397
|
+
*/
|
|
398
|
+
get: operations['list-items'];
|
|
399
|
+
put?: never;
|
|
400
|
+
post?: never;
|
|
401
|
+
delete?: never;
|
|
402
|
+
options?: never;
|
|
403
|
+
head?: never;
|
|
404
|
+
patch?: never;
|
|
405
|
+
trace?: never;
|
|
406
|
+
};
|
|
407
|
+
'/item/search': {
|
|
408
|
+
parameters: {
|
|
409
|
+
query?: never;
|
|
410
|
+
header?: never;
|
|
411
|
+
path?: never;
|
|
412
|
+
cookie?: never;
|
|
413
|
+
};
|
|
414
|
+
get?: never;
|
|
415
|
+
put?: never;
|
|
416
|
+
/**
|
|
417
|
+
* Search item database
|
|
418
|
+
* @description <Note>
|
|
419
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
420
|
+
* </Note>
|
|
421
|
+
*
|
|
422
|
+
* Filters can be empty and do not always need to be present in the payload. To understand the endpoint better, try the official Wynncraft item guide while monitoring the network tab in your browser devtools.
|
|
423
|
+
*
|
|
424
|
+
* <Info>
|
|
425
|
+
* `fullResult` bypasses pagination and returns the `results` object for all objects at once.
|
|
426
|
+
* </Info>
|
|
427
|
+
*
|
|
428
|
+
* This endpoint uses the generic pagination response format.
|
|
429
|
+
*
|
|
430
|
+
* <Footer>
|
|
431
|
+
* Enum values in these docs are based on the item metadata available on April 23, 2026. New item content can add or change values over time.
|
|
432
|
+
* </Footer>
|
|
433
|
+
*/
|
|
434
|
+
post: operations['search-items'];
|
|
435
|
+
delete?: never;
|
|
436
|
+
options?: never;
|
|
437
|
+
head?: never;
|
|
438
|
+
patch?: never;
|
|
439
|
+
trace?: never;
|
|
440
|
+
};
|
|
441
|
+
'/item/search/{query}': {
|
|
442
|
+
parameters: {
|
|
443
|
+
query?: never;
|
|
444
|
+
header?: never;
|
|
445
|
+
path?: never;
|
|
446
|
+
cookie?: never;
|
|
447
|
+
};
|
|
448
|
+
/**
|
|
449
|
+
* Quick item search
|
|
450
|
+
* @description <Note>
|
|
451
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
452
|
+
* </Note>
|
|
453
|
+
*
|
|
454
|
+
* Items use the [API Markup parser](/welcome#api-markup-parser) for Major IDs.
|
|
455
|
+
*
|
|
456
|
+
* <Footer>
|
|
457
|
+
* Enum values in these docs are based on the item metadata available on April 23, 2026. New item content can add or change values over time.
|
|
458
|
+
* </Footer>
|
|
459
|
+
*/
|
|
460
|
+
get: operations['quick-search-items'];
|
|
461
|
+
put?: never;
|
|
462
|
+
post?: never;
|
|
463
|
+
delete?: never;
|
|
464
|
+
options?: never;
|
|
465
|
+
head?: never;
|
|
466
|
+
patch?: never;
|
|
467
|
+
trace?: never;
|
|
468
|
+
};
|
|
469
|
+
'/item/recipe/database': {
|
|
470
|
+
parameters: {
|
|
471
|
+
query?: never;
|
|
472
|
+
header?: never;
|
|
473
|
+
path?: never;
|
|
474
|
+
cookie?: never;
|
|
475
|
+
};
|
|
476
|
+
/**
|
|
477
|
+
* List recipe database entries
|
|
478
|
+
* @description <Note>
|
|
479
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
480
|
+
* </Note>
|
|
481
|
+
* <Info>
|
|
482
|
+
* `full_result` bypasses pagination and returns the full raw array instead of the paginated object.
|
|
483
|
+
* </Info>
|
|
484
|
+
*
|
|
485
|
+
* This endpoint uses the generic pagination response format unless `full_result` is present.
|
|
486
|
+
*/
|
|
487
|
+
get: operations['list-recipes'];
|
|
488
|
+
put?: never;
|
|
489
|
+
post?: never;
|
|
490
|
+
delete?: never;
|
|
491
|
+
options?: never;
|
|
492
|
+
head?: never;
|
|
493
|
+
patch?: never;
|
|
494
|
+
trace?: never;
|
|
495
|
+
};
|
|
496
|
+
'/item/recipe/search': {
|
|
497
|
+
parameters: {
|
|
498
|
+
query?: never;
|
|
499
|
+
header?: never;
|
|
500
|
+
path?: never;
|
|
501
|
+
cookie?: never;
|
|
502
|
+
};
|
|
503
|
+
get?: never;
|
|
504
|
+
put?: never;
|
|
505
|
+
/**
|
|
506
|
+
* Search recipe database
|
|
507
|
+
* @description <Note>
|
|
508
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
509
|
+
* </Note>
|
|
510
|
+
* <Info>
|
|
511
|
+
* `full_result` bypasses pagination and returns the full raw array instead of the paginated object.
|
|
512
|
+
* </Info>
|
|
513
|
+
*
|
|
514
|
+
* For range filters, an integer checks whether that value falls inside the stored recipe range. A one-value list behaves the same way. A two-value list matches any recipe whose stored range overlaps the requested range.
|
|
515
|
+
*/
|
|
516
|
+
post: operations['search-recipes'];
|
|
517
|
+
delete?: never;
|
|
518
|
+
options?: never;
|
|
519
|
+
head?: never;
|
|
520
|
+
patch?: never;
|
|
521
|
+
trace?: never;
|
|
522
|
+
};
|
|
523
|
+
'/item/metadata': {
|
|
524
|
+
parameters: {
|
|
525
|
+
query?: never;
|
|
526
|
+
header?: never;
|
|
527
|
+
path?: never;
|
|
528
|
+
cookie?: never;
|
|
529
|
+
};
|
|
530
|
+
/**
|
|
531
|
+
* Get item filter metadata
|
|
532
|
+
* @description <Note>
|
|
533
|
+
* This endpoint is cached for <Badge intent="success" minimal>3 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
534
|
+
* </Note>
|
|
535
|
+
* Returns all available filters for advanced item search. If you need an exact filter or lookup key, this endpoint is the authoritative source.
|
|
536
|
+
*
|
|
537
|
+
* <Info>
|
|
538
|
+
* Prefer `?static` when you only need the static lookup map. The default response also includes website-oriented filter groupings used by the item guide.
|
|
539
|
+
* </Info>
|
|
540
|
+
*/
|
|
541
|
+
get: operations['get-item-metadata'];
|
|
542
|
+
put?: never;
|
|
543
|
+
post?: never;
|
|
544
|
+
delete?: never;
|
|
545
|
+
options?: never;
|
|
546
|
+
head?: never;
|
|
547
|
+
patch?: never;
|
|
548
|
+
trace?: never;
|
|
549
|
+
};
|
|
550
|
+
'/item/sets': {
|
|
551
|
+
parameters: {
|
|
552
|
+
query?: never;
|
|
553
|
+
header?: never;
|
|
554
|
+
path?: never;
|
|
555
|
+
cookie?: never;
|
|
556
|
+
};
|
|
557
|
+
/**
|
|
558
|
+
* List item sets
|
|
559
|
+
* @description <Note>
|
|
560
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>ITEMS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
561
|
+
* </Note>
|
|
562
|
+
*/
|
|
563
|
+
get: operations['list-item-sets'];
|
|
564
|
+
put?: never;
|
|
565
|
+
post?: never;
|
|
566
|
+
delete?: never;
|
|
567
|
+
options?: never;
|
|
568
|
+
head?: never;
|
|
569
|
+
patch?: never;
|
|
570
|
+
trace?: never;
|
|
571
|
+
};
|
|
572
|
+
'/ability/tree/{tree}': {
|
|
573
|
+
parameters: {
|
|
574
|
+
query?: never;
|
|
575
|
+
header?: never;
|
|
576
|
+
path?: never;
|
|
577
|
+
cookie?: never;
|
|
578
|
+
};
|
|
579
|
+
/**
|
|
580
|
+
* Get class ability tree
|
|
581
|
+
* @description <Note>
|
|
582
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
583
|
+
* </Note>
|
|
584
|
+
*
|
|
585
|
+
* Ability and aspect responses use the [API Markup parser](/welcome#api-markup-parser).
|
|
586
|
+
*
|
|
587
|
+
* Use these endpoints together to render a player ability tree like the in-game view:
|
|
588
|
+
* - [GET /ability/tree/{tree}](api:GET/ability/tree/{tree})
|
|
589
|
+
* - [GET /ability/map/{tree}](api:GET/ability/map/{tree})
|
|
590
|
+
* - [GET /player/{username}/characters/{uuid}/abilities](api:GET/player/{username}/characters/{uuid}/abilities)
|
|
591
|
+
*/
|
|
592
|
+
get: operations['get-ability-tree'];
|
|
593
|
+
put?: never;
|
|
594
|
+
post?: never;
|
|
595
|
+
delete?: never;
|
|
596
|
+
options?: never;
|
|
597
|
+
head?: never;
|
|
598
|
+
patch?: never;
|
|
599
|
+
trace?: never;
|
|
600
|
+
};
|
|
601
|
+
'/ability/map/{tree}': {
|
|
602
|
+
parameters: {
|
|
603
|
+
query?: never;
|
|
604
|
+
header?: never;
|
|
605
|
+
path?: never;
|
|
606
|
+
cookie?: never;
|
|
607
|
+
};
|
|
608
|
+
/**
|
|
609
|
+
* Get class ability tree map
|
|
610
|
+
* @description <Note>
|
|
611
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
612
|
+
* </Note>
|
|
613
|
+
*
|
|
614
|
+
* Ability and aspect responses use the [API Markup parser](/welcome#api-markup-parser).
|
|
615
|
+
*
|
|
616
|
+
* Use these endpoints together to render a player ability tree like the in-game view:
|
|
617
|
+
* - [GET /ability/tree/{tree}](api:GET/ability/tree/{tree})
|
|
618
|
+
* - [GET /ability/map/{tree}](api:GET/ability/map/{tree})
|
|
619
|
+
* - [GET /player/{username}/characters/{uuid}/abilities](api:GET/player/{username}/characters/{uuid}/abilities)
|
|
620
|
+
*
|
|
621
|
+
* The map structure is shared with [GET /player/{username}/characters/{uuid}/abilities](api:GET/player/{username}/characters/{uuid}/abilities).
|
|
622
|
+
*/
|
|
623
|
+
get: operations['get-ability-map'];
|
|
624
|
+
put?: never;
|
|
625
|
+
post?: never;
|
|
626
|
+
delete?: never;
|
|
627
|
+
options?: never;
|
|
628
|
+
head?: never;
|
|
629
|
+
patch?: never;
|
|
630
|
+
trace?: never;
|
|
631
|
+
};
|
|
632
|
+
'/aspects/{tree}': {
|
|
633
|
+
parameters: {
|
|
634
|
+
query?: never;
|
|
635
|
+
header?: never;
|
|
636
|
+
path?: never;
|
|
637
|
+
cookie?: never;
|
|
638
|
+
};
|
|
639
|
+
/**
|
|
640
|
+
* List aspects for a class
|
|
641
|
+
* @description <Note>
|
|
642
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
643
|
+
* </Note>
|
|
644
|
+
*
|
|
645
|
+
* Ability and aspect responses use the [API Markup parser](/welcome#api-markup-parser).
|
|
646
|
+
*/
|
|
647
|
+
get: operations['list-aspects'];
|
|
648
|
+
put?: never;
|
|
649
|
+
post?: never;
|
|
650
|
+
delete?: never;
|
|
651
|
+
options?: never;
|
|
652
|
+
head?: never;
|
|
653
|
+
patch?: never;
|
|
654
|
+
trace?: never;
|
|
655
|
+
};
|
|
656
|
+
'/classes': {
|
|
657
|
+
parameters: {
|
|
658
|
+
query?: never;
|
|
659
|
+
header?: never;
|
|
660
|
+
path?: never;
|
|
661
|
+
cookie?: never;
|
|
662
|
+
};
|
|
663
|
+
/**
|
|
664
|
+
* List classes
|
|
665
|
+
* @description <Note>
|
|
666
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
667
|
+
* </Note>
|
|
668
|
+
*/
|
|
669
|
+
get: operations['list-classes'];
|
|
670
|
+
put?: never;
|
|
671
|
+
post?: never;
|
|
672
|
+
delete?: never;
|
|
673
|
+
options?: never;
|
|
674
|
+
head?: never;
|
|
675
|
+
patch?: never;
|
|
676
|
+
trace?: never;
|
|
677
|
+
};
|
|
678
|
+
'/classes/{class_name}': {
|
|
679
|
+
parameters: {
|
|
680
|
+
query?: never;
|
|
681
|
+
header?: never;
|
|
682
|
+
path?: never;
|
|
683
|
+
cookie?: never;
|
|
684
|
+
};
|
|
685
|
+
/**
|
|
686
|
+
* Get class detail
|
|
687
|
+
* @description <Note>
|
|
688
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
689
|
+
* </Note>
|
|
690
|
+
*/
|
|
691
|
+
get: operations['get-class'];
|
|
692
|
+
put?: never;
|
|
693
|
+
post?: never;
|
|
694
|
+
delete?: never;
|
|
695
|
+
options?: never;
|
|
696
|
+
head?: never;
|
|
697
|
+
patch?: never;
|
|
698
|
+
trace?: never;
|
|
699
|
+
};
|
|
700
|
+
'/map/locations/markers': {
|
|
701
|
+
parameters: {
|
|
702
|
+
query?: never;
|
|
703
|
+
header?: never;
|
|
704
|
+
path?: never;
|
|
705
|
+
cookie?: never;
|
|
706
|
+
};
|
|
707
|
+
/**
|
|
708
|
+
* List map markers
|
|
709
|
+
* @description <Note>
|
|
710
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
711
|
+
* </Note>
|
|
712
|
+
*/
|
|
713
|
+
get: operations['list-map-markers'];
|
|
714
|
+
put?: never;
|
|
715
|
+
post?: never;
|
|
716
|
+
delete?: never;
|
|
717
|
+
options?: never;
|
|
718
|
+
head?: never;
|
|
719
|
+
patch?: never;
|
|
720
|
+
trace?: never;
|
|
721
|
+
};
|
|
722
|
+
'/map/locations/player': {
|
|
723
|
+
parameters: {
|
|
724
|
+
query?: never;
|
|
725
|
+
header?: never;
|
|
726
|
+
path?: never;
|
|
727
|
+
cookie?: never;
|
|
728
|
+
};
|
|
729
|
+
/**
|
|
730
|
+
* List visible player locations
|
|
731
|
+
* @description <Note>
|
|
732
|
+
* This endpoint is cached for <Badge intent="success" minimal>15 seconds</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
733
|
+
* </Note>
|
|
734
|
+
*
|
|
735
|
+
* <Warning>
|
|
736
|
+
* Try it will not return usable data for this route. It depends on authentication and IP-aware context, so test it against the live API outside the docs.
|
|
737
|
+
* </Warning>
|
|
738
|
+
*/
|
|
739
|
+
get: operations['list-player-locations'];
|
|
740
|
+
put?: never;
|
|
741
|
+
post?: never;
|
|
742
|
+
delete?: never;
|
|
743
|
+
options?: never;
|
|
744
|
+
head?: never;
|
|
745
|
+
patch?: never;
|
|
746
|
+
trace?: never;
|
|
747
|
+
};
|
|
748
|
+
'/map/world-events': {
|
|
749
|
+
parameters: {
|
|
750
|
+
query?: never;
|
|
751
|
+
header?: never;
|
|
752
|
+
path?: never;
|
|
753
|
+
cookie?: never;
|
|
754
|
+
};
|
|
755
|
+
/**
|
|
756
|
+
* List world events
|
|
757
|
+
* @description <Note>
|
|
758
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
759
|
+
* </Note>
|
|
760
|
+
*
|
|
761
|
+
* The `schedule` field only contains the next visible run. The current schedule window is <Badge intent="success" minimal>15 minutes</Badge>. When no run starts inside that visibility window, `schedule` is `null`.
|
|
762
|
+
*/
|
|
763
|
+
get: operations['list-world-events'];
|
|
764
|
+
put?: never;
|
|
765
|
+
post?: never;
|
|
766
|
+
delete?: never;
|
|
767
|
+
options?: never;
|
|
768
|
+
head?: never;
|
|
769
|
+
patch?: never;
|
|
770
|
+
trace?: never;
|
|
771
|
+
};
|
|
772
|
+
'/map/camps': {
|
|
773
|
+
parameters: {
|
|
774
|
+
query?: never;
|
|
775
|
+
header?: never;
|
|
776
|
+
path?: never;
|
|
777
|
+
cookie?: never;
|
|
778
|
+
};
|
|
779
|
+
/**
|
|
780
|
+
* List map camps
|
|
781
|
+
* @description <Note>
|
|
782
|
+
* This endpoint is cached for <Badge intent="success" minimal>1 minute</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
783
|
+
* </Note>
|
|
784
|
+
*
|
|
785
|
+
* <Info>
|
|
786
|
+
* Use `level` to preview rewards for a specific level. The API picks the highest available preview threshold that does not exceed the requested level. If none match, it falls back to the lowest available threshold.
|
|
787
|
+
* </Info>
|
|
788
|
+
*/
|
|
789
|
+
get: operations['list-map-camps'];
|
|
790
|
+
put?: never;
|
|
791
|
+
post?: never;
|
|
792
|
+
delete?: never;
|
|
793
|
+
options?: never;
|
|
794
|
+
head?: never;
|
|
795
|
+
patch?: never;
|
|
796
|
+
trace?: never;
|
|
797
|
+
};
|
|
798
|
+
'/map/raids': {
|
|
799
|
+
parameters: {
|
|
800
|
+
query?: never;
|
|
801
|
+
header?: never;
|
|
802
|
+
path?: never;
|
|
803
|
+
cookie?: never;
|
|
804
|
+
};
|
|
805
|
+
/**
|
|
806
|
+
* List map raids
|
|
807
|
+
* @description <Note>
|
|
808
|
+
* This endpoint is cached for <Badge intent="success" minimal>1 minute</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
809
|
+
* </Note>
|
|
810
|
+
*
|
|
811
|
+
* <Info>
|
|
812
|
+
* Use `level` to preview rewards for a specific level. The API picks the highest available preview threshold that does not exceed the requested level. If none match, it falls back to the lowest available threshold.
|
|
813
|
+
* </Info>
|
|
814
|
+
*/
|
|
815
|
+
get: operations['list-map-raids'];
|
|
816
|
+
put?: never;
|
|
817
|
+
post?: never;
|
|
818
|
+
delete?: never;
|
|
819
|
+
options?: never;
|
|
820
|
+
head?: never;
|
|
821
|
+
patch?: never;
|
|
822
|
+
trace?: never;
|
|
823
|
+
};
|
|
824
|
+
'/map/loot-pools': {
|
|
825
|
+
parameters: {
|
|
826
|
+
query?: never;
|
|
827
|
+
header?: never;
|
|
828
|
+
path?: never;
|
|
829
|
+
cookie?: never;
|
|
830
|
+
};
|
|
831
|
+
/**
|
|
832
|
+
* List map loot pools
|
|
833
|
+
* @description <Note>
|
|
834
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
835
|
+
* </Note>
|
|
836
|
+
*
|
|
837
|
+
* <Info>
|
|
838
|
+
* Use `level` to preview rewards for a specific level. The API picks the highest available preview threshold that does not exceed the requested level. If none match, it falls back to the lowest available threshold.
|
|
839
|
+
* </Info>
|
|
840
|
+
*/
|
|
841
|
+
get: operations['list-map-loot-pools'];
|
|
842
|
+
put?: never;
|
|
843
|
+
post?: never;
|
|
844
|
+
delete?: never;
|
|
845
|
+
options?: never;
|
|
846
|
+
head?: never;
|
|
847
|
+
patch?: never;
|
|
848
|
+
trace?: never;
|
|
849
|
+
};
|
|
850
|
+
'/map/gathering-nodes': {
|
|
851
|
+
parameters: {
|
|
852
|
+
query?: never;
|
|
853
|
+
header?: never;
|
|
854
|
+
path?: never;
|
|
855
|
+
cookie?: never;
|
|
856
|
+
};
|
|
857
|
+
/**
|
|
858
|
+
* List gathering nodes
|
|
859
|
+
* @description <Note>
|
|
860
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
861
|
+
* </Note>
|
|
862
|
+
*
|
|
863
|
+
* `type` distinguishes normal node spots from wall and corner placements used by the web map.
|
|
864
|
+
*/
|
|
865
|
+
get: operations['list-gathering-nodes'];
|
|
866
|
+
put?: never;
|
|
867
|
+
post?: never;
|
|
868
|
+
delete?: never;
|
|
869
|
+
options?: never;
|
|
870
|
+
head?: never;
|
|
871
|
+
patch?: never;
|
|
872
|
+
trace?: never;
|
|
873
|
+
};
|
|
874
|
+
'/map/quests': {
|
|
875
|
+
parameters: {
|
|
876
|
+
query?: never;
|
|
877
|
+
header?: never;
|
|
878
|
+
path?: never;
|
|
879
|
+
cookie?: never;
|
|
880
|
+
};
|
|
881
|
+
/**
|
|
882
|
+
* Get total quest count
|
|
883
|
+
* @description <Note>
|
|
884
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>MAP</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
885
|
+
* </Note>
|
|
886
|
+
*/
|
|
887
|
+
get: operations['get-quest-count'];
|
|
888
|
+
put?: never;
|
|
889
|
+
post?: never;
|
|
890
|
+
delete?: never;
|
|
891
|
+
options?: never;
|
|
892
|
+
head?: never;
|
|
893
|
+
patch?: never;
|
|
894
|
+
trace?: never;
|
|
895
|
+
};
|
|
896
|
+
'/search/{query}': {
|
|
897
|
+
parameters: {
|
|
898
|
+
query?: never;
|
|
899
|
+
header?: never;
|
|
900
|
+
path?: never;
|
|
901
|
+
cookie?: never;
|
|
902
|
+
};
|
|
903
|
+
/**
|
|
904
|
+
* Search across public resources
|
|
905
|
+
* @description <Note>
|
|
906
|
+
* This endpoint is cached for <Badge intent="warning" minimal>10 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
907
|
+
* </Note>
|
|
908
|
+
*
|
|
909
|
+
* Item results use the same structure as item responses.
|
|
910
|
+
*
|
|
911
|
+
* Player results are limited to 20 entries and guild results are limited to 50 entries.
|
|
912
|
+
*/
|
|
913
|
+
get: operations['global-search'];
|
|
914
|
+
put?: never;
|
|
915
|
+
post?: never;
|
|
916
|
+
delete?: never;
|
|
917
|
+
options?: never;
|
|
918
|
+
head?: never;
|
|
919
|
+
patch?: never;
|
|
920
|
+
trace?: never;
|
|
921
|
+
};
|
|
922
|
+
'/leaderboards/types': {
|
|
923
|
+
parameters: {
|
|
924
|
+
query?: never;
|
|
925
|
+
header?: never;
|
|
926
|
+
path?: never;
|
|
927
|
+
cookie?: never;
|
|
928
|
+
};
|
|
929
|
+
/**
|
|
930
|
+
* List leaderboard types
|
|
931
|
+
* @description <Note>
|
|
932
|
+
* This endpoint is cached for <Badge intent="warning" minimal>10 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>LEADERBOARDS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
933
|
+
* </Note>
|
|
934
|
+
*
|
|
935
|
+
* Use this list to know which leaderboard types can be requested from `GET /leaderboards/{lb_type}`.
|
|
936
|
+
*/
|
|
937
|
+
get: operations['list-leaderboard-types'];
|
|
938
|
+
put?: never;
|
|
939
|
+
post?: never;
|
|
940
|
+
delete?: never;
|
|
941
|
+
options?: never;
|
|
942
|
+
head?: never;
|
|
943
|
+
patch?: never;
|
|
944
|
+
trace?: never;
|
|
945
|
+
};
|
|
946
|
+
'/leaderboards/{lb_type}': {
|
|
947
|
+
parameters: {
|
|
948
|
+
query?: never;
|
|
949
|
+
header?: never;
|
|
950
|
+
path?: never;
|
|
951
|
+
cookie?: never;
|
|
952
|
+
};
|
|
953
|
+
/**
|
|
954
|
+
* Get leaderboard entries
|
|
955
|
+
* @description <Note>
|
|
956
|
+
* This endpoint is cached for <Badge intent="warning" minimal>10 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>LEADERBOARDS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
957
|
+
* </Note>
|
|
958
|
+
*
|
|
959
|
+
* Leaderboards update every 10 minutes for online players. Players who go offline between update intervals are flagged to update on the next interval.
|
|
960
|
+
*
|
|
961
|
+
* Use `resultLimit` with an integer below 1000 to limit the response size. The default limit is `100`.
|
|
962
|
+
*
|
|
963
|
+
* Character-based leaderboards can include `characterUuid` and `characterType`, such as profession or gamemode leaderboards.
|
|
964
|
+
*
|
|
965
|
+
* `metadata` contains variable keys depending on the leaderboard type. Some gamemode leaderboards also include top-level `characterData`, which has the same structure as player character data.
|
|
966
|
+
*
|
|
967
|
+
* Some entries also include optional rank presentation fields such as `rank`, `supportRank`, `shortenedRank`, `legacyRankColour`, and `rankBadge`.
|
|
968
|
+
*
|
|
969
|
+
* Guild season leaderboard types are dynamic and use the `guildSeason...` format returned by `GET /leaderboards/types`, such as `guildSeason32`.
|
|
970
|
+
*
|
|
971
|
+
* Raid leaderboards include a score and gambits used. Completion starts at 200, then adds +10, +20, or +30 for each gambit.
|
|
972
|
+
*
|
|
973
|
+
* `previousRanking` is stored daily depending on player activity. Subtracting `previousRanking` from the current ranking gives the player's leaderboard progression.
|
|
974
|
+
*/
|
|
975
|
+
get: operations['get-leaderboard'];
|
|
976
|
+
put?: never;
|
|
977
|
+
post?: never;
|
|
978
|
+
delete?: never;
|
|
979
|
+
options?: never;
|
|
980
|
+
head?: never;
|
|
981
|
+
patch?: never;
|
|
982
|
+
trace?: never;
|
|
983
|
+
};
|
|
984
|
+
'/publisher/articles/fetch/{article_type}/{pk}': {
|
|
985
|
+
parameters: {
|
|
986
|
+
query?: never;
|
|
987
|
+
header?: never;
|
|
988
|
+
path?: never;
|
|
989
|
+
cookie?: never;
|
|
990
|
+
};
|
|
991
|
+
/**
|
|
992
|
+
* Fetch a published article
|
|
993
|
+
* @description <Note>
|
|
994
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
995
|
+
* </Note>
|
|
996
|
+
*
|
|
997
|
+
* Article content uses standard Markdown syntax alongside Discord-specific syntax such as timestamps. See Discord Markdown and timestamp formatting for supported syntax.
|
|
998
|
+
*
|
|
999
|
+
* <Info>
|
|
1000
|
+
* Poll articles can include `question` content blocks. In those blocks, `content` can be either a plain string or a structured question object with answer options and requirements.
|
|
1001
|
+
* </Info>
|
|
1002
|
+
*/
|
|
1003
|
+
get: operations['fetch-publisher-article'];
|
|
1004
|
+
put?: never;
|
|
1005
|
+
post?: never;
|
|
1006
|
+
delete?: never;
|
|
1007
|
+
options?: never;
|
|
1008
|
+
head?: never;
|
|
1009
|
+
patch?: never;
|
|
1010
|
+
trace?: never;
|
|
1011
|
+
};
|
|
1012
|
+
'/publisher/articles/list/{article_type}': {
|
|
1013
|
+
parameters: {
|
|
1014
|
+
query?: never;
|
|
1015
|
+
header?: never;
|
|
1016
|
+
path?: never;
|
|
1017
|
+
cookie?: never;
|
|
1018
|
+
};
|
|
1019
|
+
/**
|
|
1020
|
+
* List published articles
|
|
1021
|
+
* @description <Note>
|
|
1022
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
1023
|
+
* </Note>
|
|
1024
|
+
*
|
|
1025
|
+
* Lists published articles.
|
|
1026
|
+
*
|
|
1027
|
+
* <Info>
|
|
1028
|
+
* Use `article` to return every published article type in the same response.
|
|
1029
|
+
* </Info>
|
|
1030
|
+
* This endpoint uses the generic pagination response format.
|
|
1031
|
+
*/
|
|
1032
|
+
get: operations['list-publisher-articles'];
|
|
1033
|
+
put?: never;
|
|
1034
|
+
post?: never;
|
|
1035
|
+
delete?: never;
|
|
1036
|
+
options?: never;
|
|
1037
|
+
head?: never;
|
|
1038
|
+
patch?: never;
|
|
1039
|
+
trace?: never;
|
|
1040
|
+
};
|
|
1041
|
+
'/publisher/videos/list': {
|
|
1042
|
+
parameters: {
|
|
1043
|
+
query?: never;
|
|
1044
|
+
header?: never;
|
|
1045
|
+
path?: never;
|
|
1046
|
+
cookie?: never;
|
|
1047
|
+
};
|
|
1048
|
+
/**
|
|
1049
|
+
* List featured videos
|
|
1050
|
+
* @description <Note>
|
|
1051
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
1052
|
+
* </Note>
|
|
1053
|
+
*/
|
|
1054
|
+
get: operations['list-publisher-videos'];
|
|
1055
|
+
put?: never;
|
|
1056
|
+
post?: never;
|
|
1057
|
+
delete?: never;
|
|
1058
|
+
options?: never;
|
|
1059
|
+
head?: never;
|
|
1060
|
+
patch?: never;
|
|
1061
|
+
trace?: never;
|
|
1062
|
+
};
|
|
1063
|
+
'/latest-news': {
|
|
1064
|
+
parameters: {
|
|
1065
|
+
query?: never;
|
|
1066
|
+
header?: never;
|
|
1067
|
+
path?: never;
|
|
1068
|
+
cookie?: never;
|
|
1069
|
+
};
|
|
1070
|
+
/**
|
|
1071
|
+
* Get legacy news
|
|
1072
|
+
* @description <Note>
|
|
1073
|
+
* This endpoint is cached for <Badge intent="error" minimal>1 hour</Badge> in the <Badge intent="success" minimal>SHARED</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>SHARED</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
1074
|
+
* </Note>
|
|
1075
|
+
*
|
|
1076
|
+
* Returns the latest legacy forum news.
|
|
1077
|
+
*/
|
|
1078
|
+
get: operations['list-latest-news'];
|
|
1079
|
+
put?: never;
|
|
1080
|
+
post?: never;
|
|
1081
|
+
delete?: never;
|
|
1082
|
+
options?: never;
|
|
1083
|
+
head?: never;
|
|
1084
|
+
patch?: never;
|
|
1085
|
+
trace?: never;
|
|
1086
|
+
};
|
|
1087
|
+
'/player/{username}': {
|
|
1088
|
+
parameters: {
|
|
1089
|
+
query?: never;
|
|
1090
|
+
header?: never;
|
|
1091
|
+
path?: never;
|
|
1092
|
+
cookie?: never;
|
|
1093
|
+
};
|
|
1094
|
+
/**
|
|
1095
|
+
* Get player profile
|
|
1096
|
+
* @description <Note>
|
|
1097
|
+
* This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits).
|
|
1098
|
+
* </Note>
|
|
1099
|
+
*
|
|
1100
|
+
* <Warning>
|
|
1101
|
+
* Player stats are subject to [Access Rules](/privacy), which can hide some of the stats. Check the `restrictions` object to see which access rules affected the response.
|
|
1102
|
+
* </Warning>
|
|
1103
|
+
* <Info>
|
|
1104
|
+
* It is recommended to request players by UUID. Username lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one player matches the query.
|
|
1105
|
+
* </Info>
|
|
1106
|
+
* `previousRanking` is stored daily based on player activity. Subtracting `previousRanking` from the current ranking gives the player's leaderboard progression.
|
|
1107
|
+
*
|
|
1108
|
+
* <Info>
|
|
1109
|
+
* Use `fullResult` to include full character data. The `characters` object uses the same structure as [GET /player/{username}/characters/{uuid}](api:GET/player/{username}/characters/{uuid}).
|
|
1110
|
+
* </Info>
|
|
1111
|
+
*/
|
|
1112
|
+
get: operations['get-player'];
|
|
1113
|
+
put?: never;
|
|
1114
|
+
post?: never;
|
|
1115
|
+
delete?: never;
|
|
1116
|
+
options?: never;
|
|
1117
|
+
head?: never;
|
|
1118
|
+
patch?: never;
|
|
1119
|
+
trace?: never;
|
|
1120
|
+
};
|
|
1121
|
+
}
|
|
1122
|
+
export type webhooks = Record<string, never>;
|
|
1123
|
+
export interface components {
|
|
1124
|
+
schemas: {
|
|
1125
|
+
/**
|
|
1126
|
+
* PlayerGetParametersIdentifier
|
|
1127
|
+
* @enum {string}
|
|
1128
|
+
*/
|
|
1129
|
+
PlayerGetParametersIdentifier: 'username' | 'uuid';
|
|
1130
|
+
/** PlayerGetParametersServer */
|
|
1131
|
+
PlayerGetParametersServer: string | number;
|
|
1132
|
+
/** OnlinePlayerListPlayers */
|
|
1133
|
+
OnlinePlayerListPlayers: {
|
|
1134
|
+
/** Format: server */
|
|
1135
|
+
identifier?: string;
|
|
1136
|
+
};
|
|
1137
|
+
/** OnlinePlayerList */
|
|
1138
|
+
OnlinePlayerList: {
|
|
1139
|
+
total: number;
|
|
1140
|
+
players: components['schemas']['OnlinePlayerListPlayers'];
|
|
1141
|
+
};
|
|
1142
|
+
/** LegacyRankColour */
|
|
1143
|
+
LegacyRankColour: {
|
|
1144
|
+
main: string;
|
|
1145
|
+
sub: string;
|
|
1146
|
+
};
|
|
1147
|
+
/** PlayerIdentity */
|
|
1148
|
+
PlayerIdentity: {
|
|
1149
|
+
username: string;
|
|
1150
|
+
online: boolean;
|
|
1151
|
+
nickname: string | null;
|
|
1152
|
+
rank: string;
|
|
1153
|
+
supportRank: string | null;
|
|
1154
|
+
shortenedRank: string;
|
|
1155
|
+
legacyRankColour: components['schemas']['LegacyRankColour'];
|
|
1156
|
+
rankBadge: string;
|
|
1157
|
+
};
|
|
1158
|
+
/** Error */
|
|
1159
|
+
Error: {
|
|
1160
|
+
error: string;
|
|
1161
|
+
detail: string;
|
|
1162
|
+
code: number;
|
|
1163
|
+
};
|
|
1164
|
+
/**
|
|
1165
|
+
* PlayerUsernameGetParametersFullResult
|
|
1166
|
+
* @enum {string}
|
|
1167
|
+
*/
|
|
1168
|
+
PlayerUsernameGetParametersFullResult: '';
|
|
1169
|
+
/** GuildReference */
|
|
1170
|
+
GuildReference: {
|
|
1171
|
+
/** Format: uuid */
|
|
1172
|
+
uuid: string;
|
|
1173
|
+
name: string;
|
|
1174
|
+
prefix: string;
|
|
1175
|
+
rank?: string | null;
|
|
1176
|
+
rankStars?: string | null;
|
|
1177
|
+
};
|
|
1178
|
+
/**
|
|
1179
|
+
* RankMap
|
|
1180
|
+
* @description Map of leaderboard type/name to rank position. See [GET /leaderboards/types](api:GET/leaderboards/types) for possible types.
|
|
1181
|
+
*/
|
|
1182
|
+
RankMap: {
|
|
1183
|
+
[key: string]: number;
|
|
1184
|
+
};
|
|
1185
|
+
/** DungeonList */
|
|
1186
|
+
DungeonList: {
|
|
1187
|
+
'Skeleton'?: number;
|
|
1188
|
+
'Decrepit Sewers'?: number;
|
|
1189
|
+
'Corrupted Decrepit Sewers'?: number;
|
|
1190
|
+
'Spider'?: number;
|
|
1191
|
+
'Infested Pit'?: number;
|
|
1192
|
+
'Zombie'?: number;
|
|
1193
|
+
'Timelost Sanctum'?: number;
|
|
1194
|
+
'Underworld Crypt'?: number;
|
|
1195
|
+
'Corrupted Underworld Crypt'?: number;
|
|
1196
|
+
'Animal'?: number;
|
|
1197
|
+
'Lost Sanctuary'?: number;
|
|
1198
|
+
'Corrupted Lost Sanctuary'?: number;
|
|
1199
|
+
'Silverfish'?: number;
|
|
1200
|
+
'Sand-Swept Tomb'?: number;
|
|
1201
|
+
'Corrupted Sand-Swept Tomb'?: number;
|
|
1202
|
+
'Ice'?: number;
|
|
1203
|
+
'Ice Barrows'?: number;
|
|
1204
|
+
'Corrupted Ice Barrows'?: number;
|
|
1205
|
+
'Jungle'?: number;
|
|
1206
|
+
'Undergrowth Ruins'?: number;
|
|
1207
|
+
'Corrupted Undergrowth Ruins'?: number;
|
|
1208
|
+
'Ocean'?: number;
|
|
1209
|
+
'Galleon\'s Graveyard'?: number;
|
|
1210
|
+
'Corrupted Galleon\'s Graveyard'?: number;
|
|
1211
|
+
'Fallen Factory'?: number;
|
|
1212
|
+
'Eldritch Outlook'?: number;
|
|
1213
|
+
};
|
|
1214
|
+
/** DungeonCountList */
|
|
1215
|
+
DungeonCountList: {
|
|
1216
|
+
total: number;
|
|
1217
|
+
list: components['schemas']['DungeonList'];
|
|
1218
|
+
};
|
|
1219
|
+
/** RaidList */
|
|
1220
|
+
RaidList: {
|
|
1221
|
+
'Nest of the Grootslangs'?: number;
|
|
1222
|
+
'Orphion\'s Nexus of Light'?: number;
|
|
1223
|
+
'The Canyon Colossus'?: number;
|
|
1224
|
+
'The Nameless Anomaly'?: number;
|
|
1225
|
+
'The Wartorn Palace'?: number;
|
|
1226
|
+
};
|
|
1227
|
+
/** RaidCountList */
|
|
1228
|
+
RaidCountList: {
|
|
1229
|
+
total: number;
|
|
1230
|
+
list: components['schemas']['RaidList'];
|
|
1231
|
+
};
|
|
1232
|
+
/** RaidStats */
|
|
1233
|
+
RaidStats: {
|
|
1234
|
+
damageTaken: number;
|
|
1235
|
+
damageDealt: number;
|
|
1236
|
+
healthHealed: number;
|
|
1237
|
+
deaths: number;
|
|
1238
|
+
buffsTaken: number;
|
|
1239
|
+
gambitsUsed: number;
|
|
1240
|
+
};
|
|
1241
|
+
/** PvpStats */
|
|
1242
|
+
PvpStats: {
|
|
1243
|
+
kills?: number;
|
|
1244
|
+
deaths?: number;
|
|
1245
|
+
};
|
|
1246
|
+
/** PlayerGlobalData */
|
|
1247
|
+
PlayerGlobalData: {
|
|
1248
|
+
contentCompletion: number;
|
|
1249
|
+
wars: number;
|
|
1250
|
+
totalLevel: number;
|
|
1251
|
+
mobsKilled: number;
|
|
1252
|
+
chestsFound: number;
|
|
1253
|
+
dungeons: components['schemas']['DungeonCountList'];
|
|
1254
|
+
raids: components['schemas']['RaidCountList'];
|
|
1255
|
+
worldEvents: number;
|
|
1256
|
+
lootruns: number;
|
|
1257
|
+
caves: number;
|
|
1258
|
+
completedQuests: number;
|
|
1259
|
+
guildRaids: components['schemas']['RaidCountList'] | null;
|
|
1260
|
+
raidStats: components['schemas']['RaidStats'] | null;
|
|
1261
|
+
pvp: components['schemas']['PvpStats'];
|
|
1262
|
+
};
|
|
1263
|
+
/** FeaturedStats */
|
|
1264
|
+
FeaturedStats: string | number;
|
|
1265
|
+
/** ProfessionProgress */
|
|
1266
|
+
ProfessionProgress: {
|
|
1267
|
+
level: number;
|
|
1268
|
+
xpPercent: number;
|
|
1269
|
+
};
|
|
1270
|
+
/** Professions */
|
|
1271
|
+
Professions: {
|
|
1272
|
+
fishing?: components['schemas']['ProfessionProgress'];
|
|
1273
|
+
woodcutting?: components['schemas']['ProfessionProgress'];
|
|
1274
|
+
mining?: components['schemas']['ProfessionProgress'];
|
|
1275
|
+
farming?: components['schemas']['ProfessionProgress'];
|
|
1276
|
+
scribing?: components['schemas']['ProfessionProgress'];
|
|
1277
|
+
jeweling?: components['schemas']['ProfessionProgress'];
|
|
1278
|
+
alchemism?: components['schemas']['ProfessionProgress'];
|
|
1279
|
+
cooking?: components['schemas']['ProfessionProgress'];
|
|
1280
|
+
weaponsmithing?: components['schemas']['ProfessionProgress'];
|
|
1281
|
+
tailoring?: components['schemas']['ProfessionProgress'];
|
|
1282
|
+
woodworking?: components['schemas']['ProfessionProgress'];
|
|
1283
|
+
armouring?: components['schemas']['ProfessionProgress'];
|
|
1284
|
+
};
|
|
1285
|
+
/** Character */
|
|
1286
|
+
Character: {
|
|
1287
|
+
type: string;
|
|
1288
|
+
reskin: string | null;
|
|
1289
|
+
nickname: string | null;
|
|
1290
|
+
level: number;
|
|
1291
|
+
xp: number;
|
|
1292
|
+
xpPercent: number;
|
|
1293
|
+
totalLevel: number;
|
|
1294
|
+
preEconomy: boolean | null;
|
|
1295
|
+
gamemode: string[];
|
|
1296
|
+
contentCompletion: number;
|
|
1297
|
+
wars: number;
|
|
1298
|
+
/** Format: double */
|
|
1299
|
+
playtime: number;
|
|
1300
|
+
mobsKilled: number;
|
|
1301
|
+
chestsFound: number;
|
|
1302
|
+
itemsIdentified: number;
|
|
1303
|
+
blocksWalked: number;
|
|
1304
|
+
logins: number;
|
|
1305
|
+
deaths: number;
|
|
1306
|
+
discoveries: number;
|
|
1307
|
+
pvp: components['schemas']['PvpStats'];
|
|
1308
|
+
skillPoints: {
|
|
1309
|
+
[key: string]: number;
|
|
1310
|
+
} | null;
|
|
1311
|
+
professions: components['schemas']['Professions'];
|
|
1312
|
+
dungeons: components['schemas']['DungeonCountList'] | null;
|
|
1313
|
+
raids: components['schemas']['RaidCountList'] | null;
|
|
1314
|
+
worldEvents: number;
|
|
1315
|
+
lootruns: number;
|
|
1316
|
+
caves: number;
|
|
1317
|
+
quests: string[];
|
|
1318
|
+
restrictions: {
|
|
1319
|
+
[key: string]: boolean;
|
|
1320
|
+
};
|
|
1321
|
+
removedStat: string[];
|
|
1322
|
+
};
|
|
1323
|
+
/** Player */
|
|
1324
|
+
Player: {
|
|
1325
|
+
username: string;
|
|
1326
|
+
online: boolean;
|
|
1327
|
+
server: string | null;
|
|
1328
|
+
/** Format: uuid */
|
|
1329
|
+
activeCharacter: string | null;
|
|
1330
|
+
nickname: string | null;
|
|
1331
|
+
/** Format: uuid */
|
|
1332
|
+
uuid: string;
|
|
1333
|
+
rank: string;
|
|
1334
|
+
rankBadge: string;
|
|
1335
|
+
legacyRankColour: components['schemas']['LegacyRankColour'];
|
|
1336
|
+
shortenedRank: string;
|
|
1337
|
+
supportRank: string | null;
|
|
1338
|
+
veteran: boolean;
|
|
1339
|
+
/** Format: date-time */
|
|
1340
|
+
lastJoin: string;
|
|
1341
|
+
guild: components['schemas']['GuildReference'] | null;
|
|
1342
|
+
ranking: components['schemas']['RankMap'];
|
|
1343
|
+
previousRanking: components['schemas']['RankMap'];
|
|
1344
|
+
/** Format: date-time */
|
|
1345
|
+
firstJoin: string;
|
|
1346
|
+
/** Format: double */
|
|
1347
|
+
playtime: number;
|
|
1348
|
+
globalData: components['schemas']['PlayerGlobalData'];
|
|
1349
|
+
featuredStats: components['schemas']['FeaturedStats'];
|
|
1350
|
+
wallpaper: string;
|
|
1351
|
+
avatar: string;
|
|
1352
|
+
restrictions: {
|
|
1353
|
+
[key: string]: boolean;
|
|
1354
|
+
};
|
|
1355
|
+
/**
|
|
1356
|
+
* @description <Info>
|
|
1357
|
+
* Only present when `fullResult` is enabled.
|
|
1358
|
+
* </Info>
|
|
1359
|
+
*/
|
|
1360
|
+
characters?: {
|
|
1361
|
+
[key: string]: components['schemas']['Character'];
|
|
1362
|
+
};
|
|
1363
|
+
};
|
|
1364
|
+
/** LightCharacterMeta */
|
|
1365
|
+
LightCharacterMeta: {
|
|
1366
|
+
died?: boolean;
|
|
1367
|
+
};
|
|
1368
|
+
/** LightCharacter */
|
|
1369
|
+
LightCharacter: {
|
|
1370
|
+
type: string;
|
|
1371
|
+
reskin: string | null;
|
|
1372
|
+
nickname: string | null;
|
|
1373
|
+
level: number;
|
|
1374
|
+
xp: number;
|
|
1375
|
+
xpPercent: number;
|
|
1376
|
+
totalLevel: number;
|
|
1377
|
+
gamemode: string[];
|
|
1378
|
+
meta: components['schemas']['LightCharacterMeta'];
|
|
1379
|
+
};
|
|
1380
|
+
/**
|
|
1381
|
+
* AbilityMapNodeType
|
|
1382
|
+
* @enum {string}
|
|
1383
|
+
*/
|
|
1384
|
+
AbilityMapNodeType: 'ability' | 'connector';
|
|
1385
|
+
/** AbilityMapNodeCoordinates */
|
|
1386
|
+
AbilityMapNodeCoordinates: {
|
|
1387
|
+
x: number;
|
|
1388
|
+
y: number;
|
|
1389
|
+
};
|
|
1390
|
+
/** AbilityIconValueCustomModelData */
|
|
1391
|
+
AbilityIconValueCustomModelData: {
|
|
1392
|
+
rangeDispatch: number[];
|
|
1393
|
+
};
|
|
1394
|
+
/** AbilityIconValue */
|
|
1395
|
+
AbilityIconValue: {
|
|
1396
|
+
id: string;
|
|
1397
|
+
name: string;
|
|
1398
|
+
customModelData: components['schemas']['AbilityIconValueCustomModelData'];
|
|
1399
|
+
};
|
|
1400
|
+
/** AbilityIcon */
|
|
1401
|
+
AbilityIcon: {
|
|
1402
|
+
name?: string;
|
|
1403
|
+
value: components['schemas']['AbilityIconValue'];
|
|
1404
|
+
format: string;
|
|
1405
|
+
};
|
|
1406
|
+
/** AbilityMapNodeMetaIcon */
|
|
1407
|
+
AbilityMapNodeMetaIcon: components['schemas']['AbilityIcon'] | string;
|
|
1408
|
+
/** AbilityMapNodeMeta */
|
|
1409
|
+
AbilityMapNodeMeta: {
|
|
1410
|
+
icon?: components['schemas']['AbilityMapNodeMetaIcon'];
|
|
1411
|
+
page: number;
|
|
1412
|
+
id?: string;
|
|
1413
|
+
};
|
|
1414
|
+
/** AbilityMapNode */
|
|
1415
|
+
AbilityMapNode: {
|
|
1416
|
+
type: components['schemas']['AbilityMapNodeType'];
|
|
1417
|
+
coordinates: components['schemas']['AbilityMapNodeCoordinates'];
|
|
1418
|
+
meta: components['schemas']['AbilityMapNodeMeta'];
|
|
1419
|
+
family: string[];
|
|
1420
|
+
};
|
|
1421
|
+
/** AbilityMapPages */
|
|
1422
|
+
AbilityMapPages: {
|
|
1423
|
+
[key: string]: components['schemas']['AbilityMapNode'][];
|
|
1424
|
+
};
|
|
1425
|
+
/** OAuthApplication */
|
|
1426
|
+
OAuthApplication: {
|
|
1427
|
+
client_id: string;
|
|
1428
|
+
scopes: string[];
|
|
1429
|
+
};
|
|
1430
|
+
/** OAuthProfile */
|
|
1431
|
+
OAuthProfile: {
|
|
1432
|
+
username: string;
|
|
1433
|
+
primary: boolean;
|
|
1434
|
+
rank: string;
|
|
1435
|
+
supportRank: string | null;
|
|
1436
|
+
shortenedRank: string;
|
|
1437
|
+
legacyRankColour: components['schemas']['LegacyRankColour'];
|
|
1438
|
+
rankBadge: string;
|
|
1439
|
+
accessRules: {
|
|
1440
|
+
[key: string]: string;
|
|
1441
|
+
};
|
|
1442
|
+
};
|
|
1443
|
+
/** OAuthMeResponse */
|
|
1444
|
+
OAuthMeResponse: {
|
|
1445
|
+
application: components['schemas']['OAuthApplication'];
|
|
1446
|
+
profiles: {
|
|
1447
|
+
[key: string]: components['schemas']['OAuthProfile'];
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
/**
|
|
1451
|
+
* OAuthTokenExchangeRequestGrantType
|
|
1452
|
+
* @description Only `authorization_code` is supported.
|
|
1453
|
+
* @enum {string}
|
|
1454
|
+
*/
|
|
1455
|
+
OAuthTokenExchangeRequestGrantType: 'authorization_code';
|
|
1456
|
+
/** OAuthTokenExchangeRequest */
|
|
1457
|
+
OAuthTokenExchangeRequest: {
|
|
1458
|
+
/** @description Only `authorization_code` is supported. */
|
|
1459
|
+
grant_type: components['schemas']['OAuthTokenExchangeRequestGrantType'];
|
|
1460
|
+
/** @description One-time authorization code. Expires after 5 minutes. */
|
|
1461
|
+
code: string;
|
|
1462
|
+
/**
|
|
1463
|
+
* Format: uri
|
|
1464
|
+
* @description Must match the redirect URI used during authorization.
|
|
1465
|
+
*/
|
|
1466
|
+
redirect_uri: string;
|
|
1467
|
+
client_id: string;
|
|
1468
|
+
/** @description Required for private applications. Must not be sent by public applications. */
|
|
1469
|
+
client_secret?: string;
|
|
1470
|
+
/** @description Required for public applications and for any authorization code created with PKCE. */
|
|
1471
|
+
code_verifier?: string;
|
|
1472
|
+
};
|
|
1473
|
+
/**
|
|
1474
|
+
* OAuthTokenResponseTokenType
|
|
1475
|
+
* @enum {string}
|
|
1476
|
+
*/
|
|
1477
|
+
OAuthTokenResponseTokenType: 'bearer';
|
|
1478
|
+
/** OAuthTokenResponse */
|
|
1479
|
+
OAuthTokenResponse: {
|
|
1480
|
+
access_token: string;
|
|
1481
|
+
token_type: components['schemas']['OAuthTokenResponseTokenType'];
|
|
1482
|
+
/** @description Space-delimited granted scopes. */
|
|
1483
|
+
scope: string;
|
|
1484
|
+
};
|
|
1485
|
+
/**
|
|
1486
|
+
* GuildListGuildGetParametersIdentifier
|
|
1487
|
+
* @enum {string}
|
|
1488
|
+
*/
|
|
1489
|
+
GuildListGuildGetParametersIdentifier: 'username' | 'uuid';
|
|
1490
|
+
/** GuildListEntryByName */
|
|
1491
|
+
GuildListEntryByName: {
|
|
1492
|
+
/** Format: uuid */
|
|
1493
|
+
uuid: string;
|
|
1494
|
+
prefix: string;
|
|
1495
|
+
};
|
|
1496
|
+
/** GuildListByName */
|
|
1497
|
+
GuildListByName: {
|
|
1498
|
+
[key: string]: components['schemas']['GuildListEntryByName'];
|
|
1499
|
+
};
|
|
1500
|
+
/** GuildListEntryByUuid */
|
|
1501
|
+
GuildListEntryByUuid: {
|
|
1502
|
+
name: string;
|
|
1503
|
+
prefix: string;
|
|
1504
|
+
};
|
|
1505
|
+
/** GuildListByUuid */
|
|
1506
|
+
GuildListByUuid: {
|
|
1507
|
+
[key: string]: components['schemas']['GuildListEntryByUuid'];
|
|
1508
|
+
};
|
|
1509
|
+
/** Guild_listGuilds_Response_200 */
|
|
1510
|
+
Guild_listGuilds_Response_200: components['schemas']['GuildListByName'] | components['schemas']['GuildListByUuid'];
|
|
1511
|
+
/** TerritoryGuildReference */
|
|
1512
|
+
TerritoryGuildReference: {
|
|
1513
|
+
/** Format: uuid */
|
|
1514
|
+
uuid: string;
|
|
1515
|
+
name: string;
|
|
1516
|
+
prefix: string;
|
|
1517
|
+
/** @description Territory name of the current headquarters for the owning guild. */
|
|
1518
|
+
hq: string;
|
|
1519
|
+
};
|
|
1520
|
+
/**
|
|
1521
|
+
* TerritoryResourceType
|
|
1522
|
+
* @enum {string}
|
|
1523
|
+
*/
|
|
1524
|
+
TerritoryResourceType: 'EMERALD' | 'ORE' | 'WOOD' | 'FISH' | 'CROP';
|
|
1525
|
+
/** TerritoryResource */
|
|
1526
|
+
TerritoryResource: {
|
|
1527
|
+
type: components['schemas']['TerritoryResourceType'];
|
|
1528
|
+
/** @description Amount generated per hour. */
|
|
1529
|
+
generation: number;
|
|
1530
|
+
/** @description Amount currently stored. */
|
|
1531
|
+
stored: number;
|
|
1532
|
+
/** @description Maximum amount the territory can hold. */
|
|
1533
|
+
limit: number;
|
|
1534
|
+
};
|
|
1535
|
+
/**
|
|
1536
|
+
* TerritoryStorageLevel
|
|
1537
|
+
* @enum {string}
|
|
1538
|
+
*/
|
|
1539
|
+
TerritoryStorageLevel: 'VERY_LOW' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH';
|
|
1540
|
+
/** TerritoryLocation */
|
|
1541
|
+
TerritoryLocation: {
|
|
1542
|
+
start: unknown[];
|
|
1543
|
+
end: unknown[];
|
|
1544
|
+
};
|
|
1545
|
+
/** Territory */
|
|
1546
|
+
Territory: {
|
|
1547
|
+
guild: components['schemas']['TerritoryGuildReference'];
|
|
1548
|
+
/** Format: date-time */
|
|
1549
|
+
acquired: string;
|
|
1550
|
+
/** @description Whether this territory is currently a headquarters. */
|
|
1551
|
+
hq: boolean;
|
|
1552
|
+
resources: components['schemas']['TerritoryResource'][];
|
|
1553
|
+
/** @description Connected territory names for the current territory. */
|
|
1554
|
+
links: string[];
|
|
1555
|
+
treasury: components['schemas']['TerritoryStorageLevel'];
|
|
1556
|
+
defences: components['schemas']['TerritoryStorageLevel'];
|
|
1557
|
+
location: components['schemas']['TerritoryLocation'];
|
|
1558
|
+
};
|
|
1559
|
+
/**
|
|
1560
|
+
* GuildSeasonRewardConditionType
|
|
1561
|
+
* @enum {string}
|
|
1562
|
+
*/
|
|
1563
|
+
GuildSeasonRewardConditionType: 'SR' | 'LEADERBOARD_POSITION';
|
|
1564
|
+
/** GuildSeasonRewardCondition */
|
|
1565
|
+
GuildSeasonRewardCondition: {
|
|
1566
|
+
type: components['schemas']['GuildSeasonRewardConditionType'];
|
|
1567
|
+
value: number;
|
|
1568
|
+
};
|
|
1569
|
+
/**
|
|
1570
|
+
* GuildSeasonRewardType
|
|
1571
|
+
* @enum {string}
|
|
1572
|
+
*/
|
|
1573
|
+
GuildSeasonRewardType: 'BADGE' | 'EFFECT' | 'COSMETIC' | 'EMERALD' | 'PRIVATE_BANK_SLOT' | 'PUBLIC_BANK_SLOT' | 'GUILD_TOME' | 'STRUCTURE';
|
|
1574
|
+
/** GuildSeasonRewardValue */
|
|
1575
|
+
GuildSeasonRewardValue: number | string;
|
|
1576
|
+
/** GuildSeasonReward */
|
|
1577
|
+
GuildSeasonReward: {
|
|
1578
|
+
condition: components['schemas']['GuildSeasonRewardCondition'];
|
|
1579
|
+
type: components['schemas']['GuildSeasonRewardType'];
|
|
1580
|
+
value: components['schemas']['GuildSeasonRewardValue'] | null;
|
|
1581
|
+
/** Format: date-time */
|
|
1582
|
+
expires: string | null;
|
|
1583
|
+
};
|
|
1584
|
+
/** GuildSeasonDefinition */
|
|
1585
|
+
GuildSeasonDefinition: {
|
|
1586
|
+
/** Format: date-time */
|
|
1587
|
+
initDate?: string | null;
|
|
1588
|
+
/** Format: date-time */
|
|
1589
|
+
endDate?: string | null;
|
|
1590
|
+
territoryHoldingSrPerHour: number;
|
|
1591
|
+
srPerWar: number;
|
|
1592
|
+
ratingRewards: components['schemas']['GuildSeasonReward'][];
|
|
1593
|
+
leaderboardRewards: components['schemas']['GuildSeasonReward'][];
|
|
1594
|
+
};
|
|
1595
|
+
/** GuildSeasonList */
|
|
1596
|
+
GuildSeasonList: {
|
|
1597
|
+
[key: string]: components['schemas']['GuildSeasonDefinition'];
|
|
1598
|
+
};
|
|
1599
|
+
/**
|
|
1600
|
+
* GuildPrefixQueryGetParametersIdentifier
|
|
1601
|
+
* @enum {string}
|
|
1602
|
+
*/
|
|
1603
|
+
GuildPrefixQueryGetParametersIdentifier: 'username' | 'uuid';
|
|
1604
|
+
/**
|
|
1605
|
+
* GuildMemberWeekly
|
|
1606
|
+
* @description Weekly guild objective data. This object is empty unless the authenticated requester is at least STRATEGIST in the guild.
|
|
1607
|
+
*/
|
|
1608
|
+
GuildMemberWeekly: {
|
|
1609
|
+
completed?: boolean;
|
|
1610
|
+
streak?: number;
|
|
1611
|
+
};
|
|
1612
|
+
/** GuildMemberGlobalData */
|
|
1613
|
+
GuildMemberGlobalData: {
|
|
1614
|
+
contentCompletion?: number;
|
|
1615
|
+
wars?: number;
|
|
1616
|
+
totalLevel?: number;
|
|
1617
|
+
mobsKilled?: number;
|
|
1618
|
+
chestsFound?: number;
|
|
1619
|
+
dungeons?: components['schemas']['DungeonCountList'];
|
|
1620
|
+
raids?: components['schemas']['RaidCountList'];
|
|
1621
|
+
worldEvents?: number;
|
|
1622
|
+
lootruns?: number;
|
|
1623
|
+
caves?: number;
|
|
1624
|
+
completedQuests?: number;
|
|
1625
|
+
pvp?: components['schemas']['PvpStats'];
|
|
1626
|
+
/** @description Guild raids completed while the player was in this guild only. */
|
|
1627
|
+
currentGuildRaids?: components['schemas']['RaidCountList'] | null;
|
|
1628
|
+
/** @description All guild raids completed by the player across every guild. */
|
|
1629
|
+
guildRaids?: components['schemas']['RaidCountList'] | null;
|
|
1630
|
+
/** Format: double */
|
|
1631
|
+
playtime?: number;
|
|
1632
|
+
};
|
|
1633
|
+
/** GuildMemberRestrictions */
|
|
1634
|
+
GuildMemberRestrictions: {
|
|
1635
|
+
online_status?: boolean;
|
|
1636
|
+
main_access?: boolean;
|
|
1637
|
+
guild_high_ranked_access?: boolean;
|
|
1638
|
+
};
|
|
1639
|
+
/** GuildMember */
|
|
1640
|
+
GuildMember: {
|
|
1641
|
+
/** Format: uuid */
|
|
1642
|
+
uuid?: string;
|
|
1643
|
+
username?: string;
|
|
1644
|
+
online: boolean;
|
|
1645
|
+
/** Format: date-time */
|
|
1646
|
+
lastJoin: string | null;
|
|
1647
|
+
server: string | null;
|
|
1648
|
+
contributed: number;
|
|
1649
|
+
contributionRank: number;
|
|
1650
|
+
/** Format: date-time */
|
|
1651
|
+
joined: string;
|
|
1652
|
+
weekly: components['schemas']['GuildMemberWeekly'];
|
|
1653
|
+
globalData: components['schemas']['GuildMemberGlobalData'];
|
|
1654
|
+
restrictions: components['schemas']['GuildMemberRestrictions'];
|
|
1655
|
+
};
|
|
1656
|
+
/** GuildMembers */
|
|
1657
|
+
GuildMembers: {
|
|
1658
|
+
total: number;
|
|
1659
|
+
owner?: {
|
|
1660
|
+
[key: string]: components['schemas']['GuildMember'];
|
|
1661
|
+
};
|
|
1662
|
+
chief?: {
|
|
1663
|
+
[key: string]: components['schemas']['GuildMember'];
|
|
1664
|
+
};
|
|
1665
|
+
strategist?: {
|
|
1666
|
+
[key: string]: components['schemas']['GuildMember'];
|
|
1667
|
+
};
|
|
1668
|
+
recruiter?: {
|
|
1669
|
+
[key: string]: components['schemas']['GuildMember'];
|
|
1670
|
+
};
|
|
1671
|
+
recruit?: {
|
|
1672
|
+
[key: string]: components['schemas']['GuildMember'];
|
|
1673
|
+
};
|
|
1674
|
+
};
|
|
1675
|
+
/**
|
|
1676
|
+
* BannerColour
|
|
1677
|
+
* @enum {string}
|
|
1678
|
+
*/
|
|
1679
|
+
BannerColour: 'BLACK' | 'RED' | 'GREEN' | 'BROWN' | 'BLUE' | 'PURPLE' | 'CYAN' | 'SILVER' | 'GRAY' | 'PINK' | 'LIME' | 'YELLOW' | 'LIGHT_BLUE' | 'MAGENTA' | 'ORANGE' | 'WHITE';
|
|
1680
|
+
/**
|
|
1681
|
+
* BannerPattern
|
|
1682
|
+
* @enum {string}
|
|
1683
|
+
*/
|
|
1684
|
+
BannerPattern: 'MOJANG' | 'RHOMBUS_MIDDLE' | 'SKULL' | 'SQUARE_BOTTOM_LEFT' | 'SQUARE_BOTTOM_RIGHT' | 'SQUARE_TOP_LEFT' | 'SQUARE_TOP_RIGHT' | 'STRAIGHT_CROSS' | 'STRIPE_BOTTOM' | 'STRIPE_CENTER' | 'STRIPE_DOWNLEFT' | 'STRIPE_DOWNRIGHT' | 'STRIPE_LEFT' | 'STRIPE_MIDDLE' | 'STRIPE_RIGHT' | 'STRIPE_SMALL' | 'STRIPE_TOP' | 'TRIANGLE_BOTTOM' | 'TRIANGLE_TOP' | 'TRIANGLES_BOTTOM' | 'TRIANGLES_TOP' | 'BASE' | 'BLANK' | 'BORDER' | 'BRICKS' | 'CIRCLE_MIDDLE' | 'CREEPER' | 'CROSS' | 'CURLY_BORDER' | 'DIAGONAL_LEFT' | 'DIAGONAL_LEFT_MIRROR' | 'DIAGONAL_RIGHT' | 'DIAGONAL_RIGHT_MIRROR' | 'FLOWER' | 'GRADIENT' | 'GRADIENT_UP' | 'HALF_HORIZONTAL' | 'HALF_HORIZONTAL_MIRROR' | 'HALF_VERTICAL' | 'HALF_VERTICAL_MIRROR';
|
|
1685
|
+
/** BannerLayer */
|
|
1686
|
+
BannerLayer: {
|
|
1687
|
+
color: components['schemas']['BannerColour'];
|
|
1688
|
+
pattern: components['schemas']['BannerPattern'];
|
|
1689
|
+
};
|
|
1690
|
+
/** GuildBanner */
|
|
1691
|
+
GuildBanner: {
|
|
1692
|
+
base: components['schemas']['BannerColour'];
|
|
1693
|
+
tier: number;
|
|
1694
|
+
structure: string;
|
|
1695
|
+
layers: components['schemas']['BannerLayer'][];
|
|
1696
|
+
};
|
|
1697
|
+
/** GuildSeasonRank */
|
|
1698
|
+
GuildSeasonRank: {
|
|
1699
|
+
rating: number;
|
|
1700
|
+
finalTerritories: number;
|
|
1701
|
+
};
|
|
1702
|
+
/** GuildSeasonRanks */
|
|
1703
|
+
GuildSeasonRanks: {
|
|
1704
|
+
[key: string]: components['schemas']['GuildSeasonRank'];
|
|
1705
|
+
};
|
|
1706
|
+
/** Guild */
|
|
1707
|
+
Guild: {
|
|
1708
|
+
/** Format: uuid */
|
|
1709
|
+
uuid: string;
|
|
1710
|
+
name: string;
|
|
1711
|
+
prefix: string;
|
|
1712
|
+
level: number;
|
|
1713
|
+
xpPercent: number;
|
|
1714
|
+
territories: number;
|
|
1715
|
+
wars: number;
|
|
1716
|
+
raids: number;
|
|
1717
|
+
/** Format: date-time */
|
|
1718
|
+
created: string;
|
|
1719
|
+
members: components['schemas']['GuildMembers'];
|
|
1720
|
+
online: number;
|
|
1721
|
+
banner: components['schemas']['GuildBanner'];
|
|
1722
|
+
seasonRanks: components['schemas']['GuildSeasonRanks'];
|
|
1723
|
+
ranking: components['schemas']['RankMap'];
|
|
1724
|
+
};
|
|
1725
|
+
/**
|
|
1726
|
+
* GuildUuidQueryGetParametersIdentifier
|
|
1727
|
+
* @enum {string}
|
|
1728
|
+
*/
|
|
1729
|
+
GuildUuidQueryGetParametersIdentifier: 'username' | 'uuid';
|
|
1730
|
+
/**
|
|
1731
|
+
* GuildQueryGetParametersIdentifier
|
|
1732
|
+
* @enum {string}
|
|
1733
|
+
*/
|
|
1734
|
+
GuildQueryGetParametersIdentifier: 'username' | 'uuid';
|
|
1735
|
+
/**
|
|
1736
|
+
* ItemDatabaseGetParametersFullResult
|
|
1737
|
+
* @enum {string}
|
|
1738
|
+
*/
|
|
1739
|
+
ItemDatabaseGetParametersFullResult: '';
|
|
1740
|
+
/** PaginationController */
|
|
1741
|
+
PaginationController: {
|
|
1742
|
+
count: number;
|
|
1743
|
+
current_count: number;
|
|
1744
|
+
pages: number;
|
|
1745
|
+
prev: number | null;
|
|
1746
|
+
current: number;
|
|
1747
|
+
next: number | null;
|
|
1748
|
+
};
|
|
1749
|
+
/**
|
|
1750
|
+
* ItemTypeName
|
|
1751
|
+
* @enum {string}
|
|
1752
|
+
*/
|
|
1753
|
+
ItemTypeName: 'weapon' | 'armour' | 'accessory' | 'charm' | 'tome' | 'tool' | 'material' | 'ingredient';
|
|
1754
|
+
/**
|
|
1755
|
+
* ItemSubTypeName
|
|
1756
|
+
* @enum {string}
|
|
1757
|
+
*/
|
|
1758
|
+
ItemSubTypeName: 'bow' | 'dagger' | 'relik' | 'spear' | 'wand' | 'boots' | 'chestplate' | 'helmet' | 'leggings' | 'bracelet' | 'necklace' | 'ring' | 'guildTome' | 'armourTome' | 'expertiseTome' | 'marathonTome' | 'mysticismTome' | 'lootrunTome' | 'weaponTome' | 'axe' | 'rod' | 'pickaxe' | 'scythe' | 'farming' | 'fishing' | 'mining' | 'woodcutting';
|
|
1759
|
+
/** ItemIcon */
|
|
1760
|
+
ItemIcon: {
|
|
1761
|
+
value: components['schemas']['AbilityIconValue'];
|
|
1762
|
+
format: string;
|
|
1763
|
+
};
|
|
1764
|
+
/**
|
|
1765
|
+
* ItemEmblemName
|
|
1766
|
+
* @enum {string}
|
|
1767
|
+
*/
|
|
1768
|
+
ItemEmblemName: 'diamond5' | 'diamond_5' | 'diamond1' | 'diamond_1' | 'diamond4' | 'diamond_4' | 'diamond6' | 'diamond_6' | 'diamond3' | 'diamond_3' | 'diamond2' | 'diamond_2' | 'shield5' | 'shield_5' | 'shield1' | 'shield_1' | 'shield4' | 'shield_4' | 'shield6' | 'shield_6' | 'shield3' | 'shield_3' | 'shield2' | 'shield_2' | 'shield' | 'sticker5' | 'sticker_5' | 'sticker1' | 'sticker_1' | 'sticker4' | 'sticker_4' | 'sticker6' | 'sticker_6' | 'sticker3' | 'sticker_3' | 'sticker2' | 'sticker_2' | 'square5' | 'square_5' | 'square4' | 'square_4' | 'square6' | 'square_6' | 'square';
|
|
1769
|
+
/**
|
|
1770
|
+
* ItemTierName
|
|
1771
|
+
* @enum {string}
|
|
1772
|
+
*/
|
|
1773
|
+
ItemTierName: 'rare' | 'unique' | 'normal' | 'legendary' | 'mythic' | 'fabled' | 'TIER3' | 'TIER2' | 'TIER1' | 'TIER0';
|
|
1774
|
+
/**
|
|
1775
|
+
* ItemAttackSpeedName
|
|
1776
|
+
* @enum {string}
|
|
1777
|
+
*/
|
|
1778
|
+
ItemAttackSpeedName: 'slow' | 'fast' | 'superSlow' | 'normal' | 'verySlow' | 'veryFast' | 'superFast';
|
|
1779
|
+
/**
|
|
1780
|
+
* ItemGatheringName
|
|
1781
|
+
* @enum {string}
|
|
1782
|
+
*/
|
|
1783
|
+
ItemGatheringName: 'farming' | 'fishing' | 'mining' | 'woodcutting';
|
|
1784
|
+
/**
|
|
1785
|
+
* ItemSetName
|
|
1786
|
+
* @enum {string}
|
|
1787
|
+
*/
|
|
1788
|
+
ItemSetName: 'boundless' | 'corrupted' | 'firemoss' | 'bony' | 'spore' | 'petal' | 'scrap' | 'beachside' | 'pigman' | 'toxic' | 'regal' | 'vexing' | 'voidglass' | 'cosmicFoundations' | 'snail' | 'thanosLegionnaire' | 'uth' | 'cosmic' | 'leaf' | 'tribal' | 'saint\'s' | 'visceral' | 'ascension' | 'ultramarine' | 'taigaElk' | 'clock' | 'nii' | 'moirai' | 'bleeding' | 'liffmail' | 'elf' | 'slime' | 'goblin' | 'ghostly' | 'horse' | 'snow' | 'skien\'s' | 'thunderRelic' | 'morph' | 'black' | 'earthRelic' | 'waterRelic' | 'relic' | 'outlaw' | 'silverfish' | 'nether' | 'fireRelic' | 'airRelic' | 'adventurer' | 'darkened' | 'bovine' | 'bear' | 'kaerynn' | 'villager' | 'spider' | 'conqueredSkies' | 'synchCore' | 'flashfire' | 'jester' | 'forgottenChronicles' | 'wynnterfest2016' | 'bandit\'s' | 'desert' | 'blackCatalyst' | 'constellation' | 'hallowynn2016';
|
|
1789
|
+
/** ItemRequirements */
|
|
1790
|
+
ItemRequirements: {
|
|
1791
|
+
level?: number;
|
|
1792
|
+
classRequirement?: string;
|
|
1793
|
+
strength?: number;
|
|
1794
|
+
dexterity?: number;
|
|
1795
|
+
intelligence?: number;
|
|
1796
|
+
defence?: number;
|
|
1797
|
+
agility?: number;
|
|
1798
|
+
};
|
|
1799
|
+
/** IdentificationValue1 */
|
|
1800
|
+
IdentificationValue1: {
|
|
1801
|
+
min: number;
|
|
1802
|
+
raw: number;
|
|
1803
|
+
max: number;
|
|
1804
|
+
};
|
|
1805
|
+
/** IdentificationValue */
|
|
1806
|
+
IdentificationValue: number | components['schemas']['IdentificationValue1'];
|
|
1807
|
+
/** Item */
|
|
1808
|
+
Item: {
|
|
1809
|
+
displayName: string;
|
|
1810
|
+
internalName: string;
|
|
1811
|
+
type: components['schemas']['ItemTypeName'];
|
|
1812
|
+
subType: components['schemas']['ItemSubTypeName'];
|
|
1813
|
+
icon: components['schemas']['ItemIcon'];
|
|
1814
|
+
emblem: components['schemas']['ItemEmblemName'];
|
|
1815
|
+
tier: components['schemas']['ItemTierName'];
|
|
1816
|
+
attackSpeed?: components['schemas']['ItemAttackSpeedName'];
|
|
1817
|
+
/** Format: double */
|
|
1818
|
+
averageDps?: number;
|
|
1819
|
+
restriction?: string;
|
|
1820
|
+
dropRestriction?: string;
|
|
1821
|
+
gathering?: components['schemas']['ItemGatheringName'];
|
|
1822
|
+
set?: components['schemas']['ItemSetName'];
|
|
1823
|
+
elements?: string[];
|
|
1824
|
+
requirements?: components['schemas']['ItemRequirements'];
|
|
1825
|
+
majorIds?: {
|
|
1826
|
+
[key: string]: string;
|
|
1827
|
+
};
|
|
1828
|
+
powderSlots?: number;
|
|
1829
|
+
lore?: string;
|
|
1830
|
+
identifications?: {
|
|
1831
|
+
[key: string]: components['schemas']['IdentificationValue'];
|
|
1832
|
+
};
|
|
1833
|
+
base?: {
|
|
1834
|
+
[key: string]: components['schemas']['IdentificationValue'];
|
|
1835
|
+
};
|
|
1836
|
+
};
|
|
1837
|
+
/** ItemDatabaseFull */
|
|
1838
|
+
ItemDatabaseFull: components['schemas']['Item'][];
|
|
1839
|
+
/** PaginatedItemResponse */
|
|
1840
|
+
PaginatedItemResponse: {
|
|
1841
|
+
controller: components['schemas']['PaginationController'];
|
|
1842
|
+
results: components['schemas']['ItemDatabaseFull'];
|
|
1843
|
+
};
|
|
1844
|
+
/**
|
|
1845
|
+
* ItemSearchPostParametersFullResult
|
|
1846
|
+
* @enum {string}
|
|
1847
|
+
*/
|
|
1848
|
+
ItemSearchPostParametersFullResult: '';
|
|
1849
|
+
/** ItemSearchRequestType1 */
|
|
1850
|
+
ItemSearchRequestType1: components['schemas']['ItemTypeName'][];
|
|
1851
|
+
/** ItemSearchRequestType */
|
|
1852
|
+
ItemSearchRequestType: components['schemas']['ItemTypeName'] | components['schemas']['ItemSearchRequestType1'];
|
|
1853
|
+
/** ItemSearchRequestTier1 */
|
|
1854
|
+
ItemSearchRequestTier1: components['schemas']['ItemTierName'][];
|
|
1855
|
+
/** ItemSearchRequestTier */
|
|
1856
|
+
ItemSearchRequestTier: components['schemas']['ItemTierName'] | components['schemas']['ItemSearchRequestTier1'];
|
|
1857
|
+
/** ItemSearchRequestAttackSpeed1 */
|
|
1858
|
+
ItemSearchRequestAttackSpeed1: components['schemas']['ItemAttackSpeedName'][];
|
|
1859
|
+
/** ItemSearchRequestAttackSpeed */
|
|
1860
|
+
ItemSearchRequestAttackSpeed: components['schemas']['ItemAttackSpeedName'] | components['schemas']['ItemSearchRequestAttackSpeed1'];
|
|
1861
|
+
/** ItemSearchRequestLevelRange */
|
|
1862
|
+
ItemSearchRequestLevelRange: number | number[];
|
|
1863
|
+
/** ItemSearchRequestProfessions1 */
|
|
1864
|
+
ItemSearchRequestProfessions1: components['schemas']['ItemGatheringName'][];
|
|
1865
|
+
/** ItemSearchRequestProfessions */
|
|
1866
|
+
ItemSearchRequestProfessions: components['schemas']['ItemGatheringName'] | components['schemas']['ItemSearchRequestProfessions1'];
|
|
1867
|
+
/**
|
|
1868
|
+
* ItemIdentificationKey
|
|
1869
|
+
* @enum {string}
|
|
1870
|
+
*/
|
|
1871
|
+
ItemIdentificationKey: 'baseDamage' | 'baseEarthDamage' | 'baseThunderDamage' | 'baseWaterDamage' | 'baseFireDamage' | 'baseAirDamage' | 'strength' | 'dexterity' | 'intelligence' | 'defence' | 'agility' | 'healthRegenRaw' | 'rawSpellDamage' | 'rawMainAttackDamage' | 'elementalDefence' | 'rawDefence' | 'walkSpeed' | 'airDamage' | 'thunderDamage' | 'spellDamage' | 'raw1stSpellCost' | 'knockback' | 'fireDamage' | 'mainAttackDamage' | 'lifeSteal' | 'manaSteal' | 'weakenEnemy' | 'waterDefence' | 'airDefence' | 'rawDexterity' | 'manaRegen' | 'combatExperience' | 'slowEnemy' | 'waterDamage' | 'earthDefence' | 'exploding' | 'thunderDefence' | 'rawAgility' | 'reflection' | 'earthDamage' | 'healthRegen' | 'rawHealth' | 'damage' | 'elementalDamage' | 'rawAttackSpeed' | 'sprint' | 'raw4thSpellCost' | 'rawIntelligence' | 'rawAirDamage' | 'jumpHeight' | 'rawStrength' | 'rawElementalSpellDamage' | 'thorns' | 'fireDefence' | 'raw3rdSpellCost' | 'sprintRegen' | 'poison' | 'elementalSpellDamage' | 'rawThunderMainAttackDamage' | 'rawEarthMainAttackDamage' | 'fireSpellDamage' | 'stealing' | 'rawThunderDamage' | 'mainAttackRange' | 'raw2ndSpellCost' | '1stSpellCost' | '3rdSpellCost' | 'rawFireDamage' | 'lootBonus' | 'fireMainAttackDamage' | 'rawAirMainAttackDamage' | 'rawDamage' | '4thSpellCost' | 'rawElementalDamage' | 'elementalMainAttackDamage' | 'earthMainAttackDamage' | 'thunderMainAttackDamage' | 'rawMaxMana' | 'rawAirSpellDamage' | '2ndSpellCost' | 'rawEarthDamage' | 'earthSpellDamage' | 'waterSpellDamage' | 'rawFireSpellDamage' | 'criticalDamageBonus' | 'airSpellDamage' | 'rawThunderSpellDamage' | 'rawWaterSpellDamage' | 'rawFireMainAttackDamage' | 'neutralSpellDamage' | 'neutralDamage' | 'rawNeutralMainAttackDamage' | 'thunderSpellDamage' | 'rawEarthSpellDamage' | 'rawNeutralDamage' | 'rawWaterDamage' | 'healingEfficiency' | 'rawElementalMainAttackDamage' | 'airMainAttackDamage' | 'rawNeutralSpellDamage' | 'baseHealth' | 'baseEarthDefence' | 'baseFireDefence' | 'baseThunderDefence' | 'baseWaterDefence' | 'baseAirDefence' | 'neutralMainAttackDamage' | 'leveledXpBonus' | 'damageFromMobs' | 'leveledLootBonus' | 'gatheringExperience' | 'gatherXpBonus' | 'gatherSpeed' | 'lootQuality' | 'rawWaterMainAttackDamage' | 'AGILITYBONUS' | 'STRENGTHBONUS';
|
|
1872
|
+
/** ItemSearchRequestIdentifications1 */
|
|
1873
|
+
ItemSearchRequestIdentifications1: components['schemas']['ItemIdentificationKey'][];
|
|
1874
|
+
/** ItemSearchRequestIdentifications */
|
|
1875
|
+
ItemSearchRequestIdentifications: components['schemas']['ItemIdentificationKey'] | components['schemas']['ItemSearchRequestIdentifications1'];
|
|
1876
|
+
/**
|
|
1877
|
+
* ItemMajorIdKey
|
|
1878
|
+
* @enum {string}
|
|
1879
|
+
*/
|
|
1880
|
+
ItemMajorIdKey: 'evershot' | 'forestSBlessing' | 'fallout' | 'twistingThreads' | 'pioneerSEcho' | 'altruism' | 'freerunner' | 'vedette' | 'realityRevision' | 'seekingModule' | 'fission' | 'freneticSpirit' | 'netShot' | 'deathSentence' | 'regicide' | 'selfSufficient' | 'napalm' | 'riverofSouls' | 'comboStomp' | 'gunkShot' | 'heartbeat' | 'methodical' | 'fantheHammer' | 'wormhole' | 'punishment' | 'grandInfluence' | 'cherryBombs' | 'greed' | 'windsurf' | 'hurricaneSEye' | 'sorcery' | 'rovingAssassin' | 'transcendence' | 'efflorescence' | 'spaceGlide' | 'heatShimmer' | 'soulEater' | 'juggle' | 'flurryofBlows' | 'incisionElegy' | 'lightningCrash' | 'livingMuseum' | 'manicEdge' | 'enlightenment' | 'ignitionWhirlwind' | 'lifestream' | 'peacefulEffigy' | 'stringsofFate' | 'ergosphere' | 'deadWeight' | 'sublimation' | 'furiousEffigy' | 'faustianGambit' | 'totemicFuse' | 'geocentrism' | 'gruesomeKnots' | 'starcrossed' | 'chaosReach' | 'flainRemnants' | 'litFuse' | 'rally' | 'hellfire' | 'paragon' | 'divineHonor' | 'trollBarge' | 'tidalDrift' | 'guardian' | 'lastResort' | 'saviourSSacrifice' | 'scarceComfort' | 'vitriol' | 'tackle' | 'divineRight' | 'slowBoil' | 'stagnantAir' | 'oldSpark' | 'oneselfUntoAll' | 'temblor' | 'overwhelm' | 'meteorCrash' | 'earthenSplinter' | 'entropy' | 'fixate' | 'lustrate' | 'inversion' | 'cosmicCapture' | 'orbitalChain' | 'perfectRecall' | 'gravityWell' | 'displace' | 'lockdown' | 'plague' | 'solarWind' | 'wavebreak' | '֎' | 'gentleGlow' | 'blindingLights' | 'oneiro' | 'dauntlessInferno' | 'fissure' | 'flashfreeze' | 'perilousFlare' | 'explosiveImpact' | 'escapeRoute' | 'lightweight' | 'pirouette' | 'lunge' | 'taunt' | 'desperateMeasures' | 'rockShield' | 'cannulate' | 'snowySteps' | 'phoenixBorn' | 'superconductor' | 'magnet' | 'alterEgo' | 'mangle' | 'intangible' | 'iceStorm' | 'pounce' | 'hawkeye' | 'orbwalk' | 'burntShadows' | 'frightorFlight' | 'festiveSpirit' | 'sunEater' | 'recklessAbandon' | 'expunge' | 'brachiate' | 'rustedIchor' | 'findThyself' | 'madness' | 'clamber' | 'splitSecond' | 'spectralMemory' | 'insoluble' | 'boundbyBlood' | 'mobMentality' | 'lasso' | 'coagulate' | 'flightBurst' | 'culicidaeCreed' | 'powerFist' | 'brutalBlow';
|
|
1881
|
+
/** ItemSearchRequestMajorIds1 */
|
|
1882
|
+
ItemSearchRequestMajorIds1: components['schemas']['ItemMajorIdKey'][];
|
|
1883
|
+
/** ItemSearchRequestMajorIds */
|
|
1884
|
+
ItemSearchRequestMajorIds: components['schemas']['ItemMajorIdKey'] | components['schemas']['ItemSearchRequestMajorIds1'];
|
|
1885
|
+
/** ItemSearchRequest */
|
|
1886
|
+
ItemSearchRequest: {
|
|
1887
|
+
query?: string | null;
|
|
1888
|
+
type?: components['schemas']['ItemSearchRequestType'];
|
|
1889
|
+
tier?: components['schemas']['ItemSearchRequestTier'];
|
|
1890
|
+
attackSpeed?: components['schemas']['ItemSearchRequestAttackSpeed'];
|
|
1891
|
+
levelRange?: components['schemas']['ItemSearchRequestLevelRange'];
|
|
1892
|
+
professions?: components['schemas']['ItemSearchRequestProfessions'];
|
|
1893
|
+
identifications?: components['schemas']['ItemSearchRequestIdentifications'];
|
|
1894
|
+
majorIds?: components['schemas']['ItemSearchRequestMajorIds'];
|
|
1895
|
+
};
|
|
1896
|
+
/**
|
|
1897
|
+
* ItemRecipeDatabaseGetParametersFullResult
|
|
1898
|
+
* @enum {string}
|
|
1899
|
+
*/
|
|
1900
|
+
ItemRecipeDatabaseGetParametersFullResult: '';
|
|
1901
|
+
/** IntegerRange */
|
|
1902
|
+
IntegerRange: {
|
|
1903
|
+
minimum: number;
|
|
1904
|
+
maximum: number;
|
|
1905
|
+
};
|
|
1906
|
+
/** RecipeMaterial */
|
|
1907
|
+
RecipeMaterial: {
|
|
1908
|
+
item: string;
|
|
1909
|
+
amount: number;
|
|
1910
|
+
};
|
|
1911
|
+
/** RecipeSpriteValue */
|
|
1912
|
+
RecipeSpriteValue: {
|
|
1913
|
+
id: string;
|
|
1914
|
+
customModelData: number;
|
|
1915
|
+
name: string;
|
|
1916
|
+
};
|
|
1917
|
+
/** RecipeSprite */
|
|
1918
|
+
RecipeSprite: {
|
|
1919
|
+
format: string;
|
|
1920
|
+
value: components['schemas']['RecipeSpriteValue'];
|
|
1921
|
+
name: string;
|
|
1922
|
+
};
|
|
1923
|
+
/** Recipe */
|
|
1924
|
+
Recipe: {
|
|
1925
|
+
internalName: string;
|
|
1926
|
+
type: string;
|
|
1927
|
+
skill: string;
|
|
1928
|
+
level: components['schemas']['IntegerRange'];
|
|
1929
|
+
durability?: components['schemas']['IntegerRange'];
|
|
1930
|
+
materials: components['schemas']['RecipeMaterial'][];
|
|
1931
|
+
healthOrDamage: components['schemas']['IntegerRange'];
|
|
1932
|
+
duration?: components['schemas']['IntegerRange'];
|
|
1933
|
+
basicDuration?: components['schemas']['IntegerRange'];
|
|
1934
|
+
sprites: {
|
|
1935
|
+
[key: string]: components['schemas']['RecipeSprite'];
|
|
1936
|
+
};
|
|
1937
|
+
xp: number;
|
|
1938
|
+
};
|
|
1939
|
+
/** RecipeDatabaseFull */
|
|
1940
|
+
RecipeDatabaseFull: components['schemas']['Recipe'][];
|
|
1941
|
+
/** PaginatedRecipeResponse */
|
|
1942
|
+
PaginatedRecipeResponse: {
|
|
1943
|
+
controller: components['schemas']['PaginationController'];
|
|
1944
|
+
results: components['schemas']['RecipeDatabaseFull'];
|
|
1945
|
+
};
|
|
1946
|
+
/**
|
|
1947
|
+
* ItemRecipeSearchPostParametersFullResult
|
|
1948
|
+
* @enum {string}
|
|
1949
|
+
*/
|
|
1950
|
+
ItemRecipeSearchPostParametersFullResult: '';
|
|
1951
|
+
/** SearchScalarOrList */
|
|
1952
|
+
SearchScalarOrList: string | string[];
|
|
1953
|
+
/** SearchIntegerOrRange */
|
|
1954
|
+
SearchIntegerOrRange: number | number[];
|
|
1955
|
+
/** RecipeSearchRequest */
|
|
1956
|
+
RecipeSearchRequest: {
|
|
1957
|
+
/** @description Match recipe `internalName` values by partial name, such as `1-3` or `Bow1-3`. */
|
|
1958
|
+
query?: components['schemas']['SearchScalarOrList'];
|
|
1959
|
+
/** @description Match an exact XP value or an inclusive XP range. */
|
|
1960
|
+
xp?: components['schemas']['SearchIntegerOrRange'];
|
|
1961
|
+
type?: components['schemas']['SearchScalarOrList'];
|
|
1962
|
+
skill?: components['schemas']['SearchScalarOrList'];
|
|
1963
|
+
/** @description Match material item names, case-insensitive. */
|
|
1964
|
+
materials?: components['schemas']['SearchScalarOrList'];
|
|
1965
|
+
level?: components['schemas']['SearchIntegerOrRange'];
|
|
1966
|
+
durability?: components['schemas']['SearchIntegerOrRange'];
|
|
1967
|
+
healthOrDamage?: components['schemas']['SearchIntegerOrRange'];
|
|
1968
|
+
duration?: components['schemas']['SearchIntegerOrRange'];
|
|
1969
|
+
basicDuration?: components['schemas']['SearchIntegerOrRange'];
|
|
1970
|
+
};
|
|
1971
|
+
/** ItemMetadataFilters */
|
|
1972
|
+
ItemMetadataFilters: {
|
|
1973
|
+
type: string[];
|
|
1974
|
+
advanced: {
|
|
1975
|
+
[key: string]: string[];
|
|
1976
|
+
};
|
|
1977
|
+
tier: {
|
|
1978
|
+
[key: string]: string[];
|
|
1979
|
+
};
|
|
1980
|
+
identifications: string[];
|
|
1981
|
+
majorIds: string[];
|
|
1982
|
+
levelRange: number[];
|
|
1983
|
+
};
|
|
1984
|
+
/** ItemStaticValueMap */
|
|
1985
|
+
ItemStaticValueMap: {
|
|
1986
|
+
[key: string]: number;
|
|
1987
|
+
};
|
|
1988
|
+
/** ItemMetadata */
|
|
1989
|
+
ItemMetadata: {
|
|
1990
|
+
filters: components['schemas']['ItemMetadataFilters'];
|
|
1991
|
+
static: components['schemas']['ItemStaticValueMap'];
|
|
1992
|
+
};
|
|
1993
|
+
/** ItemStaticMetadata */
|
|
1994
|
+
ItemStaticMetadata: {
|
|
1995
|
+
attackSpeed: components['schemas']['ItemStaticValueMap'];
|
|
1996
|
+
emblem: components['schemas']['ItemStaticValueMap'];
|
|
1997
|
+
gathering: components['schemas']['ItemStaticValueMap'];
|
|
1998
|
+
identifications: components['schemas']['ItemStaticValueMap'];
|
|
1999
|
+
majorIds: components['schemas']['ItemStaticValueMap'];
|
|
2000
|
+
set: components['schemas']['ItemStaticValueMap'];
|
|
2001
|
+
subType: components['schemas']['ItemStaticValueMap'];
|
|
2002
|
+
tier: components['schemas']['ItemStaticValueMap'];
|
|
2003
|
+
type: components['schemas']['ItemStaticValueMap'];
|
|
2004
|
+
};
|
|
2005
|
+
/** Item_getItemMetadata_Response_200 */
|
|
2006
|
+
Item_getItemMetadata_Response_200: components['schemas']['ItemMetadata'] | components['schemas']['ItemStaticMetadata'];
|
|
2007
|
+
/** ItemSetBonusMinor */
|
|
2008
|
+
ItemSetBonusMinor: number | string;
|
|
2009
|
+
/** ItemSetBonus */
|
|
2010
|
+
ItemSetBonus: {
|
|
2011
|
+
major: string[];
|
|
2012
|
+
minor: {
|
|
2013
|
+
[key: string]: components['schemas']['ItemSetBonusMinor'];
|
|
2014
|
+
};
|
|
2015
|
+
};
|
|
2016
|
+
/** ItemSet */
|
|
2017
|
+
ItemSet: {
|
|
2018
|
+
internalName: string;
|
|
2019
|
+
bonuses: {
|
|
2020
|
+
[key: string]: components['schemas']['ItemSetBonus'];
|
|
2021
|
+
};
|
|
2022
|
+
parts: string[];
|
|
2023
|
+
};
|
|
2024
|
+
/**
|
|
2025
|
+
* AbilityTreeTreeGetParametersTree
|
|
2026
|
+
* @enum {string}
|
|
2027
|
+
*/
|
|
2028
|
+
AbilityTreeTreeGetParametersTree: 'archer' | 'warrior' | 'assassin' | 'mage' | 'shaman';
|
|
2029
|
+
/** AbilityTreeArchetype */
|
|
2030
|
+
AbilityTreeArchetype: {
|
|
2031
|
+
name: string;
|
|
2032
|
+
description: string;
|
|
2033
|
+
shortDescription: string;
|
|
2034
|
+
icon: components['schemas']['AbilityIcon'];
|
|
2035
|
+
slot: number;
|
|
2036
|
+
};
|
|
2037
|
+
/** AbilityDefinitionCoordinates */
|
|
2038
|
+
AbilityDefinitionCoordinates: {
|
|
2039
|
+
x: number;
|
|
2040
|
+
y: number;
|
|
2041
|
+
};
|
|
2042
|
+
/** AbilityDefinition */
|
|
2043
|
+
AbilityDefinition: {
|
|
2044
|
+
name: string;
|
|
2045
|
+
icon: components['schemas']['AbilityIcon'];
|
|
2046
|
+
slot: number;
|
|
2047
|
+
coordinates: components['schemas']['AbilityDefinitionCoordinates'];
|
|
2048
|
+
description: string[];
|
|
2049
|
+
requirements: {
|
|
2050
|
+
[key: string]: number;
|
|
2051
|
+
};
|
|
2052
|
+
links: string[];
|
|
2053
|
+
locks: string[] | null;
|
|
2054
|
+
page: number;
|
|
2055
|
+
};
|
|
2056
|
+
/** AbilityTree */
|
|
2057
|
+
AbilityTree: {
|
|
2058
|
+
archetypes: {
|
|
2059
|
+
[key: string]: components['schemas']['AbilityTreeArchetype'];
|
|
2060
|
+
};
|
|
2061
|
+
pages: {
|
|
2062
|
+
[key: string]: {
|
|
2063
|
+
[key: string]: components['schemas']['AbilityDefinition'];
|
|
2064
|
+
};
|
|
2065
|
+
};
|
|
2066
|
+
};
|
|
2067
|
+
/**
|
|
2068
|
+
* AbilityMapTreeGetParametersTree
|
|
2069
|
+
* @enum {string}
|
|
2070
|
+
*/
|
|
2071
|
+
AbilityMapTreeGetParametersTree: 'archer' | 'warrior' | 'assassin' | 'mage' | 'shaman';
|
|
2072
|
+
/**
|
|
2073
|
+
* AspectsTreeGetParametersTree
|
|
2074
|
+
* @enum {string}
|
|
2075
|
+
*/
|
|
2076
|
+
AspectsTreeGetParametersTree: 'archer' | 'warrior' | 'assassin' | 'mage' | 'shaman';
|
|
2077
|
+
/** AspectTier */
|
|
2078
|
+
AspectTier: {
|
|
2079
|
+
threshold: number;
|
|
2080
|
+
description: string[];
|
|
2081
|
+
};
|
|
2082
|
+
/** Aspect */
|
|
2083
|
+
Aspect: {
|
|
2084
|
+
name: string;
|
|
2085
|
+
internalName: string;
|
|
2086
|
+
icon: components['schemas']['AbilityIcon'];
|
|
2087
|
+
rarity: string;
|
|
2088
|
+
requiredClass: string;
|
|
2089
|
+
tiers: {
|
|
2090
|
+
[key: string]: components['schemas']['AspectTier'];
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
/** ClassSummary */
|
|
2094
|
+
ClassSummary: {
|
|
2095
|
+
name: string;
|
|
2096
|
+
overallDifficulty: number;
|
|
2097
|
+
};
|
|
2098
|
+
/**
|
|
2099
|
+
* ClassesClassNameGetParametersClassName
|
|
2100
|
+
* @enum {string}
|
|
2101
|
+
*/
|
|
2102
|
+
ClassesClassNameGetParametersClassName: 'archer' | 'warrior' | 'assassin' | 'mage' | 'shaman';
|
|
2103
|
+
/** ClassArchetype */
|
|
2104
|
+
ClassArchetype: {
|
|
2105
|
+
name: string;
|
|
2106
|
+
difficulty: number;
|
|
2107
|
+
max: number;
|
|
2108
|
+
icon: string;
|
|
2109
|
+
damage: number;
|
|
2110
|
+
defence: number;
|
|
2111
|
+
range: number;
|
|
2112
|
+
speed: number;
|
|
2113
|
+
};
|
|
2114
|
+
/** ClassDetail */
|
|
2115
|
+
ClassDetail: {
|
|
2116
|
+
id: string;
|
|
2117
|
+
name: string;
|
|
2118
|
+
lore: string;
|
|
2119
|
+
overallDifficulty: number;
|
|
2120
|
+
overallMax: number;
|
|
2121
|
+
archetypes: {
|
|
2122
|
+
[key: string]: components['schemas']['ClassArchetype'];
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
/** MapMarker */
|
|
2126
|
+
MapMarker: {
|
|
2127
|
+
name: string;
|
|
2128
|
+
icon: string;
|
|
2129
|
+
x: string;
|
|
2130
|
+
y: string;
|
|
2131
|
+
z: string;
|
|
2132
|
+
};
|
|
2133
|
+
/** PlayerLocationMember */
|
|
2134
|
+
PlayerLocationMember: {
|
|
2135
|
+
/** Format: uuid */
|
|
2136
|
+
uuid: string;
|
|
2137
|
+
name: string;
|
|
2138
|
+
nickname: string | null;
|
|
2139
|
+
/** Format: uuid */
|
|
2140
|
+
character: string;
|
|
2141
|
+
server: string | null;
|
|
2142
|
+
x: number;
|
|
2143
|
+
y: number;
|
|
2144
|
+
z: number;
|
|
2145
|
+
};
|
|
2146
|
+
/** PlayerLocation */
|
|
2147
|
+
PlayerLocation: {
|
|
2148
|
+
/** Format: uuid */
|
|
2149
|
+
uuid: string;
|
|
2150
|
+
name: string;
|
|
2151
|
+
nickname: string | null;
|
|
2152
|
+
/** Format: uuid */
|
|
2153
|
+
character: string;
|
|
2154
|
+
server: string | null;
|
|
2155
|
+
x: number;
|
|
2156
|
+
y: number;
|
|
2157
|
+
z: number;
|
|
2158
|
+
friends: components['schemas']['PlayerLocationMember'][];
|
|
2159
|
+
party: components['schemas']['PlayerLocationMember'][];
|
|
2160
|
+
guild: components['schemas']['PlayerLocationMember'][];
|
|
2161
|
+
};
|
|
2162
|
+
/** WorldEventRequirementValue */
|
|
2163
|
+
WorldEventRequirementValue: number | string;
|
|
2164
|
+
/** WorldEventRequirement */
|
|
2165
|
+
WorldEventRequirement: {
|
|
2166
|
+
type: string;
|
|
2167
|
+
value: components['schemas']['WorldEventRequirementValue'];
|
|
2168
|
+
};
|
|
2169
|
+
/** MapCoordinate3D */
|
|
2170
|
+
MapCoordinate3D: {
|
|
2171
|
+
x: number;
|
|
2172
|
+
y: number;
|
|
2173
|
+
z: number;
|
|
2174
|
+
};
|
|
2175
|
+
/** WorldEventLocation */
|
|
2176
|
+
WorldEventLocation: {
|
|
2177
|
+
event: components['schemas']['MapCoordinate3D'] | null;
|
|
2178
|
+
spawn: components['schemas']['MapCoordinate3D'] | null;
|
|
2179
|
+
reward: components['schemas']['MapCoordinate3D'] | null;
|
|
2180
|
+
radius: number | null;
|
|
2181
|
+
spawnRadius: number | null;
|
|
2182
|
+
};
|
|
2183
|
+
/** WorldEvent */
|
|
2184
|
+
WorldEvent: {
|
|
2185
|
+
name: string;
|
|
2186
|
+
internalName: string;
|
|
2187
|
+
lore: string;
|
|
2188
|
+
difficulty: string | null;
|
|
2189
|
+
level: number | null;
|
|
2190
|
+
length: string | null;
|
|
2191
|
+
rewardPerLevel: {
|
|
2192
|
+
[key: string]: string[];
|
|
2193
|
+
} | null;
|
|
2194
|
+
requirements: components['schemas']['WorldEventRequirement'][] | null;
|
|
2195
|
+
location: components['schemas']['WorldEventLocation'][];
|
|
2196
|
+
/** Format: date-time */
|
|
2197
|
+
schedule: string | null;
|
|
2198
|
+
};
|
|
2199
|
+
/**
|
|
2200
|
+
* MapLootPoolContentType
|
|
2201
|
+
* @enum {string}
|
|
2202
|
+
*/
|
|
2203
|
+
MapLootPoolContentType: 'CAMP' | 'RAID';
|
|
2204
|
+
/**
|
|
2205
|
+
* LootPoolRewardType
|
|
2206
|
+
* @enum {string}
|
|
2207
|
+
*/
|
|
2208
|
+
LootPoolRewardType: 'ASPECT' | 'CURRENCY' | 'INGREDIENT' | 'ITEM' | 'TOME' | 'WARD';
|
|
2209
|
+
/** LootPoolReward */
|
|
2210
|
+
LootPoolReward: {
|
|
2211
|
+
name: string;
|
|
2212
|
+
type: components['schemas']['LootPoolRewardType'];
|
|
2213
|
+
amount: number;
|
|
2214
|
+
/** @description Whether this reward is granted automatically without player action. */
|
|
2215
|
+
always: boolean;
|
|
2216
|
+
tier?: string | null;
|
|
2217
|
+
shiny?: boolean;
|
|
2218
|
+
};
|
|
2219
|
+
/** MapLootPoolContent */
|
|
2220
|
+
MapLootPoolContent: {
|
|
2221
|
+
name: string;
|
|
2222
|
+
internalName: string;
|
|
2223
|
+
type: components['schemas']['MapLootPoolContentType'];
|
|
2224
|
+
lore: string | null;
|
|
2225
|
+
difficulty: string | null;
|
|
2226
|
+
level: number | null;
|
|
2227
|
+
length: string | null;
|
|
2228
|
+
requirements: components['schemas']['WorldEventRequirement'][] | null;
|
|
2229
|
+
location: components['schemas']['MapCoordinate3D'] | null;
|
|
2230
|
+
rewards: components['schemas']['LootPoolReward'][];
|
|
2231
|
+
};
|
|
2232
|
+
/**
|
|
2233
|
+
* LootPoolType
|
|
2234
|
+
* @enum {string}
|
|
2235
|
+
*/
|
|
2236
|
+
LootPoolType: 'CAMP' | 'RAID';
|
|
2237
|
+
/** LootPool */
|
|
2238
|
+
LootPool: {
|
|
2239
|
+
name: string;
|
|
2240
|
+
internalName: string;
|
|
2241
|
+
type: components['schemas']['LootPoolType'];
|
|
2242
|
+
rewards: components['schemas']['LootPoolReward'][];
|
|
2243
|
+
};
|
|
2244
|
+
/**
|
|
2245
|
+
* GatheringNodeType
|
|
2246
|
+
* @enum {string}
|
|
2247
|
+
*/
|
|
2248
|
+
GatheringNodeType: 'NODE' | 'WALL' | 'CORNER';
|
|
2249
|
+
/** GatheringNode */
|
|
2250
|
+
GatheringNode: {
|
|
2251
|
+
x: number;
|
|
2252
|
+
y: number;
|
|
2253
|
+
z: number;
|
|
2254
|
+
angle: number;
|
|
2255
|
+
type: components['schemas']['GatheringNodeType'];
|
|
2256
|
+
resource: string;
|
|
2257
|
+
level: number;
|
|
2258
|
+
};
|
|
2259
|
+
/** Map_getQuestCount_Response_200 */
|
|
2260
|
+
Map_getQuestCount_Response_200: {
|
|
2261
|
+
quests: number;
|
|
2262
|
+
};
|
|
2263
|
+
/** SearchGuildResult */
|
|
2264
|
+
SearchGuildResult: {
|
|
2265
|
+
name: string;
|
|
2266
|
+
prefix: string;
|
|
2267
|
+
};
|
|
2268
|
+
/** SearchTerritoryResult */
|
|
2269
|
+
SearchTerritoryResult: {
|
|
2270
|
+
start: unknown[];
|
|
2271
|
+
end: unknown[];
|
|
2272
|
+
};
|
|
2273
|
+
/** SearchDiscoveryResult */
|
|
2274
|
+
SearchDiscoveryResult: {
|
|
2275
|
+
start: unknown[];
|
|
2276
|
+
end: unknown[];
|
|
2277
|
+
};
|
|
2278
|
+
/** GlobalSearchResult */
|
|
2279
|
+
GlobalSearchResult: {
|
|
2280
|
+
query: string;
|
|
2281
|
+
players?: {
|
|
2282
|
+
[key: string]: string;
|
|
2283
|
+
};
|
|
2284
|
+
guilds?: {
|
|
2285
|
+
[key: string]: components['schemas']['SearchGuildResult'];
|
|
2286
|
+
};
|
|
2287
|
+
items?: components['schemas']['ItemDatabaseFull'];
|
|
2288
|
+
guildsPrefix?: {
|
|
2289
|
+
[key: string]: components['schemas']['SearchGuildResult'];
|
|
2290
|
+
};
|
|
2291
|
+
territories?: {
|
|
2292
|
+
[key: string]: components['schemas']['SearchTerritoryResult'];
|
|
2293
|
+
};
|
|
2294
|
+
discoveries?: {
|
|
2295
|
+
[key: string]: components['schemas']['SearchDiscoveryResult'];
|
|
2296
|
+
};
|
|
2297
|
+
};
|
|
2298
|
+
/** GuildEntryScore */
|
|
2299
|
+
GuildEntryScore: number;
|
|
2300
|
+
/** LeaderboardMetadataXpPlaytime */
|
|
2301
|
+
LeaderboardMetadataXpPlaytime: {
|
|
2302
|
+
xp: number;
|
|
2303
|
+
/** Format: double */
|
|
2304
|
+
playtime: number;
|
|
2305
|
+
};
|
|
2306
|
+
/** LeaderboardMetadataTotalLevelXpPlaytime */
|
|
2307
|
+
LeaderboardMetadataTotalLevelXpPlaytime: {
|
|
2308
|
+
totalLevel: number;
|
|
2309
|
+
xp: number;
|
|
2310
|
+
/** Format: double */
|
|
2311
|
+
playtime: number;
|
|
2312
|
+
};
|
|
2313
|
+
/** LeaderboardMetadataPlaytime */
|
|
2314
|
+
LeaderboardMetadataPlaytime: {
|
|
2315
|
+
/** Format: double */
|
|
2316
|
+
playtime: number;
|
|
2317
|
+
};
|
|
2318
|
+
/** LeaderboardMetadataCompletionsGambits */
|
|
2319
|
+
LeaderboardMetadataCompletionsGambits: {
|
|
2320
|
+
completions: number;
|
|
2321
|
+
gambits: number;
|
|
2322
|
+
};
|
|
2323
|
+
/** LeaderboardMetadataGuildSeason */
|
|
2324
|
+
LeaderboardMetadataGuildSeason: {
|
|
2325
|
+
seasonName: string;
|
|
2326
|
+
position: number;
|
|
2327
|
+
};
|
|
2328
|
+
/** LeaderboardMetadata */
|
|
2329
|
+
LeaderboardMetadata: components['schemas']['LeaderboardMetadataXpPlaytime'] | components['schemas']['LeaderboardMetadataTotalLevelXpPlaytime'] | components['schemas']['LeaderboardMetadataPlaytime'] | components['schemas']['LeaderboardMetadataCompletionsGambits'] | components['schemas']['LeaderboardMetadataGuildSeason'];
|
|
2330
|
+
/** GuildEntry */
|
|
2331
|
+
GuildEntry: {
|
|
2332
|
+
metaScore: number;
|
|
2333
|
+
/** Format: uuid */
|
|
2334
|
+
uuid: string;
|
|
2335
|
+
name: string;
|
|
2336
|
+
prefix: string;
|
|
2337
|
+
score: components['schemas']['GuildEntryScore'];
|
|
2338
|
+
metadata: components['schemas']['LeaderboardMetadata'];
|
|
2339
|
+
banner: components['schemas']['GuildBanner'];
|
|
2340
|
+
previousRanking?: number;
|
|
2341
|
+
};
|
|
2342
|
+
/** GuildLegacyEntry */
|
|
2343
|
+
GuildLegacyEntry: {
|
|
2344
|
+
/** Format: uuid */
|
|
2345
|
+
uuid: string;
|
|
2346
|
+
name: string;
|
|
2347
|
+
prefix: string;
|
|
2348
|
+
level: number;
|
|
2349
|
+
xp: number;
|
|
2350
|
+
territories: number;
|
|
2351
|
+
wars: number;
|
|
2352
|
+
/** Format: date-time */
|
|
2353
|
+
created: string;
|
|
2354
|
+
banner: components['schemas']['GuildBanner'];
|
|
2355
|
+
};
|
|
2356
|
+
/** PlayerEntryScore */
|
|
2357
|
+
PlayerEntryScore: number;
|
|
2358
|
+
/** PlayerEntry */
|
|
2359
|
+
PlayerEntry: {
|
|
2360
|
+
metaScore: number;
|
|
2361
|
+
name: string;
|
|
2362
|
+
/** Format: uuid */
|
|
2363
|
+
uuid: string;
|
|
2364
|
+
score: components['schemas']['PlayerEntryScore'];
|
|
2365
|
+
metadata: components['schemas']['LeaderboardMetadata'];
|
|
2366
|
+
prefix?: string;
|
|
2367
|
+
/** Format: uuid */
|
|
2368
|
+
characterUuid?: string;
|
|
2369
|
+
characterType?: string;
|
|
2370
|
+
characterData?: components['schemas']['Character'];
|
|
2371
|
+
rank?: string;
|
|
2372
|
+
supportRank?: string | null;
|
|
2373
|
+
shortenedRank?: string;
|
|
2374
|
+
legacyRankColour?: components['schemas']['LegacyRankColour'];
|
|
2375
|
+
rankBadge?: string;
|
|
2376
|
+
previousRanking?: number;
|
|
2377
|
+
restricted: boolean;
|
|
2378
|
+
};
|
|
2379
|
+
/** LeaderboardEntry */
|
|
2380
|
+
LeaderboardEntry: components['schemas']['GuildEntry'] | components['schemas']['GuildLegacyEntry'] | components['schemas']['PlayerEntry'];
|
|
2381
|
+
/**
|
|
2382
|
+
* PublisherArticleType
|
|
2383
|
+
* @enum {string}
|
|
2384
|
+
*/
|
|
2385
|
+
PublisherArticleType: 'blog' | 'event' | 'giveaway' | 'article' | 'poll';
|
|
2386
|
+
/**
|
|
2387
|
+
* PublisherPollRequirementType
|
|
2388
|
+
* @enum {string}
|
|
2389
|
+
*/
|
|
2390
|
+
PublisherPollRequirementType: 'highest_level' | 'account_age' | 'content_completion';
|
|
2391
|
+
/**
|
|
2392
|
+
* PublisherPollRequirementSubType
|
|
2393
|
+
* @enum {string}
|
|
2394
|
+
*/
|
|
2395
|
+
PublisherPollRequirementSubType: 'combat' | 'alchemism' | 'armouring' | 'cooking' | 'farming' | 'fishing' | 'jeweling' | 'mining' | 'scribing' | 'tailoring' | 'weaponsmithing' | 'woodcutting' | 'woodworking' | 'orphion' | 'fruma' | 'colossus' | 'grootslang' | 'nameless' | 'orphion_guild' | 'fruma_guild' | 'colossus_guild' | 'grootslang_guild' | 'nameless_guild';
|
|
2396
|
+
/** PublisherPollRequirement */
|
|
2397
|
+
PublisherPollRequirement: {
|
|
2398
|
+
type: components['schemas']['PublisherPollRequirementType'];
|
|
2399
|
+
subType: components['schemas']['PublisherPollRequirementSubType'];
|
|
2400
|
+
value: number;
|
|
2401
|
+
};
|
|
2402
|
+
/** PublisherPollQuestion */
|
|
2403
|
+
PublisherPollQuestion: {
|
|
2404
|
+
answers: {
|
|
2405
|
+
[key: string]: string;
|
|
2406
|
+
};
|
|
2407
|
+
override: boolean;
|
|
2408
|
+
question: string;
|
|
2409
|
+
requirements: components['schemas']['PublisherPollRequirement'][];
|
|
2410
|
+
};
|
|
2411
|
+
/**
|
|
2412
|
+
* PublisherArticleContentBlockContent
|
|
2413
|
+
* @description Markdown content for standard blocks, or a structured question object for `question` blocks in poll articles.
|
|
2414
|
+
*/
|
|
2415
|
+
PublisherArticleContentBlockContent: string | components['schemas']['PublisherPollQuestion'];
|
|
2416
|
+
/** PublisherArticleContentBlock */
|
|
2417
|
+
PublisherArticleContentBlock: {
|
|
2418
|
+
id: string;
|
|
2419
|
+
type: string;
|
|
2420
|
+
focus: boolean;
|
|
2421
|
+
/** @description Markdown content for standard blocks, or a structured question object for `question` blocks in poll articles. */
|
|
2422
|
+
content: components['schemas']['PublisherArticleContentBlockContent'];
|
|
2423
|
+
discord: boolean;
|
|
2424
|
+
website: boolean;
|
|
2425
|
+
};
|
|
2426
|
+
/** PublisherPollVotes */
|
|
2427
|
+
PublisherPollVotes: {
|
|
2428
|
+
total: number;
|
|
2429
|
+
};
|
|
2430
|
+
/** PublisherArticle */
|
|
2431
|
+
PublisherArticle: {
|
|
2432
|
+
id: number;
|
|
2433
|
+
type: components['schemas']['PublisherArticleType'];
|
|
2434
|
+
created_by: string;
|
|
2435
|
+
discord_messages: {
|
|
2436
|
+
[key: string]: string;
|
|
2437
|
+
};
|
|
2438
|
+
discord_recap: boolean;
|
|
2439
|
+
allow_discord: boolean;
|
|
2440
|
+
destination: string;
|
|
2441
|
+
published: boolean;
|
|
2442
|
+
pinned: boolean;
|
|
2443
|
+
visible: boolean;
|
|
2444
|
+
content: components['schemas']['PublisherArticleContentBlock'][];
|
|
2445
|
+
/** Format: date-time */
|
|
2446
|
+
start_date: string;
|
|
2447
|
+
/** Format: date-time */
|
|
2448
|
+
end_date: string | null;
|
|
2449
|
+
recap: string;
|
|
2450
|
+
title: string;
|
|
2451
|
+
banner: string;
|
|
2452
|
+
banner_zoom: boolean;
|
|
2453
|
+
likes: number;
|
|
2454
|
+
/** Format: date-time */
|
|
2455
|
+
published_at: string;
|
|
2456
|
+
require_discord: boolean;
|
|
2457
|
+
require_clan: boolean;
|
|
2458
|
+
/** @description List of global requirements for poll questions if the article is a poll. */
|
|
2459
|
+
poll_settings?: components['schemas']['PublisherPollRequirement'][];
|
|
2460
|
+
/** @description Whether poll vote totals are publicly visible. */
|
|
2461
|
+
poll_public?: boolean;
|
|
2462
|
+
/** @description Returned when `poll_public` is true. */
|
|
2463
|
+
votes?: components['schemas']['PublisherPollVotes'] | null;
|
|
2464
|
+
};
|
|
2465
|
+
/** PublisherArticleSummary */
|
|
2466
|
+
PublisherArticleSummary: {
|
|
2467
|
+
pk: number;
|
|
2468
|
+
title: string;
|
|
2469
|
+
type: components['schemas']['PublisherArticleType'];
|
|
2470
|
+
banner: string;
|
|
2471
|
+
banner_zoom: boolean;
|
|
2472
|
+
recap: string;
|
|
2473
|
+
visible: boolean;
|
|
2474
|
+
/** Format: date-time */
|
|
2475
|
+
start_date: string;
|
|
2476
|
+
/** Format: date-time */
|
|
2477
|
+
end_date: string | null;
|
|
2478
|
+
pinned: boolean;
|
|
2479
|
+
has_content: boolean;
|
|
2480
|
+
/** Format: date-time */
|
|
2481
|
+
published_at: string;
|
|
2482
|
+
};
|
|
2483
|
+
/** PublisherArticleList */
|
|
2484
|
+
PublisherArticleList: {
|
|
2485
|
+
controller: components['schemas']['PaginationController'];
|
|
2486
|
+
results: {
|
|
2487
|
+
[key: string]: components['schemas']['PublisherArticleSummary'];
|
|
2488
|
+
};
|
|
2489
|
+
};
|
|
2490
|
+
/** LatestNewsEntry */
|
|
2491
|
+
LatestNewsEntry: {
|
|
2492
|
+
title: string;
|
|
2493
|
+
date: string;
|
|
2494
|
+
/** Format: uri */
|
|
2495
|
+
forumThread: string;
|
|
2496
|
+
author: string;
|
|
2497
|
+
content: string;
|
|
2498
|
+
comments: string;
|
|
2499
|
+
};
|
|
2500
|
+
PlayerMultiSelector: components['schemas']['Error'] & {
|
|
2501
|
+
objects?: {
|
|
2502
|
+
[key: string]: components['schemas']['PlayerMultiSelectorPartialPlayer'];
|
|
2503
|
+
};
|
|
2504
|
+
};
|
|
2505
|
+
PlayerMultiSelectorPartialPlayer: {
|
|
2506
|
+
username?: components['schemas']['Player']['username'];
|
|
2507
|
+
rank?: components['schemas']['Player']['rank'];
|
|
2508
|
+
supportRank?: components['schemas']['Player']['supportRank'];
|
|
2509
|
+
shortenedRank?: components['schemas']['Player']['shortenedRank'];
|
|
2510
|
+
legacyRankColour?: components['schemas']['Player']['legacyRankColour'];
|
|
2511
|
+
rankBadge?: components['schemas']['Player']['rankBadge'];
|
|
2512
|
+
};
|
|
2513
|
+
};
|
|
2514
|
+
responses: never;
|
|
2515
|
+
parameters: never;
|
|
2516
|
+
requestBodies: never;
|
|
2517
|
+
headers: never;
|
|
2518
|
+
pathItems: never;
|
|
2519
|
+
}
|
|
2520
|
+
export type $defs = Record<string, never>;
|
|
2521
|
+
export interface operations {
|
|
2522
|
+
'list-online-players': {
|
|
2523
|
+
parameters: {
|
|
2524
|
+
query?: {
|
|
2525
|
+
/** @description Switches player descriptor between either their username or their uuid. */
|
|
2526
|
+
identifier?: components['schemas']['PlayerGetParametersIdentifier'];
|
|
2527
|
+
/** @description Filter online players to a specific world such as `WC1` or `1`. */
|
|
2528
|
+
server?: components['schemas']['PlayerGetParametersServer'];
|
|
2529
|
+
};
|
|
2530
|
+
header?: never;
|
|
2531
|
+
path?: never;
|
|
2532
|
+
cookie?: never;
|
|
2533
|
+
};
|
|
2534
|
+
requestBody?: never;
|
|
2535
|
+
responses: {
|
|
2536
|
+
/** @description Online player summary. */
|
|
2537
|
+
200: {
|
|
2538
|
+
headers: {
|
|
2539
|
+
[name: string]: unknown;
|
|
2540
|
+
};
|
|
2541
|
+
content: {
|
|
2542
|
+
'application/json': components['schemas']['OnlinePlayerList'];
|
|
2543
|
+
};
|
|
2544
|
+
};
|
|
2545
|
+
};
|
|
2546
|
+
};
|
|
2547
|
+
'get-player-identity': {
|
|
2548
|
+
parameters: {
|
|
2549
|
+
query?: never;
|
|
2550
|
+
header?: never;
|
|
2551
|
+
path?: never;
|
|
2552
|
+
cookie?: never;
|
|
2553
|
+
};
|
|
2554
|
+
requestBody?: never;
|
|
2555
|
+
responses: {
|
|
2556
|
+
/** @description Identity mapping keyed by player UUID. */
|
|
2557
|
+
200: {
|
|
2558
|
+
headers: {
|
|
2559
|
+
[name: string]: unknown;
|
|
2560
|
+
};
|
|
2561
|
+
content: {
|
|
2562
|
+
'application/json': {
|
|
2563
|
+
[key: string]: components['schemas']['PlayerIdentity'];
|
|
2564
|
+
};
|
|
2565
|
+
};
|
|
2566
|
+
};
|
|
2567
|
+
/** @description No eligible online identity could be resolved. */
|
|
2568
|
+
403: {
|
|
2569
|
+
headers: {
|
|
2570
|
+
[name: string]: unknown;
|
|
2571
|
+
};
|
|
2572
|
+
content: {
|
|
2573
|
+
'application/json': components['schemas']['Error'];
|
|
2574
|
+
};
|
|
2575
|
+
};
|
|
2576
|
+
};
|
|
2577
|
+
};
|
|
2578
|
+
'list-player-characters': {
|
|
2579
|
+
parameters: {
|
|
2580
|
+
query?: never;
|
|
2581
|
+
header?: never;
|
|
2582
|
+
path: {
|
|
2583
|
+
/** @description Username or UUID accepted by the player route. */
|
|
2584
|
+
username: string;
|
|
2585
|
+
};
|
|
2586
|
+
cookie?: never;
|
|
2587
|
+
};
|
|
2588
|
+
requestBody?: never;
|
|
2589
|
+
responses: {
|
|
2590
|
+
/** @description Character map keyed by character UUID. */
|
|
2591
|
+
200: {
|
|
2592
|
+
headers: {
|
|
2593
|
+
[name: string]: unknown;
|
|
2594
|
+
};
|
|
2595
|
+
content: {
|
|
2596
|
+
'application/json': {
|
|
2597
|
+
[key: string]: components['schemas']['LightCharacter'];
|
|
2598
|
+
};
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
/** @description The player has no characters. */
|
|
2602
|
+
400: {
|
|
2603
|
+
headers: {
|
|
2604
|
+
[name: string]: unknown;
|
|
2605
|
+
};
|
|
2606
|
+
content: {
|
|
2607
|
+
'application/json': components['schemas']['Error'];
|
|
2608
|
+
};
|
|
2609
|
+
};
|
|
2610
|
+
/** @description Character list visibility is restricted. */
|
|
2611
|
+
403: {
|
|
2612
|
+
headers: {
|
|
2613
|
+
[name: string]: unknown;
|
|
2614
|
+
};
|
|
2615
|
+
content: {
|
|
2616
|
+
'application/json': components['schemas']['Error'];
|
|
2617
|
+
};
|
|
2618
|
+
};
|
|
2619
|
+
/** @description No matching player was found. */
|
|
2620
|
+
404: {
|
|
2621
|
+
headers: {
|
|
2622
|
+
[name: string]: unknown;
|
|
2623
|
+
};
|
|
2624
|
+
content: {
|
|
2625
|
+
'application/json': components['schemas']['Error'];
|
|
2626
|
+
};
|
|
2627
|
+
};
|
|
2628
|
+
/** @description Player payload construction failed. */
|
|
2629
|
+
500: {
|
|
2630
|
+
headers: {
|
|
2631
|
+
[name: string]: unknown;
|
|
2632
|
+
};
|
|
2633
|
+
content: {
|
|
2634
|
+
'application/json': components['schemas']['Error'];
|
|
2635
|
+
};
|
|
2636
|
+
};
|
|
2637
|
+
};
|
|
2638
|
+
};
|
|
2639
|
+
'get-player-character': {
|
|
2640
|
+
parameters: {
|
|
2641
|
+
query?: never;
|
|
2642
|
+
header?: never;
|
|
2643
|
+
path: {
|
|
2644
|
+
/** @description Username or UUID accepted by the player route. */
|
|
2645
|
+
username: string;
|
|
2646
|
+
uuid: string;
|
|
2647
|
+
};
|
|
2648
|
+
cookie?: never;
|
|
2649
|
+
};
|
|
2650
|
+
requestBody?: never;
|
|
2651
|
+
responses: {
|
|
2652
|
+
/** @description Character detail. */
|
|
2653
|
+
200: {
|
|
2654
|
+
headers: {
|
|
2655
|
+
[name: string]: unknown;
|
|
2656
|
+
};
|
|
2657
|
+
content: {
|
|
2658
|
+
'application/json': components['schemas']['Character'];
|
|
2659
|
+
};
|
|
2660
|
+
};
|
|
2661
|
+
/** @description Unknown character UUID. */
|
|
2662
|
+
400: {
|
|
2663
|
+
headers: {
|
|
2664
|
+
[name: string]: unknown;
|
|
2665
|
+
};
|
|
2666
|
+
content: {
|
|
2667
|
+
'application/json': components['schemas']['Error'];
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
/** @description Character data visibility is restricted. */
|
|
2671
|
+
403: {
|
|
2672
|
+
headers: {
|
|
2673
|
+
[name: string]: unknown;
|
|
2674
|
+
};
|
|
2675
|
+
content: {
|
|
2676
|
+
'application/json': components['schemas']['Error'];
|
|
2677
|
+
};
|
|
2678
|
+
};
|
|
2679
|
+
/** @description No matching player was found. */
|
|
2680
|
+
404: {
|
|
2681
|
+
headers: {
|
|
2682
|
+
[name: string]: unknown;
|
|
2683
|
+
};
|
|
2684
|
+
content: {
|
|
2685
|
+
'application/json': components['schemas']['Error'];
|
|
2686
|
+
};
|
|
2687
|
+
};
|
|
2688
|
+
/** @description Player payload construction failed. */
|
|
2689
|
+
500: {
|
|
2690
|
+
headers: {
|
|
2691
|
+
[name: string]: unknown;
|
|
2692
|
+
};
|
|
2693
|
+
content: {
|
|
2694
|
+
'application/json': components['schemas']['Error'];
|
|
2695
|
+
};
|
|
2696
|
+
};
|
|
2697
|
+
};
|
|
2698
|
+
};
|
|
2699
|
+
'get-player-character-abilities': {
|
|
2700
|
+
parameters: {
|
|
2701
|
+
query?: never;
|
|
2702
|
+
header?: never;
|
|
2703
|
+
path: {
|
|
2704
|
+
/** @description Username or UUID accepted by the player route. */
|
|
2705
|
+
username: string;
|
|
2706
|
+
uuid: string;
|
|
2707
|
+
};
|
|
2708
|
+
cookie?: never;
|
|
2709
|
+
};
|
|
2710
|
+
requestBody?: never;
|
|
2711
|
+
responses: {
|
|
2712
|
+
/** @description Ability tree nodes grouped by page. */
|
|
2713
|
+
200: {
|
|
2714
|
+
headers: {
|
|
2715
|
+
[name: string]: unknown;
|
|
2716
|
+
};
|
|
2717
|
+
content: {
|
|
2718
|
+
'application/json': components['schemas']['AbilityMapPages'];
|
|
2719
|
+
};
|
|
2720
|
+
};
|
|
2721
|
+
/** @description Unknown character UUID. */
|
|
2722
|
+
400: {
|
|
2723
|
+
headers: {
|
|
2724
|
+
[name: string]: unknown;
|
|
2725
|
+
};
|
|
2726
|
+
content: {
|
|
2727
|
+
'application/json': components['schemas']['Error'];
|
|
2728
|
+
};
|
|
2729
|
+
};
|
|
2730
|
+
/** @description Ability tree visibility is restricted. */
|
|
2731
|
+
403: {
|
|
2732
|
+
headers: {
|
|
2733
|
+
[name: string]: unknown;
|
|
2734
|
+
};
|
|
2735
|
+
content: {
|
|
2736
|
+
'application/json': components['schemas']['Error'];
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
/** @description No matching player was found. */
|
|
2740
|
+
404: {
|
|
2741
|
+
headers: {
|
|
2742
|
+
[name: string]: unknown;
|
|
2743
|
+
};
|
|
2744
|
+
content: {
|
|
2745
|
+
'application/json': components['schemas']['Error'];
|
|
2746
|
+
};
|
|
2747
|
+
};
|
|
2748
|
+
/** @description The character ability tree could not be rendered. */
|
|
2749
|
+
500: {
|
|
2750
|
+
headers: {
|
|
2751
|
+
[name: string]: unknown;
|
|
2752
|
+
};
|
|
2753
|
+
content: {
|
|
2754
|
+
'application/json': components['schemas']['Error'];
|
|
2755
|
+
};
|
|
2756
|
+
};
|
|
2757
|
+
};
|
|
2758
|
+
};
|
|
2759
|
+
'get-oauth-identity': {
|
|
2760
|
+
parameters: {
|
|
2761
|
+
query?: never;
|
|
2762
|
+
header?: never;
|
|
2763
|
+
path?: never;
|
|
2764
|
+
cookie?: never;
|
|
2765
|
+
};
|
|
2766
|
+
requestBody?: never;
|
|
2767
|
+
responses: {
|
|
2768
|
+
/** @description OAuth2 application context and linked profiles. */
|
|
2769
|
+
200: {
|
|
2770
|
+
headers: {
|
|
2771
|
+
[name: string]: unknown;
|
|
2772
|
+
};
|
|
2773
|
+
content: {
|
|
2774
|
+
'application/json': components['schemas']['OAuthMeResponse'];
|
|
2775
|
+
};
|
|
2776
|
+
};
|
|
2777
|
+
};
|
|
2778
|
+
};
|
|
2779
|
+
'exchange-oauth-token': {
|
|
2780
|
+
parameters: {
|
|
2781
|
+
query?: never;
|
|
2782
|
+
header?: never;
|
|
2783
|
+
path?: never;
|
|
2784
|
+
cookie?: never;
|
|
2785
|
+
};
|
|
2786
|
+
requestBody?: {
|
|
2787
|
+
content: {
|
|
2788
|
+
'application/json': components['schemas']['OAuthTokenExchangeRequest'];
|
|
2789
|
+
};
|
|
2790
|
+
};
|
|
2791
|
+
responses: {
|
|
2792
|
+
/** @description OAuth2 access token exchange result. */
|
|
2793
|
+
200: {
|
|
2794
|
+
headers: {
|
|
2795
|
+
[name: string]: unknown;
|
|
2796
|
+
};
|
|
2797
|
+
content: {
|
|
2798
|
+
'application/json': components['schemas']['OAuthTokenResponse'];
|
|
2799
|
+
};
|
|
2800
|
+
};
|
|
2801
|
+
};
|
|
2802
|
+
};
|
|
2803
|
+
'list-guilds': {
|
|
2804
|
+
parameters: {
|
|
2805
|
+
query?: {
|
|
2806
|
+
/** @description Switches player descriptor between either their username or their uuid. */
|
|
2807
|
+
identifier?: components['schemas']['GuildListGuildGetParametersIdentifier'];
|
|
2808
|
+
};
|
|
2809
|
+
header?: never;
|
|
2810
|
+
path?: never;
|
|
2811
|
+
cookie?: never;
|
|
2812
|
+
};
|
|
2813
|
+
requestBody?: never;
|
|
2814
|
+
responses: {
|
|
2815
|
+
/** @description Guild directory keyed by name or UUID. */
|
|
2816
|
+
200: {
|
|
2817
|
+
headers: {
|
|
2818
|
+
[name: string]: unknown;
|
|
2819
|
+
};
|
|
2820
|
+
content: {
|
|
2821
|
+
'application/json': components['schemas']['Guild_listGuilds_Response_200'];
|
|
2822
|
+
};
|
|
2823
|
+
};
|
|
2824
|
+
};
|
|
2825
|
+
};
|
|
2826
|
+
'list-guild-territories': {
|
|
2827
|
+
parameters: {
|
|
2828
|
+
query?: never;
|
|
2829
|
+
header?: never;
|
|
2830
|
+
path?: never;
|
|
2831
|
+
cookie?: never;
|
|
2832
|
+
};
|
|
2833
|
+
requestBody?: never;
|
|
2834
|
+
responses: {
|
|
2835
|
+
/** @description Territory ownership map keyed by territory name. */
|
|
2836
|
+
200: {
|
|
2837
|
+
headers: {
|
|
2838
|
+
[name: string]: unknown;
|
|
2839
|
+
};
|
|
2840
|
+
content: {
|
|
2841
|
+
'application/json': {
|
|
2842
|
+
[key: string]: components['schemas']['Territory'];
|
|
2843
|
+
};
|
|
2844
|
+
};
|
|
2845
|
+
};
|
|
2846
|
+
/** @description Territory list cache could not be loaded. */
|
|
2847
|
+
500: {
|
|
2848
|
+
headers: {
|
|
2849
|
+
[name: string]: unknown;
|
|
2850
|
+
};
|
|
2851
|
+
content: {
|
|
2852
|
+
'application/json': components['schemas']['Error'];
|
|
2853
|
+
};
|
|
2854
|
+
};
|
|
2855
|
+
};
|
|
2856
|
+
};
|
|
2857
|
+
'list-guild-seasons': {
|
|
2858
|
+
parameters: {
|
|
2859
|
+
query?: never;
|
|
2860
|
+
header?: never;
|
|
2861
|
+
path?: never;
|
|
2862
|
+
cookie?: never;
|
|
2863
|
+
};
|
|
2864
|
+
requestBody?: never;
|
|
2865
|
+
responses: {
|
|
2866
|
+
/** @description Guild season definitions keyed by season name. */
|
|
2867
|
+
200: {
|
|
2868
|
+
headers: {
|
|
2869
|
+
[name: string]: unknown;
|
|
2870
|
+
};
|
|
2871
|
+
content: {
|
|
2872
|
+
'application/json': components['schemas']['GuildSeasonList'];
|
|
2873
|
+
};
|
|
2874
|
+
};
|
|
2875
|
+
};
|
|
2876
|
+
};
|
|
2877
|
+
'get-guild-by-prefix': {
|
|
2878
|
+
parameters: {
|
|
2879
|
+
query?: {
|
|
2880
|
+
/** @description Switches player descriptor between either their username or their uuid. */
|
|
2881
|
+
identifier?: components['schemas']['GuildPrefixQueryGetParametersIdentifier'];
|
|
2882
|
+
};
|
|
2883
|
+
header?: never;
|
|
2884
|
+
path: {
|
|
2885
|
+
query: string;
|
|
2886
|
+
};
|
|
2887
|
+
cookie?: never;
|
|
2888
|
+
};
|
|
2889
|
+
requestBody?: never;
|
|
2890
|
+
responses: {
|
|
2891
|
+
/** @description Guild detail. */
|
|
2892
|
+
200: {
|
|
2893
|
+
headers: {
|
|
2894
|
+
[name: string]: unknown;
|
|
2895
|
+
};
|
|
2896
|
+
content: {
|
|
2897
|
+
'application/json': components['schemas']['Guild'];
|
|
2898
|
+
};
|
|
2899
|
+
};
|
|
2900
|
+
/** @description The provided guild prefix is malformed. */
|
|
2901
|
+
400: {
|
|
2902
|
+
headers: {
|
|
2903
|
+
[name: string]: unknown;
|
|
2904
|
+
};
|
|
2905
|
+
content: {
|
|
2906
|
+
'application/json': components['schemas']['Error'];
|
|
2907
|
+
};
|
|
2908
|
+
};
|
|
2909
|
+
/** @description No matching guild was found. */
|
|
2910
|
+
404: {
|
|
2911
|
+
headers: {
|
|
2912
|
+
[name: string]: unknown;
|
|
2913
|
+
};
|
|
2914
|
+
content: {
|
|
2915
|
+
'application/json': components['schemas']['Error'];
|
|
2916
|
+
};
|
|
2917
|
+
};
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
'get-guild-by-uuid': {
|
|
2921
|
+
parameters: {
|
|
2922
|
+
query?: {
|
|
2923
|
+
/** @description Switches player descriptor between either their username or their uuid. */
|
|
2924
|
+
identifier?: components['schemas']['GuildUuidQueryGetParametersIdentifier'];
|
|
2925
|
+
};
|
|
2926
|
+
header?: never;
|
|
2927
|
+
path: {
|
|
2928
|
+
query: string;
|
|
2929
|
+
};
|
|
2930
|
+
cookie?: never;
|
|
2931
|
+
};
|
|
2932
|
+
requestBody?: never;
|
|
2933
|
+
responses: {
|
|
2934
|
+
/** @description Guild detail. */
|
|
2935
|
+
200: {
|
|
2936
|
+
headers: {
|
|
2937
|
+
[name: string]: unknown;
|
|
2938
|
+
};
|
|
2939
|
+
content: {
|
|
2940
|
+
'application/json': components['schemas']['Guild'];
|
|
2941
|
+
};
|
|
2942
|
+
};
|
|
2943
|
+
/** @description No matching guild was found. */
|
|
2944
|
+
404: {
|
|
2945
|
+
headers: {
|
|
2946
|
+
[name: string]: unknown;
|
|
2947
|
+
};
|
|
2948
|
+
content: {
|
|
2949
|
+
'application/json': components['schemas']['Error'];
|
|
2950
|
+
};
|
|
2951
|
+
};
|
|
2952
|
+
};
|
|
2953
|
+
};
|
|
2954
|
+
'get-guild-by-name': {
|
|
2955
|
+
parameters: {
|
|
2956
|
+
query?: {
|
|
2957
|
+
/** @description Switches player descriptor between either their username or their uuid. */
|
|
2958
|
+
identifier?: components['schemas']['GuildQueryGetParametersIdentifier'];
|
|
2959
|
+
};
|
|
2960
|
+
header?: never;
|
|
2961
|
+
path: {
|
|
2962
|
+
query: string;
|
|
2963
|
+
};
|
|
2964
|
+
cookie?: never;
|
|
2965
|
+
};
|
|
2966
|
+
requestBody?: never;
|
|
2967
|
+
responses: {
|
|
2968
|
+
/** @description Guild detail. */
|
|
2969
|
+
200: {
|
|
2970
|
+
headers: {
|
|
2971
|
+
[name: string]: unknown;
|
|
2972
|
+
};
|
|
2973
|
+
content: {
|
|
2974
|
+
'application/json': components['schemas']['Guild'];
|
|
2975
|
+
};
|
|
2976
|
+
};
|
|
2977
|
+
/** @description No matching guild was found. */
|
|
2978
|
+
404: {
|
|
2979
|
+
headers: {
|
|
2980
|
+
[name: string]: unknown;
|
|
2981
|
+
};
|
|
2982
|
+
content: {
|
|
2983
|
+
'application/json': components['schemas']['Error'];
|
|
2984
|
+
};
|
|
2985
|
+
};
|
|
2986
|
+
};
|
|
2987
|
+
};
|
|
2988
|
+
'list-items': {
|
|
2989
|
+
parameters: {
|
|
2990
|
+
query?: {
|
|
2991
|
+
page?: number;
|
|
2992
|
+
/** @description Presence-based flag that expands responses. Send it without a value as `?fullResult`. Using `?fullResult=true` or `?fullResult=false` is not accepted. */
|
|
2993
|
+
fullResult?: components['schemas']['ItemDatabaseGetParametersFullResult'];
|
|
2994
|
+
};
|
|
2995
|
+
header?: never;
|
|
2996
|
+
path?: never;
|
|
2997
|
+
cookie?: never;
|
|
2998
|
+
};
|
|
2999
|
+
requestBody?: never;
|
|
3000
|
+
responses: {
|
|
3001
|
+
/** @description Paginated item list. */
|
|
3002
|
+
200: {
|
|
3003
|
+
headers: {
|
|
3004
|
+
[name: string]: unknown;
|
|
3005
|
+
};
|
|
3006
|
+
content: {
|
|
3007
|
+
'application/json': components['schemas']['PaginatedItemResponse'];
|
|
3008
|
+
};
|
|
3009
|
+
};
|
|
3010
|
+
};
|
|
3011
|
+
};
|
|
3012
|
+
'search-items': {
|
|
3013
|
+
parameters: {
|
|
3014
|
+
query?: {
|
|
3015
|
+
page?: number;
|
|
3016
|
+
/** @description Presence-based flag that expands responses. Send it without a value as `?fullResult`. Using `?fullResult=true` or `?fullResult=false` is not accepted. */
|
|
3017
|
+
fullResult?: components['schemas']['ItemSearchPostParametersFullResult'];
|
|
3018
|
+
};
|
|
3019
|
+
header?: never;
|
|
3020
|
+
path?: never;
|
|
3021
|
+
cookie?: never;
|
|
3022
|
+
};
|
|
3023
|
+
requestBody?: {
|
|
3024
|
+
content: {
|
|
3025
|
+
'application/json': components['schemas']['ItemSearchRequest'];
|
|
3026
|
+
};
|
|
3027
|
+
};
|
|
3028
|
+
responses: {
|
|
3029
|
+
/** @description Paginated search results. */
|
|
3030
|
+
200: {
|
|
3031
|
+
headers: {
|
|
3032
|
+
[name: string]: unknown;
|
|
3033
|
+
};
|
|
3034
|
+
content: {
|
|
3035
|
+
'application/json': components['schemas']['PaginatedItemResponse'];
|
|
3036
|
+
};
|
|
3037
|
+
};
|
|
3038
|
+
/** @description Invalid request payload. */
|
|
3039
|
+
400: {
|
|
3040
|
+
headers: {
|
|
3041
|
+
[name: string]: unknown;
|
|
3042
|
+
};
|
|
3043
|
+
content: {
|
|
3044
|
+
'application/json': components['schemas']['Error'];
|
|
3045
|
+
};
|
|
3046
|
+
};
|
|
3047
|
+
/** @description No items matched the request. */
|
|
3048
|
+
404: {
|
|
3049
|
+
headers: {
|
|
3050
|
+
[name: string]: unknown;
|
|
3051
|
+
};
|
|
3052
|
+
content: {
|
|
3053
|
+
'application/json': components['schemas']['Error'];
|
|
3054
|
+
};
|
|
3055
|
+
};
|
|
3056
|
+
};
|
|
3057
|
+
};
|
|
3058
|
+
'quick-search-items': {
|
|
3059
|
+
parameters: {
|
|
3060
|
+
query?: never;
|
|
3061
|
+
header?: never;
|
|
3062
|
+
path: {
|
|
3063
|
+
query: string;
|
|
3064
|
+
};
|
|
3065
|
+
cookie?: never;
|
|
3066
|
+
};
|
|
3067
|
+
requestBody?: never;
|
|
3068
|
+
responses: {
|
|
3069
|
+
/** @description Item matches. */
|
|
3070
|
+
200: {
|
|
3071
|
+
headers: {
|
|
3072
|
+
[name: string]: unknown;
|
|
3073
|
+
};
|
|
3074
|
+
content: {
|
|
3075
|
+
'application/json': components['schemas']['ItemDatabaseFull'];
|
|
3076
|
+
};
|
|
3077
|
+
};
|
|
3078
|
+
/** @description No items matched the query. */
|
|
3079
|
+
404: {
|
|
3080
|
+
headers: {
|
|
3081
|
+
[name: string]: unknown;
|
|
3082
|
+
};
|
|
3083
|
+
content: {
|
|
3084
|
+
'application/json': components['schemas']['Error'];
|
|
3085
|
+
};
|
|
3086
|
+
};
|
|
3087
|
+
};
|
|
3088
|
+
};
|
|
3089
|
+
'list-recipes': {
|
|
3090
|
+
parameters: {
|
|
3091
|
+
query?: {
|
|
3092
|
+
page?: number;
|
|
3093
|
+
/** @description Presence-based flag that expands responses. Send it without a value as `?full_result`. Using `?full_result=true` or `?full_result=false` is not accepted. */
|
|
3094
|
+
full_result?: components['schemas']['ItemRecipeDatabaseGetParametersFullResult'];
|
|
3095
|
+
};
|
|
3096
|
+
header?: never;
|
|
3097
|
+
path?: never;
|
|
3098
|
+
cookie?: never;
|
|
3099
|
+
};
|
|
3100
|
+
requestBody?: never;
|
|
3101
|
+
responses: {
|
|
3102
|
+
/** @description Paginated recipe list. */
|
|
3103
|
+
200: {
|
|
3104
|
+
headers: {
|
|
3105
|
+
[name: string]: unknown;
|
|
3106
|
+
};
|
|
3107
|
+
content: {
|
|
3108
|
+
'application/json': components['schemas']['PaginatedRecipeResponse'];
|
|
3109
|
+
};
|
|
3110
|
+
};
|
|
3111
|
+
};
|
|
3112
|
+
};
|
|
3113
|
+
'search-recipes': {
|
|
3114
|
+
parameters: {
|
|
3115
|
+
query?: {
|
|
3116
|
+
page?: number;
|
|
3117
|
+
/** @description Presence-based flag that expands responses. Send it without a value as `?full_result`. Using `?full_result=true` or `?full_result=false` is not accepted. */
|
|
3118
|
+
full_result?: components['schemas']['ItemRecipeSearchPostParametersFullResult'];
|
|
3119
|
+
};
|
|
3120
|
+
header?: never;
|
|
3121
|
+
path?: never;
|
|
3122
|
+
cookie?: never;
|
|
3123
|
+
};
|
|
3124
|
+
requestBody?: {
|
|
3125
|
+
content: {
|
|
3126
|
+
'application/json': components['schemas']['RecipeSearchRequest'];
|
|
3127
|
+
};
|
|
3128
|
+
};
|
|
3129
|
+
responses: {
|
|
3130
|
+
/** @description Paginated search results. */
|
|
3131
|
+
200: {
|
|
3132
|
+
headers: {
|
|
3133
|
+
[name: string]: unknown;
|
|
3134
|
+
};
|
|
3135
|
+
content: {
|
|
3136
|
+
'application/json': components['schemas']['PaginatedRecipeResponse'];
|
|
3137
|
+
};
|
|
3138
|
+
};
|
|
3139
|
+
/** @description Invalid request payload. */
|
|
3140
|
+
400: {
|
|
3141
|
+
headers: {
|
|
3142
|
+
[name: string]: unknown;
|
|
3143
|
+
};
|
|
3144
|
+
content: {
|
|
3145
|
+
'application/json': components['schemas']['Error'];
|
|
3146
|
+
};
|
|
3147
|
+
};
|
|
3148
|
+
/** @description No recipes matched the request. */
|
|
3149
|
+
404: {
|
|
3150
|
+
headers: {
|
|
3151
|
+
[name: string]: unknown;
|
|
3152
|
+
};
|
|
3153
|
+
content: {
|
|
3154
|
+
'application/json': components['schemas']['Error'];
|
|
3155
|
+
};
|
|
3156
|
+
};
|
|
3157
|
+
};
|
|
3158
|
+
};
|
|
3159
|
+
'get-item-metadata': {
|
|
3160
|
+
parameters: {
|
|
3161
|
+
query?: {
|
|
3162
|
+
/** @description Presence-based flag that returns only the static metadata payload. Prefer sending it as `?static`. `?static=` is also accepted. */
|
|
3163
|
+
static?: string;
|
|
3164
|
+
};
|
|
3165
|
+
header?: never;
|
|
3166
|
+
path?: never;
|
|
3167
|
+
cookie?: never;
|
|
3168
|
+
};
|
|
3169
|
+
requestBody?: never;
|
|
3170
|
+
responses: {
|
|
3171
|
+
/** @description Filter metadata or static metadata only. */
|
|
3172
|
+
200: {
|
|
3173
|
+
headers: {
|
|
3174
|
+
[name: string]: unknown;
|
|
3175
|
+
};
|
|
3176
|
+
content: {
|
|
3177
|
+
'application/json': components['schemas']['Item_getItemMetadata_Response_200'];
|
|
3178
|
+
};
|
|
3179
|
+
};
|
|
3180
|
+
};
|
|
3181
|
+
};
|
|
3182
|
+
'list-item-sets': {
|
|
3183
|
+
parameters: {
|
|
3184
|
+
query?: never;
|
|
3185
|
+
header?: never;
|
|
3186
|
+
path?: never;
|
|
3187
|
+
cookie?: never;
|
|
3188
|
+
};
|
|
3189
|
+
requestBody?: never;
|
|
3190
|
+
responses: {
|
|
3191
|
+
/** @description Item set map keyed by set name. */
|
|
3192
|
+
200: {
|
|
3193
|
+
headers: {
|
|
3194
|
+
[name: string]: unknown;
|
|
3195
|
+
};
|
|
3196
|
+
content: {
|
|
3197
|
+
'application/json': {
|
|
3198
|
+
[key: string]: components['schemas']['ItemSet'];
|
|
3199
|
+
};
|
|
3200
|
+
};
|
|
3201
|
+
};
|
|
3202
|
+
};
|
|
3203
|
+
};
|
|
3204
|
+
'get-ability-tree': {
|
|
3205
|
+
parameters: {
|
|
3206
|
+
query?: never;
|
|
3207
|
+
header?: never;
|
|
3208
|
+
path: {
|
|
3209
|
+
tree: components['schemas']['AbilityTreeTreeGetParametersTree'];
|
|
3210
|
+
};
|
|
3211
|
+
cookie?: never;
|
|
3212
|
+
};
|
|
3213
|
+
requestBody?: never;
|
|
3214
|
+
responses: {
|
|
3215
|
+
/** @description Ability tree definition. */
|
|
3216
|
+
200: {
|
|
3217
|
+
headers: {
|
|
3218
|
+
[name: string]: unknown;
|
|
3219
|
+
};
|
|
3220
|
+
content: {
|
|
3221
|
+
'application/json': components['schemas']['AbilityTree'];
|
|
3222
|
+
};
|
|
3223
|
+
};
|
|
3224
|
+
/** @description Invalid class tree identifier. */
|
|
3225
|
+
400: {
|
|
3226
|
+
headers: {
|
|
3227
|
+
[name: string]: unknown;
|
|
3228
|
+
};
|
|
3229
|
+
content: {
|
|
3230
|
+
'application/json': components['schemas']['Error'];
|
|
3231
|
+
};
|
|
3232
|
+
};
|
|
3233
|
+
};
|
|
3234
|
+
};
|
|
3235
|
+
'get-ability-map': {
|
|
3236
|
+
parameters: {
|
|
3237
|
+
query?: never;
|
|
3238
|
+
header?: never;
|
|
3239
|
+
path: {
|
|
3240
|
+
tree: components['schemas']['AbilityMapTreeGetParametersTree'];
|
|
3241
|
+
};
|
|
3242
|
+
cookie?: never;
|
|
3243
|
+
};
|
|
3244
|
+
requestBody?: never;
|
|
3245
|
+
responses: {
|
|
3246
|
+
/** @description Ability nodes grouped by page. */
|
|
3247
|
+
200: {
|
|
3248
|
+
headers: {
|
|
3249
|
+
[name: string]: unknown;
|
|
3250
|
+
};
|
|
3251
|
+
content: {
|
|
3252
|
+
'application/json': components['schemas']['AbilityMapPages'];
|
|
3253
|
+
};
|
|
3254
|
+
};
|
|
3255
|
+
/** @description Invalid class tree identifier. */
|
|
3256
|
+
400: {
|
|
3257
|
+
headers: {
|
|
3258
|
+
[name: string]: unknown;
|
|
3259
|
+
};
|
|
3260
|
+
content: {
|
|
3261
|
+
'application/json': components['schemas']['Error'];
|
|
3262
|
+
};
|
|
3263
|
+
};
|
|
3264
|
+
};
|
|
3265
|
+
};
|
|
3266
|
+
'list-aspects': {
|
|
3267
|
+
parameters: {
|
|
3268
|
+
query?: never;
|
|
3269
|
+
header?: never;
|
|
3270
|
+
path: {
|
|
3271
|
+
tree: components['schemas']['AspectsTreeGetParametersTree'];
|
|
3272
|
+
};
|
|
3273
|
+
cookie?: never;
|
|
3274
|
+
};
|
|
3275
|
+
requestBody?: never;
|
|
3276
|
+
responses: {
|
|
3277
|
+
/** @description Aspect list. */
|
|
3278
|
+
200: {
|
|
3279
|
+
headers: {
|
|
3280
|
+
[name: string]: unknown;
|
|
3281
|
+
};
|
|
3282
|
+
content: {
|
|
3283
|
+
'application/json': components['schemas']['Aspect'][];
|
|
3284
|
+
};
|
|
3285
|
+
};
|
|
3286
|
+
/** @description Invalid class tree identifier. */
|
|
3287
|
+
400: {
|
|
3288
|
+
headers: {
|
|
3289
|
+
[name: string]: unknown;
|
|
3290
|
+
};
|
|
3291
|
+
content: {
|
|
3292
|
+
'application/json': components['schemas']['Error'];
|
|
3293
|
+
};
|
|
3294
|
+
};
|
|
3295
|
+
};
|
|
3296
|
+
};
|
|
3297
|
+
'list-classes': {
|
|
3298
|
+
parameters: {
|
|
3299
|
+
query?: never;
|
|
3300
|
+
header?: never;
|
|
3301
|
+
path?: never;
|
|
3302
|
+
cookie?: never;
|
|
3303
|
+
};
|
|
3304
|
+
requestBody?: never;
|
|
3305
|
+
responses: {
|
|
3306
|
+
/** @description Class summary map keyed by class identifier. */
|
|
3307
|
+
200: {
|
|
3308
|
+
headers: {
|
|
3309
|
+
[name: string]: unknown;
|
|
3310
|
+
};
|
|
3311
|
+
content: {
|
|
3312
|
+
'application/json': {
|
|
3313
|
+
[key: string]: components['schemas']['ClassSummary'];
|
|
3314
|
+
};
|
|
3315
|
+
};
|
|
3316
|
+
};
|
|
3317
|
+
/** @description Class metadata could not be loaded. */
|
|
3318
|
+
500: {
|
|
3319
|
+
headers: {
|
|
3320
|
+
[name: string]: unknown;
|
|
3321
|
+
};
|
|
3322
|
+
content: {
|
|
3323
|
+
'application/json': components['schemas']['Error'];
|
|
3324
|
+
};
|
|
3325
|
+
};
|
|
3326
|
+
};
|
|
3327
|
+
};
|
|
3328
|
+
'get-class': {
|
|
3329
|
+
parameters: {
|
|
3330
|
+
query?: never;
|
|
3331
|
+
header?: never;
|
|
3332
|
+
path: {
|
|
3333
|
+
class_name: components['schemas']['ClassesClassNameGetParametersClassName'];
|
|
3334
|
+
};
|
|
3335
|
+
cookie?: never;
|
|
3336
|
+
};
|
|
3337
|
+
requestBody?: never;
|
|
3338
|
+
responses: {
|
|
3339
|
+
/** @description Class detail. */
|
|
3340
|
+
200: {
|
|
3341
|
+
headers: {
|
|
3342
|
+
[name: string]: unknown;
|
|
3343
|
+
};
|
|
3344
|
+
content: {
|
|
3345
|
+
'application/json': components['schemas']['ClassDetail'];
|
|
3346
|
+
};
|
|
3347
|
+
};
|
|
3348
|
+
/** @description Invalid class tree identifier. */
|
|
3349
|
+
400: {
|
|
3350
|
+
headers: {
|
|
3351
|
+
[name: string]: unknown;
|
|
3352
|
+
};
|
|
3353
|
+
content: {
|
|
3354
|
+
'application/json': components['schemas']['Error'];
|
|
3355
|
+
};
|
|
3356
|
+
};
|
|
3357
|
+
/** @description Class metadata could not be loaded. */
|
|
3358
|
+
500: {
|
|
3359
|
+
headers: {
|
|
3360
|
+
[name: string]: unknown;
|
|
3361
|
+
};
|
|
3362
|
+
content: {
|
|
3363
|
+
'application/json': components['schemas']['Error'];
|
|
3364
|
+
};
|
|
3365
|
+
};
|
|
3366
|
+
};
|
|
3367
|
+
};
|
|
3368
|
+
'list-map-markers': {
|
|
3369
|
+
parameters: {
|
|
3370
|
+
query?: never;
|
|
3371
|
+
header?: never;
|
|
3372
|
+
path?: never;
|
|
3373
|
+
cookie?: never;
|
|
3374
|
+
};
|
|
3375
|
+
requestBody?: never;
|
|
3376
|
+
responses: {
|
|
3377
|
+
/** @description Map markers. */
|
|
3378
|
+
200: {
|
|
3379
|
+
headers: {
|
|
3380
|
+
[name: string]: unknown;
|
|
3381
|
+
};
|
|
3382
|
+
content: {
|
|
3383
|
+
'application/json': components['schemas']['MapMarker'][];
|
|
3384
|
+
};
|
|
3385
|
+
};
|
|
3386
|
+
};
|
|
3387
|
+
};
|
|
3388
|
+
'list-player-locations': {
|
|
3389
|
+
parameters: {
|
|
3390
|
+
query?: never;
|
|
3391
|
+
header?: never;
|
|
3392
|
+
path?: never;
|
|
3393
|
+
cookie?: never;
|
|
3394
|
+
};
|
|
3395
|
+
requestBody?: never;
|
|
3396
|
+
responses: {
|
|
3397
|
+
/** @description Visible player locations. */
|
|
3398
|
+
200: {
|
|
3399
|
+
headers: {
|
|
3400
|
+
[name: string]: unknown;
|
|
3401
|
+
};
|
|
3402
|
+
content: {
|
|
3403
|
+
'application/json': components['schemas']['PlayerLocation'][];
|
|
3404
|
+
};
|
|
3405
|
+
};
|
|
3406
|
+
/** @description No eligible online player location could be resolved. */
|
|
3407
|
+
403: {
|
|
3408
|
+
headers: {
|
|
3409
|
+
[name: string]: unknown;
|
|
3410
|
+
};
|
|
3411
|
+
content: {
|
|
3412
|
+
'application/json': components['schemas']['Error'];
|
|
3413
|
+
};
|
|
3414
|
+
};
|
|
3415
|
+
};
|
|
3416
|
+
};
|
|
3417
|
+
'list-world-events': {
|
|
3418
|
+
parameters: {
|
|
3419
|
+
query?: never;
|
|
3420
|
+
header?: never;
|
|
3421
|
+
path?: never;
|
|
3422
|
+
cookie?: never;
|
|
3423
|
+
};
|
|
3424
|
+
requestBody?: never;
|
|
3425
|
+
responses: {
|
|
3426
|
+
/** @description World event metadata and next visible schedules. */
|
|
3427
|
+
200: {
|
|
3428
|
+
headers: {
|
|
3429
|
+
[name: string]: unknown;
|
|
3430
|
+
};
|
|
3431
|
+
content: {
|
|
3432
|
+
'application/json': components['schemas']['WorldEvent'][];
|
|
3433
|
+
};
|
|
3434
|
+
};
|
|
3435
|
+
};
|
|
3436
|
+
};
|
|
3437
|
+
'list-map-camps': {
|
|
3438
|
+
parameters: {
|
|
3439
|
+
query?: {
|
|
3440
|
+
/** @description Preview level used when rendering loot-pool rewards. Invalid values are ignored. */
|
|
3441
|
+
level?: number;
|
|
3442
|
+
};
|
|
3443
|
+
header?: never;
|
|
3444
|
+
path?: never;
|
|
3445
|
+
cookie?: never;
|
|
3446
|
+
};
|
|
3447
|
+
requestBody?: never;
|
|
3448
|
+
responses: {
|
|
3449
|
+
/** @description Camp metadata and reward previews. */
|
|
3450
|
+
200: {
|
|
3451
|
+
headers: {
|
|
3452
|
+
[name: string]: unknown;
|
|
3453
|
+
};
|
|
3454
|
+
content: {
|
|
3455
|
+
'application/json': components['schemas']['MapLootPoolContent'][];
|
|
3456
|
+
};
|
|
3457
|
+
};
|
|
3458
|
+
};
|
|
3459
|
+
};
|
|
3460
|
+
'list-map-raids': {
|
|
3461
|
+
parameters: {
|
|
3462
|
+
query?: {
|
|
3463
|
+
/** @description Preview level used when rendering loot-pool rewards. Invalid values are ignored. */
|
|
3464
|
+
level?: number;
|
|
3465
|
+
};
|
|
3466
|
+
header?: never;
|
|
3467
|
+
path?: never;
|
|
3468
|
+
cookie?: never;
|
|
3469
|
+
};
|
|
3470
|
+
requestBody?: never;
|
|
3471
|
+
responses: {
|
|
3472
|
+
/** @description Raid metadata and reward previews. */
|
|
3473
|
+
200: {
|
|
3474
|
+
headers: {
|
|
3475
|
+
[name: string]: unknown;
|
|
3476
|
+
};
|
|
3477
|
+
content: {
|
|
3478
|
+
'application/json': components['schemas']['MapLootPoolContent'][];
|
|
3479
|
+
};
|
|
3480
|
+
};
|
|
3481
|
+
};
|
|
3482
|
+
};
|
|
3483
|
+
'list-map-loot-pools': {
|
|
3484
|
+
parameters: {
|
|
3485
|
+
query?: {
|
|
3486
|
+
/** @description Preview level used when rendering loot-pool rewards. Invalid values are ignored. */
|
|
3487
|
+
level?: number;
|
|
3488
|
+
};
|
|
3489
|
+
header?: never;
|
|
3490
|
+
path?: never;
|
|
3491
|
+
cookie?: never;
|
|
3492
|
+
};
|
|
3493
|
+
requestBody?: never;
|
|
3494
|
+
responses: {
|
|
3495
|
+
/** @description Camp and raid loot-pool previews. */
|
|
3496
|
+
200: {
|
|
3497
|
+
headers: {
|
|
3498
|
+
[name: string]: unknown;
|
|
3499
|
+
};
|
|
3500
|
+
content: {
|
|
3501
|
+
'application/json': components['schemas']['LootPool'][];
|
|
3502
|
+
};
|
|
3503
|
+
};
|
|
3504
|
+
};
|
|
3505
|
+
};
|
|
3506
|
+
'list-gathering-nodes': {
|
|
3507
|
+
parameters: {
|
|
3508
|
+
query?: never;
|
|
3509
|
+
header?: never;
|
|
3510
|
+
path?: never;
|
|
3511
|
+
cookie?: never;
|
|
3512
|
+
};
|
|
3513
|
+
requestBody?: never;
|
|
3514
|
+
responses: {
|
|
3515
|
+
/** @description Gathering node positions. */
|
|
3516
|
+
200: {
|
|
3517
|
+
headers: {
|
|
3518
|
+
[name: string]: unknown;
|
|
3519
|
+
};
|
|
3520
|
+
content: {
|
|
3521
|
+
'application/json': components['schemas']['GatheringNode'][];
|
|
3522
|
+
};
|
|
3523
|
+
};
|
|
3524
|
+
};
|
|
3525
|
+
};
|
|
3526
|
+
'get-quest-count': {
|
|
3527
|
+
parameters: {
|
|
3528
|
+
query?: never;
|
|
3529
|
+
header?: never;
|
|
3530
|
+
path?: never;
|
|
3531
|
+
cookie?: never;
|
|
3532
|
+
};
|
|
3533
|
+
requestBody?: never;
|
|
3534
|
+
responses: {
|
|
3535
|
+
/** @description Quest count summary. */
|
|
3536
|
+
200: {
|
|
3537
|
+
headers: {
|
|
3538
|
+
[name: string]: unknown;
|
|
3539
|
+
};
|
|
3540
|
+
content: {
|
|
3541
|
+
'application/json': components['schemas']['Map_getQuestCount_Response_200'];
|
|
3542
|
+
};
|
|
3543
|
+
};
|
|
3544
|
+
};
|
|
3545
|
+
};
|
|
3546
|
+
'global-search': {
|
|
3547
|
+
parameters: {
|
|
3548
|
+
query?: {
|
|
3549
|
+
/** @description Restrict global search to one result category. */
|
|
3550
|
+
only?: string;
|
|
3551
|
+
};
|
|
3552
|
+
header?: never;
|
|
3553
|
+
path: {
|
|
3554
|
+
query: string;
|
|
3555
|
+
};
|
|
3556
|
+
cookie?: never;
|
|
3557
|
+
};
|
|
3558
|
+
requestBody?: never;
|
|
3559
|
+
responses: {
|
|
3560
|
+
/** @description Grouped search results. */
|
|
3561
|
+
200: {
|
|
3562
|
+
headers: {
|
|
3563
|
+
[name: string]: unknown;
|
|
3564
|
+
};
|
|
3565
|
+
content: {
|
|
3566
|
+
'application/json': components['schemas']['GlobalSearchResult'];
|
|
3567
|
+
};
|
|
3568
|
+
};
|
|
3569
|
+
/** @description Malformed search query. */
|
|
3570
|
+
400: {
|
|
3571
|
+
headers: {
|
|
3572
|
+
[name: string]: unknown;
|
|
3573
|
+
};
|
|
3574
|
+
content: {
|
|
3575
|
+
'application/json': components['schemas']['Error'];
|
|
3576
|
+
};
|
|
3577
|
+
};
|
|
3578
|
+
/** @description No matches were found in any requested category. */
|
|
3579
|
+
404: {
|
|
3580
|
+
headers: {
|
|
3581
|
+
[name: string]: unknown;
|
|
3582
|
+
};
|
|
3583
|
+
content: {
|
|
3584
|
+
'application/json': components['schemas']['Error'];
|
|
3585
|
+
};
|
|
3586
|
+
};
|
|
3587
|
+
};
|
|
3588
|
+
};
|
|
3589
|
+
'list-leaderboard-types': {
|
|
3590
|
+
parameters: {
|
|
3591
|
+
query?: never;
|
|
3592
|
+
header?: never;
|
|
3593
|
+
path?: never;
|
|
3594
|
+
cookie?: never;
|
|
3595
|
+
};
|
|
3596
|
+
requestBody?: never;
|
|
3597
|
+
responses: {
|
|
3598
|
+
/** @description Leaderboard type identifiers. */
|
|
3599
|
+
200: {
|
|
3600
|
+
headers: {
|
|
3601
|
+
[name: string]: unknown;
|
|
3602
|
+
};
|
|
3603
|
+
content: {
|
|
3604
|
+
'application/json': string[];
|
|
3605
|
+
};
|
|
3606
|
+
};
|
|
3607
|
+
};
|
|
3608
|
+
};
|
|
3609
|
+
'get-leaderboard': {
|
|
3610
|
+
parameters: {
|
|
3611
|
+
query?: {
|
|
3612
|
+
/** @description Defaults to 100. */
|
|
3613
|
+
resultLimit?: number;
|
|
3614
|
+
};
|
|
3615
|
+
header?: never;
|
|
3616
|
+
path: {
|
|
3617
|
+
/** @description Leaderboard identifier such as `playerContent`. */
|
|
3618
|
+
lb_type: string;
|
|
3619
|
+
};
|
|
3620
|
+
cookie?: never;
|
|
3621
|
+
};
|
|
3622
|
+
requestBody?: never;
|
|
3623
|
+
responses: {
|
|
3624
|
+
/** @description Leaderboard entries keyed by ranking position. */
|
|
3625
|
+
200: {
|
|
3626
|
+
headers: {
|
|
3627
|
+
[name: string]: unknown;
|
|
3628
|
+
};
|
|
3629
|
+
content: {
|
|
3630
|
+
'application/json': {
|
|
3631
|
+
[key: string]: components['schemas']['LeaderboardEntry'];
|
|
3632
|
+
};
|
|
3633
|
+
};
|
|
3634
|
+
};
|
|
3635
|
+
/** @description Invalid leaderboard type. */
|
|
3636
|
+
400: {
|
|
3637
|
+
headers: {
|
|
3638
|
+
[name: string]: unknown;
|
|
3639
|
+
};
|
|
3640
|
+
content: {
|
|
3641
|
+
'application/json': components['schemas']['Error'];
|
|
3642
|
+
};
|
|
3643
|
+
};
|
|
3644
|
+
};
|
|
3645
|
+
};
|
|
3646
|
+
'fetch-publisher-article': {
|
|
3647
|
+
parameters: {
|
|
3648
|
+
query?: never;
|
|
3649
|
+
header?: never;
|
|
3650
|
+
path: {
|
|
3651
|
+
/** @description Publisher content type. Use `article` to return every published article type. */
|
|
3652
|
+
article_type: components['schemas']['PublisherArticleType'];
|
|
3653
|
+
pk: string;
|
|
3654
|
+
};
|
|
3655
|
+
cookie?: never;
|
|
3656
|
+
};
|
|
3657
|
+
requestBody?: never;
|
|
3658
|
+
responses: {
|
|
3659
|
+
/** @description Article detail. */
|
|
3660
|
+
200: {
|
|
3661
|
+
headers: {
|
|
3662
|
+
[name: string]: unknown;
|
|
3663
|
+
};
|
|
3664
|
+
content: {
|
|
3665
|
+
'application/json': components['schemas']['PublisherArticle'];
|
|
3666
|
+
};
|
|
3667
|
+
};
|
|
3668
|
+
/** @description The requested article is not visible or does not exist. */
|
|
3669
|
+
404: {
|
|
3670
|
+
headers: {
|
|
3671
|
+
[name: string]: unknown;
|
|
3672
|
+
};
|
|
3673
|
+
content: {
|
|
3674
|
+
'application/json': components['schemas']['Error'];
|
|
3675
|
+
};
|
|
3676
|
+
};
|
|
3677
|
+
};
|
|
3678
|
+
};
|
|
3679
|
+
'list-publisher-articles': {
|
|
3680
|
+
parameters: {
|
|
3681
|
+
query?: {
|
|
3682
|
+
page?: number;
|
|
3683
|
+
};
|
|
3684
|
+
header?: never;
|
|
3685
|
+
path: {
|
|
3686
|
+
article_type: components['schemas']['PublisherArticleType'];
|
|
3687
|
+
};
|
|
3688
|
+
cookie?: never;
|
|
3689
|
+
};
|
|
3690
|
+
requestBody?: never;
|
|
3691
|
+
responses: {
|
|
3692
|
+
/** @description Paginated article list. */
|
|
3693
|
+
200: {
|
|
3694
|
+
headers: {
|
|
3695
|
+
[name: string]: unknown;
|
|
3696
|
+
};
|
|
3697
|
+
content: {
|
|
3698
|
+
'application/json': components['schemas']['PublisherArticleList'];
|
|
3699
|
+
};
|
|
3700
|
+
};
|
|
3701
|
+
};
|
|
3702
|
+
};
|
|
3703
|
+
'list-publisher-videos': {
|
|
3704
|
+
parameters: {
|
|
3705
|
+
query?: never;
|
|
3706
|
+
header?: never;
|
|
3707
|
+
path?: never;
|
|
3708
|
+
cookie?: never;
|
|
3709
|
+
};
|
|
3710
|
+
requestBody?: never;
|
|
3711
|
+
responses: {
|
|
3712
|
+
/** @description Video list keyed by display position. */
|
|
3713
|
+
200: {
|
|
3714
|
+
headers: {
|
|
3715
|
+
[name: string]: unknown;
|
|
3716
|
+
};
|
|
3717
|
+
content: {
|
|
3718
|
+
'application/json': {
|
|
3719
|
+
[key: string]: string;
|
|
3720
|
+
};
|
|
3721
|
+
};
|
|
3722
|
+
};
|
|
3723
|
+
};
|
|
3724
|
+
};
|
|
3725
|
+
'list-latest-news': {
|
|
3726
|
+
parameters: {
|
|
3727
|
+
query?: never;
|
|
3728
|
+
header?: never;
|
|
3729
|
+
path?: never;
|
|
3730
|
+
cookie?: never;
|
|
3731
|
+
};
|
|
3732
|
+
requestBody?: never;
|
|
3733
|
+
responses: {
|
|
3734
|
+
/** @description Latest news entries. */
|
|
3735
|
+
200: {
|
|
3736
|
+
headers: {
|
|
3737
|
+
[name: string]: unknown;
|
|
3738
|
+
};
|
|
3739
|
+
content: {
|
|
3740
|
+
'application/json': components['schemas']['LatestNewsEntry'][];
|
|
3741
|
+
};
|
|
3742
|
+
};
|
|
3743
|
+
};
|
|
3744
|
+
};
|
|
3745
|
+
'get-player': {
|
|
3746
|
+
parameters: {
|
|
3747
|
+
query?: {
|
|
3748
|
+
/** @description Presence-based flag that expands responses. Send it without a value as `?fullResult`. Using `?fullResult=true` or `?fullResult=false` is not accepted. */
|
|
3749
|
+
fullResult?: components['schemas']['PlayerUsernameGetParametersFullResult'];
|
|
3750
|
+
};
|
|
3751
|
+
header?: never;
|
|
3752
|
+
path: {
|
|
3753
|
+
/** @description Username or UUID accepted by the player route. */
|
|
3754
|
+
username: string;
|
|
3755
|
+
};
|
|
3756
|
+
cookie?: never;
|
|
3757
|
+
};
|
|
3758
|
+
requestBody?: never;
|
|
3759
|
+
responses: {
|
|
3760
|
+
/** @description Player profile. */
|
|
3761
|
+
200: {
|
|
3762
|
+
headers: {
|
|
3763
|
+
[name: string]: unknown;
|
|
3764
|
+
};
|
|
3765
|
+
content: {
|
|
3766
|
+
'application/json': components['schemas']['Player'];
|
|
3767
|
+
};
|
|
3768
|
+
};
|
|
3769
|
+
/** @description Multiple player profiles found. */
|
|
3770
|
+
300: {
|
|
3771
|
+
headers: {
|
|
3772
|
+
[name: string]: unknown;
|
|
3773
|
+
};
|
|
3774
|
+
content: {
|
|
3775
|
+
'application/json': components['schemas']['PlayerMultiSelector'];
|
|
3776
|
+
};
|
|
3777
|
+
};
|
|
3778
|
+
/** @description No matching player was found. */
|
|
3779
|
+
404: {
|
|
3780
|
+
headers: {
|
|
3781
|
+
[name: string]: unknown;
|
|
3782
|
+
};
|
|
3783
|
+
content: {
|
|
3784
|
+
'application/json': components['schemas']['Error'];
|
|
3785
|
+
};
|
|
3786
|
+
};
|
|
3787
|
+
/** @description Player payload construction failed. */
|
|
3788
|
+
500: {
|
|
3789
|
+
headers: {
|
|
3790
|
+
[name: string]: unknown;
|
|
3791
|
+
};
|
|
3792
|
+
content: {
|
|
3793
|
+
'application/json': components['schemas']['Error'];
|
|
3794
|
+
};
|
|
3795
|
+
};
|
|
3796
|
+
};
|
|
3797
|
+
};
|
|
3798
|
+
}
|