txapi-sdk 1.0.0__py3-none-any.whl

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.
Files changed (18) hide show
  1. txapi/__init__.py +75 -0
  2. txapi/_client.py +364 -0
  3. txapi/_core.py +302 -0
  4. txapi/_endpoints.py +813 -0
  5. txapi/_errors.py +190 -0
  6. txapi/_generated.py +10599 -0
  7. txapi/_pagination.py +140 -0
  8. txapi/_protocols.py +41 -0
  9. txapi/_ratelimit.py +81 -0
  10. txapi/_version.py +7 -0
  11. txapi/live.py +632 -0
  12. txapi/py.typed +0 -0
  13. txapi/types.py +532 -0
  14. txapi/webhooks.py +137 -0
  15. txapi_sdk-1.0.0.dist-info/METADATA +537 -0
  16. txapi_sdk-1.0.0.dist-info/RECORD +18 -0
  17. txapi_sdk-1.0.0.dist-info/WHEEL +4 -0
  18. txapi_sdk-1.0.0.dist-info/licenses/LICENSE +21 -0
txapi/_endpoints.py ADDED
@@ -0,0 +1,813 @@
1
+ """Endpoint descriptors — GENERATED by ``scripts/generate.py`` from ``spec/endpoints.json``.
2
+
3
+ Do not edit by hand.
4
+ """
5
+
6
+ from __future__ import annotations
7
+
8
+ from ._core import EndpointSpec, FieldSpec
9
+
10
+ API_VERSION = "1.8.0"
11
+
12
+ ENDPOINTS: dict[str, EndpointSpec] = {
13
+ "account.me": EndpointSpec(
14
+ "account.me", "GET", "/api/v1/me", None, True, path_params=(), query=(), body=()
15
+ ),
16
+ "account.servers": EndpointSpec(
17
+ "account.servers", "GET", "/api/v1/servers", None, True, path_params=(), query=(), body=()
18
+ ),
19
+ "players.search": EndpointSpec(
20
+ "players.search",
21
+ "GET",
22
+ "/api/v1/players/search",
23
+ "players.read",
24
+ False,
25
+ path_params=(),
26
+ query=(
27
+ FieldSpec("query", "query", required=False, type="string"),
28
+ FieldSpec("sortBy", "sort_by", required=False, type="string"),
29
+ FieldSpec("order", "order", required=False, type="string"),
30
+ FieldSpec("filters", "filters", required=False, type="string"),
31
+ FieldSpec("offset", "offset", required=False, type="integer"),
32
+ FieldSpec("cursor", "cursor", required=False, type="string"),
33
+ ),
34
+ body=(),
35
+ ),
36
+ "players.online": EndpointSpec(
37
+ "players.online",
38
+ "GET",
39
+ "/api/v1/players/online",
40
+ "players.read",
41
+ False,
42
+ path_params=(),
43
+ query=(
44
+ FieldSpec("offset", "offset", required=False, type="integer"),
45
+ FieldSpec("cursor", "cursor", required=False, type="string"),
46
+ ),
47
+ body=(),
48
+ ),
49
+ "players.lookup": EndpointSpec(
50
+ "players.lookup",
51
+ "GET",
52
+ "/api/v1/players/lookup",
53
+ "players.read",
54
+ False,
55
+ path_params=(),
56
+ query=(
57
+ FieldSpec("identifier", "identifier", required=True, type="string"),
58
+ FieldSpec("offset", "offset", required=False, type="integer"),
59
+ FieldSpec("cursor", "cursor", required=False, type="string"),
60
+ ),
61
+ body=(),
62
+ ),
63
+ "players.info": EndpointSpec(
64
+ "players.info",
65
+ "GET",
66
+ "/api/v1/players/info",
67
+ "players.read",
68
+ False,
69
+ path_params=(),
70
+ query=(FieldSpec("identifier", "identifier", required=True, type="string"),),
71
+ body=(),
72
+ ),
73
+ "players.stats": EndpointSpec(
74
+ "players.stats",
75
+ "GET",
76
+ "/api/v1/players/stats",
77
+ "players.read",
78
+ False,
79
+ path_params=(),
80
+ query=(),
81
+ body=(),
82
+ ),
83
+ "players.warn": EndpointSpec(
84
+ "players.warn",
85
+ "POST",
86
+ "/api/v1/players/warn",
87
+ "players.write",
88
+ False,
89
+ path_params=(),
90
+ query=(),
91
+ body=(
92
+ FieldSpec("identifier", "identifier", required=True, type="string"),
93
+ FieldSpec("reason", "reason", required=True, type="string", max_length=512),
94
+ ),
95
+ ),
96
+ "players.ban": EndpointSpec(
97
+ "players.ban",
98
+ "POST",
99
+ "/api/v1/players/ban",
100
+ "players.write",
101
+ False,
102
+ path_params=(),
103
+ query=(),
104
+ body=(
105
+ FieldSpec("identifier", "identifier", required=True, type="string"),
106
+ FieldSpec("reason", "reason", required=True, type="string", max_length=512),
107
+ FieldSpec("durationHours", "duration_hours", required=False, type="integer"),
108
+ FieldSpec("discordBan", "discord_ban", required=False, type="boolean"),
109
+ ),
110
+ ),
111
+ "players.kick": EndpointSpec(
112
+ "players.kick",
113
+ "POST",
114
+ "/api/v1/players/kick",
115
+ "players.write",
116
+ False,
117
+ path_params=(),
118
+ query=(),
119
+ body=(
120
+ FieldSpec("identifier", "identifier", required=True, type="string"),
121
+ FieldSpec("reason", "reason", required=False, type="string", max_length=512),
122
+ ),
123
+ ),
124
+ "players.dm": EndpointSpec(
125
+ "players.dm",
126
+ "POST",
127
+ "/api/v1/players/dm",
128
+ "players.write",
129
+ False,
130
+ path_params=(),
131
+ query=(),
132
+ body=(
133
+ FieldSpec("identifier", "identifier", required=True, type="string"),
134
+ FieldSpec("message", "message", required=True, type="string", max_length=512),
135
+ ),
136
+ ),
137
+ "players.notes": EndpointSpec(
138
+ "players.notes",
139
+ "POST",
140
+ "/api/v1/players/notes",
141
+ "players.write",
142
+ False,
143
+ path_params=(),
144
+ query=(),
145
+ body=(
146
+ FieldSpec("identifier", "identifier", required=True, type="string"),
147
+ FieldSpec("note", "note", required=False, type="string", max_length=2000),
148
+ ),
149
+ ),
150
+ "players.whitelist": EndpointSpec(
151
+ "players.whitelist",
152
+ "POST",
153
+ "/api/v1/players/whitelist",
154
+ "players.write",
155
+ False,
156
+ path_params=(),
157
+ query=(),
158
+ body=(
159
+ FieldSpec("identifier", "identifier", required=True, type="string"),
160
+ FieldSpec("whitelisted", "whitelisted", required=True, type="boolean"),
161
+ ),
162
+ ),
163
+ "history.bans": EndpointSpec(
164
+ "history.bans",
165
+ "GET",
166
+ "/api/v1/history/bans",
167
+ "players.read",
168
+ False,
169
+ path_params=(),
170
+ query=(
171
+ FieldSpec("order", "order", required=False, type="string"),
172
+ FieldSpec("offset", "offset", required=False, type="integer"),
173
+ FieldSpec("cursor", "cursor", required=False, type="string"),
174
+ ),
175
+ body=(),
176
+ ),
177
+ "history.warns": EndpointSpec(
178
+ "history.warns",
179
+ "GET",
180
+ "/api/v1/history/warns",
181
+ "players.read",
182
+ False,
183
+ path_params=(),
184
+ query=(
185
+ FieldSpec("order", "order", required=False, type="string"),
186
+ FieldSpec("offset", "offset", required=False, type="integer"),
187
+ FieldSpec("cursor", "cursor", required=False, type="string"),
188
+ ),
189
+ body=(),
190
+ ),
191
+ "history.search": EndpointSpec(
192
+ "history.search",
193
+ "GET",
194
+ "/api/v1/history/search",
195
+ "players.read",
196
+ False,
197
+ path_params=(),
198
+ query=(
199
+ FieldSpec("type", "type", required=False, type="string"),
200
+ FieldSpec("admin", "admin", required=False, type="string"),
201
+ FieldSpec("searchType", "search_type", required=False, type="string"),
202
+ FieldSpec("search", "search", required=False, type="string"),
203
+ FieldSpec("order", "order", required=False, type="string"),
204
+ FieldSpec("offset", "offset", required=False, type="integer"),
205
+ FieldSpec("cursor", "cursor", required=False, type="string"),
206
+ ),
207
+ body=(),
208
+ ),
209
+ "history.ban-templates": EndpointSpec(
210
+ "history.ban-templates",
211
+ "GET",
212
+ "/api/v1/txadmin/ban-templates",
213
+ "players.read",
214
+ False,
215
+ path_params=(),
216
+ query=(),
217
+ body=(),
218
+ ),
219
+ "history.action": EndpointSpec(
220
+ "history.action",
221
+ "GET",
222
+ "/api/v1/history/action/{actionId}",
223
+ "players.read",
224
+ False,
225
+ path_params=(FieldSpec("actionId", "action_id", required=True, type="string"),),
226
+ query=(),
227
+ body=(),
228
+ ),
229
+ "history.stats": EndpointSpec(
230
+ "history.stats",
231
+ "GET",
232
+ "/api/v1/history/stats",
233
+ "players.read",
234
+ False,
235
+ path_params=(),
236
+ query=(),
237
+ body=(),
238
+ ),
239
+ "history.revoke": EndpointSpec(
240
+ "history.revoke",
241
+ "POST",
242
+ "/api/v1/history/revoke/{actionId}",
243
+ "players.write",
244
+ False,
245
+ path_params=(FieldSpec("actionId", "action_id", required=True, type="string"),),
246
+ query=(),
247
+ body=(
248
+ FieldSpec("reason", "reason", required=False, type="string", max_length=512),
249
+ FieldSpec("discordUnban", "discord_unban", required=False, type="boolean"),
250
+ ),
251
+ ),
252
+ "server.status": EndpointSpec(
253
+ "server.status",
254
+ "GET",
255
+ "/api/v1/server/status",
256
+ "server.control",
257
+ False,
258
+ path_params=(),
259
+ query=(),
260
+ body=(),
261
+ ),
262
+ "server.diagnostics": EndpointSpec(
263
+ "server.diagnostics",
264
+ "GET",
265
+ "/api/v1/server/diagnostics",
266
+ "server.control",
267
+ False,
268
+ path_params=(),
269
+ query=(),
270
+ body=(),
271
+ ),
272
+ "server.drops": EndpointSpec(
273
+ "server.drops",
274
+ "GET",
275
+ "/api/v1/server/drops",
276
+ "server.control",
277
+ False,
278
+ path_params=(),
279
+ query=(),
280
+ body=(),
281
+ ),
282
+ "server.performance": EndpointSpec(
283
+ "server.performance",
284
+ "GET",
285
+ "/api/v1/server/performance",
286
+ "server.control",
287
+ False,
288
+ path_params=(),
289
+ query=(FieldSpec("thread", "thread", required=False, type="string"),),
290
+ body=(),
291
+ ),
292
+ "server.restart": EndpointSpec(
293
+ "server.restart",
294
+ "POST",
295
+ "/api/v1/server/restart",
296
+ "server.control",
297
+ False,
298
+ path_params=(),
299
+ query=(),
300
+ body=(),
301
+ ),
302
+ "server.start": EndpointSpec(
303
+ "server.start",
304
+ "POST",
305
+ "/api/v1/server/start",
306
+ "server.control",
307
+ False,
308
+ path_params=(),
309
+ query=(),
310
+ body=(),
311
+ ),
312
+ "server.stop": EndpointSpec(
313
+ "server.stop",
314
+ "POST",
315
+ "/api/v1/server/stop",
316
+ "server.control",
317
+ False,
318
+ path_params=(),
319
+ query=(),
320
+ body=(),
321
+ ),
322
+ "server.schedule-restart": EndpointSpec(
323
+ "server.schedule-restart",
324
+ "POST",
325
+ "/api/v1/server/schedule-restart",
326
+ "server.control",
327
+ False,
328
+ path_params=(),
329
+ query=(),
330
+ body=(FieldSpec("time", "time", required=True, type="string"),),
331
+ ),
332
+ "server.skip-restart": EndpointSpec(
333
+ "server.skip-restart",
334
+ "POST",
335
+ "/api/v1/server/skip-restart",
336
+ "server.control",
337
+ False,
338
+ path_params=(),
339
+ query=(),
340
+ body=(FieldSpec("skip", "skip", required=True, type="boolean"),),
341
+ ),
342
+ "server.kickall": EndpointSpec(
343
+ "server.kickall",
344
+ "POST",
345
+ "/api/v1/server/kickall",
346
+ "server.control",
347
+ False,
348
+ path_params=(),
349
+ query=(),
350
+ body=(FieldSpec("reason", "reason", required=False, type="string", max_length=512),),
351
+ ),
352
+ "server.announcement": EndpointSpec(
353
+ "server.announcement",
354
+ "POST",
355
+ "/api/v1/server/announcement",
356
+ "server.control",
357
+ False,
358
+ path_params=(),
359
+ query=(),
360
+ body=(FieldSpec("message", "message", required=True, type="string", max_length=512),),
361
+ ),
362
+ "server.resource.start": EndpointSpec(
363
+ "server.resource.start",
364
+ "POST",
365
+ "/api/v1/server/resource/start",
366
+ "server.control",
367
+ False,
368
+ path_params=(),
369
+ query=(),
370
+ body=(FieldSpec("name", "name", required=True, type="string", max_length=128),),
371
+ ),
372
+ "server.resource.stop": EndpointSpec(
373
+ "server.resource.stop",
374
+ "POST",
375
+ "/api/v1/server/resource/stop",
376
+ "server.control",
377
+ False,
378
+ path_params=(),
379
+ query=(),
380
+ body=(FieldSpec("name", "name", required=True, type="string", max_length=128),),
381
+ ),
382
+ "server.resource.restart": EndpointSpec(
383
+ "server.resource.restart",
384
+ "POST",
385
+ "/api/v1/server/resource/restart",
386
+ "server.control",
387
+ False,
388
+ path_params=(),
389
+ query=(),
390
+ body=(FieldSpec("name", "name", required=True, type="string", max_length=128),),
391
+ ),
392
+ "server.resource.ensure": EndpointSpec(
393
+ "server.resource.ensure",
394
+ "POST",
395
+ "/api/v1/server/resource/ensure",
396
+ "server.control",
397
+ False,
398
+ path_params=(),
399
+ query=(),
400
+ body=(FieldSpec("name", "name", required=True, type="string", max_length=128),),
401
+ ),
402
+ "server.resource.refresh": EndpointSpec(
403
+ "server.resource.refresh",
404
+ "POST",
405
+ "/api/v1/server/resource/refresh",
406
+ "server.control",
407
+ False,
408
+ path_params=(),
409
+ query=(),
410
+ body=(),
411
+ ),
412
+ "console.buffer": EndpointSpec(
413
+ "console.buffer",
414
+ "GET",
415
+ "/api/v1/console",
416
+ "console.write",
417
+ False,
418
+ path_params=(),
419
+ query=(),
420
+ body=(),
421
+ ),
422
+ "console.command": EndpointSpec(
423
+ "console.command",
424
+ "POST",
425
+ "/api/v1/console/command",
426
+ "console.write",
427
+ False,
428
+ path_params=(),
429
+ query=(),
430
+ body=(FieldSpec("command", "command", required=True, type="string", max_length=1024),),
431
+ ),
432
+ "serverlog.buffer": EndpointSpec(
433
+ "serverlog.buffer",
434
+ "GET",
435
+ "/api/v1/server/log",
436
+ "logs.view",
437
+ False,
438
+ path_params=(),
439
+ query=(),
440
+ body=(),
441
+ ),
442
+ "serverlog.history": EndpointSpec(
443
+ "serverlog.history",
444
+ "GET",
445
+ "/api/v1/server/log/history",
446
+ "logs.view",
447
+ False,
448
+ path_params=(),
449
+ query=(
450
+ FieldSpec("direction", "direction", required=False, type="string"),
451
+ FieldSpec("ref", "ref", required=False, type="integer"),
452
+ ),
453
+ body=(),
454
+ ),
455
+ "events.list": EndpointSpec(
456
+ "events.list",
457
+ "GET",
458
+ "/api/v1/events",
459
+ "logs.view",
460
+ False,
461
+ path_params=(),
462
+ query=(
463
+ FieldSpec("type", "type", required=False, type="string"),
464
+ FieldSpec("player", "player", required=False, type="string"),
465
+ FieldSpec("search", "search", required=False, type="string"),
466
+ FieldSpec("since", "since", required=False, type="string"),
467
+ FieldSpec("until", "until", required=False, type="string"),
468
+ FieldSpec("cursor", "cursor", required=False, type="string"),
469
+ FieldSpec("limit", "limit", required=False, type="integer"),
470
+ ),
471
+ body=(),
472
+ ),
473
+ "events.deaths": EndpointSpec(
474
+ "events.deaths",
475
+ "GET",
476
+ "/api/v1/events/deaths",
477
+ "logs.view",
478
+ False,
479
+ path_params=(),
480
+ query=(
481
+ FieldSpec("player", "player", required=False, type="string"),
482
+ FieldSpec("victim", "victim", required=False, type="string"),
483
+ FieldSpec("killer", "killer", required=False, type="string"),
484
+ FieldSpec("cause", "cause", required=False, type="string"),
485
+ FieldSpec("pvp", "pvp", required=False, type="boolean"),
486
+ FieldSpec("since", "since", required=False, type="string"),
487
+ FieldSpec("until", "until", required=False, type="string"),
488
+ FieldSpec("cursor", "cursor", required=False, type="string"),
489
+ FieldSpec("limit", "limit", required=False, type="integer"),
490
+ ),
491
+ body=(),
492
+ ),
493
+ "events.kills": EndpointSpec(
494
+ "events.kills",
495
+ "GET",
496
+ "/api/v1/events/kills",
497
+ "logs.view",
498
+ False,
499
+ path_params=(),
500
+ query=(
501
+ FieldSpec("player", "player", required=False, type="string"),
502
+ FieldSpec("killer", "killer", required=False, type="string"),
503
+ FieldSpec("victim", "victim", required=False, type="string"),
504
+ FieldSpec("cause", "cause", required=False, type="string"),
505
+ FieldSpec("since", "since", required=False, type="string"),
506
+ FieldSpec("until", "until", required=False, type="string"),
507
+ FieldSpec("cursor", "cursor", required=False, type="string"),
508
+ FieldSpec("limit", "limit", required=False, type="integer"),
509
+ ),
510
+ body=(),
511
+ ),
512
+ "events.leaderboard": EndpointSpec(
513
+ "events.leaderboard",
514
+ "GET",
515
+ "/api/v1/events/leaderboard",
516
+ "logs.view",
517
+ False,
518
+ path_params=(),
519
+ query=(
520
+ FieldSpec("since", "since", required=False, type="string"),
521
+ FieldSpec("sort", "sort", required=False, type="string"),
522
+ FieldSpec("limit", "limit", required=False, type="integer"),
523
+ ),
524
+ body=(),
525
+ ),
526
+ "events.player": EndpointSpec(
527
+ "events.player",
528
+ "GET",
529
+ "/api/v1/events/player",
530
+ "logs.view",
531
+ False,
532
+ path_params=(),
533
+ query=(
534
+ FieldSpec("player", "player", required=True, type="string"),
535
+ FieldSpec("since", "since", required=False, type="string"),
536
+ ),
537
+ body=(),
538
+ ),
539
+ "events.summary": EndpointSpec(
540
+ "events.summary",
541
+ "GET",
542
+ "/api/v1/events/summary",
543
+ "logs.view",
544
+ False,
545
+ path_params=(),
546
+ query=(FieldSpec("since", "since", required=False, type="string"),),
547
+ body=(),
548
+ ),
549
+ "events.chat": EndpointSpec(
550
+ "events.chat",
551
+ "GET",
552
+ "/api/v1/events/chat",
553
+ "logs.view",
554
+ False,
555
+ path_params=(),
556
+ query=(
557
+ FieldSpec("player", "player", required=False, type="string"),
558
+ FieldSpec("search", "search", required=False, type="string"),
559
+ FieldSpec("since", "since", required=False, type="string"),
560
+ FieldSpec("until", "until", required=False, type="string"),
561
+ FieldSpec("cursor", "cursor", required=False, type="string"),
562
+ FieldSpec("limit", "limit", required=False, type="integer"),
563
+ ),
564
+ body=(),
565
+ ),
566
+ "events.commands": EndpointSpec(
567
+ "events.commands",
568
+ "GET",
569
+ "/api/v1/events/commands",
570
+ "logs.view",
571
+ False,
572
+ path_params=(),
573
+ query=(
574
+ FieldSpec("player", "player", required=False, type="string"),
575
+ FieldSpec("search", "search", required=False, type="string"),
576
+ FieldSpec("since", "since", required=False, type="string"),
577
+ FieldSpec("until", "until", required=False, type="string"),
578
+ FieldSpec("cursor", "cursor", required=False, type="string"),
579
+ FieldSpec("limit", "limit", required=False, type="integer"),
580
+ ),
581
+ body=(),
582
+ ),
583
+ "events.admin-actions": EndpointSpec(
584
+ "events.admin-actions",
585
+ "GET",
586
+ "/api/v1/events/admin-actions",
587
+ "logs.view",
588
+ False,
589
+ path_params=(),
590
+ query=(
591
+ FieldSpec("admin", "admin", required=False, type="string"),
592
+ FieldSpec("kind", "kind", required=False, type="string"),
593
+ FieldSpec("search", "search", required=False, type="string"),
594
+ FieldSpec("since", "since", required=False, type="string"),
595
+ FieldSpec("until", "until", required=False, type="string"),
596
+ FieldSpec("cursor", "cursor", required=False, type="string"),
597
+ FieldSpec("limit", "limit", required=False, type="integer"),
598
+ ),
599
+ body=(),
600
+ ),
601
+ "events.actions": EndpointSpec(
602
+ "events.actions",
603
+ "GET",
604
+ "/api/v1/events/actions",
605
+ "logs.view",
606
+ False,
607
+ path_params=(),
608
+ query=(
609
+ FieldSpec("type", "type", required=False, type="string"),
610
+ FieldSpec("player", "player", required=False, type="string"),
611
+ FieldSpec("admin", "admin", required=False, type="string"),
612
+ FieldSpec("revoked", "revoked", required=False, type="boolean"),
613
+ FieldSpec("since", "since", required=False, type="string"),
614
+ FieldSpec("until", "until", required=False, type="string"),
615
+ FieldSpec("cursor", "cursor", required=False, type="string"),
616
+ FieldSpec("limit", "limit", required=False, type="integer"),
617
+ ),
618
+ body=(),
619
+ ),
620
+ "events.sessions": EndpointSpec(
621
+ "events.sessions",
622
+ "GET",
623
+ "/api/v1/events/sessions",
624
+ "logs.view",
625
+ False,
626
+ path_params=(),
627
+ query=(
628
+ FieldSpec("player", "player", required=False, type="string"),
629
+ FieldSpec("since", "since", required=False, type="string"),
630
+ FieldSpec("until", "until", required=False, type="string"),
631
+ FieldSpec("cursor", "cursor", required=False, type="string"),
632
+ FieldSpec("limit", "limit", required=False, type="integer"),
633
+ ),
634
+ body=(),
635
+ ),
636
+ "events.playtime": EndpointSpec(
637
+ "events.playtime",
638
+ "GET",
639
+ "/api/v1/events/playtime",
640
+ "logs.view",
641
+ False,
642
+ path_params=(),
643
+ query=(
644
+ FieldSpec("since", "since", required=False, type="string"),
645
+ FieldSpec("player", "player", required=False, type="string"),
646
+ FieldSpec("limit", "limit", required=False, type="integer"),
647
+ ),
648
+ body=(),
649
+ ),
650
+ "events.activity": EndpointSpec(
651
+ "events.activity",
652
+ "GET",
653
+ "/api/v1/events/activity",
654
+ "logs.view",
655
+ False,
656
+ path_params=(),
657
+ query=(
658
+ FieldSpec("since", "since", required=False, type="string"),
659
+ FieldSpec("bucket", "bucket", required=False, type="string"),
660
+ FieldSpec("timeZone", "time_zone", required=False, type="string"),
661
+ ),
662
+ body=(),
663
+ ),
664
+ "events.action-log": EndpointSpec(
665
+ "events.action-log",
666
+ "GET",
667
+ "/api/v1/txadmin/action-log",
668
+ "logs.view",
669
+ False,
670
+ path_params=(),
671
+ query=(FieldSpec("lines", "lines", required=False, type="integer"),),
672
+ body=(),
673
+ ),
674
+ "whitelist.requests": EndpointSpec(
675
+ "whitelist.requests",
676
+ "GET",
677
+ "/api/v1/whitelist/requests",
678
+ "players.read",
679
+ False,
680
+ path_params=(),
681
+ query=(FieldSpec("page", "page", required=False, type="integer"),),
682
+ body=(),
683
+ ),
684
+ "whitelist.approve": EndpointSpec(
685
+ "whitelist.approve",
686
+ "POST",
687
+ "/api/v1/whitelist/requests/{requestId}/approve",
688
+ "players.write",
689
+ False,
690
+ path_params=(FieldSpec("requestId", "request_id", required=True, type="string"),),
691
+ query=(),
692
+ body=(),
693
+ ),
694
+ "whitelist.deny": EndpointSpec(
695
+ "whitelist.deny",
696
+ "POST",
697
+ "/api/v1/whitelist/requests/{requestId}/deny",
698
+ "players.write",
699
+ False,
700
+ path_params=(FieldSpec("requestId", "request_id", required=True, type="string"),),
701
+ query=(),
702
+ body=(),
703
+ ),
704
+ "whitelist.deny-all": EndpointSpec(
705
+ "whitelist.deny-all",
706
+ "POST",
707
+ "/api/v1/whitelist/requests/deny-all",
708
+ "players.write",
709
+ False,
710
+ path_params=(),
711
+ query=(),
712
+ body=(FieldSpec("before", "before", required=False, type="integer"),),
713
+ ),
714
+ "whitelist.approvals": EndpointSpec(
715
+ "whitelist.approvals",
716
+ "GET",
717
+ "/api/v1/whitelist/approvals",
718
+ "players.read",
719
+ False,
720
+ path_params=(),
721
+ query=(),
722
+ body=(),
723
+ ),
724
+ "whitelist.approvals.add": EndpointSpec(
725
+ "whitelist.approvals.add",
726
+ "POST",
727
+ "/api/v1/whitelist/approvals",
728
+ "players.write",
729
+ False,
730
+ path_params=(),
731
+ query=(),
732
+ body=(FieldSpec("identifier", "identifier", required=True, type="string"),),
733
+ ),
734
+ "whitelist.approvals.remove": EndpointSpec(
735
+ "whitelist.approvals.remove",
736
+ "DELETE",
737
+ "/api/v1/whitelist/approvals/{identifier}",
738
+ "players.write",
739
+ False,
740
+ path_params=(FieldSpec("identifier", "identifier", required=True, type="string"),),
741
+ query=(),
742
+ body=(),
743
+ ),
744
+ "admins.list": EndpointSpec(
745
+ "admins.list",
746
+ "GET",
747
+ "/api/v1/txadmin/admins",
748
+ "admin.manage",
749
+ False,
750
+ path_params=(),
751
+ query=(),
752
+ body=(),
753
+ ),
754
+ "admins.get": EndpointSpec(
755
+ "admins.get",
756
+ "GET",
757
+ "/api/v1/txadmin/admins/{name}",
758
+ "admin.manage",
759
+ False,
760
+ path_params=(FieldSpec("name", "name", required=True, type="string"),),
761
+ query=(),
762
+ body=(),
763
+ ),
764
+ "admins.permissions": EndpointSpec(
765
+ "admins.permissions",
766
+ "GET",
767
+ "/api/v1/txadmin/admins/available-permissions",
768
+ "admin.manage",
769
+ False,
770
+ path_params=(),
771
+ query=(),
772
+ body=(),
773
+ ),
774
+ "admins.add": EndpointSpec(
775
+ "admins.add",
776
+ "POST",
777
+ "/api/v1/txadmin/admins",
778
+ "admin.manage",
779
+ False,
780
+ path_params=(),
781
+ query=(),
782
+ body=(
783
+ FieldSpec("name", "name", required=True, type="string"),
784
+ FieldSpec("citizenfxId", "citizenfx_id", required=False, type="string"),
785
+ FieldSpec("discordId", "discord_id", required=False, type="string"),
786
+ FieldSpec("permissions", "permissions", required=True, type="string[]"),
787
+ ),
788
+ ),
789
+ "admins.edit": EndpointSpec(
790
+ "admins.edit",
791
+ "PUT",
792
+ "/api/v1/txadmin/admins/{name}",
793
+ "admin.manage",
794
+ False,
795
+ path_params=(FieldSpec("name", "name", required=True, type="string"),),
796
+ query=(),
797
+ body=(
798
+ FieldSpec("citizenfxId", "citizenfx_id", required=False, type="string"),
799
+ FieldSpec("discordId", "discord_id", required=False, type="string"),
800
+ FieldSpec("permissions", "permissions", required=False, type="string[]"),
801
+ ),
802
+ ),
803
+ "admins.delete": EndpointSpec(
804
+ "admins.delete",
805
+ "DELETE",
806
+ "/api/v1/txadmin/admins/{name}",
807
+ "admin.manage",
808
+ False,
809
+ path_params=(FieldSpec("name", "name", required=True, type="string"),),
810
+ query=(),
811
+ body=(),
812
+ ),
813
+ }