@rebornteam/reborn-api 2.9.1 → 3.0.1

package/dist/esm/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: 2.9.1
+ * The version of the OpenAPI document: 3.0.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -152,6 +152,23 @@ export interface AdminConnectionBypassResponse {
      */
     'createdAt'?: string;
 }
+/**
+ * Result from a single VPN detection service for a given IP address
+ */
+export interface AdminConnectionCheckResult {
+    /**
+     * Service identifier
+     */
+    'service'?: string;
+    /**
+     * Whether this service flagged the IP as a VPN, proxy, or Tor exit node
+     */
+    'result'?: boolean;
+    /**
+     * When this check was last performed
+     */
+    'checkedAt'?: string;
+}
 /**
  * Request to evaluate the impact of a punishment across one or more targets before applying
  */
@@ -198,6 +215,10 @@ export interface AdminDashboardConnectionResponse {
     'lastSeen'?: string | null;
     'percentPositive': number;
     'numberOfChecks': number;
+    /**
+     * Results from each VPN detection service for this IP address
+     */
+    'results'?: Array<AdminConnectionCheckResult>;
 }
 export interface AdminGetDashboardStats {
     'totalPlayers': number;
@@ -539,24 +560,31 @@ export interface ConnectionGetConnectionDetailsResponse {
      */
     'ipAddress'?: string;
     /**
-     * Approximate geographic location of the IP address, typically in \'City, Country\' format. Returns \'Local, N/A\' for localhost or private IPs.
+     * Approximate geographic location of the IP address. Returns \'Local, N/A\' for localhost or private IPs.
      */
     'approximateLocation'?: string;
     /**
-     * Confidence score representing the percentage of VPN detection services that flagged this IP as suspicious. Range: 0.0 (clean) to 100.0 (definitely VPN/proxy). Values above 50.0 suggest high probability of VPN usage.
+     * Confidence score representing the percentage of VPN detection services that flagged this IP as suspicious. Range: 0.0 (clean) to 100.0 (definitely VPN/proxy).
      */
     'percentPositive'?: number;
     /**
-     * Total number of VPN detection services successfully queried during the last check. Higher numbers indicate more comprehensive analysis.
+     * Total number of VPN detection services successfully queried during the last check.
      */
     'numberOfChecks'?: number;
-    'bypassed'?: boolean;
     /**
-     * Expiration timestamp for the bypass (ISO-8601 format). After this time, normal VPN detection rules will apply again. Null if not bypassed or bypass is permanent.
+     * Indicates if this IP address has been administratively bypassed.
+     */
+    'isBypassed'?: boolean;
+    /**
+     * Expiration timestamp for the bypass (ISO-8601 format). Null if not bypassed or bypass is permanent.
      */
     'bypassedUntil'?: string | null;
     /**
-     * Player information associated with this connection. Only populated when \'associate_uuid\' query parameter is provided. Contains first join status and login history.
+     * Results from each VPN detection service that checked this IP address
+     */
+    'results'?: Array<AdminConnectionCheckResult>;
+    /**
+     * Player information associated with this connection. Only populated when \'associate_uuid\' query parameter is provided.
      */
     'playerInformation'?: PlayerGetPlayerInformation | null;
     /**
@@ -582,19 +610,19 @@ export interface CreateBypassRequest {
  */
 export interface PlayerGetPlayerInformation {
     /**
-     * Timestamp of when the player first connected to the server (ISO-8601 format).
+     * Indicates whether this is the player\'s first time joining the server.
      */
-    'firstLogin'?: string;
+    'firstJoin'?: boolean;
     /**
-     * Indicates whether this is the player\'s first time joining the server. Useful for triggering welcome messages, tutorials, or first-join rewards.
+     * Timestamp of when the player first connected to the server (ISO-8601 format).
      */
-    'firstJoin'?: boolean;
+    'firstLogin'?: string;
     /**
-     * Raw punishment score calculated as: SUM((base_weight × severity/10)) where base_weight is 0.10 for WARNING, 0.30 for MUTE, 0.50 for BAN. Severity ranges 1-10. Used for tracking overall punishment severity.
+     * Raw punishment score calculated as: SUM((base_weight × severity/10)). Used for tracking overall punishment severity.
      */
     'punishmentPointsRaw'?: number;
     /**
-     * Punishment score as a percentage (0-100). When this score is >100% BEFORE applying a new punishment, the new punishment should be made permanent. Check this value BEFORE issuing punishment, not after. Calculated as raw_score × 100.
+     * Punishment score as a percentage (0-100). When >100% before applying a new punishment, the new punishment should be made permanent.
      */
     'punishmentPointsPercent'?: number;
 }
@@ -1000,6 +1028,15 @@ export declare const AdminConnectionsApiAxiosParamCreator: (configuration?: Conf
      * @throws {RequiredError}
      */
     listConnections: (createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Re-runs one named VPN detection service for a specific connection, persists the updated result, and recalculates the connection\'s overall `percentPositive` and `numberOfChecks` from all stored checks. Returns the refreshed check result including its new `checkedAt` timestamp.
+     * @summary Refresh a single VPN check
+     * @param {number} connectionId
+     * @param {string} service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recheckService: (connectionId: number, service: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AdminConnectionsApi - functional programming interface
@@ -1039,6 +1076,15 @@ export declare const AdminConnectionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listConnections(createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardConnectionResponse>>>;
+    /**
+     * Re-runs one named VPN detection service for a specific connection, persists the updated result, and recalculates the connection\'s overall `percentPositive` and `numberOfChecks` from all stored checks. Returns the refreshed check result including its new `checkedAt` timestamp.
+     * @summary Refresh a single VPN check
+     * @param {number} connectionId
+     * @param {string} service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recheckService(connectionId: number, service: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminConnectionCheckResult>>;
 };
 /**
  * AdminConnectionsApi - factory interface
@@ -1078,6 +1124,15 @@ export declare const AdminConnectionsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     listConnections(createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardConnectionResponse>>;
+    /**
+     * Re-runs one named VPN detection service for a specific connection, persists the updated result, and recalculates the connection\'s overall `percentPositive` and `numberOfChecks` from all stored checks. Returns the refreshed check result including its new `checkedAt` timestamp.
+     * @summary Refresh a single VPN check
+     * @param {number} connectionId
+     * @param {string} service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recheckService(connectionId: number, service: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminConnectionCheckResult>;
 };
 /**
  * AdminConnectionsApi - object-oriented interface
@@ -1117,6 +1172,15 @@ export declare class AdminConnectionsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     listConnections(createdAfter?: number | null, createdBefore?: number | null, ipAddress?: string | null, uuid?: string | null, isVpn?: boolean | null, page?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardConnectionResponse[], any, {}>>;
+    /**
+     * Re-runs one named VPN detection service for a specific connection, persists the updated result, and recalculates the connection\'s overall `percentPositive` and `numberOfChecks` from all stored checks. Returns the refreshed check result including its new `checkedAt` timestamp.
+     * @summary Refresh a single VPN check
+     * @param {number} connectionId
+     * @param {string} service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    recheckService(connectionId: number, service: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminConnectionCheckResult, any, {}>>;
 }
 /**
  * AdminDashboardApi - axios parameter creator
@@ -1263,7 +1327,7 @@ export declare class AdminPlayersApi extends BaseAPI {
  */
 export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Apply a punishment to one or more targets. Player targets are linked via player_punishment; IP targets are linked via connection_punishment. The authenticated user is recorded as the issuer.
+     * Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
      * @summary Apply punishment
      * @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
      * @param {*} [options] Override http request option.
@@ -1271,7 +1335,7 @@ export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Conf
      */
     applyPunishment: (adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Preview the impact of a punishment across one or more targets. Returns current score, points to add, projected new score, and affected players per target. No changes are made.
+     * Preview the impact of a punishment across one or more targets. No changes are made.
      * @summary Evaluate punishment impact
      * @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
      * @param {*} [options] Override http request option.
@@ -1294,7 +1358,7 @@ export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Conf
      */
     getPunishments: (page: number, limit: number, uuid?: string | null, username?: string | null, ipAddress?: string | null, type?: Array<string> | null, issuedAfter?: number | null, issuedBefore?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Search for players by UUID or username, or look up all players associated with an IP address. Used to populate the target table before issuing a punishment.
+     * Search for players by UUID or username, or look up all players associated with an IP address.
      * @summary Search punishment targets
      * @param {string} q UUID, username, or partial/full IP address to search for
      * @param {*} [options] Override http request option.
@@ -1307,7 +1371,7 @@ export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Conf
  */
 export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
     /**
-     * Apply a punishment to one or more targets. Player targets are linked via player_punishment; IP targets are linked via connection_punishment. The authenticated user is recorded as the issuer.
+     * Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
      * @summary Apply punishment
      * @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
      * @param {*} [options] Override http request option.
@@ -1315,7 +1379,7 @@ export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
      */
     applyPunishment(adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminApplyPunishmentResponse>>;
     /**
-     * Preview the impact of a punishment across one or more targets. Returns current score, points to add, projected new score, and affected players per target. No changes are made.
+     * Preview the impact of a punishment across one or more targets. No changes are made.
      * @summary Evaluate punishment impact
      * @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
      * @param {*} [options] Override http request option.
@@ -1338,7 +1402,7 @@ export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
      */
     getPunishments(page: number, limit: number, uuid?: string | null, username?: string | null, ipAddress?: string | null, type?: Array<string> | null, issuedAfter?: number | null, issuedBefore?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminPagedPunishmentResponse>>;
     /**
-     * Search for players by UUID or username, or look up all players associated with an IP address. Used to populate the target table before issuing a punishment.
+     * Search for players by UUID or username, or look up all players associated with an IP address.
      * @summary Search punishment targets
      * @param {string} q UUID, username, or partial/full IP address to search for
      * @param {*} [options] Override http request option.
@@ -1351,7 +1415,7 @@ export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
  */
 export declare const AdminPunishmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Apply a punishment to one or more targets. Player targets are linked via player_punishment; IP targets are linked via connection_punishment. The authenticated user is recorded as the issuer.
+     * Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
      * @summary Apply punishment
      * @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
      * @param {*} [options] Override http request option.
@@ -1359,7 +1423,7 @@ export declare const AdminPunishmentsApiFactory: (configuration?: Configuration,
      */
     applyPunishment(adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminApplyPunishmentResponse>;
     /**
-     * Preview the impact of a punishment across one or more targets. Returns current score, points to add, projected new score, and affected players per target. No changes are made.
+     * Preview the impact of a punishment across one or more targets. No changes are made.
      * @summary Evaluate punishment impact
      * @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
      * @param {*} [options] Override http request option.
@@ -1382,7 +1446,7 @@ export declare const AdminPunishmentsApiFactory: (configuration?: Configuration,
      */
     getPunishments(page: number, limit: number, uuid?: string | null, username?: string | null, ipAddress?: string | null, type?: Array<string> | null, issuedAfter?: number | null, issuedBefore?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<AdminPagedPunishmentResponse>;
     /**
-     * Search for players by UUID or username, or look up all players associated with an IP address. Used to populate the target table before issuing a punishment.
+     * Search for players by UUID or username, or look up all players associated with an IP address.
      * @summary Search punishment targets
      * @param {string} q UUID, username, or partial/full IP address to search for
      * @param {*} [options] Override http request option.
@@ -1395,7 +1459,7 @@ export declare const AdminPunishmentsApiFactory: (configuration?: Configuration,
  */
 export declare class AdminPunishmentsApi extends BaseAPI {
     /**
-     * Apply a punishment to one or more targets. Player targets are linked via player_punishment; IP targets are linked via connection_punishment. The authenticated user is recorded as the issuer.
+     * Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
      * @summary Apply punishment
      * @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
      * @param {*} [options] Override http request option.
@@ -1403,7 +1467,7 @@ export declare class AdminPunishmentsApi extends BaseAPI {
      */
     applyPunishment(adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminApplyPunishmentResponse, any, {}>>;
     /**
-     * Preview the impact of a punishment across one or more targets. Returns current score, points to add, projected new score, and affected players per target. No changes are made.
+     * Preview the impact of a punishment across one or more targets. No changes are made.
      * @summary Evaluate punishment impact
      * @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
      * @param {*} [options] Override http request option.
@@ -1426,7 +1490,7 @@ export declare class AdminPunishmentsApi extends BaseAPI {
      */
     getPunishments(page: number, limit: number, uuid?: string | null, username?: string | null, ipAddress?: string | null, type?: Array<string> | null, issuedAfter?: number | null, issuedBefore?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminPagedPunishmentResponse, any, {}>>;
     /**
-     * Search for players by UUID or username, or look up all players associated with an IP address. Used to populate the target table before issuing a punishment.
+     * Search for players by UUID or username, or look up all players associated with an IP address.
      * @summary Search punishment targets
      * @param {string} q UUID, username, or partial/full IP address to search for
      * @param {*} [options] Override http request option.
@@ -1743,17 +1807,17 @@ export declare class ConnectionApi extends BaseAPI {
  */
 export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
+     * Retrieves player information by Minecraft UUID including first join status and login timestamp.
      * @summary Get player information
-     * @param {string} uuid The Minecraft player UUID (with or without dashes)
+     * @param {string} uuid
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPlayer1: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
+     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record are omitted from the response.
      * @summary Batch resolve UUIDs to usernames
-     * @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
+     * @param {Array<string>} uuids List of player UUIDs to resolve
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -1764,17 +1828,17 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
  */
 export declare const PlayerApiFp: (configuration?: Configuration) => {
     /**
-     * Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
+     * Retrieves player information by Minecraft UUID including first join status and login timestamp.
      * @summary Get player information
-     * @param {string} uuid The Minecraft player UUID (with or without dashes)
+     * @param {string} uuid
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPlayer1(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerGetPlayerInformation>>;
     /**
-     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
+     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record are omitted from the response.
      * @summary Batch resolve UUIDs to usernames
-     * @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
+     * @param {Array<string>} uuids List of player UUIDs to resolve
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -1785,17 +1849,17 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
  */
 export declare const PlayerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
+     * Retrieves player information by Minecraft UUID including first join status and login timestamp.
      * @summary Get player information
-     * @param {string} uuid The Minecraft player UUID (with or without dashes)
+     * @param {string} uuid
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPlayer1(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerGetPlayerInformation>;
     /**
-     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
+     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record are omitted from the response.
      * @summary Batch resolve UUIDs to usernames
-     * @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
+     * @param {Array<string>} uuids List of player UUIDs to resolve
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -1806,17 +1870,17 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
  */
 export declare class PlayerApi extends BaseAPI {
     /**
-     * Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
+     * Retrieves player information by Minecraft UUID including first join status and login timestamp.
      * @summary Get player information
-     * @param {string} uuid The Minecraft player UUID (with or without dashes)
+     * @param {string} uuid
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPlayer1(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerGetPlayerInformation, any, {}>>;
     /**
-     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
+     * Accepts a list of player UUIDs and returns a map of `uuid → username` for those that have a recorded username. UUIDs with no username record are omitted from the response.
      * @summary Batch resolve UUIDs to usernames
-     * @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
+     * @param {Array<string>} uuids List of player UUIDs to resolve
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */