@rebornteam/reborn-api 4.9.3 → 4.9.4

package/.openapi-generator/FILES

@@ -6,6 +6,7 @@ api.ts
 base.ts
 common.ts
 configuration.ts
+docs/AdminAdvancedBanImportRequest.md
 docs/AdminAltAccount.md
 docs/AdminAltExemption.md
 docs/AdminAltGraph.md
@@ -42,7 +43,10 @@ docs/AdminDashboardReportSummary.md
 docs/AdminDashboardServerRegion.md
 docs/AdminDashboardTrustBucket.md
 docs/AdminGetDashboardStats.md
+docs/AdminImportApi.md
 docs/AdminIpSearchResult.md
+docs/AdminJobConfig.md
+docs/AdminJobField.md
 docs/AdminJobsApi.md
 docs/AdminPlayerDetailResponse.md
 docs/AdminPlayerNote.md
@@ -85,6 +89,7 @@ docs/CursoredPageAdminAuditLogEntry.md
 docs/CursoredPageable.md
 docs/DiscordAuthUrlResponse.md
 docs/GameType.md
+docs/JobFieldType.md
 docs/JobStatus.md
 docs/PageAdminAltAccount.md
 docs/PageAdminAltExemption.md

package/README.md

@@ -1,4 +1,4 @@
-## @rebornteam/reborn-api@4.9.3
+## @rebornteam/reborn-api@4.9.4
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @rebornteam/reborn-api@4.9.3 --save
+npm install @rebornteam/reborn-api@4.9.4 --save
 ```
 
 _unPublished (not recommended):_
@@ -77,7 +77,9 @@ Class | Method | HTTP request | Description
 *AdminDashboardApi* | [**serverRegions**](docs/AdminDashboardApi.md#serverregions) | **GET** /admin/dashboard/servers/summary | Servers & players by region
 *AdminDashboardApi* | [**topModerators**](docs/AdminDashboardApi.md#topmoderators) | **GET** /admin/dashboard/moderators/top | Top moderators by activity
 *AdminDashboardApi* | [**trustDistribution**](docs/AdminDashboardApi.md#trustdistribution) | **GET** /admin/dashboard/trust/distribution | Trust-factor distribution
+*AdminImportApi* | [**importAdvancedBan**](docs/AdminImportApi.md#importadvancedban) | **POST** /admin/import/advancedban | Import punishments from an AdvancedBan MySQL database
 *AdminJobsApi* | [**cancel**](docs/AdminJobsApi.md#cancel) | **DELETE** /admin/job/{id} | Request cancellation of an async job
+*AdminJobsApi* | [**config**](docs/AdminJobsApi.md#config) | **GET** /admin/job/config | List configurable jobs
 *AdminJobsApi* | [**downloadArtifact**](docs/AdminJobsApi.md#downloadartifact) | **GET** /admin/job/{id}/artifact.csv | Download a job\'s CSV artifact
 *AdminJobsApi* | [**get**](docs/AdminJobsApi.md#get) | **GET** /admin/job/{id} | Get one async job
 *AdminJobsApi* | [**list**](docs/AdminJobsApi.md#list) | **GET** /admin/job | List async jobs
@@ -137,6 +139,7 @@ Class | Method | HTTP request | Description
 
 ### Documentation For Models
 
+ - [AdminAdvancedBanImportRequest](docs/AdminAdvancedBanImportRequest.md)
  - [AdminAltAccount](docs/AdminAltAccount.md)
  - [AdminAltExemption](docs/AdminAltExemption.md)
  - [AdminAltGraph](docs/AdminAltGraph.md)
@@ -170,6 +173,8 @@ Class | Method | HTTP request | Description
  - [AdminDashboardTrustBucket](docs/AdminDashboardTrustBucket.md)
  - [AdminGetDashboardStats](docs/AdminGetDashboardStats.md)
  - [AdminIpSearchResult](docs/AdminIpSearchResult.md)
+ - [AdminJobConfig](docs/AdminJobConfig.md)
+ - [AdminJobField](docs/AdminJobField.md)
  - [AdminPlayerDetailResponse](docs/AdminPlayerDetailResponse.md)
  - [AdminPlayerNote](docs/AdminPlayerNote.md)
  - [AdminPlayerPunishmentResponse](docs/AdminPlayerPunishmentResponse.md)
@@ -205,6 +210,7 @@ Class | Method | HTTP request | Description
  - [CursoredPageable](docs/CursoredPageable.md)
  - [DiscordAuthUrlResponse](docs/DiscordAuthUrlResponse.md)
  - [GameType](docs/GameType.md)
+ - [JobFieldType](docs/JobFieldType.md)
  - [JobStatus](docs/JobStatus.md)
  - [PageAdminAltAccount](docs/PageAdminAltAccount.md)
  - [PageAdminAltExemption](docs/PageAdminAltExemption.md)

package/api.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).
@@ -23,6 +23,43 @@ import type { RequestArgs } from './base';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
 
+/**
+ * Source AdvancedBan MySQL connection details for a punishment import.
+ */
+export interface AdminAdvancedBanImportRequest {
+    /**
+     * MySQL host
+     */
+    'host': string;
+    /**
+     * MySQL port (default 3306)
+     */
+    'port'?: number | null;
+    /**
+     * Database / schema name
+     */
+    'database': string;
+    /**
+     * MySQL username
+     */
+    'username': string;
+    /**
+     * MySQL password
+     */
+    'password'?: string | null;
+    /**
+     * Active punishments table (default \'Punishments\')
+     */
+    'activeTable'?: string | null;
+    /**
+     * History table (default \'PunishmentHistory\')
+     */
+    'historyTable'?: string | null;
+    /**
+     * Use TLS for the MySQL connection (default false)
+     */
+    'useSsl'?: boolean | null;
+}
 /**
  * Another player who has been seen on at least one of this player\'s historical connections — i.e. an alt account candidate.
  */
@@ -742,6 +779,70 @@ export interface AdminIpSearchResult {
      */
     'players': Array<AdminPlayerSearchResult>;
 }
+/**
+ * Configuration metadata for a runnable job (fields + submit path).
+ */
+export interface AdminJobConfig {
+    /**
+     * JobType name
+     */
+    'jobType'?: string;
+    /**
+     * Display title
+     */
+    'title'?: string;
+    /**
+     * Display description
+     */
+    'description'?: string;
+    /**
+     * Path the filled-in {key:value} body is POSTed to
+     */
+    'submitPath'?: string;
+    /**
+     * Whether running this job requires Administrator rank
+     */
+    'requiresAdmin'?: boolean;
+    /**
+     * Fields to render, in order
+     */
+    'fields'?: Array<AdminJobField>;
+}
+/**
+ * One configurable field of a runnable job.
+ */
+export interface AdminJobField {
+    /**
+     * Field key; also the JSON property name submitted to the job\'s endpoint
+     */
+    'key'?: string;
+    /**
+     * Human label for the input
+     */
+    'label'?: string;
+    /**
+     * Input type
+     */
+    'type'?: JobFieldType;
+    /**
+     * Whether the field must be provided
+     */
+    'required'?: boolean;
+    /**
+     * Default value, string form (booleans use \"true\"/\"false\")
+     */
+    'defaultValue'?: string | null;
+    /**
+     * Placeholder text
+     */
+    'placeholder'?: string | null;
+    /**
+     * Optional helper text shown under the input
+     */
+    'helpText'?: string | null;
+}
+
+
 /**
  * Full player detail including punishment history and all known usernames
  */
@@ -1538,6 +1639,20 @@ export const GameType = {
 export type GameType = typeof GameType[keyof typeof GameType];
 
 
+/**
+ * Input type
+ */
+
+export const JobFieldType = {
+    Text: 'TEXT',
+    Number: 'NUMBER',
+    Password: 'PASSWORD',
+    Boolean: 'BOOLEAN'
+} as const;
+
+export type JobFieldType = typeof JobFieldType[keyof typeof JobFieldType];
+
+
 /**
  * Current lifecycle state.
  */
@@ -4378,6 +4493,112 @@ export class AdminDashboardApi extends BaseAPI {
 
 
 
+/**
+ * AdminImportApi - axios parameter creator
+ */
+export const AdminImportApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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.
+         * @summary Import punishments from an AdvancedBan MySQL database
+         * @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        importAdvancedBan: async (adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'adminAdvancedBanImportRequest' is not null or undefined
+            assertParamExists('importAdvancedBan', 'adminAdvancedBanImportRequest', adminAdvancedBanImportRequest)
+            const localVarPath = `/admin/import/advancedban`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication DiscordAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(adminAdvancedBanImportRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * AdminImportApi - functional programming interface
+ */
+export const AdminImportApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AdminImportApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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.
+         * @summary Import punishments from an AdvancedBan MySQL database
+         * @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAsyncJobStartResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.importAdvancedBan(adminAdvancedBanImportRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AdminImportApi.importAdvancedBan']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * AdminImportApi - factory interface
+ */
+export const AdminImportApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AdminImportApiFp(configuration)
+    return {
+        /**
+         * 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.
+         * @summary Import punishments from an AdvancedBan MySQL database
+         * @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAsyncJobStartResponse> {
+            return localVarFp.importAdvancedBan(adminAdvancedBanImportRequest, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * AdminImportApi - object-oriented interface
+ */
+export class AdminImportApi extends BaseAPI {
+    /**
+     * 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.
+     * @summary Import punishments from an AdvancedBan MySQL database
+     * @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig) {
+        return AdminImportApiFp(this.configuration).importAdvancedBan(adminAdvancedBanImportRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * AdminJobsApi - axios parameter creator
  */
@@ -4411,6 +4632,40 @@ export const AdminJobsApiAxiosParamCreator = function (configuration?: Configura
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
 
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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.
+         * @summary List configurable jobs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        config: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/admin/job/config`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication DiscordAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -4564,6 +4819,18 @@ export const AdminJobsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AdminJobsApi.cancel']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary List configurable jobs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async config(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminJobConfig>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.config(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AdminJobsApi.config']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
          * @summary Download a job\'s CSV artifact
@@ -4623,6 +4890,15 @@ export const AdminJobsApiFactory = function (configuration?: Configuration, base
         cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary List configurable jobs
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        config(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminJobConfig>> {
+            return localVarFp.config(options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
          * @summary Download a job\'s CSV artifact
@@ -4672,6 +4948,16 @@ export class AdminJobsApi extends BaseAPI {
         return AdminJobsApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary List configurable jobs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public config(options?: RawAxiosRequestConfig) {
+        return AdminJobsApiFp(this.configuration).config(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
      * @summary Download a job\'s CSV artifact

package/base.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/common.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/configuration.ts

@@ -3,7 +3,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).