@rebornteam/reborn-api 4.9.1 → 4.9.3
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.
- package/.openapi-generator/FILES +11 -0
- package/README.md +23 -2
- package/api.ts +1104 -183
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +516 -1
- package/dist/api.js +684 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +516 -1
- package/dist/esm/api.js +684 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AdminDashboardActivityCell.md +25 -0
- package/docs/AdminDashboardApi.md +453 -0
- package/docs/AdminDashboardCategoryCount.md +23 -0
- package/docs/AdminDashboardCountryCount.md +25 -0
- package/docs/AdminDashboardDailySessions.md +27 -0
- package/docs/AdminDashboardModeratorActivity.md +23 -0
- package/docs/AdminDashboardOverview.md +35 -0
- package/docs/AdminDashboardPunishmentDaily.md +25 -0
- package/docs/AdminDashboardReportSummary.md +27 -0
- package/docs/AdminDashboardServerRegion.md +27 -0
- package/docs/AdminDashboardTrustBucket.md +23 -0
- package/docs/AuthenticationApi.md +53 -0
- package/docs/DiscordAuthUrlResponse.md +21 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* 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
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Reborn API
|
|
6
6
|
* 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
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 4.9.
|
|
8
|
+
* The version of the OpenAPI document: 4.9.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* 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
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Reborn API
|
|
6
6
|
* 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
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 4.9.
|
|
8
|
+
* The version of the OpenAPI document: 4.9.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* 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
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
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.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* 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
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -493,6 +493,36 @@ export interface AdminCreatePunishmentDraftRequest {
|
|
|
493
493
|
*/
|
|
494
494
|
'forcePermanent': boolean;
|
|
495
495
|
}
|
|
496
|
+
/**
|
|
497
|
+
* One cell of the activity heatmap: connection volume bucketed by UTC day-of-week (0 = Sunday) and hour-of-day (0--23).
|
|
498
|
+
*/
|
|
499
|
+
export interface AdminDashboardActivityCell {
|
|
500
|
+
/**
|
|
501
|
+
* UTC day of week, 0 = Sunday … 6 = Saturday
|
|
502
|
+
*/
|
|
503
|
+
'dayOfWeek': number;
|
|
504
|
+
/**
|
|
505
|
+
* UTC hour of day, 0–23
|
|
506
|
+
*/
|
|
507
|
+
'hourOfDay': number;
|
|
508
|
+
/**
|
|
509
|
+
* Connections in this bucket
|
|
510
|
+
*/
|
|
511
|
+
'count': number;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* Report count for one category over the window.
|
|
515
|
+
*/
|
|
516
|
+
export interface AdminDashboardCategoryCount {
|
|
517
|
+
/**
|
|
518
|
+
* Report category
|
|
519
|
+
*/
|
|
520
|
+
'category': string;
|
|
521
|
+
/**
|
|
522
|
+
* Reports filed in this category
|
|
523
|
+
*/
|
|
524
|
+
'count': number;
|
|
525
|
+
}
|
|
496
526
|
export interface AdminDashboardConnectionResponse {
|
|
497
527
|
'id': number;
|
|
498
528
|
'ipAddress': string;
|
|
@@ -516,6 +546,166 @@ export interface AdminDashboardConnectionResponse {
|
|
|
516
546
|
*/
|
|
517
547
|
'results': Array<AdminConnectionCheckResult>;
|
|
518
548
|
}
|
|
549
|
+
/**
|
|
550
|
+
* Connection volume for one country over the requested window.
|
|
551
|
+
*/
|
|
552
|
+
export interface AdminDashboardCountryCount {
|
|
553
|
+
/**
|
|
554
|
+
* ISO country code
|
|
555
|
+
*/
|
|
556
|
+
'country': string;
|
|
557
|
+
/**
|
|
558
|
+
* Distinct connections geolocated to this country
|
|
559
|
+
*/
|
|
560
|
+
'connections': number;
|
|
561
|
+
/**
|
|
562
|
+
* Of those, how many were flagged VPN/proxy
|
|
563
|
+
*/
|
|
564
|
+
'vpnConnections': number;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* One day of the session-activity timeseries (UTC day).
|
|
568
|
+
*/
|
|
569
|
+
export interface AdminDashboardDailySessions {
|
|
570
|
+
/**
|
|
571
|
+
* UTC day, YYYY-MM-DD
|
|
572
|
+
*/
|
|
573
|
+
'day': string;
|
|
574
|
+
/**
|
|
575
|
+
* Sessions started this day
|
|
576
|
+
*/
|
|
577
|
+
'sessionCount': number;
|
|
578
|
+
/**
|
|
579
|
+
* Distinct players active this day
|
|
580
|
+
*/
|
|
581
|
+
'activePlayers': number;
|
|
582
|
+
/**
|
|
583
|
+
* Mean completed-session length this day, seconds
|
|
584
|
+
*/
|
|
585
|
+
'avgDurationSeconds': number;
|
|
586
|
+
}
|
|
587
|
+
/**
|
|
588
|
+
* A moderator and their audit-log action count over the window.
|
|
589
|
+
*/
|
|
590
|
+
export interface AdminDashboardModeratorActivity {
|
|
591
|
+
/**
|
|
592
|
+
* Moderator username
|
|
593
|
+
*/
|
|
594
|
+
'actor': string;
|
|
595
|
+
/**
|
|
596
|
+
* Audit-log actions performed
|
|
597
|
+
*/
|
|
598
|
+
'actionCount': number;
|
|
599
|
+
}
|
|
600
|
+
/**
|
|
601
|
+
* \"At a glance\" dashboard tiles --- current pulse of the network plus rolling 7-day session averages. Session durations are in seconds.
|
|
602
|
+
*/
|
|
603
|
+
export interface AdminDashboardOverview {
|
|
604
|
+
/**
|
|
605
|
+
* Players with an open session right now
|
|
606
|
+
*/
|
|
607
|
+
'onlinePlayers': number;
|
|
608
|
+
/**
|
|
609
|
+
* Players whose first join was today (UTC)
|
|
610
|
+
*/
|
|
611
|
+
'newPlayersToday': number;
|
|
612
|
+
/**
|
|
613
|
+
* Distinct players seen today (UTC)
|
|
614
|
+
*/
|
|
615
|
+
'dauToday': number;
|
|
616
|
+
/**
|
|
617
|
+
* Mean completed-session length over the last 7 days, seconds
|
|
618
|
+
*/
|
|
619
|
+
'avgSessionSeconds': number;
|
|
620
|
+
/**
|
|
621
|
+
* Median completed-session length over the last 7 days, seconds
|
|
622
|
+
*/
|
|
623
|
+
'medianSessionSeconds': number;
|
|
624
|
+
/**
|
|
625
|
+
* Unexpired BAN punishments
|
|
626
|
+
*/
|
|
627
|
+
'activeBans': number;
|
|
628
|
+
/**
|
|
629
|
+
* Unexpired MUTE punishments
|
|
630
|
+
*/
|
|
631
|
+
'activeMutes': number;
|
|
632
|
+
/**
|
|
633
|
+
* Reports awaiting resolution
|
|
634
|
+
*/
|
|
635
|
+
'openReports': number;
|
|
636
|
+
}
|
|
637
|
+
/**
|
|
638
|
+
* Punishments issued on one UTC day for a single type (BAN/MUTE/KICK/WARNING).
|
|
639
|
+
*/
|
|
640
|
+
export interface AdminDashboardPunishmentDaily {
|
|
641
|
+
/**
|
|
642
|
+
* UTC day, YYYY-MM-DD
|
|
643
|
+
*/
|
|
644
|
+
'day': string;
|
|
645
|
+
/**
|
|
646
|
+
* Punishment type
|
|
647
|
+
*/
|
|
648
|
+
'type': string;
|
|
649
|
+
/**
|
|
650
|
+
* Issued this day of this type
|
|
651
|
+
*/
|
|
652
|
+
'count': number;
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* Report backlog, resolution speed, and category breakdown over the window.
|
|
656
|
+
*/
|
|
657
|
+
export interface AdminDashboardReportSummary {
|
|
658
|
+
/**
|
|
659
|
+
* Reports awaiting resolution (all time)
|
|
660
|
+
*/
|
|
661
|
+
'openReports': number;
|
|
662
|
+
/**
|
|
663
|
+
* Reports resolved within the window
|
|
664
|
+
*/
|
|
665
|
+
'resolvedReports': number;
|
|
666
|
+
/**
|
|
667
|
+
* Mean time-to-resolution within the window, seconds
|
|
668
|
+
*/
|
|
669
|
+
'avgResolutionSeconds': number;
|
|
670
|
+
/**
|
|
671
|
+
* Reports filed within the window, grouped by category
|
|
672
|
+
*/
|
|
673
|
+
'byCategory': Array<AdminDashboardCategoryCount>;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* Online server count and current player load for a region/game-type pair.
|
|
677
|
+
*/
|
|
678
|
+
export interface AdminDashboardServerRegion {
|
|
679
|
+
/**
|
|
680
|
+
* Server region
|
|
681
|
+
*/
|
|
682
|
+
'region': string;
|
|
683
|
+
/**
|
|
684
|
+
* Game type
|
|
685
|
+
*/
|
|
686
|
+
'gameType': string;
|
|
687
|
+
/**
|
|
688
|
+
* Online server instances
|
|
689
|
+
*/
|
|
690
|
+
'onlineServers': number;
|
|
691
|
+
/**
|
|
692
|
+
* Players currently in open sessions on those servers
|
|
693
|
+
*/
|
|
694
|
+
'players': number;
|
|
695
|
+
}
|
|
696
|
+
/**
|
|
697
|
+
* 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.
|
|
698
|
+
*/
|
|
699
|
+
export interface AdminDashboardTrustBucket {
|
|
700
|
+
/**
|
|
701
|
+
* Histogram bucket index, 0–9 (each spans 10 trust points)
|
|
702
|
+
*/
|
|
703
|
+
'bucket': number;
|
|
704
|
+
/**
|
|
705
|
+
* Players in this bucket
|
|
706
|
+
*/
|
|
707
|
+
'count': number;
|
|
708
|
+
}
|
|
519
709
|
export interface AdminGetDashboardStats {
|
|
520
710
|
'totalPlayers': number;
|
|
521
711
|
'totalConnections': number;
|
|
@@ -1291,6 +1481,15 @@ export interface CursoredPageable {
|
|
|
1291
1481
|
'sort': Sort;
|
|
1292
1482
|
'backward': boolean;
|
|
1293
1483
|
}
|
|
1484
|
+
/**
|
|
1485
|
+
* 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.
|
|
1486
|
+
*/
|
|
1487
|
+
export interface DiscordAuthUrlResponse {
|
|
1488
|
+
/**
|
|
1489
|
+
* Discord OAuth2 authorize URL to open on the client.
|
|
1490
|
+
*/
|
|
1491
|
+
'authorizeUrl': string;
|
|
1492
|
+
}
|
|
1294
1493
|
export declare const GameType: {
|
|
1295
1494
|
readonly Rotj: "ROTJ";
|
|
1296
1495
|
readonly Legacy: "LEGACY";
|
|
@@ -2570,6 +2769,31 @@ export declare class AdminConnectionsApi extends BaseAPI {
|
|
|
2570
2769
|
* AdminDashboardApi - axios parameter creator
|
|
2571
2770
|
*/
|
|
2572
2771
|
export declare const AdminDashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2772
|
+
/**
|
|
2773
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
2774
|
+
* @summary Connection activity heatmap
|
|
2775
|
+
* @param {number} [days] Trailing window in days
|
|
2776
|
+
* @param {*} [options] Override http request option.
|
|
2777
|
+
* @throws {RequiredError}
|
|
2778
|
+
*/
|
|
2779
|
+
activityHeatmap: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2780
|
+
/**
|
|
2781
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
2782
|
+
* @summary Connections by country
|
|
2783
|
+
* @param {number} [days] Trailing window in days
|
|
2784
|
+
* @param {number} [limit] Max countries to return
|
|
2785
|
+
* @param {*} [options] Override http request option.
|
|
2786
|
+
* @throws {RequiredError}
|
|
2787
|
+
*/
|
|
2788
|
+
connectionsByCountry: (days?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2789
|
+
/**
|
|
2790
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
2791
|
+
* @summary Daily session activity
|
|
2792
|
+
* @param {number} [days] Trailing window in days
|
|
2793
|
+
* @param {*} [options] Override http request option.
|
|
2794
|
+
* @throws {RequiredError}
|
|
2795
|
+
*/
|
|
2796
|
+
dailySessions: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2573
2797
|
/**
|
|
2574
2798
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2575
2799
|
* @summary Get dashboard statistics
|
|
@@ -2577,11 +2801,82 @@ export declare const AdminDashboardApiAxiosParamCreator: (configuration?: Config
|
|
|
2577
2801
|
* @throws {RequiredError}
|
|
2578
2802
|
*/
|
|
2579
2803
|
dashboardStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2804
|
+
/**
|
|
2805
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
2806
|
+
* @summary Dashboard overview tiles
|
|
2807
|
+
* @param {*} [options] Override http request option.
|
|
2808
|
+
* @throws {RequiredError}
|
|
2809
|
+
*/
|
|
2810
|
+
overview: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2811
|
+
/**
|
|
2812
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
2813
|
+
* @summary Punishments by type over time
|
|
2814
|
+
* @param {number} [days] Trailing window in days
|
|
2815
|
+
* @param {*} [options] Override http request option.
|
|
2816
|
+
* @throws {RequiredError}
|
|
2817
|
+
*/
|
|
2818
|
+
punishmentsByType: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2819
|
+
/**
|
|
2820
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
2821
|
+
* @summary Report backlog & resolution speed
|
|
2822
|
+
* @param {number} [days] Trailing window in days
|
|
2823
|
+
* @param {*} [options] Override http request option.
|
|
2824
|
+
* @throws {RequiredError}
|
|
2825
|
+
*/
|
|
2826
|
+
reportSummary: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2827
|
+
/**
|
|
2828
|
+
* Online server count and current player load per region/game-type.
|
|
2829
|
+
* @summary Servers & players by region
|
|
2830
|
+
* @param {*} [options] Override http request option.
|
|
2831
|
+
* @throws {RequiredError}
|
|
2832
|
+
*/
|
|
2833
|
+
serverRegions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2834
|
+
/**
|
|
2835
|
+
* Moderators ranked by audit-log action count over the window.
|
|
2836
|
+
* @summary Top moderators by activity
|
|
2837
|
+
* @param {number} [days] Trailing window in days
|
|
2838
|
+
* @param {number} [limit] Max moderators to return
|
|
2839
|
+
* @param {*} [options] Override http request option.
|
|
2840
|
+
* @throws {RequiredError}
|
|
2841
|
+
*/
|
|
2842
|
+
topModerators: (days?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2843
|
+
/**
|
|
2844
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
2845
|
+
* @summary Trust-factor distribution
|
|
2846
|
+
* @param {*} [options] Override http request option.
|
|
2847
|
+
* @throws {RequiredError}
|
|
2848
|
+
*/
|
|
2849
|
+
trustDistribution: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2580
2850
|
};
|
|
2581
2851
|
/**
|
|
2582
2852
|
* AdminDashboardApi - functional programming interface
|
|
2583
2853
|
*/
|
|
2584
2854
|
export declare const AdminDashboardApiFp: (configuration?: Configuration) => {
|
|
2855
|
+
/**
|
|
2856
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
2857
|
+
* @summary Connection activity heatmap
|
|
2858
|
+
* @param {number} [days] Trailing window in days
|
|
2859
|
+
* @param {*} [options] Override http request option.
|
|
2860
|
+
* @throws {RequiredError}
|
|
2861
|
+
*/
|
|
2862
|
+
activityHeatmap(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardActivityCell>>>;
|
|
2863
|
+
/**
|
|
2864
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
2865
|
+
* @summary Connections by country
|
|
2866
|
+
* @param {number} [days] Trailing window in days
|
|
2867
|
+
* @param {number} [limit] Max countries to return
|
|
2868
|
+
* @param {*} [options] Override http request option.
|
|
2869
|
+
* @throws {RequiredError}
|
|
2870
|
+
*/
|
|
2871
|
+
connectionsByCountry(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardCountryCount>>>;
|
|
2872
|
+
/**
|
|
2873
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
2874
|
+
* @summary Daily session activity
|
|
2875
|
+
* @param {number} [days] Trailing window in days
|
|
2876
|
+
* @param {*} [options] Override http request option.
|
|
2877
|
+
* @throws {RequiredError}
|
|
2878
|
+
*/
|
|
2879
|
+
dailySessions(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardDailySessions>>>;
|
|
2585
2880
|
/**
|
|
2586
2881
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2587
2882
|
* @summary Get dashboard statistics
|
|
@@ -2589,11 +2884,82 @@ export declare const AdminDashboardApiFp: (configuration?: Configuration) => {
|
|
|
2589
2884
|
* @throws {RequiredError}
|
|
2590
2885
|
*/
|
|
2591
2886
|
dashboardStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminGetDashboardStats>>;
|
|
2887
|
+
/**
|
|
2888
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
2889
|
+
* @summary Dashboard overview tiles
|
|
2890
|
+
* @param {*} [options] Override http request option.
|
|
2891
|
+
* @throws {RequiredError}
|
|
2892
|
+
*/
|
|
2893
|
+
overview(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminDashboardOverview>>;
|
|
2894
|
+
/**
|
|
2895
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
2896
|
+
* @summary Punishments by type over time
|
|
2897
|
+
* @param {number} [days] Trailing window in days
|
|
2898
|
+
* @param {*} [options] Override http request option.
|
|
2899
|
+
* @throws {RequiredError}
|
|
2900
|
+
*/
|
|
2901
|
+
punishmentsByType(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardPunishmentDaily>>>;
|
|
2902
|
+
/**
|
|
2903
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
2904
|
+
* @summary Report backlog & resolution speed
|
|
2905
|
+
* @param {number} [days] Trailing window in days
|
|
2906
|
+
* @param {*} [options] Override http request option.
|
|
2907
|
+
* @throws {RequiredError}
|
|
2908
|
+
*/
|
|
2909
|
+
reportSummary(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminDashboardReportSummary>>;
|
|
2910
|
+
/**
|
|
2911
|
+
* Online server count and current player load per region/game-type.
|
|
2912
|
+
* @summary Servers & players by region
|
|
2913
|
+
* @param {*} [options] Override http request option.
|
|
2914
|
+
* @throws {RequiredError}
|
|
2915
|
+
*/
|
|
2916
|
+
serverRegions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardServerRegion>>>;
|
|
2917
|
+
/**
|
|
2918
|
+
* Moderators ranked by audit-log action count over the window.
|
|
2919
|
+
* @summary Top moderators by activity
|
|
2920
|
+
* @param {number} [days] Trailing window in days
|
|
2921
|
+
* @param {number} [limit] Max moderators to return
|
|
2922
|
+
* @param {*} [options] Override http request option.
|
|
2923
|
+
* @throws {RequiredError}
|
|
2924
|
+
*/
|
|
2925
|
+
topModerators(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardModeratorActivity>>>;
|
|
2926
|
+
/**
|
|
2927
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
2928
|
+
* @summary Trust-factor distribution
|
|
2929
|
+
* @param {*} [options] Override http request option.
|
|
2930
|
+
* @throws {RequiredError}
|
|
2931
|
+
*/
|
|
2932
|
+
trustDistribution(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardTrustBucket>>>;
|
|
2592
2933
|
};
|
|
2593
2934
|
/**
|
|
2594
2935
|
* AdminDashboardApi - factory interface
|
|
2595
2936
|
*/
|
|
2596
2937
|
export declare const AdminDashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2938
|
+
/**
|
|
2939
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
2940
|
+
* @summary Connection activity heatmap
|
|
2941
|
+
* @param {number} [days] Trailing window in days
|
|
2942
|
+
* @param {*} [options] Override http request option.
|
|
2943
|
+
* @throws {RequiredError}
|
|
2944
|
+
*/
|
|
2945
|
+
activityHeatmap(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardActivityCell>>;
|
|
2946
|
+
/**
|
|
2947
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
2948
|
+
* @summary Connections by country
|
|
2949
|
+
* @param {number} [days] Trailing window in days
|
|
2950
|
+
* @param {number} [limit] Max countries to return
|
|
2951
|
+
* @param {*} [options] Override http request option.
|
|
2952
|
+
* @throws {RequiredError}
|
|
2953
|
+
*/
|
|
2954
|
+
connectionsByCountry(days?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardCountryCount>>;
|
|
2955
|
+
/**
|
|
2956
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
2957
|
+
* @summary Daily session activity
|
|
2958
|
+
* @param {number} [days] Trailing window in days
|
|
2959
|
+
* @param {*} [options] Override http request option.
|
|
2960
|
+
* @throws {RequiredError}
|
|
2961
|
+
*/
|
|
2962
|
+
dailySessions(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardDailySessions>>;
|
|
2597
2963
|
/**
|
|
2598
2964
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2599
2965
|
* @summary Get dashboard statistics
|
|
@@ -2601,11 +2967,82 @@ export declare const AdminDashboardApiFactory: (configuration?: Configuration, b
|
|
|
2601
2967
|
* @throws {RequiredError}
|
|
2602
2968
|
*/
|
|
2603
2969
|
dashboardStats(options?: RawAxiosRequestConfig): AxiosPromise<AdminGetDashboardStats>;
|
|
2970
|
+
/**
|
|
2971
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
2972
|
+
* @summary Dashboard overview tiles
|
|
2973
|
+
* @param {*} [options] Override http request option.
|
|
2974
|
+
* @throws {RequiredError}
|
|
2975
|
+
*/
|
|
2976
|
+
overview(options?: RawAxiosRequestConfig): AxiosPromise<AdminDashboardOverview>;
|
|
2977
|
+
/**
|
|
2978
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
2979
|
+
* @summary Punishments by type over time
|
|
2980
|
+
* @param {number} [days] Trailing window in days
|
|
2981
|
+
* @param {*} [options] Override http request option.
|
|
2982
|
+
* @throws {RequiredError}
|
|
2983
|
+
*/
|
|
2984
|
+
punishmentsByType(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardPunishmentDaily>>;
|
|
2985
|
+
/**
|
|
2986
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
2987
|
+
* @summary Report backlog & resolution speed
|
|
2988
|
+
* @param {number} [days] Trailing window in days
|
|
2989
|
+
* @param {*} [options] Override http request option.
|
|
2990
|
+
* @throws {RequiredError}
|
|
2991
|
+
*/
|
|
2992
|
+
reportSummary(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminDashboardReportSummary>;
|
|
2993
|
+
/**
|
|
2994
|
+
* Online server count and current player load per region/game-type.
|
|
2995
|
+
* @summary Servers & players by region
|
|
2996
|
+
* @param {*} [options] Override http request option.
|
|
2997
|
+
* @throws {RequiredError}
|
|
2998
|
+
*/
|
|
2999
|
+
serverRegions(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardServerRegion>>;
|
|
3000
|
+
/**
|
|
3001
|
+
* Moderators ranked by audit-log action count over the window.
|
|
3002
|
+
* @summary Top moderators by activity
|
|
3003
|
+
* @param {number} [days] Trailing window in days
|
|
3004
|
+
* @param {number} [limit] Max moderators to return
|
|
3005
|
+
* @param {*} [options] Override http request option.
|
|
3006
|
+
* @throws {RequiredError}
|
|
3007
|
+
*/
|
|
3008
|
+
topModerators(days?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardModeratorActivity>>;
|
|
3009
|
+
/**
|
|
3010
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
3011
|
+
* @summary Trust-factor distribution
|
|
3012
|
+
* @param {*} [options] Override http request option.
|
|
3013
|
+
* @throws {RequiredError}
|
|
3014
|
+
*/
|
|
3015
|
+
trustDistribution(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardTrustBucket>>;
|
|
2604
3016
|
};
|
|
2605
3017
|
/**
|
|
2606
3018
|
* AdminDashboardApi - object-oriented interface
|
|
2607
3019
|
*/
|
|
2608
3020
|
export declare class AdminDashboardApi extends BaseAPI {
|
|
3021
|
+
/**
|
|
3022
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
3023
|
+
* @summary Connection activity heatmap
|
|
3024
|
+
* @param {number} [days] Trailing window in days
|
|
3025
|
+
* @param {*} [options] Override http request option.
|
|
3026
|
+
* @throws {RequiredError}
|
|
3027
|
+
*/
|
|
3028
|
+
activityHeatmap(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardActivityCell[], any, {}>>;
|
|
3029
|
+
/**
|
|
3030
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
3031
|
+
* @summary Connections by country
|
|
3032
|
+
* @param {number} [days] Trailing window in days
|
|
3033
|
+
* @param {number} [limit] Max countries to return
|
|
3034
|
+
* @param {*} [options] Override http request option.
|
|
3035
|
+
* @throws {RequiredError}
|
|
3036
|
+
*/
|
|
3037
|
+
connectionsByCountry(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardCountryCount[], any, {}>>;
|
|
3038
|
+
/**
|
|
3039
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
3040
|
+
* @summary Daily session activity
|
|
3041
|
+
* @param {number} [days] Trailing window in days
|
|
3042
|
+
* @param {*} [options] Override http request option.
|
|
3043
|
+
* @throws {RequiredError}
|
|
3044
|
+
*/
|
|
3045
|
+
dailySessions(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardDailySessions[], any, {}>>;
|
|
2609
3046
|
/**
|
|
2610
3047
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2611
3048
|
* @summary Get dashboard statistics
|
|
@@ -2613,6 +3050,52 @@ export declare class AdminDashboardApi extends BaseAPI {
|
|
|
2613
3050
|
* @throws {RequiredError}
|
|
2614
3051
|
*/
|
|
2615
3052
|
dashboardStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminGetDashboardStats, any, {}>>;
|
|
3053
|
+
/**
|
|
3054
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
3055
|
+
* @summary Dashboard overview tiles
|
|
3056
|
+
* @param {*} [options] Override http request option.
|
|
3057
|
+
* @throws {RequiredError}
|
|
3058
|
+
*/
|
|
3059
|
+
overview(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardOverview, any, {}>>;
|
|
3060
|
+
/**
|
|
3061
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
3062
|
+
* @summary Punishments by type over time
|
|
3063
|
+
* @param {number} [days] Trailing window in days
|
|
3064
|
+
* @param {*} [options] Override http request option.
|
|
3065
|
+
* @throws {RequiredError}
|
|
3066
|
+
*/
|
|
3067
|
+
punishmentsByType(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardPunishmentDaily[], any, {}>>;
|
|
3068
|
+
/**
|
|
3069
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
3070
|
+
* @summary Report backlog & resolution speed
|
|
3071
|
+
* @param {number} [days] Trailing window in days
|
|
3072
|
+
* @param {*} [options] Override http request option.
|
|
3073
|
+
* @throws {RequiredError}
|
|
3074
|
+
*/
|
|
3075
|
+
reportSummary(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardReportSummary, any, {}>>;
|
|
3076
|
+
/**
|
|
3077
|
+
* Online server count and current player load per region/game-type.
|
|
3078
|
+
* @summary Servers & players by region
|
|
3079
|
+
* @param {*} [options] Override http request option.
|
|
3080
|
+
* @throws {RequiredError}
|
|
3081
|
+
*/
|
|
3082
|
+
serverRegions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardServerRegion[], any, {}>>;
|
|
3083
|
+
/**
|
|
3084
|
+
* Moderators ranked by audit-log action count over the window.
|
|
3085
|
+
* @summary Top moderators by activity
|
|
3086
|
+
* @param {number} [days] Trailing window in days
|
|
3087
|
+
* @param {number} [limit] Max moderators to return
|
|
3088
|
+
* @param {*} [options] Override http request option.
|
|
3089
|
+
* @throws {RequiredError}
|
|
3090
|
+
*/
|
|
3091
|
+
topModerators(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardModeratorActivity[], any, {}>>;
|
|
3092
|
+
/**
|
|
3093
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
3094
|
+
* @summary Trust-factor distribution
|
|
3095
|
+
* @param {*} [options] Override http request option.
|
|
3096
|
+
* @throws {RequiredError}
|
|
3097
|
+
*/
|
|
3098
|
+
trustDistribution(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardTrustBucket[], any, {}>>;
|
|
2616
3099
|
}
|
|
2617
3100
|
/**
|
|
2618
3101
|
* AdminJobsApi - axios parameter creator
|
|
@@ -3878,6 +4361,14 @@ export declare class AdminReportsApi extends BaseAPI {
|
|
|
3878
4361
|
* AuthenticationApi - axios parameter creator
|
|
3879
4362
|
*/
|
|
3880
4363
|
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4364
|
+
/**
|
|
4365
|
+
* 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.
|
|
4366
|
+
* @summary Discord - Authorize URL (native clients)
|
|
4367
|
+
* @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
|
|
4368
|
+
* @param {*} [options] Override http request option.
|
|
4369
|
+
* @throws {RequiredError}
|
|
4370
|
+
*/
|
|
4371
|
+
authorizeUrl: (redirect?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3881
4372
|
/**
|
|
3882
4373
|
* 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.
|
|
3883
4374
|
* @summary Discord - OAuth2 callback
|
|
@@ -3918,6 +4409,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
3918
4409
|
* AuthenticationApi - functional programming interface
|
|
3919
4410
|
*/
|
|
3920
4411
|
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
4412
|
+
/**
|
|
4413
|
+
* 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.
|
|
4414
|
+
* @summary Discord - Authorize URL (native clients)
|
|
4415
|
+
* @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
|
|
4416
|
+
* @param {*} [options] Override http request option.
|
|
4417
|
+
* @throws {RequiredError}
|
|
4418
|
+
*/
|
|
4419
|
+
authorizeUrl(redirect?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DiscordAuthUrlResponse>>;
|
|
3921
4420
|
/**
|
|
3922
4421
|
* 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.
|
|
3923
4422
|
* @summary Discord - OAuth2 callback
|
|
@@ -3958,6 +4457,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
3958
4457
|
* AuthenticationApi - factory interface
|
|
3959
4458
|
*/
|
|
3960
4459
|
export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4460
|
+
/**
|
|
4461
|
+
* 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.
|
|
4462
|
+
* @summary Discord - Authorize URL (native clients)
|
|
4463
|
+
* @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
|
|
4464
|
+
* @param {*} [options] Override http request option.
|
|
4465
|
+
* @throws {RequiredError}
|
|
4466
|
+
*/
|
|
4467
|
+
authorizeUrl(redirect?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DiscordAuthUrlResponse>;
|
|
3961
4468
|
/**
|
|
3962
4469
|
* 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.
|
|
3963
4470
|
* @summary Discord - OAuth2 callback
|
|
@@ -3998,6 +4505,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
3998
4505
|
* AuthenticationApi - object-oriented interface
|
|
3999
4506
|
*/
|
|
4000
4507
|
export declare class AuthenticationApi extends BaseAPI {
|
|
4508
|
+
/**
|
|
4509
|
+
* 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.
|
|
4510
|
+
* @summary Discord - Authorize URL (native clients)
|
|
4511
|
+
* @param {string | null} [redirect] Final redirect target for the JWT (native deep link). Must be allowlisted.
|
|
4512
|
+
* @param {*} [options] Override http request option.
|
|
4513
|
+
* @throws {RequiredError}
|
|
4514
|
+
*/
|
|
4515
|
+
authorizeUrl(redirect?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DiscordAuthUrlResponse, any, {}>>;
|
|
4001
4516
|
/**
|
|
4002
4517
|
* 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.
|
|
4003
4518
|
* @summary Discord - OAuth2 callback
|