@rebornteam/reborn-api 2.6.0 → 2.7.0

package/docs/AuthenticationApi.md

@@ -0,0 +1,167 @@
+# AuthenticationApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**callback**](#callback) | **GET** /auth/discord/callback | Discord - OAuth2 callback|
+|[**initiateLogin**](#initiatelogin) | **GET** /auth/discord | Discord - Initiate login|
+|[**token**](#token) | **POST** /oauth/token | Service - Exchange client credentials for token|
+
+# **callback**
+> callback()
+
+Receives the authorization code from Discord after the user approves the OAuth2 prompt. Exchanges the code for an access token, verifies the user holds an admin guild role, then redirects back to the admin frontend with a signed JWT in the query string (`?token=...`). On failure, redirects with `?error=<reason>` instead. 
+
+### Example
+
+```typescript
+import {
+    AuthenticationApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthenticationApi(configuration);
+
+let code: string; //Authorization code provided by Discord on successful approval (optional) (default to undefined)
+let error: string; //Error code provided by Discord if the user denied access (optional) (default to undefined)
+
+const { status, data } = await apiInstance.callback(
+    code,
+    error
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **code** | [**string**] | Authorization code provided by Discord on successful approval | (optional) defaults to undefined|
+| **error** | [**string**] | Error code provided by Discord if the user denied access | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**302** | Redirect to admin frontend with &#x60;?token&#x3D;&lt;jwt&gt;&#x60; on success or &#x60;?error&#x3D;&lt;reason&gt;&#x60; on failure |  -  |
+
+[[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)
+
+# **initiateLogin**
+> initiateLogin()
+
+Redirects the browser to Discord\'s OAuth2 authorization page. Not called directly — the admin frontend navigates to this URL to begin the login flow.
+
+### Example
+
+```typescript
+import {
+    AuthenticationApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthenticationApi(configuration);
+
+const { status, data } = await apiInstance.initiateLogin();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**302** | Redirect to Discord authorization URL |  -  |
+
+[[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)
+
+# **token**
+> object token()
+
+Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
+
+### Example
+
+```typescript
+import {
+    AuthenticationApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AuthenticationApi(configuration);
+
+let grantType: string; // (optional) (default to undefined)
+let clientId: string; // (optional) (default to undefined)
+let clientSecret: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.token(
+    grantType,
+    clientId,
+    clientSecret
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **grantType** | [**string**] |  | (optional) defaults to undefined|
+| **clientId** | [**string**] |  | (optional) defaults to undefined|
+| **clientSecret** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded, application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Token generated successfully |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Invalid credentials |  -  |
+
+[[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)
+

package/docs/ChatApi.md

@@ -0,0 +1,121 @@
+# ChatApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**history**](#history) | **GET** /v1/chat | Get chat history|
+|[**ingest**](#ingest) | **POST** /v1/chat | Ingest a chat message|
+
+# **history**
+> Array<ChatMessageDTO> history()
+
+Returns up to `limit` chat messages before the given `before` timestamp (keyset pagination). Results are returned in ascending chronological order. Omit `before` to start from the current time. Scroll back through history by passing the `sentAt` of the oldest message received as the next `before` value. 
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let limit: number; //Maximum number of messages to return (1–100) (default to 50)
+let sessionId: string; //Filter to a specific server session. Omit for global history. (optional) (default to undefined)
+let before: string; //ISO-8601 timestamp cursor — return messages sent before this time. Omit to start from now. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.history(
+    limit,
+    sessionId,
+    before
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Maximum number of messages to return (1–100) | defaults to 50|
+| **sessionId** | [**string**] | Filter to a specific server session. Omit for global history. | (optional) defaults to undefined|
+| **before** | [**string**] | ISO-8601 timestamp cursor — return messages sent before this time. Omit to start from now. | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<ChatMessageDTO>**
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of chat messages in ascending chronological order |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+
+# **ingest**
+> ChatMessageDTO ingest(chatMessageRequest)
+
+Stores a chat message from a game server and fans it out to all connected WebSocket clients via PostgreSQL LISTEN/NOTIFY. The session must be currently online. Only the player UUID is stored — usernames are resolved on the web UI from the player database cache. 
+
+### Example
+
+```typescript
+import {
+    ChatApi,
+    Configuration,
+    ChatMessageRequest
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ChatApi(configuration);
+
+let chatMessageRequest: ChatMessageRequest; //
+
+const { status, data } = await apiInstance.ingest(
+    chatMessageRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **chatMessageRequest** | **ChatMessageRequest**|  | |
+
+
+### Return type
+
+**ChatMessageDTO**
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Message ingested |  -  |
+|**400** | Bad request — unknown session ID or validation failure |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+

package/docs/ChatMessageDTO.md

@@ -0,0 +1,30 @@
+# ChatMessageDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**sentAt** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [default to undefined]
+**playerUuid** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**channel** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessageDTO } from '@rebornteam/reborn-api';
+
+const instance: ChatMessageDTO = {
+    id,
+    sentAt,
+    sessionId,
+    playerUuid,
+    message,
+    channel,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChatMessageRequest.md

@@ -0,0 +1,26 @@
+# ChatMessageRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sessionId** | **string** |  | [default to undefined]
+**playerUuid** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**channel** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChatMessageRequest } from '@rebornteam/reborn-api';
+
+const instance: ChatMessageRequest = {
+    sessionId,
+    playerUuid,
+    message,
+    channel,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PlayerApi.md

@@ -4,7 +4,8 @@ All URIs are relative to *https://api.smsh.sh*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getPlayer1**](#getplayer1) | **GET** /v1/player/{uuid} | Get Player Information|
+|[**getPlayer1**](#getplayer1) | **GET** /v1/player/{uuid} | Get player information|
+|[**getUsernames**](#getusernames) | **GET** /v1/player/usernames | Batch resolve UUIDs to usernames|
 
 # **getPlayer1**
 > PlayerGetPlayerInformation getPlayer1()
@@ -54,9 +55,61 @@ const { status, data } = await apiInstance.getPlayer1(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Player information retrieved successfully |  -  |
-|**401** | Unauthorized - Invalid or missing authentication token |  -  |
-|**400** | Bad Request - Invalid UUID format |  -  |
+|**401** | Unauthorized — invalid or missing authentication token |  -  |
+|**400** | Bad request — invalid UUID format |  -  |
 |**404** | Player not found |  -  |
 
 [[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)
 
+# **getUsernames**
+> getUsernames()
+
+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 (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log. 
+
+### Example
+
+```typescript
+import {
+    PlayerApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new PlayerApi(configuration);
+
+let uuids: Array<string>; //List of player UUIDs to resolve (repeatable query param) (default to undefined)
+
+const { status, data } = await apiInstance.getUsernames(
+    uuids
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuids** | **Array&lt;string&gt;** | List of player UUIDs to resolve (repeatable query param) | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Map of UUID → username for all resolved players |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+

package/docs/PunishmentApi.md

@@ -4,117 +4,11 @@ All URIs are relative to *https://api.smsh.sh*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**applyPunishment**](#applypunishment) | **POST** /v1/punishment/apply | Apply a punishment|
-|[**createPunishmentDraft**](#createpunishmentdraft) | **POST** /v1/punishment/draft | Create a punishment draft|
 |[**getPunishmentSeverities**](#getpunishmentseverities) | **GET** /v1/punishment/severities | Get punishment severities|
 |[**getPunishments1**](#getpunishments1) | **GET** /v1/punishment | Get punishments by player|
 |[**getPunishmentsByIp**](#getpunishmentsbyip) | **GET** /v1/punishment/ip | Get punishments by IP address|
 |[**getRecentPunishments**](#getrecentpunishments) | **GET** /v1/punishment/recent | List recent punishments|
 
-# **applyPunishment**
-> ApplyPunishmentResponse applyPunishment(applyPunishmentRequest)
-
-Create and apply a punishment to a player. Automatically determines if permanent based on current score threshold (≥100%).
-
-### Example
-
-```typescript
-import {
-    PunishmentApi,
-    Configuration,
-    ApplyPunishmentRequest
-} from '@rebornteam/reborn-api';
-
-const configuration = new Configuration();
-const apiInstance = new PunishmentApi(configuration);
-
-let applyPunishmentRequest: ApplyPunishmentRequest; //
-
-const { status, data } = await apiInstance.applyPunishment(
-    applyPunishmentRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **applyPunishmentRequest** | **ApplyPunishmentRequest**|  | |
-
-
-### Return type
-
-**ApplyPunishmentResponse**
-
-### Authorization
-
-[DiscordAuth](../README.md#DiscordAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Punishment successfully applied |  -  |
-
-[[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)
-
-# **createPunishmentDraft**
-> PunishmentDraftResponse createPunishmentDraft(createPunishmentDraftRequest)
-
-Preview punishment impact before applying. Returns calculated points, current/new thresholds, and whether it will be permanent.
-
-### Example
-
-```typescript
-import {
-    PunishmentApi,
-    Configuration,
-    CreatePunishmentDraftRequest
-} from '@rebornteam/reborn-api';
-
-const configuration = new Configuration();
-const apiInstance = new PunishmentApi(configuration);
-
-let createPunishmentDraftRequest: CreatePunishmentDraftRequest; //
-
-const { status, data } = await apiInstance.createPunishmentDraft(
-    createPunishmentDraftRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createPunishmentDraftRequest** | **CreatePunishmentDraftRequest**|  | |
-
-
-### Return type
-
-**PunishmentDraftResponse**
-
-### Authorization
-
-[DiscordAuth](../README.md#DiscordAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Punishment draft with calculated impact |  -  |
-
-[[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)
-
 # **getPunishmentSeverities**
 > PunishmentSeveritiesResponse getPunishmentSeverities()
 

package/docs/PunishmentGetPunishmentResponse.md

@@ -7,9 +7,10 @@ Punishment information including reason, type, creator, and expiration
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | Unique identifier for the punishment | [optional] [default to undefined]
-**reason** | **string** | Reason for the punishment | [optional] [default to undefined]
-**type** | **string** | Type of punishment (e.g., BAN, MUTE, KICK, WARNING) | [optional] [default to undefined]
-**severity** | **number** | Severity level of the punishment (1-10, where 10 is most severe) | [optional] [default to undefined]
+**reason** | **string** | Reason for the punishment, shown to the punished player | [optional] [default to undefined]
+**notes** | **string** | Internal administrator notes — not shown to the punished player | [optional] [default to undefined]
+**type** | **string** | Type of punishment (BAN, MUTE, WARNING) | [optional] [default to undefined]
+**severity** | **number** | Severity level (1=Minor, 2=Moderate, 3=Severe, 4=Critical) | [optional] [default to undefined]
 **createdBy** | **string** | Username or identifier of the person who created this punishment | [optional] [default to undefined]
 **expiresAt** | **string** | Timestamp when the punishment expires (ISO-8601 format). Null for permanent punishments. | [optional] [default to undefined]
 **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';
 const instance: PunishmentGetPunishmentResponse = {
     id,
     reason,
+    notes,
     type,
     severity,
     createdBy,

package/docs/ServerRegisterRequest.md

@@ -0,0 +1,24 @@
+# ServerRegisterRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**region** | **string** |  | [default to undefined]
+**gameType** | **string** |  | [default to undefined]
+**containerId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServerRegisterRequest } from '@rebornteam/reborn-api';
+
+const instance: ServerRegisterRequest = {
+    region,
+    gameType,
+    containerId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ServerSessionDTO.md

@@ -0,0 +1,36 @@
+# ServerSessionDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**region** | **string** |  | [default to undefined]
+**gameType** | **string** |  | [default to undefined]
+**instanceName** | **string** |  | [default to undefined]
+**containerId** | **string** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [default to undefined]
+**lastHeartbeat** | **string** |  | [default to undefined]
+**endedAt** | **string** |  | [optional] [default to undefined]
+**online** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ServerSessionDTO } from '@rebornteam/reborn-api';
+
+const instance: ServerSessionDTO = {
+    id,
+    region,
+    gameType,
+    instanceName,
+    containerId,
+    startedAt,
+    lastHeartbeat,
+    endedAt,
+    online,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)