@rebornteam/reborn-api 4.9.3 → 4.9.4

package/docs/AdminImportApi.md

@@ -0,0 +1,63 @@
+# AdminImportApi
+
+All URIs are relative to *https://api.smsh.sh*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**importAdvancedBan**](#importadvancedban) | **POST** /admin/import/advancedban | Import punishments from an AdvancedBan MySQL database|
+
+# **importAdvancedBan**
+> AdminAsyncJobStartResponse importAdvancedBan(adminAdvancedBanImportRequest)
+
+Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
+
+### Example
+
+```typescript
+import {
+    AdminImportApi,
+    Configuration,
+    AdminAdvancedBanImportRequest
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminImportApi(configuration);
+
+let adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest; //
+
+const { status, data } = await apiInstance.importAdvancedBan(
+    adminAdvancedBanImportRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminAdvancedBanImportRequest** | **AdminAdvancedBanImportRequest**|  | |
+
+
+### Return type
+
+**AdminAsyncJobStartResponse**
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Job accepted; poll /admin/job/{id} for progress |  -  |
+|**400** | Invalid request body |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden - Administrator 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/AdminJobConfig.md

@@ -0,0 +1,31 @@
+# AdminJobConfig
+
+Configuration metadata for a runnable job (fields + submit path).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobType** | **string** | JobType name | [optional] [default to undefined]
+**title** | **string** | Display title | [optional] [default to undefined]
+**description** | **string** | Display description | [optional] [default to undefined]
+**submitPath** | **string** | Path the filled-in {key:value} body is POSTed to | [optional] [default to undefined]
+**requiresAdmin** | **boolean** | Whether running this job requires Administrator rank | [optional] [default to undefined]
+**fields** | [**Array<AdminJobField>**](AdminJobField.md) | Fields to render, in order | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminJobConfig } from '@rebornteam/reborn-api';
+
+const instance: AdminJobConfig = {
+    jobType,
+    title,
+    description,
+    submitPath,
+    requiresAdmin,
+    fields,
+};
+```
+
+[[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/AdminJobField.md

@@ -0,0 +1,33 @@
+# AdminJobField
+
+One configurable field of a runnable job.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Field key; also the JSON property name submitted to the job\'s endpoint | [optional] [default to undefined]
+**label** | **string** | Human label for the input | [optional] [default to undefined]
+**type** | [**JobFieldType**](JobFieldType.md) | Input type | [optional] [default to undefined]
+**required** | **boolean** | Whether the field must be provided | [optional] [default to undefined]
+**defaultValue** | **string** | Default value, string form (booleans use \"true\"/\"false\") | [optional] [default to undefined]
+**placeholder** | **string** | Placeholder text | [optional] [default to undefined]
+**helpText** | **string** | Optional helper text shown under the input | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminJobField } from '@rebornteam/reborn-api';
+
+const instance: AdminJobField = {
+    key,
+    label,
+    type,
+    required,
+    defaultValue,
+    placeholder,
+    helpText,
+};
+```
+
+[[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/AdminJobsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.smsh.sh*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**cancel**](#cancel) | **DELETE** /admin/job/{id} | Request cancellation of an async job|
+|[**config**](#config) | **GET** /admin/job/config | List configurable jobs|
 |[**downloadArtifact**](#downloadartifact) | **GET** /admin/job/{id}/artifact.csv | Download a job\'s CSV artifact|
 |[**get**](#get) | **GET** /admin/job/{id} | Get one async job|
 |[**list**](#list) | **GET** /admin/job | List async jobs|
@@ -63,6 +64,52 @@ void (empty response body)
 
 [[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)
 
+# **config**
+> Array<AdminJobConfig> config()
+
+Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
+
+### Example
+
+```typescript
+import {
+    AdminJobsApi,
+    Configuration
+} from '@rebornteam/reborn-api';
+
+const configuration = new Configuration();
+const apiInstance = new AdminJobsApi(configuration);
+
+const { status, data } = await apiInstance.config();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<AdminJobConfig>**
+
+### Authorization
+
+[DiscordAuth](../README.md#DiscordAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Job configuration metadata |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden - Moderator 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)
+
 # **downloadArtifact**
 > string downloadArtifact()
 

package/docs/JobFieldType.md

@@ -0,0 +1,15 @@
+# JobFieldType
+
+Input type
+
+## Enum
+
+* `Text` (value: `'TEXT'`)
+
+* `Number` (value: `'NUMBER'`)
+
+* `Password` (value: `'PASSWORD'`)
+
+* `Boolean` (value: `'BOOLEAN'`)
+
+[[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: 4.9.3
+ * The version of the OpenAPI document: 4.9.4
  * 
  *
  * 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": "4.9.3",
+  "version": "4.9.4",
   "description": "OpenAPI client for @rebornteam/reborn-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {