@rebornteam/reborn-api 2.5.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/.gitkeep +0 -0
- package/.openapi-generator/FILES +36 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +104 -0
- package/api.ts +2037 -0
- package/base.ts +62 -0
- package/common.ts +127 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +1144 -0
- package/dist/api.js +1594 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +139 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +1144 -0
- package/dist/esm/api.js +1567 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +34 -0
- package/dist/esm/common.js +126 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/AdminClientCredentialResponse.md +33 -0
- package/docs/AdminClientCredentialsApi.md +390 -0
- package/docs/AdminConnectionBypassResponse.md +27 -0
- package/docs/AdminConnectionsApi.md +135 -0
- package/docs/AdminDashboardApi.md +54 -0
- package/docs/AdminDashboardConnectionResponse.md +38 -0
- package/docs/AdminGetDashboardStats.md +24 -0
- package/docs/ApplyPunishmentRequest.md +31 -0
- package/docs/ApplyPunishmentResponse.md +33 -0
- package/docs/ClientCredentialRequest.md +23 -0
- package/docs/ConnectionApi.md +69 -0
- package/docs/ConnectionGetConnectionDetailsResponse.md +35 -0
- package/docs/CreateBypassRequest.md +23 -0
- package/docs/CreatePunishmentDraftRequest.md +29 -0
- package/docs/PlayerApi.md +62 -0
- package/docs/PlayerGetPlayerInformation.md +27 -0
- package/docs/PunishmentApi.md +347 -0
- package/docs/PunishmentDraftResponse.md +39 -0
- package/docs/PunishmentGetPunishmentResponse.md +33 -0
- package/docs/PunishmentSeveritiesResponse.md +21 -0
- package/docs/PunishmentSeveritiesResponsePunishmentTypeInfo.md +23 -0
- package/docs/PunishmentSeveritiesResponseSeverityInfo.md +23 -0
- package/docs/UpdateClientRequest.md +23 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,1144 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reborn API
|
|
3
|
+
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Cognito Bearer Token**: For admin endpoints requiring AWS Cognito authentication
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.5.1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* Client credential response
|
|
18
|
+
*/
|
|
19
|
+
export interface AdminClientCredentialResponse {
|
|
20
|
+
/**
|
|
21
|
+
* Unique identifier for the client credential
|
|
22
|
+
*/
|
|
23
|
+
'id'?: number;
|
|
24
|
+
/**
|
|
25
|
+
* Client ID used for authentication
|
|
26
|
+
*/
|
|
27
|
+
'clientId'?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Client secret (only returned on generation/rotation, null otherwise)
|
|
30
|
+
*/
|
|
31
|
+
'clientSecret'?: string | null;
|
|
32
|
+
/**
|
|
33
|
+
* Human-readable name for the client
|
|
34
|
+
*/
|
|
35
|
+
'name'?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Optional description of the client\'s purpose
|
|
38
|
+
*/
|
|
39
|
+
'description'?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Whether the client credential is currently enabled
|
|
42
|
+
*/
|
|
43
|
+
'enabled'?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Timestamp when the credential was created (ISO-8601 format)
|
|
46
|
+
*/
|
|
47
|
+
'createdAt'?: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Connection bypass response
|
|
51
|
+
*/
|
|
52
|
+
export interface AdminConnectionBypassResponse {
|
|
53
|
+
/**
|
|
54
|
+
* Unique identifier for the bypass
|
|
55
|
+
*/
|
|
56
|
+
'id'?: number;
|
|
57
|
+
/**
|
|
58
|
+
* IP address that is bypassed
|
|
59
|
+
*/
|
|
60
|
+
'ipAddress'?: string;
|
|
61
|
+
/**
|
|
62
|
+
* Timestamp when the bypass expires (ISO-8601 format)
|
|
63
|
+
*/
|
|
64
|
+
'expiresAt'?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Timestamp when the bypass was created (ISO-8601 format)
|
|
67
|
+
*/
|
|
68
|
+
'createdAt'?: string;
|
|
69
|
+
}
|
|
70
|
+
export interface AdminDashboardConnectionResponse {
|
|
71
|
+
'id': number;
|
|
72
|
+
'ipAddress': string;
|
|
73
|
+
'location': string;
|
|
74
|
+
'isVpn': boolean;
|
|
75
|
+
'isBypassed': boolean;
|
|
76
|
+
'bypassExpiresAt'?: string | null;
|
|
77
|
+
'playerUuid'?: string | null;
|
|
78
|
+
'lastSeen'?: string | null;
|
|
79
|
+
'percentPositive': number;
|
|
80
|
+
'numberOfChecks': number;
|
|
81
|
+
}
|
|
82
|
+
export interface AdminGetDashboardStats {
|
|
83
|
+
'totalPlayers': number;
|
|
84
|
+
'totalConnections': number;
|
|
85
|
+
'totalClients': number;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Request to apply a punishment to a player
|
|
89
|
+
*/
|
|
90
|
+
export interface ApplyPunishmentRequest {
|
|
91
|
+
/**
|
|
92
|
+
* Player UUID to punish
|
|
93
|
+
*/
|
|
94
|
+
'playerUuid': string;
|
|
95
|
+
/**
|
|
96
|
+
* Reason for the punishment
|
|
97
|
+
*/
|
|
98
|
+
'reason': string;
|
|
99
|
+
/**
|
|
100
|
+
* Type of punishment
|
|
101
|
+
*/
|
|
102
|
+
'type': string;
|
|
103
|
+
/**
|
|
104
|
+
* Severity level of the punishment (1-10)
|
|
105
|
+
*/
|
|
106
|
+
'severity': number;
|
|
107
|
+
/**
|
|
108
|
+
* Staff member applying the punishment
|
|
109
|
+
*/
|
|
110
|
+
'createdBy': string;
|
|
111
|
+
/**
|
|
112
|
+
* Duration of the punishment in seconds. Null means permanent.
|
|
113
|
+
*/
|
|
114
|
+
'durationSeconds'?: number | null;
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Response after applying a punishment
|
|
118
|
+
*/
|
|
119
|
+
export interface ApplyPunishmentResponse {
|
|
120
|
+
/**
|
|
121
|
+
* ID of the created punishment
|
|
122
|
+
*/
|
|
123
|
+
'punishmentId'?: number;
|
|
124
|
+
/**
|
|
125
|
+
* Player UUID punished
|
|
126
|
+
*/
|
|
127
|
+
'playerUuid'?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Type of punishment applied
|
|
130
|
+
*/
|
|
131
|
+
'type'?: string;
|
|
132
|
+
/**
|
|
133
|
+
* Severity level (1-10)
|
|
134
|
+
*/
|
|
135
|
+
'severity'?: number;
|
|
136
|
+
/**
|
|
137
|
+
* New total punishment score after applying
|
|
138
|
+
*/
|
|
139
|
+
'newScore'?: number;
|
|
140
|
+
/**
|
|
141
|
+
* Whether this punishment is permanent
|
|
142
|
+
*/
|
|
143
|
+
'isPermanent'?: boolean;
|
|
144
|
+
/**
|
|
145
|
+
* Timestamp when punishment expires (ISO-8601 format, null if permanent)
|
|
146
|
+
*/
|
|
147
|
+
'expiresAt'?: string;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* Request to create new client credentials
|
|
151
|
+
*/
|
|
152
|
+
export interface ClientCredentialRequest {
|
|
153
|
+
/**
|
|
154
|
+
* Human-readable name for the client
|
|
155
|
+
*/
|
|
156
|
+
'name': string;
|
|
157
|
+
/**
|
|
158
|
+
* Optional description of the client\'s purpose
|
|
159
|
+
*/
|
|
160
|
+
'description'?: string;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Comprehensive connection analysis response including VPN detection, geolocation, bypass status, and optional player information
|
|
164
|
+
*/
|
|
165
|
+
export interface ConnectionGetConnectionDetailsResponse {
|
|
166
|
+
/**
|
|
167
|
+
* The analyzed IPv4 address
|
|
168
|
+
*/
|
|
169
|
+
'ipAddress'?: string;
|
|
170
|
+
/**
|
|
171
|
+
* Approximate geographic location of the IP address, typically in \'City, Country\' format. Returns \'Local, N/A\' for localhost or private IPs.
|
|
172
|
+
*/
|
|
173
|
+
'approximateLocation'?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Confidence score representing the percentage of VPN detection services that flagged this IP as suspicious. Range: 0.0 (clean) to 100.0 (definitely VPN/proxy). Values above 50.0 suggest high probability of VPN usage.
|
|
176
|
+
*/
|
|
177
|
+
'percentPositive'?: number;
|
|
178
|
+
/**
|
|
179
|
+
* Total number of VPN detection services successfully queried during the last check. Higher numbers indicate more comprehensive analysis.
|
|
180
|
+
*/
|
|
181
|
+
'numberOfChecks'?: number;
|
|
182
|
+
'bypassed'?: boolean;
|
|
183
|
+
/**
|
|
184
|
+
* Expiration timestamp for the bypass (ISO-8601 format). After this time, normal VPN detection rules will apply again. Null if not bypassed or bypass is permanent.
|
|
185
|
+
*/
|
|
186
|
+
'bypassedUntil'?: string | null;
|
|
187
|
+
/**
|
|
188
|
+
* Player information associated with this connection. Only populated when \'associate_uuid\' query parameter is provided. Contains first join status and login history.
|
|
189
|
+
*/
|
|
190
|
+
'playerInformation'?: PlayerGetPlayerInformation | null;
|
|
191
|
+
/**
|
|
192
|
+
* Combined list of active punishments for both the IP address and player UUID (if provided). Only includes non-expired punishments.
|
|
193
|
+
*/
|
|
194
|
+
'punishments'?: Array<PunishmentGetPunishmentResponse>;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Request to create a connection bypass
|
|
198
|
+
*/
|
|
199
|
+
export interface CreateBypassRequest {
|
|
200
|
+
/**
|
|
201
|
+
* IP address to bypass
|
|
202
|
+
*/
|
|
203
|
+
'ipAddress': string;
|
|
204
|
+
/**
|
|
205
|
+
* Unix epoch timestamp (seconds) when the bypass should expire
|
|
206
|
+
*/
|
|
207
|
+
'expiresAtEpoch': number;
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Request to create a punishment draft for preview before applying
|
|
211
|
+
*/
|
|
212
|
+
export interface CreatePunishmentDraftRequest {
|
|
213
|
+
/**
|
|
214
|
+
* Player UUID to punish
|
|
215
|
+
*/
|
|
216
|
+
'playerUuid': string;
|
|
217
|
+
/**
|
|
218
|
+
* Reason for the punishment
|
|
219
|
+
*/
|
|
220
|
+
'reason': string;
|
|
221
|
+
/**
|
|
222
|
+
* Type of punishment
|
|
223
|
+
*/
|
|
224
|
+
'type': string;
|
|
225
|
+
/**
|
|
226
|
+
* Severity level of the punishment (1-10)
|
|
227
|
+
*/
|
|
228
|
+
'severity': number;
|
|
229
|
+
/**
|
|
230
|
+
* Duration of the punishment in seconds. Null means permanent.
|
|
231
|
+
*/
|
|
232
|
+
'durationSeconds'?: number | null;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Player information including join history, tracking data, and punishment scoring
|
|
236
|
+
*/
|
|
237
|
+
export interface PlayerGetPlayerInformation {
|
|
238
|
+
/**
|
|
239
|
+
* Timestamp of when the player first connected to the server (ISO-8601 format).
|
|
240
|
+
*/
|
|
241
|
+
'firstLogin'?: string;
|
|
242
|
+
/**
|
|
243
|
+
* Indicates whether this is the player\'s first time joining the server. Useful for triggering welcome messages, tutorials, or first-join rewards.
|
|
244
|
+
*/
|
|
245
|
+
'firstJoin'?: boolean;
|
|
246
|
+
/**
|
|
247
|
+
* Raw punishment score calculated as: SUM((base_weight × severity/10)) where base_weight is 0.10 for WARNING, 0.30 for MUTE, 0.50 for BAN. Severity ranges 1-10. Used for tracking overall punishment severity.
|
|
248
|
+
*/
|
|
249
|
+
'punishmentPointsRaw'?: number;
|
|
250
|
+
/**
|
|
251
|
+
* Punishment score as a percentage (0-100). When this score is >100% BEFORE applying a new punishment, the new punishment should be made permanent. Check this value BEFORE issuing punishment, not after. Calculated as raw_score × 100.
|
|
252
|
+
*/
|
|
253
|
+
'punishmentPointsPercent'?: number;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Response containing punishment draft preview with calculated points and thresholds
|
|
257
|
+
*/
|
|
258
|
+
export interface PunishmentDraftResponse {
|
|
259
|
+
/**
|
|
260
|
+
* Player UUID this punishment would apply to
|
|
261
|
+
*/
|
|
262
|
+
'playerUuid'?: string;
|
|
263
|
+
/**
|
|
264
|
+
* Reason for the punishment
|
|
265
|
+
*/
|
|
266
|
+
'reason'?: string;
|
|
267
|
+
/**
|
|
268
|
+
* Type of punishment
|
|
269
|
+
*/
|
|
270
|
+
'type'?: string;
|
|
271
|
+
/**
|
|
272
|
+
* Severity level (1-10)
|
|
273
|
+
*/
|
|
274
|
+
'severity'?: number;
|
|
275
|
+
/**
|
|
276
|
+
* Current total punishment score before applying this punishment
|
|
277
|
+
*/
|
|
278
|
+
'currentScore'?: number;
|
|
279
|
+
/**
|
|
280
|
+
* Points this punishment would add
|
|
281
|
+
*/
|
|
282
|
+
'pointsToAdd'?: number;
|
|
283
|
+
/**
|
|
284
|
+
* New total score after applying this punishment
|
|
285
|
+
*/
|
|
286
|
+
'newScore'?: number;
|
|
287
|
+
/**
|
|
288
|
+
* Whether this punishment will be permanent
|
|
289
|
+
*/
|
|
290
|
+
'willBePermanent'?: boolean;
|
|
291
|
+
/**
|
|
292
|
+
* Duration in seconds (null if permanent)
|
|
293
|
+
*/
|
|
294
|
+
'durationSeconds'?: number;
|
|
295
|
+
/**
|
|
296
|
+
* Number of previous punishments for this player
|
|
297
|
+
*/
|
|
298
|
+
'previousPunishmentCount'?: number;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Punishment information including reason, type, creator, and expiration
|
|
302
|
+
*/
|
|
303
|
+
export interface PunishmentGetPunishmentResponse {
|
|
304
|
+
/**
|
|
305
|
+
* Unique identifier for the punishment
|
|
306
|
+
*/
|
|
307
|
+
'id'?: number;
|
|
308
|
+
/**
|
|
309
|
+
* Reason for the punishment
|
|
310
|
+
*/
|
|
311
|
+
'reason'?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Type of punishment (e.g., BAN, MUTE, KICK, WARNING)
|
|
314
|
+
*/
|
|
315
|
+
'type'?: string;
|
|
316
|
+
/**
|
|
317
|
+
* Severity level of the punishment (1-10, where 10 is most severe)
|
|
318
|
+
*/
|
|
319
|
+
'severity'?: number;
|
|
320
|
+
/**
|
|
321
|
+
* Username or identifier of the person who created this punishment
|
|
322
|
+
*/
|
|
323
|
+
'createdBy'?: string;
|
|
324
|
+
/**
|
|
325
|
+
* Timestamp when the punishment expires (ISO-8601 format). Null for permanent punishments.
|
|
326
|
+
*/
|
|
327
|
+
'expiresAt'?: string | null;
|
|
328
|
+
/**
|
|
329
|
+
* Timestamp when the punishment was created (ISO-8601 format)
|
|
330
|
+
*/
|
|
331
|
+
'createdAt'?: string;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* Response containing punishment severity durations for each type
|
|
335
|
+
*/
|
|
336
|
+
export interface PunishmentSeveritiesResponse {
|
|
337
|
+
/**
|
|
338
|
+
* List of punishment types with their severity durations
|
|
339
|
+
*/
|
|
340
|
+
'punishmentTypes'?: Array<PunishmentSeveritiesResponsePunishmentTypeInfo>;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Punishment type with severity information
|
|
344
|
+
*/
|
|
345
|
+
export interface PunishmentSeveritiesResponsePunishmentTypeInfo {
|
|
346
|
+
/**
|
|
347
|
+
* Type of punishment
|
|
348
|
+
*/
|
|
349
|
+
'type'?: string;
|
|
350
|
+
/**
|
|
351
|
+
* List of severity levels with durations
|
|
352
|
+
*/
|
|
353
|
+
'severities'?: Array<PunishmentSeveritiesResponseSeverityInfo>;
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Severity level with duration information
|
|
357
|
+
*/
|
|
358
|
+
export interface PunishmentSeveritiesResponseSeverityInfo {
|
|
359
|
+
/**
|
|
360
|
+
* Severity level
|
|
361
|
+
*/
|
|
362
|
+
'severity'?: number;
|
|
363
|
+
/**
|
|
364
|
+
* Duration in seconds (0 means no duration)
|
|
365
|
+
*/
|
|
366
|
+
'durationSeconds'?: number;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* Request to update client metadata
|
|
370
|
+
*/
|
|
371
|
+
export interface UpdateClientRequest {
|
|
372
|
+
/**
|
|
373
|
+
* Human-readable name for the client
|
|
374
|
+
*/
|
|
375
|
+
'name'?: string;
|
|
376
|
+
/**
|
|
377
|
+
* Optional description of the client\'s purpose
|
|
378
|
+
*/
|
|
379
|
+
'description'?: string;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* AdminClientCredentialsApi - axios parameter creator
|
|
383
|
+
*/
|
|
384
|
+
export declare const AdminClientCredentialsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
385
|
+
/**
|
|
386
|
+
* Temporarily disables a client credential, preventing authentication. Can be re-enabled later.
|
|
387
|
+
* @summary Disable client credentials
|
|
388
|
+
* @param {number} id Client credential ID
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
disableClient: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
393
|
+
/**
|
|
394
|
+
* Re-enables a previously disabled client credential, allowing authentication.
|
|
395
|
+
* @summary Enable client credentials
|
|
396
|
+
* @param {number} id Client credential ID
|
|
397
|
+
* @param {*} [options] Override http request option.
|
|
398
|
+
* @throws {RequiredError}
|
|
399
|
+
*/
|
|
400
|
+
enableClient: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
401
|
+
/**
|
|
402
|
+
* Creates a new API client with credentials for authentication. Returns the client ID and secret (only shown once).
|
|
403
|
+
* @summary Generate new client credentials
|
|
404
|
+
* @param {ClientCredentialRequest} clientCredentialRequest
|
|
405
|
+
* @param {*} [options] Override http request option.
|
|
406
|
+
* @throws {RequiredError}
|
|
407
|
+
*/
|
|
408
|
+
generateClientCredentials: (clientCredentialRequest: ClientCredentialRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
409
|
+
/**
|
|
410
|
+
* Returns all client credentials. **Client secrets are never returned** from this endpoint.
|
|
411
|
+
* @summary List client credentials
|
|
412
|
+
* @param {*} [options] Override http request option.
|
|
413
|
+
* @throws {RequiredError}
|
|
414
|
+
*/
|
|
415
|
+
listClients: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
416
|
+
/**
|
|
417
|
+
* Permanently deletes a client credential from the database, revoking all access.
|
|
418
|
+
* @summary Revoke client credentials
|
|
419
|
+
* @param {number} id Client credential ID
|
|
420
|
+
* @param {*} [options] Override http request option.
|
|
421
|
+
* @throws {RequiredError}
|
|
422
|
+
*/
|
|
423
|
+
revokeToken: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
424
|
+
/**
|
|
425
|
+
* Generates new client ID and secret for an existing client. The old credentials will no longer work. Returns the new credentials (secret only shown once).
|
|
426
|
+
* @summary Rotate client credentials
|
|
427
|
+
* @param {number} id Client credential ID
|
|
428
|
+
* @param {*} [options] Override http request option.
|
|
429
|
+
* @throws {RequiredError}
|
|
430
|
+
*/
|
|
431
|
+
rotateToken: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
432
|
+
/**
|
|
433
|
+
* Updates the name and/or description of a client credential. Does not affect the actual credentials.
|
|
434
|
+
* @summary Update client metadata
|
|
435
|
+
* @param {number} id Client credential ID
|
|
436
|
+
* @param {UpdateClientRequest} updateClientRequest
|
|
437
|
+
* @param {*} [options] Override http request option.
|
|
438
|
+
* @throws {RequiredError}
|
|
439
|
+
*/
|
|
440
|
+
updateClient: (id: number, updateClientRequest: UpdateClientRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
441
|
+
};
|
|
442
|
+
/**
|
|
443
|
+
* AdminClientCredentialsApi - functional programming interface
|
|
444
|
+
*/
|
|
445
|
+
export declare const AdminClientCredentialsApiFp: (configuration?: Configuration) => {
|
|
446
|
+
/**
|
|
447
|
+
* Temporarily disables a client credential, preventing authentication. Can be re-enabled later.
|
|
448
|
+
* @summary Disable client credentials
|
|
449
|
+
* @param {number} id Client credential ID
|
|
450
|
+
* @param {*} [options] Override http request option.
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
*/
|
|
453
|
+
disableClient(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
454
|
+
/**
|
|
455
|
+
* Re-enables a previously disabled client credential, allowing authentication.
|
|
456
|
+
* @summary Enable client credentials
|
|
457
|
+
* @param {number} id Client credential ID
|
|
458
|
+
* @param {*} [options] Override http request option.
|
|
459
|
+
* @throws {RequiredError}
|
|
460
|
+
*/
|
|
461
|
+
enableClient(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
462
|
+
/**
|
|
463
|
+
* Creates a new API client with credentials for authentication. Returns the client ID and secret (only shown once).
|
|
464
|
+
* @summary Generate new client credentials
|
|
465
|
+
* @param {ClientCredentialRequest} clientCredentialRequest
|
|
466
|
+
* @param {*} [options] Override http request option.
|
|
467
|
+
* @throws {RequiredError}
|
|
468
|
+
*/
|
|
469
|
+
generateClientCredentials(clientCredentialRequest: ClientCredentialRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminClientCredentialResponse>>;
|
|
470
|
+
/**
|
|
471
|
+
* Returns all client credentials. **Client secrets are never returned** from this endpoint.
|
|
472
|
+
* @summary List client credentials
|
|
473
|
+
* @param {*} [options] Override http request option.
|
|
474
|
+
* @throws {RequiredError}
|
|
475
|
+
*/
|
|
476
|
+
listClients(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminClientCredentialResponse>>>;
|
|
477
|
+
/**
|
|
478
|
+
* Permanently deletes a client credential from the database, revoking all access.
|
|
479
|
+
* @summary Revoke client credentials
|
|
480
|
+
* @param {number} id Client credential ID
|
|
481
|
+
* @param {*} [options] Override http request option.
|
|
482
|
+
* @throws {RequiredError}
|
|
483
|
+
*/
|
|
484
|
+
revokeToken(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
485
|
+
/**
|
|
486
|
+
* Generates new client ID and secret for an existing client. The old credentials will no longer work. Returns the new credentials (secret only shown once).
|
|
487
|
+
* @summary Rotate client credentials
|
|
488
|
+
* @param {number} id Client credential ID
|
|
489
|
+
* @param {*} [options] Override http request option.
|
|
490
|
+
* @throws {RequiredError}
|
|
491
|
+
*/
|
|
492
|
+
rotateToken(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminClientCredentialResponse>>;
|
|
493
|
+
/**
|
|
494
|
+
* Updates the name and/or description of a client credential. Does not affect the actual credentials.
|
|
495
|
+
* @summary Update client metadata
|
|
496
|
+
* @param {number} id Client credential ID
|
|
497
|
+
* @param {UpdateClientRequest} updateClientRequest
|
|
498
|
+
* @param {*} [options] Override http request option.
|
|
499
|
+
* @throws {RequiredError}
|
|
500
|
+
*/
|
|
501
|
+
updateClient(id: number, updateClientRequest: UpdateClientRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminClientCredentialResponse>>;
|
|
502
|
+
};
|
|
503
|
+
/**
|
|
504
|
+
* AdminClientCredentialsApi - factory interface
|
|
505
|
+
*/
|
|
506
|
+
export declare const AdminClientCredentialsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
507
|
+
/**
|
|
508
|
+
* Temporarily disables a client credential, preventing authentication. Can be re-enabled later.
|
|
509
|
+
* @summary Disable client credentials
|
|
510
|
+
* @param {number} id Client credential ID
|
|
511
|
+
* @param {*} [options] Override http request option.
|
|
512
|
+
* @throws {RequiredError}
|
|
513
|
+
*/
|
|
514
|
+
disableClient(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
515
|
+
/**
|
|
516
|
+
* Re-enables a previously disabled client credential, allowing authentication.
|
|
517
|
+
* @summary Enable client credentials
|
|
518
|
+
* @param {number} id Client credential ID
|
|
519
|
+
* @param {*} [options] Override http request option.
|
|
520
|
+
* @throws {RequiredError}
|
|
521
|
+
*/
|
|
522
|
+
enableClient(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
523
|
+
/**
|
|
524
|
+
* Creates a new API client with credentials for authentication. Returns the client ID and secret (only shown once).
|
|
525
|
+
* @summary Generate new client credentials
|
|
526
|
+
* @param {ClientCredentialRequest} clientCredentialRequest
|
|
527
|
+
* @param {*} [options] Override http request option.
|
|
528
|
+
* @throws {RequiredError}
|
|
529
|
+
*/
|
|
530
|
+
generateClientCredentials(clientCredentialRequest: ClientCredentialRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientCredentialResponse>;
|
|
531
|
+
/**
|
|
532
|
+
* Returns all client credentials. **Client secrets are never returned** from this endpoint.
|
|
533
|
+
* @summary List client credentials
|
|
534
|
+
* @param {*} [options] Override http request option.
|
|
535
|
+
* @throws {RequiredError}
|
|
536
|
+
*/
|
|
537
|
+
listClients(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminClientCredentialResponse>>;
|
|
538
|
+
/**
|
|
539
|
+
* Permanently deletes a client credential from the database, revoking all access.
|
|
540
|
+
* @summary Revoke client credentials
|
|
541
|
+
* @param {number} id Client credential ID
|
|
542
|
+
* @param {*} [options] Override http request option.
|
|
543
|
+
* @throws {RequiredError}
|
|
544
|
+
*/
|
|
545
|
+
revokeToken(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
546
|
+
/**
|
|
547
|
+
* Generates new client ID and secret for an existing client. The old credentials will no longer work. Returns the new credentials (secret only shown once).
|
|
548
|
+
* @summary Rotate client credentials
|
|
549
|
+
* @param {number} id Client credential ID
|
|
550
|
+
* @param {*} [options] Override http request option.
|
|
551
|
+
* @throws {RequiredError}
|
|
552
|
+
*/
|
|
553
|
+
rotateToken(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientCredentialResponse>;
|
|
554
|
+
/**
|
|
555
|
+
* Updates the name and/or description of a client credential. Does not affect the actual credentials.
|
|
556
|
+
* @summary Update client metadata
|
|
557
|
+
* @param {number} id Client credential ID
|
|
558
|
+
* @param {UpdateClientRequest} updateClientRequest
|
|
559
|
+
* @param {*} [options] Override http request option.
|
|
560
|
+
* @throws {RequiredError}
|
|
561
|
+
*/
|
|
562
|
+
updateClient(id: number, updateClientRequest: UpdateClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientCredentialResponse>;
|
|
563
|
+
};
|
|
564
|
+
/**
|
|
565
|
+
* AdminClientCredentialsApi - object-oriented interface
|
|
566
|
+
*/
|
|
567
|
+
export declare class AdminClientCredentialsApi extends BaseAPI {
|
|
568
|
+
/**
|
|
569
|
+
* Temporarily disables a client credential, preventing authentication. Can be re-enabled later.
|
|
570
|
+
* @summary Disable client credentials
|
|
571
|
+
* @param {number} id Client credential ID
|
|
572
|
+
* @param {*} [options] Override http request option.
|
|
573
|
+
* @throws {RequiredError}
|
|
574
|
+
*/
|
|
575
|
+
disableClient(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
576
|
+
/**
|
|
577
|
+
* Re-enables a previously disabled client credential, allowing authentication.
|
|
578
|
+
* @summary Enable client credentials
|
|
579
|
+
* @param {number} id Client credential ID
|
|
580
|
+
* @param {*} [options] Override http request option.
|
|
581
|
+
* @throws {RequiredError}
|
|
582
|
+
*/
|
|
583
|
+
enableClient(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
584
|
+
/**
|
|
585
|
+
* Creates a new API client with credentials for authentication. Returns the client ID and secret (only shown once).
|
|
586
|
+
* @summary Generate new client credentials
|
|
587
|
+
* @param {ClientCredentialRequest} clientCredentialRequest
|
|
588
|
+
* @param {*} [options] Override http request option.
|
|
589
|
+
* @throws {RequiredError}
|
|
590
|
+
*/
|
|
591
|
+
generateClientCredentials(clientCredentialRequest: ClientCredentialRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminClientCredentialResponse, any, {}>>;
|
|
592
|
+
/**
|
|
593
|
+
* Returns all client credentials. **Client secrets are never returned** from this endpoint.
|
|
594
|
+
* @summary List client credentials
|
|
595
|
+
* @param {*} [options] Override http request option.
|
|
596
|
+
* @throws {RequiredError}
|
|
597
|
+
*/
|
|
598
|
+
listClients(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminClientCredentialResponse[], any, {}>>;
|
|
599
|
+
/**
|
|
600
|
+
* Permanently deletes a client credential from the database, revoking all access.
|
|
601
|
+
* @summary Revoke client credentials
|
|
602
|
+
* @param {number} id Client credential ID
|
|
603
|
+
* @param {*} [options] Override http request option.
|
|
604
|
+
* @throws {RequiredError}
|
|
605
|
+
*/
|
|
606
|
+
revokeToken(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
607
|
+
/**
|
|
608
|
+
* Generates new client ID and secret for an existing client. The old credentials will no longer work. Returns the new credentials (secret only shown once).
|
|
609
|
+
* @summary Rotate client credentials
|
|
610
|
+
* @param {number} id Client credential ID
|
|
611
|
+
* @param {*} [options] Override http request option.
|
|
612
|
+
* @throws {RequiredError}
|
|
613
|
+
*/
|
|
614
|
+
rotateToken(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminClientCredentialResponse, any, {}>>;
|
|
615
|
+
/**
|
|
616
|
+
* Updates the name and/or description of a client credential. Does not affect the actual credentials.
|
|
617
|
+
* @summary Update client metadata
|
|
618
|
+
* @param {number} id Client credential ID
|
|
619
|
+
* @param {UpdateClientRequest} updateClientRequest
|
|
620
|
+
* @param {*} [options] Override http request option.
|
|
621
|
+
* @throws {RequiredError}
|
|
622
|
+
*/
|
|
623
|
+
updateClient(id: number, updateClientRequest: UpdateClientRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminClientCredentialResponse, any, {}>>;
|
|
624
|
+
}
|
|
625
|
+
/**
|
|
626
|
+
* AdminConnectionsApi - axios parameter creator
|
|
627
|
+
*/
|
|
628
|
+
export declare const AdminConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
629
|
+
/**
|
|
630
|
+
* Creates a temporary bypass for an IP address, expiring at the specified epoch timestamp (milliseconds since Unix epoch).
|
|
631
|
+
* @summary Create connection bypass
|
|
632
|
+
* @param {CreateBypassRequest} createBypassRequest
|
|
633
|
+
* @param {*} [options] Override http request option.
|
|
634
|
+
* @throws {RequiredError}
|
|
635
|
+
*/
|
|
636
|
+
createBypass: (createBypassRequest: CreateBypassRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
637
|
+
/**
|
|
638
|
+
* Returns a list of recent connections with VPN detection status, bypass information, and associated player data. Optionally filter by epoch timestamp (seconds since Unix epoch).
|
|
639
|
+
* @summary List recent connections
|
|
640
|
+
* @param {number | null} [createdAfter] Filter connections after this epoch timestamp in milliseconds
|
|
641
|
+
* @param {number | null} [createdBefore] Filter connections before this epoch timestamp in milliseconds
|
|
642
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
643
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
644
|
+
* @param {boolean | null} [isVpn] Filter by VPN status (true=VPN, false=not VPN)
|
|
645
|
+
* @param {number | null} [page] Page number for pagination
|
|
646
|
+
* @param {number | null} [limit] Maximum number of records to return
|
|
647
|
+
* @param {*} [options] Override http request option.
|
|
648
|
+
* @throws {RequiredError}
|
|
649
|
+
*/
|
|
650
|
+
listConnections: (createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* AdminConnectionsApi - functional programming interface
|
|
654
|
+
*/
|
|
655
|
+
export declare const AdminConnectionsApiFp: (configuration?: Configuration) => {
|
|
656
|
+
/**
|
|
657
|
+
* Creates a temporary bypass for an IP address, expiring at the specified epoch timestamp (milliseconds since Unix epoch).
|
|
658
|
+
* @summary Create connection bypass
|
|
659
|
+
* @param {CreateBypassRequest} createBypassRequest
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
createBypass(createBypassRequest: CreateBypassRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminConnectionBypassResponse>>;
|
|
664
|
+
/**
|
|
665
|
+
* Returns a list of recent connections with VPN detection status, bypass information, and associated player data. Optionally filter by epoch timestamp (seconds since Unix epoch).
|
|
666
|
+
* @summary List recent connections
|
|
667
|
+
* @param {number | null} [createdAfter] Filter connections after this epoch timestamp in milliseconds
|
|
668
|
+
* @param {number | null} [createdBefore] Filter connections before this epoch timestamp in milliseconds
|
|
669
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
670
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
671
|
+
* @param {boolean | null} [isVpn] Filter by VPN status (true=VPN, false=not VPN)
|
|
672
|
+
* @param {number | null} [page] Page number for pagination
|
|
673
|
+
* @param {number | null} [limit] Maximum number of records to return
|
|
674
|
+
* @param {*} [options] Override http request option.
|
|
675
|
+
* @throws {RequiredError}
|
|
676
|
+
*/
|
|
677
|
+
listConnections(createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardConnectionResponse>>>;
|
|
678
|
+
};
|
|
679
|
+
/**
|
|
680
|
+
* AdminConnectionsApi - factory interface
|
|
681
|
+
*/
|
|
682
|
+
export declare const AdminConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
683
|
+
/**
|
|
684
|
+
* Creates a temporary bypass for an IP address, expiring at the specified epoch timestamp (milliseconds since Unix epoch).
|
|
685
|
+
* @summary Create connection bypass
|
|
686
|
+
* @param {CreateBypassRequest} createBypassRequest
|
|
687
|
+
* @param {*} [options] Override http request option.
|
|
688
|
+
* @throws {RequiredError}
|
|
689
|
+
*/
|
|
690
|
+
createBypass(createBypassRequest: CreateBypassRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminConnectionBypassResponse>;
|
|
691
|
+
/**
|
|
692
|
+
* Returns a list of recent connections with VPN detection status, bypass information, and associated player data. Optionally filter by epoch timestamp (seconds since Unix epoch).
|
|
693
|
+
* @summary List recent connections
|
|
694
|
+
* @param {number | null} [createdAfter] Filter connections after this epoch timestamp in milliseconds
|
|
695
|
+
* @param {number | null} [createdBefore] Filter connections before this epoch timestamp in milliseconds
|
|
696
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
697
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
698
|
+
* @param {boolean | null} [isVpn] Filter by VPN status (true=VPN, false=not VPN)
|
|
699
|
+
* @param {number | null} [page] Page number for pagination
|
|
700
|
+
* @param {number | null} [limit] Maximum number of records to return
|
|
701
|
+
* @param {*} [options] Override http request option.
|
|
702
|
+
* @throws {RequiredError}
|
|
703
|
+
*/
|
|
704
|
+
listConnections(createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardConnectionResponse>>;
|
|
705
|
+
};
|
|
706
|
+
/**
|
|
707
|
+
* AdminConnectionsApi - object-oriented interface
|
|
708
|
+
*/
|
|
709
|
+
export declare class AdminConnectionsApi extends BaseAPI {
|
|
710
|
+
/**
|
|
711
|
+
* Creates a temporary bypass for an IP address, expiring at the specified epoch timestamp (milliseconds since Unix epoch).
|
|
712
|
+
* @summary Create connection bypass
|
|
713
|
+
* @param {CreateBypassRequest} createBypassRequest
|
|
714
|
+
* @param {*} [options] Override http request option.
|
|
715
|
+
* @throws {RequiredError}
|
|
716
|
+
*/
|
|
717
|
+
createBypass(createBypassRequest: CreateBypassRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminConnectionBypassResponse, any, {}>>;
|
|
718
|
+
/**
|
|
719
|
+
* Returns a list of recent connections with VPN detection status, bypass information, and associated player data. Optionally filter by epoch timestamp (seconds since Unix epoch).
|
|
720
|
+
* @summary List recent connections
|
|
721
|
+
* @param {number | null} [createdAfter] Filter connections after this epoch timestamp in milliseconds
|
|
722
|
+
* @param {number | null} [createdBefore] Filter connections before this epoch timestamp in milliseconds
|
|
723
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
724
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
725
|
+
* @param {boolean | null} [isVpn] Filter by VPN status (true=VPN, false=not VPN)
|
|
726
|
+
* @param {number | null} [page] Page number for pagination
|
|
727
|
+
* @param {number | null} [limit] Maximum number of records to return
|
|
728
|
+
* @param {*} [options] Override http request option.
|
|
729
|
+
* @throws {RequiredError}
|
|
730
|
+
*/
|
|
731
|
+
listConnections(createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardConnectionResponse[], any, {}>>;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* AdminDashboardApi - axios parameter creator
|
|
735
|
+
*/
|
|
736
|
+
export declare const AdminDashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
737
|
+
/**
|
|
738
|
+
* Returns aggregate counts for clients, connections, and players in the system.
|
|
739
|
+
* @summary Get dashboard statistics
|
|
740
|
+
* @param {*} [options] Override http request option.
|
|
741
|
+
* @throws {RequiredError}
|
|
742
|
+
*/
|
|
743
|
+
dashboardStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
744
|
+
};
|
|
745
|
+
/**
|
|
746
|
+
* AdminDashboardApi - functional programming interface
|
|
747
|
+
*/
|
|
748
|
+
export declare const AdminDashboardApiFp: (configuration?: Configuration) => {
|
|
749
|
+
/**
|
|
750
|
+
* Returns aggregate counts for clients, connections, and players in the system.
|
|
751
|
+
* @summary Get dashboard statistics
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
*/
|
|
755
|
+
dashboardStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminGetDashboardStats>>;
|
|
756
|
+
};
|
|
757
|
+
/**
|
|
758
|
+
* AdminDashboardApi - factory interface
|
|
759
|
+
*/
|
|
760
|
+
export declare const AdminDashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
761
|
+
/**
|
|
762
|
+
* Returns aggregate counts for clients, connections, and players in the system.
|
|
763
|
+
* @summary Get dashboard statistics
|
|
764
|
+
* @param {*} [options] Override http request option.
|
|
765
|
+
* @throws {RequiredError}
|
|
766
|
+
*/
|
|
767
|
+
dashboardStats(options?: RawAxiosRequestConfig): AxiosPromise<AdminGetDashboardStats>;
|
|
768
|
+
};
|
|
769
|
+
/**
|
|
770
|
+
* AdminDashboardApi - object-oriented interface
|
|
771
|
+
*/
|
|
772
|
+
export declare class AdminDashboardApi extends BaseAPI {
|
|
773
|
+
/**
|
|
774
|
+
* Returns aggregate counts for clients, connections, and players in the system.
|
|
775
|
+
* @summary Get dashboard statistics
|
|
776
|
+
* @param {*} [options] Override http request option.
|
|
777
|
+
* @throws {RequiredError}
|
|
778
|
+
*/
|
|
779
|
+
dashboardStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminGetDashboardStats, any, {}>>;
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* ConnectionApi - axios parameter creator
|
|
783
|
+
*/
|
|
784
|
+
export declare const ConnectionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
785
|
+
/**
|
|
786
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
787
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
788
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
789
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
790
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
791
|
+
* @param {*} [options] Override http request option.
|
|
792
|
+
* @throws {RequiredError}
|
|
793
|
+
*/
|
|
794
|
+
getConnectionDetails: (ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
795
|
+
};
|
|
796
|
+
/**
|
|
797
|
+
* ConnectionApi - functional programming interface
|
|
798
|
+
*/
|
|
799
|
+
export declare const ConnectionApiFp: (configuration?: Configuration) => {
|
|
800
|
+
/**
|
|
801
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
802
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
803
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
804
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
805
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
getConnectionDetails(ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionGetConnectionDetailsResponse>>;
|
|
810
|
+
};
|
|
811
|
+
/**
|
|
812
|
+
* ConnectionApi - factory interface
|
|
813
|
+
*/
|
|
814
|
+
export declare const ConnectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
815
|
+
/**
|
|
816
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
817
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
818
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
819
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
820
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
821
|
+
* @param {*} [options] Override http request option.
|
|
822
|
+
* @throws {RequiredError}
|
|
823
|
+
*/
|
|
824
|
+
getConnectionDetails(ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionGetConnectionDetailsResponse>;
|
|
825
|
+
};
|
|
826
|
+
/**
|
|
827
|
+
* ConnectionApi - object-oriented interface
|
|
828
|
+
*/
|
|
829
|
+
export declare class ConnectionApi extends BaseAPI {
|
|
830
|
+
/**
|
|
831
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
832
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
833
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
834
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
835
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
836
|
+
* @param {*} [options] Override http request option.
|
|
837
|
+
* @throws {RequiredError}
|
|
838
|
+
*/
|
|
839
|
+
getConnectionDetails(ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConnectionGetConnectionDetailsResponse, any, {}>>;
|
|
840
|
+
}
|
|
841
|
+
/**
|
|
842
|
+
* PlayerApi - axios parameter creator
|
|
843
|
+
*/
|
|
844
|
+
export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
845
|
+
/**
|
|
846
|
+
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
847
|
+
* @summary Get Player Information
|
|
848
|
+
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
849
|
+
* @param {*} [options] Override http request option.
|
|
850
|
+
* @throws {RequiredError}
|
|
851
|
+
*/
|
|
852
|
+
getPlayer: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
853
|
+
};
|
|
854
|
+
/**
|
|
855
|
+
* PlayerApi - functional programming interface
|
|
856
|
+
*/
|
|
857
|
+
export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
858
|
+
/**
|
|
859
|
+
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
860
|
+
* @summary Get Player Information
|
|
861
|
+
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
862
|
+
* @param {*} [options] Override http request option.
|
|
863
|
+
* @throws {RequiredError}
|
|
864
|
+
*/
|
|
865
|
+
getPlayer(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerGetPlayerInformation>>;
|
|
866
|
+
};
|
|
867
|
+
/**
|
|
868
|
+
* PlayerApi - factory interface
|
|
869
|
+
*/
|
|
870
|
+
export declare const PlayerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
871
|
+
/**
|
|
872
|
+
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
873
|
+
* @summary Get Player Information
|
|
874
|
+
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
875
|
+
* @param {*} [options] Override http request option.
|
|
876
|
+
* @throws {RequiredError}
|
|
877
|
+
*/
|
|
878
|
+
getPlayer(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerGetPlayerInformation>;
|
|
879
|
+
};
|
|
880
|
+
/**
|
|
881
|
+
* PlayerApi - object-oriented interface
|
|
882
|
+
*/
|
|
883
|
+
export declare class PlayerApi extends BaseAPI {
|
|
884
|
+
/**
|
|
885
|
+
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
886
|
+
* @summary Get Player Information
|
|
887
|
+
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
888
|
+
* @param {*} [options] Override http request option.
|
|
889
|
+
* @throws {RequiredError}
|
|
890
|
+
*/
|
|
891
|
+
getPlayer(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerGetPlayerInformation, any, {}>>;
|
|
892
|
+
}
|
|
893
|
+
/**
|
|
894
|
+
* PunishmentApi - axios parameter creator
|
|
895
|
+
*/
|
|
896
|
+
export declare const PunishmentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
897
|
+
/**
|
|
898
|
+
* Create and apply a punishment to a player. Automatically determines if permanent based on current score threshold (≥100%).
|
|
899
|
+
* @summary Apply a punishment
|
|
900
|
+
* @param {ApplyPunishmentRequest} applyPunishmentRequest
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
applyPunishment: (applyPunishmentRequest: ApplyPunishmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
905
|
+
/**
|
|
906
|
+
* Preview punishment impact before applying. Returns calculated points, current/new thresholds, and whether it will be permanent.
|
|
907
|
+
* @summary Create a punishment draft
|
|
908
|
+
* @param {CreatePunishmentDraftRequest} createPunishmentDraftRequest
|
|
909
|
+
* @param {*} [options] Override http request option.
|
|
910
|
+
* @throws {RequiredError}
|
|
911
|
+
*/
|
|
912
|
+
createPunishmentDraft: (createPunishmentDraftRequest: CreatePunishmentDraftRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
913
|
+
/**
|
|
914
|
+
* Retrieve duration information for each punishment type and severity level (1-10)
|
|
915
|
+
* @summary Get punishment severities
|
|
916
|
+
* @param {*} [options] Override http request option.
|
|
917
|
+
* @throws {RequiredError}
|
|
918
|
+
*/
|
|
919
|
+
getPunishmentSeverities: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
920
|
+
/**
|
|
921
|
+
* Retrieve all active punishments for a player by UUID or username, optionally filtered by type and time
|
|
922
|
+
* @summary Get punishments by player
|
|
923
|
+
* @param {string | null} [uuid] Player UUID
|
|
924
|
+
* @param {string | null} [username] Player username
|
|
925
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
926
|
+
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
927
|
+
* @param {*} [options] Override http request option.
|
|
928
|
+
* @throws {RequiredError}
|
|
929
|
+
*/
|
|
930
|
+
getPunishments: (uuid?: string | null, username?: string | null, type?: Array<string> | null, since?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
931
|
+
/**
|
|
932
|
+
* Retrieve all active punishments associated with an IP address
|
|
933
|
+
* @summary Get punishments by IP address
|
|
934
|
+
* @param {string} ip IP address
|
|
935
|
+
* @param {*} [options] Override http request option.
|
|
936
|
+
* @throws {RequiredError}
|
|
937
|
+
*/
|
|
938
|
+
getPunishmentsByIp: (ip: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
939
|
+
/**
|
|
940
|
+
* Returns a paginated list of recent punishments with optional filtering by issue date, expiration date, and type
|
|
941
|
+
* @summary List recent punishments
|
|
942
|
+
* @param {number} limit Maximum number of records to return
|
|
943
|
+
* @param {number} page Page number for pagination
|
|
944
|
+
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (milliseconds)
|
|
945
|
+
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
946
|
+
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
947
|
+
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
948
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
949
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
950
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
951
|
+
* @param {*} [options] Override http request option.
|
|
952
|
+
* @throws {RequiredError}
|
|
953
|
+
*/
|
|
954
|
+
getRecentPunishments: (limit: number, page: number, issuedAfter?: number | null, issuedBefore?: number | null, expiresAfter?: number | null, expiresBefore?: number | null, type?: Array<string> | null, uuid?: string | null, ipAddress?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
955
|
+
};
|
|
956
|
+
/**
|
|
957
|
+
* PunishmentApi - functional programming interface
|
|
958
|
+
*/
|
|
959
|
+
export declare const PunishmentApiFp: (configuration?: Configuration) => {
|
|
960
|
+
/**
|
|
961
|
+
* Create and apply a punishment to a player. Automatically determines if permanent based on current score threshold (≥100%).
|
|
962
|
+
* @summary Apply a punishment
|
|
963
|
+
* @param {ApplyPunishmentRequest} applyPunishmentRequest
|
|
964
|
+
* @param {*} [options] Override http request option.
|
|
965
|
+
* @throws {RequiredError}
|
|
966
|
+
*/
|
|
967
|
+
applyPunishment(applyPunishmentRequest: ApplyPunishmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplyPunishmentResponse>>;
|
|
968
|
+
/**
|
|
969
|
+
* Preview punishment impact before applying. Returns calculated points, current/new thresholds, and whether it will be permanent.
|
|
970
|
+
* @summary Create a punishment draft
|
|
971
|
+
* @param {CreatePunishmentDraftRequest} createPunishmentDraftRequest
|
|
972
|
+
* @param {*} [options] Override http request option.
|
|
973
|
+
* @throws {RequiredError}
|
|
974
|
+
*/
|
|
975
|
+
createPunishmentDraft(createPunishmentDraftRequest: CreatePunishmentDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PunishmentDraftResponse>>;
|
|
976
|
+
/**
|
|
977
|
+
* Retrieve duration information for each punishment type and severity level (1-10)
|
|
978
|
+
* @summary Get punishment severities
|
|
979
|
+
* @param {*} [options] Override http request option.
|
|
980
|
+
* @throws {RequiredError}
|
|
981
|
+
*/
|
|
982
|
+
getPunishmentSeverities(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PunishmentSeveritiesResponse>>;
|
|
983
|
+
/**
|
|
984
|
+
* Retrieve all active punishments for a player by UUID or username, optionally filtered by type and time
|
|
985
|
+
* @summary Get punishments by player
|
|
986
|
+
* @param {string | null} [uuid] Player UUID
|
|
987
|
+
* @param {string | null} [username] Player username
|
|
988
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
989
|
+
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
990
|
+
* @param {*} [options] Override http request option.
|
|
991
|
+
* @throws {RequiredError}
|
|
992
|
+
*/
|
|
993
|
+
getPunishments(uuid?: string | null, username?: string | null, type?: Array<string> | null, since?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PunishmentGetPunishmentResponse>>>;
|
|
994
|
+
/**
|
|
995
|
+
* Retrieve all active punishments associated with an IP address
|
|
996
|
+
* @summary Get punishments by IP address
|
|
997
|
+
* @param {string} ip IP address
|
|
998
|
+
* @param {*} [options] Override http request option.
|
|
999
|
+
* @throws {RequiredError}
|
|
1000
|
+
*/
|
|
1001
|
+
getPunishmentsByIp(ip: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PunishmentGetPunishmentResponse>>>;
|
|
1002
|
+
/**
|
|
1003
|
+
* Returns a paginated list of recent punishments with optional filtering by issue date, expiration date, and type
|
|
1004
|
+
* @summary List recent punishments
|
|
1005
|
+
* @param {number} limit Maximum number of records to return
|
|
1006
|
+
* @param {number} page Page number for pagination
|
|
1007
|
+
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (milliseconds)
|
|
1008
|
+
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
1009
|
+
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
1010
|
+
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
1011
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
1012
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
1013
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
1014
|
+
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @throws {RequiredError}
|
|
1016
|
+
*/
|
|
1017
|
+
getRecentPunishments(limit: number, page: number, issuedAfter?: number | null, issuedBefore?: number | null, expiresAfter?: number | null, expiresBefore?: number | null, type?: Array<string> | null, uuid?: string | null, ipAddress?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PunishmentGetPunishmentResponse>>>;
|
|
1018
|
+
};
|
|
1019
|
+
/**
|
|
1020
|
+
* PunishmentApi - factory interface
|
|
1021
|
+
*/
|
|
1022
|
+
export declare const PunishmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1023
|
+
/**
|
|
1024
|
+
* Create and apply a punishment to a player. Automatically determines if permanent based on current score threshold (≥100%).
|
|
1025
|
+
* @summary Apply a punishment
|
|
1026
|
+
* @param {ApplyPunishmentRequest} applyPunishmentRequest
|
|
1027
|
+
* @param {*} [options] Override http request option.
|
|
1028
|
+
* @throws {RequiredError}
|
|
1029
|
+
*/
|
|
1030
|
+
applyPunishment(applyPunishmentRequest: ApplyPunishmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplyPunishmentResponse>;
|
|
1031
|
+
/**
|
|
1032
|
+
* Preview punishment impact before applying. Returns calculated points, current/new thresholds, and whether it will be permanent.
|
|
1033
|
+
* @summary Create a punishment draft
|
|
1034
|
+
* @param {CreatePunishmentDraftRequest} createPunishmentDraftRequest
|
|
1035
|
+
* @param {*} [options] Override http request option.
|
|
1036
|
+
* @throws {RequiredError}
|
|
1037
|
+
*/
|
|
1038
|
+
createPunishmentDraft(createPunishmentDraftRequest: CreatePunishmentDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<PunishmentDraftResponse>;
|
|
1039
|
+
/**
|
|
1040
|
+
* Retrieve duration information for each punishment type and severity level (1-10)
|
|
1041
|
+
* @summary Get punishment severities
|
|
1042
|
+
* @param {*} [options] Override http request option.
|
|
1043
|
+
* @throws {RequiredError}
|
|
1044
|
+
*/
|
|
1045
|
+
getPunishmentSeverities(options?: RawAxiosRequestConfig): AxiosPromise<PunishmentSeveritiesResponse>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Retrieve all active punishments for a player by UUID or username, optionally filtered by type and time
|
|
1048
|
+
* @summary Get punishments by player
|
|
1049
|
+
* @param {string | null} [uuid] Player UUID
|
|
1050
|
+
* @param {string | null} [username] Player username
|
|
1051
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
1052
|
+
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
1053
|
+
* @param {*} [options] Override http request option.
|
|
1054
|
+
* @throws {RequiredError}
|
|
1055
|
+
*/
|
|
1056
|
+
getPunishments(uuid?: string | null, username?: string | null, type?: Array<string> | null, since?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<PunishmentGetPunishmentResponse>>;
|
|
1057
|
+
/**
|
|
1058
|
+
* Retrieve all active punishments associated with an IP address
|
|
1059
|
+
* @summary Get punishments by IP address
|
|
1060
|
+
* @param {string} ip IP address
|
|
1061
|
+
* @param {*} [options] Override http request option.
|
|
1062
|
+
* @throws {RequiredError}
|
|
1063
|
+
*/
|
|
1064
|
+
getPunishmentsByIp(ip: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PunishmentGetPunishmentResponse>>;
|
|
1065
|
+
/**
|
|
1066
|
+
* Returns a paginated list of recent punishments with optional filtering by issue date, expiration date, and type
|
|
1067
|
+
* @summary List recent punishments
|
|
1068
|
+
* @param {number} limit Maximum number of records to return
|
|
1069
|
+
* @param {number} page Page number for pagination
|
|
1070
|
+
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (milliseconds)
|
|
1071
|
+
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
1072
|
+
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
1073
|
+
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
1074
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
1075
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
1076
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
1077
|
+
* @param {*} [options] Override http request option.
|
|
1078
|
+
* @throws {RequiredError}
|
|
1079
|
+
*/
|
|
1080
|
+
getRecentPunishments(limit: number, page: number, issuedAfter?: number | null, issuedBefore?: number | null, expiresAfter?: number | null, expiresBefore?: number | null, type?: Array<string> | null, uuid?: string | null, ipAddress?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<PunishmentGetPunishmentResponse>>;
|
|
1081
|
+
};
|
|
1082
|
+
/**
|
|
1083
|
+
* PunishmentApi - object-oriented interface
|
|
1084
|
+
*/
|
|
1085
|
+
export declare class PunishmentApi extends BaseAPI {
|
|
1086
|
+
/**
|
|
1087
|
+
* Create and apply a punishment to a player. Automatically determines if permanent based on current score threshold (≥100%).
|
|
1088
|
+
* @summary Apply a punishment
|
|
1089
|
+
* @param {ApplyPunishmentRequest} applyPunishmentRequest
|
|
1090
|
+
* @param {*} [options] Override http request option.
|
|
1091
|
+
* @throws {RequiredError}
|
|
1092
|
+
*/
|
|
1093
|
+
applyPunishment(applyPunishmentRequest: ApplyPunishmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplyPunishmentResponse, any, {}>>;
|
|
1094
|
+
/**
|
|
1095
|
+
* Preview punishment impact before applying. Returns calculated points, current/new thresholds, and whether it will be permanent.
|
|
1096
|
+
* @summary Create a punishment draft
|
|
1097
|
+
* @param {CreatePunishmentDraftRequest} createPunishmentDraftRequest
|
|
1098
|
+
* @param {*} [options] Override http request option.
|
|
1099
|
+
* @throws {RequiredError}
|
|
1100
|
+
*/
|
|
1101
|
+
createPunishmentDraft(createPunishmentDraftRequest: CreatePunishmentDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PunishmentDraftResponse, any, {}>>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Retrieve duration information for each punishment type and severity level (1-10)
|
|
1104
|
+
* @summary Get punishment severities
|
|
1105
|
+
* @param {*} [options] Override http request option.
|
|
1106
|
+
* @throws {RequiredError}
|
|
1107
|
+
*/
|
|
1108
|
+
getPunishmentSeverities(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PunishmentSeveritiesResponse, any, {}>>;
|
|
1109
|
+
/**
|
|
1110
|
+
* Retrieve all active punishments for a player by UUID or username, optionally filtered by type and time
|
|
1111
|
+
* @summary Get punishments by player
|
|
1112
|
+
* @param {string | null} [uuid] Player UUID
|
|
1113
|
+
* @param {string | null} [username] Player username
|
|
1114
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
1115
|
+
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
1116
|
+
* @param {*} [options] Override http request option.
|
|
1117
|
+
* @throws {RequiredError}
|
|
1118
|
+
*/
|
|
1119
|
+
getPunishments(uuid?: string | null, username?: string | null, type?: Array<string> | null, since?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PunishmentGetPunishmentResponse[], any, {}>>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Retrieve all active punishments associated with an IP address
|
|
1122
|
+
* @summary Get punishments by IP address
|
|
1123
|
+
* @param {string} ip IP address
|
|
1124
|
+
* @param {*} [options] Override http request option.
|
|
1125
|
+
* @throws {RequiredError}
|
|
1126
|
+
*/
|
|
1127
|
+
getPunishmentsByIp(ip: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PunishmentGetPunishmentResponse[], any, {}>>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Returns a paginated list of recent punishments with optional filtering by issue date, expiration date, and type
|
|
1130
|
+
* @summary List recent punishments
|
|
1131
|
+
* @param {number} limit Maximum number of records to return
|
|
1132
|
+
* @param {number} page Page number for pagination
|
|
1133
|
+
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (milliseconds)
|
|
1134
|
+
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
1135
|
+
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
1136
|
+
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
1137
|
+
* @param {Array<string> | null} [type] Filter by punishment types
|
|
1138
|
+
* @param {string | null} [uuid] Filter by player UUID
|
|
1139
|
+
* @param {string | null} [ipAddress] Filter by IP address
|
|
1140
|
+
* @param {*} [options] Override http request option.
|
|
1141
|
+
* @throws {RequiredError}
|
|
1142
|
+
*/
|
|
1143
|
+
getRecentPunishments(limit: number, page: number, issuedAfter?: number | null, issuedBefore?: number | null, expiresAfter?: number | null, expiresBefore?: number | null, type?: Array<string> | null, uuid?: string | null, ipAddress?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PunishmentGetPunishmentResponse[], any, {}>>;
|
|
1144
|
+
}
|