@rebornteam/reborn-api 2.9.1 → 3.0.1
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 +1 -0
- package/README.md +4 -2
- package/api.ts +148 -41
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +105 -41
- package/dist/api.js +105 -29
- 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 +105 -41
- package/dist/esm/api.js +105 -29
- 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/AdminConnectionCheckResult.md +25 -0
- package/docs/AdminConnectionsApi.md +59 -0
- package/docs/AdminDashboardConnectionResponse.md +2 -0
- package/docs/AdminPunishmentsApi.md +3 -3
- package/docs/ConnectionGetConnectionDetailsResponse.md +9 -7
- package/docs/PlayerApi.md +7 -8
- package/docs/PlayerGetPlayerInformation.md +4 -4
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/PlayerApi.md
CHANGED
|
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
10
10
|
# **getPlayer1**
|
|
11
11
|
> PlayerGetPlayerInformation getPlayer1()
|
|
12
12
|
|
|
13
|
-
Retrieves player information by
|
|
13
|
+
Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -23,7 +23,7 @@ import {
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
24
|
const apiInstance = new PlayerApi(configuration);
|
|
25
25
|
|
|
26
|
-
let uuid: string; //
|
|
26
|
+
let uuid: string; // (default to undefined)
|
|
27
27
|
|
|
28
28
|
const { status, data } = await apiInstance.getPlayer1(
|
|
29
29
|
uuid
|
|
@@ -34,7 +34,7 @@ const { status, data } = await apiInstance.getPlayer1(
|
|
|
34
34
|
|
|
35
35
|
|Name | Type | Description | Notes|
|
|
36
36
|
|------------- | ------------- | ------------- | -------------|
|
|
37
|
-
| **uuid** | [**string**] |
|
|
37
|
+
| **uuid** | [**string**] | | defaults to undefined|
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### Return type
|
|
@@ -55,8 +55,7 @@ const { status, data } = await apiInstance.getPlayer1(
|
|
|
55
55
|
| Status code | Description | Response headers |
|
|
56
56
|
|-------------|-------------|------------------|
|
|
57
57
|
|**200** | Player information retrieved successfully | - |
|
|
58
|
-
|**401** | Unauthorized
|
|
59
|
-
|**400** | Bad request — invalid UUID format | - |
|
|
58
|
+
|**401** | Unauthorized | - |
|
|
60
59
|
|**404** | Player not found | - |
|
|
61
60
|
|
|
62
61
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -64,7 +63,7 @@ const { status, data } = await apiInstance.getPlayer1(
|
|
|
64
63
|
# **getUsernames**
|
|
65
64
|
> getUsernames()
|
|
66
65
|
|
|
67
|
-
Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record
|
|
66
|
+
Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record are omitted from the response.
|
|
68
67
|
|
|
69
68
|
### Example
|
|
70
69
|
|
|
@@ -77,7 +76,7 @@ import {
|
|
|
77
76
|
const configuration = new Configuration();
|
|
78
77
|
const apiInstance = new PlayerApi(configuration);
|
|
79
78
|
|
|
80
|
-
let uuids: Array<string>; //List of player UUIDs to resolve (
|
|
79
|
+
let uuids: Array<string>; //List of player UUIDs to resolve (default to undefined)
|
|
81
80
|
|
|
82
81
|
const { status, data } = await apiInstance.getUsernames(
|
|
83
82
|
uuids
|
|
@@ -88,7 +87,7 @@ const { status, data } = await apiInstance.getUsernames(
|
|
|
88
87
|
|
|
89
88
|
|Name | Type | Description | Notes|
|
|
90
89
|
|------------- | ------------- | ------------- | -------------|
|
|
91
|
-
| **uuids** | **Array<string>** | List of player UUIDs to resolve
|
|
90
|
+
| **uuids** | **Array<string>** | List of player UUIDs to resolve | defaults to undefined|
|
|
92
91
|
|
|
93
92
|
|
|
94
93
|
### Return type
|
|
@@ -6,10 +6,10 @@ Player information including join history, tracking data, and punishment scoring
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**firstJoin** | **boolean** | Indicates whether this is the player\'s first time joining the server. | [optional] [default to undefined]
|
|
9
10
|
**firstLogin** | **string** | Timestamp of when the player first connected to the server (ISO-8601 format). | [optional] [default to undefined]
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**punishmentPointsPercent** | **number** | Punishment score as a percentage (0-100). When this score is >100% BEFORE applying a new punishment, the new punishment should be made permanent. Check this value BEFORE issuing punishment, not after. Calculated as raw_score × 100. | [optional] [default to undefined]
|
|
11
|
+
**punishmentPointsRaw** | **number** | Raw punishment score calculated as: SUM((base_weight × severity/10)). Used for tracking overall punishment severity. | [optional] [default to undefined]
|
|
12
|
+
**punishmentPointsPercent** | **number** | Punishment score as a percentage (0-100). When >100% before applying a new punishment, the new punishment should be made permanent. | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -17,8 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
import { PlayerGetPlayerInformation } from '@rebornteam/reborn-api';
|
|
18
18
|
|
|
19
19
|
const instance: PlayerGetPlayerInformation = {
|
|
20
|
-
firstLogin,
|
|
21
20
|
firstJoin,
|
|
21
|
+
firstLogin,
|
|
22
22
|
punishmentPointsRaw,
|
|
23
23
|
punishmentPointsPercent,
|
|
24
24
|
};
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|