@rebornteam/reborn-api 4.9.0 → 4.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,35 @@
1
+ # AdminDashboardOverview
2
+
3
+ \"At a glance\" dashboard tiles --- current pulse of the network plus rolling 7-day session averages. Session durations are in seconds.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **onlinePlayers** | **number** | Players with an open session right now | [default to undefined]
10
+ **newPlayersToday** | **number** | Players whose first join was today (UTC) | [default to undefined]
11
+ **dauToday** | **number** | Distinct players seen today (UTC) | [default to undefined]
12
+ **avgSessionSeconds** | **number** | Mean completed-session length over the last 7 days, seconds | [default to undefined]
13
+ **medianSessionSeconds** | **number** | Median completed-session length over the last 7 days, seconds | [default to undefined]
14
+ **activeBans** | **number** | Unexpired BAN punishments | [default to undefined]
15
+ **activeMutes** | **number** | Unexpired MUTE punishments | [default to undefined]
16
+ **openReports** | **number** | Reports awaiting resolution | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { AdminDashboardOverview } from '@rebornteam/reborn-api';
22
+
23
+ const instance: AdminDashboardOverview = {
24
+ onlinePlayers,
25
+ newPlayersToday,
26
+ dauToday,
27
+ avgSessionSeconds,
28
+ medianSessionSeconds,
29
+ activeBans,
30
+ activeMutes,
31
+ openReports,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # AdminDashboardPunishmentDaily
2
+
3
+ Punishments issued on one UTC day for a single type (BAN/MUTE/KICK/WARNING).
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **day** | **string** | UTC day, YYYY-MM-DD | [default to undefined]
10
+ **type** | **string** | Punishment type | [default to undefined]
11
+ **count** | **number** | Issued this day of this type | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AdminDashboardPunishmentDaily } from '@rebornteam/reborn-api';
17
+
18
+ const instance: AdminDashboardPunishmentDaily = {
19
+ day,
20
+ type,
21
+ count,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # AdminDashboardReportSummary
2
+
3
+ Report backlog, resolution speed, and category breakdown over the window.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **openReports** | **number** | Reports awaiting resolution (all time) | [default to undefined]
10
+ **resolvedReports** | **number** | Reports resolved within the window | [default to undefined]
11
+ **avgResolutionSeconds** | **number** | Mean time-to-resolution within the window, seconds | [default to undefined]
12
+ **byCategory** | [**Array<AdminDashboardCategoryCount>**](AdminDashboardCategoryCount.md) | Reports filed within the window, grouped by category | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { AdminDashboardReportSummary } from '@rebornteam/reborn-api';
18
+
19
+ const instance: AdminDashboardReportSummary = {
20
+ openReports,
21
+ resolvedReports,
22
+ avgResolutionSeconds,
23
+ byCategory,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # AdminDashboardServerRegion
2
+
3
+ Online server count and current player load for a region/game-type pair.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **region** | **string** | Server region | [default to undefined]
10
+ **gameType** | **string** | Game type | [default to undefined]
11
+ **onlineServers** | **number** | Online server instances | [default to undefined]
12
+ **players** | **number** | Players currently in open sessions on those servers | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { AdminDashboardServerRegion } from '@rebornteam/reborn-api';
18
+
19
+ const instance: AdminDashboardServerRegion = {
20
+ region,
21
+ gameType,
22
+ onlineServers,
23
+ players,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # AdminDashboardTrustBucket
2
+
3
+ One bar of the trust-factor distribution histogram. Bucket 0 = scores 0--9, bucket 9 = scores 90--100; count is players whose latest snapshot falls in it.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **bucket** | **number** | Histogram bucket index, 0–9 (each spans 10 trust points) | [default to undefined]
10
+ **count** | **number** | Players in this bucket | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AdminDashboardTrustBucket } from '@rebornteam/reborn-api';
16
+
17
+ const instance: AdminDashboardTrustBucket = {
18
+ bucket,
19
+ count,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -27,10 +27,12 @@ const apiInstance = new AuthenticationApi(configuration);
27
27
 
28
28
  let code: string; //Authorization code provided by Discord on successful approval (optional) (default to undefined)
29
29
  let error: string; //Error code provided by Discord if the user denied access (optional) (default to undefined)
30
+ let state: string; //Opaque value echoed back by Discord — carries the client\'s chosen redirect target (optional) (default to undefined)
30
31
 
31
32
  const { status, data } = await apiInstance.callback(
32
33
  code,
33
- error
34
+ error,
35
+ state
34
36
  );
35
37
  ```
36
38
 
@@ -40,6 +42,7 @@ const { status, data } = await apiInstance.callback(
40
42
  |------------- | ------------- | ------------- | -------------|
41
43
  | **code** | [**string**] | Authorization code provided by Discord on successful approval | (optional) defaults to undefined|
42
44
  | **error** | [**string**] | Error code provided by Discord if the user denied access | (optional) defaults to undefined|
45
+ | **state** | [**string**] | Opaque value echoed back by Discord — carries the client\'s chosen redirect target | (optional) defaults to undefined|
43
46
 
44
47
 
45
48
  ### Return type
@@ -66,7 +69,7 @@ void (empty response body)
66
69
  # **initiateLogin**
67
70
  > initiateLogin()
68
71
 
69
- Redirects the browser to Discord\'s OAuth2 authorization page. Not called directly the admin frontend navigates to this URL to begin the login flow.
72
+ Redirects the browser (or native in-app browser session) to Discord\'s OAuth2 authorization page. The optional `redirect` parameter names the final destination the signed JWT should be sent to once auth completes — the web app URL (default) or a native deep-link scheme such as `reborn://auth/callback`. It must be allowlisted (DISCORD_ADMIN_FRONTEND_URL or one of DISCORD_ADMIN_ALLOWED_REDIRECTS); the value is carried through Discord via the OAuth `state` parameter and re-validated on the callback.
70
73
 
71
74
  ### Example
72
75
 
@@ -79,11 +82,18 @@ import {
79
82
  const configuration = new Configuration();
80
83
  const apiInstance = new AuthenticationApi(configuration);
81
84
 
82
- const { status, data } = await apiInstance.initiateLogin();
85
+ let redirect: string; //Final redirect target for the JWT (web URL or native deep link). Must be allowlisted. Defaults to the web admin frontend. (optional) (default to undefined)
86
+
87
+ const { status, data } = await apiInstance.initiateLogin(
88
+ redirect
89
+ );
83
90
  ```
84
91
 
85
92
  ### Parameters
86
- This endpoint does not have any parameters.
93
+
94
+ |Name | Type | Description | Notes|
95
+ |------------- | ------------- | ------------- | -------------|
96
+ | **redirect** | [**string**] | Final redirect target for the JWT (web URL or native deep link). Must be allowlisted. Defaults to the web admin frontend. | (optional) defaults to undefined|
87
97
 
88
98
 
89
99
  ### Return type
@@ -104,6 +114,7 @@ void (empty response body)
104
114
  | Status code | Description | Response headers |
105
115
  |-------------|-------------|------------------|
106
116
  |**302** | Redirect to Discord authorization URL | - |
117
+ |**400** | The requested `redirect` is not allowlisted | - |
107
118
 
108
119
  [[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)
109
120
 
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Reborn API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 4.9.0
7
+ * The version of the OpenAPI document: 4.9.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rebornteam/reborn-api",
3
- "version": "4.9.0",
3
+ "version": "4.9.2",
4
4
  "description": "OpenAPI client for @rebornteam/reborn-api",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {