@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
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:
|
|
5
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
7
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
5
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
7
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
5
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
6
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
5
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
7
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
5
|
+
* The version of the OpenAPI document: 4.0.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:
|
|
8
|
+
* The version of the OpenAPI document: 4.0.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# AdminAltAccount
|
|
2
|
+
|
|
3
|
+
Another player who has been seen on at least one of this player\'s historical connections — i.e. an alt account candidate.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**uuid** | **string** | Alt player\'s Minecraft UUID | [default to undefined]
|
|
10
|
+
**username** | **string** | Most recently seen username for the alt, null if never recorded | [optional] [default to undefined]
|
|
11
|
+
**lastUsedAt** | **string** | Timestamp of the alt\'s most recent connection (ISO-8601), null if never connected | [optional] [default to undefined]
|
|
12
|
+
**sharedConnectionCount** | **number** | Number of distinct connections this alt shares with the source player | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { AdminAltAccount } from '@rebornteam/reborn-api';
|
|
18
|
+
|
|
19
|
+
const instance: AdminAltAccount = {
|
|
20
|
+
uuid,
|
|
21
|
+
username,
|
|
22
|
+
lastUsedAt,
|
|
23
|
+
sharedConnectionCount,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[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,31 @@
|
|
|
1
|
+
# AdminAltExemption
|
|
2
|
+
|
|
3
|
+
Per-pair exemption from aggressive-mode alt propagation. When a row exists with (player_id=X, alt_player_id=Y), propagation for X will skip Y as an alt source.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**playerUuid** | **string** | Player this exemption applies to | [default to undefined]
|
|
10
|
+
**altPlayerUuid** | **string** | Player to be skipped as an alt source | [default to undefined]
|
|
11
|
+
**altPlayerUsername** | **string** | Most recent username of the exempted alt | [optional] [default to undefined]
|
|
12
|
+
**createdBy** | **string** | Staff member who created the exemption | [default to undefined]
|
|
13
|
+
**createdAt** | **string** | When the exemption was created (ISO-8601) | [default to undefined]
|
|
14
|
+
**reason** | **string** | Optional human-readable reason | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { AdminAltExemption } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: AdminAltExemption = {
|
|
22
|
+
playerUuid,
|
|
23
|
+
altPlayerUuid,
|
|
24
|
+
altPlayerUsername,
|
|
25
|
+
createdBy,
|
|
26
|
+
createdAt,
|
|
27
|
+
reason,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**target** | [**AdminPunishmentTarget**](AdminPunishmentTarget.md) | The target this result applies to | [default to undefined]
|
|
10
10
|
**punishmentId** | **number** | ID of the created punishment record | [default to undefined]
|
|
11
11
|
**type** | [**PunishmentType**](PunishmentType.md) | Punishment type applied | [default to undefined]
|
|
12
|
-
**severity** | **number** | Severity level applied | [default to undefined]
|
|
13
|
-
**
|
|
14
|
-
**isPermanent** | **boolean** | Whether the punishment was made permanent | [default to undefined]
|
|
12
|
+
**severity** | **number** | Severity level applied (1-4) | [default to undefined]
|
|
13
|
+
**newTrustFactor** | **number** | Trust factor (0-100) for the targeted player after the punishment landed. Present only when the target is a player; absent for any other target shape. | [optional] [default to undefined]
|
|
14
|
+
**isPermanent** | **boolean** | Whether the punishment was made permanent. Mirrors the request\'s forcePermanent flag — auto-escalation has been removed. | [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
|
|
@@ -24,7 +24,7 @@ const instance: AdminApplyPunishmentResult = {
|
|
|
24
24
|
punishmentId,
|
|
25
25
|
type,
|
|
26
26
|
severity,
|
|
27
|
-
|
|
27
|
+
newTrustFactor,
|
|
28
28
|
isPermanent,
|
|
29
29
|
expiresAt,
|
|
30
30
|
};
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# AdminAsyncJob
|
|
2
|
+
|
|
3
|
+
One row of admin_job — a long-running admin operation.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Job id | [default to undefined]
|
|
10
|
+
**jobType** | **string** | Stable identifier of what kind of work this is (e.g. LOCATION_BACKFILL) | [default to undefined]
|
|
11
|
+
**status** | [**JobStatus**](JobStatus.md) | Current lifecycle state. | [default to undefined]
|
|
12
|
+
**progressCurrent** | **number** | Number of units processed so far | [default to undefined]
|
|
13
|
+
**progressTotal** | **number** | Total units, when known up front. Null when total is undetermined. | [optional] [default to undefined]
|
|
14
|
+
**progressMessage** | **string** | Optional human-readable status line (e.g. \"Re-checking IpHub\"). | [optional] [default to undefined]
|
|
15
|
+
**errorMessage** | **string** | Error message when status = FAILED. Null otherwise. | [optional] [default to undefined]
|
|
16
|
+
**resultPayload** | **object** | Type-specific JSON result, populated when status = COMPLETED. Schema varies by jobType — consult the docs for each type. | [optional] [default to undefined]
|
|
17
|
+
**startedBy** | **string** | Admin who submitted the job (Discord username for SSO admins). | [default to undefined]
|
|
18
|
+
**startedAt** | **string** | When the job was submitted (ISO-8601). | [default to undefined]
|
|
19
|
+
**lastProgressAt** | **string** | Timestamp of the most recent progress update. The reaper marks jobs FAILED when this falls behind by 5 min. | [default to undefined]
|
|
20
|
+
**finishedAt** | **string** | When the job entered a terminal state. Null while running. | [optional] [default to undefined]
|
|
21
|
+
**cancelRequested** | **boolean** | True if an admin has requested cancellation. The host instance picks this up at its next progress tick. | [default to undefined]
|
|
22
|
+
**hostInstance** | **string** | Identifier of the API instance that is running this job. Other instances can see state and request cancellation but cannot dispose the in-flight Reactor subscription directly. | [default to undefined]
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { AdminAsyncJob } from '@rebornteam/reborn-api';
|
|
28
|
+
|
|
29
|
+
const instance: AdminAsyncJob = {
|
|
30
|
+
id,
|
|
31
|
+
jobType,
|
|
32
|
+
status,
|
|
33
|
+
progressCurrent,
|
|
34
|
+
progressTotal,
|
|
35
|
+
progressMessage,
|
|
36
|
+
errorMessage,
|
|
37
|
+
resultPayload,
|
|
38
|
+
startedBy,
|
|
39
|
+
startedAt,
|
|
40
|
+
lastProgressAt,
|
|
41
|
+
finishedAt,
|
|
42
|
+
cancelRequested,
|
|
43
|
+
hostInstance,
|
|
44
|
+
};
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[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,21 @@
|
|
|
1
|
+
# AdminAsyncJobStartResponse
|
|
2
|
+
|
|
3
|
+
Acknowledgement returned by endpoints that submit an async job. The id is the polling target — GET /admin/job/{id} for status, DELETE /admin/job/{id} to cancel.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**jobId** | **string** | Server-assigned job id | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminAsyncJobStartResponse } from '@rebornteam/reborn-api';
|
|
15
|
+
|
|
16
|
+
const instance: AdminAsyncJobStartResponse = {
|
|
17
|
+
jobId,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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,141 @@
|
|
|
1
|
+
# AdminAuditLogApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.smsh.sh*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**search**](#search) | **GET** /admin/audit-log | Search the admin audit log|
|
|
8
|
+
|[**searchCursor**](#searchcursor) | **GET** /admin/audit-log/cursor | Cursor-paginated audit-log search (infinite scroll)|
|
|
9
|
+
|
|
10
|
+
# **search**
|
|
11
|
+
> PageAdminAuditLogEntry search()
|
|
12
|
+
|
|
13
|
+
Paginated audit-log search. All filter parameters are optional; an empty filter set returns the most recent rows across the system. Sorted newest-first.
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
AdminAuditLogApi,
|
|
20
|
+
Configuration,
|
|
21
|
+
Pageable
|
|
22
|
+
} from '@rebornteam/reborn-api';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new AdminAuditLogApi(configuration);
|
|
26
|
+
|
|
27
|
+
let pageable: Pageable; // (default to undefined)
|
|
28
|
+
let actor: string; //Filter to actions performed by this Discord username (case-sensitive exact match) (optional) (default to undefined)
|
|
29
|
+
let action: string; //Filter to a specific action verb (e.g. REVOKE_PROPAGATED_LINK, SET_AGGRESSIVE_MODE_IMMUNITY) (optional) (default to undefined)
|
|
30
|
+
let targetType: string; //Filter to a specific target type (e.g. PLAYER, PUNISHMENT, PLAYER_PUNISHMENT) (optional) (default to undefined)
|
|
31
|
+
let targetId: string; //Filter to a specific target id (paired with targetType for narrowing) (optional) (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.search(
|
|
34
|
+
pageable,
|
|
35
|
+
actor,
|
|
36
|
+
action,
|
|
37
|
+
targetType,
|
|
38
|
+
targetId
|
|
39
|
+
);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
|Name | Type | Description | Notes|
|
|
45
|
+
|------------- | ------------- | ------------- | -------------|
|
|
46
|
+
| **pageable** | **Pageable** | | defaults to undefined|
|
|
47
|
+
| **actor** | [**string**] | Filter to actions performed by this Discord username (case-sensitive exact match) | (optional) defaults to undefined|
|
|
48
|
+
| **action** | [**string**] | Filter to a specific action verb (e.g. REVOKE_PROPAGATED_LINK, SET_AGGRESSIVE_MODE_IMMUNITY) | (optional) defaults to undefined|
|
|
49
|
+
| **targetType** | [**string**] | Filter to a specific target type (e.g. PLAYER, PUNISHMENT, PLAYER_PUNISHMENT) | (optional) defaults to undefined|
|
|
50
|
+
| **targetId** | [**string**] | Filter to a specific target id (paired with targetType for narrowing) | (optional) defaults to undefined|
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
**PageAdminAuditLogEntry**
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: Not defined
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
### HTTP response details
|
|
68
|
+
| Status code | Description | Response headers |
|
|
69
|
+
|-------------|-------------|------------------|
|
|
70
|
+
|**200** | Audit-log page retrieved | - |
|
|
71
|
+
|**401** | Unauthorized | - |
|
|
72
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
73
|
+
|
|
74
|
+
[[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)
|
|
75
|
+
|
|
76
|
+
# **searchCursor**
|
|
77
|
+
> CursoredPageAdminAuditLogEntry searchCursor()
|
|
78
|
+
|
|
79
|
+
Cursor-based companion to GET /admin/audit-log. Preferred for the admin UI\'s infinite-scroll view of the audit log because the SQL plan stays flat as the table grows — offset pagination degrades linearly with depth, this does not. Pass the {@code cursor} returned in the previous response to get the next page; omit it for the first page.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import {
|
|
85
|
+
AdminAuditLogApi,
|
|
86
|
+
Configuration,
|
|
87
|
+
CursoredPageable
|
|
88
|
+
} from '@rebornteam/reborn-api';
|
|
89
|
+
|
|
90
|
+
const configuration = new Configuration();
|
|
91
|
+
const apiInstance = new AdminAuditLogApi(configuration);
|
|
92
|
+
|
|
93
|
+
let pageable: CursoredPageable; // (default to undefined)
|
|
94
|
+
let actor: string; // (optional) (default to undefined)
|
|
95
|
+
let action: string; // (optional) (default to undefined)
|
|
96
|
+
let targetType: string; // (optional) (default to undefined)
|
|
97
|
+
let targetId: string; // (optional) (default to undefined)
|
|
98
|
+
|
|
99
|
+
const { status, data } = await apiInstance.searchCursor(
|
|
100
|
+
pageable,
|
|
101
|
+
actor,
|
|
102
|
+
action,
|
|
103
|
+
targetType,
|
|
104
|
+
targetId
|
|
105
|
+
);
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
|Name | Type | Description | Notes|
|
|
111
|
+
|------------- | ------------- | ------------- | -------------|
|
|
112
|
+
| **pageable** | **CursoredPageable** | | defaults to undefined|
|
|
113
|
+
| **actor** | [**string**] | | (optional) defaults to undefined|
|
|
114
|
+
| **action** | [**string**] | | (optional) defaults to undefined|
|
|
115
|
+
| **targetType** | [**string**] | | (optional) defaults to undefined|
|
|
116
|
+
| **targetId** | [**string**] | | (optional) defaults to undefined|
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### Return type
|
|
120
|
+
|
|
121
|
+
**CursoredPageAdminAuditLogEntry**
|
|
122
|
+
|
|
123
|
+
### Authorization
|
|
124
|
+
|
|
125
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
126
|
+
|
|
127
|
+
### HTTP request headers
|
|
128
|
+
|
|
129
|
+
- **Content-Type**: Not defined
|
|
130
|
+
- **Accept**: application/json
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
### HTTP response details
|
|
134
|
+
| Status code | Description | Response headers |
|
|
135
|
+
|-------------|-------------|------------------|
|
|
136
|
+
|**200** | Cursor page retrieved | - |
|
|
137
|
+
|**401** | Unauthorized | - |
|
|
138
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
139
|
+
|
|
140
|
+
[[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)
|
|
141
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# AdminAuditLogEntry
|
|
2
|
+
|
|
3
|
+
Single admin audit-log entry. Captures who did what to which target with an action-specific JSON payload (e.g. before/after for edits, count for bulk ops).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Sequential id (ordering matches createdAt) | [default to undefined]
|
|
10
|
+
**actorUsername** | **string** | Discord username of the moderator who performed the action | [default to undefined]
|
|
11
|
+
**action** | **string** | Action verb. Open-vocabulary; current values include APPLY_PUNISHMENT, EDIT_PUNISHMENT, REVOKE_PROPAGATED_LINK, BULK_REVOKE, SET_AGGRESSIVE_MODE_IMMUNITY, ADD_ALT_EXEMPTION, REMOVE_ALT_EXEMPTION. | [default to undefined]
|
|
12
|
+
**targetType** | **string** | Type of entity acted upon (PLAYER, PUNISHMENT, PLAYER_PUNISHMENT, etc.) | [default to undefined]
|
|
13
|
+
**targetId** | **string** | Identifier of the target (stringified id or UUID, depending on targetType) | [default to undefined]
|
|
14
|
+
**payload** | **string** | Action-specific JSON payload. Shape depends on the action. | [optional] [default to undefined]
|
|
15
|
+
**createdAt** | **string** | When the action occurred (ISO-8601) | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { AdminAuditLogEntry } from '@rebornteam/reborn-api';
|
|
21
|
+
|
|
22
|
+
const instance: AdminAuditLogEntry = {
|
|
23
|
+
id,
|
|
24
|
+
actorUsername,
|
|
25
|
+
action,
|
|
26
|
+
targetType,
|
|
27
|
+
targetId,
|
|
28
|
+
payload,
|
|
29
|
+
createdAt,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[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,25 @@
|
|
|
1
|
+
# AdminBulkRevokeRequest
|
|
2
|
+
|
|
3
|
+
Bulk-revoke every active PROPAGATED player_punishment row sourced from a single alt or connection. Used when staff identify a false-positive source (e.g. a shared NAT or legitimate roommate) and want to undo every link it caused.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sourcePlayerId** | **number** | Revoke links whose source_player_id matches. Mutually exclusive with sourceConnectionId. | [optional] [default to undefined]
|
|
10
|
+
**sourceConnectionId** | **number** | Revoke links whose source_connection_id matches. Mutually exclusive with sourcePlayerId. | [optional] [default to undefined]
|
|
11
|
+
**reason** | **string** | Optional reason for the audit log | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminBulkRevokeRequest } from '@rebornteam/reborn-api';
|
|
17
|
+
|
|
18
|
+
const instance: AdminBulkRevokeRequest = {
|
|
19
|
+
sourcePlayerId,
|
|
20
|
+
sourceConnectionId,
|
|
21
|
+
reason,
|
|
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,21 @@
|
|
|
1
|
+
# AdminBulkRevokeResponse
|
|
2
|
+
|
|
3
|
+
Result of a bulk-revoke operation
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**revoked** | **number** | Number of player_punishment rows soft-deleted by the operation | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminBulkRevokeResponse } from '@rebornteam/reborn-api';
|
|
15
|
+
|
|
16
|
+
const instance: AdminBulkRevokeResponse = {
|
|
17
|
+
revoked,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**checkedAt** | **string** | When this check was last performed | [default to undefined]
|
|
12
12
|
**city** | **string** | City reported by this service, if available | [optional] [default to undefined]
|
|
13
13
|
**country** | **string** | Country code reported by this service, if available | [optional] [default to undefined]
|
|
14
|
+
**latitude** | **number** | Latitude reported by this service, if available | [optional] [default to undefined]
|
|
15
|
+
**longitude** | **number** | Longitude reported by this service, if available | [optional] [default to undefined]
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -23,6 +25,8 @@ const instance: AdminConnectionCheckResult = {
|
|
|
23
25
|
checkedAt,
|
|
24
26
|
city,
|
|
25
27
|
country,
|
|
28
|
+
latitude,
|
|
29
|
+
longitude,
|
|
26
30
|
};
|
|
27
31
|
```
|
|
28
32
|
|