@rebornteam/reborn-api 3.0.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +7 -0
- package/README.md +9 -2
- package/api.ts +230 -149
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +190 -146
- package/dist/api.js +45 -23
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +190 -146
- package/dist/esm/api.js +43 -22
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AdminApplyPunishmentRequest.md +3 -3
- package/docs/AdminApplyPunishmentResponse.md +1 -1
- package/docs/AdminApplyPunishmentResult.md +6 -6
- package/docs/AdminClientCredentialResponse.md +6 -6
- package/docs/AdminConnectionBypassResponse.md +4 -4
- package/docs/AdminConnectionCheckResult.md +7 -3
- package/docs/AdminCreatePunishmentDraftRequest.md +3 -3
- package/docs/AdminDashboardConnectionResponse.md +2 -2
- package/docs/AdminIpSearchResult.md +2 -2
- package/docs/AdminPagedConnectionResponse.md +5 -5
- package/docs/AdminPagedPlayerResponse.md +5 -5
- package/docs/AdminPagedPunishmentResponse.md +5 -5
- package/docs/AdminPlayerDetailResponse.md +7 -7
- package/docs/AdminPlayerSearchResult.md +1 -1
- package/docs/AdminPlayerSummary.md +6 -6
- package/docs/AdminPunishmentDraftResponse.md +1 -1
- package/docs/AdminPunishmentEvaluation.md +9 -9
- package/docs/AdminPunishmentListItem.md +2 -2
- package/docs/AdminPunishmentSearchResponse.md +3 -3
- package/docs/AdminPunishmentsApi.md +2 -2
- package/docs/AdminUsernameHistoryEntry.md +2 -2
- package/docs/ConnectionGetConnectionDetailsResponse.md +9 -7
- package/docs/ConnectionResult.md +25 -0
- package/docs/ConnectionResultResultCode.md +20 -0
- package/docs/GameType.md +12 -0
- package/docs/PlayerGetPlayerInformation.md +4 -4
- package/docs/PunishmentApi.md +4 -4
- package/docs/PunishmentGetPunishmentResponse.md +6 -6
- package/docs/PunishmentSeveritiesResponse.md +1 -1
- package/docs/PunishmentSeveritiesResponsePunishmentTypeInfo.md +2 -2
- package/docs/PunishmentSeveritiesResponseSeverityInfo.md +2 -2
- package/docs/PunishmentTargetType.md +10 -0
- package/docs/PunishmentType.md +12 -0
- package/docs/Region.md +12 -0
- package/docs/SearchKind.md +11 -0
- package/docs/ServerRegisterRequest.md +2 -2
- package/docs/ServerSessionDTO.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* 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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.0
|
|
7
|
+
* The version of the OpenAPI document: 3.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -26,25 +26,46 @@ import globalAxios from 'axios';
|
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from './base';
|
|
29
|
-
export const
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
29
|
+
export const ConnectionResultResultCode = {
|
|
30
|
+
Allowed: 'ALLOWED',
|
|
31
|
+
AllowedBypass: 'ALLOWED_BYPASS',
|
|
32
|
+
AllowedPlayerBypass: 'ALLOWED_PLAYER_BYPASS',
|
|
33
|
+
Banned: 'BANNED',
|
|
34
|
+
VpnDetected: 'VPN_DETECTED',
|
|
35
|
+
VpnRetry: 'VPN_RETRY',
|
|
36
|
+
VpnTempBanned: 'VPN_TEMP_BANNED'
|
|
37
|
+
};
|
|
38
|
+
export const GameType = {
|
|
39
|
+
Rotj: 'ROTJ',
|
|
40
|
+
Legacy: 'LEGACY',
|
|
41
|
+
Classic: 'CLASSIC'
|
|
42
|
+
};
|
|
43
|
+
export const PunishmentTargetType = {
|
|
44
|
+
Player: 'PLAYER',
|
|
45
|
+
Connection: 'CONNECTION'
|
|
33
46
|
};
|
|
34
|
-
export const
|
|
47
|
+
export const PunishmentType = {
|
|
35
48
|
Ban: 'BAN',
|
|
36
49
|
Mute: 'MUTE',
|
|
37
50
|
Warning: 'WARNING'
|
|
38
51
|
};
|
|
39
|
-
export const AdminPunishmentSearchResponseKindEnum = {
|
|
40
|
-
Player: 'player',
|
|
41
|
-
Ip: 'ip'
|
|
42
|
-
};
|
|
43
52
|
export const Rank = {
|
|
44
53
|
Administrator: 'ADMINISTRATOR',
|
|
45
54
|
Moderator: 'MODERATOR',
|
|
46
55
|
Service: 'SERVICE'
|
|
47
56
|
};
|
|
57
|
+
export const Region = {
|
|
58
|
+
Us: 'US',
|
|
59
|
+
Eu: 'EU',
|
|
60
|
+
Au: 'AU'
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Search kind — PLAYER for UUID/username searches, IP for IP address searches
|
|
64
|
+
*/
|
|
65
|
+
export const SearchKind = {
|
|
66
|
+
Player: 'PLAYER',
|
|
67
|
+
Ip: 'IP'
|
|
68
|
+
};
|
|
48
69
|
/**
|
|
49
70
|
* AdminClientCredentialsApi - axios parameter creator
|
|
50
71
|
*/
|
|
@@ -1292,7 +1313,7 @@ export const AdminPunishmentsApiAxiosParamCreator = function (configuration) {
|
|
|
1292
1313
|
* @param {string | null} [uuid] Filter by player UUID
|
|
1293
1314
|
* @param {string | null} [username] Filter by player username (case-insensitive substring match)
|
|
1294
1315
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
1295
|
-
* @param {Array<
|
|
1316
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment type. Repeatable.
|
|
1296
1317
|
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (ms)
|
|
1297
1318
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (ms)
|
|
1298
1319
|
* @param {*} [options] Override http request option.
|
|
@@ -1432,7 +1453,7 @@ export const AdminPunishmentsApiFp = function (configuration) {
|
|
|
1432
1453
|
* @param {string | null} [uuid] Filter by player UUID
|
|
1433
1454
|
* @param {string | null} [username] Filter by player username (case-insensitive substring match)
|
|
1434
1455
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
1435
|
-
* @param {Array<
|
|
1456
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment type. Repeatable.
|
|
1436
1457
|
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (ms)
|
|
1437
1458
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (ms)
|
|
1438
1459
|
* @param {*} [options] Override http request option.
|
|
@@ -1499,7 +1520,7 @@ export const AdminPunishmentsApiFactory = function (configuration, basePath, axi
|
|
|
1499
1520
|
* @param {string | null} [uuid] Filter by player UUID
|
|
1500
1521
|
* @param {string | null} [username] Filter by player username (case-insensitive substring match)
|
|
1501
1522
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
1502
|
-
* @param {Array<
|
|
1523
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment type. Repeatable.
|
|
1503
1524
|
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (ms)
|
|
1504
1525
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (ms)
|
|
1505
1526
|
* @param {*} [options] Override http request option.
|
|
@@ -1552,7 +1573,7 @@ export class AdminPunishmentsApi extends BaseAPI {
|
|
|
1552
1573
|
* @param {string | null} [uuid] Filter by player UUID
|
|
1553
1574
|
* @param {string | null} [username] Filter by player username (case-insensitive substring match)
|
|
1554
1575
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
1555
|
-
* @param {Array<
|
|
1576
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment type. Repeatable.
|
|
1556
1577
|
* @param {number | null} [issuedAfter] Filter punishments issued after this epoch timestamp (ms)
|
|
1557
1578
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (ms)
|
|
1558
1579
|
* @param {*} [options] Override http request option.
|
|
@@ -2387,7 +2408,7 @@ export const PunishmentApiAxiosParamCreator = function (configuration) {
|
|
|
2387
2408
|
* @summary Get punishments by player
|
|
2388
2409
|
* @param {string | null} [uuid] Player UUID
|
|
2389
2410
|
* @param {string | null} [username] Player username
|
|
2390
|
-
* @param {Array<
|
|
2411
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2391
2412
|
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
2392
2413
|
* @param {*} [options] Override http request option.
|
|
2393
2414
|
* @throws {RequiredError}
|
|
@@ -2471,7 +2492,7 @@ export const PunishmentApiAxiosParamCreator = function (configuration) {
|
|
|
2471
2492
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
2472
2493
|
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
2473
2494
|
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
2474
|
-
* @param {Array<
|
|
2495
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2475
2496
|
* @param {string | null} [uuid] Filter by player UUID
|
|
2476
2497
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
2477
2498
|
* @param {*} [options] Override http request option.
|
|
@@ -2559,7 +2580,7 @@ export const PunishmentApiFp = function (configuration) {
|
|
|
2559
2580
|
* @summary Get punishments by player
|
|
2560
2581
|
* @param {string | null} [uuid] Player UUID
|
|
2561
2582
|
* @param {string | null} [username] Player username
|
|
2562
|
-
* @param {Array<
|
|
2583
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2563
2584
|
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
2564
2585
|
* @param {*} [options] Override http request option.
|
|
2565
2586
|
* @throws {RequiredError}
|
|
@@ -2598,7 +2619,7 @@ export const PunishmentApiFp = function (configuration) {
|
|
|
2598
2619
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
2599
2620
|
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
2600
2621
|
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
2601
|
-
* @param {Array<
|
|
2622
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2602
2623
|
* @param {string | null} [uuid] Filter by player UUID
|
|
2603
2624
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
2604
2625
|
* @param {*} [options] Override http request option.
|
|
@@ -2635,7 +2656,7 @@ export const PunishmentApiFactory = function (configuration, basePath, axios) {
|
|
|
2635
2656
|
* @summary Get punishments by player
|
|
2636
2657
|
* @param {string | null} [uuid] Player UUID
|
|
2637
2658
|
* @param {string | null} [username] Player username
|
|
2638
|
-
* @param {Array<
|
|
2659
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2639
2660
|
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
2640
2661
|
* @param {*} [options] Override http request option.
|
|
2641
2662
|
* @throws {RequiredError}
|
|
@@ -2662,7 +2683,7 @@ export const PunishmentApiFactory = function (configuration, basePath, axios) {
|
|
|
2662
2683
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
2663
2684
|
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
2664
2685
|
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
2665
|
-
* @param {Array<
|
|
2686
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2666
2687
|
* @param {string | null} [uuid] Filter by player UUID
|
|
2667
2688
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
2668
2689
|
* @param {*} [options] Override http request option.
|
|
@@ -2691,7 +2712,7 @@ export class PunishmentApi extends BaseAPI {
|
|
|
2691
2712
|
* @summary Get punishments by player
|
|
2692
2713
|
* @param {string | null} [uuid] Player UUID
|
|
2693
2714
|
* @param {string | null} [username] Player username
|
|
2694
|
-
* @param {Array<
|
|
2715
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2695
2716
|
* @param {number | null} [since] Filter punishments created after this Unix epoch timestamp (milliseconds)
|
|
2696
2717
|
* @param {*} [options] Override http request option.
|
|
2697
2718
|
* @throws {RequiredError}
|
|
@@ -2718,7 +2739,7 @@ export class PunishmentApi extends BaseAPI {
|
|
|
2718
2739
|
* @param {number | null} [issuedBefore] Filter punishments issued before this epoch timestamp (milliseconds)
|
|
2719
2740
|
* @param {number | null} [expiresAfter] Filter punishments expiring after this epoch timestamp (milliseconds)
|
|
2720
2741
|
* @param {number | null} [expiresBefore] Filter punishments expiring before this epoch timestamp (milliseconds)
|
|
2721
|
-
* @param {Array<
|
|
2742
|
+
* @param {Array<PunishmentType> | null} [type] Filter by punishment types
|
|
2722
2743
|
* @param {string | null} [uuid] Filter by player UUID
|
|
2723
2744
|
* @param {string | null} [ipAddress] Filter by IP address
|
|
2724
2745
|
* @param {*} [options] Override http request option.
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.0
|
|
5
|
+
* The version of the OpenAPI document: 3.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* 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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.0
|
|
7
|
+
* The version of the OpenAPI document: 3.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.0
|
|
5
|
+
* The version of the OpenAPI document: 3.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* 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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.0
|
|
7
|
+
* The version of the OpenAPI document: 3.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.0
|
|
5
|
+
* The version of the OpenAPI document: 3.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Reborn API
|
|
4
4
|
* 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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 3.0
|
|
6
|
+
* The version of the OpenAPI document: 3.2.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.0
|
|
5
|
+
* The version of the OpenAPI document: 3.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* 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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.0
|
|
7
|
+
* The version of the OpenAPI document: 3.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.0
|
|
5
|
+
* The version of the OpenAPI document: 3.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Reborn API
|
|
6
6
|
* 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 - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.0
|
|
8
|
+
* The version of the OpenAPI document: 3.2.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -7,11 +7,11 @@ Request to apply a punishment to one or more targets
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**targets** | [**Array<AdminPunishmentTarget>**](AdminPunishmentTarget.md) | List of targets to punish — each must have either a uuid or ipAddress | [default to undefined]
|
|
10
|
-
**type** | **
|
|
11
|
-
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [
|
|
10
|
+
**type** | [**PunishmentType**](PunishmentType.md) | Punishment type | [default to undefined]
|
|
11
|
+
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [default to undefined]
|
|
12
12
|
**reason** | **string** | Reason for the punishment | [default to undefined]
|
|
13
13
|
**durationSeconds** | **number** | Custom duration in seconds — if omitted the suggested duration for the type and severity is used | [optional] [default to undefined]
|
|
14
|
-
**forcePermanent** | **boolean** | Force the punishment to be permanent regardless of the target\'s current score | [
|
|
14
|
+
**forcePermanent** | **boolean** | Force the punishment to be permanent regardless of the target\'s current score | [default to false]
|
|
15
15
|
**notes** | **string** | Internal notes visible only to administrators — not shown to the punished player | [optional] [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -6,7 +6,7 @@ Batch punishment apply result — one result per target
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<AdminApplyPunishmentResult>**](AdminApplyPunishmentResult.md) | Ordered list of results, one per target in the request | [
|
|
9
|
+
**results** | [**Array<AdminApplyPunishmentResult>**](AdminApplyPunishmentResult.md) | Ordered list of results, one per target in the request | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,12 +6,12 @@ Result of applying a punishment to a single target
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**target** | [**AdminPunishmentTarget**](AdminPunishmentTarget.md) | The target this result applies to | [
|
|
10
|
-
**punishmentId** | **number** | ID of the created punishment record | [
|
|
11
|
-
**type** | **
|
|
12
|
-
**severity** | **number** | Severity level applied | [
|
|
13
|
-
**newScore** | **number** | Updated punishment score after applying | [
|
|
14
|
-
**isPermanent** | **boolean** | Whether the punishment was made permanent | [
|
|
9
|
+
**target** | [**AdminPunishmentTarget**](AdminPunishmentTarget.md) | The target this result applies to | [default to undefined]
|
|
10
|
+
**punishmentId** | **number** | ID of the created punishment record | [default to undefined]
|
|
11
|
+
**type** | [**PunishmentType**](PunishmentType.md) | Punishment type applied | [default to undefined]
|
|
12
|
+
**severity** | **number** | Severity level applied | [default to undefined]
|
|
13
|
+
**newScore** | **number** | Updated punishment score after applying | [default to undefined]
|
|
14
|
+
**isPermanent** | **boolean** | Whether the punishment was made permanent | [default to undefined]
|
|
15
15
|
**expiresAt** | **string** | When the punishment expires — null if permanent or a WARNING | [optional] [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
@@ -6,13 +6,13 @@ Client credential response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Unique identifier for the client credential | [
|
|
10
|
-
**clientId** | **string** | Client ID used for authentication | [
|
|
9
|
+
**id** | **number** | Unique identifier for the client credential | [default to undefined]
|
|
10
|
+
**clientId** | **string** | Client ID used for authentication | [default to undefined]
|
|
11
11
|
**clientSecret** | **string** | Client secret (only returned on generation/rotation, null otherwise) | [optional] [default to undefined]
|
|
12
|
-
**name** | **string** | Human-readable name for the client | [
|
|
13
|
-
**description** | **string** | Optional description of the client\'s purpose | [
|
|
14
|
-
**enabled** | **boolean** | Whether the client credential is currently enabled | [
|
|
15
|
-
**createdAt** | **string** | Timestamp when the credential was created (ISO-8601 format) | [
|
|
12
|
+
**name** | **string** | Human-readable name for the client | [default to undefined]
|
|
13
|
+
**description** | **string** | Optional description of the client\'s purpose | [default to undefined]
|
|
14
|
+
**enabled** | **boolean** | Whether the client credential is currently enabled | [default to undefined]
|
|
15
|
+
**createdAt** | **string** | Timestamp when the credential was created (ISO-8601 format) | [default to undefined]
|
|
16
16
|
**expiresAt** | **string** | Timestamp when the credential expires (ISO-8601 format). Null means the credential never expires. | [optional] [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
@@ -6,10 +6,10 @@ Connection bypass response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Unique identifier for the bypass | [
|
|
10
|
-
**ipAddress** | **string** | IP address that is bypassed | [
|
|
11
|
-
**expiresAt** | **string** | Timestamp when the bypass expires (ISO-8601 format) | [
|
|
12
|
-
**createdAt** | **string** | Timestamp when the bypass was created (ISO-8601 format) | [
|
|
9
|
+
**id** | **number** | Unique identifier for the bypass | [default to undefined]
|
|
10
|
+
**ipAddress** | **string** | IP address that is bypassed | [default to undefined]
|
|
11
|
+
**expiresAt** | **string** | Timestamp when the bypass expires (ISO-8601 format) | [default to undefined]
|
|
12
|
+
**createdAt** | **string** | Timestamp when the bypass was created (ISO-8601 format) | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,9 +6,11 @@ Result from a single VPN detection service for a given IP address
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**service** | **string** | Service identifier | [
|
|
10
|
-
**result** | **boolean** | Whether this service flagged the IP as a VPN, proxy, or Tor exit node | [
|
|
11
|
-
**checkedAt** | **string** | When this check was last performed | [
|
|
9
|
+
**service** | **string** | Service identifier | [default to undefined]
|
|
10
|
+
**result** | **boolean** | Whether this service flagged the IP as a VPN, proxy, or Tor exit node | [default to undefined]
|
|
11
|
+
**checkedAt** | **string** | When this check was last performed | [default to undefined]
|
|
12
|
+
**city** | **string** | City reported by this service, if available | [optional] [default to undefined]
|
|
13
|
+
**country** | **string** | Country code reported by this service, if available | [optional] [default to undefined]
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
@@ -19,6 +21,8 @@ const instance: AdminConnectionCheckResult = {
|
|
|
19
21
|
service,
|
|
20
22
|
result,
|
|
21
23
|
checkedAt,
|
|
24
|
+
city,
|
|
25
|
+
country,
|
|
22
26
|
};
|
|
23
27
|
```
|
|
24
28
|
|
|
@@ -7,11 +7,11 @@ Request to evaluate the impact of a punishment across one or more targets before
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**targets** | [**Array<AdminPunishmentTarget>**](AdminPunishmentTarget.md) | List of targets to evaluate — each must have either a uuid or ipAddress | [default to undefined]
|
|
10
|
-
**type** | **
|
|
11
|
-
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [
|
|
10
|
+
**type** | [**PunishmentType**](PunishmentType.md) | Punishment type | [default to undefined]
|
|
11
|
+
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [default to undefined]
|
|
12
12
|
**reason** | **string** | Reason for the punishment (not used in evaluation, required for apply) | [default to undefined]
|
|
13
13
|
**durationSeconds** | **number** | Custom duration in seconds — if omitted the suggested duration for the type and severity is used | [optional] [default to undefined]
|
|
14
|
-
**forcePermanent** | **boolean** | Force the punishment to be permanent regardless of the target\'s current score | [
|
|
14
|
+
**forcePermanent** | **boolean** | Force the punishment to be permanent regardless of the target\'s current score | [default to false]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **number** | | [default to undefined]
|
|
9
9
|
**ipAddress** | **string** | | [default to undefined]
|
|
10
|
-
**location** | **string** | | [default to undefined]
|
|
10
|
+
**location** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**isVpn** | **boolean** | | [default to undefined]
|
|
12
12
|
**isBypassed** | **boolean** | | [default to undefined]
|
|
13
13
|
**bypassExpiresAt** | **string** | | [optional] [default to undefined]
|
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**lastSeen** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**percentPositive** | **number** | | [default to undefined]
|
|
17
17
|
**numberOfChecks** | **number** | | [default to undefined]
|
|
18
|
-
**results** | [**Array<AdminConnectionCheckResult>**](AdminConnectionCheckResult.md) | Results from each VPN detection service for this IP address | [
|
|
18
|
+
**results** | [**Array<AdminConnectionCheckResult>**](AdminConnectionCheckResult.md) | Results from each VPN detection service for this IP address | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,8 +6,8 @@ A single IP address match in a punishment search, with all players ever seen on
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ipAddress** | **string** | IP address | [
|
|
10
|
-
**players** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Players ever seen on this IP | [
|
|
9
|
+
**ipAddress** | **string** | IP address | [default to undefined]
|
|
10
|
+
**players** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Players ever seen on this IP | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,11 +6,11 @@ Paginated connection list response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<AdminDashboardConnectionResponse>**](AdminDashboardConnectionResponse.md) | Connections on the current page | [
|
|
10
|
-
**total** | **number** | Total number of connections matching the filters | [
|
|
11
|
-
**page** | **number** | Current page (1-indexed) | [
|
|
12
|
-
**limit** | **number** | Page size | [
|
|
13
|
-
**totalPages** | **number** | Total number of pages | [
|
|
9
|
+
**data** | [**Array<AdminDashboardConnectionResponse>**](AdminDashboardConnectionResponse.md) | Connections on the current page | [default to undefined]
|
|
10
|
+
**total** | **number** | Total number of connections matching the filters | [default to undefined]
|
|
11
|
+
**page** | **number** | Current page (1-indexed) | [default to undefined]
|
|
12
|
+
**limit** | **number** | Page size | [default to undefined]
|
|
13
|
+
**totalPages** | **number** | Total number of pages | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,11 +6,11 @@ Paginated player list response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<AdminPlayerSummary>**](AdminPlayerSummary.md) | Players on the current page | [
|
|
10
|
-
**total** | **number** | Total number of players matching the search filter | [
|
|
11
|
-
**page** | **number** | Current page (1-indexed) | [
|
|
12
|
-
**limit** | **number** | Page size | [
|
|
13
|
-
**totalPages** | **number** | Total number of pages | [
|
|
9
|
+
**data** | [**Array<AdminPlayerSummary>**](AdminPlayerSummary.md) | Players on the current page | [default to undefined]
|
|
10
|
+
**total** | **number** | Total number of players matching the search filter | [default to undefined]
|
|
11
|
+
**page** | **number** | Current page (1-indexed) | [default to undefined]
|
|
12
|
+
**limit** | **number** | Page size | [default to undefined]
|
|
13
|
+
**totalPages** | **number** | Total number of pages | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,11 +6,11 @@ Paginated punishment list response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<AdminPunishmentListItem>**](AdminPunishmentListItem.md) | Punishments on the current page | [
|
|
10
|
-
**total** | **number** | Total number of punishments matching the filters | [
|
|
11
|
-
**page** | **number** | Current page (1-indexed) | [
|
|
12
|
-
**limit** | **number** | Page size | [
|
|
13
|
-
**totalPages** | **number** | Total number of pages | [
|
|
9
|
+
**data** | [**Array<AdminPunishmentListItem>**](AdminPunishmentListItem.md) | Punishments on the current page | [default to undefined]
|
|
10
|
+
**total** | **number** | Total number of punishments matching the filters | [default to undefined]
|
|
11
|
+
**page** | **number** | Current page (1-indexed) | [default to undefined]
|
|
12
|
+
**limit** | **number** | Page size | [default to undefined]
|
|
13
|
+
**totalPages** | **number** | Total number of pages | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,15 +6,15 @@ Full player detail including punishment history and all known usernames
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Internal player ID | [
|
|
10
|
-
**uuid** | **string** | Player Minecraft UUID | [
|
|
9
|
+
**id** | **number** | Internal player ID | [default to undefined]
|
|
10
|
+
**uuid** | **string** | Player Minecraft UUID | [default to undefined]
|
|
11
11
|
**username** | **string** | Most recently seen username | [optional] [default to undefined]
|
|
12
|
-
**firstJoin** | **boolean** | Whether this player still has first-join status | [
|
|
13
|
-
**firstLogin** | **string** | Timestamp of first connection (ISO-8601) | [
|
|
12
|
+
**firstJoin** | **boolean** | Whether this player still has first-join status | [default to undefined]
|
|
13
|
+
**firstLogin** | **string** | Timestamp of first connection (ISO-8601) | [default to undefined]
|
|
14
14
|
**lastUsedAt** | **string** | Timestamp of most recent connection (ISO-8601) | [optional] [default to undefined]
|
|
15
|
-
**punishmentPointsRaw** | **number** | Raw punishment score | [
|
|
16
|
-
**punishmentPointsPercent** | **number** | Punishment score as a percentage | [
|
|
17
|
-
**usernameHistory** | [**Array<AdminUsernameHistoryEntry>**](AdminUsernameHistoryEntry.md) | All usernames this player has used, newest first | [
|
|
15
|
+
**punishmentPointsRaw** | **number** | Raw punishment score | [default to undefined]
|
|
16
|
+
**punishmentPointsPercent** | **number** | Punishment score as a percentage | [default to undefined]
|
|
17
|
+
**usernameHistory** | [**Array<AdminUsernameHistoryEntry>**](AdminUsernameHistoryEntry.md) | All usernames this player has used, newest first | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,7 +6,7 @@ Lightweight player reference used in search results and punishment evaluations
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**uuid** | **string** | Player Minecraft UUID | [
|
|
9
|
+
**uuid** | **string** | Player Minecraft UUID | [default to undefined]
|
|
10
10
|
**username** | **string** | Most recently seen username, null if never recorded | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,14 +6,14 @@ Summary of a player record, used in list views
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Internal player ID | [
|
|
10
|
-
**uuid** | **string** | Player Minecraft UUID | [
|
|
9
|
+
**id** | **number** | Internal player ID | [default to undefined]
|
|
10
|
+
**uuid** | **string** | Player Minecraft UUID | [default to undefined]
|
|
11
11
|
**username** | **string** | Most recently seen username, null if never recorded | [optional] [default to undefined]
|
|
12
|
-
**firstJoin** | **boolean** | Whether this player still has first-join status | [
|
|
13
|
-
**firstLogin** | **string** | Timestamp of first connection (ISO-8601) | [
|
|
12
|
+
**firstJoin** | **boolean** | Whether this player still has first-join status | [default to undefined]
|
|
13
|
+
**firstLogin** | **string** | Timestamp of first connection (ISO-8601) | [default to undefined]
|
|
14
14
|
**lastUsedAt** | **string** | Timestamp of most recent connection (ISO-8601) | [optional] [default to undefined]
|
|
15
|
-
**punishmentPointsRaw** | **number** | Raw punishment score (sum of weighted punishment values) | [
|
|
16
|
-
**punishmentPointsPercent** | **number** | Punishment score as a percentage. Values above 100 indicate future punishments should be permanent. | [
|
|
15
|
+
**punishmentPointsRaw** | **number** | Raw punishment score (sum of weighted punishment values) | [default to undefined]
|
|
16
|
+
**punishmentPointsPercent** | **number** | Punishment score as a percentage. Values above 100 indicate future punishments should be permanent. | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -6,7 +6,7 @@ Batch punishment draft — one evaluation per target
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**evaluations** | [**Array<AdminPunishmentEvaluation>**](AdminPunishmentEvaluation.md) | Ordered list of evaluations, one per target in the request | [
|
|
9
|
+
**evaluations** | [**Array<AdminPunishmentEvaluation>**](AdminPunishmentEvaluation.md) | Ordered list of evaluations, one per target in the request | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,16 +6,16 @@ Evaluation of a punishment\'s impact on a single target
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**target** | [**AdminPunishmentTarget**](AdminPunishmentTarget.md) | The target this evaluation applies to | [
|
|
10
|
-
**affectedPlayers** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Players affected — one player for UUID targets, all players on the IP for connection targets | [
|
|
11
|
-
**currentScore** | **number** | Current punishment score before applying this punishment (0–100+) | [
|
|
12
|
-
**pointsToAdd** | **number** | Points this punishment would add to the score | [
|
|
13
|
-
**newScore** | **number** | Projected score after applying this punishment | [
|
|
14
|
-
**willBePermanent** | **boolean** | Whether this punishment would be permanent based on the current score threshold | [
|
|
9
|
+
**target** | [**AdminPunishmentTarget**](AdminPunishmentTarget.md) | The target this evaluation applies to | [default to undefined]
|
|
10
|
+
**affectedPlayers** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Players affected — one player for UUID targets, all players on the IP for connection targets | [default to undefined]
|
|
11
|
+
**currentScore** | **number** | Current punishment score before applying this punishment (0–100+) | [default to undefined]
|
|
12
|
+
**pointsToAdd** | **number** | Points this punishment would add to the score | [default to undefined]
|
|
13
|
+
**newScore** | **number** | Projected score after applying this punishment | [default to undefined]
|
|
14
|
+
**willBePermanent** | **boolean** | Whether this punishment would be permanent based on the current score threshold | [default to undefined]
|
|
15
15
|
**durationSeconds** | **number** | Resolved duration in seconds — null if permanent or a WARNING | [optional] [default to undefined]
|
|
16
|
-
**previousPunishmentCount** | **number** | Number of existing punishments on this target | [
|
|
17
|
-
**isConnectionTarget** | **boolean** | True when the target is an IP address (connection punishment) rather than a player UUID | [
|
|
18
|
-
**effectiveType** | **
|
|
16
|
+
**previousPunishmentCount** | **number** | Number of existing punishments on this target | [default to undefined]
|
|
17
|
+
**isConnectionTarget** | **boolean** | True when the target is an IP address (connection punishment) rather than a player UUID | [default to undefined]
|
|
18
|
+
**effectiveType** | [**PunishmentType**](PunishmentType.md) | The effective punishment type that will be applied — may differ from the requested type if escalated to BAN at threshold | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **number** | | [default to undefined]
|
|
9
9
|
**reason** | **string** | | [default to undefined]
|
|
10
10
|
**notes** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**type** | **
|
|
11
|
+
**type** | [**PunishmentType**](PunishmentType.md) | | [default to undefined]
|
|
12
12
|
**severity** | **number** | | [default to undefined]
|
|
13
13
|
**createdBy** | **string** | | [default to undefined]
|
|
14
14
|
**expiresAt** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**createdAt** | **string** | | [default to undefined]
|
|
16
|
-
**targetType** | **
|
|
16
|
+
**targetType** | [**PunishmentTargetType**](PunishmentTargetType.md) | | [default to undefined]
|
|
17
17
|
**targetUuid** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**targetUsername** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**targetIp** | **string** | | [optional] [default to undefined]
|
|
@@ -6,9 +6,9 @@ Result of a punishment target search — either a list of matching players or a
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**kind** | **
|
|
10
|
-
**players** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Matching players — only populated when kind=\'player\' | [
|
|
11
|
-
**ipResults** | [**Array<AdminIpSearchResult>**](AdminIpSearchResult.md) | Matching IP addresses with their associated players — only populated when kind=\'ip\' | [
|
|
9
|
+
**kind** | [**SearchKind**](SearchKind.md) | Search kind — PLAYER for UUID/username searches, IP for IP address searches | [default to undefined]
|
|
10
|
+
**players** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Matching players — only populated when kind=\'player\' | [default to undefined]
|
|
11
|
+
**ipResults** | [**Array<AdminIpSearchResult>**](AdminIpSearchResult.md) | Matching IP addresses with their associated players — only populated when kind=\'ip\' | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|