@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/esm/api.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:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -40,6 +40,11 @@ export const AdminPunishmentSearchResponseKindEnum = {
|
|
|
40
40
|
Player: 'player',
|
|
41
41
|
Ip: 'ip'
|
|
42
42
|
};
|
|
43
|
+
export const Rank = {
|
|
44
|
+
Administrator: 'ADMINISTRATOR',
|
|
45
|
+
Moderator: 'MODERATOR',
|
|
46
|
+
Service: 'SERVICE'
|
|
47
|
+
};
|
|
43
48
|
/**
|
|
44
49
|
* AdminClientCredentialsApi - axios parameter creator
|
|
45
50
|
*/
|
|
@@ -695,6 +700,43 @@ export const AdminConnectionsApiAxiosParamCreator = function (configuration) {
|
|
|
695
700
|
options: localVarRequestOptions,
|
|
696
701
|
};
|
|
697
702
|
}),
|
|
703
|
+
/**
|
|
704
|
+
* 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.
|
|
705
|
+
* @summary Refresh a single VPN check
|
|
706
|
+
* @param {number} connectionId
|
|
707
|
+
* @param {string} service
|
|
708
|
+
* @param {*} [options] Override http request option.
|
|
709
|
+
* @throws {RequiredError}
|
|
710
|
+
*/
|
|
711
|
+
recheckService: (connectionId_1, service_1, ...args_1) => __awaiter(this, [connectionId_1, service_1, ...args_1], void 0, function* (connectionId, service, options = {}) {
|
|
712
|
+
// verify required parameter 'connectionId' is not null or undefined
|
|
713
|
+
assertParamExists('recheckService', 'connectionId', connectionId);
|
|
714
|
+
// verify required parameter 'service' is not null or undefined
|
|
715
|
+
assertParamExists('recheckService', 'service', service);
|
|
716
|
+
const localVarPath = `/admin/connection/{connectionId}/recheck/{service}`
|
|
717
|
+
.replace(`{${"connectionId"}}`, encodeURIComponent(String(connectionId)))
|
|
718
|
+
.replace(`{${"service"}}`, encodeURIComponent(String(service)));
|
|
719
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
720
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
721
|
+
let baseOptions;
|
|
722
|
+
if (configuration) {
|
|
723
|
+
baseOptions = configuration.baseOptions;
|
|
724
|
+
}
|
|
725
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
726
|
+
const localVarHeaderParameter = {};
|
|
727
|
+
const localVarQueryParameter = {};
|
|
728
|
+
// authentication DiscordAuth required
|
|
729
|
+
// http bearer authentication required
|
|
730
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
731
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
732
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
733
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
734
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
735
|
+
return {
|
|
736
|
+
url: toPathString(localVarUrlObj),
|
|
737
|
+
options: localVarRequestOptions,
|
|
738
|
+
};
|
|
739
|
+
}),
|
|
698
740
|
};
|
|
699
741
|
};
|
|
700
742
|
/**
|
|
@@ -761,6 +803,23 @@ export const AdminConnectionsApiFp = function (configuration) {
|
|
|
761
803
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
762
804
|
});
|
|
763
805
|
},
|
|
806
|
+
/**
|
|
807
|
+
* 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.
|
|
808
|
+
* @summary Refresh a single VPN check
|
|
809
|
+
* @param {number} connectionId
|
|
810
|
+
* @param {string} service
|
|
811
|
+
* @param {*} [options] Override http request option.
|
|
812
|
+
* @throws {RequiredError}
|
|
813
|
+
*/
|
|
814
|
+
recheckService(connectionId, service, options) {
|
|
815
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
816
|
+
var _a, _b, _c;
|
|
817
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.recheckService(connectionId, service, options);
|
|
818
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
819
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminConnectionsApi.recheckService']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
820
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
821
|
+
});
|
|
822
|
+
},
|
|
764
823
|
};
|
|
765
824
|
};
|
|
766
825
|
/**
|
|
@@ -809,6 +868,17 @@ export const AdminConnectionsApiFactory = function (configuration, basePath, axi
|
|
|
809
868
|
listConnections(createdAfter, createdBefore, ipAddress, uuid, isVpn, page, limit, options) {
|
|
810
869
|
return localVarFp.listConnections(createdAfter, createdBefore, ipAddress, uuid, isVpn, page, limit, options).then((request) => request(axios, basePath));
|
|
811
870
|
},
|
|
871
|
+
/**
|
|
872
|
+
* 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.
|
|
873
|
+
* @summary Refresh a single VPN check
|
|
874
|
+
* @param {number} connectionId
|
|
875
|
+
* @param {string} service
|
|
876
|
+
* @param {*} [options] Override http request option.
|
|
877
|
+
* @throws {RequiredError}
|
|
878
|
+
*/
|
|
879
|
+
recheckService(connectionId, service, options) {
|
|
880
|
+
return localVarFp.recheckService(connectionId, service, options).then((request) => request(axios, basePath));
|
|
881
|
+
},
|
|
812
882
|
};
|
|
813
883
|
};
|
|
814
884
|
/**
|
|
@@ -855,6 +925,17 @@ export class AdminConnectionsApi extends BaseAPI {
|
|
|
855
925
|
listConnections(createdAfter, createdBefore, ipAddress, uuid, isVpn, page, limit, options) {
|
|
856
926
|
return AdminConnectionsApiFp(this.configuration).listConnections(createdAfter, createdBefore, ipAddress, uuid, isVpn, page, limit, options).then((request) => request(this.axios, this.basePath));
|
|
857
927
|
}
|
|
928
|
+
/**
|
|
929
|
+
* 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.
|
|
930
|
+
* @summary Refresh a single VPN check
|
|
931
|
+
* @param {number} connectionId
|
|
932
|
+
* @param {string} service
|
|
933
|
+
* @param {*} [options] Override http request option.
|
|
934
|
+
* @throws {RequiredError}
|
|
935
|
+
*/
|
|
936
|
+
recheckService(connectionId, service, options) {
|
|
937
|
+
return AdminConnectionsApiFp(this.configuration).recheckService(connectionId, service, options).then((request) => request(this.axios, this.basePath));
|
|
938
|
+
}
|
|
858
939
|
}
|
|
859
940
|
/**
|
|
860
941
|
* AdminDashboardApi - axios parameter creator
|
|
@@ -1136,7 +1217,7 @@ export class AdminPlayersApi extends BaseAPI {
|
|
|
1136
1217
|
export const AdminPunishmentsApiAxiosParamCreator = function (configuration) {
|
|
1137
1218
|
return {
|
|
1138
1219
|
/**
|
|
1139
|
-
* Apply a punishment to one or more targets.
|
|
1220
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1140
1221
|
* @summary Apply punishment
|
|
1141
1222
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1142
1223
|
* @param {*} [options] Override http request option.
|
|
@@ -1170,7 +1251,7 @@ export const AdminPunishmentsApiAxiosParamCreator = function (configuration) {
|
|
|
1170
1251
|
};
|
|
1171
1252
|
}),
|
|
1172
1253
|
/**
|
|
1173
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1254
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1174
1255
|
* @summary Evaluate punishment impact
|
|
1175
1256
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1176
1257
|
* @param {*} [options] Override http request option.
|
|
@@ -1269,7 +1350,7 @@ export const AdminPunishmentsApiAxiosParamCreator = function (configuration) {
|
|
|
1269
1350
|
};
|
|
1270
1351
|
}),
|
|
1271
1352
|
/**
|
|
1272
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1353
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1273
1354
|
* @summary Search punishment targets
|
|
1274
1355
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1275
1356
|
* @param {*} [options] Override http request option.
|
|
@@ -1312,7 +1393,7 @@ export const AdminPunishmentsApiFp = function (configuration) {
|
|
|
1312
1393
|
const localVarAxiosParamCreator = AdminPunishmentsApiAxiosParamCreator(configuration);
|
|
1313
1394
|
return {
|
|
1314
1395
|
/**
|
|
1315
|
-
* Apply a punishment to one or more targets.
|
|
1396
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1316
1397
|
* @summary Apply punishment
|
|
1317
1398
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1318
1399
|
* @param {*} [options] Override http request option.
|
|
@@ -1328,7 +1409,7 @@ export const AdminPunishmentsApiFp = function (configuration) {
|
|
|
1328
1409
|
});
|
|
1329
1410
|
},
|
|
1330
1411
|
/**
|
|
1331
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1412
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1332
1413
|
* @summary Evaluate punishment impact
|
|
1333
1414
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1334
1415
|
* @param {*} [options] Override http request option.
|
|
@@ -1367,7 +1448,7 @@ export const AdminPunishmentsApiFp = function (configuration) {
|
|
|
1367
1448
|
});
|
|
1368
1449
|
},
|
|
1369
1450
|
/**
|
|
1370
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1451
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1371
1452
|
* @summary Search punishment targets
|
|
1372
1453
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1373
1454
|
* @param {*} [options] Override http request option.
|
|
@@ -1391,7 +1472,7 @@ export const AdminPunishmentsApiFactory = function (configuration, basePath, axi
|
|
|
1391
1472
|
const localVarFp = AdminPunishmentsApiFp(configuration);
|
|
1392
1473
|
return {
|
|
1393
1474
|
/**
|
|
1394
|
-
* Apply a punishment to one or more targets.
|
|
1475
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1395
1476
|
* @summary Apply punishment
|
|
1396
1477
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1397
1478
|
* @param {*} [options] Override http request option.
|
|
@@ -1401,7 +1482,7 @@ export const AdminPunishmentsApiFactory = function (configuration, basePath, axi
|
|
|
1401
1482
|
return localVarFp.applyPunishment(adminApplyPunishmentRequest, options).then((request) => request(axios, basePath));
|
|
1402
1483
|
},
|
|
1403
1484
|
/**
|
|
1404
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1485
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1405
1486
|
* @summary Evaluate punishment impact
|
|
1406
1487
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1407
1488
|
* @param {*} [options] Override http request option.
|
|
@@ -1428,7 +1509,7 @@ export const AdminPunishmentsApiFactory = function (configuration, basePath, axi
|
|
|
1428
1509
|
return localVarFp.getPunishments(page, limit, uuid, username, ipAddress, type, issuedAfter, issuedBefore, options).then((request) => request(axios, basePath));
|
|
1429
1510
|
},
|
|
1430
1511
|
/**
|
|
1431
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1512
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1432
1513
|
* @summary Search punishment targets
|
|
1433
1514
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1434
1515
|
* @param {*} [options] Override http request option.
|
|
@@ -1444,7 +1525,7 @@ export const AdminPunishmentsApiFactory = function (configuration, basePath, axi
|
|
|
1444
1525
|
*/
|
|
1445
1526
|
export class AdminPunishmentsApi extends BaseAPI {
|
|
1446
1527
|
/**
|
|
1447
|
-
* Apply a punishment to one or more targets.
|
|
1528
|
+
* Apply a punishment to one or more targets. The authenticated user is recorded as the issuer.
|
|
1448
1529
|
* @summary Apply punishment
|
|
1449
1530
|
* @param {AdminApplyPunishmentRequest} adminApplyPunishmentRequest
|
|
1450
1531
|
* @param {*} [options] Override http request option.
|
|
@@ -1454,7 +1535,7 @@ export class AdminPunishmentsApi extends BaseAPI {
|
|
|
1454
1535
|
return AdminPunishmentsApiFp(this.configuration).applyPunishment(adminApplyPunishmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1455
1536
|
}
|
|
1456
1537
|
/**
|
|
1457
|
-
* Preview the impact of a punishment across one or more targets.
|
|
1538
|
+
* Preview the impact of a punishment across one or more targets. No changes are made.
|
|
1458
1539
|
* @summary Evaluate punishment impact
|
|
1459
1540
|
* @param {AdminCreatePunishmentDraftRequest} adminCreatePunishmentDraftRequest
|
|
1460
1541
|
* @param {*} [options] Override http request option.
|
|
@@ -1481,7 +1562,7 @@ export class AdminPunishmentsApi extends BaseAPI {
|
|
|
1481
1562
|
return AdminPunishmentsApiFp(this.configuration).getPunishments(page, limit, uuid, username, ipAddress, type, issuedAfter, issuedBefore, options).then((request) => request(this.axios, this.basePath));
|
|
1482
1563
|
}
|
|
1483
1564
|
/**
|
|
1484
|
-
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1565
|
+
* Search for players by UUID or username, or look up all players associated with an IP address.
|
|
1485
1566
|
* @summary Search punishment targets
|
|
1486
1567
|
* @param {string} q UUID, username, or partial/full IP address to search for
|
|
1487
1568
|
* @param {*} [options] Override http request option.
|
|
@@ -1560,6 +1641,35 @@ export const AuthenticationApiAxiosParamCreator = function (configuration) {
|
|
|
1560
1641
|
options: localVarRequestOptions,
|
|
1561
1642
|
};
|
|
1562
1643
|
}),
|
|
1644
|
+
/**
|
|
1645
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1646
|
+
* @summary Get current user profile
|
|
1647
|
+
* @param {*} [options] Override http request option.
|
|
1648
|
+
* @throws {RequiredError}
|
|
1649
|
+
*/
|
|
1650
|
+
me: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
1651
|
+
const localVarPath = `/auth/me`;
|
|
1652
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1653
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1654
|
+
let baseOptions;
|
|
1655
|
+
if (configuration) {
|
|
1656
|
+
baseOptions = configuration.baseOptions;
|
|
1657
|
+
}
|
|
1658
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1659
|
+
const localVarHeaderParameter = {};
|
|
1660
|
+
const localVarQueryParameter = {};
|
|
1661
|
+
// authentication DiscordAuth required
|
|
1662
|
+
// http bearer authentication required
|
|
1663
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1664
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1665
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1666
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1667
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1668
|
+
return {
|
|
1669
|
+
url: toPathString(localVarUrlObj),
|
|
1670
|
+
options: localVarRequestOptions,
|
|
1671
|
+
};
|
|
1672
|
+
}),
|
|
1563
1673
|
/**
|
|
1564
1674
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1565
1675
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1644,6 +1754,21 @@ export const AuthenticationApiFp = function (configuration) {
|
|
|
1644
1754
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1645
1755
|
});
|
|
1646
1756
|
},
|
|
1757
|
+
/**
|
|
1758
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1759
|
+
* @summary Get current user profile
|
|
1760
|
+
* @param {*} [options] Override http request option.
|
|
1761
|
+
* @throws {RequiredError}
|
|
1762
|
+
*/
|
|
1763
|
+
me(options) {
|
|
1764
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1765
|
+
var _a, _b, _c;
|
|
1766
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.me(options);
|
|
1767
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1768
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AuthenticationApi.me']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1769
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1770
|
+
});
|
|
1771
|
+
},
|
|
1647
1772
|
/**
|
|
1648
1773
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1649
1774
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1690,6 +1815,15 @@ export const AuthenticationApiFactory = function (configuration, basePath, axios
|
|
|
1690
1815
|
initiateLogin(options) {
|
|
1691
1816
|
return localVarFp.initiateLogin(options).then((request) => request(axios, basePath));
|
|
1692
1817
|
},
|
|
1818
|
+
/**
|
|
1819
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1820
|
+
* @summary Get current user profile
|
|
1821
|
+
* @param {*} [options] Override http request option.
|
|
1822
|
+
* @throws {RequiredError}
|
|
1823
|
+
*/
|
|
1824
|
+
me(options) {
|
|
1825
|
+
return localVarFp.me(options).then((request) => request(axios, basePath));
|
|
1826
|
+
},
|
|
1693
1827
|
/**
|
|
1694
1828
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1695
1829
|
* @summary Service - Exchange client credentials for token
|
|
@@ -1728,6 +1862,15 @@ export class AuthenticationApi extends BaseAPI {
|
|
|
1728
1862
|
initiateLogin(options) {
|
|
1729
1863
|
return AuthenticationApiFp(this.configuration).initiateLogin(options).then((request) => request(this.axios, this.basePath));
|
|
1730
1864
|
}
|
|
1865
|
+
/**
|
|
1866
|
+
* Returns the authenticated user\'s profile from their JWT claims. The session is already validated by the security rule before this endpoint is reached.
|
|
1867
|
+
* @summary Get current user profile
|
|
1868
|
+
* @param {*} [options] Override http request option.
|
|
1869
|
+
* @throws {RequiredError}
|
|
1870
|
+
*/
|
|
1871
|
+
me(options) {
|
|
1872
|
+
return AuthenticationApiFp(this.configuration).me(options).then((request) => request(this.axios, this.basePath));
|
|
1873
|
+
}
|
|
1731
1874
|
/**
|
|
1732
1875
|
* Exchange service client credentials for a Bearer JWT using the OAuth2 client_credentials grant. Used by game server plugins to authenticate against the API.
|
|
1733
1876
|
* @summary Service - Exchange client credentials for token
|
|
@@ -2043,9 +2186,9 @@ export class ConnectionApi extends BaseAPI {
|
|
|
2043
2186
|
export const PlayerApiAxiosParamCreator = function (configuration) {
|
|
2044
2187
|
return {
|
|
2045
2188
|
/**
|
|
2046
|
-
* Retrieves player information by
|
|
2189
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
2047
2190
|
* @summary Get player information
|
|
2048
|
-
* @param {string} uuid
|
|
2191
|
+
* @param {string} uuid
|
|
2049
2192
|
* @param {*} [options] Override http request option.
|
|
2050
2193
|
* @throws {RequiredError}
|
|
2051
2194
|
*/
|
|
@@ -2076,9 +2219,9 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
|
|
|
2076
2219
|
};
|
|
2077
2220
|
}),
|
|
2078
2221
|
/**
|
|
2079
|
-
* 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
|
|
2222
|
+
* 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.
|
|
2080
2223
|
* @summary Batch resolve UUIDs to usernames
|
|
2081
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2224
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2082
2225
|
* @param {*} [options] Override http request option.
|
|
2083
2226
|
* @throws {RequiredError}
|
|
2084
2227
|
*/
|
|
@@ -2119,9 +2262,9 @@ export const PlayerApiFp = function (configuration) {
|
|
|
2119
2262
|
const localVarAxiosParamCreator = PlayerApiAxiosParamCreator(configuration);
|
|
2120
2263
|
return {
|
|
2121
2264
|
/**
|
|
2122
|
-
* Retrieves player information by
|
|
2265
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
2123
2266
|
* @summary Get player information
|
|
2124
|
-
* @param {string} uuid
|
|
2267
|
+
* @param {string} uuid
|
|
2125
2268
|
* @param {*} [options] Override http request option.
|
|
2126
2269
|
* @throws {RequiredError}
|
|
2127
2270
|
*/
|
|
@@ -2135,9 +2278,9 @@ export const PlayerApiFp = function (configuration) {
|
|
|
2135
2278
|
});
|
|
2136
2279
|
},
|
|
2137
2280
|
/**
|
|
2138
|
-
* 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
|
|
2281
|
+
* 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.
|
|
2139
2282
|
* @summary Batch resolve UUIDs to usernames
|
|
2140
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2283
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2141
2284
|
* @param {*} [options] Override http request option.
|
|
2142
2285
|
* @throws {RequiredError}
|
|
2143
2286
|
*/
|
|
@@ -2159,9 +2302,9 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
|
|
|
2159
2302
|
const localVarFp = PlayerApiFp(configuration);
|
|
2160
2303
|
return {
|
|
2161
2304
|
/**
|
|
2162
|
-
* Retrieves player information by
|
|
2305
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
2163
2306
|
* @summary Get player information
|
|
2164
|
-
* @param {string} uuid
|
|
2307
|
+
* @param {string} uuid
|
|
2165
2308
|
* @param {*} [options] Override http request option.
|
|
2166
2309
|
* @throws {RequiredError}
|
|
2167
2310
|
*/
|
|
@@ -2169,9 +2312,9 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
|
|
|
2169
2312
|
return localVarFp.getPlayer1(uuid, options).then((request) => request(axios, basePath));
|
|
2170
2313
|
},
|
|
2171
2314
|
/**
|
|
2172
|
-
* 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
|
|
2315
|
+
* 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.
|
|
2173
2316
|
* @summary Batch resolve UUIDs to usernames
|
|
2174
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2317
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2175
2318
|
* @param {*} [options] Override http request option.
|
|
2176
2319
|
* @throws {RequiredError}
|
|
2177
2320
|
*/
|
|
@@ -2185,9 +2328,9 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
|
|
|
2185
2328
|
*/
|
|
2186
2329
|
export class PlayerApi extends BaseAPI {
|
|
2187
2330
|
/**
|
|
2188
|
-
* Retrieves player information by
|
|
2331
|
+
* Retrieves player information by Minecraft UUID including first join status and login timestamp.
|
|
2189
2332
|
* @summary Get player information
|
|
2190
|
-
* @param {string} uuid
|
|
2333
|
+
* @param {string} uuid
|
|
2191
2334
|
* @param {*} [options] Override http request option.
|
|
2192
2335
|
* @throws {RequiredError}
|
|
2193
2336
|
*/
|
|
@@ -2195,9 +2338,9 @@ export class PlayerApi extends BaseAPI {
|
|
|
2195
2338
|
return PlayerApiFp(this.configuration).getPlayer1(uuid, options).then((request) => request(this.axios, this.basePath));
|
|
2196
2339
|
}
|
|
2197
2340
|
/**
|
|
2198
|
-
* 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
|
|
2341
|
+
* 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.
|
|
2199
2342
|
* @summary Batch resolve UUIDs to usernames
|
|
2200
|
-
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2343
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve
|
|
2201
2344
|
* @param {*} [options] Override http request option.
|
|
2202
2345
|
* @throws {RequiredError}
|
|
2203
2346
|
*/
|
package/dist/esm/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:
|
|
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).
|
package/dist/esm/base.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:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/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:
|
|
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).
|
package/dist/esm/common.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:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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).
|
|
@@ -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:
|
|
6
|
+
* The version of the OpenAPI document: 3.0.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.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).
|
package/dist/esm/index.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:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.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).
|
package/dist/index.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:
|
|
8
|
+
* The version of the OpenAPI document: 3.0.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AdminConnectionCheckResult
|
|
2
|
+
|
|
3
|
+
Result from a single VPN detection service for a given IP address
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**service** | **string** | Service identifier | [optional] [default to undefined]
|
|
10
|
+
**result** | **boolean** | Whether this service flagged the IP as a VPN, proxy, or Tor exit node | [optional] [default to undefined]
|
|
11
|
+
**checkedAt** | **string** | When this check was last performed | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminConnectionCheckResult } from '@rebornteam/reborn-api';
|
|
17
|
+
|
|
18
|
+
const instance: AdminConnectionCheckResult = {
|
|
19
|
+
service,
|
|
20
|
+
result,
|
|
21
|
+
checkedAt,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
7
7
|
|[**createBypass**](#createbypass) | **POST** /admin/connection/bypass | Create connection bypass|
|
|
8
8
|
|[**listAllConnections**](#listallconnections) | **GET** /admin/connection | List all connections (paginated)|
|
|
9
9
|
|[**listConnections**](#listconnections) | **GET** /admin/connection/recent | List recent connections|
|
|
10
|
+
|[**recheckService**](#recheckservice) | **POST** /admin/connection/{connectionId}/recheck/{service} | Refresh a single VPN check|
|
|
10
11
|
|
|
11
12
|
# **createBypass**
|
|
12
13
|
> AdminConnectionBypassResponse createBypass(createBypassRequest)
|
|
@@ -59,7 +60,7 @@ const { status, data } = await apiInstance.createBypass(
|
|
|
59
60
|
|**200** | Connection bypass created successfully | - |
|
|
60
61
|
|**400** | Invalid request body | - |
|
|
61
62
|
|**401** | Unauthorized - Authentication required | - |
|
|
62
|
-
|**403** | Forbidden -
|
|
63
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
63
64
|
|
|
64
65
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
65
66
|
|
|
@@ -124,7 +125,7 @@ const { status, data } = await apiInstance.listAllConnections(
|
|
|
124
125
|
|-------------|-------------|------------------|
|
|
125
126
|
|**200** | Paginated connection list retrieved successfully | - |
|
|
126
127
|
|**401** | Unauthorized - Authentication required | - |
|
|
127
|
-
|**403** | Forbidden -
|
|
128
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
128
129
|
|
|
129
130
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
130
131
|
|
|
@@ -195,7 +196,65 @@ const { status, data } = await apiInstance.listConnections(
|
|
|
195
196
|
|-------------|-------------|------------------|
|
|
196
197
|
|**200** | Successfully retrieved connections list | - |
|
|
197
198
|
|**401** | Unauthorized - Authentication required | - |
|
|
198
|
-
|**403** | Forbidden -
|
|
199
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
200
|
+
|
|
201
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
202
|
+
|
|
203
|
+
# **recheckService**
|
|
204
|
+
> AdminConnectionCheckResult recheckService()
|
|
205
|
+
|
|
206
|
+
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.
|
|
207
|
+
|
|
208
|
+
### Example
|
|
209
|
+
|
|
210
|
+
```typescript
|
|
211
|
+
import {
|
|
212
|
+
AdminConnectionsApi,
|
|
213
|
+
Configuration
|
|
214
|
+
} from '@rebornteam/reborn-api';
|
|
215
|
+
|
|
216
|
+
const configuration = new Configuration();
|
|
217
|
+
const apiInstance = new AdminConnectionsApi(configuration);
|
|
218
|
+
|
|
219
|
+
let connectionId: number; // (default to undefined)
|
|
220
|
+
let service: string; // (default to undefined)
|
|
221
|
+
|
|
222
|
+
const { status, data } = await apiInstance.recheckService(
|
|
223
|
+
connectionId,
|
|
224
|
+
service
|
|
225
|
+
);
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Parameters
|
|
229
|
+
|
|
230
|
+
|Name | Type | Description | Notes|
|
|
231
|
+
|------------- | ------------- | ------------- | -------------|
|
|
232
|
+
| **connectionId** | [**number**] | | defaults to undefined|
|
|
233
|
+
| **service** | [**string**] | | defaults to undefined|
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
### Return type
|
|
237
|
+
|
|
238
|
+
**AdminConnectionCheckResult**
|
|
239
|
+
|
|
240
|
+
### Authorization
|
|
241
|
+
|
|
242
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
243
|
+
|
|
244
|
+
### HTTP request headers
|
|
245
|
+
|
|
246
|
+
- **Content-Type**: Not defined
|
|
247
|
+
- **Accept**: application/json
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
### HTTP response details
|
|
251
|
+
| Status code | Description | Response headers |
|
|
252
|
+
|-------------|-------------|------------------|
|
|
253
|
+
|**200** | Check refreshed successfully | - |
|
|
254
|
+
|**400** | Unknown or unavailable service name | - |
|
|
255
|
+
|**401** | Unauthorized - Authentication required | - |
|
|
256
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
257
|
+
|**404** | Connection not found | - |
|
|
199
258
|
|
|
200
259
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
201
260
|
|
|
@@ -48,7 +48,7 @@ This endpoint does not have any parameters.
|
|
|
48
48
|
|-------------|-------------|------------------|
|
|
49
49
|
|**200** | Successfully retrieved dashboard statistics | - |
|
|
50
50
|
|**401** | Unauthorized - Authentication required | - |
|
|
51
|
-
|**403** | Forbidden -
|
|
51
|
+
|**403** | Forbidden - Moderator role required | - |
|
|
52
52
|
|
|
53
53
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
54
54
|
|