@rebornteam/reborn-api 2.8.0 → 3.0.1
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 +3 -0
- package/README.md +7 -2
- package/api.ts +233 -41
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +147 -41
- package/dist/api.js +173 -30
- 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 +147 -41
- package/dist/esm/api.js +172 -29
- 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/AdminConnectionCheckResult.md +25 -0
- package/docs/AdminConnectionsApi.md +62 -3
- package/docs/AdminDashboardApi.md +1 -1
- package/docs/AdminDashboardConnectionResponse.md +2 -0
- package/docs/AdminPlayersApi.md +2 -2
- package/docs/AdminPunishmentsApi.md +7 -7
- package/docs/AuthenticationApi.md +46 -0
- package/docs/ConnectionGetConnectionDetailsResponse.md +9 -7
- package/docs/PlayerApi.md +7 -8
- package/docs/PlayerGetPlayerInformation.md +4 -4
- package/docs/Rank.md +12 -0
- package/docs/UserProfileResponse.md +30 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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:
|
|
5
|
+
* The version of the OpenAPI document: 3.0.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -152,6 +152,23 @@ export interface AdminConnectionBypassResponse {
|
|
|
152
152
|
*/
|
|
153
153
|
'createdAt'?: string;
|
|
154
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* Result from a single VPN detection service for a given IP address
|
|
157
|
+
*/
|
|
158
|
+
export interface AdminConnectionCheckResult {
|
|
159
|
+
/**
|
|
160
|
+
* Service identifier
|
|
161
|
+
*/
|
|
162
|
+
'service'?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Whether this service flagged the IP as a VPN, proxy, or Tor exit node
|
|
165
|
+
*/
|
|
166
|
+
'result'?: boolean;
|
|
167
|
+
/**
|
|
168
|
+
* When this check was last performed
|
|
169
|
+
*/
|
|
170
|
+
'checkedAt'?: string;
|
|
171
|
+
}
|
|
155
172
|
/**
|
|
156
173
|
* Request to evaluate the impact of a punishment across one or more targets before applying
|
|
157
174
|
*/
|
|
@@ -198,6 +215,10 @@ export interface AdminDashboardConnectionResponse {
|
|
|
198
215
|
'lastSeen'?: string | null;
|
|
199
216
|
'percentPositive': number;
|
|
200
217
|
'numberOfChecks': number;
|
|
218
|
+
/**
|
|
219
|
+
* Results from each VPN detection service for this IP address
|
|
220
|
+
*/
|
|
221
|
+
'results'?: Array<AdminConnectionCheckResult>;
|
|
201
222
|
}
|
|
202
223
|
export interface AdminGetDashboardStats {
|
|
203
224
|
'totalPlayers': number;
|
|
@@ -539,24 +560,31 @@ export interface ConnectionGetConnectionDetailsResponse {
|
|
|
539
560
|
*/
|
|
540
561
|
'ipAddress'?: string;
|
|
541
562
|
/**
|
|
542
|
-
* Approximate geographic location of the IP address
|
|
563
|
+
* Approximate geographic location of the IP address. Returns \'Local, N/A\' for localhost or private IPs.
|
|
543
564
|
*/
|
|
544
565
|
'approximateLocation'?: string;
|
|
545
566
|
/**
|
|
546
|
-
* 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).
|
|
567
|
+
* 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).
|
|
547
568
|
*/
|
|
548
569
|
'percentPositive'?: number;
|
|
549
570
|
/**
|
|
550
|
-
* Total number of VPN detection services successfully queried during the last check.
|
|
571
|
+
* Total number of VPN detection services successfully queried during the last check.
|
|
551
572
|
*/
|
|
552
573
|
'numberOfChecks'?: number;
|
|
553
|
-
'bypassed'?: boolean;
|
|
554
574
|
/**
|
|
555
|
-
*
|
|
575
|
+
* Indicates if this IP address has been administratively bypassed.
|
|
576
|
+
*/
|
|
577
|
+
'isBypassed'?: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Expiration timestamp for the bypass (ISO-8601 format). Null if not bypassed or bypass is permanent.
|
|
556
580
|
*/
|
|
557
581
|
'bypassedUntil'?: string | null;
|
|
558
582
|
/**
|
|
559
|
-
*
|
|
583
|
+
* Results from each VPN detection service that checked this IP address
|
|
584
|
+
*/
|
|
585
|
+
'results'?: Array<AdminConnectionCheckResult>;
|
|
586
|
+
/**
|
|
587
|
+
* Player information associated with this connection. Only populated when \'associate_uuid\' query parameter is provided.
|
|
560
588
|
*/
|
|
561
589
|
'playerInformation'?: PlayerGetPlayerInformation | null;
|
|
562
590
|
/**
|
|
@@ -582,19 +610,19 @@ export interface CreateBypassRequest {
|
|
|
582
610
|
*/
|
|
583
611
|
export interface PlayerGetPlayerInformation {
|
|
584
612
|
/**
|
|
585
|
-
*
|
|
613
|
+
* Indicates whether this is the player\'s first time joining the server.
|
|
586
614
|
*/
|
|
587
|
-
'
|
|
615
|
+
'firstJoin'?: boolean;
|
|
588
616
|
/**
|
|
589
|
-
*
|
|
617
|
+
* Timestamp of when the player first connected to the server (ISO-8601 format).
|
|
590
618
|
*/
|
|
591
|
-
'
|
|
619
|
+
'firstLogin'?: string;
|
|
592
620
|
/**
|
|
593
|
-
* Raw punishment score calculated as: SUM((base_weight × severity/10))
|
|
621
|
+
* Raw punishment score calculated as: SUM((base_weight × severity/10)). Used for tracking overall punishment severity.
|
|
594
622
|
*/
|
|
595
623
|
'punishmentPointsRaw'?: number;
|
|
596
624
|
/**
|
|
597
|
-
* Punishment score as a percentage (0-100). When
|
|
625
|
+
* Punishment score as a percentage (0-100). When >100% before applying a new punishment, the new punishment should be made permanent.
|
|
598
626
|
*/
|
|
599
627
|
'punishmentPointsPercent'?: number;
|
|
600
628
|
}
|
|
@@ -670,6 +698,12 @@ export interface PunishmentSeveritiesResponseSeverityInfo {
|
|
|
670
698
|
*/
|
|
671
699
|
'durationSeconds'?: number;
|
|
672
700
|
}
|
|
701
|
+
export declare const Rank: {
|
|
702
|
+
readonly Administrator: "ADMINISTRATOR";
|
|
703
|
+
readonly Moderator: "MODERATOR";
|
|
704
|
+
readonly Service: "SERVICE";
|
|
705
|
+
};
|
|
706
|
+
export type Rank = typeof Rank[keyof typeof Rank];
|
|
673
707
|
export interface ServerRegisterRequest {
|
|
674
708
|
'region': string;
|
|
675
709
|
'gameType': string;
|
|
@@ -704,6 +738,14 @@ export interface UpdateClientRequest {
|
|
|
704
738
|
*/
|
|
705
739
|
'description'?: string;
|
|
706
740
|
}
|
|
741
|
+
export interface UserProfileResponse {
|
|
742
|
+
'id': string;
|
|
743
|
+
'username': string;
|
|
744
|
+
'avatarUrl': string;
|
|
745
|
+
'rank': Rank;
|
|
746
|
+
'roles': Array<string>;
|
|
747
|
+
'discordRoles': Array<string>;
|
|
748
|
+
}
|
|
707
749
|
/**
|
|
708
750
|
* AdminClientCredentialsApi - axios parameter creator
|
|
709
751
|
*/
|
|
@@ -986,6 +1028,15 @@ export declare const AdminConnectionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
986
1028
|
* @throws {RequiredError}
|
|
987
1029
|
*/
|
|
988
1030
|
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>;
|
|
1031
|
+
/**
|
|
1032
|
+
* 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.
|
|
1033
|
+
* @summary Refresh a single VPN check
|
|
1034
|
+
* @param {number} connectionId
|
|
1035
|
+
* @param {string} service
|
|
1036
|
+
* @param {*} [options] Override http request option.
|
|
1037
|
+
* @throws {RequiredError}
|
|
1038
|
+
*/
|
|
1039
|
+
recheckService: (connectionId: number, service: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
989
1040
|
};
|
|
990
1041
|
/**
|
|
991
1042
|
* AdminConnectionsApi - functional programming interface
|
|
@@ -1025,6 +1076,15 @@ export declare const AdminConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
1025
1076
|
* @throws {RequiredError}
|
|
1026
1077
|
*/
|
|
1027
1078
|
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>>>;
|
|
1079
|
+
/**
|
|
1080
|
+
* 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.
|
|
1081
|
+
* @summary Refresh a single VPN check
|
|
1082
|
+
* @param {number} connectionId
|
|
1083
|
+
* @param {string} service
|
|
1084
|
+
* @param {*} [options] Override http request option.
|
|
1085
|
+
* @throws {RequiredError}
|
|
1086
|
+
*/
|
|
1087
|
+
recheckService(connectionId: number, service: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminConnectionCheckResult>>;
|
|
1028
1088
|
};
|
|
1029
1089
|
/**
|
|
1030
1090
|
* AdminConnectionsApi - factory interface
|
|
@@ -1064,6 +1124,15 @@ export declare const AdminConnectionsApiFactory: (configuration?: Configuration,
|
|
|
1064
1124
|
* @throws {RequiredError}
|
|
1065
1125
|
*/
|
|
1066
1126
|
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>>;
|
|
1127
|
+
/**
|
|
1128
|
+
* 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.
|
|
1129
|
+
* @summary Refresh a single VPN check
|
|
1130
|
+
* @param {number} connectionId
|
|
1131
|
+
* @param {string} service
|
|
1132
|
+
* @param {*} [options] Override http request option.
|
|
1133
|
+
* @throws {RequiredError}
|
|
1134
|
+
*/
|
|
1135
|
+
recheckService(connectionId: number, service: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminConnectionCheckResult>;
|
|
1067
1136
|
};
|
|
1068
1137
|
/**
|
|
1069
1138
|
* AdminConnectionsApi - object-oriented interface
|
|
@@ -1103,6 +1172,15 @@ export declare class AdminConnectionsApi extends BaseAPI {
|
|
|
1103
1172
|
* @throws {RequiredError}
|
|
1104
1173
|
*/
|
|
1105
1174
|
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, {}>>;
|
|
1175
|
+
/**
|
|
1176
|
+
* 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.
|
|
1177
|
+
* @summary Refresh a single VPN check
|
|
1178
|
+
* @param {number} connectionId
|
|
1179
|
+
* @param {string} service
|
|
1180
|
+
* @param {*} [options] Override http request option.
|
|
1181
|
+
* @throws {RequiredError}
|
|
1182
|
+
*/
|
|
1183
|
+
recheckService(connectionId: number, service: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminConnectionCheckResult, any, {}>>;
|
|
1106
1184
|
}
|
|
1107
1185
|
/**
|
|
1108
1186
|
* AdminDashboardApi - axios parameter creator
|
|
@@ -1249,7 +1327,7 @@ export declare class AdminPlayersApi extends BaseAPI {
|
|
|
1249
1327
|
*/
|
|
1250
1328
|
export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1251
1329
|
/**
|
|
1252
|
-
* Apply a punishment to one or more targets.
|
|
1330
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1253
1331
|
* @summary Apply punishment
|
|
1254
1332
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1255
1333
|
* @param {*} [options] Override http request option.
|
|
@@ -1257,7 +1335,7 @@ export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
1257
1335
|
*/
|
|
1258
1336
|
applyPunishment: (adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1259
1337
|
/**
|
|
1260
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1338
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1261
1339
|
* @summary Evaluate punishment impact
|
|
1262
1340
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1263
1341
|
* @param {*} [options] Override http request option.
|
|
@@ -1280,7 +1358,7 @@ export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
1280
1358
|
*/
|
|
1281
1359
|
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>;
|
|
1282
1360
|
/**
|
|
1283
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1361
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1284
1362
|
* @summary Search punishment targets
|
|
1285
1363
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1286
1364
|
* @param {*} [options] Override http request option.
|
|
@@ -1293,7 +1371,7 @@ export declare const AdminPunishmentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
1293
1371
|
*/
|
|
1294
1372
|
export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
|
|
1295
1373
|
/**
|
|
1296
|
-
* Apply a punishment to one or more targets.
|
|
1374
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1297
1375
|
* @summary Apply punishment
|
|
1298
1376
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1299
1377
|
* @param {*} [options] Override http request option.
|
|
@@ -1301,7 +1379,7 @@ export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
|
|
|
1301
1379
|
*/
|
|
1302
1380
|
applyPunishment(adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminApplyPunishmentResponse>>;
|
|
1303
1381
|
/**
|
|
1304
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1382
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1305
1383
|
* @summary Evaluate punishment impact
|
|
1306
1384
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1307
1385
|
* @param {*} [options] Override http request option.
|
|
@@ -1324,7 +1402,7 @@ export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
|
|
|
1324
1402
|
*/
|
|
1325
1403
|
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>>;
|
|
1326
1404
|
/**
|
|
1327
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1405
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1328
1406
|
* @summary Search punishment targets
|
|
1329
1407
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1330
1408
|
* @param {*} [options] Override http request option.
|
|
@@ -1337,7 +1415,7 @@ export declare const AdminPunishmentsApiFp: (configuration?: Configuration) => {
|
|
|
1337
1415
|
*/
|
|
1338
1416
|
export declare const AdminPunishmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1339
1417
|
/**
|
|
1340
|
-
* Apply a punishment to one or more targets.
|
|
1418
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1341
1419
|
* @summary Apply punishment
|
|
1342
1420
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1343
1421
|
* @param {*} [options] Override http request option.
|
|
@@ -1345,7 +1423,7 @@ export declare const AdminPunishmentsApiFactory: (configuration?: Configuration,
|
|
|
1345
1423
|
*/
|
|
1346
1424
|
applyPunishment(adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminApplyPunishmentResponse>;
|
|
1347
1425
|
/**
|
|
1348
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1426
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1349
1427
|
* @summary Evaluate punishment impact
|
|
1350
1428
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1351
1429
|
* @param {*} [options] Override http request option.
|
|
@@ -1368,7 +1446,7 @@ export declare const AdminPunishmentsApiFactory: (configuration?: Configuration,
|
|
|
1368
1446
|
*/
|
|
1369
1447
|
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>;
|
|
1370
1448
|
/**
|
|
1371
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1449
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1372
1450
|
* @summary Search punishment targets
|
|
1373
1451
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1374
1452
|
* @param {*} [options] Override http request option.
|
|
@@ -1381,7 +1459,7 @@ export declare const AdminPunishmentsApiFactory: (configuration?: Configuration,
|
|
|
1381
1459
|
*/
|
|
1382
1460
|
export declare class AdminPunishmentsApi extends BaseAPI {
|
|
1383
1461
|
/**
|
|
1384
|
-
* Apply a punishment to one or more targets.
|
|
1462
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1385
1463
|
* @summary Apply punishment
|
|
1386
1464
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1387
1465
|
* @param {*} [options] Override http request option.
|
|
@@ -1389,7 +1467,7 @@ export declare class AdminPunishmentsApi extends BaseAPI {
|
|
|
1389
1467
|
*/
|
|
1390
1468
|
applyPunishment(adminApplyPunishmentRequest: AdminApplyPunishmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminApplyPunishmentResponse, any, {}>>;
|
|
1391
1469
|
/**
|
|
1392
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1470
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1393
1471
|
* @summary Evaluate punishment impact
|
|
1394
1472
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1395
1473
|
* @param {*} [options] Override http request option.
|
|
@@ -1412,7 +1490,7 @@ export declare class AdminPunishmentsApi extends BaseAPI {
|
|
|
1412
1490
|
*/
|
|
1413
1491
|
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, {}>>;
|
|
1414
1492
|
/**
|
|
1415
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1493
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1416
1494
|
* @summary Search punishment targets
|
|
1417
1495
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1418
1496
|
* @param {*} [options] Override http request option.
|
|
@@ -1440,6 +1518,13 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
1440
1518
|
* @throws {RequiredError}
|
|
1441
1519
|
*/
|
|
1442
1520
|
initiateLogin: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1521
|
+
/**
|
|
1522
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1523
|
+
* @summary Get current user profile
|
|
1524
|
+
* @param {*} [options] Override http request option.
|
|
1525
|
+
* @throws {RequiredError}
|
|
1526
|
+
*/
|
|
1527
|
+
me: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1443
1528
|
/**
|
|
1444
1529
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1445
1530
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1471,6 +1556,13 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
1471
1556
|
* @throws {RequiredError}
|
|
1472
1557
|
*/
|
|
1473
1558
|
initiateLogin(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1559
|
+
/**
|
|
1560
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1561
|
+
* @summary Get current user profile
|
|
1562
|
+
* @param {*} [options] Override http request option.
|
|
1563
|
+
* @throws {RequiredError}
|
|
1564
|
+
*/
|
|
1565
|
+
me(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserProfileResponse>>;
|
|
1474
1566
|
/**
|
|
1475
1567
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1476
1568
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1502,6 +1594,13 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
1502
1594
|
* @throws {RequiredError}
|
|
1503
1595
|
*/
|
|
1504
1596
|
initiateLogin(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1597
|
+
/**
|
|
1598
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1599
|
+
* @summary Get current user profile
|
|
1600
|
+
* @param {*} [options] Override http request option.
|
|
1601
|
+
* @throws {RequiredError}
|
|
1602
|
+
*/
|
|
1603
|
+
me(options?: RawAxiosRequestConfig): AxiosPromise<UserProfileResponse>;
|
|
1505
1604
|
/**
|
|
1506
1605
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1507
1606
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1533,6 +1632,13 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
1533
1632
|
* @throws {RequiredError}
|
|
1534
1633
|
*/
|
|
1535
1634
|
initiateLogin(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1635
|
+
/**
|
|
1636
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1637
|
+
* @summary Get current user profile
|
|
1638
|
+
* @param {*} [options] Override http request option.
|
|
1639
|
+
* @throws {RequiredError}
|
|
1640
|
+
*/
|
|
1641
|
+
me(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserProfileResponse, any, {}>>;
|
|
1536
1642
|
/**
|
|
1537
1643
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1538
1644
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1701,17 +1807,17 @@ export declare class ConnectionApi extends BaseAPI {
|
|
|
1701
1807
|
*/
|
|
1702
1808
|
export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1703
1809
|
/**
|
|
1704
|
-
* Retrieves player information by
|
|
1810
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
1705
1811
|
* @summary Get player information
|
|
1706
|
-
* @param {string} uuid
|
|
1812
|
+
* @param {string} uuid
|
|
1707
1813
|
* @param {*} [options] Override http request option.
|
|
1708
1814
|
* @throws {RequiredError}
|
|
1709
1815
|
*/
|
|
1710
1816
|
getPlayer1: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1711
1817
|
/**
|
|
1712
|
-
* 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
|
|
1818
|
+
* 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.
|
|
1713
1819
|
* @summary Batch resolve UUIDs to usernames
|
|
1714
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1820
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1715
1821
|
* @param {*} [options] Override http request option.
|
|
1716
1822
|
* @throws {RequiredError}
|
|
1717
1823
|
*/
|
|
@@ -1722,17 +1828,17 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1722
1828
|
*/
|
|
1723
1829
|
export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
1724
1830
|
/**
|
|
1725
|
-
* Retrieves player information by
|
|
1831
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
1726
1832
|
* @summary Get player information
|
|
1727
|
-
* @param {string} uuid
|
|
1833
|
+
* @param {string} uuid
|
|
1728
1834
|
* @param {*} [options] Override http request option.
|
|
1729
1835
|
* @throws {RequiredError}
|
|
1730
1836
|
*/
|
|
1731
1837
|
getPlayer1(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerGetPlayerInformation>>;
|
|
1732
1838
|
/**
|
|
1733
|
-
* 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
|
|
1839
|
+
* 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.
|
|
1734
1840
|
* @summary Batch resolve UUIDs to usernames
|
|
1735
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1841
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1736
1842
|
* @param {*} [options] Override http request option.
|
|
1737
1843
|
* @throws {RequiredError}
|
|
1738
1844
|
*/
|
|
@@ -1743,17 +1849,17 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
|
1743
1849
|
*/
|
|
1744
1850
|
export declare const PlayerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1745
1851
|
/**
|
|
1746
|
-
* Retrieves player information by
|
|
1852
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
1747
1853
|
* @summary Get player information
|
|
1748
|
-
* @param {string} uuid
|
|
1854
|
+
* @param {string} uuid
|
|
1749
1855
|
* @param {*} [options] Override http request option.
|
|
1750
1856
|
* @throws {RequiredError}
|
|
1751
1857
|
*/
|
|
1752
1858
|
getPlayer1(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerGetPlayerInformation>;
|
|
1753
1859
|
/**
|
|
1754
|
-
* 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
|
|
1860
|
+
* 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.
|
|
1755
1861
|
* @summary Batch resolve UUIDs to usernames
|
|
1756
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1862
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1757
1863
|
* @param {*} [options] Override http request option.
|
|
1758
1864
|
* @throws {RequiredError}
|
|
1759
1865
|
*/
|
|
@@ -1764,17 +1870,17 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
|
|
|
1764
1870
|
*/
|
|
1765
1871
|
export declare class PlayerApi extends BaseAPI {
|
|
1766
1872
|
/**
|
|
1767
|
-
* Retrieves player information by
|
|
1873
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
1768
1874
|
* @summary Get player information
|
|
1769
|
-
* @param {string} uuid
|
|
1875
|
+
* @param {string} uuid
|
|
1770
1876
|
* @param {*} [options] Override http request option.
|
|
1771
1877
|
* @throws {RequiredError}
|
|
1772
1878
|
*/
|
|
1773
1879
|
getPlayer1(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerGetPlayerInformation, any, {}>>;
|
|
1774
1880
|
/**
|
|
1775
|
-
* 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
|
|
1881
|
+
* 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.
|
|
1776
1882
|
* @summary Batch resolve UUIDs to usernames
|
|
1777
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1883
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
1778
1884
|
* @param {*} [options] Override http request option.
|
|
1779
1885
|
* @throws {RequiredError}
|
|
1780
1886
|
*/
|