@rebornteam/reborn-api 3.2.1 → 4.0.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 +65 -4
- package/README.md +93 -8
- package/api.ts +3979 -537
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2462 -386
- package/dist/api.js +2750 -361
- 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 +2462 -386
- package/dist/esm/api.js +2722 -353
- 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/AdminAltAccount.md +27 -0
- package/docs/AdminAltExemption.md +31 -0
- package/docs/AdminApplyPunishmentResult.md +4 -4
- package/docs/AdminAsyncJob.md +47 -0
- package/docs/AdminAsyncJobStartResponse.md +21 -0
- package/docs/AdminAuditLogApi.md +141 -0
- package/docs/AdminAuditLogEntry.md +33 -0
- package/docs/AdminBulkRevokeRequest.md +25 -0
- package/docs/AdminBulkRevokeResponse.md +21 -0
- package/docs/AdminConnectionCheckResult.md +4 -0
- package/docs/AdminConnectionsApi.md +154 -39
- package/docs/AdminCreateAltExemptionRequest.md +23 -0
- package/docs/AdminCreatePlayerNoteRequest.md +21 -0
- package/docs/AdminDashboardConnectionResponse.md +4 -2
- package/docs/AdminJobsApi.md +175 -0
- package/docs/AdminPlayerDetailResponse.md +4 -4
- package/docs/AdminPlayerNote.md +31 -0
- package/docs/AdminPlayerPunishmentResponse.md +51 -0
- package/docs/AdminPlayerReport.md +39 -0
- package/docs/AdminPlayerSession.md +31 -0
- package/docs/AdminPlayerSessionStats.md +29 -0
- package/docs/AdminPlayerSummary.md +2 -4
- package/docs/AdminPlayersApi.md +936 -16
- package/docs/AdminPunishmentEvaluation.md +4 -8
- package/docs/AdminPunishmentsApi.md +78 -21
- package/docs/AdminReportTarget.md +23 -0
- package/docs/AdminReportsApi.md +123 -0
- package/docs/AdminResolveReportRequest.md +21 -0
- package/docs/AdminSetAggressiveModeImmunityRequest.md +21 -0
- package/docs/AdminTrustFactorBreakdown.md +61 -0
- package/docs/AdminTrustFactorHistoryEntry.md +23 -0
- package/docs/AdminTrustFactorImpact.md +23 -0
- package/docs/AdminUpdatePunishmentRequest.md +27 -0
- package/docs/ChatApi.md +4 -4
- package/docs/ConnectionApi.md +4 -4
- package/docs/ConnectionGetConnectionDetailsResponse.md +5 -1
- package/docs/ConnectionResult.md +1 -1
- package/docs/CreateReportRequest.md +27 -0
- package/docs/CreateReportResponse.md +23 -0
- package/docs/CursoredPageAdminAuditLogEntry.md +38 -0
- package/docs/CursoredPageable.md +30 -0
- package/docs/JobStatus.md +17 -0
- package/docs/PageAdminAltAccount.md +36 -0
- package/docs/PageAdminAltExemption.md +36 -0
- package/docs/PageAdminAsyncJob.md +36 -0
- package/docs/PageAdminAuditLogEntry.md +36 -0
- package/docs/PageAdminDashboardConnectionResponse.md +36 -0
- package/docs/PageAdminPlayerNote.md +36 -0
- package/docs/PageAdminPlayerPunishmentResponse.md +36 -0
- package/docs/PageAdminPlayerReport.md +36 -0
- package/docs/PageAdminPlayerSession.md +36 -0
- package/docs/PageAdminPlayerSummary.md +36 -0
- package/docs/PageAdminPunishmentListItem.md +36 -0
- package/docs/PagePunishmentGetPunishmentResponse.md +36 -0
- package/docs/Pageable.md +28 -0
- package/docs/PageableMode.md +12 -0
- package/docs/PlayerGetPlayerInformation.md +5 -3
- package/docs/PlayerSessionEndRequest.md +23 -0
- package/docs/PlayerSessionStartRequest.md +27 -0
- package/docs/PlayerSessionStartResponse.md +51 -0
- package/docs/PlayerSessionsApi.md +116 -0
- package/docs/PunishmentApi.md +22 -24
- package/docs/PunishmentSource.md +11 -0
- package/docs/PunishmentType.md +1 -0
- package/docs/ReportApi.md +64 -0
- package/docs/ReportCategory.md +17 -0
- package/docs/SliceAdminAltAccount.md +32 -0
- package/docs/SliceAdminAltExemption.md +32 -0
- package/docs/SliceAdminAsyncJob.md +32 -0
- package/docs/SliceAdminAuditLogEntry.md +32 -0
- package/docs/SliceAdminDashboardConnectionResponse.md +32 -0
- package/docs/SliceAdminPlayerNote.md +32 -0
- package/docs/SliceAdminPlayerPunishmentResponse.md +32 -0
- package/docs/SliceAdminPlayerReport.md +32 -0
- package/docs/SliceAdminPlayerSession.md +32 -0
- package/docs/SliceAdminPlayerSummary.md +32 -0
- package/docs/SliceAdminPunishmentListItem.md +32 -0
- package/docs/SlicePunishmentGetPunishmentResponse.md +32 -0
- package/docs/Sort.md +20 -0
- package/docs/SortOrder.md +26 -0
- package/docs/SortOrderDirection.md +10 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/AdminBackfillLocationResponse.md +0 -25
- package/docs/AdminPagedConnectionResponse.md +0 -29
- package/docs/AdminPagedPlayerResponse.md +0 -29
- package/docs/AdminPagedPunishmentResponse.md +0 -29
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# PlayerSessionStartResponse
|
|
2
|
+
|
|
3
|
+
Result of POST /v1/player-session/start. Always populated; session fields are null when the player was not allowed in.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sessionId** | **string** | Session row id. Null when the join was not allowed. | [optional] [default to undefined]
|
|
10
|
+
**startedAt** | **string** | When the session was opened (ISO-8601). For re-attached sessions this is the original start time, not now. Null when the join was not allowed. | [optional] [default to undefined]
|
|
11
|
+
**playerUuid** | **string** | Player Minecraft UUID | [default to undefined]
|
|
12
|
+
**serverSessionId** | **string** | Server session id the join applies to | [default to undefined]
|
|
13
|
+
**connectionResult** | [**ConnectionResult**](ConnectionResult.md) | Final allow/deny verdict plus formatted kick message if denied. | [default to undefined]
|
|
14
|
+
**ipAddress** | **string** | Player\'s connecting IP, echoed from the request | [default to undefined]
|
|
15
|
+
**city** | **string** | City reported by the first VPN provider that returned one. Null when no provider has city data (private IPs, localhost, sparse providers). | [optional] [default to undefined]
|
|
16
|
+
**country** | **string** | Country code reported by the first VPN provider that returned one (ISO 3166-1 alpha-2 or alpha-3 depending on provider). | [optional] [default to undefined]
|
|
17
|
+
**percentPositive** | **number** | Confidence score (0.0–100.0) representing what fraction of VPN detection services flagged this IP as suspicious. | [default to undefined]
|
|
18
|
+
**numberOfChecks** | **number** | Total VPN detection services successfully queried on this IP | [default to undefined]
|
|
19
|
+
**isBypassed** | **boolean** | Whether this IP has an active administrative VPN bypass | [default to undefined]
|
|
20
|
+
**bypassedUntil** | **string** | Bypass expiration timestamp; null if not bypassed or bypass is permanent. | [optional] [default to undefined]
|
|
21
|
+
**checkResults** | [**Array<AdminConnectionCheckResult>**](AdminConnectionCheckResult.md) | Per-provider VPN check results, useful for the admin UI / debugging. | [optional] [default to undefined]
|
|
22
|
+
**playerInformation** | [**PlayerGetPlayerInformation**](PlayerGetPlayerInformation.md) | Player info (first-join flag, first login, punishment score). Null only in edge cases where the player record could not be loaded. | [optional] [default to undefined]
|
|
23
|
+
**activePunishments** | [**Array<PunishmentGetPunishmentResponse>**](PunishmentGetPunishmentResponse.md) | Active (non-expired, non-revoked) punishments on this player, including any that were just propagated by the join check. | [default to undefined]
|
|
24
|
+
**sessionStats** | [**AdminPlayerSessionStats**](AdminPlayerSessionStats.md) | Aggregate session stats. Useful for game-server-side welcome messages (\"Welcome back — you\'ve played 250 hours\") or for the chat plugin to know if the player is a returning user. | [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { PlayerSessionStartResponse } from '@rebornteam/reborn-api';
|
|
30
|
+
|
|
31
|
+
const instance: PlayerSessionStartResponse = {
|
|
32
|
+
sessionId,
|
|
33
|
+
startedAt,
|
|
34
|
+
playerUuid,
|
|
35
|
+
serverSessionId,
|
|
36
|
+
connectionResult,
|
|
37
|
+
ipAddress,
|
|
38
|
+
city,
|
|
39
|
+
country,
|
|
40
|
+
percentPositive,
|
|
41
|
+
numberOfChecks,
|
|
42
|
+
isBypassed,
|
|
43
|
+
bypassedUntil,
|
|
44
|
+
checkResults,
|
|
45
|
+
playerInformation,
|
|
46
|
+
activePunishments,
|
|
47
|
+
sessionStats,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[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,116 @@
|
|
|
1
|
+
# PlayerSessionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.smsh.sh*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**end**](#end) | **POST** /v1/player-session/end | Close the active player session|
|
|
8
|
+
|[**start**](#start) | **POST** /v1/player-session/start | Player join — unified authorization + session-open|
|
|
9
|
+
|
|
10
|
+
# **end**
|
|
11
|
+
> end(playerSessionEndRequest)
|
|
12
|
+
|
|
13
|
+
Closes the active session for a (playerUuid, serverSessionId) pair. No-op if no active session is found, so duplicate end events from a retry don\'t error.
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
PlayerSessionsApi,
|
|
20
|
+
Configuration,
|
|
21
|
+
PlayerSessionEndRequest
|
|
22
|
+
} from '@rebornteam/reborn-api';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new PlayerSessionsApi(configuration);
|
|
26
|
+
|
|
27
|
+
let playerSessionEndRequest: PlayerSessionEndRequest; //
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.end(
|
|
30
|
+
playerSessionEndRequest
|
|
31
|
+
);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
|Name | Type | Description | Notes|
|
|
37
|
+
|------------- | ------------- | ------------- | -------------|
|
|
38
|
+
| **playerSessionEndRequest** | **PlayerSessionEndRequest**| | |
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Return type
|
|
42
|
+
|
|
43
|
+
void (empty response body)
|
|
44
|
+
|
|
45
|
+
### Authorization
|
|
46
|
+
|
|
47
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
48
|
+
|
|
49
|
+
### HTTP request headers
|
|
50
|
+
|
|
51
|
+
- **Content-Type**: application/json
|
|
52
|
+
- **Accept**: Not defined
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### HTTP response details
|
|
56
|
+
| Status code | Description | Response headers |
|
|
57
|
+
|-------------|-------------|------------------|
|
|
58
|
+
|**204** | Session closed (or no-op if no active session) | - |
|
|
59
|
+
|**401** | Unauthorized | - |
|
|
60
|
+
|
|
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)
|
|
62
|
+
|
|
63
|
+
# **start**
|
|
64
|
+
> PlayerSessionStartResponse start(playerSessionStartRequest)
|
|
65
|
+
|
|
66
|
+
Single round-trip the game server / proxy makes when a player joins. Runs the full authorization check (VPN detection, bypass tiers, punishment propagation, active-ban evaluation) and — only if allowed — opens (or re-attaches to) a player_session row. Replaces the older two-call flow (`GET /v1/connection/details` followed by a session-open POST). `/v1/connection/details` remains available for admin / debugging use but is deprecated for player-join purposes. Idempotent at the session-open step: a duplicate join request returns the existing active session\'s id instead of creating a duplicate row. Response shape: - `connectionResult` — always populated; carries ALLOWED / BANNED / VPN_DETECTED etc. plus a formatted kick message when denied. - `sessionId` / `startedAt` — populated only when the join was allowed. - Connection context (IP, location, VPN%, bypass) for display + logging. - `playerInformation`, `activePunishments` — full player history at join time. - `sessionStats` — total seconds played / days active / currently-online, useful for game-server-side welcome messages.
|
|
67
|
+
|
|
68
|
+
### Example
|
|
69
|
+
|
|
70
|
+
```typescript
|
|
71
|
+
import {
|
|
72
|
+
PlayerSessionsApi,
|
|
73
|
+
Configuration,
|
|
74
|
+
PlayerSessionStartRequest
|
|
75
|
+
} from '@rebornteam/reborn-api';
|
|
76
|
+
|
|
77
|
+
const configuration = new Configuration();
|
|
78
|
+
const apiInstance = new PlayerSessionsApi(configuration);
|
|
79
|
+
|
|
80
|
+
let playerSessionStartRequest: PlayerSessionStartRequest; //
|
|
81
|
+
|
|
82
|
+
const { status, data } = await apiInstance.start(
|
|
83
|
+
playerSessionStartRequest
|
|
84
|
+
);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
|Name | Type | Description | Notes|
|
|
90
|
+
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **playerSessionStartRequest** | **PlayerSessionStartRequest**| | |
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### Return type
|
|
95
|
+
|
|
96
|
+
**PlayerSessionStartResponse**
|
|
97
|
+
|
|
98
|
+
### Authorization
|
|
99
|
+
|
|
100
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
101
|
+
|
|
102
|
+
### HTTP request headers
|
|
103
|
+
|
|
104
|
+
- **Content-Type**: application/json
|
|
105
|
+
- **Accept**: application/json
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### HTTP response details
|
|
109
|
+
| Status code | Description | Response headers |
|
|
110
|
+
|-------------|-------------|------------------|
|
|
111
|
+
|**201** | Join handled. Inspect `connectionResult.allowed` to decide whether to admit the player. | - |
|
|
112
|
+
|**400** | Invalid request (missing fields, malformed IP, etc.) | - |
|
|
113
|
+
|**401** | Unauthorized | - |
|
|
114
|
+
|
|
115
|
+
[[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)
|
|
116
|
+
|
package/docs/PunishmentApi.md
CHANGED
|
@@ -165,7 +165,7 @@ const { status, data } = await apiInstance.getPunishmentsByIp(
|
|
|
165
165
|
[[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)
|
|
166
166
|
|
|
167
167
|
# **getRecentPunishments**
|
|
168
|
-
>
|
|
168
|
+
> PagePunishmentGetPunishmentResponse getRecentPunishments()
|
|
169
169
|
|
|
170
170
|
Returns a paginated list of recent punishments with optional filtering by issue date, expiration date, and type
|
|
171
171
|
|
|
@@ -174,25 +174,24 @@ Returns a paginated list of recent punishments with optional filtering by issue
|
|
|
174
174
|
```typescript
|
|
175
175
|
import {
|
|
176
176
|
PunishmentApi,
|
|
177
|
-
Configuration
|
|
177
|
+
Configuration,
|
|
178
|
+
Pageable
|
|
178
179
|
} from '@rebornteam/reborn-api';
|
|
179
180
|
|
|
180
181
|
const configuration = new Configuration();
|
|
181
182
|
const apiInstance = new PunishmentApi(configuration);
|
|
182
183
|
|
|
183
|
-
let
|
|
184
|
-
let
|
|
185
|
-
let
|
|
186
|
-
let
|
|
187
|
-
let
|
|
188
|
-
let
|
|
189
|
-
let
|
|
190
|
-
let
|
|
191
|
-
let ipAddress: string; //Filter by IP address (optional) (default to undefined)
|
|
184
|
+
let pageable: Pageable; // (default to undefined)
|
|
185
|
+
let issuedAfter: number; // (optional) (default to undefined)
|
|
186
|
+
let issuedBefore: number; // (optional) (default to undefined)
|
|
187
|
+
let expiresAfter: number; // (optional) (default to undefined)
|
|
188
|
+
let expiresBefore: number; // (optional) (default to undefined)
|
|
189
|
+
let type: Array<PunishmentType>; // (optional) (default to undefined)
|
|
190
|
+
let uuid: string; // (optional) (default to undefined)
|
|
191
|
+
let ipAddress: string; // (optional) (default to undefined)
|
|
192
192
|
|
|
193
193
|
const { status, data } = await apiInstance.getRecentPunishments(
|
|
194
|
-
|
|
195
|
-
page,
|
|
194
|
+
pageable,
|
|
196
195
|
issuedAfter,
|
|
197
196
|
issuedBefore,
|
|
198
197
|
expiresAfter,
|
|
@@ -207,20 +206,19 @@ const { status, data } = await apiInstance.getRecentPunishments(
|
|
|
207
206
|
|
|
208
207
|
|Name | Type | Description | Notes|
|
|
209
208
|
|------------- | ------------- | ------------- | -------------|
|
|
210
|
-
| **
|
|
211
|
-
| **
|
|
212
|
-
| **
|
|
213
|
-
| **
|
|
214
|
-
| **
|
|
215
|
-
| **
|
|
216
|
-
| **
|
|
217
|
-
| **
|
|
218
|
-
| **ipAddress** | [**string**] | Filter by IP address | (optional) defaults to undefined|
|
|
209
|
+
| **pageable** | **Pageable** | | defaults to undefined|
|
|
210
|
+
| **issuedAfter** | [**number**] | | (optional) defaults to undefined|
|
|
211
|
+
| **issuedBefore** | [**number**] | | (optional) defaults to undefined|
|
|
212
|
+
| **expiresAfter** | [**number**] | | (optional) defaults to undefined|
|
|
213
|
+
| **expiresBefore** | [**number**] | | (optional) defaults to undefined|
|
|
214
|
+
| **type** | **Array<PunishmentType>** | | (optional) defaults to undefined|
|
|
215
|
+
| **uuid** | [**string**] | | (optional) defaults to undefined|
|
|
216
|
+
| **ipAddress** | [**string**] | | (optional) defaults to undefined|
|
|
219
217
|
|
|
220
218
|
|
|
221
219
|
### Return type
|
|
222
220
|
|
|
223
|
-
**
|
|
221
|
+
**PagePunishmentGetPunishmentResponse**
|
|
224
222
|
|
|
225
223
|
### Authorization
|
|
226
224
|
|
|
@@ -235,7 +233,7 @@ const { status, data } = await apiInstance.getRecentPunishments(
|
|
|
235
233
|
### HTTP response details
|
|
236
234
|
| Status code | Description | Response headers |
|
|
237
235
|
|-------------|-------------|------------------|
|
|
238
|
-
|**200** |
|
|
236
|
+
|**200** | Paged list of recent punishments | - |
|
|
239
237
|
|
|
240
238
|
[[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)
|
|
241
239
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# PunishmentSource
|
|
2
|
+
|
|
3
|
+
How this link came to exist. DIRECT links are immutable from the link side (remove via the punishment-level delete); PROPAGATED links are revocable individually.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Direct` (value: `'DIRECT'`)
|
|
8
|
+
|
|
9
|
+
* `Propagated` (value: `'PROPAGATED'`)
|
|
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)
|
package/docs/PunishmentType.md
CHANGED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# ReportApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.smsh.sh*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**submit**](#submit) | **POST** /v1/report | Submit a peer report|
|
|
8
|
+
|
|
9
|
+
# **submit**
|
|
10
|
+
> CreateReportResponse submit(createReportRequest)
|
|
11
|
+
|
|
12
|
+
Records that {reporterUuid} flagged one OR MORE players for misconduct in a single incident. Idempotent per (reporter, exact target set) while the prior report is unresolved — repeat submissions with the same target set overwrite reason / category in place and the response\'s {@code deduplicated} flag is true. A different target set (even overlapping) creates a new report. Resolved reports do not block fresh submissions. **Active-report cap**: each reporter may hold at most 3 unresolved reports at a time. A 4th submission with a NEW target set returns 429 until staff resolve one of the existing reports. Dedupe updates (same target set) never count against the cap.
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
ReportApi,
|
|
19
|
+
Configuration,
|
|
20
|
+
CreateReportRequest
|
|
21
|
+
} from '@rebornteam/reborn-api';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new ReportApi(configuration);
|
|
25
|
+
|
|
26
|
+
let createReportRequest: CreateReportRequest; //
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.submit(
|
|
29
|
+
createReportRequest
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **createReportRequest** | **CreateReportRequest**| | |
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**CreateReportResponse**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: application/json
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**201** | Report accepted | - |
|
|
58
|
+
|**400** | Validation error (UUID malformed, reason out of range, empty target list, or reporter listed as one of their own targets) | - |
|
|
59
|
+
|**404** | Reporter or any reported UUID has no player record | - |
|
|
60
|
+
|**429** | Reporter is at the active-report cap. Wait for staff to resolve an existing report. | - |
|
|
61
|
+
|**401** | Unauthorized | - |
|
|
62
|
+
|
|
63
|
+
[[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
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportCategory
|
|
2
|
+
|
|
3
|
+
Category of misconduct. Coarse on purpose — staff refine in triage.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Cheating` (value: `'CHEATING'`)
|
|
8
|
+
|
|
9
|
+
* `Harassment` (value: `'HARASSMENT'`)
|
|
10
|
+
|
|
11
|
+
* `ChatAbuse` (value: `'CHAT_ABUSE'`)
|
|
12
|
+
|
|
13
|
+
* `Griefing` (value: `'GRIEFING'`)
|
|
14
|
+
|
|
15
|
+
* `Other` (value: `'OTHER'`)
|
|
16
|
+
|
|
17
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminAltAccount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminAltAccount>**](AdminAltAccount.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminAltAccount } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminAltAccount = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminAltExemption
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminAltExemption>**](AdminAltExemption.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminAltExemption } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminAltExemption = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminAsyncJob
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminAsyncJob>**](AdminAsyncJob.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminAsyncJob } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminAsyncJob = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminAuditLogEntry
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminAuditLogEntry>**](AdminAuditLogEntry.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminAuditLogEntry } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminAuditLogEntry = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminDashboardConnectionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminDashboardConnectionResponse>**](AdminDashboardConnectionResponse.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminDashboardConnectionResponse } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminDashboardConnectionResponse = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminPlayerNote
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminPlayerNote>**](AdminPlayerNote.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminPlayerNote } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminPlayerNote = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminPlayerPunishmentResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminPlayerPunishmentResponse>**](AdminPlayerPunishmentResponse.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminPlayerPunishmentResponse } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminPlayerPunishmentResponse = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminPlayerReport
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminPlayerReport>**](AdminPlayerReport.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminPlayerReport } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminPlayerReport = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,32 @@
|
|
|
1
|
+
# SliceAdminPlayerSession
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | [**Array<AdminPlayerSession>**](AdminPlayerSession.md) | | [default to undefined]
|
|
9
|
+
**pageable** | [**Pageable**](Pageable.md) | | [default to undefined]
|
|
10
|
+
**pageNumber** | **number** | | [default to undefined]
|
|
11
|
+
**offset** | **number** | | [default to undefined]
|
|
12
|
+
**size** | **number** | | [default to undefined]
|
|
13
|
+
**empty** | **boolean** | | [default to undefined]
|
|
14
|
+
**numberOfElements** | **number** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { SliceAdminPlayerSession } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: SliceAdminPlayerSession = {
|
|
22
|
+
content,
|
|
23
|
+
pageable,
|
|
24
|
+
pageNumber,
|
|
25
|
+
offset,
|
|
26
|
+
size,
|
|
27
|
+
empty,
|
|
28
|
+
numberOfElements,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|