@rebornteam/reborn-api 2.9.1 → 3.1.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 +8 -0
- package/README.md +11 -2
- package/api.ts +280 -100
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +197 -97
- package/dist/api.js +149 -51
- 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 +197 -97
- package/dist/esm/api.js +147 -50
- 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 +1 -1
- package/docs/AdminApplyPunishmentResult.md +1 -1
- package/docs/AdminConnectionCheckResult.md +25 -0
- package/docs/AdminConnectionsApi.md +59 -0
- package/docs/AdminCreatePunishmentDraftRequest.md +1 -1
- package/docs/AdminDashboardConnectionResponse.md +2 -0
- package/docs/AdminPunishmentEvaluation.md +1 -1
- package/docs/AdminPunishmentListItem.md +2 -2
- package/docs/AdminPunishmentSearchResponse.md +1 -1
- package/docs/AdminPunishmentsApi.md +5 -5
- package/docs/ConnectionGetConnectionDetailsResponse.md +11 -7
- package/docs/ConnectionResult.md +25 -0
- package/docs/ConnectionResultResultCode.md +20 -0
- package/docs/GameType.md +12 -0
- package/docs/PlayerApi.md +7 -8
- package/docs/PlayerGetPlayerInformation.md +4 -4
- package/docs/PunishmentApi.md +4 -4
- package/docs/PunishmentGetPunishmentResponse.md +1 -1
- package/docs/PunishmentSeveritiesResponsePunishmentTypeInfo.md +1 -1
- 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
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
7
7
|
|[**createBypass**](#createbypass) | **POST** /admin/connection/bypass | Create connection bypass|
|
|
8
8
|
|[**listAllConnections**](#listallconnections) | **GET** /admin/connection | List all connections (paginated)|
|
|
9
9
|
|[**listConnections**](#listconnections) | **GET** /admin/connection/recent | List recent connections|
|
|
10
|
+
|[**recheckService**](#recheckservice) | **POST** /admin/connection/{connectionId}/recheck/{service} | Refresh a single VPN check|
|
|
10
11
|
|
|
11
12
|
# **createBypass**
|
|
12
13
|
> AdminConnectionBypassResponse createBypass(createBypassRequest)
|
|
@@ -199,3 +200,61 @@ const { status, data } = await apiInstance.listConnections(
|
|
|
199
200
|
|
|
200
201
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
201
202
|
|
|
203
|
+
# **recheckService**
|
|
204
|
+
> AdminConnectionCheckResult recheckService()
|
|
205
|
+
|
|
206
|
+
Re-runs one named VPN detection service for a specific connection, persists the updated result, and recalculates the connection\'s overall `percentPositive` and `numberOfChecks` from all stored checks. Returns the refreshed check result including its new `checkedAt` timestamp.
|
|
207
|
+
|
|
208
|
+
### Example
|
|
209
|
+
|
|
210
|
+
```typescript
|
|
211
|
+
import {
|
|
212
|
+
AdminConnectionsApi,
|
|
213
|
+
Configuration
|
|
214
|
+
} from '@rebornteam/reborn-api';
|
|
215
|
+
|
|
216
|
+
const configuration = new Configuration();
|
|
217
|
+
const apiInstance = new AdminConnectionsApi(configuration);
|
|
218
|
+
|
|
219
|
+
let connectionId: number; // (default to undefined)
|
|
220
|
+
let service: string; // (default to undefined)
|
|
221
|
+
|
|
222
|
+
const { status, data } = await apiInstance.recheckService(
|
|
223
|
+
connectionId,
|
|
224
|
+
service
|
|
225
|
+
);
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Parameters
|
|
229
|
+
|
|
230
|
+
|Name | Type | Description | Notes|
|
|
231
|
+
|------------- | ------------- | ------------- | -------------|
|
|
232
|
+
| **connectionId** | [**number**] | | defaults to undefined|
|
|
233
|
+
| **service** | [**string**] | | defaults to undefined|
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
### Return type
|
|
237
|
+
|
|
238
|
+
**AdminConnectionCheckResult**
|
|
239
|
+
|
|
240
|
+
### Authorization
|
|
241
|
+
|
|
242
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
243
|
+
|
|
244
|
+
### HTTP request headers
|
|
245
|
+
|
|
246
|
+
- **Content-Type**: Not defined
|
|
247
|
+
- **Accept**: application/json
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
### HTTP response details
|
|
251
|
+
| Status code | Description | Response headers |
|
|
252
|
+
|-------------|-------------|------------------|
|
|
253
|
+
|**200** | Check refreshed successfully | - |
|
|
254
|
+
|**400** | Unknown or unavailable service name | - |
|
|
255
|
+
|**401** | Unauthorized - Authentication required | - |
|
|
256
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
257
|
+
|**404** | Connection not found | - |
|
|
258
|
+
|
|
259
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
260
|
+
|
|
@@ -7,7 +7,7 @@ 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** | **
|
|
10
|
+
**type** | [**PunishmentType**](PunishmentType.md) | Punishment type | [default to undefined]
|
|
11
11
|
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [optional] [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]
|
|
@@ -15,6 +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 | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,6 +33,7 @@ const instance: AdminDashboardConnectionResponse = {
|
|
|
32
33
|
lastSeen,
|
|
33
34
|
percentPositive,
|
|
34
35
|
numberOfChecks,
|
|
36
|
+
results,
|
|
35
37
|
};
|
|
36
38
|
```
|
|
37
39
|
|
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**durationSeconds** | **number** | Resolved duration in seconds — null if permanent or a WARNING | [optional] [default to undefined]
|
|
16
16
|
**previousPunishmentCount** | **number** | Number of existing punishments on this target | [optional] [default to undefined]
|
|
17
17
|
**isConnectionTarget** | **boolean** | True when the target is an IP address (connection punishment) rather than a player UUID | [optional] [default to undefined]
|
|
18
|
-
**effectiveType** | **
|
|
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 | [optional] [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,7 +6,7 @@ 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** | **
|
|
9
|
+
**kind** | [**SearchKind**](SearchKind.md) | Search kind — PLAYER for UUID/username searches, IP for IP address searches | [optional] [default to undefined]
|
|
10
10
|
**players** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Matching players — only populated when kind=\'player\' | [optional] [default to undefined]
|
|
11
11
|
**ipResults** | [**Array<AdminIpSearchResult>**](AdminIpSearchResult.md) | Matching IP addresses with their associated players — only populated when kind=\'ip\' | [optional] [default to undefined]
|
|
12
12
|
|
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
12
12
|
# **applyPunishment**
|
|
13
13
|
> AdminApplyPunishmentResponse applyPunishment(adminApplyPunishmentRequest)
|
|
14
14
|
|
|
15
|
-
Apply a punishment to one or more targets.
|
|
15
|
+
Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.applyPunishment(
|
|
|
67
67
|
# **createDraft**
|
|
68
68
|
> AdminPunishmentDraftResponse createDraft(adminCreatePunishmentDraftRequest)
|
|
69
69
|
|
|
70
|
-
Preview the impact of a punishment across one or more targets.
|
|
70
|
+
Preview the impact of a punishment across one or more targets. No changes are made.
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
|
@@ -140,7 +140,7 @@ let limit: number; //Page size (default to 50)
|
|
|
140
140
|
let uuid: string; //Filter by player UUID (optional) (default to undefined)
|
|
141
141
|
let username: string; //Filter by player username (case-insensitive substring match) (optional) (default to undefined)
|
|
142
142
|
let ipAddress: string; //Filter by IP address (optional) (default to undefined)
|
|
143
|
-
let type: Array<
|
|
143
|
+
let type: Array<PunishmentType>; //Filter by punishment type. Repeatable. (optional) (default to undefined)
|
|
144
144
|
let issuedAfter: number; //Filter punishments issued after this epoch timestamp (ms) (optional) (default to undefined)
|
|
145
145
|
let issuedBefore: number; //Filter punishments issued before this epoch timestamp (ms) (optional) (default to undefined)
|
|
146
146
|
|
|
@@ -165,7 +165,7 @@ const { status, data } = await apiInstance.getPunishments(
|
|
|
165
165
|
| **uuid** | [**string**] | Filter by player UUID | (optional) defaults to undefined|
|
|
166
166
|
| **username** | [**string**] | Filter by player username (case-insensitive substring match) | (optional) defaults to undefined|
|
|
167
167
|
| **ipAddress** | [**string**] | Filter by IP address | (optional) defaults to undefined|
|
|
168
|
-
| **type** | **Array<
|
|
168
|
+
| **type** | **Array<PunishmentType>** | Filter by punishment type. Repeatable. | (optional) defaults to undefined|
|
|
169
169
|
| **issuedAfter** | [**number**] | Filter punishments issued after this epoch timestamp (ms) | (optional) defaults to undefined|
|
|
170
170
|
| **issuedBefore** | [**number**] | Filter punishments issued before this epoch timestamp (ms) | (optional) defaults to undefined|
|
|
171
171
|
|
|
@@ -196,7 +196,7 @@ const { status, data } = await apiInstance.getPunishments(
|
|
|
196
196
|
# **searchTargets**
|
|
197
197
|
> AdminPunishmentSearchResponse searchTargets()
|
|
198
198
|
|
|
199
|
-
Search for players by UUID or username, or look up all players associated with an IP address.
|
|
199
|
+
Search for players by UUID or username, or look up all players associated with an IP address.
|
|
200
200
|
|
|
201
201
|
### Example
|
|
202
202
|
|
|
@@ -7,13 +7,15 @@ Comprehensive connection analysis response including VPN detection, geolocation,
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**ipAddress** | **string** | The analyzed IPv4 address | [optional] [default to undefined]
|
|
10
|
-
**approximateLocation** | **string** | Approximate geographic location of the IP address
|
|
11
|
-
**percentPositive** | **number** | 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).
|
|
12
|
-
**numberOfChecks** | **number** | Total number of VPN detection services successfully queried during the last check.
|
|
13
|
-
**
|
|
14
|
-
**bypassedUntil** | **string** | Expiration timestamp for the bypass (ISO-8601 format).
|
|
15
|
-
**
|
|
10
|
+
**approximateLocation** | **string** | Approximate geographic location of the IP address. Returns \'Local, N/A\' for localhost or private IPs. | [optional] [default to undefined]
|
|
11
|
+
**percentPositive** | **number** | 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). | [optional] [default to undefined]
|
|
12
|
+
**numberOfChecks** | **number** | Total number of VPN detection services successfully queried during the last check. | [optional] [default to undefined]
|
|
13
|
+
**isBypassed** | **boolean** | Indicates if this IP address has been administratively bypassed. | [optional] [default to undefined]
|
|
14
|
+
**bypassedUntil** | **string** | Expiration timestamp for the bypass (ISO-8601 format). Null if not bypassed or bypass is permanent. | [optional] [default to undefined]
|
|
15
|
+
**results** | [**Array<AdminConnectionCheckResult>**](AdminConnectionCheckResult.md) | Results from each VPN detection service that checked this IP address | [optional] [default to undefined]
|
|
16
|
+
**playerInformation** | [**PlayerGetPlayerInformation**](PlayerGetPlayerInformation.md) | Player information associated with this connection. Only populated when \'associate_uuid\' query parameter is provided. | [optional] [default to undefined]
|
|
16
17
|
**punishments** | [**Array<PunishmentGetPunishmentResponse>**](PunishmentGetPunishmentResponse.md) | Combined list of active punishments for both the IP address and player UUID (if provided). Only includes non-expired punishments. | [optional] [default to undefined]
|
|
18
|
+
**connectionResult** | [**ConnectionResult**](ConnectionResult.md) | Join enforcement result. Only populated when \'associate_uuid\' query parameter is provided. Contains the final allow/deny decision and a formatted kick message if denied. | [optional] [default to undefined]
|
|
17
19
|
|
|
18
20
|
## Example
|
|
19
21
|
|
|
@@ -25,10 +27,12 @@ const instance: ConnectionGetConnectionDetailsResponse = {
|
|
|
25
27
|
approximateLocation,
|
|
26
28
|
percentPositive,
|
|
27
29
|
numberOfChecks,
|
|
28
|
-
|
|
30
|
+
isBypassed,
|
|
29
31
|
bypassedUntil,
|
|
32
|
+
results,
|
|
30
33
|
playerInformation,
|
|
31
34
|
punishments,
|
|
35
|
+
connectionResult,
|
|
32
36
|
};
|
|
33
37
|
```
|
|
34
38
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ConnectionResult
|
|
2
|
+
|
|
3
|
+
Join enforcement result. Only populated when \'associate_uuid\' query parameter is provided. Contains the final allow/deny decision and a formatted kick message if denied.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | [**ConnectionResultResultCode**](ConnectionResultResultCode.md) | | [default to undefined]
|
|
10
|
+
**allowed** | **boolean** | | [default to undefined]
|
|
11
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ConnectionResult } from '@rebornteam/reborn-api';
|
|
17
|
+
|
|
18
|
+
const instance: ConnectionResult = {
|
|
19
|
+
code,
|
|
20
|
+
allowed,
|
|
21
|
+
message,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ConnectionResultResultCode
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Allowed` (value: `'ALLOWED'`)
|
|
7
|
+
|
|
8
|
+
* `AllowedBypass` (value: `'ALLOWED_BYPASS'`)
|
|
9
|
+
|
|
10
|
+
* `AllowedPlayerBypass` (value: `'ALLOWED_PLAYER_BYPASS'`)
|
|
11
|
+
|
|
12
|
+
* `Banned` (value: `'BANNED'`)
|
|
13
|
+
|
|
14
|
+
* `VpnDetected` (value: `'VPN_DETECTED'`)
|
|
15
|
+
|
|
16
|
+
* `VpnRetry` (value: `'VPN_RETRY'`)
|
|
17
|
+
|
|
18
|
+
* `VpnTempBanned` (value: `'VPN_TEMP_BANNED'`)
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/GameType.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# GameType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Rotj` (value: `'ROTJ'`)
|
|
7
|
+
|
|
8
|
+
* `Legacy` (value: `'LEGACY'`)
|
|
9
|
+
|
|
10
|
+
* `Classic` (value: `'CLASSIC'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/PlayerApi.md
CHANGED
|
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
10
10
|
# **getPlayer1**
|
|
11
11
|
> PlayerGetPlayerInformation getPlayer1()
|
|
12
12
|
|
|
13
|
-
Retrieves player information by
|
|
13
|
+
Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -23,7 +23,7 @@ import {
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
24
|
const apiInstance = new PlayerApi(configuration);
|
|
25
25
|
|
|
26
|
-
let uuid: string; //
|
|
26
|
+
let uuid: string; // (default to undefined)
|
|
27
27
|
|
|
28
28
|
const { status, data } = await apiInstance.getPlayer1(
|
|
29
29
|
uuid
|
|
@@ -34,7 +34,7 @@ const { status, data } = await apiInstance.getPlayer1(
|
|
|
34
34
|
|
|
35
35
|
|Name | Type | Description | Notes|
|
|
36
36
|
|------------- | ------------- | ------------- | -------------|
|
|
37
|
-
| **uuid** | [**string**] |
|
|
37
|
+
| **uuid** | [**string**] | | defaults to undefined|
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### Return type
|
|
@@ -55,8 +55,7 @@ const { status, data } = await apiInstance.getPlayer1(
|
|
|
55
55
|
| Status code | Description | Response headers |
|
|
56
56
|
|-------------|-------------|------------------|
|
|
57
57
|
|**200** | Player information retrieved successfully | - |
|
|
58
|
-
|**401** | Unauthorized
|
|
59
|
-
|**400** | Bad request — invalid UUID format | - |
|
|
58
|
+
|**401** | Unauthorized | - |
|
|
60
59
|
|**404** | Player not found | - |
|
|
61
60
|
|
|
62
61
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -64,7 +63,7 @@ const { status, data } = await apiInstance.getPlayer1(
|
|
|
64
63
|
# **getUsernames**
|
|
65
64
|
> getUsernames()
|
|
66
65
|
|
|
67
|
-
Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record
|
|
66
|
+
Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record are omitted from the response.
|
|
68
67
|
|
|
69
68
|
### Example
|
|
70
69
|
|
|
@@ -77,7 +76,7 @@ import {
|
|
|
77
76
|
const configuration = new Configuration();
|
|
78
77
|
const apiInstance = new PlayerApi(configuration);
|
|
79
78
|
|
|
80
|
-
let uuids: Array<string>; //List of player UUIDs to resolve (
|
|
79
|
+
let uuids: Array<string>; //List of player UUIDs to resolve (default to undefined)
|
|
81
80
|
|
|
82
81
|
const { status, data } = await apiInstance.getUsernames(
|
|
83
82
|
uuids
|
|
@@ -88,7 +87,7 @@ const { status, data } = await apiInstance.getUsernames(
|
|
|
88
87
|
|
|
89
88
|
|Name | Type | Description | Notes|
|
|
90
89
|
|------------- | ------------- | ------------- | -------------|
|
|
91
|
-
| **uuids** | **Array<string>** | List of player UUIDs to resolve
|
|
90
|
+
| **uuids** | **Array<string>** | List of player UUIDs to resolve | defaults to undefined|
|
|
92
91
|
|
|
93
92
|
|
|
94
93
|
### Return type
|
|
@@ -6,10 +6,10 @@ Player information including join history, tracking data, and punishment scoring
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**firstJoin** | **boolean** | Indicates whether this is the player\'s first time joining the server. | [optional] [default to undefined]
|
|
9
10
|
**firstLogin** | **string** | Timestamp of when the player first connected to the server (ISO-8601 format). | [optional] [default to undefined]
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**punishmentPointsPercent** | **number** | 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. | [optional] [default to undefined]
|
|
11
|
+
**punishmentPointsRaw** | **number** | Raw punishment score calculated as: SUM((base_weight × severity/10)). Used for tracking overall punishment severity. | [optional] [default to undefined]
|
|
12
|
+
**punishmentPointsPercent** | **number** | Punishment score as a percentage (0-100). When >100% before applying a new punishment, the new punishment should be made permanent. | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -17,8 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
import { PlayerGetPlayerInformation } from '@rebornteam/reborn-api';
|
|
18
18
|
|
|
19
19
|
const instance: PlayerGetPlayerInformation = {
|
|
20
|
-
firstLogin,
|
|
21
20
|
firstJoin,
|
|
21
|
+
firstLogin,
|
|
22
22
|
punishmentPointsRaw,
|
|
23
23
|
punishmentPointsPercent,
|
|
24
24
|
};
|
package/docs/PunishmentApi.md
CHANGED
|
@@ -71,7 +71,7 @@ const apiInstance = new PunishmentApi(configuration);
|
|
|
71
71
|
|
|
72
72
|
let uuid: string; //Player UUID (optional) (default to undefined)
|
|
73
73
|
let username: string; //Player username (optional) (default to undefined)
|
|
74
|
-
let type: Array<
|
|
74
|
+
let type: Array<PunishmentType>; //Filter by punishment types (optional) (default to undefined)
|
|
75
75
|
let since: number; //Filter punishments created after this Unix epoch timestamp (milliseconds) (optional) (default to undefined)
|
|
76
76
|
|
|
77
77
|
const { status, data } = await apiInstance.getPunishments1(
|
|
@@ -88,7 +88,7 @@ const { status, data } = await apiInstance.getPunishments1(
|
|
|
88
88
|
|------------- | ------------- | ------------- | -------------|
|
|
89
89
|
| **uuid** | [**string**] | Player UUID | (optional) defaults to undefined|
|
|
90
90
|
| **username** | [**string**] | Player username | (optional) defaults to undefined|
|
|
91
|
-
| **type** | **Array<
|
|
91
|
+
| **type** | **Array<PunishmentType>** | Filter by punishment types | (optional) defaults to undefined|
|
|
92
92
|
| **since** | [**number**] | Filter punishments created after this Unix epoch timestamp (milliseconds) | (optional) defaults to undefined|
|
|
93
93
|
|
|
94
94
|
|
|
@@ -186,7 +186,7 @@ let issuedAfter: number; //Filter punishments issued after this epoch timestamp
|
|
|
186
186
|
let issuedBefore: number; //Filter punishments issued before this epoch timestamp (milliseconds) (optional) (default to undefined)
|
|
187
187
|
let expiresAfter: number; //Filter punishments expiring after this epoch timestamp (milliseconds) (optional) (default to undefined)
|
|
188
188
|
let expiresBefore: number; //Filter punishments expiring before this epoch timestamp (milliseconds) (optional) (default to undefined)
|
|
189
|
-
let type: Array<
|
|
189
|
+
let type: Array<PunishmentType>; //Filter by punishment types (optional) (default to undefined)
|
|
190
190
|
let uuid: string; //Filter by player UUID (optional) (default to undefined)
|
|
191
191
|
let ipAddress: string; //Filter by IP address (optional) (default to undefined)
|
|
192
192
|
|
|
@@ -213,7 +213,7 @@ const { status, data } = await apiInstance.getRecentPunishments(
|
|
|
213
213
|
| **issuedBefore** | [**number**] | Filter punishments issued before this epoch timestamp (milliseconds) | (optional) defaults to undefined|
|
|
214
214
|
| **expiresAfter** | [**number**] | Filter punishments expiring after this epoch timestamp (milliseconds) | (optional) defaults to undefined|
|
|
215
215
|
| **expiresBefore** | [**number**] | Filter punishments expiring before this epoch timestamp (milliseconds) | (optional) defaults to undefined|
|
|
216
|
-
| **type** | **Array<
|
|
216
|
+
| **type** | **Array<PunishmentType>** | Filter by punishment types | (optional) defaults to undefined|
|
|
217
217
|
| **uuid** | [**string**] | Filter by player UUID | (optional) defaults to undefined|
|
|
218
218
|
| **ipAddress** | [**string**] | Filter by IP address | (optional) defaults to undefined|
|
|
219
219
|
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**id** | **number** | Unique identifier for the punishment | [optional] [default to undefined]
|
|
10
10
|
**reason** | **string** | Reason for the punishment, shown to the punished player | [optional] [default to undefined]
|
|
11
11
|
**notes** | **string** | Internal administrator notes — not shown to the punished player | [optional] [default to undefined]
|
|
12
|
-
**type** | **
|
|
12
|
+
**type** | [**PunishmentType**](PunishmentType.md) | Type of punishment | [optional] [default to undefined]
|
|
13
13
|
**severity** | **number** | Severity level (1=Minor, 2=Moderate, 3=Severe, 4=Critical) | [optional] [default to undefined]
|
|
14
14
|
**createdBy** | **string** | Username or identifier of the person who created this punishment | [optional] [default to undefined]
|
|
15
15
|
**expiresAt** | **string** | Timestamp when the punishment expires (ISO-8601 format). Null for permanent punishments. | [optional] [default to undefined]
|
|
@@ -6,7 +6,7 @@ Punishment type with severity information
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**type** | **
|
|
9
|
+
**type** | [**PunishmentType**](PunishmentType.md) | Type of punishment | [optional] [default to undefined]
|
|
10
10
|
**severities** | [**Array<PunishmentSeveritiesResponseSeverityInfo>**](PunishmentSeveritiesResponseSeverityInfo.md) | List of severity levels with durations | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# PunishmentTargetType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Player` (value: `'PLAYER'`)
|
|
7
|
+
|
|
8
|
+
* `Connection` (value: `'CONNECTION'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# PunishmentType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Ban` (value: `'BAN'`)
|
|
7
|
+
|
|
8
|
+
* `Mute` (value: `'MUTE'`)
|
|
9
|
+
|
|
10
|
+
* `Warning` (value: `'WARNING'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Region.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Region
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Us` (value: `'US'`)
|
|
7
|
+
|
|
8
|
+
* `Eu` (value: `'EU'`)
|
|
9
|
+
|
|
10
|
+
* `Au` (value: `'AU'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# SearchKind
|
|
2
|
+
|
|
3
|
+
Search kind — PLAYER for UUID/username searches, IP for IP address searches
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Player` (value: `'PLAYER'`)
|
|
8
|
+
|
|
9
|
+
* `Ip` (value: `'IP'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**region** | **
|
|
9
|
-
**gameType** | **
|
|
8
|
+
**region** | [**Region**](Region.md) | | [default to undefined]
|
|
9
|
+
**gameType** | [**GameType**](GameType.md) | | [default to undefined]
|
|
10
10
|
**containerId** | **string** | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
package/docs/ServerSessionDTO.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
-
**region** | **
|
|
10
|
-
**gameType** | **
|
|
9
|
+
**region** | [**Region**](Region.md) | | [default to undefined]
|
|
10
|
+
**gameType** | [**GameType**](GameType.md) | | [default to undefined]
|
|
11
11
|
**instanceName** | **string** | | [default to undefined]
|
|
12
12
|
**containerId** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**startedAt** | **string** | | [default to undefined]
|
package/index.ts
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:
|
|
7
|
+
* The version of the OpenAPI document: 3.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|