@rebornteam/reborn-api 4.9.2 → 4.9.4

package/dist/api.d.ts

@@ -2,7 +2,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.2
+ * The version of the OpenAPI document: 4.9.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,43 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } 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.
  */
@@ -724,6 +761,68 @@ 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
  */
@@ -1481,12 +1580,31 @@ export interface CursoredPageable {
     'sort': Sort;
     'backward': boolean;
 }
+/**
+ * The Discord OAuth2 authorize URL, returned as JSON so a native client can open it directly (system browser → Discord-app universal-link hand-off) rather than following the backend\'s 302. Keeps client_id/scope server-side.
+ */
+export interface DiscordAuthUrlResponse {
+    /**
+     * Discord OAuth2 authorize URL to open on the client.
+     */
+    'authorizeUrl': string;
+}
 export declare const GameType: {
     readonly Rotj: "ROTJ";
     readonly Legacy: "LEGACY";
     readonly Classic: "CLASSIC";
 };
 export type GameType = typeof GameType[keyof typeof GameType];
+/**
+ * Input type
+ */
+export declare const JobFieldType: {
+    readonly Text: "TEXT";
+    readonly Number: "NUMBER";
+    readonly Password: "PASSWORD";
+    readonly Boolean: "BOOLEAN";
+};
+export type JobFieldType = typeof JobFieldType[keyof typeof JobFieldType];
 /**
  * Current lifecycle state.
  */
@@ -3088,6 +3206,58 @@ export declare class AdminDashboardApi extends BaseAPI {
      */
     trustDistribution(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardTrustBucket[], any, {}>>;
 }
+/**
+ * AdminImportApi - axios parameter creator
+ */
+export declare const AdminImportApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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) => Promise<RequestArgs>;
+};
+/**
+ * AdminImportApi - functional programming interface
+ */
+export declare const AdminImportApiFp: (configuration?: Configuration) => {
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAsyncJobStartResponse>>;
+};
+/**
+ * AdminImportApi - factory interface
+ */
+export declare const AdminImportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+};
+/**
+ * AdminImportApi - object-oriented interface
+ */
+export declare 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}
+     */
+    importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAsyncJobStartResponse, any, {}>>;
+}
 /**
  * AdminJobsApi - axios parameter creator
  */
@@ -3100,6 +3270,13 @@ export declare const AdminJobsApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     cancel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
     /**
      * 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
@@ -3138,6 +3315,13 @@ export declare const AdminJobsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminJobConfig>>>;
     /**
      * 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
@@ -3176,6 +3360,13 @@ export declare const AdminJobsApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * 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>>;
     /**
      * 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
@@ -3214,6 +3405,13 @@ export declare class AdminJobsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     cancel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<AdminJobConfig[], any, {}>>;
     /**
      * 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
@@ -4352,6 +4550,14 @@ export declare class AdminReportsApi extends BaseAPI {
  * AuthenticationApi - axios parameter creator
  */
 export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns the Discord OAuth2 authorize URL as JSON so a native app can open it directly (system browser → Discord-app universal-link hand-off) instead of following the 302. The `redirect` is validated against the allowlist and carried through Discord via `state`, exactly like the browser flow; the callback still bounces the JWT to that target.
+     * @summary Discord - Authorize URL (native clients)
+     * @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeUrl: (redirect?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @summary Discord - OAuth2 callback
@@ -4392,6 +4598,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
  * AuthenticationApi - functional programming interface
  */
 export declare const AuthenticationApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns the Discord OAuth2 authorize URL as JSON so a native app can open it directly (system browser → Discord-app universal-link hand-off) instead of following the 302. The `redirect` is validated against the allowlist and carried through Discord via `state`, exactly like the browser flow; the callback still bounces the JWT to that target.
+     * @summary Discord - Authorize URL (native clients)
+     * @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeUrl(redirect?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DiscordAuthUrlResponse>>;
     /**
      * 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.
      * @summary Discord - OAuth2 callback
@@ -4432,6 +4646,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
  * AuthenticationApi - factory interface
  */
 export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns the Discord OAuth2 authorize URL as JSON so a native app can open it directly (system browser → Discord-app universal-link hand-off) instead of following the 302. The `redirect` is validated against the allowlist and carried through Discord via `state`, exactly like the browser flow; the callback still bounces the JWT to that target.
+     * @summary Discord - Authorize URL (native clients)
+     * @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeUrl(redirect?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DiscordAuthUrlResponse>;
     /**
      * 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.
      * @summary Discord - OAuth2 callback
@@ -4472,6 +4694,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
  * AuthenticationApi - object-oriented interface
  */
 export declare class AuthenticationApi extends BaseAPI {
+    /**
+     * Returns the Discord OAuth2 authorize URL as JSON so a native app can open it directly (system browser → Discord-app universal-link hand-off) instead of following the 302. The `redirect` is validated against the allowlist and carried through Discord via `state`, exactly like the browser flow; the callback still bounces the JWT to that target.
+     * @summary Discord - Authorize URL (native clients)
+     * @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeUrl(redirect?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DiscordAuthUrlResponse, any, {}>>;
     /**
      * 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.
      * @summary Discord - OAuth2 callback