@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
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# DefaultApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.smsh.sh*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**callback**](#callback) | **GET** /auth/discord/callback | |
|
|
8
|
+
|[**initiateLogin**](#initiatelogin) | **GET** /auth/discord | |
|
|
9
|
+
|
|
10
|
+
# **callback**
|
|
11
|
+
> object callback()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
DefaultApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@rebornteam/reborn-api';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new DefaultApi(configuration);
|
|
24
|
+
|
|
25
|
+
let code: string; // (optional) (default to undefined)
|
|
26
|
+
let error: string; // (optional) (default to undefined)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.callback(
|
|
29
|
+
code,
|
|
30
|
+
error
|
|
31
|
+
);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
|Name | Type | Description | Notes|
|
|
37
|
+
|------------- | ------------- | ------------- | -------------|
|
|
38
|
+
| **code** | [**string**] | | (optional) defaults to undefined|
|
|
39
|
+
| **error** | [**string**] | | (optional) defaults to undefined|
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**object**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: Not defined
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**200** | callback 200 response | - |
|
|
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
|
+
# **initiateLogin**
|
|
64
|
+
> object initiateLogin()
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
import {
|
|
71
|
+
DefaultApi,
|
|
72
|
+
Configuration
|
|
73
|
+
} from '@rebornteam/reborn-api';
|
|
74
|
+
|
|
75
|
+
const configuration = new Configuration();
|
|
76
|
+
const apiInstance = new DefaultApi(configuration);
|
|
77
|
+
|
|
78
|
+
const { status, data } = await apiInstance.initiateLogin();
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Parameters
|
|
82
|
+
This endpoint does not have any parameters.
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
**object**
|
|
88
|
+
|
|
89
|
+
### Authorization
|
|
90
|
+
|
|
91
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
92
|
+
|
|
93
|
+
### HTTP request headers
|
|
94
|
+
|
|
95
|
+
- **Content-Type**: Not defined
|
|
96
|
+
- **Accept**: application/json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
### HTTP response details
|
|
100
|
+
| Status code | Description | Response headers |
|
|
101
|
+
|-------------|-------------|------------------|
|
|
102
|
+
|**200** | initiateLogin 200 response | - |
|
|
103
|
+
|
|
104
|
+
[[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)
|
|
105
|
+
|
package/docs/PlayerApi.md
CHANGED
|
@@ -4,10 +4,10 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**getPlayer1**](#getplayer1) | **GET** /v1/player/{uuid} | Get Player Information|
|
|
8
8
|
|
|
9
|
-
# **
|
|
10
|
-
> PlayerGetPlayerInformation
|
|
9
|
+
# **getPlayer1**
|
|
10
|
+
> PlayerGetPlayerInformation getPlayer1()
|
|
11
11
|
|
|
12
12
|
Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
13
13
|
|
|
@@ -24,7 +24,7 @@ const apiInstance = new PlayerApi(configuration);
|
|
|
24
24
|
|
|
25
25
|
let uuid: string; //The Minecraft player UUID (with or without dashes) (default to undefined)
|
|
26
26
|
|
|
27
|
-
const { status, data } = await apiInstance.
|
|
27
|
+
const { status, data } = await apiInstance.getPlayer1(
|
|
28
28
|
uuid
|
|
29
29
|
);
|
|
30
30
|
```
|
|
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.getPlayer(
|
|
|
42
42
|
|
|
43
43
|
### Authorization
|
|
44
44
|
|
|
45
|
-
[
|
|
45
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
46
46
|
|
|
47
47
|
### HTTP request headers
|
|
48
48
|
|
package/docs/PunishmentApi.md
CHANGED
|
@@ -4,117 +4,11 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**applyPunishment**](#applypunishment) | **POST** /v1/punishment/apply | Apply a punishment|
|
|
8
|
-
|[**createPunishmentDraft**](#createpunishmentdraft) | **POST** /v1/punishment/draft | Create a punishment draft|
|
|
9
7
|
|[**getPunishmentSeverities**](#getpunishmentseverities) | **GET** /v1/punishment/severities | Get punishment severities|
|
|
10
|
-
|[**
|
|
8
|
+
|[**getPunishments1**](#getpunishments1) | **GET** /v1/punishment | Get punishments by player|
|
|
11
9
|
|[**getPunishmentsByIp**](#getpunishmentsbyip) | **GET** /v1/punishment/ip | Get punishments by IP address|
|
|
12
10
|
|[**getRecentPunishments**](#getrecentpunishments) | **GET** /v1/punishment/recent | List recent punishments|
|
|
13
11
|
|
|
14
|
-
# **applyPunishment**
|
|
15
|
-
> ApplyPunishmentResponse applyPunishment(applyPunishmentRequest)
|
|
16
|
-
|
|
17
|
-
Create and apply a punishment to a player. Automatically determines if permanent based on current score threshold (≥100%).
|
|
18
|
-
|
|
19
|
-
### Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import {
|
|
23
|
-
PunishmentApi,
|
|
24
|
-
Configuration,
|
|
25
|
-
ApplyPunishmentRequest
|
|
26
|
-
} from '@rebornteam/reborn-api';
|
|
27
|
-
|
|
28
|
-
const configuration = new Configuration();
|
|
29
|
-
const apiInstance = new PunishmentApi(configuration);
|
|
30
|
-
|
|
31
|
-
let applyPunishmentRequest: ApplyPunishmentRequest; //
|
|
32
|
-
|
|
33
|
-
const { status, data } = await apiInstance.applyPunishment(
|
|
34
|
-
applyPunishmentRequest
|
|
35
|
-
);
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Parameters
|
|
39
|
-
|
|
40
|
-
|Name | Type | Description | Notes|
|
|
41
|
-
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **applyPunishmentRequest** | **ApplyPunishmentRequest**| | |
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
### Return type
|
|
46
|
-
|
|
47
|
-
**ApplyPunishmentResponse**
|
|
48
|
-
|
|
49
|
-
### Authorization
|
|
50
|
-
|
|
51
|
-
[CognitoAuth](../README.md#CognitoAuth)
|
|
52
|
-
|
|
53
|
-
### HTTP request headers
|
|
54
|
-
|
|
55
|
-
- **Content-Type**: application/json
|
|
56
|
-
- **Accept**: application/json
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
### HTTP response details
|
|
60
|
-
| Status code | Description | Response headers |
|
|
61
|
-
|-------------|-------------|------------------|
|
|
62
|
-
|**200** | Punishment successfully applied | - |
|
|
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
|
-
# **createPunishmentDraft**
|
|
67
|
-
> PunishmentDraftResponse createPunishmentDraft(createPunishmentDraftRequest)
|
|
68
|
-
|
|
69
|
-
Preview punishment impact before applying. Returns calculated points, current/new thresholds, and whether it will be permanent.
|
|
70
|
-
|
|
71
|
-
### Example
|
|
72
|
-
|
|
73
|
-
```typescript
|
|
74
|
-
import {
|
|
75
|
-
PunishmentApi,
|
|
76
|
-
Configuration,
|
|
77
|
-
CreatePunishmentDraftRequest
|
|
78
|
-
} from '@rebornteam/reborn-api';
|
|
79
|
-
|
|
80
|
-
const configuration = new Configuration();
|
|
81
|
-
const apiInstance = new PunishmentApi(configuration);
|
|
82
|
-
|
|
83
|
-
let createPunishmentDraftRequest: CreatePunishmentDraftRequest; //
|
|
84
|
-
|
|
85
|
-
const { status, data } = await apiInstance.createPunishmentDraft(
|
|
86
|
-
createPunishmentDraftRequest
|
|
87
|
-
);
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
### Parameters
|
|
91
|
-
|
|
92
|
-
|Name | Type | Description | Notes|
|
|
93
|
-
|------------- | ------------- | ------------- | -------------|
|
|
94
|
-
| **createPunishmentDraftRequest** | **CreatePunishmentDraftRequest**| | |
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
### Return type
|
|
98
|
-
|
|
99
|
-
**PunishmentDraftResponse**
|
|
100
|
-
|
|
101
|
-
### Authorization
|
|
102
|
-
|
|
103
|
-
[CognitoAuth](../README.md#CognitoAuth)
|
|
104
|
-
|
|
105
|
-
### HTTP request headers
|
|
106
|
-
|
|
107
|
-
- **Content-Type**: application/json
|
|
108
|
-
- **Accept**: application/json
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
### HTTP response details
|
|
112
|
-
| Status code | Description | Response headers |
|
|
113
|
-
|-------------|-------------|------------------|
|
|
114
|
-
|**200** | Punishment draft with calculated impact | - |
|
|
115
|
-
|
|
116
|
-
[[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)
|
|
117
|
-
|
|
118
12
|
# **getPunishmentSeverities**
|
|
119
13
|
> PunishmentSeveritiesResponse getPunishmentSeverities()
|
|
120
14
|
|
|
@@ -144,7 +38,7 @@ This endpoint does not have any parameters.
|
|
|
144
38
|
|
|
145
39
|
### Authorization
|
|
146
40
|
|
|
147
|
-
[
|
|
41
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
148
42
|
|
|
149
43
|
### HTTP request headers
|
|
150
44
|
|
|
@@ -159,8 +53,8 @@ This endpoint does not have any parameters.
|
|
|
159
53
|
|
|
160
54
|
[[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)
|
|
161
55
|
|
|
162
|
-
# **
|
|
163
|
-
> Array<PunishmentGetPunishmentResponse>
|
|
56
|
+
# **getPunishments1**
|
|
57
|
+
> Array<PunishmentGetPunishmentResponse> getPunishments1()
|
|
164
58
|
|
|
165
59
|
Retrieve all active punishments for a player by UUID or username, optionally filtered by type and time
|
|
166
60
|
|
|
@@ -180,7 +74,7 @@ let username: string; //Player username (optional) (default to undefined)
|
|
|
180
74
|
let type: Array<string>; //Filter by punishment types (optional) (default to undefined)
|
|
181
75
|
let since: number; //Filter punishments created after this Unix epoch timestamp (milliseconds) (optional) (default to undefined)
|
|
182
76
|
|
|
183
|
-
const { status, data } = await apiInstance.
|
|
77
|
+
const { status, data } = await apiInstance.getPunishments1(
|
|
184
78
|
uuid,
|
|
185
79
|
username,
|
|
186
80
|
type,
|
|
@@ -204,7 +98,7 @@ const { status, data } = await apiInstance.getPunishments(
|
|
|
204
98
|
|
|
205
99
|
### Authorization
|
|
206
100
|
|
|
207
|
-
[
|
|
101
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
208
102
|
|
|
209
103
|
### HTTP request headers
|
|
210
104
|
|
|
@@ -255,7 +149,7 @@ const { status, data } = await apiInstance.getPunishmentsByIp(
|
|
|
255
149
|
|
|
256
150
|
### Authorization
|
|
257
151
|
|
|
258
|
-
[
|
|
152
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
259
153
|
|
|
260
154
|
### HTTP request headers
|
|
261
155
|
|
|
@@ -330,7 +224,7 @@ const { status, data } = await apiInstance.getRecentPunishments(
|
|
|
330
224
|
|
|
331
225
|
### Authorization
|
|
332
226
|
|
|
333
|
-
[
|
|
227
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
334
228
|
|
|
335
229
|
### HTTP request headers
|
|
336
230
|
|
|
@@ -7,9 +7,10 @@ Punishment information including reason, type, creator, and expiration
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **number** | Unique identifier for the punishment | [optional] [default to undefined]
|
|
10
|
-
**reason** | **string** | Reason for the punishment | [optional] [default to undefined]
|
|
11
|
-
**
|
|
12
|
-
**
|
|
10
|
+
**reason** | **string** | Reason for the punishment, shown to the punished player | [optional] [default to undefined]
|
|
11
|
+
**notes** | **string** | Internal administrator notes — not shown to the punished player | [optional] [default to undefined]
|
|
12
|
+
**type** | **string** | Type of punishment (BAN, MUTE, WARNING) | [optional] [default to undefined]
|
|
13
|
+
**severity** | **number** | Severity level (1=Minor, 2=Moderate, 3=Severe, 4=Critical) | [optional] [default to undefined]
|
|
13
14
|
**createdBy** | **string** | Username or identifier of the person who created this punishment | [optional] [default to undefined]
|
|
14
15
|
**expiresAt** | **string** | Timestamp when the punishment expires (ISO-8601 format). Null for permanent punishments. | [optional] [default to undefined]
|
|
15
16
|
**createdAt** | **string** | Timestamp when the punishment was created (ISO-8601 format) | [optional] [default to undefined]
|
|
@@ -22,6 +23,7 @@ import { PunishmentGetPunishmentResponse } from '@rebornteam/reborn-api';
|
|
|
22
23
|
const instance: PunishmentGetPunishmentResponse = {
|
|
23
24
|
id,
|
|
24
25
|
reason,
|
|
26
|
+
notes,
|
|
25
27
|
type,
|
|
26
28
|
severity,
|
|
27
29
|
createdBy,
|
package/index.ts
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/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rebornteam/reborn-api",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.6.4",
|
|
4
4
|
"description": "OpenAPI client for @rebornteam/reborn-api",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "https://github.com/
|
|
8
|
+
"url": "git+https://github.com/Smash-Reborn/Reborn-API-Clients.git"
|
|
9
9
|
},
|
|
10
10
|
"keywords": [
|
|
11
11
|
"axios",
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# ApplyPunishmentRequest
|
|
2
|
-
|
|
3
|
-
Request to apply a punishment to a player
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**playerUuid** | **string** | Player UUID to punish | [default to undefined]
|
|
10
|
-
**reason** | **string** | Reason for the punishment | [default to undefined]
|
|
11
|
-
**type** | **string** | Type of punishment | [default to undefined]
|
|
12
|
-
**severity** | **number** | Severity level of the punishment (1-10) | [default to undefined]
|
|
13
|
-
**createdBy** | **string** | Staff member applying the punishment | [default to undefined]
|
|
14
|
-
**durationSeconds** | **number** | Duration of the punishment in seconds. Null means permanent. | [optional] [default to undefined]
|
|
15
|
-
|
|
16
|
-
## Example
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import { ApplyPunishmentRequest } from '@rebornteam/reborn-api';
|
|
20
|
-
|
|
21
|
-
const instance: ApplyPunishmentRequest = {
|
|
22
|
-
playerUuid,
|
|
23
|
-
reason,
|
|
24
|
-
type,
|
|
25
|
-
severity,
|
|
26
|
-
createdBy,
|
|
27
|
-
durationSeconds,
|
|
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)
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# ApplyPunishmentResponse
|
|
2
|
-
|
|
3
|
-
Response after applying a punishment
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**punishmentId** | **number** | ID of the created punishment | [optional] [default to undefined]
|
|
10
|
-
**playerUuid** | **string** | Player UUID punished | [optional] [default to undefined]
|
|
11
|
-
**type** | **string** | Type of punishment applied | [optional] [default to undefined]
|
|
12
|
-
**severity** | **number** | Severity level (1-10) | [optional] [default to undefined]
|
|
13
|
-
**newScore** | **number** | New total punishment score after applying | [optional] [default to undefined]
|
|
14
|
-
**isPermanent** | **boolean** | Whether this punishment is permanent | [optional] [default to undefined]
|
|
15
|
-
**expiresAt** | **string** | Timestamp when punishment expires (ISO-8601 format, null if permanent) | [optional] [default to undefined]
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { ApplyPunishmentResponse } from '@rebornteam/reborn-api';
|
|
21
|
-
|
|
22
|
-
const instance: ApplyPunishmentResponse = {
|
|
23
|
-
punishmentId,
|
|
24
|
-
playerUuid,
|
|
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)
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# CreatePunishmentDraftRequest
|
|
2
|
-
|
|
3
|
-
Request to create a punishment draft for preview before applying
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**playerUuid** | **string** | Player UUID to punish | [default to undefined]
|
|
10
|
-
**reason** | **string** | Reason for the punishment | [default to undefined]
|
|
11
|
-
**type** | **string** | Type of punishment | [default to undefined]
|
|
12
|
-
**severity** | **number** | Severity level of the punishment (1-10) | [default to undefined]
|
|
13
|
-
**durationSeconds** | **number** | Duration of the punishment in seconds. Null means permanent. | [optional] [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { CreatePunishmentDraftRequest } from '@rebornteam/reborn-api';
|
|
19
|
-
|
|
20
|
-
const instance: CreatePunishmentDraftRequest = {
|
|
21
|
-
playerUuid,
|
|
22
|
-
reason,
|
|
23
|
-
type,
|
|
24
|
-
severity,
|
|
25
|
-
durationSeconds,
|
|
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)
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# PunishmentDraftResponse
|
|
2
|
-
|
|
3
|
-
Response containing punishment draft preview with calculated points and thresholds
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**playerUuid** | **string** | Player UUID this punishment would apply to | [optional] [default to undefined]
|
|
10
|
-
**reason** | **string** | Reason for the punishment | [optional] [default to undefined]
|
|
11
|
-
**type** | **string** | Type of punishment | [optional] [default to undefined]
|
|
12
|
-
**severity** | **number** | Severity level (1-10) | [optional] [default to undefined]
|
|
13
|
-
**currentScore** | **number** | Current total punishment score before applying this punishment | [optional] [default to undefined]
|
|
14
|
-
**pointsToAdd** | **number** | Points this punishment would add | [optional] [default to undefined]
|
|
15
|
-
**newScore** | **number** | New total score after applying this punishment | [optional] [default to undefined]
|
|
16
|
-
**willBePermanent** | **boolean** | Whether this punishment will be permanent | [optional] [default to undefined]
|
|
17
|
-
**durationSeconds** | **number** | Duration in seconds (null if permanent) | [optional] [default to undefined]
|
|
18
|
-
**previousPunishmentCount** | **number** | Number of previous punishments for this player | [optional] [default to undefined]
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { PunishmentDraftResponse } from '@rebornteam/reborn-api';
|
|
24
|
-
|
|
25
|
-
const instance: PunishmentDraftResponse = {
|
|
26
|
-
playerUuid,
|
|
27
|
-
reason,
|
|
28
|
-
type,
|
|
29
|
-
severity,
|
|
30
|
-
currentScore,
|
|
31
|
-
pointsToAdd,
|
|
32
|
-
newScore,
|
|
33
|
-
willBePermanent,
|
|
34
|
-
durationSeconds,
|
|
35
|
-
previousPunishmentCount,
|
|
36
|
-
};
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|