aegis-api 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +229 -2
- package/dist/client.d.ts +22 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +37 -0
- package/dist/client.js.map +1 -0
- package/dist/errors.d.ts +18 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +16 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated/schema.d.ts +3650 -0
- package/dist/generated/schema.d.ts.map +1 -0
- package/dist/generated/schema.js +6 -0
- package/dist/generated/schema.js.map +1 -0
- package/dist/http.d.ts +25 -0
- package/dist/http.d.ts.map +1 -0
- package/dist/http.js +108 -0
- package/dist/http.js.map +1 -0
- package/dist/index.d.ts +26 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/resources/base.d.ts +9 -0
- package/dist/resources/base.d.ts.map +1 -0
- package/dist/resources/base.js +11 -0
- package/dist/resources/base.js.map +1 -0
- package/dist/resources/bible.d.ts +47 -0
- package/dist/resources/bible.d.ts.map +1 -0
- package/dist/resources/bible.js +36 -0
- package/dist/resources/bible.js.map +1 -0
- package/dist/resources/binary.d.ts +18 -0
- package/dist/resources/binary.d.ts.map +1 -0
- package/dist/resources/binary.js +12 -0
- package/dist/resources/binary.js.map +1 -0
- package/dist/resources/fun.d.ts +18 -0
- package/dist/resources/fun.d.ts.map +1 -0
- package/dist/resources/fun.js +8 -0
- package/dist/resources/fun.js.map +1 -0
- package/dist/resources/general.d.ts +19 -0
- package/dist/resources/general.d.ts.map +1 -0
- package/dist/resources/general.js +8 -0
- package/dist/resources/general.js.map +1 -0
- package/dist/resources/holidays.d.ts +29 -0
- package/dist/resources/holidays.d.ts.map +1 -0
- package/dist/resources/holidays.js +12 -0
- package/dist/resources/holidays.js.map +1 -0
- package/dist/resources/index.d.ts +12 -0
- package/dist/resources/index.d.ts.map +1 -0
- package/dist/resources/index.js +12 -0
- package/dist/resources/index.js.map +1 -0
- package/dist/resources/jobs.d.ts +28 -0
- package/dist/resources/jobs.d.ts.map +1 -0
- package/dist/resources/jobs.js +12 -0
- package/dist/resources/jobs.js.map +1 -0
- package/dist/resources/minecraft.d.ts +27 -0
- package/dist/resources/minecraft.d.ts.map +1 -0
- package/dist/resources/minecraft.js +16 -0
- package/dist/resources/minecraft.js.map +1 -0
- package/dist/resources/music/index.d.ts +3 -0
- package/dist/resources/music/index.d.ts.map +1 -0
- package/dist/resources/music/index.js +3 -0
- package/dist/resources/music/index.js.map +1 -0
- package/dist/resources/music/music-events.d.ts +43 -0
- package/dist/resources/music/music-events.d.ts.map +1 -0
- package/dist/resources/music/music-events.js +8 -0
- package/dist/resources/music/music-events.js.map +1 -0
- package/dist/resources/music/music.d.ts +106 -0
- package/dist/resources/music/music.d.ts.map +1 -0
- package/dist/resources/music/music.js +106 -0
- package/dist/resources/music/music.js.map +1 -0
- package/dist/resources/roblox.d.ts +43 -0
- package/dist/resources/roblox.d.ts.map +1 -0
- package/dist/resources/roblox.js +12 -0
- package/dist/resources/roblox.js.map +1 -0
- package/dist/resources/translation.d.ts +26 -0
- package/dist/resources/translation.d.ts.map +1 -0
- package/dist/resources/translation.js +16 -0
- package/dist/resources/translation.js.map +1 -0
- package/dist/socket.d.ts +36 -0
- package/dist/socket.d.ts.map +1 -0
- package/dist/socket.js +139 -0
- package/dist/socket.js.map +1 -0
- package/dist/types.d.ts +65 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +51 -4
|
@@ -0,0 +1,3650 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
"/": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* API Root Banner
|
|
15
|
+
* @description Returns the Aegis API welcome ASCII banner in plain text.
|
|
16
|
+
*/
|
|
17
|
+
get: {
|
|
18
|
+
parameters: {
|
|
19
|
+
query?: never;
|
|
20
|
+
header?: never;
|
|
21
|
+
path?: never;
|
|
22
|
+
cookie?: never;
|
|
23
|
+
};
|
|
24
|
+
requestBody?: never;
|
|
25
|
+
responses: {
|
|
26
|
+
/** @description ASCII banner response */
|
|
27
|
+
200: {
|
|
28
|
+
headers: {
|
|
29
|
+
[name: string]: unknown;
|
|
30
|
+
};
|
|
31
|
+
content: {
|
|
32
|
+
"text/plain": string;
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
put?: never;
|
|
38
|
+
post?: never;
|
|
39
|
+
delete?: never;
|
|
40
|
+
options?: never;
|
|
41
|
+
head?: never;
|
|
42
|
+
patch?: never;
|
|
43
|
+
trace?: never;
|
|
44
|
+
};
|
|
45
|
+
"/v1/fun/roleplay": {
|
|
46
|
+
parameters: {
|
|
47
|
+
query?: never;
|
|
48
|
+
header?: never;
|
|
49
|
+
path?: never;
|
|
50
|
+
cookie?: never;
|
|
51
|
+
};
|
|
52
|
+
/** @description Retorna um GIF aleatório da categoria de roleplay informada. */
|
|
53
|
+
get: {
|
|
54
|
+
parameters: {
|
|
55
|
+
query: {
|
|
56
|
+
type: "angry" | "baka" | "bite" | "bleh" | "blowkiss" | "blush" | "bonk" | "bored" | "carry" | "clap" | "confused" | "cry" | "cuddle" | "dance" | "facepalm" | "feed" | "handhold" | "handshake" | "happy" | "highfive" | "hug" | "kabedon" | "kick" | "kiss" | "lappillow" | "laugh" | "lurk" | "nod" | "nom" | "nope" | "nya" | "pat" | "peck" | "poke" | "pout" | "punch" | "run" | "salute" | "shake" | "shocked" | "shoot" | "shrug" | "sip" | "slap" | "sleep" | "smile" | "smug" | "spin" | "stare" | "tableflip" | "teehee" | "think" | "thumbsup" | "tickle" | "wag" | "wave" | "wink" | "yawn" | "yeet";
|
|
57
|
+
};
|
|
58
|
+
header?: never;
|
|
59
|
+
path?: never;
|
|
60
|
+
cookie?: never;
|
|
61
|
+
};
|
|
62
|
+
requestBody?: never;
|
|
63
|
+
responses: {
|
|
64
|
+
/** @description Success */
|
|
65
|
+
200: {
|
|
66
|
+
headers: {
|
|
67
|
+
[name: string]: unknown;
|
|
68
|
+
};
|
|
69
|
+
content: {
|
|
70
|
+
"application/json": {
|
|
71
|
+
success: boolean;
|
|
72
|
+
data: {
|
|
73
|
+
results: {
|
|
74
|
+
animeName: string | null;
|
|
75
|
+
url: string;
|
|
76
|
+
dimensions: {
|
|
77
|
+
width: number;
|
|
78
|
+
height: number;
|
|
79
|
+
} | null;
|
|
80
|
+
}[];
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
/** @description Bad request */
|
|
86
|
+
400: {
|
|
87
|
+
headers: {
|
|
88
|
+
[name: string]: unknown;
|
|
89
|
+
};
|
|
90
|
+
content: {
|
|
91
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
/** @description No GIFs stored for this roleplay type */
|
|
95
|
+
404: {
|
|
96
|
+
headers: {
|
|
97
|
+
[name: string]: unknown;
|
|
98
|
+
};
|
|
99
|
+
content: {
|
|
100
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
/** @description Internal server error */
|
|
104
|
+
500: {
|
|
105
|
+
headers: {
|
|
106
|
+
[name: string]: unknown;
|
|
107
|
+
};
|
|
108
|
+
content: {
|
|
109
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
/** @description File service unavailable */
|
|
113
|
+
503: {
|
|
114
|
+
headers: {
|
|
115
|
+
[name: string]: unknown;
|
|
116
|
+
};
|
|
117
|
+
content: {
|
|
118
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
put?: never;
|
|
124
|
+
post?: never;
|
|
125
|
+
delete?: never;
|
|
126
|
+
options?: never;
|
|
127
|
+
head?: never;
|
|
128
|
+
patch?: never;
|
|
129
|
+
trace?: never;
|
|
130
|
+
};
|
|
131
|
+
"/v1/binary/encode": {
|
|
132
|
+
parameters: {
|
|
133
|
+
query?: never;
|
|
134
|
+
header?: never;
|
|
135
|
+
path?: never;
|
|
136
|
+
cookie?: never;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Encode text to binary
|
|
140
|
+
* @description Encode text to binary
|
|
141
|
+
*/
|
|
142
|
+
get: {
|
|
143
|
+
parameters: {
|
|
144
|
+
query: {
|
|
145
|
+
text: string;
|
|
146
|
+
};
|
|
147
|
+
header?: never;
|
|
148
|
+
path?: never;
|
|
149
|
+
cookie?: never;
|
|
150
|
+
};
|
|
151
|
+
requestBody?: never;
|
|
152
|
+
responses: {
|
|
153
|
+
/** @description The text was encoded to binary */
|
|
154
|
+
200: {
|
|
155
|
+
headers: {
|
|
156
|
+
[name: string]: unknown;
|
|
157
|
+
};
|
|
158
|
+
content: {
|
|
159
|
+
"application/json": {
|
|
160
|
+
error: boolean;
|
|
161
|
+
data: {
|
|
162
|
+
text?: string;
|
|
163
|
+
error?: string;
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
};
|
|
167
|
+
};
|
|
168
|
+
/** @description Bad request */
|
|
169
|
+
400: {
|
|
170
|
+
headers: {
|
|
171
|
+
[name: string]: unknown;
|
|
172
|
+
};
|
|
173
|
+
content: {
|
|
174
|
+
"application/json": {
|
|
175
|
+
error: boolean;
|
|
176
|
+
data: {
|
|
177
|
+
text?: string;
|
|
178
|
+
error?: string;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
};
|
|
185
|
+
put?: never;
|
|
186
|
+
post?: never;
|
|
187
|
+
delete?: never;
|
|
188
|
+
options?: never;
|
|
189
|
+
head?: never;
|
|
190
|
+
patch?: never;
|
|
191
|
+
trace?: never;
|
|
192
|
+
};
|
|
193
|
+
"/v1/binary/decode": {
|
|
194
|
+
parameters: {
|
|
195
|
+
query?: never;
|
|
196
|
+
header?: never;
|
|
197
|
+
path?: never;
|
|
198
|
+
cookie?: never;
|
|
199
|
+
};
|
|
200
|
+
/**
|
|
201
|
+
* Decode binary to text
|
|
202
|
+
* @description Decode binary to text
|
|
203
|
+
*/
|
|
204
|
+
get: {
|
|
205
|
+
parameters: {
|
|
206
|
+
query: {
|
|
207
|
+
text: string;
|
|
208
|
+
};
|
|
209
|
+
header?: never;
|
|
210
|
+
path?: never;
|
|
211
|
+
cookie?: never;
|
|
212
|
+
};
|
|
213
|
+
requestBody?: never;
|
|
214
|
+
responses: {
|
|
215
|
+
/** @description The binary was decoded to text */
|
|
216
|
+
200: {
|
|
217
|
+
headers: {
|
|
218
|
+
[name: string]: unknown;
|
|
219
|
+
};
|
|
220
|
+
content: {
|
|
221
|
+
"application/json": {
|
|
222
|
+
error: boolean;
|
|
223
|
+
data: {
|
|
224
|
+
text?: string;
|
|
225
|
+
error?: string;
|
|
226
|
+
};
|
|
227
|
+
};
|
|
228
|
+
};
|
|
229
|
+
};
|
|
230
|
+
/** @description Bad request */
|
|
231
|
+
400: {
|
|
232
|
+
headers: {
|
|
233
|
+
[name: string]: unknown;
|
|
234
|
+
};
|
|
235
|
+
content: {
|
|
236
|
+
"application/json": {
|
|
237
|
+
error: boolean;
|
|
238
|
+
data: {
|
|
239
|
+
text?: string;
|
|
240
|
+
error?: string;
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
put?: never;
|
|
248
|
+
post?: never;
|
|
249
|
+
delete?: never;
|
|
250
|
+
options?: never;
|
|
251
|
+
head?: never;
|
|
252
|
+
patch?: never;
|
|
253
|
+
trace?: never;
|
|
254
|
+
};
|
|
255
|
+
"/v1/translation/translate": {
|
|
256
|
+
parameters: {
|
|
257
|
+
query?: never;
|
|
258
|
+
header?: never;
|
|
259
|
+
path?: never;
|
|
260
|
+
cookie?: never;
|
|
261
|
+
};
|
|
262
|
+
/** Translate text from one language to another */
|
|
263
|
+
get: {
|
|
264
|
+
parameters: {
|
|
265
|
+
query: {
|
|
266
|
+
/** @description Text to be translated */
|
|
267
|
+
text: string;
|
|
268
|
+
/** @description Target language code (e.g., 'es' for Spanish) */
|
|
269
|
+
to: string;
|
|
270
|
+
/** @description Source language code (e.g., 'en' for English) */
|
|
271
|
+
from?: string;
|
|
272
|
+
};
|
|
273
|
+
header?: never;
|
|
274
|
+
path?: never;
|
|
275
|
+
cookie?: never;
|
|
276
|
+
};
|
|
277
|
+
requestBody?: never;
|
|
278
|
+
responses: {
|
|
279
|
+
/** @description Successful translation */
|
|
280
|
+
200: {
|
|
281
|
+
headers: {
|
|
282
|
+
[name: string]: unknown;
|
|
283
|
+
};
|
|
284
|
+
content: {
|
|
285
|
+
"application/json": {
|
|
286
|
+
success: boolean;
|
|
287
|
+
data: {
|
|
288
|
+
originalText: string;
|
|
289
|
+
translatedText: string;
|
|
290
|
+
sourceLanguage: string;
|
|
291
|
+
targetLanguage: string;
|
|
292
|
+
};
|
|
293
|
+
requestId?: string;
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
/** @description Bad request */
|
|
298
|
+
400: {
|
|
299
|
+
headers: {
|
|
300
|
+
[name: string]: unknown;
|
|
301
|
+
};
|
|
302
|
+
content: {
|
|
303
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
304
|
+
};
|
|
305
|
+
};
|
|
306
|
+
/** @description Internal server error */
|
|
307
|
+
500: {
|
|
308
|
+
headers: {
|
|
309
|
+
[name: string]: unknown;
|
|
310
|
+
};
|
|
311
|
+
content: {
|
|
312
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
313
|
+
};
|
|
314
|
+
};
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
put?: never;
|
|
318
|
+
post?: never;
|
|
319
|
+
delete?: never;
|
|
320
|
+
options?: never;
|
|
321
|
+
head?: never;
|
|
322
|
+
patch?: never;
|
|
323
|
+
trace?: never;
|
|
324
|
+
};
|
|
325
|
+
"/v1/translation/detect": {
|
|
326
|
+
parameters: {
|
|
327
|
+
query?: never;
|
|
328
|
+
header?: never;
|
|
329
|
+
path?: never;
|
|
330
|
+
cookie?: never;
|
|
331
|
+
};
|
|
332
|
+
/** Detect the language of a given text */
|
|
333
|
+
get: {
|
|
334
|
+
parameters: {
|
|
335
|
+
query: {
|
|
336
|
+
/** @description Text for which the language needs to be detected */
|
|
337
|
+
text: string;
|
|
338
|
+
};
|
|
339
|
+
header?: never;
|
|
340
|
+
path?: never;
|
|
341
|
+
cookie?: never;
|
|
342
|
+
};
|
|
343
|
+
requestBody?: never;
|
|
344
|
+
responses: {
|
|
345
|
+
/** @description Successful language detection */
|
|
346
|
+
200: {
|
|
347
|
+
headers: {
|
|
348
|
+
[name: string]: unknown;
|
|
349
|
+
};
|
|
350
|
+
content: {
|
|
351
|
+
"application/json": {
|
|
352
|
+
success: boolean;
|
|
353
|
+
data: {
|
|
354
|
+
text: string;
|
|
355
|
+
language: string;
|
|
356
|
+
};
|
|
357
|
+
requestId?: string;
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
/** @description Bad request */
|
|
362
|
+
400: {
|
|
363
|
+
headers: {
|
|
364
|
+
[name: string]: unknown;
|
|
365
|
+
};
|
|
366
|
+
content: {
|
|
367
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
368
|
+
};
|
|
369
|
+
};
|
|
370
|
+
/** @description Internal server error */
|
|
371
|
+
500: {
|
|
372
|
+
headers: {
|
|
373
|
+
[name: string]: unknown;
|
|
374
|
+
};
|
|
375
|
+
content: {
|
|
376
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
377
|
+
};
|
|
378
|
+
};
|
|
379
|
+
};
|
|
380
|
+
};
|
|
381
|
+
put?: never;
|
|
382
|
+
post?: never;
|
|
383
|
+
delete?: never;
|
|
384
|
+
options?: never;
|
|
385
|
+
head?: never;
|
|
386
|
+
patch?: never;
|
|
387
|
+
trace?: never;
|
|
388
|
+
};
|
|
389
|
+
"/v1/translation/languages": {
|
|
390
|
+
parameters: {
|
|
391
|
+
query?: never;
|
|
392
|
+
header?: never;
|
|
393
|
+
path?: never;
|
|
394
|
+
cookie?: never;
|
|
395
|
+
};
|
|
396
|
+
/** Get a list of supported languages for translation */
|
|
397
|
+
get: {
|
|
398
|
+
parameters: {
|
|
399
|
+
query?: never;
|
|
400
|
+
header?: never;
|
|
401
|
+
path?: never;
|
|
402
|
+
cookie?: never;
|
|
403
|
+
};
|
|
404
|
+
requestBody?: never;
|
|
405
|
+
responses: {
|
|
406
|
+
/** @description List of supported languages retrieved successfully */
|
|
407
|
+
200: {
|
|
408
|
+
headers: {
|
|
409
|
+
[name: string]: unknown;
|
|
410
|
+
};
|
|
411
|
+
content: {
|
|
412
|
+
"application/json": {
|
|
413
|
+
/** @example true */
|
|
414
|
+
success: boolean;
|
|
415
|
+
data: {
|
|
416
|
+
/** @description List of supported languages for translation */
|
|
417
|
+
languages: {
|
|
418
|
+
/**
|
|
419
|
+
* @description Language code
|
|
420
|
+
* @example pt
|
|
421
|
+
*/
|
|
422
|
+
code: string;
|
|
423
|
+
/**
|
|
424
|
+
* @description Language name
|
|
425
|
+
* @example Portuguese (Brazil)
|
|
426
|
+
*/
|
|
427
|
+
name: string;
|
|
428
|
+
}[];
|
|
429
|
+
};
|
|
430
|
+
requestId?: string;
|
|
431
|
+
};
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
put?: never;
|
|
437
|
+
post?: never;
|
|
438
|
+
delete?: never;
|
|
439
|
+
options?: never;
|
|
440
|
+
head?: never;
|
|
441
|
+
patch?: never;
|
|
442
|
+
trace?: never;
|
|
443
|
+
};
|
|
444
|
+
"/v1/roblox/user/{target}": {
|
|
445
|
+
parameters: {
|
|
446
|
+
query?: never;
|
|
447
|
+
header?: never;
|
|
448
|
+
path?: never;
|
|
449
|
+
cookie?: never;
|
|
450
|
+
};
|
|
451
|
+
/** Get Roblox user information by ID or Username */
|
|
452
|
+
get: {
|
|
453
|
+
parameters: {
|
|
454
|
+
query?: never;
|
|
455
|
+
header?: never;
|
|
456
|
+
path: {
|
|
457
|
+
/** @description The Roblox user ID or Username */
|
|
458
|
+
target: string;
|
|
459
|
+
};
|
|
460
|
+
cookie?: never;
|
|
461
|
+
};
|
|
462
|
+
requestBody?: never;
|
|
463
|
+
responses: {
|
|
464
|
+
/** @description Successful response with Roblox user information */
|
|
465
|
+
200: {
|
|
466
|
+
headers: {
|
|
467
|
+
[name: string]: unknown;
|
|
468
|
+
};
|
|
469
|
+
content: {
|
|
470
|
+
"application/json": {
|
|
471
|
+
success: boolean;
|
|
472
|
+
data: {
|
|
473
|
+
/**
|
|
474
|
+
* @description The Roblox user ID
|
|
475
|
+
* @example 123456789
|
|
476
|
+
*/
|
|
477
|
+
id: string;
|
|
478
|
+
/**
|
|
479
|
+
* @description The Roblox username
|
|
480
|
+
* @example username
|
|
481
|
+
*/
|
|
482
|
+
username: string;
|
|
483
|
+
/**
|
|
484
|
+
* @description The Roblox display name
|
|
485
|
+
* @example Display Name
|
|
486
|
+
*/
|
|
487
|
+
displayName: string;
|
|
488
|
+
/**
|
|
489
|
+
* @description The Roblox user description
|
|
490
|
+
* @example Description
|
|
491
|
+
*/
|
|
492
|
+
description: string;
|
|
493
|
+
/**
|
|
494
|
+
* @description The Roblox user followers count
|
|
495
|
+
* @example 0
|
|
496
|
+
*/
|
|
497
|
+
followers: number;
|
|
498
|
+
/**
|
|
499
|
+
* @description The Roblox user followings count
|
|
500
|
+
* @example 0
|
|
501
|
+
*/
|
|
502
|
+
followings: number;
|
|
503
|
+
/**
|
|
504
|
+
* @description The Roblox user friends count
|
|
505
|
+
* @example 0
|
|
506
|
+
*/
|
|
507
|
+
friends: number;
|
|
508
|
+
/**
|
|
509
|
+
* @description Indicates if the Roblox user is verified
|
|
510
|
+
* @example false
|
|
511
|
+
*/
|
|
512
|
+
isVerified: boolean;
|
|
513
|
+
/**
|
|
514
|
+
* @description Indicates if the Roblox user is banned
|
|
515
|
+
* @example false
|
|
516
|
+
*/
|
|
517
|
+
isBanned: boolean;
|
|
518
|
+
/**
|
|
519
|
+
* @description The Roblox user creation date
|
|
520
|
+
* @example 2023-01-01T00:00:00.000Z
|
|
521
|
+
*/
|
|
522
|
+
createdAt: string;
|
|
523
|
+
/**
|
|
524
|
+
* @description URL of the Roblox user full-body avatar image
|
|
525
|
+
* @example https://tr.rbxcdn.com/.../420/420/Avatar/Png
|
|
526
|
+
*/
|
|
527
|
+
avatar: string | null;
|
|
528
|
+
/**
|
|
529
|
+
* @description URL of the Roblox user headshot image
|
|
530
|
+
* @example https://tr.rbxcdn.com/.../150/150/AvatarHeadshot/Png
|
|
531
|
+
*/
|
|
532
|
+
avatarHeadshot: string | null;
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
};
|
|
537
|
+
/** @description Bad request */
|
|
538
|
+
400: {
|
|
539
|
+
headers: {
|
|
540
|
+
[name: string]: unknown;
|
|
541
|
+
};
|
|
542
|
+
content: {
|
|
543
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
544
|
+
};
|
|
545
|
+
};
|
|
546
|
+
/** @description User not found */
|
|
547
|
+
404: {
|
|
548
|
+
headers: {
|
|
549
|
+
[name: string]: unknown;
|
|
550
|
+
};
|
|
551
|
+
content: {
|
|
552
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
553
|
+
};
|
|
554
|
+
};
|
|
555
|
+
/** @description Internal server error */
|
|
556
|
+
500: {
|
|
557
|
+
headers: {
|
|
558
|
+
[name: string]: unknown;
|
|
559
|
+
};
|
|
560
|
+
content: {
|
|
561
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
562
|
+
};
|
|
563
|
+
};
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
put?: never;
|
|
567
|
+
post?: never;
|
|
568
|
+
delete?: never;
|
|
569
|
+
options?: never;
|
|
570
|
+
head?: never;
|
|
571
|
+
patch?: never;
|
|
572
|
+
trace?: never;
|
|
573
|
+
};
|
|
574
|
+
"/v1/roblox/game/{target}": {
|
|
575
|
+
parameters: {
|
|
576
|
+
query?: never;
|
|
577
|
+
header?: never;
|
|
578
|
+
path?: never;
|
|
579
|
+
cookie?: never;
|
|
580
|
+
};
|
|
581
|
+
/** Get detailed Roblox game information by Universe ID or Place ID */
|
|
582
|
+
get: {
|
|
583
|
+
parameters: {
|
|
584
|
+
query?: never;
|
|
585
|
+
header?: never;
|
|
586
|
+
path: {
|
|
587
|
+
/** @description The Roblox Universe ID or Place ID */
|
|
588
|
+
target: string;
|
|
589
|
+
};
|
|
590
|
+
cookie?: never;
|
|
591
|
+
};
|
|
592
|
+
requestBody?: never;
|
|
593
|
+
responses: {
|
|
594
|
+
/** @description Successful response with Roblox game information */
|
|
595
|
+
200: {
|
|
596
|
+
headers: {
|
|
597
|
+
[name: string]: unknown;
|
|
598
|
+
};
|
|
599
|
+
content: {
|
|
600
|
+
"application/json": {
|
|
601
|
+
success: boolean;
|
|
602
|
+
data: {
|
|
603
|
+
/**
|
|
604
|
+
* @description The Roblox game Universe ID
|
|
605
|
+
* @example 10563114921
|
|
606
|
+
*/
|
|
607
|
+
universeId: number;
|
|
608
|
+
/**
|
|
609
|
+
* @description The main Place ID of the game
|
|
610
|
+
* @example 107778070777162
|
|
611
|
+
*/
|
|
612
|
+
rootPlaceId: number;
|
|
613
|
+
/**
|
|
614
|
+
* @description The name of the game
|
|
615
|
+
* @example Roube um ovo
|
|
616
|
+
*/
|
|
617
|
+
name: string;
|
|
618
|
+
/**
|
|
619
|
+
* @description The description of the game
|
|
620
|
+
* @example Bem-vindo...
|
|
621
|
+
*/
|
|
622
|
+
description: string;
|
|
623
|
+
/**
|
|
624
|
+
* @description Full Roblox game URL
|
|
625
|
+
* @example https://www.roblox.com/games/107778070777162/Steal-An-Egg
|
|
626
|
+
*/
|
|
627
|
+
url: string;
|
|
628
|
+
/**
|
|
629
|
+
* @description Game icon image URL
|
|
630
|
+
* @example https://tr.rbxcdn.com/...
|
|
631
|
+
*/
|
|
632
|
+
iconUrl: string | null;
|
|
633
|
+
creator: {
|
|
634
|
+
/**
|
|
635
|
+
* @description Creator User or Group ID
|
|
636
|
+
* @example 825735094
|
|
637
|
+
*/
|
|
638
|
+
id: number;
|
|
639
|
+
/**
|
|
640
|
+
* @description Creator Name
|
|
641
|
+
* @example and Collect Rare Pets
|
|
642
|
+
*/
|
|
643
|
+
name: string;
|
|
644
|
+
/**
|
|
645
|
+
* @description User or Group
|
|
646
|
+
* @example Group
|
|
647
|
+
*/
|
|
648
|
+
type: string;
|
|
649
|
+
/**
|
|
650
|
+
* @description If creator has verified badge
|
|
651
|
+
* @example true
|
|
652
|
+
*/
|
|
653
|
+
hasVerifiedBadge: boolean;
|
|
654
|
+
};
|
|
655
|
+
/**
|
|
656
|
+
* @description Entry price in Robux if paid access, else null
|
|
657
|
+
* @example null
|
|
658
|
+
*/
|
|
659
|
+
price: number | null;
|
|
660
|
+
/**
|
|
661
|
+
* @description Current active players
|
|
662
|
+
* @example 1644590
|
|
663
|
+
*/
|
|
664
|
+
playing: number;
|
|
665
|
+
/**
|
|
666
|
+
* @description Total visits count
|
|
667
|
+
* @example 6747837069
|
|
668
|
+
*/
|
|
669
|
+
visits: number;
|
|
670
|
+
/**
|
|
671
|
+
* @description Total favorites count
|
|
672
|
+
* @example 6776527
|
|
673
|
+
*/
|
|
674
|
+
favoritedCount: number;
|
|
675
|
+
/**
|
|
676
|
+
* @description Max players per server
|
|
677
|
+
* @example 7
|
|
678
|
+
*/
|
|
679
|
+
maxPlayers: number;
|
|
680
|
+
/**
|
|
681
|
+
* @description Resolved main genre
|
|
682
|
+
* @example Simulação
|
|
683
|
+
*/
|
|
684
|
+
genre: string;
|
|
685
|
+
/**
|
|
686
|
+
* @description Sub-genre if available
|
|
687
|
+
* @example Magnata
|
|
688
|
+
*/
|
|
689
|
+
genreCategory: string | null;
|
|
690
|
+
/**
|
|
691
|
+
* @description Avatar morph type
|
|
692
|
+
* @example MorphToR15
|
|
693
|
+
*/
|
|
694
|
+
universeAvatarType: string;
|
|
695
|
+
/**
|
|
696
|
+
* @description If VIP servers are allowed
|
|
697
|
+
* @example false
|
|
698
|
+
*/
|
|
699
|
+
createVipServersAllowed: boolean;
|
|
700
|
+
/**
|
|
701
|
+
* @description Game creation date
|
|
702
|
+
* @example 2026-07-25T07:50:51.492Z
|
|
703
|
+
*/
|
|
704
|
+
createdAt: string;
|
|
705
|
+
/**
|
|
706
|
+
* @description Game last update date
|
|
707
|
+
* @example 2026-10-04T05:12:03.315Z
|
|
708
|
+
*/
|
|
709
|
+
updatedAt: string;
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
};
|
|
714
|
+
/** @description Bad request */
|
|
715
|
+
400: {
|
|
716
|
+
headers: {
|
|
717
|
+
[name: string]: unknown;
|
|
718
|
+
};
|
|
719
|
+
content: {
|
|
720
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
/** @description Game not found */
|
|
724
|
+
404: {
|
|
725
|
+
headers: {
|
|
726
|
+
[name: string]: unknown;
|
|
727
|
+
};
|
|
728
|
+
content: {
|
|
729
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
/** @description Internal server error */
|
|
733
|
+
500: {
|
|
734
|
+
headers: {
|
|
735
|
+
[name: string]: unknown;
|
|
736
|
+
};
|
|
737
|
+
content: {
|
|
738
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
739
|
+
};
|
|
740
|
+
};
|
|
741
|
+
};
|
|
742
|
+
};
|
|
743
|
+
put?: never;
|
|
744
|
+
post?: never;
|
|
745
|
+
delete?: never;
|
|
746
|
+
options?: never;
|
|
747
|
+
head?: never;
|
|
748
|
+
patch?: never;
|
|
749
|
+
trace?: never;
|
|
750
|
+
};
|
|
751
|
+
"/v1/minecraft/info/{player}": {
|
|
752
|
+
parameters: {
|
|
753
|
+
query?: never;
|
|
754
|
+
header?: never;
|
|
755
|
+
path?: never;
|
|
756
|
+
cookie?: never;
|
|
757
|
+
};
|
|
758
|
+
/**
|
|
759
|
+
* Minecraft player information
|
|
760
|
+
* @description Resolves a Java or Bedrock player. Accepts a Java username, a Java UUID, a Bedrock username, or a Bedrock XUID.
|
|
761
|
+
*/
|
|
762
|
+
get: {
|
|
763
|
+
parameters: {
|
|
764
|
+
query?: never;
|
|
765
|
+
header?: never;
|
|
766
|
+
path: {
|
|
767
|
+
/** @description Java or Bedrock username, Java UUID, Floodgate UUID or XUID */
|
|
768
|
+
player: string;
|
|
769
|
+
};
|
|
770
|
+
cookie?: never;
|
|
771
|
+
};
|
|
772
|
+
requestBody?: never;
|
|
773
|
+
responses: {
|
|
774
|
+
/** @description The player */
|
|
775
|
+
200: {
|
|
776
|
+
headers: {
|
|
777
|
+
[name: string]: unknown;
|
|
778
|
+
};
|
|
779
|
+
content: {
|
|
780
|
+
"application/json": components["schemas"]["MinecraftPlayer"];
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
/** @description Bad request */
|
|
784
|
+
400: {
|
|
785
|
+
headers: {
|
|
786
|
+
[name: string]: unknown;
|
|
787
|
+
};
|
|
788
|
+
content: {
|
|
789
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
790
|
+
};
|
|
791
|
+
};
|
|
792
|
+
/** @description No such player */
|
|
793
|
+
404: {
|
|
794
|
+
headers: {
|
|
795
|
+
[name: string]: unknown;
|
|
796
|
+
};
|
|
797
|
+
content: {
|
|
798
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
/** @description Upstream service failed */
|
|
802
|
+
502: {
|
|
803
|
+
headers: {
|
|
804
|
+
[name: string]: unknown;
|
|
805
|
+
};
|
|
806
|
+
content: {
|
|
807
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
put?: never;
|
|
813
|
+
post?: never;
|
|
814
|
+
delete?: never;
|
|
815
|
+
options?: never;
|
|
816
|
+
head?: never;
|
|
817
|
+
patch?: never;
|
|
818
|
+
trace?: never;
|
|
819
|
+
};
|
|
820
|
+
"/v1/minecraft/textures/{player}": {
|
|
821
|
+
parameters: {
|
|
822
|
+
query?: never;
|
|
823
|
+
header?: never;
|
|
824
|
+
path?: never;
|
|
825
|
+
cookie?: never;
|
|
826
|
+
};
|
|
827
|
+
/**
|
|
828
|
+
* Minecraft player textures
|
|
829
|
+
* @description Resolves a Java or Bedrock player to their skin and cape URLs. Bedrock skins are read through Geyser, which converts them to the Java texture layout.
|
|
830
|
+
*/
|
|
831
|
+
get: {
|
|
832
|
+
parameters: {
|
|
833
|
+
query?: never;
|
|
834
|
+
header?: never;
|
|
835
|
+
path: {
|
|
836
|
+
/** @description Java or Bedrock username, Java UUID, Floodgate UUID or XUID */
|
|
837
|
+
player: string;
|
|
838
|
+
};
|
|
839
|
+
cookie?: never;
|
|
840
|
+
};
|
|
841
|
+
requestBody?: never;
|
|
842
|
+
responses: {
|
|
843
|
+
/** @description The player textures */
|
|
844
|
+
200: {
|
|
845
|
+
headers: {
|
|
846
|
+
[name: string]: unknown;
|
|
847
|
+
};
|
|
848
|
+
content: {
|
|
849
|
+
"application/json": components["schemas"]["MinecraftTextures"];
|
|
850
|
+
};
|
|
851
|
+
};
|
|
852
|
+
/** @description Bad request */
|
|
853
|
+
400: {
|
|
854
|
+
headers: {
|
|
855
|
+
[name: string]: unknown;
|
|
856
|
+
};
|
|
857
|
+
content: {
|
|
858
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
859
|
+
};
|
|
860
|
+
};
|
|
861
|
+
/** @description No such player, or they have no skin stored */
|
|
862
|
+
404: {
|
|
863
|
+
headers: {
|
|
864
|
+
[name: string]: unknown;
|
|
865
|
+
};
|
|
866
|
+
content: {
|
|
867
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
/** @description Upstream service failed */
|
|
871
|
+
502: {
|
|
872
|
+
headers: {
|
|
873
|
+
[name: string]: unknown;
|
|
874
|
+
};
|
|
875
|
+
content: {
|
|
876
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
};
|
|
880
|
+
};
|
|
881
|
+
put?: never;
|
|
882
|
+
post?: never;
|
|
883
|
+
delete?: never;
|
|
884
|
+
options?: never;
|
|
885
|
+
head?: never;
|
|
886
|
+
patch?: never;
|
|
887
|
+
trace?: never;
|
|
888
|
+
};
|
|
889
|
+
"/v1/minecraft/render/{player}": {
|
|
890
|
+
parameters: {
|
|
891
|
+
query?: never;
|
|
892
|
+
header?: never;
|
|
893
|
+
path?: never;
|
|
894
|
+
cookie?: never;
|
|
895
|
+
};
|
|
896
|
+
/**
|
|
897
|
+
* Queue a Minecraft player render
|
|
898
|
+
* @description Queues an mcrender job and answers 202 with the job id straight away. Poll GET /v1/jobs/{id}, or hold on GET /v1/jobs/{id}/wait, to get the rendered PNG. Passing skinUrl skips the player lookup entirely and renders that texture as-is.
|
|
899
|
+
*/
|
|
900
|
+
get: {
|
|
901
|
+
parameters: {
|
|
902
|
+
query?: {
|
|
903
|
+
/** @description Which view to render */
|
|
904
|
+
render?: "head" | "body" | "front" | "wave" | "sit" | "handstand" | "cutesit" | "standing" | "showing_behind";
|
|
905
|
+
/** @description Multiplier on the view resolution */
|
|
906
|
+
scale?: number;
|
|
907
|
+
/** @description Render this skin instead of the player one. Skips the player lookup. */
|
|
908
|
+
skinUrl?: string;
|
|
909
|
+
/** @description Render this cape instead of the player one */
|
|
910
|
+
capeUrl?: string;
|
|
911
|
+
};
|
|
912
|
+
header?: never;
|
|
913
|
+
path: {
|
|
914
|
+
/** @description Java or Bedrock username, Java UUID, Floodgate UUID or XUID */
|
|
915
|
+
player: string;
|
|
916
|
+
};
|
|
917
|
+
cookie?: never;
|
|
918
|
+
};
|
|
919
|
+
requestBody?: never;
|
|
920
|
+
responses: {
|
|
921
|
+
/** @description The job was queued */
|
|
922
|
+
202: {
|
|
923
|
+
headers: {
|
|
924
|
+
[name: string]: unknown;
|
|
925
|
+
};
|
|
926
|
+
content: {
|
|
927
|
+
"application/json": components["schemas"]["MinecraftRender"];
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
/** @description Bad request */
|
|
931
|
+
400: {
|
|
932
|
+
headers: {
|
|
933
|
+
[name: string]: unknown;
|
|
934
|
+
};
|
|
935
|
+
content: {
|
|
936
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
937
|
+
};
|
|
938
|
+
};
|
|
939
|
+
/** @description No such player, or they have no skin stored */
|
|
940
|
+
404: {
|
|
941
|
+
headers: {
|
|
942
|
+
[name: string]: unknown;
|
|
943
|
+
};
|
|
944
|
+
content: {
|
|
945
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
946
|
+
};
|
|
947
|
+
};
|
|
948
|
+
/** @description Upstream service failed */
|
|
949
|
+
502: {
|
|
950
|
+
headers: {
|
|
951
|
+
[name: string]: unknown;
|
|
952
|
+
};
|
|
953
|
+
content: {
|
|
954
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
955
|
+
};
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
};
|
|
959
|
+
put?: never;
|
|
960
|
+
post?: never;
|
|
961
|
+
delete?: never;
|
|
962
|
+
options?: never;
|
|
963
|
+
head?: never;
|
|
964
|
+
patch?: never;
|
|
965
|
+
trace?: never;
|
|
966
|
+
};
|
|
967
|
+
"/v1/holidays/{countryCode}/next": {
|
|
968
|
+
parameters: {
|
|
969
|
+
query?: never;
|
|
970
|
+
header?: never;
|
|
971
|
+
path?: never;
|
|
972
|
+
cookie?: never;
|
|
973
|
+
};
|
|
974
|
+
/** Get the next public holidays for a specific country */
|
|
975
|
+
get: {
|
|
976
|
+
parameters: {
|
|
977
|
+
query?: never;
|
|
978
|
+
header?: never;
|
|
979
|
+
path: {
|
|
980
|
+
/** @description Country code (e.g., 'US' for United States) */
|
|
981
|
+
countryCode: string;
|
|
982
|
+
};
|
|
983
|
+
cookie?: never;
|
|
984
|
+
};
|
|
985
|
+
requestBody?: never;
|
|
986
|
+
responses: {
|
|
987
|
+
/** @description Successful response with the next public holidays */
|
|
988
|
+
200: {
|
|
989
|
+
headers: {
|
|
990
|
+
[name: string]: unknown;
|
|
991
|
+
};
|
|
992
|
+
content: {
|
|
993
|
+
"application/json": {
|
|
994
|
+
success: boolean;
|
|
995
|
+
data: {
|
|
996
|
+
country: {
|
|
997
|
+
/**
|
|
998
|
+
* @description Country name
|
|
999
|
+
* @example United States
|
|
1000
|
+
*/
|
|
1001
|
+
name: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* @description Country code
|
|
1004
|
+
* @example US
|
|
1005
|
+
*/
|
|
1006
|
+
code: string;
|
|
1007
|
+
};
|
|
1008
|
+
nextHolidays: {
|
|
1009
|
+
/**
|
|
1010
|
+
* @description Holiday name
|
|
1011
|
+
* @example Independence Day
|
|
1012
|
+
*/
|
|
1013
|
+
name: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* @description Holiday date in YYYY-MM-DD format
|
|
1016
|
+
* @example 2024-07-04
|
|
1017
|
+
*/
|
|
1018
|
+
date: string;
|
|
1019
|
+
/**
|
|
1020
|
+
* @description Indicates if the holiday is a national holiday
|
|
1021
|
+
* @example true
|
|
1022
|
+
*/
|
|
1023
|
+
national: boolean;
|
|
1024
|
+
/**
|
|
1025
|
+
* @description Types of the holiday
|
|
1026
|
+
* @example [
|
|
1027
|
+
* "Public",
|
|
1028
|
+
* "Observance"
|
|
1029
|
+
* ]
|
|
1030
|
+
*/
|
|
1031
|
+
type: (string | null)[];
|
|
1032
|
+
}[];
|
|
1033
|
+
};
|
|
1034
|
+
requestId?: string;
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
};
|
|
1038
|
+
/** @description Bad request */
|
|
1039
|
+
400: {
|
|
1040
|
+
headers: {
|
|
1041
|
+
[name: string]: unknown;
|
|
1042
|
+
};
|
|
1043
|
+
content: {
|
|
1044
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1045
|
+
};
|
|
1046
|
+
};
|
|
1047
|
+
/** @description Internal server error */
|
|
1048
|
+
500: {
|
|
1049
|
+
headers: {
|
|
1050
|
+
[name: string]: unknown;
|
|
1051
|
+
};
|
|
1052
|
+
content: {
|
|
1053
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1054
|
+
};
|
|
1055
|
+
};
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
put?: never;
|
|
1059
|
+
post?: never;
|
|
1060
|
+
delete?: never;
|
|
1061
|
+
options?: never;
|
|
1062
|
+
head?: never;
|
|
1063
|
+
patch?: never;
|
|
1064
|
+
trace?: never;
|
|
1065
|
+
};
|
|
1066
|
+
"/v1/holidays/{countryCode}/{year}": {
|
|
1067
|
+
parameters: {
|
|
1068
|
+
query?: never;
|
|
1069
|
+
header?: never;
|
|
1070
|
+
path?: never;
|
|
1071
|
+
cookie?: never;
|
|
1072
|
+
};
|
|
1073
|
+
/** Get public holidays for a specific country and year */
|
|
1074
|
+
get: {
|
|
1075
|
+
parameters: {
|
|
1076
|
+
query?: never;
|
|
1077
|
+
header?: never;
|
|
1078
|
+
path: {
|
|
1079
|
+
/** @description Country code (e.g., 'US' for United States) */
|
|
1080
|
+
countryCode: string;
|
|
1081
|
+
/** @description Year for which to retrieve holidays */
|
|
1082
|
+
year: number | null;
|
|
1083
|
+
};
|
|
1084
|
+
cookie?: never;
|
|
1085
|
+
};
|
|
1086
|
+
requestBody?: never;
|
|
1087
|
+
responses: {
|
|
1088
|
+
/** @description Successful response with public holidays for the specified country and year */
|
|
1089
|
+
200: {
|
|
1090
|
+
headers: {
|
|
1091
|
+
[name: string]: unknown;
|
|
1092
|
+
};
|
|
1093
|
+
content: {
|
|
1094
|
+
"application/json": {
|
|
1095
|
+
success: boolean;
|
|
1096
|
+
data: {
|
|
1097
|
+
/**
|
|
1098
|
+
* @description Year
|
|
1099
|
+
* @example 2024
|
|
1100
|
+
*/
|
|
1101
|
+
year: number;
|
|
1102
|
+
country: {
|
|
1103
|
+
/**
|
|
1104
|
+
* @description Country name
|
|
1105
|
+
* @example United States
|
|
1106
|
+
*/
|
|
1107
|
+
name: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* @description Country code
|
|
1110
|
+
* @example US
|
|
1111
|
+
*/
|
|
1112
|
+
code: string;
|
|
1113
|
+
};
|
|
1114
|
+
holidays: {
|
|
1115
|
+
/**
|
|
1116
|
+
* @description Holiday name
|
|
1117
|
+
* @example Independence Day
|
|
1118
|
+
*/
|
|
1119
|
+
name: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* @description Holiday date in YYYY-MM-DD format
|
|
1122
|
+
* @example 2024-07-04
|
|
1123
|
+
*/
|
|
1124
|
+
date: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* @description Indicates if the holiday is a national holiday
|
|
1127
|
+
* @example true
|
|
1128
|
+
*/
|
|
1129
|
+
national: boolean;
|
|
1130
|
+
/**
|
|
1131
|
+
* @description Types of the holiday
|
|
1132
|
+
* @example [
|
|
1133
|
+
* "Public",
|
|
1134
|
+
* "Observance"
|
|
1135
|
+
* ]
|
|
1136
|
+
*/
|
|
1137
|
+
type: (string | null)[];
|
|
1138
|
+
}[];
|
|
1139
|
+
};
|
|
1140
|
+
requestId?: string;
|
|
1141
|
+
};
|
|
1142
|
+
};
|
|
1143
|
+
};
|
|
1144
|
+
/** @description Bad request */
|
|
1145
|
+
400: {
|
|
1146
|
+
headers: {
|
|
1147
|
+
[name: string]: unknown;
|
|
1148
|
+
};
|
|
1149
|
+
content: {
|
|
1150
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
/** @description Internal server error */
|
|
1154
|
+
500: {
|
|
1155
|
+
headers: {
|
|
1156
|
+
[name: string]: unknown;
|
|
1157
|
+
};
|
|
1158
|
+
content: {
|
|
1159
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1160
|
+
};
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
put?: never;
|
|
1165
|
+
post?: never;
|
|
1166
|
+
delete?: never;
|
|
1167
|
+
options?: never;
|
|
1168
|
+
head?: never;
|
|
1169
|
+
patch?: never;
|
|
1170
|
+
trace?: never;
|
|
1171
|
+
};
|
|
1172
|
+
"/v1/bible/languages": {
|
|
1173
|
+
parameters: {
|
|
1174
|
+
query?: never;
|
|
1175
|
+
header?: never;
|
|
1176
|
+
path?: never;
|
|
1177
|
+
cookie?: never;
|
|
1178
|
+
};
|
|
1179
|
+
/** List available source languages */
|
|
1180
|
+
get: {
|
|
1181
|
+
parameters: {
|
|
1182
|
+
query?: never;
|
|
1183
|
+
header?: never;
|
|
1184
|
+
path?: never;
|
|
1185
|
+
cookie?: never;
|
|
1186
|
+
};
|
|
1187
|
+
requestBody?: never;
|
|
1188
|
+
responses: {
|
|
1189
|
+
/** @description OK */
|
|
1190
|
+
200: {
|
|
1191
|
+
headers: {
|
|
1192
|
+
[name: string]: unknown;
|
|
1193
|
+
};
|
|
1194
|
+
content: {
|
|
1195
|
+
"application/json": {
|
|
1196
|
+
data: string[];
|
|
1197
|
+
};
|
|
1198
|
+
};
|
|
1199
|
+
};
|
|
1200
|
+
/** @description Not found */
|
|
1201
|
+
404: {
|
|
1202
|
+
headers: {
|
|
1203
|
+
[name: string]: unknown;
|
|
1204
|
+
};
|
|
1205
|
+
content: {
|
|
1206
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1207
|
+
};
|
|
1208
|
+
};
|
|
1209
|
+
/** @description Source unavailable */
|
|
1210
|
+
503: {
|
|
1211
|
+
headers: {
|
|
1212
|
+
[name: string]: unknown;
|
|
1213
|
+
};
|
|
1214
|
+
content: {
|
|
1215
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1216
|
+
};
|
|
1217
|
+
};
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
put?: never;
|
|
1221
|
+
post?: never;
|
|
1222
|
+
delete?: never;
|
|
1223
|
+
options?: never;
|
|
1224
|
+
head?: never;
|
|
1225
|
+
patch?: never;
|
|
1226
|
+
trace?: never;
|
|
1227
|
+
};
|
|
1228
|
+
"/v1/bible/languages/{language}/types": {
|
|
1229
|
+
parameters: {
|
|
1230
|
+
query?: never;
|
|
1231
|
+
header?: never;
|
|
1232
|
+
path?: never;
|
|
1233
|
+
cookie?: never;
|
|
1234
|
+
};
|
|
1235
|
+
/** List available types for a language */
|
|
1236
|
+
get: {
|
|
1237
|
+
parameters: {
|
|
1238
|
+
query?: never;
|
|
1239
|
+
header?: never;
|
|
1240
|
+
path: {
|
|
1241
|
+
language: string;
|
|
1242
|
+
};
|
|
1243
|
+
cookie?: never;
|
|
1244
|
+
};
|
|
1245
|
+
requestBody?: never;
|
|
1246
|
+
responses: {
|
|
1247
|
+
/** @description OK */
|
|
1248
|
+
200: {
|
|
1249
|
+
headers: {
|
|
1250
|
+
[name: string]: unknown;
|
|
1251
|
+
};
|
|
1252
|
+
content: {
|
|
1253
|
+
"application/json": {
|
|
1254
|
+
data: string[];
|
|
1255
|
+
};
|
|
1256
|
+
};
|
|
1257
|
+
};
|
|
1258
|
+
/** @description Not found */
|
|
1259
|
+
404: {
|
|
1260
|
+
headers: {
|
|
1261
|
+
[name: string]: unknown;
|
|
1262
|
+
};
|
|
1263
|
+
content: {
|
|
1264
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1265
|
+
};
|
|
1266
|
+
};
|
|
1267
|
+
/** @description Source unavailable */
|
|
1268
|
+
503: {
|
|
1269
|
+
headers: {
|
|
1270
|
+
[name: string]: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
content: {
|
|
1273
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
put?: never;
|
|
1279
|
+
post?: never;
|
|
1280
|
+
delete?: never;
|
|
1281
|
+
options?: never;
|
|
1282
|
+
head?: never;
|
|
1283
|
+
patch?: never;
|
|
1284
|
+
trace?: never;
|
|
1285
|
+
};
|
|
1286
|
+
"/v1/bible/translations": {
|
|
1287
|
+
parameters: {
|
|
1288
|
+
query?: never;
|
|
1289
|
+
header?: never;
|
|
1290
|
+
path?: never;
|
|
1291
|
+
cookie?: never;
|
|
1292
|
+
};
|
|
1293
|
+
/** List known translations */
|
|
1294
|
+
get: {
|
|
1295
|
+
parameters: {
|
|
1296
|
+
query?: never;
|
|
1297
|
+
header?: never;
|
|
1298
|
+
path?: never;
|
|
1299
|
+
cookie?: never;
|
|
1300
|
+
};
|
|
1301
|
+
requestBody?: never;
|
|
1302
|
+
responses: {
|
|
1303
|
+
/** @description OK */
|
|
1304
|
+
200: {
|
|
1305
|
+
headers: {
|
|
1306
|
+
[name: string]: unknown;
|
|
1307
|
+
};
|
|
1308
|
+
content: {
|
|
1309
|
+
"application/json": {
|
|
1310
|
+
data: components["schemas"]["Translation"][];
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
};
|
|
1314
|
+
};
|
|
1315
|
+
};
|
|
1316
|
+
put?: never;
|
|
1317
|
+
post?: never;
|
|
1318
|
+
delete?: never;
|
|
1319
|
+
options?: never;
|
|
1320
|
+
head?: never;
|
|
1321
|
+
patch?: never;
|
|
1322
|
+
trace?: never;
|
|
1323
|
+
};
|
|
1324
|
+
"/v1/bible/{translation}/books": {
|
|
1325
|
+
parameters: {
|
|
1326
|
+
query?: never;
|
|
1327
|
+
header?: never;
|
|
1328
|
+
path?: never;
|
|
1329
|
+
cookie?: never;
|
|
1330
|
+
};
|
|
1331
|
+
/** List books of a translation */
|
|
1332
|
+
get: {
|
|
1333
|
+
parameters: {
|
|
1334
|
+
query?: never;
|
|
1335
|
+
header?: never;
|
|
1336
|
+
path: {
|
|
1337
|
+
/** @description Translation code (e.g. "BBE") or "language_code" (e.g. "en_bbe") */
|
|
1338
|
+
translation: string;
|
|
1339
|
+
};
|
|
1340
|
+
cookie?: never;
|
|
1341
|
+
};
|
|
1342
|
+
requestBody?: never;
|
|
1343
|
+
responses: {
|
|
1344
|
+
/** @description OK */
|
|
1345
|
+
200: {
|
|
1346
|
+
headers: {
|
|
1347
|
+
[name: string]: unknown;
|
|
1348
|
+
};
|
|
1349
|
+
content: {
|
|
1350
|
+
"application/json": {
|
|
1351
|
+
data: components["schemas"]["BookSummary"][];
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1355
|
+
/** @description Translation not found */
|
|
1356
|
+
404: {
|
|
1357
|
+
headers: {
|
|
1358
|
+
[name: string]: unknown;
|
|
1359
|
+
};
|
|
1360
|
+
content: {
|
|
1361
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1362
|
+
};
|
|
1363
|
+
};
|
|
1364
|
+
/** @description Source unavailable */
|
|
1365
|
+
503: {
|
|
1366
|
+
headers: {
|
|
1367
|
+
[name: string]: unknown;
|
|
1368
|
+
};
|
|
1369
|
+
content: {
|
|
1370
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1371
|
+
};
|
|
1372
|
+
};
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
put?: never;
|
|
1376
|
+
post?: never;
|
|
1377
|
+
delete?: never;
|
|
1378
|
+
options?: never;
|
|
1379
|
+
head?: never;
|
|
1380
|
+
patch?: never;
|
|
1381
|
+
trace?: never;
|
|
1382
|
+
};
|
|
1383
|
+
"/v1/bible/{translation}/books/{book}/chapters/{chapter}": {
|
|
1384
|
+
parameters: {
|
|
1385
|
+
query?: never;
|
|
1386
|
+
header?: never;
|
|
1387
|
+
path?: never;
|
|
1388
|
+
cookie?: never;
|
|
1389
|
+
};
|
|
1390
|
+
/** Get all verses of a chapter */
|
|
1391
|
+
get: {
|
|
1392
|
+
parameters: {
|
|
1393
|
+
query?: never;
|
|
1394
|
+
header?: never;
|
|
1395
|
+
path: {
|
|
1396
|
+
/** @description Translation code (e.g. "BBE") or "language_code" (e.g. "en_bbe") */
|
|
1397
|
+
translation: string;
|
|
1398
|
+
book: string;
|
|
1399
|
+
chapter: number;
|
|
1400
|
+
};
|
|
1401
|
+
cookie?: never;
|
|
1402
|
+
};
|
|
1403
|
+
requestBody?: never;
|
|
1404
|
+
responses: {
|
|
1405
|
+
/** @description OK */
|
|
1406
|
+
200: {
|
|
1407
|
+
headers: {
|
|
1408
|
+
[name: string]: unknown;
|
|
1409
|
+
};
|
|
1410
|
+
content: {
|
|
1411
|
+
"application/json": {
|
|
1412
|
+
data: components["schemas"]["Verse"][];
|
|
1413
|
+
};
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1416
|
+
/** @description Not found */
|
|
1417
|
+
404: {
|
|
1418
|
+
headers: {
|
|
1419
|
+
[name: string]: unknown;
|
|
1420
|
+
};
|
|
1421
|
+
content: {
|
|
1422
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1423
|
+
};
|
|
1424
|
+
};
|
|
1425
|
+
/** @description Source unavailable */
|
|
1426
|
+
503: {
|
|
1427
|
+
headers: {
|
|
1428
|
+
[name: string]: unknown;
|
|
1429
|
+
};
|
|
1430
|
+
content: {
|
|
1431
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
put?: never;
|
|
1437
|
+
post?: never;
|
|
1438
|
+
delete?: never;
|
|
1439
|
+
options?: never;
|
|
1440
|
+
head?: never;
|
|
1441
|
+
patch?: never;
|
|
1442
|
+
trace?: never;
|
|
1443
|
+
};
|
|
1444
|
+
"/v1/bible/{translation}/search": {
|
|
1445
|
+
parameters: {
|
|
1446
|
+
query?: never;
|
|
1447
|
+
header?: never;
|
|
1448
|
+
path?: never;
|
|
1449
|
+
cookie?: never;
|
|
1450
|
+
};
|
|
1451
|
+
/** Search verses containing a query */
|
|
1452
|
+
get: {
|
|
1453
|
+
parameters: {
|
|
1454
|
+
query: {
|
|
1455
|
+
q: string;
|
|
1456
|
+
};
|
|
1457
|
+
header?: never;
|
|
1458
|
+
path: {
|
|
1459
|
+
/** @description Translation code (e.g. "BBE") or "language_code" (e.g. "en_bbe") */
|
|
1460
|
+
translation: string;
|
|
1461
|
+
};
|
|
1462
|
+
cookie?: never;
|
|
1463
|
+
};
|
|
1464
|
+
requestBody?: never;
|
|
1465
|
+
responses: {
|
|
1466
|
+
/** @description OK */
|
|
1467
|
+
200: {
|
|
1468
|
+
headers: {
|
|
1469
|
+
[name: string]: unknown;
|
|
1470
|
+
};
|
|
1471
|
+
content: {
|
|
1472
|
+
"application/json": {
|
|
1473
|
+
data: components["schemas"]["SearchResult"][];
|
|
1474
|
+
};
|
|
1475
|
+
};
|
|
1476
|
+
};
|
|
1477
|
+
/** @description Translation not found */
|
|
1478
|
+
404: {
|
|
1479
|
+
headers: {
|
|
1480
|
+
[name: string]: unknown;
|
|
1481
|
+
};
|
|
1482
|
+
content: {
|
|
1483
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1484
|
+
};
|
|
1485
|
+
};
|
|
1486
|
+
/** @description Source unavailable */
|
|
1487
|
+
503: {
|
|
1488
|
+
headers: {
|
|
1489
|
+
[name: string]: unknown;
|
|
1490
|
+
};
|
|
1491
|
+
content: {
|
|
1492
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1493
|
+
};
|
|
1494
|
+
};
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
put?: never;
|
|
1498
|
+
post?: never;
|
|
1499
|
+
delete?: never;
|
|
1500
|
+
options?: never;
|
|
1501
|
+
head?: never;
|
|
1502
|
+
patch?: never;
|
|
1503
|
+
trace?: never;
|
|
1504
|
+
};
|
|
1505
|
+
"/v1/bible/{translation}/verses": {
|
|
1506
|
+
parameters: {
|
|
1507
|
+
query?: never;
|
|
1508
|
+
header?: never;
|
|
1509
|
+
path?: never;
|
|
1510
|
+
cookie?: never;
|
|
1511
|
+
};
|
|
1512
|
+
/** Get specific verses by reference */
|
|
1513
|
+
get: {
|
|
1514
|
+
parameters: {
|
|
1515
|
+
query: {
|
|
1516
|
+
/** @description Comma-separated "Book chapter:verse" references */
|
|
1517
|
+
refs: string;
|
|
1518
|
+
};
|
|
1519
|
+
header?: never;
|
|
1520
|
+
path: {
|
|
1521
|
+
/** @description Translation code (e.g. "BBE") or "language_code" (e.g. "en_bbe") */
|
|
1522
|
+
translation: string;
|
|
1523
|
+
};
|
|
1524
|
+
cookie?: never;
|
|
1525
|
+
};
|
|
1526
|
+
requestBody?: never;
|
|
1527
|
+
responses: {
|
|
1528
|
+
/** @description OK */
|
|
1529
|
+
200: {
|
|
1530
|
+
headers: {
|
|
1531
|
+
[name: string]: unknown;
|
|
1532
|
+
};
|
|
1533
|
+
content: {
|
|
1534
|
+
"application/json": {
|
|
1535
|
+
data: components["schemas"]["VerseResult"][];
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
1538
|
+
};
|
|
1539
|
+
/** @description Translation not found */
|
|
1540
|
+
404: {
|
|
1541
|
+
headers: {
|
|
1542
|
+
[name: string]: unknown;
|
|
1543
|
+
};
|
|
1544
|
+
content: {
|
|
1545
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1546
|
+
};
|
|
1547
|
+
};
|
|
1548
|
+
/** @description Source unavailable */
|
|
1549
|
+
503: {
|
|
1550
|
+
headers: {
|
|
1551
|
+
[name: string]: unknown;
|
|
1552
|
+
};
|
|
1553
|
+
content: {
|
|
1554
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
put?: never;
|
|
1560
|
+
post?: never;
|
|
1561
|
+
delete?: never;
|
|
1562
|
+
options?: never;
|
|
1563
|
+
head?: never;
|
|
1564
|
+
patch?: never;
|
|
1565
|
+
trace?: never;
|
|
1566
|
+
};
|
|
1567
|
+
"/v1/bible/data/{language}/{type}": {
|
|
1568
|
+
parameters: {
|
|
1569
|
+
query?: never;
|
|
1570
|
+
header?: never;
|
|
1571
|
+
path?: never;
|
|
1572
|
+
cookie?: never;
|
|
1573
|
+
};
|
|
1574
|
+
/** Get a summary of a raw source file */
|
|
1575
|
+
get: {
|
|
1576
|
+
parameters: {
|
|
1577
|
+
query?: never;
|
|
1578
|
+
header?: never;
|
|
1579
|
+
path: {
|
|
1580
|
+
language: string;
|
|
1581
|
+
type: string;
|
|
1582
|
+
};
|
|
1583
|
+
cookie?: never;
|
|
1584
|
+
};
|
|
1585
|
+
requestBody?: never;
|
|
1586
|
+
responses: {
|
|
1587
|
+
/** @description OK */
|
|
1588
|
+
200: {
|
|
1589
|
+
headers: {
|
|
1590
|
+
[name: string]: unknown;
|
|
1591
|
+
};
|
|
1592
|
+
content: {
|
|
1593
|
+
"application/json": {
|
|
1594
|
+
data: components["schemas"]["BibleDataSummary"];
|
|
1595
|
+
};
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
/** @description Not found */
|
|
1599
|
+
404: {
|
|
1600
|
+
headers: {
|
|
1601
|
+
[name: string]: unknown;
|
|
1602
|
+
};
|
|
1603
|
+
content: {
|
|
1604
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1605
|
+
};
|
|
1606
|
+
};
|
|
1607
|
+
/** @description Source unavailable */
|
|
1608
|
+
503: {
|
|
1609
|
+
headers: {
|
|
1610
|
+
[name: string]: unknown;
|
|
1611
|
+
};
|
|
1612
|
+
content: {
|
|
1613
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1614
|
+
};
|
|
1615
|
+
};
|
|
1616
|
+
};
|
|
1617
|
+
};
|
|
1618
|
+
put?: never;
|
|
1619
|
+
post?: never;
|
|
1620
|
+
delete?: never;
|
|
1621
|
+
options?: never;
|
|
1622
|
+
head?: never;
|
|
1623
|
+
patch?: never;
|
|
1624
|
+
trace?: never;
|
|
1625
|
+
};
|
|
1626
|
+
"/v1/jobs/{id}": {
|
|
1627
|
+
parameters: {
|
|
1628
|
+
query?: never;
|
|
1629
|
+
header?: never;
|
|
1630
|
+
path?: never;
|
|
1631
|
+
cookie?: never;
|
|
1632
|
+
};
|
|
1633
|
+
/**
|
|
1634
|
+
* Job status
|
|
1635
|
+
* @description Status of a queued job. Polled by whoever submitted it.
|
|
1636
|
+
*/
|
|
1637
|
+
get: {
|
|
1638
|
+
parameters: {
|
|
1639
|
+
query?: never;
|
|
1640
|
+
header?: never;
|
|
1641
|
+
path: {
|
|
1642
|
+
id: string;
|
|
1643
|
+
};
|
|
1644
|
+
cookie?: never;
|
|
1645
|
+
};
|
|
1646
|
+
requestBody?: never;
|
|
1647
|
+
responses: {
|
|
1648
|
+
/** @description The job. */
|
|
1649
|
+
200: {
|
|
1650
|
+
headers: {
|
|
1651
|
+
[name: string]: unknown;
|
|
1652
|
+
};
|
|
1653
|
+
content: {
|
|
1654
|
+
"application/json": components["schemas"]["JobResponse"];
|
|
1655
|
+
};
|
|
1656
|
+
};
|
|
1657
|
+
/** @description No job with that id, or it already expired. */
|
|
1658
|
+
404: {
|
|
1659
|
+
headers: {
|
|
1660
|
+
[name: string]: unknown;
|
|
1661
|
+
};
|
|
1662
|
+
content: {
|
|
1663
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
};
|
|
1667
|
+
};
|
|
1668
|
+
put?: never;
|
|
1669
|
+
post?: never;
|
|
1670
|
+
delete?: never;
|
|
1671
|
+
options?: never;
|
|
1672
|
+
head?: never;
|
|
1673
|
+
patch?: never;
|
|
1674
|
+
trace?: never;
|
|
1675
|
+
};
|
|
1676
|
+
"/v1/jobs/{id}/wait": {
|
|
1677
|
+
parameters: {
|
|
1678
|
+
query?: never;
|
|
1679
|
+
header?: never;
|
|
1680
|
+
path?: never;
|
|
1681
|
+
cookie?: never;
|
|
1682
|
+
};
|
|
1683
|
+
/**
|
|
1684
|
+
* Wait for a job to finish
|
|
1685
|
+
* @description Holds the request open until the job reaches a final state, so a caller does not have to poll.
|
|
1686
|
+
*/
|
|
1687
|
+
get: {
|
|
1688
|
+
parameters: {
|
|
1689
|
+
query?: {
|
|
1690
|
+
/** @description Seconds to hold the request open for. */
|
|
1691
|
+
timeout?: number;
|
|
1692
|
+
};
|
|
1693
|
+
header?: never;
|
|
1694
|
+
path: {
|
|
1695
|
+
id: string;
|
|
1696
|
+
};
|
|
1697
|
+
cookie?: never;
|
|
1698
|
+
};
|
|
1699
|
+
requestBody?: never;
|
|
1700
|
+
responses: {
|
|
1701
|
+
/** @description The job, once it has completed or failed. */
|
|
1702
|
+
200: {
|
|
1703
|
+
headers: {
|
|
1704
|
+
[name: string]: unknown;
|
|
1705
|
+
};
|
|
1706
|
+
content: {
|
|
1707
|
+
"application/json": components["schemas"]["JobResponse"];
|
|
1708
|
+
};
|
|
1709
|
+
};
|
|
1710
|
+
/** @description No job with that id, or it already expired. */
|
|
1711
|
+
404: {
|
|
1712
|
+
headers: {
|
|
1713
|
+
[name: string]: unknown;
|
|
1714
|
+
};
|
|
1715
|
+
content: {
|
|
1716
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1717
|
+
};
|
|
1718
|
+
};
|
|
1719
|
+
/** @description Still running when the timeout ran out. Poll again for the rest. */
|
|
1720
|
+
504: {
|
|
1721
|
+
headers: {
|
|
1722
|
+
[name: string]: unknown;
|
|
1723
|
+
};
|
|
1724
|
+
content: {
|
|
1725
|
+
"application/json": components["schemas"]["JobResponse"];
|
|
1726
|
+
};
|
|
1727
|
+
};
|
|
1728
|
+
};
|
|
1729
|
+
};
|
|
1730
|
+
put?: never;
|
|
1731
|
+
post?: never;
|
|
1732
|
+
delete?: never;
|
|
1733
|
+
options?: never;
|
|
1734
|
+
head?: never;
|
|
1735
|
+
patch?: never;
|
|
1736
|
+
trace?: never;
|
|
1737
|
+
};
|
|
1738
|
+
"/v1/music/guilds/{guildId}/play": {
|
|
1739
|
+
parameters: {
|
|
1740
|
+
query?: never;
|
|
1741
|
+
header?: never;
|
|
1742
|
+
path?: never;
|
|
1743
|
+
cookie?: never;
|
|
1744
|
+
};
|
|
1745
|
+
get?: never;
|
|
1746
|
+
put?: never;
|
|
1747
|
+
/**
|
|
1748
|
+
* Play or queue a track
|
|
1749
|
+
* @description Plays what `query` finds, or exactly the track that `track` names, which is what a search hands back. Either way it goes behind whatever is already playing. The bot joins `channelId` if it is not already in a call in this guild.
|
|
1750
|
+
*/
|
|
1751
|
+
post: {
|
|
1752
|
+
parameters: {
|
|
1753
|
+
query?: never;
|
|
1754
|
+
header?: never;
|
|
1755
|
+
path: {
|
|
1756
|
+
guildId: string;
|
|
1757
|
+
};
|
|
1758
|
+
cookie?: never;
|
|
1759
|
+
};
|
|
1760
|
+
requestBody: {
|
|
1761
|
+
content: {
|
|
1762
|
+
"application/json": ({
|
|
1763
|
+
/** @example lofi hip hop */
|
|
1764
|
+
query: string;
|
|
1765
|
+
} | {
|
|
1766
|
+
track: components["schemas"]["TrackRef"];
|
|
1767
|
+
}) & {
|
|
1768
|
+
/** @description Voice channel to join. Required when the bot is not in one yet. */
|
|
1769
|
+
channelId?: string;
|
|
1770
|
+
};
|
|
1771
|
+
};
|
|
1772
|
+
};
|
|
1773
|
+
responses: {
|
|
1774
|
+
/** @description The track that started or was queued. */
|
|
1775
|
+
200: {
|
|
1776
|
+
headers: {
|
|
1777
|
+
[name: string]: unknown;
|
|
1778
|
+
};
|
|
1779
|
+
content: {
|
|
1780
|
+
"application/json": {
|
|
1781
|
+
data: components["schemas"]["PlayResult"];
|
|
1782
|
+
};
|
|
1783
|
+
};
|
|
1784
|
+
};
|
|
1785
|
+
/** @description The API key is not linked to a bot. */
|
|
1786
|
+
403: {
|
|
1787
|
+
headers: {
|
|
1788
|
+
[name: string]: unknown;
|
|
1789
|
+
};
|
|
1790
|
+
content: {
|
|
1791
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1792
|
+
};
|
|
1793
|
+
};
|
|
1794
|
+
/** @description No player in that guild. */
|
|
1795
|
+
404: {
|
|
1796
|
+
headers: {
|
|
1797
|
+
[name: string]: unknown;
|
|
1798
|
+
};
|
|
1799
|
+
content: {
|
|
1800
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1801
|
+
};
|
|
1802
|
+
};
|
|
1803
|
+
/** @description Conflicts with the current player state. */
|
|
1804
|
+
409: {
|
|
1805
|
+
headers: {
|
|
1806
|
+
[name: string]: unknown;
|
|
1807
|
+
};
|
|
1808
|
+
content: {
|
|
1809
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1810
|
+
};
|
|
1811
|
+
};
|
|
1812
|
+
/** @description The request cannot be carried out as given. */
|
|
1813
|
+
422: {
|
|
1814
|
+
headers: {
|
|
1815
|
+
[name: string]: unknown;
|
|
1816
|
+
};
|
|
1817
|
+
content: {
|
|
1818
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1819
|
+
};
|
|
1820
|
+
};
|
|
1821
|
+
/** @description The music workers are unavailable or timed out. */
|
|
1822
|
+
503: {
|
|
1823
|
+
headers: {
|
|
1824
|
+
[name: string]: unknown;
|
|
1825
|
+
};
|
|
1826
|
+
content: {
|
|
1827
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1828
|
+
};
|
|
1829
|
+
};
|
|
1830
|
+
};
|
|
1831
|
+
};
|
|
1832
|
+
delete?: never;
|
|
1833
|
+
options?: never;
|
|
1834
|
+
head?: never;
|
|
1835
|
+
patch?: never;
|
|
1836
|
+
trace?: never;
|
|
1837
|
+
};
|
|
1838
|
+
"/v1/music/guilds/{guildId}/pause": {
|
|
1839
|
+
parameters: {
|
|
1840
|
+
query?: never;
|
|
1841
|
+
header?: never;
|
|
1842
|
+
path?: never;
|
|
1843
|
+
cookie?: never;
|
|
1844
|
+
};
|
|
1845
|
+
get?: never;
|
|
1846
|
+
put?: never;
|
|
1847
|
+
/** Pause */
|
|
1848
|
+
post: {
|
|
1849
|
+
parameters: {
|
|
1850
|
+
query?: never;
|
|
1851
|
+
header?: never;
|
|
1852
|
+
path: {
|
|
1853
|
+
guildId: string;
|
|
1854
|
+
};
|
|
1855
|
+
cookie?: never;
|
|
1856
|
+
};
|
|
1857
|
+
requestBody?: never;
|
|
1858
|
+
responses: {
|
|
1859
|
+
/** @description Paused. */
|
|
1860
|
+
200: {
|
|
1861
|
+
headers: {
|
|
1862
|
+
[name: string]: unknown;
|
|
1863
|
+
};
|
|
1864
|
+
content: {
|
|
1865
|
+
"application/json": {
|
|
1866
|
+
data: components["schemas"]["PausedResult"];
|
|
1867
|
+
};
|
|
1868
|
+
};
|
|
1869
|
+
};
|
|
1870
|
+
/** @description The API key is not linked to a bot. */
|
|
1871
|
+
403: {
|
|
1872
|
+
headers: {
|
|
1873
|
+
[name: string]: unknown;
|
|
1874
|
+
};
|
|
1875
|
+
content: {
|
|
1876
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1877
|
+
};
|
|
1878
|
+
};
|
|
1879
|
+
/** @description No player in that guild. */
|
|
1880
|
+
404: {
|
|
1881
|
+
headers: {
|
|
1882
|
+
[name: string]: unknown;
|
|
1883
|
+
};
|
|
1884
|
+
content: {
|
|
1885
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1886
|
+
};
|
|
1887
|
+
};
|
|
1888
|
+
/** @description Conflicts with the current player state. */
|
|
1889
|
+
409: {
|
|
1890
|
+
headers: {
|
|
1891
|
+
[name: string]: unknown;
|
|
1892
|
+
};
|
|
1893
|
+
content: {
|
|
1894
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
/** @description The request cannot be carried out as given. */
|
|
1898
|
+
422: {
|
|
1899
|
+
headers: {
|
|
1900
|
+
[name: string]: unknown;
|
|
1901
|
+
};
|
|
1902
|
+
content: {
|
|
1903
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1904
|
+
};
|
|
1905
|
+
};
|
|
1906
|
+
/** @description The music workers are unavailable or timed out. */
|
|
1907
|
+
503: {
|
|
1908
|
+
headers: {
|
|
1909
|
+
[name: string]: unknown;
|
|
1910
|
+
};
|
|
1911
|
+
content: {
|
|
1912
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1913
|
+
};
|
|
1914
|
+
};
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
delete?: never;
|
|
1918
|
+
options?: never;
|
|
1919
|
+
head?: never;
|
|
1920
|
+
patch?: never;
|
|
1921
|
+
trace?: never;
|
|
1922
|
+
};
|
|
1923
|
+
"/v1/music/guilds/{guildId}/resume": {
|
|
1924
|
+
parameters: {
|
|
1925
|
+
query?: never;
|
|
1926
|
+
header?: never;
|
|
1927
|
+
path?: never;
|
|
1928
|
+
cookie?: never;
|
|
1929
|
+
};
|
|
1930
|
+
get?: never;
|
|
1931
|
+
put?: never;
|
|
1932
|
+
/** Resume */
|
|
1933
|
+
post: {
|
|
1934
|
+
parameters: {
|
|
1935
|
+
query?: never;
|
|
1936
|
+
header?: never;
|
|
1937
|
+
path: {
|
|
1938
|
+
guildId: string;
|
|
1939
|
+
};
|
|
1940
|
+
cookie?: never;
|
|
1941
|
+
};
|
|
1942
|
+
requestBody?: never;
|
|
1943
|
+
responses: {
|
|
1944
|
+
/** @description Resumed. */
|
|
1945
|
+
200: {
|
|
1946
|
+
headers: {
|
|
1947
|
+
[name: string]: unknown;
|
|
1948
|
+
};
|
|
1949
|
+
content: {
|
|
1950
|
+
"application/json": {
|
|
1951
|
+
data: components["schemas"]["PausedResult"];
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
};
|
|
1955
|
+
/** @description The API key is not linked to a bot. */
|
|
1956
|
+
403: {
|
|
1957
|
+
headers: {
|
|
1958
|
+
[name: string]: unknown;
|
|
1959
|
+
};
|
|
1960
|
+
content: {
|
|
1961
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1962
|
+
};
|
|
1963
|
+
};
|
|
1964
|
+
/** @description No player in that guild. */
|
|
1965
|
+
404: {
|
|
1966
|
+
headers: {
|
|
1967
|
+
[name: string]: unknown;
|
|
1968
|
+
};
|
|
1969
|
+
content: {
|
|
1970
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1971
|
+
};
|
|
1972
|
+
};
|
|
1973
|
+
/** @description Conflicts with the current player state. */
|
|
1974
|
+
409: {
|
|
1975
|
+
headers: {
|
|
1976
|
+
[name: string]: unknown;
|
|
1977
|
+
};
|
|
1978
|
+
content: {
|
|
1979
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
1982
|
+
/** @description The request cannot be carried out as given. */
|
|
1983
|
+
422: {
|
|
1984
|
+
headers: {
|
|
1985
|
+
[name: string]: unknown;
|
|
1986
|
+
};
|
|
1987
|
+
content: {
|
|
1988
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1991
|
+
/** @description The music workers are unavailable or timed out. */
|
|
1992
|
+
503: {
|
|
1993
|
+
headers: {
|
|
1994
|
+
[name: string]: unknown;
|
|
1995
|
+
};
|
|
1996
|
+
content: {
|
|
1997
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1998
|
+
};
|
|
1999
|
+
};
|
|
2000
|
+
};
|
|
2001
|
+
};
|
|
2002
|
+
delete?: never;
|
|
2003
|
+
options?: never;
|
|
2004
|
+
head?: never;
|
|
2005
|
+
patch?: never;
|
|
2006
|
+
trace?: never;
|
|
2007
|
+
};
|
|
2008
|
+
"/v1/music/guilds/{guildId}/skip": {
|
|
2009
|
+
parameters: {
|
|
2010
|
+
query?: never;
|
|
2011
|
+
header?: never;
|
|
2012
|
+
path?: never;
|
|
2013
|
+
cookie?: never;
|
|
2014
|
+
};
|
|
2015
|
+
get?: never;
|
|
2016
|
+
put?: never;
|
|
2017
|
+
/**
|
|
2018
|
+
* Skip to the next track
|
|
2019
|
+
* @description `track` is null when the queue ran out.
|
|
2020
|
+
*/
|
|
2021
|
+
post: {
|
|
2022
|
+
parameters: {
|
|
2023
|
+
query?: never;
|
|
2024
|
+
header?: never;
|
|
2025
|
+
path: {
|
|
2026
|
+
guildId: string;
|
|
2027
|
+
};
|
|
2028
|
+
cookie?: never;
|
|
2029
|
+
};
|
|
2030
|
+
requestBody?: never;
|
|
2031
|
+
responses: {
|
|
2032
|
+
/** @description The track now playing. */
|
|
2033
|
+
200: {
|
|
2034
|
+
headers: {
|
|
2035
|
+
[name: string]: unknown;
|
|
2036
|
+
};
|
|
2037
|
+
content: {
|
|
2038
|
+
"application/json": {
|
|
2039
|
+
data: components["schemas"]["SkipResult"];
|
|
2040
|
+
};
|
|
2041
|
+
};
|
|
2042
|
+
};
|
|
2043
|
+
/** @description The API key is not linked to a bot. */
|
|
2044
|
+
403: {
|
|
2045
|
+
headers: {
|
|
2046
|
+
[name: string]: unknown;
|
|
2047
|
+
};
|
|
2048
|
+
content: {
|
|
2049
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2050
|
+
};
|
|
2051
|
+
};
|
|
2052
|
+
/** @description No player in that guild. */
|
|
2053
|
+
404: {
|
|
2054
|
+
headers: {
|
|
2055
|
+
[name: string]: unknown;
|
|
2056
|
+
};
|
|
2057
|
+
content: {
|
|
2058
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2059
|
+
};
|
|
2060
|
+
};
|
|
2061
|
+
/** @description Conflicts with the current player state. */
|
|
2062
|
+
409: {
|
|
2063
|
+
headers: {
|
|
2064
|
+
[name: string]: unknown;
|
|
2065
|
+
};
|
|
2066
|
+
content: {
|
|
2067
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2068
|
+
};
|
|
2069
|
+
};
|
|
2070
|
+
/** @description The request cannot be carried out as given. */
|
|
2071
|
+
422: {
|
|
2072
|
+
headers: {
|
|
2073
|
+
[name: string]: unknown;
|
|
2074
|
+
};
|
|
2075
|
+
content: {
|
|
2076
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2077
|
+
};
|
|
2078
|
+
};
|
|
2079
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2080
|
+
503: {
|
|
2081
|
+
headers: {
|
|
2082
|
+
[name: string]: unknown;
|
|
2083
|
+
};
|
|
2084
|
+
content: {
|
|
2085
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2086
|
+
};
|
|
2087
|
+
};
|
|
2088
|
+
};
|
|
2089
|
+
};
|
|
2090
|
+
delete?: never;
|
|
2091
|
+
options?: never;
|
|
2092
|
+
head?: never;
|
|
2093
|
+
patch?: never;
|
|
2094
|
+
trace?: never;
|
|
2095
|
+
};
|
|
2096
|
+
"/v1/music/guilds/{guildId}": {
|
|
2097
|
+
parameters: {
|
|
2098
|
+
query?: never;
|
|
2099
|
+
header?: never;
|
|
2100
|
+
path?: never;
|
|
2101
|
+
cookie?: never;
|
|
2102
|
+
};
|
|
2103
|
+
get?: never;
|
|
2104
|
+
put?: never;
|
|
2105
|
+
post?: never;
|
|
2106
|
+
/**
|
|
2107
|
+
* Stop and leave
|
|
2108
|
+
* @description Clears the queue and leaves the voice channel.
|
|
2109
|
+
*/
|
|
2110
|
+
delete: {
|
|
2111
|
+
parameters: {
|
|
2112
|
+
query?: never;
|
|
2113
|
+
header?: never;
|
|
2114
|
+
path: {
|
|
2115
|
+
guildId: string;
|
|
2116
|
+
};
|
|
2117
|
+
cookie?: never;
|
|
2118
|
+
};
|
|
2119
|
+
requestBody?: never;
|
|
2120
|
+
responses: {
|
|
2121
|
+
/** @description Stopped. */
|
|
2122
|
+
200: {
|
|
2123
|
+
headers: {
|
|
2124
|
+
[name: string]: unknown;
|
|
2125
|
+
};
|
|
2126
|
+
content: {
|
|
2127
|
+
"application/json": {
|
|
2128
|
+
data: components["schemas"]["OkResult"];
|
|
2129
|
+
};
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
/** @description The API key is not linked to a bot. */
|
|
2133
|
+
403: {
|
|
2134
|
+
headers: {
|
|
2135
|
+
[name: string]: unknown;
|
|
2136
|
+
};
|
|
2137
|
+
content: {
|
|
2138
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2139
|
+
};
|
|
2140
|
+
};
|
|
2141
|
+
/** @description No player in that guild. */
|
|
2142
|
+
404: {
|
|
2143
|
+
headers: {
|
|
2144
|
+
[name: string]: unknown;
|
|
2145
|
+
};
|
|
2146
|
+
content: {
|
|
2147
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2148
|
+
};
|
|
2149
|
+
};
|
|
2150
|
+
/** @description Conflicts with the current player state. */
|
|
2151
|
+
409: {
|
|
2152
|
+
headers: {
|
|
2153
|
+
[name: string]: unknown;
|
|
2154
|
+
};
|
|
2155
|
+
content: {
|
|
2156
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2157
|
+
};
|
|
2158
|
+
};
|
|
2159
|
+
/** @description The request cannot be carried out as given. */
|
|
2160
|
+
422: {
|
|
2161
|
+
headers: {
|
|
2162
|
+
[name: string]: unknown;
|
|
2163
|
+
};
|
|
2164
|
+
content: {
|
|
2165
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2166
|
+
};
|
|
2167
|
+
};
|
|
2168
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2169
|
+
503: {
|
|
2170
|
+
headers: {
|
|
2171
|
+
[name: string]: unknown;
|
|
2172
|
+
};
|
|
2173
|
+
content: {
|
|
2174
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2175
|
+
};
|
|
2176
|
+
};
|
|
2177
|
+
};
|
|
2178
|
+
};
|
|
2179
|
+
options?: never;
|
|
2180
|
+
head?: never;
|
|
2181
|
+
patch?: never;
|
|
2182
|
+
trace?: never;
|
|
2183
|
+
};
|
|
2184
|
+
"/v1/music/guilds/{guildId}/restart": {
|
|
2185
|
+
parameters: {
|
|
2186
|
+
query?: never;
|
|
2187
|
+
header?: never;
|
|
2188
|
+
path?: never;
|
|
2189
|
+
cookie?: never;
|
|
2190
|
+
};
|
|
2191
|
+
get?: never;
|
|
2192
|
+
put?: never;
|
|
2193
|
+
/**
|
|
2194
|
+
* Play the current track again
|
|
2195
|
+
* @description Starts the current track over from the start, keeping it paused or playing as it was.
|
|
2196
|
+
*/
|
|
2197
|
+
post: {
|
|
2198
|
+
parameters: {
|
|
2199
|
+
query?: never;
|
|
2200
|
+
header?: never;
|
|
2201
|
+
path: {
|
|
2202
|
+
guildId: string;
|
|
2203
|
+
};
|
|
2204
|
+
cookie?: never;
|
|
2205
|
+
};
|
|
2206
|
+
requestBody?: never;
|
|
2207
|
+
responses: {
|
|
2208
|
+
/** @description The track, restarted. */
|
|
2209
|
+
200: {
|
|
2210
|
+
headers: {
|
|
2211
|
+
[name: string]: unknown;
|
|
2212
|
+
};
|
|
2213
|
+
content: {
|
|
2214
|
+
"application/json": {
|
|
2215
|
+
data: components["schemas"]["RestartResult"];
|
|
2216
|
+
};
|
|
2217
|
+
};
|
|
2218
|
+
};
|
|
2219
|
+
/** @description The API key is not linked to a bot. */
|
|
2220
|
+
403: {
|
|
2221
|
+
headers: {
|
|
2222
|
+
[name: string]: unknown;
|
|
2223
|
+
};
|
|
2224
|
+
content: {
|
|
2225
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2226
|
+
};
|
|
2227
|
+
};
|
|
2228
|
+
/** @description No player in that guild. */
|
|
2229
|
+
404: {
|
|
2230
|
+
headers: {
|
|
2231
|
+
[name: string]: unknown;
|
|
2232
|
+
};
|
|
2233
|
+
content: {
|
|
2234
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2235
|
+
};
|
|
2236
|
+
};
|
|
2237
|
+
/** @description Conflicts with the current player state. */
|
|
2238
|
+
409: {
|
|
2239
|
+
headers: {
|
|
2240
|
+
[name: string]: unknown;
|
|
2241
|
+
};
|
|
2242
|
+
content: {
|
|
2243
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
/** @description The request cannot be carried out as given. */
|
|
2247
|
+
422: {
|
|
2248
|
+
headers: {
|
|
2249
|
+
[name: string]: unknown;
|
|
2250
|
+
};
|
|
2251
|
+
content: {
|
|
2252
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2253
|
+
};
|
|
2254
|
+
};
|
|
2255
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2256
|
+
503: {
|
|
2257
|
+
headers: {
|
|
2258
|
+
[name: string]: unknown;
|
|
2259
|
+
};
|
|
2260
|
+
content: {
|
|
2261
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2262
|
+
};
|
|
2263
|
+
};
|
|
2264
|
+
};
|
|
2265
|
+
};
|
|
2266
|
+
delete?: never;
|
|
2267
|
+
options?: never;
|
|
2268
|
+
head?: never;
|
|
2269
|
+
patch?: never;
|
|
2270
|
+
trace?: never;
|
|
2271
|
+
};
|
|
2272
|
+
"/v1/music/guilds/{guildId}/queue": {
|
|
2273
|
+
parameters: {
|
|
2274
|
+
query?: never;
|
|
2275
|
+
header?: never;
|
|
2276
|
+
path?: never;
|
|
2277
|
+
cookie?: never;
|
|
2278
|
+
};
|
|
2279
|
+
/**
|
|
2280
|
+
* Current track and player state
|
|
2281
|
+
* @description The whole player: what is playing, where playback is, the volume and loop mode, and the queued tracks. The queue holds what has not started yet, so its first entry is the next track up and is the `index` the queue editing routes take.
|
|
2282
|
+
*/
|
|
2283
|
+
get: {
|
|
2284
|
+
parameters: {
|
|
2285
|
+
query?: never;
|
|
2286
|
+
header?: never;
|
|
2287
|
+
path: {
|
|
2288
|
+
guildId: string;
|
|
2289
|
+
};
|
|
2290
|
+
cookie?: never;
|
|
2291
|
+
};
|
|
2292
|
+
requestBody?: never;
|
|
2293
|
+
responses: {
|
|
2294
|
+
/** @description The player. */
|
|
2295
|
+
200: {
|
|
2296
|
+
headers: {
|
|
2297
|
+
[name: string]: unknown;
|
|
2298
|
+
};
|
|
2299
|
+
content: {
|
|
2300
|
+
"application/json": {
|
|
2301
|
+
data: components["schemas"]["PlayerState"];
|
|
2302
|
+
};
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
/** @description The API key is not linked to a bot. */
|
|
2306
|
+
403: {
|
|
2307
|
+
headers: {
|
|
2308
|
+
[name: string]: unknown;
|
|
2309
|
+
};
|
|
2310
|
+
content: {
|
|
2311
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2312
|
+
};
|
|
2313
|
+
};
|
|
2314
|
+
/** @description No player in that guild. */
|
|
2315
|
+
404: {
|
|
2316
|
+
headers: {
|
|
2317
|
+
[name: string]: unknown;
|
|
2318
|
+
};
|
|
2319
|
+
content: {
|
|
2320
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2321
|
+
};
|
|
2322
|
+
};
|
|
2323
|
+
/** @description Conflicts with the current player state. */
|
|
2324
|
+
409: {
|
|
2325
|
+
headers: {
|
|
2326
|
+
[name: string]: unknown;
|
|
2327
|
+
};
|
|
2328
|
+
content: {
|
|
2329
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2330
|
+
};
|
|
2331
|
+
};
|
|
2332
|
+
/** @description The request cannot be carried out as given. */
|
|
2333
|
+
422: {
|
|
2334
|
+
headers: {
|
|
2335
|
+
[name: string]: unknown;
|
|
2336
|
+
};
|
|
2337
|
+
content: {
|
|
2338
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2339
|
+
};
|
|
2340
|
+
};
|
|
2341
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2342
|
+
503: {
|
|
2343
|
+
headers: {
|
|
2344
|
+
[name: string]: unknown;
|
|
2345
|
+
};
|
|
2346
|
+
content: {
|
|
2347
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2348
|
+
};
|
|
2349
|
+
};
|
|
2350
|
+
};
|
|
2351
|
+
};
|
|
2352
|
+
put?: never;
|
|
2353
|
+
post?: never;
|
|
2354
|
+
/**
|
|
2355
|
+
* Clear the queue
|
|
2356
|
+
* @description Removes every queued track. The current track keeps playing to the end, and the loop mode goes back to `off`, so nothing repeats once it does.
|
|
2357
|
+
*/
|
|
2358
|
+
delete: {
|
|
2359
|
+
parameters: {
|
|
2360
|
+
query?: never;
|
|
2361
|
+
header?: never;
|
|
2362
|
+
path: {
|
|
2363
|
+
guildId: string;
|
|
2364
|
+
};
|
|
2365
|
+
cookie?: never;
|
|
2366
|
+
};
|
|
2367
|
+
requestBody?: never;
|
|
2368
|
+
responses: {
|
|
2369
|
+
/** @description How many tracks were removed. */
|
|
2370
|
+
200: {
|
|
2371
|
+
headers: {
|
|
2372
|
+
[name: string]: unknown;
|
|
2373
|
+
};
|
|
2374
|
+
content: {
|
|
2375
|
+
"application/json": {
|
|
2376
|
+
data: components["schemas"]["ClearQueueResult"];
|
|
2377
|
+
};
|
|
2378
|
+
};
|
|
2379
|
+
};
|
|
2380
|
+
/** @description The API key is not linked to a bot. */
|
|
2381
|
+
403: {
|
|
2382
|
+
headers: {
|
|
2383
|
+
[name: string]: unknown;
|
|
2384
|
+
};
|
|
2385
|
+
content: {
|
|
2386
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2387
|
+
};
|
|
2388
|
+
};
|
|
2389
|
+
/** @description No player in that guild. */
|
|
2390
|
+
404: {
|
|
2391
|
+
headers: {
|
|
2392
|
+
[name: string]: unknown;
|
|
2393
|
+
};
|
|
2394
|
+
content: {
|
|
2395
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2396
|
+
};
|
|
2397
|
+
};
|
|
2398
|
+
/** @description Conflicts with the current player state. */
|
|
2399
|
+
409: {
|
|
2400
|
+
headers: {
|
|
2401
|
+
[name: string]: unknown;
|
|
2402
|
+
};
|
|
2403
|
+
content: {
|
|
2404
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
/** @description The request cannot be carried out as given. */
|
|
2408
|
+
422: {
|
|
2409
|
+
headers: {
|
|
2410
|
+
[name: string]: unknown;
|
|
2411
|
+
};
|
|
2412
|
+
content: {
|
|
2413
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2417
|
+
503: {
|
|
2418
|
+
headers: {
|
|
2419
|
+
[name: string]: unknown;
|
|
2420
|
+
};
|
|
2421
|
+
content: {
|
|
2422
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2423
|
+
};
|
|
2424
|
+
};
|
|
2425
|
+
};
|
|
2426
|
+
};
|
|
2427
|
+
options?: never;
|
|
2428
|
+
head?: never;
|
|
2429
|
+
patch?: never;
|
|
2430
|
+
trace?: never;
|
|
2431
|
+
};
|
|
2432
|
+
"/v1/music/guilds/{guildId}/shuffle": {
|
|
2433
|
+
parameters: {
|
|
2434
|
+
query?: never;
|
|
2435
|
+
header?: never;
|
|
2436
|
+
path?: never;
|
|
2437
|
+
cookie?: never;
|
|
2438
|
+
};
|
|
2439
|
+
get?: never;
|
|
2440
|
+
put?: never;
|
|
2441
|
+
/**
|
|
2442
|
+
* Shuffle the queue
|
|
2443
|
+
* @description Randomises the order of the queued tracks. The current track is left alone.
|
|
2444
|
+
*/
|
|
2445
|
+
post: {
|
|
2446
|
+
parameters: {
|
|
2447
|
+
query?: never;
|
|
2448
|
+
header?: never;
|
|
2449
|
+
path: {
|
|
2450
|
+
guildId: string;
|
|
2451
|
+
};
|
|
2452
|
+
cookie?: never;
|
|
2453
|
+
};
|
|
2454
|
+
requestBody?: never;
|
|
2455
|
+
responses: {
|
|
2456
|
+
/** @description The queue in its new order. */
|
|
2457
|
+
200: {
|
|
2458
|
+
headers: {
|
|
2459
|
+
[name: string]: unknown;
|
|
2460
|
+
};
|
|
2461
|
+
content: {
|
|
2462
|
+
"application/json": {
|
|
2463
|
+
data: components["schemas"]["ShuffleResult"];
|
|
2464
|
+
};
|
|
2465
|
+
};
|
|
2466
|
+
};
|
|
2467
|
+
/** @description The API key is not linked to a bot. */
|
|
2468
|
+
403: {
|
|
2469
|
+
headers: {
|
|
2470
|
+
[name: string]: unknown;
|
|
2471
|
+
};
|
|
2472
|
+
content: {
|
|
2473
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2474
|
+
};
|
|
2475
|
+
};
|
|
2476
|
+
/** @description No player in that guild. */
|
|
2477
|
+
404: {
|
|
2478
|
+
headers: {
|
|
2479
|
+
[name: string]: unknown;
|
|
2480
|
+
};
|
|
2481
|
+
content: {
|
|
2482
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2483
|
+
};
|
|
2484
|
+
};
|
|
2485
|
+
/** @description Conflicts with the current player state. */
|
|
2486
|
+
409: {
|
|
2487
|
+
headers: {
|
|
2488
|
+
[name: string]: unknown;
|
|
2489
|
+
};
|
|
2490
|
+
content: {
|
|
2491
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2492
|
+
};
|
|
2493
|
+
};
|
|
2494
|
+
/** @description The request cannot be carried out as given. */
|
|
2495
|
+
422: {
|
|
2496
|
+
headers: {
|
|
2497
|
+
[name: string]: unknown;
|
|
2498
|
+
};
|
|
2499
|
+
content: {
|
|
2500
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2501
|
+
};
|
|
2502
|
+
};
|
|
2503
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2504
|
+
503: {
|
|
2505
|
+
headers: {
|
|
2506
|
+
[name: string]: unknown;
|
|
2507
|
+
};
|
|
2508
|
+
content: {
|
|
2509
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2510
|
+
};
|
|
2511
|
+
};
|
|
2512
|
+
};
|
|
2513
|
+
};
|
|
2514
|
+
delete?: never;
|
|
2515
|
+
options?: never;
|
|
2516
|
+
head?: never;
|
|
2517
|
+
patch?: never;
|
|
2518
|
+
trace?: never;
|
|
2519
|
+
};
|
|
2520
|
+
"/v1/music/guilds/{guildId}/queue/{index}": {
|
|
2521
|
+
parameters: {
|
|
2522
|
+
query?: never;
|
|
2523
|
+
header?: never;
|
|
2524
|
+
path?: never;
|
|
2525
|
+
cookie?: never;
|
|
2526
|
+
};
|
|
2527
|
+
get?: never;
|
|
2528
|
+
put?: never;
|
|
2529
|
+
post?: never;
|
|
2530
|
+
/**
|
|
2531
|
+
* Remove a queued track
|
|
2532
|
+
* @description Removes one track from the queue by position. Everything after it moves up by one.
|
|
2533
|
+
*/
|
|
2534
|
+
delete: {
|
|
2535
|
+
parameters: {
|
|
2536
|
+
query?: never;
|
|
2537
|
+
header?: never;
|
|
2538
|
+
path: {
|
|
2539
|
+
guildId: string;
|
|
2540
|
+
/** @description Zero-based position in the queue, where 0 is the next track up. */
|
|
2541
|
+
index: number | null;
|
|
2542
|
+
};
|
|
2543
|
+
cookie?: never;
|
|
2544
|
+
};
|
|
2545
|
+
requestBody?: never;
|
|
2546
|
+
responses: {
|
|
2547
|
+
/** @description The removed track and the queue after it. */
|
|
2548
|
+
200: {
|
|
2549
|
+
headers: {
|
|
2550
|
+
[name: string]: unknown;
|
|
2551
|
+
};
|
|
2552
|
+
content: {
|
|
2553
|
+
"application/json": {
|
|
2554
|
+
data: components["schemas"]["RemoveResult"];
|
|
2555
|
+
};
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
/** @description The API key is not linked to a bot. */
|
|
2559
|
+
403: {
|
|
2560
|
+
headers: {
|
|
2561
|
+
[name: string]: unknown;
|
|
2562
|
+
};
|
|
2563
|
+
content: {
|
|
2564
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2565
|
+
};
|
|
2566
|
+
};
|
|
2567
|
+
/** @description No player in that guild. */
|
|
2568
|
+
404: {
|
|
2569
|
+
headers: {
|
|
2570
|
+
[name: string]: unknown;
|
|
2571
|
+
};
|
|
2572
|
+
content: {
|
|
2573
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2574
|
+
};
|
|
2575
|
+
};
|
|
2576
|
+
/** @description Conflicts with the current player state. */
|
|
2577
|
+
409: {
|
|
2578
|
+
headers: {
|
|
2579
|
+
[name: string]: unknown;
|
|
2580
|
+
};
|
|
2581
|
+
content: {
|
|
2582
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2583
|
+
};
|
|
2584
|
+
};
|
|
2585
|
+
/** @description The request cannot be carried out as given. */
|
|
2586
|
+
422: {
|
|
2587
|
+
headers: {
|
|
2588
|
+
[name: string]: unknown;
|
|
2589
|
+
};
|
|
2590
|
+
content: {
|
|
2591
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2592
|
+
};
|
|
2593
|
+
};
|
|
2594
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2595
|
+
503: {
|
|
2596
|
+
headers: {
|
|
2597
|
+
[name: string]: unknown;
|
|
2598
|
+
};
|
|
2599
|
+
content: {
|
|
2600
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2601
|
+
};
|
|
2602
|
+
};
|
|
2603
|
+
};
|
|
2604
|
+
};
|
|
2605
|
+
options?: never;
|
|
2606
|
+
head?: never;
|
|
2607
|
+
/**
|
|
2608
|
+
* Move a queued track
|
|
2609
|
+
* @description Moves one track to another position in the queue. `to` is where it lands, so moving the last track to `0` puts it next up.
|
|
2610
|
+
*/
|
|
2611
|
+
patch: {
|
|
2612
|
+
parameters: {
|
|
2613
|
+
query?: never;
|
|
2614
|
+
header?: never;
|
|
2615
|
+
path: {
|
|
2616
|
+
guildId: string;
|
|
2617
|
+
/** @description Zero-based position in the queue, where 0 is the next track up. */
|
|
2618
|
+
index: number | null;
|
|
2619
|
+
};
|
|
2620
|
+
cookie?: never;
|
|
2621
|
+
};
|
|
2622
|
+
requestBody: {
|
|
2623
|
+
content: {
|
|
2624
|
+
"application/json": {
|
|
2625
|
+
/** @example 0 */
|
|
2626
|
+
to: number | null;
|
|
2627
|
+
};
|
|
2628
|
+
};
|
|
2629
|
+
};
|
|
2630
|
+
responses: {
|
|
2631
|
+
/** @description The moved track and the queue after it. */
|
|
2632
|
+
200: {
|
|
2633
|
+
headers: {
|
|
2634
|
+
[name: string]: unknown;
|
|
2635
|
+
};
|
|
2636
|
+
content: {
|
|
2637
|
+
"application/json": {
|
|
2638
|
+
data: components["schemas"]["MoveResult"];
|
|
2639
|
+
};
|
|
2640
|
+
};
|
|
2641
|
+
};
|
|
2642
|
+
/** @description The API key is not linked to a bot. */
|
|
2643
|
+
403: {
|
|
2644
|
+
headers: {
|
|
2645
|
+
[name: string]: unknown;
|
|
2646
|
+
};
|
|
2647
|
+
content: {
|
|
2648
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2651
|
+
/** @description No player in that guild. */
|
|
2652
|
+
404: {
|
|
2653
|
+
headers: {
|
|
2654
|
+
[name: string]: unknown;
|
|
2655
|
+
};
|
|
2656
|
+
content: {
|
|
2657
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2658
|
+
};
|
|
2659
|
+
};
|
|
2660
|
+
/** @description Conflicts with the current player state. */
|
|
2661
|
+
409: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2667
|
+
};
|
|
2668
|
+
};
|
|
2669
|
+
/** @description The request cannot be carried out as given. */
|
|
2670
|
+
422: {
|
|
2671
|
+
headers: {
|
|
2672
|
+
[name: string]: unknown;
|
|
2673
|
+
};
|
|
2674
|
+
content: {
|
|
2675
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2676
|
+
};
|
|
2677
|
+
};
|
|
2678
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2679
|
+
503: {
|
|
2680
|
+
headers: {
|
|
2681
|
+
[name: string]: unknown;
|
|
2682
|
+
};
|
|
2683
|
+
content: {
|
|
2684
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2685
|
+
};
|
|
2686
|
+
};
|
|
2687
|
+
};
|
|
2688
|
+
};
|
|
2689
|
+
trace?: never;
|
|
2690
|
+
};
|
|
2691
|
+
"/v1/music/guilds/{guildId}/volume": {
|
|
2692
|
+
parameters: {
|
|
2693
|
+
query?: never;
|
|
2694
|
+
header?: never;
|
|
2695
|
+
path?: never;
|
|
2696
|
+
cookie?: never;
|
|
2697
|
+
};
|
|
2698
|
+
/** Current volume */
|
|
2699
|
+
get: {
|
|
2700
|
+
parameters: {
|
|
2701
|
+
query?: never;
|
|
2702
|
+
header?: never;
|
|
2703
|
+
path: {
|
|
2704
|
+
guildId: string;
|
|
2705
|
+
};
|
|
2706
|
+
cookie?: never;
|
|
2707
|
+
};
|
|
2708
|
+
requestBody?: never;
|
|
2709
|
+
responses: {
|
|
2710
|
+
/** @description The volume and mute state. */
|
|
2711
|
+
200: {
|
|
2712
|
+
headers: {
|
|
2713
|
+
[name: string]: unknown;
|
|
2714
|
+
};
|
|
2715
|
+
content: {
|
|
2716
|
+
"application/json": {
|
|
2717
|
+
data: components["schemas"]["VolumeResult"];
|
|
2718
|
+
};
|
|
2719
|
+
};
|
|
2720
|
+
};
|
|
2721
|
+
/** @description The API key is not linked to a bot. */
|
|
2722
|
+
403: {
|
|
2723
|
+
headers: {
|
|
2724
|
+
[name: string]: unknown;
|
|
2725
|
+
};
|
|
2726
|
+
content: {
|
|
2727
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2728
|
+
};
|
|
2729
|
+
};
|
|
2730
|
+
/** @description No player in that guild. */
|
|
2731
|
+
404: {
|
|
2732
|
+
headers: {
|
|
2733
|
+
[name: string]: unknown;
|
|
2734
|
+
};
|
|
2735
|
+
content: {
|
|
2736
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
/** @description Conflicts with the current player state. */
|
|
2740
|
+
409: {
|
|
2741
|
+
headers: {
|
|
2742
|
+
[name: string]: unknown;
|
|
2743
|
+
};
|
|
2744
|
+
content: {
|
|
2745
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2746
|
+
};
|
|
2747
|
+
};
|
|
2748
|
+
/** @description The request cannot be carried out as given. */
|
|
2749
|
+
422: {
|
|
2750
|
+
headers: {
|
|
2751
|
+
[name: string]: unknown;
|
|
2752
|
+
};
|
|
2753
|
+
content: {
|
|
2754
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2755
|
+
};
|
|
2756
|
+
};
|
|
2757
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2758
|
+
503: {
|
|
2759
|
+
headers: {
|
|
2760
|
+
[name: string]: unknown;
|
|
2761
|
+
};
|
|
2762
|
+
content: {
|
|
2763
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2764
|
+
};
|
|
2765
|
+
};
|
|
2766
|
+
};
|
|
2767
|
+
};
|
|
2768
|
+
put?: never;
|
|
2769
|
+
post?: never;
|
|
2770
|
+
delete?: never;
|
|
2771
|
+
options?: never;
|
|
2772
|
+
head?: never;
|
|
2773
|
+
/**
|
|
2774
|
+
* Set the volume
|
|
2775
|
+
* @description Sets the player volume, where 100 is the default and the highest is 200. Send `muted` to change the mute state at the same time, or leave it out to keep it as it is.
|
|
2776
|
+
*/
|
|
2777
|
+
patch: {
|
|
2778
|
+
parameters: {
|
|
2779
|
+
query?: never;
|
|
2780
|
+
header?: never;
|
|
2781
|
+
path: {
|
|
2782
|
+
guildId: string;
|
|
2783
|
+
};
|
|
2784
|
+
cookie?: never;
|
|
2785
|
+
};
|
|
2786
|
+
requestBody: {
|
|
2787
|
+
content: {
|
|
2788
|
+
"application/json": {
|
|
2789
|
+
/** @example 80 */
|
|
2790
|
+
volume: number | null;
|
|
2791
|
+
/** @description Leave out to keep it as it is. */
|
|
2792
|
+
muted?: boolean;
|
|
2793
|
+
};
|
|
2794
|
+
};
|
|
2795
|
+
};
|
|
2796
|
+
responses: {
|
|
2797
|
+
/** @description The volume after the change. */
|
|
2798
|
+
200: {
|
|
2799
|
+
headers: {
|
|
2800
|
+
[name: string]: unknown;
|
|
2801
|
+
};
|
|
2802
|
+
content: {
|
|
2803
|
+
"application/json": {
|
|
2804
|
+
data: components["schemas"]["VolumeResult"];
|
|
2805
|
+
};
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2808
|
+
/** @description The API key is not linked to a bot. */
|
|
2809
|
+
403: {
|
|
2810
|
+
headers: {
|
|
2811
|
+
[name: string]: unknown;
|
|
2812
|
+
};
|
|
2813
|
+
content: {
|
|
2814
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2815
|
+
};
|
|
2816
|
+
};
|
|
2817
|
+
/** @description No player in that guild. */
|
|
2818
|
+
404: {
|
|
2819
|
+
headers: {
|
|
2820
|
+
[name: string]: unknown;
|
|
2821
|
+
};
|
|
2822
|
+
content: {
|
|
2823
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2824
|
+
};
|
|
2825
|
+
};
|
|
2826
|
+
/** @description Conflicts with the current player state. */
|
|
2827
|
+
409: {
|
|
2828
|
+
headers: {
|
|
2829
|
+
[name: string]: unknown;
|
|
2830
|
+
};
|
|
2831
|
+
content: {
|
|
2832
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2833
|
+
};
|
|
2834
|
+
};
|
|
2835
|
+
/** @description The request cannot be carried out as given. */
|
|
2836
|
+
422: {
|
|
2837
|
+
headers: {
|
|
2838
|
+
[name: string]: unknown;
|
|
2839
|
+
};
|
|
2840
|
+
content: {
|
|
2841
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2842
|
+
};
|
|
2843
|
+
};
|
|
2844
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2845
|
+
503: {
|
|
2846
|
+
headers: {
|
|
2847
|
+
[name: string]: unknown;
|
|
2848
|
+
};
|
|
2849
|
+
content: {
|
|
2850
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2851
|
+
};
|
|
2852
|
+
};
|
|
2853
|
+
};
|
|
2854
|
+
};
|
|
2855
|
+
trace?: never;
|
|
2856
|
+
};
|
|
2857
|
+
"/v1/music/guilds/{guildId}/mute": {
|
|
2858
|
+
parameters: {
|
|
2859
|
+
query?: never;
|
|
2860
|
+
header?: never;
|
|
2861
|
+
path?: never;
|
|
2862
|
+
cookie?: never;
|
|
2863
|
+
};
|
|
2864
|
+
get?: never;
|
|
2865
|
+
put?: never;
|
|
2866
|
+
/**
|
|
2867
|
+
* Mute
|
|
2868
|
+
* @description Mutes without touching the volume, so unmuting comes back at the level it was left.
|
|
2869
|
+
*/
|
|
2870
|
+
post: {
|
|
2871
|
+
parameters: {
|
|
2872
|
+
query?: never;
|
|
2873
|
+
header?: never;
|
|
2874
|
+
path: {
|
|
2875
|
+
guildId: string;
|
|
2876
|
+
};
|
|
2877
|
+
cookie?: never;
|
|
2878
|
+
};
|
|
2879
|
+
requestBody: {
|
|
2880
|
+
content: {
|
|
2881
|
+
"application/json": {
|
|
2882
|
+
/** @default true */
|
|
2883
|
+
muted?: boolean;
|
|
2884
|
+
};
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
responses: {
|
|
2888
|
+
/** @description The mute state after the change. */
|
|
2889
|
+
200: {
|
|
2890
|
+
headers: {
|
|
2891
|
+
[name: string]: unknown;
|
|
2892
|
+
};
|
|
2893
|
+
content: {
|
|
2894
|
+
"application/json": {
|
|
2895
|
+
data: components["schemas"]["MuteResult"];
|
|
2896
|
+
};
|
|
2897
|
+
};
|
|
2898
|
+
};
|
|
2899
|
+
/** @description The API key is not linked to a bot. */
|
|
2900
|
+
403: {
|
|
2901
|
+
headers: {
|
|
2902
|
+
[name: string]: unknown;
|
|
2903
|
+
};
|
|
2904
|
+
content: {
|
|
2905
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2906
|
+
};
|
|
2907
|
+
};
|
|
2908
|
+
/** @description No player in that guild. */
|
|
2909
|
+
404: {
|
|
2910
|
+
headers: {
|
|
2911
|
+
[name: string]: unknown;
|
|
2912
|
+
};
|
|
2913
|
+
content: {
|
|
2914
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2915
|
+
};
|
|
2916
|
+
};
|
|
2917
|
+
/** @description Conflicts with the current player state. */
|
|
2918
|
+
409: {
|
|
2919
|
+
headers: {
|
|
2920
|
+
[name: string]: unknown;
|
|
2921
|
+
};
|
|
2922
|
+
content: {
|
|
2923
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2924
|
+
};
|
|
2925
|
+
};
|
|
2926
|
+
/** @description The request cannot be carried out as given. */
|
|
2927
|
+
422: {
|
|
2928
|
+
headers: {
|
|
2929
|
+
[name: string]: unknown;
|
|
2930
|
+
};
|
|
2931
|
+
content: {
|
|
2932
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2933
|
+
};
|
|
2934
|
+
};
|
|
2935
|
+
/** @description The music workers are unavailable or timed out. */
|
|
2936
|
+
503: {
|
|
2937
|
+
headers: {
|
|
2938
|
+
[name: string]: unknown;
|
|
2939
|
+
};
|
|
2940
|
+
content: {
|
|
2941
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2942
|
+
};
|
|
2943
|
+
};
|
|
2944
|
+
};
|
|
2945
|
+
};
|
|
2946
|
+
/** Unmute */
|
|
2947
|
+
delete: {
|
|
2948
|
+
parameters: {
|
|
2949
|
+
query?: never;
|
|
2950
|
+
header?: never;
|
|
2951
|
+
path: {
|
|
2952
|
+
guildId: string;
|
|
2953
|
+
};
|
|
2954
|
+
cookie?: never;
|
|
2955
|
+
};
|
|
2956
|
+
requestBody?: never;
|
|
2957
|
+
responses: {
|
|
2958
|
+
/** @description The mute state after the change. */
|
|
2959
|
+
200: {
|
|
2960
|
+
headers: {
|
|
2961
|
+
[name: string]: unknown;
|
|
2962
|
+
};
|
|
2963
|
+
content: {
|
|
2964
|
+
"application/json": {
|
|
2965
|
+
data: components["schemas"]["MuteResult"];
|
|
2966
|
+
};
|
|
2967
|
+
};
|
|
2968
|
+
};
|
|
2969
|
+
/** @description The API key is not linked to a bot. */
|
|
2970
|
+
403: {
|
|
2971
|
+
headers: {
|
|
2972
|
+
[name: string]: unknown;
|
|
2973
|
+
};
|
|
2974
|
+
content: {
|
|
2975
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2976
|
+
};
|
|
2977
|
+
};
|
|
2978
|
+
/** @description No player in that guild. */
|
|
2979
|
+
404: {
|
|
2980
|
+
headers: {
|
|
2981
|
+
[name: string]: unknown;
|
|
2982
|
+
};
|
|
2983
|
+
content: {
|
|
2984
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2985
|
+
};
|
|
2986
|
+
};
|
|
2987
|
+
/** @description Conflicts with the current player state. */
|
|
2988
|
+
409: {
|
|
2989
|
+
headers: {
|
|
2990
|
+
[name: string]: unknown;
|
|
2991
|
+
};
|
|
2992
|
+
content: {
|
|
2993
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2994
|
+
};
|
|
2995
|
+
};
|
|
2996
|
+
/** @description The request cannot be carried out as given. */
|
|
2997
|
+
422: {
|
|
2998
|
+
headers: {
|
|
2999
|
+
[name: string]: unknown;
|
|
3000
|
+
};
|
|
3001
|
+
content: {
|
|
3002
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3003
|
+
};
|
|
3004
|
+
};
|
|
3005
|
+
/** @description The music workers are unavailable or timed out. */
|
|
3006
|
+
503: {
|
|
3007
|
+
headers: {
|
|
3008
|
+
[name: string]: unknown;
|
|
3009
|
+
};
|
|
3010
|
+
content: {
|
|
3011
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3012
|
+
};
|
|
3013
|
+
};
|
|
3014
|
+
};
|
|
3015
|
+
};
|
|
3016
|
+
options?: never;
|
|
3017
|
+
head?: never;
|
|
3018
|
+
patch?: never;
|
|
3019
|
+
trace?: never;
|
|
3020
|
+
};
|
|
3021
|
+
"/v1/music/guilds/{guildId}/seek": {
|
|
3022
|
+
parameters: {
|
|
3023
|
+
query?: never;
|
|
3024
|
+
header?: never;
|
|
3025
|
+
path?: never;
|
|
3026
|
+
cookie?: never;
|
|
3027
|
+
};
|
|
3028
|
+
get?: never;
|
|
3029
|
+
put?: never;
|
|
3030
|
+
/**
|
|
3031
|
+
* Jump to a position
|
|
3032
|
+
* @description Seeks the current track to a position in milliseconds. Refused when nothing is playing, or when the position is past the end of a track that has a known length.
|
|
3033
|
+
*/
|
|
3034
|
+
post: {
|
|
3035
|
+
parameters: {
|
|
3036
|
+
query?: never;
|
|
3037
|
+
header?: never;
|
|
3038
|
+
path: {
|
|
3039
|
+
guildId: string;
|
|
3040
|
+
};
|
|
3041
|
+
cookie?: never;
|
|
3042
|
+
};
|
|
3043
|
+
requestBody: {
|
|
3044
|
+
content: {
|
|
3045
|
+
"application/json": {
|
|
3046
|
+
/** @example 30000 */
|
|
3047
|
+
position: number | null;
|
|
3048
|
+
};
|
|
3049
|
+
};
|
|
3050
|
+
};
|
|
3051
|
+
responses: {
|
|
3052
|
+
/** @description Where playback is now. */
|
|
3053
|
+
200: {
|
|
3054
|
+
headers: {
|
|
3055
|
+
[name: string]: unknown;
|
|
3056
|
+
};
|
|
3057
|
+
content: {
|
|
3058
|
+
"application/json": {
|
|
3059
|
+
data: components["schemas"]["SeekResult"];
|
|
3060
|
+
};
|
|
3061
|
+
};
|
|
3062
|
+
};
|
|
3063
|
+
/** @description The API key is not linked to a bot. */
|
|
3064
|
+
403: {
|
|
3065
|
+
headers: {
|
|
3066
|
+
[name: string]: unknown;
|
|
3067
|
+
};
|
|
3068
|
+
content: {
|
|
3069
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3070
|
+
};
|
|
3071
|
+
};
|
|
3072
|
+
/** @description No player in that guild. */
|
|
3073
|
+
404: {
|
|
3074
|
+
headers: {
|
|
3075
|
+
[name: string]: unknown;
|
|
3076
|
+
};
|
|
3077
|
+
content: {
|
|
3078
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3079
|
+
};
|
|
3080
|
+
};
|
|
3081
|
+
/** @description Conflicts with the current player state. */
|
|
3082
|
+
409: {
|
|
3083
|
+
headers: {
|
|
3084
|
+
[name: string]: unknown;
|
|
3085
|
+
};
|
|
3086
|
+
content: {
|
|
3087
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3088
|
+
};
|
|
3089
|
+
};
|
|
3090
|
+
/** @description The request cannot be carried out as given. */
|
|
3091
|
+
422: {
|
|
3092
|
+
headers: {
|
|
3093
|
+
[name: string]: unknown;
|
|
3094
|
+
};
|
|
3095
|
+
content: {
|
|
3096
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3097
|
+
};
|
|
3098
|
+
};
|
|
3099
|
+
/** @description The music workers are unavailable or timed out. */
|
|
3100
|
+
503: {
|
|
3101
|
+
headers: {
|
|
3102
|
+
[name: string]: unknown;
|
|
3103
|
+
};
|
|
3104
|
+
content: {
|
|
3105
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3106
|
+
};
|
|
3107
|
+
};
|
|
3108
|
+
};
|
|
3109
|
+
};
|
|
3110
|
+
delete?: never;
|
|
3111
|
+
options?: never;
|
|
3112
|
+
head?: never;
|
|
3113
|
+
patch?: never;
|
|
3114
|
+
trace?: never;
|
|
3115
|
+
};
|
|
3116
|
+
"/v1/music/guilds/{guildId}/loop": {
|
|
3117
|
+
parameters: {
|
|
3118
|
+
query?: never;
|
|
3119
|
+
header?: never;
|
|
3120
|
+
path?: never;
|
|
3121
|
+
cookie?: never;
|
|
3122
|
+
};
|
|
3123
|
+
/** Current loop mode */
|
|
3124
|
+
get: {
|
|
3125
|
+
parameters: {
|
|
3126
|
+
query?: never;
|
|
3127
|
+
header?: never;
|
|
3128
|
+
path: {
|
|
3129
|
+
guildId: string;
|
|
3130
|
+
};
|
|
3131
|
+
cookie?: never;
|
|
3132
|
+
};
|
|
3133
|
+
requestBody?: never;
|
|
3134
|
+
responses: {
|
|
3135
|
+
/** @description The loop mode. */
|
|
3136
|
+
200: {
|
|
3137
|
+
headers: {
|
|
3138
|
+
[name: string]: unknown;
|
|
3139
|
+
};
|
|
3140
|
+
content: {
|
|
3141
|
+
"application/json": {
|
|
3142
|
+
data: components["schemas"]["LoopResult"];
|
|
3143
|
+
};
|
|
3144
|
+
};
|
|
3145
|
+
};
|
|
3146
|
+
/** @description The API key is not linked to a bot. */
|
|
3147
|
+
403: {
|
|
3148
|
+
headers: {
|
|
3149
|
+
[name: string]: unknown;
|
|
3150
|
+
};
|
|
3151
|
+
content: {
|
|
3152
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3153
|
+
};
|
|
3154
|
+
};
|
|
3155
|
+
/** @description No player in that guild. */
|
|
3156
|
+
404: {
|
|
3157
|
+
headers: {
|
|
3158
|
+
[name: string]: unknown;
|
|
3159
|
+
};
|
|
3160
|
+
content: {
|
|
3161
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3162
|
+
};
|
|
3163
|
+
};
|
|
3164
|
+
/** @description Conflicts with the current player state. */
|
|
3165
|
+
409: {
|
|
3166
|
+
headers: {
|
|
3167
|
+
[name: string]: unknown;
|
|
3168
|
+
};
|
|
3169
|
+
content: {
|
|
3170
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3171
|
+
};
|
|
3172
|
+
};
|
|
3173
|
+
/** @description The request cannot be carried out as given. */
|
|
3174
|
+
422: {
|
|
3175
|
+
headers: {
|
|
3176
|
+
[name: string]: unknown;
|
|
3177
|
+
};
|
|
3178
|
+
content: {
|
|
3179
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3180
|
+
};
|
|
3181
|
+
};
|
|
3182
|
+
/** @description The music workers are unavailable or timed out. */
|
|
3183
|
+
503: {
|
|
3184
|
+
headers: {
|
|
3185
|
+
[name: string]: unknown;
|
|
3186
|
+
};
|
|
3187
|
+
content: {
|
|
3188
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3189
|
+
};
|
|
3190
|
+
};
|
|
3191
|
+
};
|
|
3192
|
+
};
|
|
3193
|
+
/**
|
|
3194
|
+
* Set the loop mode
|
|
3195
|
+
* @description `track` repeats the current track. `queue` cycles the whole rotation, and keeps cycling when the rotation holds a single track. `off` stops after the queue runs out.
|
|
3196
|
+
*/
|
|
3197
|
+
put: {
|
|
3198
|
+
parameters: {
|
|
3199
|
+
query?: never;
|
|
3200
|
+
header?: never;
|
|
3201
|
+
path: {
|
|
3202
|
+
guildId: string;
|
|
3203
|
+
};
|
|
3204
|
+
cookie?: never;
|
|
3205
|
+
};
|
|
3206
|
+
requestBody: {
|
|
3207
|
+
content: {
|
|
3208
|
+
"application/json": {
|
|
3209
|
+
/**
|
|
3210
|
+
* @description `track` repeats the current track, `queue` cycles the whole rotation. `queue` keeps going even when the queue holds a single track.
|
|
3211
|
+
* @enum {string}
|
|
3212
|
+
*/
|
|
3213
|
+
mode: "off" | "track" | "queue";
|
|
3214
|
+
};
|
|
3215
|
+
};
|
|
3216
|
+
};
|
|
3217
|
+
responses: {
|
|
3218
|
+
/** @description The loop mode after the change. */
|
|
3219
|
+
200: {
|
|
3220
|
+
headers: {
|
|
3221
|
+
[name: string]: unknown;
|
|
3222
|
+
};
|
|
3223
|
+
content: {
|
|
3224
|
+
"application/json": {
|
|
3225
|
+
data: components["schemas"]["LoopResult"];
|
|
3226
|
+
};
|
|
3227
|
+
};
|
|
3228
|
+
};
|
|
3229
|
+
/** @description The API key is not linked to a bot. */
|
|
3230
|
+
403: {
|
|
3231
|
+
headers: {
|
|
3232
|
+
[name: string]: unknown;
|
|
3233
|
+
};
|
|
3234
|
+
content: {
|
|
3235
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3236
|
+
};
|
|
3237
|
+
};
|
|
3238
|
+
/** @description No player in that guild. */
|
|
3239
|
+
404: {
|
|
3240
|
+
headers: {
|
|
3241
|
+
[name: string]: unknown;
|
|
3242
|
+
};
|
|
3243
|
+
content: {
|
|
3244
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3245
|
+
};
|
|
3246
|
+
};
|
|
3247
|
+
/** @description Conflicts with the current player state. */
|
|
3248
|
+
409: {
|
|
3249
|
+
headers: {
|
|
3250
|
+
[name: string]: unknown;
|
|
3251
|
+
};
|
|
3252
|
+
content: {
|
|
3253
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3254
|
+
};
|
|
3255
|
+
};
|
|
3256
|
+
/** @description The request cannot be carried out as given. */
|
|
3257
|
+
422: {
|
|
3258
|
+
headers: {
|
|
3259
|
+
[name: string]: unknown;
|
|
3260
|
+
};
|
|
3261
|
+
content: {
|
|
3262
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3263
|
+
};
|
|
3264
|
+
};
|
|
3265
|
+
/** @description The music workers are unavailable or timed out. */
|
|
3266
|
+
503: {
|
|
3267
|
+
headers: {
|
|
3268
|
+
[name: string]: unknown;
|
|
3269
|
+
};
|
|
3270
|
+
content: {
|
|
3271
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3272
|
+
};
|
|
3273
|
+
};
|
|
3274
|
+
};
|
|
3275
|
+
};
|
|
3276
|
+
post?: never;
|
|
3277
|
+
delete?: never;
|
|
3278
|
+
options?: never;
|
|
3279
|
+
head?: never;
|
|
3280
|
+
patch?: never;
|
|
3281
|
+
trace?: never;
|
|
3282
|
+
};
|
|
3283
|
+
"/v1/music/search": {
|
|
3284
|
+
parameters: {
|
|
3285
|
+
query?: never;
|
|
3286
|
+
header?: never;
|
|
3287
|
+
path?: never;
|
|
3288
|
+
cookie?: never;
|
|
3289
|
+
};
|
|
3290
|
+
/**
|
|
3291
|
+
* Search for tracks
|
|
3292
|
+
* @description Looks for tracks without touching the player. Each result carries the `encoded` string that `POST /play` accepts, so a picker can search first and play exactly what was chosen.
|
|
3293
|
+
*/
|
|
3294
|
+
get: {
|
|
3295
|
+
parameters: {
|
|
3296
|
+
query: {
|
|
3297
|
+
query: string;
|
|
3298
|
+
/** @description How many results to return. */
|
|
3299
|
+
limit?: number;
|
|
3300
|
+
/** @description Which source to search on. */
|
|
3301
|
+
provider?: "youtube" | "spotify";
|
|
3302
|
+
};
|
|
3303
|
+
header?: never;
|
|
3304
|
+
path?: never;
|
|
3305
|
+
cookie?: never;
|
|
3306
|
+
};
|
|
3307
|
+
requestBody?: never;
|
|
3308
|
+
responses: {
|
|
3309
|
+
/** @description The tracks that matched. */
|
|
3310
|
+
200: {
|
|
3311
|
+
headers: {
|
|
3312
|
+
[name: string]: unknown;
|
|
3313
|
+
};
|
|
3314
|
+
content: {
|
|
3315
|
+
"application/json": {
|
|
3316
|
+
data: components["schemas"]["MusicSearchResult"];
|
|
3317
|
+
};
|
|
3318
|
+
};
|
|
3319
|
+
};
|
|
3320
|
+
/** @description The API key is not linked to a bot. */
|
|
3321
|
+
403: {
|
|
3322
|
+
headers: {
|
|
3323
|
+
[name: string]: unknown;
|
|
3324
|
+
};
|
|
3325
|
+
content: {
|
|
3326
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3327
|
+
};
|
|
3328
|
+
};
|
|
3329
|
+
/** @description No player in that guild. */
|
|
3330
|
+
404: {
|
|
3331
|
+
headers: {
|
|
3332
|
+
[name: string]: unknown;
|
|
3333
|
+
};
|
|
3334
|
+
content: {
|
|
3335
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3336
|
+
};
|
|
3337
|
+
};
|
|
3338
|
+
/** @description Conflicts with the current player state. */
|
|
3339
|
+
409: {
|
|
3340
|
+
headers: {
|
|
3341
|
+
[name: string]: unknown;
|
|
3342
|
+
};
|
|
3343
|
+
content: {
|
|
3344
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3345
|
+
};
|
|
3346
|
+
};
|
|
3347
|
+
/** @description The request cannot be carried out as given. */
|
|
3348
|
+
422: {
|
|
3349
|
+
headers: {
|
|
3350
|
+
[name: string]: unknown;
|
|
3351
|
+
};
|
|
3352
|
+
content: {
|
|
3353
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3354
|
+
};
|
|
3355
|
+
};
|
|
3356
|
+
/** @description The music workers are unavailable or timed out. */
|
|
3357
|
+
503: {
|
|
3358
|
+
headers: {
|
|
3359
|
+
[name: string]: unknown;
|
|
3360
|
+
};
|
|
3361
|
+
content: {
|
|
3362
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3363
|
+
};
|
|
3364
|
+
};
|
|
3365
|
+
};
|
|
3366
|
+
};
|
|
3367
|
+
put?: never;
|
|
3368
|
+
post?: never;
|
|
3369
|
+
delete?: never;
|
|
3370
|
+
options?: never;
|
|
3371
|
+
head?: never;
|
|
3372
|
+
patch?: never;
|
|
3373
|
+
trace?: never;
|
|
3374
|
+
};
|
|
3375
|
+
"/v1/status": {
|
|
3376
|
+
parameters: {
|
|
3377
|
+
query?: never;
|
|
3378
|
+
header?: never;
|
|
3379
|
+
path?: never;
|
|
3380
|
+
cookie?: never;
|
|
3381
|
+
};
|
|
3382
|
+
/** Check the status of the API */
|
|
3383
|
+
get: {
|
|
3384
|
+
parameters: {
|
|
3385
|
+
query?: never;
|
|
3386
|
+
header?: never;
|
|
3387
|
+
path?: never;
|
|
3388
|
+
cookie?: never;
|
|
3389
|
+
};
|
|
3390
|
+
requestBody?: never;
|
|
3391
|
+
responses: {
|
|
3392
|
+
/** @description OK */
|
|
3393
|
+
200: {
|
|
3394
|
+
headers: {
|
|
3395
|
+
[name: string]: unknown;
|
|
3396
|
+
};
|
|
3397
|
+
content: {
|
|
3398
|
+
"application/json": {
|
|
3399
|
+
/** @enum {string} */
|
|
3400
|
+
status: "ok" | "degraded" | "unhealthy";
|
|
3401
|
+
/** Format: date-time */
|
|
3402
|
+
timestamp: string;
|
|
3403
|
+
uptime: number;
|
|
3404
|
+
version: string;
|
|
3405
|
+
/** @enum {string} */
|
|
3406
|
+
environment: "development" | "staging" | "production";
|
|
3407
|
+
system?: {
|
|
3408
|
+
memory: {
|
|
3409
|
+
rssMb: number;
|
|
3410
|
+
heapUsedMb: number;
|
|
3411
|
+
heapTotalMb: number;
|
|
3412
|
+
};
|
|
3413
|
+
cpuLoadPercentage?: number;
|
|
3414
|
+
};
|
|
3415
|
+
};
|
|
3416
|
+
};
|
|
3417
|
+
};
|
|
3418
|
+
/** @description Not found */
|
|
3419
|
+
404: {
|
|
3420
|
+
headers: {
|
|
3421
|
+
[name: string]: unknown;
|
|
3422
|
+
};
|
|
3423
|
+
content: {
|
|
3424
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3425
|
+
};
|
|
3426
|
+
};
|
|
3427
|
+
};
|
|
3428
|
+
};
|
|
3429
|
+
put?: never;
|
|
3430
|
+
post?: never;
|
|
3431
|
+
delete?: never;
|
|
3432
|
+
options?: never;
|
|
3433
|
+
head?: never;
|
|
3434
|
+
patch?: never;
|
|
3435
|
+
trace?: never;
|
|
3436
|
+
};
|
|
3437
|
+
}
|
|
3438
|
+
export type webhooks = Record<string, never>;
|
|
3439
|
+
export interface components {
|
|
3440
|
+
schemas: {
|
|
3441
|
+
ErrorResponse: {
|
|
3442
|
+
error: {
|
|
3443
|
+
/** @enum {string} */
|
|
3444
|
+
code: "bad_request" | "unauthorized" | "invalid_api_key" | "api_key_revoked" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "validation_error" | "rate_limited" | "internal_error" | "service_unavailable";
|
|
3445
|
+
message: string;
|
|
3446
|
+
details?: unknown;
|
|
3447
|
+
};
|
|
3448
|
+
requestId?: string;
|
|
3449
|
+
};
|
|
3450
|
+
MinecraftPlayer: {
|
|
3451
|
+
success: boolean;
|
|
3452
|
+
data: {
|
|
3453
|
+
/**
|
|
3454
|
+
* @description The Java UUID, or the Floodgate UUID for a Bedrock player
|
|
3455
|
+
* @example 069a79f4-44e9-4726-a5be-fca90e38aaf5
|
|
3456
|
+
*/
|
|
3457
|
+
id: string;
|
|
3458
|
+
/**
|
|
3459
|
+
* @description The player name, with the Floodgate prefix for Bedrock
|
|
3460
|
+
* @example Notch
|
|
3461
|
+
*/
|
|
3462
|
+
name: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* @description Which edition the account is on
|
|
3465
|
+
* @enum {string}
|
|
3466
|
+
*/
|
|
3467
|
+
platform: "java" | "bedrock";
|
|
3468
|
+
/** @description Whether the player uses the 3 pixel wide Alex model */
|
|
3469
|
+
slim: boolean;
|
|
3470
|
+
/** @description When the skin last changed, if the source reports it */
|
|
3471
|
+
updatedAt: number | null;
|
|
3472
|
+
};
|
|
3473
|
+
};
|
|
3474
|
+
MinecraftTextures: {
|
|
3475
|
+
success: boolean;
|
|
3476
|
+
data: {
|
|
3477
|
+
/**
|
|
3478
|
+
* @description Direct link to the skin texture
|
|
3479
|
+
* @example https://textures.minecraft.net/texture/abc123
|
|
3480
|
+
*/
|
|
3481
|
+
skin: string | null;
|
|
3482
|
+
/** @description Direct link to the cape texture, if there is one */
|
|
3483
|
+
cape: string | null;
|
|
3484
|
+
/** @description Whether the player uses the Alex model */
|
|
3485
|
+
slim: boolean;
|
|
3486
|
+
/** @description Hash of the skin, when the source reports one */
|
|
3487
|
+
hash: string | null;
|
|
3488
|
+
/** @description When the skin last changed, if the source reports it */
|
|
3489
|
+
updatedAt: number | null;
|
|
3490
|
+
};
|
|
3491
|
+
};
|
|
3492
|
+
MinecraftRender: {
|
|
3493
|
+
success: boolean;
|
|
3494
|
+
data: {
|
|
3495
|
+
/**
|
|
3496
|
+
* Format: uuid
|
|
3497
|
+
* @description Poll this on the jobs routes for the result
|
|
3498
|
+
*/
|
|
3499
|
+
jobId: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* @description Always pending or processing here, since the render is queued
|
|
3502
|
+
* @enum {string}
|
|
3503
|
+
*/
|
|
3504
|
+
status: "pending" | "processing";
|
|
3505
|
+
/** @description The player or label the render was filed under */
|
|
3506
|
+
name: string;
|
|
3507
|
+
};
|
|
3508
|
+
};
|
|
3509
|
+
Translation: {
|
|
3510
|
+
code: string;
|
|
3511
|
+
language: string;
|
|
3512
|
+
name: string;
|
|
3513
|
+
description: string;
|
|
3514
|
+
};
|
|
3515
|
+
BookSummary: {
|
|
3516
|
+
name: string;
|
|
3517
|
+
chapterCount: number;
|
|
3518
|
+
};
|
|
3519
|
+
Verse: {
|
|
3520
|
+
chapter: number;
|
|
3521
|
+
verse: number;
|
|
3522
|
+
text: string;
|
|
3523
|
+
};
|
|
3524
|
+
SearchResult: {
|
|
3525
|
+
book: string;
|
|
3526
|
+
chapter: number;
|
|
3527
|
+
verse: number;
|
|
3528
|
+
text: string;
|
|
3529
|
+
};
|
|
3530
|
+
VerseResult: {
|
|
3531
|
+
reference: string;
|
|
3532
|
+
text: string;
|
|
3533
|
+
};
|
|
3534
|
+
BibleDataSummary: {
|
|
3535
|
+
language: string;
|
|
3536
|
+
type: string;
|
|
3537
|
+
bookCount: number;
|
|
3538
|
+
books: {
|
|
3539
|
+
name: string;
|
|
3540
|
+
chapterCount: number;
|
|
3541
|
+
totalVerses: number;
|
|
3542
|
+
}[];
|
|
3543
|
+
};
|
|
3544
|
+
JobResponse: {
|
|
3545
|
+
data: components["schemas"]["Job"];
|
|
3546
|
+
};
|
|
3547
|
+
Job: {
|
|
3548
|
+
id: string;
|
|
3549
|
+
type: string;
|
|
3550
|
+
/** @enum {string} */
|
|
3551
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
3552
|
+
payload?: unknown;
|
|
3553
|
+
result?: unknown;
|
|
3554
|
+
error?: string;
|
|
3555
|
+
createdAt: number;
|
|
3556
|
+
updatedAt: number;
|
|
3557
|
+
};
|
|
3558
|
+
PlayResult: {
|
|
3559
|
+
track: components["schemas"]["Track"];
|
|
3560
|
+
/** @description 0 when it started playing, otherwise its place in the queue. */
|
|
3561
|
+
position: number;
|
|
3562
|
+
/** @description How many tracks were added (a playlist adds many). */
|
|
3563
|
+
added: number;
|
|
3564
|
+
};
|
|
3565
|
+
Track: {
|
|
3566
|
+
title: string;
|
|
3567
|
+
author: string;
|
|
3568
|
+
lengthMs: number;
|
|
3569
|
+
uri: string | null;
|
|
3570
|
+
artworkUrl: string | null;
|
|
3571
|
+
isStream: boolean;
|
|
3572
|
+
};
|
|
3573
|
+
TrackRef: {
|
|
3574
|
+
encoded: string;
|
|
3575
|
+
};
|
|
3576
|
+
PausedResult: {
|
|
3577
|
+
paused: boolean;
|
|
3578
|
+
};
|
|
3579
|
+
SkipResult: {
|
|
3580
|
+
track: components["schemas"]["Track"] & unknown;
|
|
3581
|
+
};
|
|
3582
|
+
OkResult: {
|
|
3583
|
+
/** @enum {boolean} */
|
|
3584
|
+
ok: true;
|
|
3585
|
+
};
|
|
3586
|
+
RestartResult: {
|
|
3587
|
+
track: components["schemas"]["Track"];
|
|
3588
|
+
positionMs: number;
|
|
3589
|
+
};
|
|
3590
|
+
PlayerState: {
|
|
3591
|
+
channelId: string;
|
|
3592
|
+
paused: boolean;
|
|
3593
|
+
positionMs: number;
|
|
3594
|
+
volume: number;
|
|
3595
|
+
muted: boolean;
|
|
3596
|
+
/**
|
|
3597
|
+
* @description `track` repeats the current track, `queue` cycles the whole rotation. `queue` keeps going even when the queue holds a single track.
|
|
3598
|
+
* @enum {string}
|
|
3599
|
+
*/
|
|
3600
|
+
loop: "off" | "track" | "queue";
|
|
3601
|
+
current: components["schemas"]["Track"] & unknown;
|
|
3602
|
+
queue: components["schemas"]["Track"][];
|
|
3603
|
+
};
|
|
3604
|
+
ShuffleResult: {
|
|
3605
|
+
queue: components["schemas"]["Track"][];
|
|
3606
|
+
};
|
|
3607
|
+
ClearQueueResult: {
|
|
3608
|
+
cleared: number;
|
|
3609
|
+
};
|
|
3610
|
+
RemoveResult: {
|
|
3611
|
+
removed: components["schemas"]["Track"];
|
|
3612
|
+
queue: components["schemas"]["Track"][];
|
|
3613
|
+
};
|
|
3614
|
+
MoveResult: {
|
|
3615
|
+
moved: components["schemas"]["Track"];
|
|
3616
|
+
queue: components["schemas"]["Track"][];
|
|
3617
|
+
};
|
|
3618
|
+
VolumeResult: {
|
|
3619
|
+
volume: number;
|
|
3620
|
+
muted: boolean;
|
|
3621
|
+
};
|
|
3622
|
+
MuteResult: {
|
|
3623
|
+
muted: boolean;
|
|
3624
|
+
};
|
|
3625
|
+
SeekResult: {
|
|
3626
|
+
positionMs: number;
|
|
3627
|
+
};
|
|
3628
|
+
LoopResult: {
|
|
3629
|
+
/**
|
|
3630
|
+
* @description `track` repeats the current track, `queue` cycles the whole rotation. `queue` keeps going even when the queue holds a single track.
|
|
3631
|
+
* @enum {string}
|
|
3632
|
+
*/
|
|
3633
|
+
loop: "off" | "track" | "queue";
|
|
3634
|
+
};
|
|
3635
|
+
MusicSearchResult: {
|
|
3636
|
+
results: components["schemas"]["MusicSearchTrack"][];
|
|
3637
|
+
};
|
|
3638
|
+
MusicSearchTrack: components["schemas"]["Track"] & {
|
|
3639
|
+
encoded: string;
|
|
3640
|
+
};
|
|
3641
|
+
};
|
|
3642
|
+
responses: never;
|
|
3643
|
+
parameters: never;
|
|
3644
|
+
requestBodies: never;
|
|
3645
|
+
headers: never;
|
|
3646
|
+
pathItems: never;
|
|
3647
|
+
}
|
|
3648
|
+
export type $defs = Record<string, never>;
|
|
3649
|
+
export type operations = Record<string, never>;
|
|
3650
|
+
//# sourceMappingURL=schema.d.ts.map
|