@rebornteam/reborn-api 2.5.1 → 2.6.4
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 +20 -4
- package/README.md +32 -12
- package/api.ts +1372 -357
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +795 -176
- package/dist/api.js +954 -268
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +795 -176
- package/dist/esm/api.js +917 -243
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/AdminApplyPunishmentRequest.md +33 -0
- package/docs/AdminApplyPunishmentResponse.md +21 -0
- package/docs/AdminApplyPunishmentResult.md +33 -0
- package/docs/AdminClientCredentialResponse.md +2 -0
- package/docs/AdminClientCredentialsApi.md +17 -17
- package/docs/AdminConnectionsApi.md +70 -4
- package/docs/AdminCreatePunishmentDraftRequest.md +31 -0
- package/docs/AdminDashboardApi.md +2 -2
- package/docs/AdminIpSearchResult.md +23 -0
- package/docs/AdminPagedConnectionResponse.md +29 -0
- package/docs/AdminPagedPlayerResponse.md +29 -0
- package/docs/AdminPagedPunishmentResponse.md +29 -0
- package/docs/AdminPlayerDetailResponse.md +37 -0
- package/docs/AdminPlayerSearchResult.md +23 -0
- package/docs/AdminPlayerSummary.md +35 -0
- package/docs/AdminPlayersApi.md +122 -0
- package/docs/AdminPunishmentDraftResponse.md +21 -0
- package/docs/AdminPunishmentEvaluation.md +39 -0
- package/docs/AdminPunishmentListItem.md +42 -0
- package/docs/AdminPunishmentSearchResponse.md +25 -0
- package/docs/AdminPunishmentTarget.md +23 -0
- package/docs/AdminPunishmentsApi.md +248 -0
- package/docs/AdminUsernameHistoryEntry.md +23 -0
- package/docs/ClientCredentialRequest.md +2 -0
- package/docs/ConnectionApi.md +1 -1
- package/docs/DefaultApi.md +105 -0
- package/docs/PlayerApi.md +5 -5
- package/docs/PunishmentApi.md +8 -114
- package/docs/PunishmentGetPunishmentResponse.md +5 -3
- package/index.ts +2 -2
- package/package.json +2 -2
- package/docs/ApplyPunishmentRequest.md +0 -31
- package/docs/ApplyPunishmentResponse.md +0 -33
- package/docs/CreatePunishmentDraftRequest.md +0 -29
- package/docs/PunishmentDraftResponse.md +0 -39
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Reborn API
|
|
3
|
-
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **
|
|
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: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.6.4
|
|
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
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Reborn API
|
|
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 - **
|
|
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: 2.
|
|
7
|
+
* The version of the OpenAPI document: 2.6.4
|
|
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
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Reborn API
|
|
3
|
-
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **
|
|
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: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.6.4
|
|
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
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Reborn API
|
|
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 - **
|
|
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: 2.
|
|
7
|
+
* The version of the OpenAPI document: 2.6.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Reborn API
|
|
3
|
-
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **
|
|
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: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.6.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/**
|
|
3
3
|
* Reborn API
|
|
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 - **
|
|
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: 2.
|
|
6
|
+
* The version of the OpenAPI document: 2.6.4
|
|
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
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Reborn API
|
|
3
|
-
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **
|
|
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: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.6.4
|
|
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
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Reborn API
|
|
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 - **
|
|
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: 2.
|
|
7
|
+
* The version of the OpenAPI document: 2.6.4
|
|
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
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Reborn API
|
|
3
|
-
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **
|
|
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: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.6.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Reborn API
|
|
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 - **
|
|
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: 2.
|
|
8
|
+
* The version of the OpenAPI document: 2.6.4
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# AdminApplyPunishmentRequest
|
|
2
|
+
|
|
3
|
+
Request to apply a punishment to one or more targets
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**targets** | [**Array<AdminPunishmentTarget>**](AdminPunishmentTarget.md) | List of targets to punish — each must have either a uuid or ipAddress | [default to undefined]
|
|
10
|
+
**type** | **string** | Punishment type | [default to undefined]
|
|
11
|
+
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [optional] [default to undefined]
|
|
12
|
+
**reason** | **string** | Reason for the punishment | [default to undefined]
|
|
13
|
+
**durationSeconds** | **number** | Custom duration in seconds — if omitted the suggested duration for the type and severity is used | [optional] [default to undefined]
|
|
14
|
+
**forcePermanent** | **boolean** | Force the punishment to be permanent regardless of the target\'s current score | [optional] [default to false]
|
|
15
|
+
**notes** | **string** | Internal notes visible only to administrators — not shown to the punished player | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { AdminApplyPunishmentRequest } from '@rebornteam/reborn-api';
|
|
21
|
+
|
|
22
|
+
const instance: AdminApplyPunishmentRequest = {
|
|
23
|
+
targets,
|
|
24
|
+
type,
|
|
25
|
+
severity,
|
|
26
|
+
reason,
|
|
27
|
+
durationSeconds,
|
|
28
|
+
forcePermanent,
|
|
29
|
+
notes,
|
|
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,21 @@
|
|
|
1
|
+
# AdminApplyPunishmentResponse
|
|
2
|
+
|
|
3
|
+
Batch punishment apply result — one result per target
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<AdminApplyPunishmentResult>**](AdminApplyPunishmentResult.md) | Ordered list of results, one per target in the request | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminApplyPunishmentResponse } from '@rebornteam/reborn-api';
|
|
15
|
+
|
|
16
|
+
const instance: AdminApplyPunishmentResponse = {
|
|
17
|
+
results,
|
|
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,33 @@
|
|
|
1
|
+
# AdminApplyPunishmentResult
|
|
2
|
+
|
|
3
|
+
Result of applying a punishment to a single target
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**target** | [**AdminPunishmentTarget**](AdminPunishmentTarget.md) | The target this result applies to | [optional] [default to undefined]
|
|
10
|
+
**punishmentId** | **number** | ID of the created punishment record | [optional] [default to undefined]
|
|
11
|
+
**type** | **string** | Punishment type applied | [optional] [default to undefined]
|
|
12
|
+
**severity** | **number** | Severity level applied | [optional] [default to undefined]
|
|
13
|
+
**newScore** | **number** | Updated punishment score after applying | [optional] [default to undefined]
|
|
14
|
+
**isPermanent** | **boolean** | Whether the punishment was made permanent | [optional] [default to undefined]
|
|
15
|
+
**expiresAt** | **string** | When the punishment expires — null if permanent or a WARNING | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { AdminApplyPunishmentResult } from '@rebornteam/reborn-api';
|
|
21
|
+
|
|
22
|
+
const instance: AdminApplyPunishmentResult = {
|
|
23
|
+
target,
|
|
24
|
+
punishmentId,
|
|
25
|
+
type,
|
|
26
|
+
severity,
|
|
27
|
+
newScore,
|
|
28
|
+
isPermanent,
|
|
29
|
+
expiresAt,
|
|
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)
|
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**description** | **string** | Optional description of the client\'s purpose | [optional] [default to undefined]
|
|
14
14
|
**enabled** | **boolean** | Whether the client credential is currently enabled | [optional] [default to undefined]
|
|
15
15
|
**createdAt** | **string** | Timestamp when the credential was created (ISO-8601 format) | [optional] [default to undefined]
|
|
16
|
+
**expiresAt** | **string** | Timestamp when the credential expires (ISO-8601 format). Null means the credential never expires. | [optional] [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -27,6 +28,7 @@ const instance: AdminClientCredentialResponse = {
|
|
|
27
28
|
description,
|
|
28
29
|
enabled,
|
|
29
30
|
createdAt,
|
|
31
|
+
expiresAt,
|
|
30
32
|
};
|
|
31
33
|
```
|
|
32
34
|
|
|
@@ -48,7 +48,7 @@ void (empty response body)
|
|
|
48
48
|
|
|
49
49
|
### Authorization
|
|
50
50
|
|
|
51
|
-
[
|
|
51
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
52
52
|
|
|
53
53
|
### HTTP request headers
|
|
54
54
|
|
|
@@ -61,8 +61,8 @@ void (empty response body)
|
|
|
61
61
|
|-------------|-------------|------------------|
|
|
62
62
|
|**204** | Client credential disabled successfully | - |
|
|
63
63
|
|**404** | Client credential not found | - |
|
|
64
|
-
|**401** | Unauthorized -
|
|
65
|
-
|**403** | Forbidden -
|
|
64
|
+
|**401** | Unauthorized - Discord SSO token required | - |
|
|
65
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
66
66
|
|
|
67
67
|
[[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)
|
|
68
68
|
|
|
@@ -102,7 +102,7 @@ void (empty response body)
|
|
|
102
102
|
|
|
103
103
|
### Authorization
|
|
104
104
|
|
|
105
|
-
[
|
|
105
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
106
106
|
|
|
107
107
|
### HTTP request headers
|
|
108
108
|
|
|
@@ -115,8 +115,8 @@ void (empty response body)
|
|
|
115
115
|
|-------------|-------------|------------------|
|
|
116
116
|
|**204** | Client credential enabled successfully | - |
|
|
117
117
|
|**404** | Client credential not found | - |
|
|
118
|
-
|**401** | Unauthorized -
|
|
119
|
-
|**403** | Forbidden -
|
|
118
|
+
|**401** | Unauthorized - Discord SSO token required | - |
|
|
119
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
120
120
|
|
|
121
121
|
[[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)
|
|
122
122
|
|
|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.generateClientCredentials(
|
|
|
157
157
|
|
|
158
158
|
### Authorization
|
|
159
159
|
|
|
160
|
-
[
|
|
160
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
161
161
|
|
|
162
162
|
### HTTP request headers
|
|
163
163
|
|
|
@@ -171,7 +171,7 @@ const { status, data } = await apiInstance.generateClientCredentials(
|
|
|
171
171
|
|**200** | Client credentials generated successfully | - |
|
|
172
172
|
|**400** | Invalid request body | - |
|
|
173
173
|
|**401** | Unauthorized - Authentication required | - |
|
|
174
|
-
|**403** | Forbidden -
|
|
174
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
175
175
|
|
|
176
176
|
[[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)
|
|
177
177
|
|
|
@@ -204,7 +204,7 @@ This endpoint does not have any parameters.
|
|
|
204
204
|
|
|
205
205
|
### Authorization
|
|
206
206
|
|
|
207
|
-
[
|
|
207
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
208
208
|
|
|
209
209
|
### HTTP request headers
|
|
210
210
|
|
|
@@ -217,7 +217,7 @@ This endpoint does not have any parameters.
|
|
|
217
217
|
|-------------|-------------|------------------|
|
|
218
218
|
|**200** | Client credentials retrieved successfully | - |
|
|
219
219
|
|**401** | Unauthorized - Authentication required | - |
|
|
220
|
-
|**403** | Forbidden -
|
|
220
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
221
221
|
|
|
222
222
|
[[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)
|
|
223
223
|
|
|
@@ -257,7 +257,7 @@ void (empty response body)
|
|
|
257
257
|
|
|
258
258
|
### Authorization
|
|
259
259
|
|
|
260
|
-
[
|
|
260
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
261
261
|
|
|
262
262
|
### HTTP request headers
|
|
263
263
|
|
|
@@ -270,8 +270,8 @@ void (empty response body)
|
|
|
270
270
|
|-------------|-------------|------------------|
|
|
271
271
|
|**204** | Client credential revoked successfully | - |
|
|
272
272
|
|**404** | Client credential not found | - |
|
|
273
|
-
|**401** | Unauthorized -
|
|
274
|
-
|**403** | Forbidden -
|
|
273
|
+
|**401** | Unauthorized - Discord SSO token required | - |
|
|
274
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
275
275
|
|
|
276
276
|
[[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)
|
|
277
277
|
|
|
@@ -311,7 +311,7 @@ const { status, data } = await apiInstance.rotateToken(
|
|
|
311
311
|
|
|
312
312
|
### Authorization
|
|
313
313
|
|
|
314
|
-
[
|
|
314
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
315
315
|
|
|
316
316
|
### HTTP request headers
|
|
317
317
|
|
|
@@ -325,7 +325,7 @@ const { status, data } = await apiInstance.rotateToken(
|
|
|
325
325
|
|**200** | Client credentials rotated successfully | - |
|
|
326
326
|
|**404** | Client credential not found | - |
|
|
327
327
|
|**401** | Unauthorized - Authentication required | - |
|
|
328
|
-
|**403** | Forbidden -
|
|
328
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
329
329
|
|
|
330
330
|
[[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)
|
|
331
331
|
|
|
@@ -369,7 +369,7 @@ const { status, data } = await apiInstance.updateClient(
|
|
|
369
369
|
|
|
370
370
|
### Authorization
|
|
371
371
|
|
|
372
|
-
[
|
|
372
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
373
373
|
|
|
374
374
|
### HTTP request headers
|
|
375
375
|
|
|
@@ -384,7 +384,7 @@ const { status, data } = await apiInstance.updateClient(
|
|
|
384
384
|
|**404** | Client credential not found | - |
|
|
385
385
|
|**400** | Invalid request body | - |
|
|
386
386
|
|**401** | Unauthorized - Authentication required | - |
|
|
387
|
-
|**403** | Forbidden -
|
|
387
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
388
388
|
|
|
389
389
|
[[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)
|
|
390
390
|
|
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createBypass**](#createbypass) | **POST** /admin/connection/bypass | Create connection bypass|
|
|
8
|
+
|[**listAllConnections**](#listallconnections) | **GET** /admin/connection | List all connections (paginated)|
|
|
8
9
|
|[**listConnections**](#listconnections) | **GET** /admin/connection/recent | List recent connections|
|
|
9
10
|
|
|
10
11
|
# **createBypass**
|
|
@@ -44,7 +45,7 @@ const { status, data } = await apiInstance.createBypass(
|
|
|
44
45
|
|
|
45
46
|
### Authorization
|
|
46
47
|
|
|
47
|
-
[
|
|
48
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
48
49
|
|
|
49
50
|
### HTTP request headers
|
|
50
51
|
|
|
@@ -58,7 +59,72 @@ const { status, data } = await apiInstance.createBypass(
|
|
|
58
59
|
|**200** | Connection bypass created successfully | - |
|
|
59
60
|
|**400** | Invalid request body | - |
|
|
60
61
|
|**401** | Unauthorized - Authentication required | - |
|
|
61
|
-
|**403** | Forbidden -
|
|
62
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
66
|
+
# **listAllConnections**
|
|
67
|
+
> AdminPagedConnectionResponse listAllConnections()
|
|
68
|
+
|
|
69
|
+
Returns a paginated list of all connections with a total count. Supports filtering by IP address, UUID, and VPN status.
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
AdminConnectionsApi,
|
|
76
|
+
Configuration
|
|
77
|
+
} from '@rebornteam/reborn-api';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new AdminConnectionsApi(configuration);
|
|
81
|
+
|
|
82
|
+
let ipAddress: string; //Filter by IP address (optional) (default to undefined)
|
|
83
|
+
let uuid: string; //Filter by player UUID (optional) (default to undefined)
|
|
84
|
+
let isVpn: boolean; //Filter by VPN status (optional) (default to undefined)
|
|
85
|
+
let page: number; //Page number (1-indexed) (optional) (default to 1)
|
|
86
|
+
let limit: number; //Page size (optional) (default to 50)
|
|
87
|
+
|
|
88
|
+
const { status, data } = await apiInstance.listAllConnections(
|
|
89
|
+
ipAddress,
|
|
90
|
+
uuid,
|
|
91
|
+
isVpn,
|
|
92
|
+
page,
|
|
93
|
+
limit
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **ipAddress** | [**string**] | Filter by IP address | (optional) defaults to undefined|
|
|
102
|
+
| **uuid** | [**string**] | Filter by player UUID | (optional) defaults to undefined|
|
|
103
|
+
| **isVpn** | [**boolean**] | Filter by VPN status | (optional) defaults to undefined|
|
|
104
|
+
| **page** | [**number**] | Page number (1-indexed) | (optional) defaults to 1|
|
|
105
|
+
| **limit** | [**number**] | Page size | (optional) defaults to 50|
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
**AdminPagedConnectionResponse**
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### HTTP response details
|
|
123
|
+
| Status code | Description | Response headers |
|
|
124
|
+
|-------------|-------------|------------------|
|
|
125
|
+
|**200** | Paginated connection list retrieved successfully | - |
|
|
126
|
+
|**401** | Unauthorized - Authentication required | - |
|
|
127
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
62
128
|
|
|
63
129
|
[[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
130
|
|
|
@@ -116,7 +182,7 @@ const { status, data } = await apiInstance.listConnections(
|
|
|
116
182
|
|
|
117
183
|
### Authorization
|
|
118
184
|
|
|
119
|
-
[
|
|
185
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
120
186
|
|
|
121
187
|
### HTTP request headers
|
|
122
188
|
|
|
@@ -129,7 +195,7 @@ const { status, data } = await apiInstance.listConnections(
|
|
|
129
195
|
|-------------|-------------|------------------|
|
|
130
196
|
|**200** | Successfully retrieved connections list | - |
|
|
131
197
|
|**401** | Unauthorized - Authentication required | - |
|
|
132
|
-
|**403** | Forbidden -
|
|
198
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
133
199
|
|
|
134
200
|
[[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)
|
|
135
201
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# AdminCreatePunishmentDraftRequest
|
|
2
|
+
|
|
3
|
+
Request to evaluate the impact of a punishment across one or more targets before applying
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**targets** | [**Array<AdminPunishmentTarget>**](AdminPunishmentTarget.md) | List of targets to evaluate — each must have either a uuid or ipAddress | [default to undefined]
|
|
10
|
+
**type** | **string** | Punishment type | [default to undefined]
|
|
11
|
+
**severity** | **number** | Severity level: 1=Minor, 2=Moderate, 3=Severe, 4=Critical | [optional] [default to undefined]
|
|
12
|
+
**reason** | **string** | Reason for the punishment (not used in evaluation, required for apply) | [default to undefined]
|
|
13
|
+
**durationSeconds** | **number** | Custom duration in seconds — if omitted the suggested duration for the type and severity is used | [optional] [default to undefined]
|
|
14
|
+
**forcePermanent** | **boolean** | Force the punishment to be permanent regardless of the target\'s current score | [optional] [default to false]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { AdminCreatePunishmentDraftRequest } from '@rebornteam/reborn-api';
|
|
20
|
+
|
|
21
|
+
const instance: AdminCreatePunishmentDraftRequest = {
|
|
22
|
+
targets,
|
|
23
|
+
type,
|
|
24
|
+
severity,
|
|
25
|
+
reason,
|
|
26
|
+
durationSeconds,
|
|
27
|
+
forcePermanent,
|
|
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)
|
|
@@ -35,7 +35,7 @@ This endpoint does not have any parameters.
|
|
|
35
35
|
|
|
36
36
|
### Authorization
|
|
37
37
|
|
|
38
|
-
[
|
|
38
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
39
39
|
|
|
40
40
|
### HTTP request headers
|
|
41
41
|
|
|
@@ -48,7 +48,7 @@ This endpoint does not have any parameters.
|
|
|
48
48
|
|-------------|-------------|------------------|
|
|
49
49
|
|**200** | Successfully retrieved dashboard statistics | - |
|
|
50
50
|
|**401** | Unauthorized - Authentication required | - |
|
|
51
|
-
|**403** | Forbidden -
|
|
51
|
+
|**403** | Forbidden - Administrator role required | - |
|
|
52
52
|
|
|
53
53
|
[[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)
|
|
54
54
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AdminIpSearchResult
|
|
2
|
+
|
|
3
|
+
A single IP address match in a punishment search, with all players ever seen on that IP
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**ipAddress** | **string** | IP address | [optional] [default to undefined]
|
|
10
|
+
**players** | [**Array<AdminPlayerSearchResult>**](AdminPlayerSearchResult.md) | Players ever seen on this IP | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminIpSearchResult } from '@rebornteam/reborn-api';
|
|
16
|
+
|
|
17
|
+
const instance: AdminIpSearchResult = {
|
|
18
|
+
ipAddress,
|
|
19
|
+
players,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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,29 @@
|
|
|
1
|
+
# AdminPagedConnectionResponse
|
|
2
|
+
|
|
3
|
+
Paginated connection list response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**data** | [**Array<AdminDashboardConnectionResponse>**](AdminDashboardConnectionResponse.md) | Connections on the current page | [optional] [default to undefined]
|
|
10
|
+
**total** | **number** | Total number of connections matching the filters | [optional] [default to undefined]
|
|
11
|
+
**page** | **number** | Current page (1-indexed) | [optional] [default to undefined]
|
|
12
|
+
**limit** | **number** | Page size | [optional] [default to undefined]
|
|
13
|
+
**totalPages** | **number** | Total number of pages | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { AdminPagedConnectionResponse } from '@rebornteam/reborn-api';
|
|
19
|
+
|
|
20
|
+
const instance: AdminPagedConnectionResponse = {
|
|
21
|
+
data,
|
|
22
|
+
total,
|
|
23
|
+
page,
|
|
24
|
+
limit,
|
|
25
|
+
totalPages,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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,29 @@
|
|
|
1
|
+
# AdminPagedPlayerResponse
|
|
2
|
+
|
|
3
|
+
Paginated player list response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**data** | [**Array<AdminPlayerSummary>**](AdminPlayerSummary.md) | Players on the current page | [optional] [default to undefined]
|
|
10
|
+
**total** | **number** | Total number of players matching the search filter | [optional] [default to undefined]
|
|
11
|
+
**page** | **number** | Current page (1-indexed) | [optional] [default to undefined]
|
|
12
|
+
**limit** | **number** | Page size | [optional] [default to undefined]
|
|
13
|
+
**totalPages** | **number** | Total number of pages | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { AdminPagedPlayerResponse } from '@rebornteam/reborn-api';
|
|
19
|
+
|
|
20
|
+
const instance: AdminPagedPlayerResponse = {
|
|
21
|
+
data,
|
|
22
|
+
total,
|
|
23
|
+
page,
|
|
24
|
+
limit,
|
|
25
|
+
totalPages,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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,29 @@
|
|
|
1
|
+
# AdminPagedPunishmentResponse
|
|
2
|
+
|
|
3
|
+
Paginated punishment list response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**data** | [**Array<AdminPunishmentListItem>**](AdminPunishmentListItem.md) | Punishments on the current page | [optional] [default to undefined]
|
|
10
|
+
**total** | **number** | Total number of punishments matching the filters | [optional] [default to undefined]
|
|
11
|
+
**page** | **number** | Current page (1-indexed) | [optional] [default to undefined]
|
|
12
|
+
**limit** | **number** | Page size | [optional] [default to undefined]
|
|
13
|
+
**totalPages** | **number** | Total number of pages | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { AdminPagedPunishmentResponse } from '@rebornteam/reborn-api';
|
|
19
|
+
|
|
20
|
+
const instance: AdminPagedPunishmentResponse = {
|
|
21
|
+
data,
|
|
22
|
+
total,
|
|
23
|
+
page,
|
|
24
|
+
limit,
|
|
25
|
+
totalPages,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|