@rebornteam/reborn-api 4.9.1 → 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.
- package/.openapi-generator/FILES +10 -0
- package/README.md +21 -2
- package/api.ts +884 -45
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +475 -1
- package/dist/api.js +615 -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 +475 -1
- package/dist/esm/api.js +615 -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/index.ts +1 -1
- package/package.json +1 -1
package/base.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.
|
|
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/common.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.
|
|
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/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Reborn API
|
|
4
4
|
* 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
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 4.9.
|
|
6
|
+
* The version of the OpenAPI document: 4.9.2
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/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.2
|
|
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;
|
|
@@ -2570,6 +2760,31 @@ export declare class AdminConnectionsApi extends BaseAPI {
|
|
|
2570
2760
|
* AdminDashboardApi - axios parameter creator
|
|
2571
2761
|
*/
|
|
2572
2762
|
export declare const AdminDashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2763
|
+
/**
|
|
2764
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
2765
|
+
* @summary Connection activity heatmap
|
|
2766
|
+
* @param {number} [days] Trailing window in days
|
|
2767
|
+
* @param {*} [options] Override http request option.
|
|
2768
|
+
* @throws {RequiredError}
|
|
2769
|
+
*/
|
|
2770
|
+
activityHeatmap: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2771
|
+
/**
|
|
2772
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
2773
|
+
* @summary Connections by country
|
|
2774
|
+
* @param {number} [days] Trailing window in days
|
|
2775
|
+
* @param {number} [limit] Max countries to return
|
|
2776
|
+
* @param {*} [options] Override http request option.
|
|
2777
|
+
* @throws {RequiredError}
|
|
2778
|
+
*/
|
|
2779
|
+
connectionsByCountry: (days?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2780
|
+
/**
|
|
2781
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
2782
|
+
* @summary Daily session activity
|
|
2783
|
+
* @param {number} [days] Trailing window in days
|
|
2784
|
+
* @param {*} [options] Override http request option.
|
|
2785
|
+
* @throws {RequiredError}
|
|
2786
|
+
*/
|
|
2787
|
+
dailySessions: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2573
2788
|
/**
|
|
2574
2789
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2575
2790
|
* @summary Get dashboard statistics
|
|
@@ -2577,11 +2792,82 @@ export declare const AdminDashboardApiAxiosParamCreator: (configuration?: Config
|
|
|
2577
2792
|
* @throws {RequiredError}
|
|
2578
2793
|
*/
|
|
2579
2794
|
dashboardStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2795
|
+
/**
|
|
2796
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
2797
|
+
* @summary Dashboard overview tiles
|
|
2798
|
+
* @param {*} [options] Override http request option.
|
|
2799
|
+
* @throws {RequiredError}
|
|
2800
|
+
*/
|
|
2801
|
+
overview: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2802
|
+
/**
|
|
2803
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
2804
|
+
* @summary Punishments by type over time
|
|
2805
|
+
* @param {number} [days] Trailing window in days
|
|
2806
|
+
* @param {*} [options] Override http request option.
|
|
2807
|
+
* @throws {RequiredError}
|
|
2808
|
+
*/
|
|
2809
|
+
punishmentsByType: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2810
|
+
/**
|
|
2811
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
2812
|
+
* @summary Report backlog & resolution speed
|
|
2813
|
+
* @param {number} [days] Trailing window in days
|
|
2814
|
+
* @param {*} [options] Override http request option.
|
|
2815
|
+
* @throws {RequiredError}
|
|
2816
|
+
*/
|
|
2817
|
+
reportSummary: (days?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2818
|
+
/**
|
|
2819
|
+
* Online server count and current player load per region/game-type.
|
|
2820
|
+
* @summary Servers & players by region
|
|
2821
|
+
* @param {*} [options] Override http request option.
|
|
2822
|
+
* @throws {RequiredError}
|
|
2823
|
+
*/
|
|
2824
|
+
serverRegions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2825
|
+
/**
|
|
2826
|
+
* Moderators ranked by audit-log action count over the window.
|
|
2827
|
+
* @summary Top moderators by activity
|
|
2828
|
+
* @param {number} [days] Trailing window in days
|
|
2829
|
+
* @param {number} [limit] Max moderators to return
|
|
2830
|
+
* @param {*} [options] Override http request option.
|
|
2831
|
+
* @throws {RequiredError}
|
|
2832
|
+
*/
|
|
2833
|
+
topModerators: (days?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2834
|
+
/**
|
|
2835
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
2836
|
+
* @summary Trust-factor distribution
|
|
2837
|
+
* @param {*} [options] Override http request option.
|
|
2838
|
+
* @throws {RequiredError}
|
|
2839
|
+
*/
|
|
2840
|
+
trustDistribution: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2580
2841
|
};
|
|
2581
2842
|
/**
|
|
2582
2843
|
* AdminDashboardApi - functional programming interface
|
|
2583
2844
|
*/
|
|
2584
2845
|
export declare const AdminDashboardApiFp: (configuration?: Configuration) => {
|
|
2846
|
+
/**
|
|
2847
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
2848
|
+
* @summary Connection activity heatmap
|
|
2849
|
+
* @param {number} [days] Trailing window in days
|
|
2850
|
+
* @param {*} [options] Override http request option.
|
|
2851
|
+
* @throws {RequiredError}
|
|
2852
|
+
*/
|
|
2853
|
+
activityHeatmap(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardActivityCell>>>;
|
|
2854
|
+
/**
|
|
2855
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
2856
|
+
* @summary Connections by country
|
|
2857
|
+
* @param {number} [days] Trailing window in days
|
|
2858
|
+
* @param {number} [limit] Max countries to return
|
|
2859
|
+
* @param {*} [options] Override http request option.
|
|
2860
|
+
* @throws {RequiredError}
|
|
2861
|
+
*/
|
|
2862
|
+
connectionsByCountry(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardCountryCount>>>;
|
|
2863
|
+
/**
|
|
2864
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
2865
|
+
* @summary Daily session activity
|
|
2866
|
+
* @param {number} [days] Trailing window in days
|
|
2867
|
+
* @param {*} [options] Override http request option.
|
|
2868
|
+
* @throws {RequiredError}
|
|
2869
|
+
*/
|
|
2870
|
+
dailySessions(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardDailySessions>>>;
|
|
2585
2871
|
/**
|
|
2586
2872
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2587
2873
|
* @summary Get dashboard statistics
|
|
@@ -2589,11 +2875,82 @@ export declare const AdminDashboardApiFp: (configuration?: Configuration) => {
|
|
|
2589
2875
|
* @throws {RequiredError}
|
|
2590
2876
|
*/
|
|
2591
2877
|
dashboardStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminGetDashboardStats>>;
|
|
2878
|
+
/**
|
|
2879
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
2880
|
+
* @summary Dashboard overview tiles
|
|
2881
|
+
* @param {*} [options] Override http request option.
|
|
2882
|
+
* @throws {RequiredError}
|
|
2883
|
+
*/
|
|
2884
|
+
overview(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminDashboardOverview>>;
|
|
2885
|
+
/**
|
|
2886
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
2887
|
+
* @summary Punishments by type over time
|
|
2888
|
+
* @param {number} [days] Trailing window in days
|
|
2889
|
+
* @param {*} [options] Override http request option.
|
|
2890
|
+
* @throws {RequiredError}
|
|
2891
|
+
*/
|
|
2892
|
+
punishmentsByType(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardPunishmentDaily>>>;
|
|
2893
|
+
/**
|
|
2894
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
2895
|
+
* @summary Report backlog & resolution speed
|
|
2896
|
+
* @param {number} [days] Trailing window in days
|
|
2897
|
+
* @param {*} [options] Override http request option.
|
|
2898
|
+
* @throws {RequiredError}
|
|
2899
|
+
*/
|
|
2900
|
+
reportSummary(days?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminDashboardReportSummary>>;
|
|
2901
|
+
/**
|
|
2902
|
+
* Online server count and current player load per region/game-type.
|
|
2903
|
+
* @summary Servers & players by region
|
|
2904
|
+
* @param {*} [options] Override http request option.
|
|
2905
|
+
* @throws {RequiredError}
|
|
2906
|
+
*/
|
|
2907
|
+
serverRegions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardServerRegion>>>;
|
|
2908
|
+
/**
|
|
2909
|
+
* Moderators ranked by audit-log action count over the window.
|
|
2910
|
+
* @summary Top moderators by activity
|
|
2911
|
+
* @param {number} [days] Trailing window in days
|
|
2912
|
+
* @param {number} [limit] Max moderators to return
|
|
2913
|
+
* @param {*} [options] Override http request option.
|
|
2914
|
+
* @throws {RequiredError}
|
|
2915
|
+
*/
|
|
2916
|
+
topModerators(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardModeratorActivity>>>;
|
|
2917
|
+
/**
|
|
2918
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
2919
|
+
* @summary Trust-factor distribution
|
|
2920
|
+
* @param {*} [options] Override http request option.
|
|
2921
|
+
* @throws {RequiredError}
|
|
2922
|
+
*/
|
|
2923
|
+
trustDistribution(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminDashboardTrustBucket>>>;
|
|
2592
2924
|
};
|
|
2593
2925
|
/**
|
|
2594
2926
|
* AdminDashboardApi - factory interface
|
|
2595
2927
|
*/
|
|
2596
2928
|
export declare const AdminDashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2929
|
+
/**
|
|
2930
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
2931
|
+
* @summary Connection activity heatmap
|
|
2932
|
+
* @param {number} [days] Trailing window in days
|
|
2933
|
+
* @param {*} [options] Override http request option.
|
|
2934
|
+
* @throws {RequiredError}
|
|
2935
|
+
*/
|
|
2936
|
+
activityHeatmap(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardActivityCell>>;
|
|
2937
|
+
/**
|
|
2938
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
2939
|
+
* @summary Connections by country
|
|
2940
|
+
* @param {number} [days] Trailing window in days
|
|
2941
|
+
* @param {number} [limit] Max countries to return
|
|
2942
|
+
* @param {*} [options] Override http request option.
|
|
2943
|
+
* @throws {RequiredError}
|
|
2944
|
+
*/
|
|
2945
|
+
connectionsByCountry(days?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardCountryCount>>;
|
|
2946
|
+
/**
|
|
2947
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
2948
|
+
* @summary Daily session activity
|
|
2949
|
+
* @param {number} [days] Trailing window in days
|
|
2950
|
+
* @param {*} [options] Override http request option.
|
|
2951
|
+
* @throws {RequiredError}
|
|
2952
|
+
*/
|
|
2953
|
+
dailySessions(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardDailySessions>>;
|
|
2597
2954
|
/**
|
|
2598
2955
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2599
2956
|
* @summary Get dashboard statistics
|
|
@@ -2601,11 +2958,82 @@ export declare const AdminDashboardApiFactory: (configuration?: Configuration, b
|
|
|
2601
2958
|
* @throws {RequiredError}
|
|
2602
2959
|
*/
|
|
2603
2960
|
dashboardStats(options?: RawAxiosRequestConfig): AxiosPromise<AdminGetDashboardStats>;
|
|
2961
|
+
/**
|
|
2962
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
2963
|
+
* @summary Dashboard overview tiles
|
|
2964
|
+
* @param {*} [options] Override http request option.
|
|
2965
|
+
* @throws {RequiredError}
|
|
2966
|
+
*/
|
|
2967
|
+
overview(options?: RawAxiosRequestConfig): AxiosPromise<AdminDashboardOverview>;
|
|
2968
|
+
/**
|
|
2969
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
2970
|
+
* @summary Punishments by type over time
|
|
2971
|
+
* @param {number} [days] Trailing window in days
|
|
2972
|
+
* @param {*} [options] Override http request option.
|
|
2973
|
+
* @throws {RequiredError}
|
|
2974
|
+
*/
|
|
2975
|
+
punishmentsByType(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardPunishmentDaily>>;
|
|
2976
|
+
/**
|
|
2977
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
2978
|
+
* @summary Report backlog & resolution speed
|
|
2979
|
+
* @param {number} [days] Trailing window in days
|
|
2980
|
+
* @param {*} [options] Override http request option.
|
|
2981
|
+
* @throws {RequiredError}
|
|
2982
|
+
*/
|
|
2983
|
+
reportSummary(days?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminDashboardReportSummary>;
|
|
2984
|
+
/**
|
|
2985
|
+
* Online server count and current player load per region/game-type.
|
|
2986
|
+
* @summary Servers & players by region
|
|
2987
|
+
* @param {*} [options] Override http request option.
|
|
2988
|
+
* @throws {RequiredError}
|
|
2989
|
+
*/
|
|
2990
|
+
serverRegions(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardServerRegion>>;
|
|
2991
|
+
/**
|
|
2992
|
+
* Moderators ranked by audit-log action count over the window.
|
|
2993
|
+
* @summary Top moderators by activity
|
|
2994
|
+
* @param {number} [days] Trailing window in days
|
|
2995
|
+
* @param {number} [limit] Max moderators to return
|
|
2996
|
+
* @param {*} [options] Override http request option.
|
|
2997
|
+
* @throws {RequiredError}
|
|
2998
|
+
*/
|
|
2999
|
+
topModerators(days?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardModeratorActivity>>;
|
|
3000
|
+
/**
|
|
3001
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
3002
|
+
* @summary Trust-factor distribution
|
|
3003
|
+
* @param {*} [options] Override http request option.
|
|
3004
|
+
* @throws {RequiredError}
|
|
3005
|
+
*/
|
|
3006
|
+
trustDistribution(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminDashboardTrustBucket>>;
|
|
2604
3007
|
};
|
|
2605
3008
|
/**
|
|
2606
3009
|
* AdminDashboardApi - object-oriented interface
|
|
2607
3010
|
*/
|
|
2608
3011
|
export declare class AdminDashboardApi extends BaseAPI {
|
|
3012
|
+
/**
|
|
3013
|
+
* Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
3014
|
+
* @summary Connection activity heatmap
|
|
3015
|
+
* @param {number} [days] Trailing window in days
|
|
3016
|
+
* @param {*} [options] Override http request option.
|
|
3017
|
+
* @throws {RequiredError}
|
|
3018
|
+
*/
|
|
3019
|
+
activityHeatmap(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardActivityCell[], any, {}>>;
|
|
3020
|
+
/**
|
|
3021
|
+
* Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
3022
|
+
* @summary Connections by country
|
|
3023
|
+
* @param {number} [days] Trailing window in days
|
|
3024
|
+
* @param {number} [limit] Max countries to return
|
|
3025
|
+
* @param {*} [options] Override http request option.
|
|
3026
|
+
* @throws {RequiredError}
|
|
3027
|
+
*/
|
|
3028
|
+
connectionsByCountry(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardCountryCount[], any, {}>>;
|
|
3029
|
+
/**
|
|
3030
|
+
* Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
3031
|
+
* @summary Daily session activity
|
|
3032
|
+
* @param {number} [days] Trailing window in days
|
|
3033
|
+
* @param {*} [options] Override http request option.
|
|
3034
|
+
* @throws {RequiredError}
|
|
3035
|
+
*/
|
|
3036
|
+
dailySessions(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardDailySessions[], any, {}>>;
|
|
2609
3037
|
/**
|
|
2610
3038
|
* Returns aggregate counts for clients, connections, and players in the system.
|
|
2611
3039
|
* @summary Get dashboard statistics
|
|
@@ -2613,6 +3041,52 @@ export declare class AdminDashboardApi extends BaseAPI {
|
|
|
2613
3041
|
* @throws {RequiredError}
|
|
2614
3042
|
*/
|
|
2615
3043
|
dashboardStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminGetDashboardStats, any, {}>>;
|
|
3044
|
+
/**
|
|
3045
|
+
* At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
3046
|
+
* @summary Dashboard overview tiles
|
|
3047
|
+
* @param {*} [options] Override http request option.
|
|
3048
|
+
* @throws {RequiredError}
|
|
3049
|
+
*/
|
|
3050
|
+
overview(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardOverview, any, {}>>;
|
|
3051
|
+
/**
|
|
3052
|
+
* Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
3053
|
+
* @summary Punishments by type over time
|
|
3054
|
+
* @param {number} [days] Trailing window in days
|
|
3055
|
+
* @param {*} [options] Override http request option.
|
|
3056
|
+
* @throws {RequiredError}
|
|
3057
|
+
*/
|
|
3058
|
+
punishmentsByType(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardPunishmentDaily[], any, {}>>;
|
|
3059
|
+
/**
|
|
3060
|
+
* Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
3061
|
+
* @summary Report backlog & resolution speed
|
|
3062
|
+
* @param {number} [days] Trailing window in days
|
|
3063
|
+
* @param {*} [options] Override http request option.
|
|
3064
|
+
* @throws {RequiredError}
|
|
3065
|
+
*/
|
|
3066
|
+
reportSummary(days?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardReportSummary, any, {}>>;
|
|
3067
|
+
/**
|
|
3068
|
+
* Online server count and current player load per region/game-type.
|
|
3069
|
+
* @summary Servers & players by region
|
|
3070
|
+
* @param {*} [options] Override http request option.
|
|
3071
|
+
* @throws {RequiredError}
|
|
3072
|
+
*/
|
|
3073
|
+
serverRegions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardServerRegion[], any, {}>>;
|
|
3074
|
+
/**
|
|
3075
|
+
* Moderators ranked by audit-log action count over the window.
|
|
3076
|
+
* @summary Top moderators by activity
|
|
3077
|
+
* @param {number} [days] Trailing window in days
|
|
3078
|
+
* @param {number} [limit] Max moderators to return
|
|
3079
|
+
* @param {*} [options] Override http request option.
|
|
3080
|
+
* @throws {RequiredError}
|
|
3081
|
+
*/
|
|
3082
|
+
topModerators(days?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardModeratorActivity[], any, {}>>;
|
|
3083
|
+
/**
|
|
3084
|
+
* Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
3085
|
+
* @summary Trust-factor distribution
|
|
3086
|
+
* @param {*} [options] Override http request option.
|
|
3087
|
+
* @throws {RequiredError}
|
|
3088
|
+
*/
|
|
3089
|
+
trustDistribution(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardTrustBucket[], any, {}>>;
|
|
2616
3090
|
}
|
|
2617
3091
|
/**
|
|
2618
3092
|
* AdminJobsApi - axios parameter creator
|