@rebornteam/reborn-api 2.5.1

package/docs/AdminClientCredentialsApi.md

@@ -0,0 +1,390 @@
+# AdminClientCredentialsApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**disableClient**](#disableclient) | **POST** /admin/client/{id}/disable | Disable client credentials|
+|[**enableClient**](#enableclient) | **POST** /admin/client/{id}/enable | Enable client credentials|
+|[**generateClientCredentials**](#generateclientcredentials) | **POST** /admin/client/generate | Generate new client credentials|
+|[**listClients**](#listclients) | **GET** /admin/client | List client credentials|
+|[**revokeToken**](#revoketoken) | **DELETE** /admin/client/{id} | Revoke client credentials|
+|[**rotateToken**](#rotatetoken) | **POST** /admin/client/{id}/rotate | Rotate client credentials|
+|[**updateClient**](#updateclient) | **PUT** /admin/client/{id} | Update client metadata|
+
+# **disableClient**
+> disableClient()
+
+Temporarily disables a client credential, preventing authentication. Can be re-enabled later.
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+let id: number; //Client credential ID (default to undefined)
+
+const { status, data } = await apiInstance.disableClient(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Client credential ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Client credential disabled successfully |  -  |
+|**404** | Client credential not found |  -  |
+|**401** | Unauthorized - Cognito token required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **enableClient**
+> enableClient()
+
+Re-enables a previously disabled client credential, allowing authentication.
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+let id: number; //Client credential ID (default to undefined)
+
+const { status, data } = await apiInstance.enableClient(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Client credential ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Client credential enabled successfully |  -  |
+|**404** | Client credential not found |  -  |
+|**401** | Unauthorized - Cognito token required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **generateClientCredentials**
+> AdminClientCredentialResponse generateClientCredentials(clientCredentialRequest)
+
+Creates a new API client with credentials for authentication. Returns the client ID and secret (only shown once).
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration,
+    ClientCredentialRequest
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+let clientCredentialRequest: ClientCredentialRequest; //
+
+const { status, data } = await apiInstance.generateClientCredentials(
+    clientCredentialRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientCredentialRequest** | **ClientCredentialRequest**|  | |
+
+
+### Return type
+
+**AdminClientCredentialResponse**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Client credentials generated successfully |  -  |
+|**400** | Invalid request body |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **listClients**
+> Array<AdminClientCredentialResponse> listClients()
+
+Returns all client credentials. **Client secrets are never returned** from this endpoint.
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+const { status, data } = await apiInstance.listClients();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<AdminClientCredentialResponse>**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Client credentials retrieved successfully |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **revokeToken**
+> revokeToken()
+
+Permanently deletes a client credential from the database, revoking all access.
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+let id: number; //Client credential ID (default to undefined)
+
+const { status, data } = await apiInstance.revokeToken(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Client credential ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Client credential revoked successfully |  -  |
+|**404** | Client credential not found |  -  |
+|**401** | Unauthorized - Cognito token required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **rotateToken**
+> AdminClientCredentialResponse rotateToken()
+
+Generates new client ID and secret for an existing client. The old credentials will no longer work. Returns the new credentials (secret only shown once).
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+let id: number; //Client credential ID (default to undefined)
+
+const { status, data } = await apiInstance.rotateToken(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Client credential ID | defaults to undefined|
+
+
+### Return type
+
+**AdminClientCredentialResponse**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Client credentials rotated successfully |  -  |
+|**404** | Client credential not found |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **updateClient**
+> AdminClientCredentialResponse updateClient(updateClientRequest)
+
+Updates the name and/or description of a client credential. Does not affect the actual credentials.
+
+### Example
+
+```typescript
+import {
+    AdminClientCredentialsApi,
+    Configuration,
+    UpdateClientRequest
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminClientCredentialsApi(configuration);
+
+let id: number; //Client credential ID (default to undefined)
+let updateClientRequest: UpdateClientRequest; //
+
+const { status, data } = await apiInstance.updateClient(
+    id,
+    updateClientRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateClientRequest** | **UpdateClientRequest**|  | |
+| **id** | [**number**] | Client credential ID | defaults to undefined|
+
+
+### Return type
+
+**AdminClientCredentialResponse**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Client metadata updated successfully |  -  |
+|**404** | Client credential not found |  -  |
+|**400** | Invalid request body |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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/AdminConnectionBypassResponse.md

@@ -0,0 +1,27 @@
+# AdminConnectionBypassResponse
+
+Connection bypass response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Unique identifier for the bypass | [optional] [default to undefined]
+**ipAddress** | **string** | IP address that is bypassed | [optional] [default to undefined]
+**expiresAt** | **string** | Timestamp when the bypass expires (ISO-8601 format) | [optional] [default to undefined]
+**createdAt** | **string** | Timestamp when the bypass was created (ISO-8601 format) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminConnectionBypassResponse } from '@rebornteam/reborn-api';
+
+const instance: AdminConnectionBypassResponse = {
+    id,
+    ipAddress,
+    expiresAt,
+    createdAt,
+};
+```
+
+[[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/AdminConnectionsApi.md

@@ -0,0 +1,135 @@
+# AdminConnectionsApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createBypass**](#createbypass) | **POST** /admin/connection/bypass | Create connection bypass|
+|[**listConnections**](#listconnections) | **GET** /admin/connection/recent | List recent connections|
+
+# **createBypass**
+> AdminConnectionBypassResponse createBypass(createBypassRequest)
+
+Creates a temporary bypass for an IP address, expiring at the specified epoch timestamp (milliseconds since Unix epoch).
+
+### Example
+
+```typescript
+import {
+    AdminConnectionsApi,
+    Configuration,
+    CreateBypassRequest
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminConnectionsApi(configuration);
+
+let createBypassRequest: CreateBypassRequest; //
+
+const { status, data } = await apiInstance.createBypass(
+    createBypassRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createBypassRequest** | **CreateBypassRequest**|  | |
+
+
+### Return type
+
+**AdminConnectionBypassResponse**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection bypass created successfully |  -  |
+|**400** | Invalid request body |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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)
+
+# **listConnections**
+> Array<AdminDashboardConnectionResponse> listConnections()
+
+Returns a list of recent connections with VPN detection status, bypass information, and associated player data. Optionally filter by epoch timestamp (seconds since Unix epoch).
+
+### Example
+
+```typescript
+import {
+    AdminConnectionsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminConnectionsApi(configuration);
+
+let createdAfter: number; //Filter connections after this epoch timestamp in milliseconds (optional) (default to undefined)
+let createdBefore: number; //Filter connections before this epoch timestamp in milliseconds (optional) (default to undefined)
+let ipAddress: string; //Filter by IP address (optional) (default to undefined)
+let uuid: string; //Filter by player UUID (optional) (default to undefined)
+let isVpn: boolean; //Filter by VPN status (true=VPN, false=not VPN) (optional) (default to undefined)
+let page: number; //Page number for pagination (optional) (default to 1)
+let limit: number; //Maximum number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.listConnections(
+    createdAfter,
+    createdBefore,
+    ipAddress,
+    uuid,
+    isVpn,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createdAfter** | [**number**] | Filter connections after this epoch timestamp in milliseconds | (optional) defaults to undefined|
+| **createdBefore** | [**number**] | Filter connections before this epoch timestamp in milliseconds | (optional) defaults to undefined|
+| **ipAddress** | [**string**] | Filter by IP address | (optional) defaults to undefined|
+| **uuid** | [**string**] | Filter by player UUID | (optional) defaults to undefined|
+| **isVpn** | [**boolean**] | Filter by VPN status (true&#x3D;VPN, false&#x3D;not VPN) | (optional) defaults to undefined|
+| **page** | [**number**] | Page number for pagination | (optional) defaults to 1|
+| **limit** | [**number**] | Maximum number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<AdminDashboardConnectionResponse>**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved connections list |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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/AdminDashboardApi.md

@@ -0,0 +1,54 @@
+# AdminDashboardApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**dashboardStats**](#dashboardstats) | **GET** /admin/dashboard | Get dashboard statistics|
+
+# **dashboardStats**
+> AdminGetDashboardStats dashboardStats()
+
+Returns aggregate counts for clients, connections, and players in the system.
+
+### Example
+
+```typescript
+import {
+    AdminDashboardApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminDashboardApi(configuration);
+
+const { status, data } = await apiInstance.dashboardStats();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AdminGetDashboardStats**
+
+### Authorization
+
+[CognitoAuth](../README.md#CognitoAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved dashboard statistics |  -  |
+|**401** | Unauthorized - Authentication required |  -  |
+|**403** | Forbidden - CognitoAdministrator role required |  -  |
+
+[[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/AdminDashboardConnectionResponse.md

@@ -0,0 +1,38 @@
+# AdminDashboardConnectionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**ipAddress** | **string** |  | [default to undefined]
+**location** | **string** |  | [default to undefined]
+**isVpn** | **boolean** |  | [default to undefined]
+**isBypassed** | **boolean** |  | [default to undefined]
+**bypassExpiresAt** | **string** |  | [optional] [default to undefined]
+**playerUuid** | **string** |  | [optional] [default to undefined]
+**lastSeen** | **string** |  | [optional] [default to undefined]
+**percentPositive** | **number** |  | [default to undefined]
+**numberOfChecks** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdminDashboardConnectionResponse } from '@rebornteam/reborn-api';
+
+const instance: AdminDashboardConnectionResponse = {
+    id,
+    ipAddress,
+    location,
+    isVpn,
+    isBypassed,
+    bypassExpiresAt,
+    playerUuid,
+    lastSeen,
+    percentPositive,
+    numberOfChecks,
+};
+```
+
+[[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/AdminGetDashboardStats.md

@@ -0,0 +1,24 @@
+# AdminGetDashboardStats
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalPlayers** | **number** |  | [default to undefined]
+**totalConnections** | **number** |  | [default to undefined]
+**totalClients** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdminGetDashboardStats } from '@rebornteam/reborn-api';
+
+const instance: AdminGetDashboardStats = {
+    totalPlayers,
+    totalConnections,
+    totalClients,
+};
+```
+
+[[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/ApplyPunishmentRequest.md

@@ -0,0 +1,31 @@
+# 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)