@rebornteam/reborn-api 2.6.0 → 2.7.0

package/docs/ServerSessionsApi.md

@@ -0,0 +1,261 @@
+# ServerSessionsApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**heartbeat**](#heartbeat) | **PUT** /v1/servers/{id}/heartbeat | Send a heartbeat|
+|[**listAll**](#listall) | **GET** /v1/servers/history | List all server sessions|
+|[**listOnline**](#listonline) | **GET** /v1/servers | List online server sessions|
+|[**markOffline**](#markoffline) | **PUT** /v1/servers/{id}/offline | Mark a session offline|
+|[**register**](#register) | **POST** /v1/servers | Register a server session|
+
+# **heartbeat**
+> heartbeat()
+
+Updates the `last_heartbeat` timestamp for the given session, keeping it marked as online. Sessions that miss heartbeats for more than 2 minutes are automatically tombstoned by the scheduler. Call this every 30 seconds from the game server. 
+
+### Example
+
+```typescript
+import {
+    ServerSessionsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ServerSessionsApi(configuration);
+
+let id: string; //Session UUID returned from the registration call (default to undefined)
+
+const { status, data } = await apiInstance.heartbeat(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Session UUID returned from the registration call | 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 |
+|-------------|-------------|------------------|
+|**204** | Heartbeat recorded |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Session not found or already offline |  -  |
+
+[[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)
+
+# **listAll**
+> Array<ServerSessionDTO> listAll()
+
+Returns all server sessions — both online and historical — ordered by start time descending. Used by the web UI to populate the session filter dropdown.
+
+### Example
+
+```typescript
+import {
+    ServerSessionsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ServerSessionsApi(configuration);
+
+const { status, data } = await apiInstance.listAll();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ServerSessionDTO>**
+
+### 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 all sessions |  -  |
+|**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)
+
+# **listOnline**
+> Array<ServerSessionDTO> listOnline()
+
+Returns all currently online server sessions, ordered by start time descending.
+
+### Example
+
+```typescript
+import {
+    ServerSessionsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ServerSessionsApi(configuration);
+
+const { status, data } = await apiInstance.listOnline();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ServerSessionDTO>**
+
+### 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 online sessions |  -  |
+|**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)
+
+# **markOffline**
+> markOffline()
+
+Marks the session as offline with the current timestamp as `endedAt`. Call this from the game server\'s shutdown hook for a clean shutdown signal. Sessions that crash without calling this endpoint will be tombstoned automatically by the 2-minute heartbeat scheduler. 
+
+### Example
+
+```typescript
+import {
+    ServerSessionsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ServerSessionsApi(configuration);
+
+let id: string; //Session UUID returned from the registration call (default to undefined)
+
+const { status, data } = await apiInstance.markOffline(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Session UUID returned from the registration call | 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 |
+|-------------|-------------|------------------|
+|**204** | Session marked offline |  -  |
+|**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)
+
+# **register**
+> ServerSessionDTO register(serverRegisterRequest)
+
+Registers a game server instance and returns a session ID used for subsequent heartbeats and chat ingestion. If a `containerId` is provided and an online session already exists for that container (e.g. after a Velocity restart), the existing session is returned unchanged. Otherwise a fresh session is created with an auto-generated instance name. 
+
+### Example
+
+```typescript
+import {
+    ServerSessionsApi,
+    Configuration,
+    ServerRegisterRequest
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new ServerSessionsApi(configuration);
+
+let serverRegisterRequest: ServerRegisterRequest; //
+
+const { status, data } = await apiInstance.register(
+    serverRegisterRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **serverRegisterRequest** | **ServerRegisterRequest**|  | |
+
+
+### Return type
+
+**ServerSessionDTO**
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Session created or resumed |  -  |
+|**400** | Bad request — missing required fields |  -  |
+|**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/TokenRequest.md

@@ -0,0 +1,24 @@
+# TokenRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**grant_type** | **string** |  | [optional] [default to undefined]
+**client_id** | **string** |  | [optional] [default to undefined]
+**client_secret** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TokenRequest } from '@rebornteam/reborn-api';
+
+const instance: TokenRequest = {
+    grant_type,
+    client_id,
+    client_secret,
+};
+```
+
+[[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/index.ts

@@ -4,7 +4,7 @@
  * Reborn API
  * 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 
  *
- * The version of the OpenAPI document: 2.6.0
+ * The version of the OpenAPI document: 2.7.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebornteam/reborn-api",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "OpenAPI client for @rebornteam/reborn-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/ApplyPunishmentRequest.md

@@ -1,31 +0,0 @@
-# ApplyPunishmentRequest
-
-Request to apply a punishment to a player
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**playerUuid** | **string** | Player UUID to punish | [default to undefined]
-**reason** | **string** | Reason for the punishment | [default to undefined]
-**type** | **string** | Type of punishment | [default to undefined]
-**severity** | **number** | Severity level of the punishment (1-10) | [default to undefined]
-**createdBy** | **string** | Staff member applying the punishment | [default to undefined]
-**durationSeconds** | **number** | Duration of the punishment in seconds. Null means permanent. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ApplyPunishmentRequest } from '@rebornteam/reborn-api';
-
-const instance: ApplyPunishmentRequest = {
-    playerUuid,
-    reason,
-    type,
-    severity,
-    createdBy,
-    durationSeconds,
-};
-```
-
-[[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/ApplyPunishmentResponse.md

@@ -1,33 +0,0 @@
-# ApplyPunishmentResponse
-
-Response after applying a punishment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**punishmentId** | **number** | ID of the created punishment | [optional] [default to undefined]
-**playerUuid** | **string** | Player UUID punished | [optional] [default to undefined]
-**type** | **string** | Type of punishment applied | [optional] [default to undefined]
-**severity** | **number** | Severity level (1-10) | [optional] [default to undefined]
-**newScore** | **number** | New total punishment score after applying | [optional] [default to undefined]
-**isPermanent** | **boolean** | Whether this punishment is permanent | [optional] [default to undefined]
-**expiresAt** | **string** | Timestamp when punishment expires (ISO-8601 format, null if permanent) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ApplyPunishmentResponse } from '@rebornteam/reborn-api';
-
-const instance: ApplyPunishmentResponse = {
-    punishmentId,
-    playerUuid,
-    type,
-    severity,
-    newScore,
-    isPermanent,
-    expiresAt,
-};
-```
-
-[[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/CreatePunishmentDraftRequest.md

@@ -1,29 +0,0 @@
-# CreatePunishmentDraftRequest
-
-Request to create a punishment draft for preview before applying
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**playerUuid** | **string** | Player UUID to punish | [default to undefined]
-**reason** | **string** | Reason for the punishment | [default to undefined]
-**type** | **string** | Type of punishment | [default to undefined]
-**severity** | **number** | Severity level of the punishment (1-10) | [default to undefined]
-**durationSeconds** | **number** | Duration of the punishment in seconds. Null means permanent. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreatePunishmentDraftRequest } from '@rebornteam/reborn-api';
-
-const instance: CreatePunishmentDraftRequest = {
-    playerUuid,
-    reason,
-    type,
-    severity,
-    durationSeconds,
-};
-```
-
-[[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/DefaultApi.md

@@ -1,105 +0,0 @@
-# DefaultApi
-
-All URIs are relative to *https://api.smsh.sh*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**callback**](#callback) | **GET** /auth/discord/callback | |
-|[**initiateLogin**](#initiatelogin) | **GET** /auth/discord | |
-
-# **callback**
-> object callback()
-
-
-### Example
-
-```typescript
-import {
-    DefaultApi,
-    Configuration
-} from '@rebornteam/reborn-api';
-
-const configuration = new Configuration();
-const apiInstance = new DefaultApi(configuration);
-
-let code: string; // (optional) (default to undefined)
-let error: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.callback(
-    code,
-    error
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **code** | [**string**] |  | (optional) defaults to undefined|
-| **error** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**object**
-
-### Authorization
-
-[DiscordAuth](../README.md#DiscordAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | callback 200 response |  -  |
-
-[[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**
-> object initiateLogin()
-
-
-### Example
-
-```typescript
-import {
-    DefaultApi,
-    Configuration
-} from '@rebornteam/reborn-api';
-
-const configuration = new Configuration();
-const apiInstance = new DefaultApi(configuration);
-
-const { status, data } = await apiInstance.initiateLogin();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**object**
-
-### Authorization
-
-[DiscordAuth](../README.md#DiscordAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | initiateLogin 200 response |  -  |
-
-[[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/PunishmentDraftResponse.md

@@ -1,39 +0,0 @@
-# PunishmentDraftResponse
-
-Response containing punishment draft preview with calculated points and thresholds
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**playerUuid** | **string** | Player UUID this punishment would apply to | [optional] [default to undefined]
-**reason** | **string** | Reason for the punishment | [optional] [default to undefined]
-**type** | **string** | Type of punishment | [optional] [default to undefined]
-**severity** | **number** | Severity level (1-10) | [optional] [default to undefined]
-**currentScore** | **number** | Current total punishment score before applying this punishment | [optional] [default to undefined]
-**pointsToAdd** | **number** | Points this punishment would add | [optional] [default to undefined]
-**newScore** | **number** | New total score after applying this punishment | [optional] [default to undefined]
-**willBePermanent** | **boolean** | Whether this punishment will be permanent | [optional] [default to undefined]
-**durationSeconds** | **number** | Duration in seconds (null if permanent) | [optional] [default to undefined]
-**previousPunishmentCount** | **number** | Number of previous punishments for this player | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PunishmentDraftResponse } from '@rebornteam/reborn-api';
-
-const instance: PunishmentDraftResponse = {
-    playerUuid,
-    reason,
-    type,
-    severity,
-    currentScore,
-    pointsToAdd,
-    newScore,
-    willBePermanent,
-    durationSeconds,
-    previousPunishmentCount,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)