@rebornteam/reborn-api 2.6.4 → 2.7.0
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 +8 -1
- package/README.md +19 -5
- package/api.ts +910 -127
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +448 -69
- package/dist/api.js +823 -111
- 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 +448 -69
- package/dist/esm/api.js +806 -102
- 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/AuthenticationApi.md +167 -0
- package/docs/ChatApi.md +121 -0
- package/docs/ChatMessageDTO.md +30 -0
- package/docs/ChatMessageRequest.md +26 -0
- package/docs/PlayerApi.md +56 -3
- package/docs/ServerRegisterRequest.md +24 -0
- package/docs/ServerSessionDTO.md +36 -0
- package/docs/ServerSessionsApi.md +261 -0
- package/docs/TokenRequest.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/DefaultApi.md +0 -105
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: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.7.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -499,6 +499,20 @@ export interface AdminUsernameHistoryEntry {
|
|
|
499
499
|
*/
|
|
500
500
|
'changedAt'?: string;
|
|
501
501
|
}
|
|
502
|
+
export interface ChatMessageDTO {
|
|
503
|
+
'id': number;
|
|
504
|
+
'sentAt': string;
|
|
505
|
+
'sessionId': string;
|
|
506
|
+
'playerUuid': string;
|
|
507
|
+
'message': string;
|
|
508
|
+
'channel': string;
|
|
509
|
+
}
|
|
510
|
+
export interface ChatMessageRequest {
|
|
511
|
+
'sessionId': string;
|
|
512
|
+
'playerUuid': string;
|
|
513
|
+
'message': string;
|
|
514
|
+
'channel'?: string | null;
|
|
515
|
+
}
|
|
502
516
|
/**
|
|
503
517
|
* Request to create new client credentials
|
|
504
518
|
*/
|
|
@@ -656,6 +670,27 @@ export interface PunishmentSeveritiesResponseSeverityInfo {
|
|
|
656
670
|
*/
|
|
657
671
|
'durationSeconds'?: number;
|
|
658
672
|
}
|
|
673
|
+
export interface ServerRegisterRequest {
|
|
674
|
+
'region': string;
|
|
675
|
+
'gameType': string;
|
|
676
|
+
'containerId'?: string | null;
|
|
677
|
+
}
|
|
678
|
+
export interface ServerSessionDTO {
|
|
679
|
+
'id': string;
|
|
680
|
+
'region': string;
|
|
681
|
+
'gameType': string;
|
|
682
|
+
'instanceName': string;
|
|
683
|
+
'containerId'?: string | null;
|
|
684
|
+
'startedAt': string;
|
|
685
|
+
'lastHeartbeat': string;
|
|
686
|
+
'endedAt'?: string | null;
|
|
687
|
+
'online': boolean;
|
|
688
|
+
}
|
|
689
|
+
export interface TokenRequest {
|
|
690
|
+
'grant_type'?: string | null;
|
|
691
|
+
'client_id'?: string | null;
|
|
692
|
+
'client_secret'?: string | null;
|
|
693
|
+
}
|
|
659
694
|
/**
|
|
660
695
|
* Request to update client metadata
|
|
661
696
|
*/
|
|
@@ -1386,140 +1421,280 @@ export declare class AdminPunishmentsApi extends BaseAPI {
|
|
|
1386
1421
|
searchTargets(q: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminPunishmentSearchResponse, any, {}>>;
|
|
1387
1422
|
}
|
|
1388
1423
|
/**
|
|
1389
|
-
*
|
|
1424
|
+
* AuthenticationApi - axios parameter creator
|
|
1390
1425
|
*/
|
|
1391
|
-
export declare const
|
|
1426
|
+
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1392
1427
|
/**
|
|
1393
|
-
*
|
|
1394
|
-
* @summary
|
|
1395
|
-
* @param {string}
|
|
1396
|
-
* @param {
|
|
1397
|
-
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1428
|
+
* Receives the authorization code from Discord after the user approves the OAuth2 prompt. Exchanges the code for an access token, verifies the user holds an admin guild role, then redirects back to the admin frontend with a signed JWT in the query string (`?token=...`). On failure, redirects with `?error=<reason>` instead.
|
|
1429
|
+
* @summary Discord - OAuth2 callback
|
|
1430
|
+
* @param {string | null} [code] Authorization code provided by Discord on successful approval
|
|
1431
|
+
* @param {string | null} [error] Error code provided by Discord if the user denied access
|
|
1398
1432
|
* @param {*} [options] Override http request option.
|
|
1399
1433
|
* @throws {RequiredError}
|
|
1400
1434
|
*/
|
|
1401
|
-
|
|
1435
|
+
callback: (code?: string | null, error?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1436
|
+
/**
|
|
1437
|
+
* Redirects the browser to Discord\'s OAuth2 authorization page. Not called directly — the admin frontend navigates to this URL to begin the login flow.
|
|
1438
|
+
* @summary Discord - Initiate login
|
|
1439
|
+
* @param {*} [options] Override http request option.
|
|
1440
|
+
* @throws {RequiredError}
|
|
1441
|
+
*/
|
|
1442
|
+
initiateLogin: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1443
|
+
/**
|
|
1444
|
+
* 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
|
+
* @summary Service - Exchange client credentials for token
|
|
1446
|
+
* @param {string | null} [grantType]
|
|
1447
|
+
* @param {string | null} [clientId]
|
|
1448
|
+
* @param {string | null} [clientSecret]
|
|
1449
|
+
* @param {*} [options] Override http request option.
|
|
1450
|
+
* @throws {RequiredError}
|
|
1451
|
+
*/
|
|
1452
|
+
token: (grantType?: string | null, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1402
1453
|
};
|
|
1403
1454
|
/**
|
|
1404
|
-
*
|
|
1455
|
+
* AuthenticationApi - functional programming interface
|
|
1405
1456
|
*/
|
|
1406
|
-
export declare const
|
|
1457
|
+
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
1407
1458
|
/**
|
|
1408
|
-
*
|
|
1409
|
-
* @summary
|
|
1410
|
-
* @param {string}
|
|
1411
|
-
* @param {
|
|
1412
|
-
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1459
|
+
* Receives the authorization code from Discord after the user approves the OAuth2 prompt. Exchanges the code for an access token, verifies the user holds an admin guild role, then redirects back to the admin frontend with a signed JWT in the query string (`?token=...`). On failure, redirects with `?error=<reason>` instead.
|
|
1460
|
+
* @summary Discord - OAuth2 callback
|
|
1461
|
+
* @param {string | null} [code] Authorization code provided by Discord on successful approval
|
|
1462
|
+
* @param {string | null} [error] Error code provided by Discord if the user denied access
|
|
1413
1463
|
* @param {*} [options] Override http request option.
|
|
1414
1464
|
* @throws {RequiredError}
|
|
1415
1465
|
*/
|
|
1416
|
-
|
|
1466
|
+
callback(code?: string | null, error?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Redirects the browser to Discord\'s OAuth2 authorization page. Not called directly — the admin frontend navigates to this URL to begin the login flow.
|
|
1469
|
+
* @summary Discord - Initiate login
|
|
1470
|
+
* @param {*} [options] Override http request option.
|
|
1471
|
+
* @throws {RequiredError}
|
|
1472
|
+
*/
|
|
1473
|
+
initiateLogin(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1474
|
+
/**
|
|
1475
|
+
* 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
|
+
* @summary Service - Exchange client credentials for token
|
|
1477
|
+
* @param {string | null} [grantType]
|
|
1478
|
+
* @param {string | null} [clientId]
|
|
1479
|
+
* @param {string | null} [clientSecret]
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
*/
|
|
1483
|
+
token(grantType?: string | null, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
1417
1484
|
};
|
|
1418
1485
|
/**
|
|
1419
|
-
*
|
|
1486
|
+
* AuthenticationApi - factory interface
|
|
1420
1487
|
*/
|
|
1421
|
-
export declare const
|
|
1488
|
+
export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1422
1489
|
/**
|
|
1423
|
-
*
|
|
1424
|
-
* @summary
|
|
1425
|
-
* @param {string}
|
|
1426
|
-
* @param {
|
|
1427
|
-
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1490
|
+
* Receives the authorization code from Discord after the user approves the OAuth2 prompt. Exchanges the code for an access token, verifies the user holds an admin guild role, then redirects back to the admin frontend with a signed JWT in the query string (`?token=...`). On failure, redirects with `?error=<reason>` instead.
|
|
1491
|
+
* @summary Discord - OAuth2 callback
|
|
1492
|
+
* @param {string | null} [code] Authorization code provided by Discord on successful approval
|
|
1493
|
+
* @param {string | null} [error] Error code provided by Discord if the user denied access
|
|
1428
1494
|
* @param {*} [options] Override http request option.
|
|
1429
1495
|
* @throws {RequiredError}
|
|
1430
1496
|
*/
|
|
1431
|
-
|
|
1497
|
+
callback(code?: string | null, error?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Redirects the browser to Discord\'s OAuth2 authorization page. Not called directly — the admin frontend navigates to this URL to begin the login flow.
|
|
1500
|
+
* @summary Discord - Initiate login
|
|
1501
|
+
* @param {*} [options] Override http request option.
|
|
1502
|
+
* @throws {RequiredError}
|
|
1503
|
+
*/
|
|
1504
|
+
initiateLogin(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1505
|
+
/**
|
|
1506
|
+
* 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
|
+
* @summary Service - Exchange client credentials for token
|
|
1508
|
+
* @param {string | null} [grantType]
|
|
1509
|
+
* @param {string | null} [clientId]
|
|
1510
|
+
* @param {string | null} [clientSecret]
|
|
1511
|
+
* @param {*} [options] Override http request option.
|
|
1512
|
+
* @throws {RequiredError}
|
|
1513
|
+
*/
|
|
1514
|
+
token(grantType?: string | null, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
1432
1515
|
};
|
|
1433
1516
|
/**
|
|
1434
|
-
*
|
|
1517
|
+
* AuthenticationApi - object-oriented interface
|
|
1435
1518
|
*/
|
|
1436
|
-
export declare class
|
|
1519
|
+
export declare class AuthenticationApi extends BaseAPI {
|
|
1437
1520
|
/**
|
|
1438
|
-
*
|
|
1439
|
-
* @summary
|
|
1440
|
-
* @param {string}
|
|
1441
|
-
* @param {
|
|
1442
|
-
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1521
|
+
* Receives the authorization code from Discord after the user approves the OAuth2 prompt. Exchanges the code for an access token, verifies the user holds an admin guild role, then redirects back to the admin frontend with a signed JWT in the query string (`?token=...`). On failure, redirects with `?error=<reason>` instead.
|
|
1522
|
+
* @summary Discord - OAuth2 callback
|
|
1523
|
+
* @param {string | null} [code] Authorization code provided by Discord on successful approval
|
|
1524
|
+
* @param {string | null} [error] Error code provided by Discord if the user denied access
|
|
1443
1525
|
* @param {*} [options] Override http request option.
|
|
1444
1526
|
* @throws {RequiredError}
|
|
1445
1527
|
*/
|
|
1446
|
-
|
|
1528
|
+
callback(code?: string | null, error?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1529
|
+
/**
|
|
1530
|
+
* Redirects the browser to Discord\'s OAuth2 authorization page. Not called directly — the admin frontend navigates to this URL to begin the login flow.
|
|
1531
|
+
* @summary Discord - Initiate login
|
|
1532
|
+
* @param {*} [options] Override http request option.
|
|
1533
|
+
* @throws {RequiredError}
|
|
1534
|
+
*/
|
|
1535
|
+
initiateLogin(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1536
|
+
/**
|
|
1537
|
+
* 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
|
+
* @summary Service - Exchange client credentials for token
|
|
1539
|
+
* @param {string | null} [grantType]
|
|
1540
|
+
* @param {string | null} [clientId]
|
|
1541
|
+
* @param {string | null} [clientSecret]
|
|
1542
|
+
* @param {*} [options] Override http request option.
|
|
1543
|
+
* @throws {RequiredError}
|
|
1544
|
+
*/
|
|
1545
|
+
token(grantType?: string | null, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
1447
1546
|
}
|
|
1448
1547
|
/**
|
|
1449
|
-
*
|
|
1548
|
+
* ChatApi - axios parameter creator
|
|
1450
1549
|
*/
|
|
1451
|
-
export declare const
|
|
1550
|
+
export declare const ChatApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1452
1551
|
/**
|
|
1453
|
-
*
|
|
1454
|
-
* @
|
|
1455
|
-
* @param {
|
|
1552
|
+
* Returns up to `limit` chat messages before the given `before` timestamp (keyset pagination). Results are returned in ascending chronological order. Omit `before` to start from the current time. Scroll back through history by passing the `sentAt` of the oldest message received as the next `before` value.
|
|
1553
|
+
* @summary Get chat history
|
|
1554
|
+
* @param {number} limit Maximum number of messages to return (1–100)
|
|
1555
|
+
* @param {string | null} [sessionId] Filter to a specific server session. Omit for global history.
|
|
1556
|
+
* @param {string | null} [before] ISO-8601 timestamp cursor — return messages sent before this time. Omit to start from now.
|
|
1456
1557
|
* @param {*} [options] Override http request option.
|
|
1457
1558
|
* @throws {RequiredError}
|
|
1458
1559
|
*/
|
|
1459
|
-
|
|
1560
|
+
history: (limit: number, sessionId?: string | null, before?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1460
1561
|
/**
|
|
1461
|
-
*
|
|
1562
|
+
* Stores a chat message from a game server and fans it out to all connected WebSocket clients via PostgreSQL LISTEN/NOTIFY. The session must be currently online. Only the player UUID is stored — usernames are resolved on the web UI from the player database cache.
|
|
1563
|
+
* @summary Ingest a chat message
|
|
1564
|
+
* @param {ChatMessageRequest} chatMessageRequest
|
|
1462
1565
|
* @param {*} [options] Override http request option.
|
|
1463
1566
|
* @throws {RequiredError}
|
|
1464
1567
|
*/
|
|
1465
|
-
|
|
1568
|
+
ingest: (chatMessageRequest: ChatMessageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1569
|
+
};
|
|
1570
|
+
/**
|
|
1571
|
+
* ChatApi - functional programming interface
|
|
1572
|
+
*/
|
|
1573
|
+
export declare const ChatApiFp: (configuration?: Configuration) => {
|
|
1574
|
+
/**
|
|
1575
|
+
* Returns up to `limit` chat messages before the given `before` timestamp (keyset pagination). Results are returned in ascending chronological order. Omit `before` to start from the current time. Scroll back through history by passing the `sentAt` of the oldest message received as the next `before` value.
|
|
1576
|
+
* @summary Get chat history
|
|
1577
|
+
* @param {number} limit Maximum number of messages to return (1–100)
|
|
1578
|
+
* @param {string | null} [sessionId] Filter to a specific server session. Omit for global history.
|
|
1579
|
+
* @param {string | null} [before] ISO-8601 timestamp cursor — return messages sent before this time. Omit to start from now.
|
|
1580
|
+
* @param {*} [options] Override http request option.
|
|
1581
|
+
* @throws {RequiredError}
|
|
1582
|
+
*/
|
|
1583
|
+
history(limit: number, sessionId?: string | null, before?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ChatMessageDTO>>>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Stores a chat message from a game server and fans it out to all connected WebSocket clients via PostgreSQL LISTEN/NOTIFY. The session must be currently online. Only the player UUID is stored — usernames are resolved on the web UI from the player database cache.
|
|
1586
|
+
* @summary Ingest a chat message
|
|
1587
|
+
* @param {ChatMessageRequest} chatMessageRequest
|
|
1588
|
+
* @param {*} [options] Override http request option.
|
|
1589
|
+
* @throws {RequiredError}
|
|
1590
|
+
*/
|
|
1591
|
+
ingest(chatMessageRequest: ChatMessageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatMessageDTO>>;
|
|
1466
1592
|
};
|
|
1467
1593
|
/**
|
|
1468
|
-
*
|
|
1594
|
+
* ChatApi - factory interface
|
|
1469
1595
|
*/
|
|
1470
|
-
export declare const
|
|
1596
|
+
export declare const ChatApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1471
1597
|
/**
|
|
1472
|
-
*
|
|
1473
|
-
* @
|
|
1474
|
-
* @param {
|
|
1598
|
+
* Returns up to `limit` chat messages before the given `before` timestamp (keyset pagination). Results are returned in ascending chronological order. Omit `before` to start from the current time. Scroll back through history by passing the `sentAt` of the oldest message received as the next `before` value.
|
|
1599
|
+
* @summary Get chat history
|
|
1600
|
+
* @param {number} limit Maximum number of messages to return (1–100)
|
|
1601
|
+
* @param {string | null} [sessionId] Filter to a specific server session. Omit for global history.
|
|
1602
|
+
* @param {string | null} [before] ISO-8601 timestamp cursor — return messages sent before this time. Omit to start from now.
|
|
1475
1603
|
* @param {*} [options] Override http request option.
|
|
1476
1604
|
* @throws {RequiredError}
|
|
1477
1605
|
*/
|
|
1478
|
-
|
|
1606
|
+
history(limit: number, sessionId?: string | null, before?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<ChatMessageDTO>>;
|
|
1479
1607
|
/**
|
|
1480
|
-
*
|
|
1608
|
+
* Stores a chat message from a game server and fans it out to all connected WebSocket clients via PostgreSQL LISTEN/NOTIFY. The session must be currently online. Only the player UUID is stored — usernames are resolved on the web UI from the player database cache.
|
|
1609
|
+
* @summary Ingest a chat message
|
|
1610
|
+
* @param {ChatMessageRequest} chatMessageRequest
|
|
1481
1611
|
* @param {*} [options] Override http request option.
|
|
1482
1612
|
* @throws {RequiredError}
|
|
1483
1613
|
*/
|
|
1484
|
-
|
|
1614
|
+
ingest(chatMessageRequest: ChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatMessageDTO>;
|
|
1485
1615
|
};
|
|
1486
1616
|
/**
|
|
1487
|
-
*
|
|
1617
|
+
* ChatApi - object-oriented interface
|
|
1618
|
+
*/
|
|
1619
|
+
export declare class ChatApi extends BaseAPI {
|
|
1620
|
+
/**
|
|
1621
|
+
* Returns up to `limit` chat messages before the given `before` timestamp (keyset pagination). Results are returned in ascending chronological order. Omit `before` to start from the current time. Scroll back through history by passing the `sentAt` of the oldest message received as the next `before` value.
|
|
1622
|
+
* @summary Get chat history
|
|
1623
|
+
* @param {number} limit Maximum number of messages to return (1–100)
|
|
1624
|
+
* @param {string | null} [sessionId] Filter to a specific server session. Omit for global history.
|
|
1625
|
+
* @param {string | null} [before] ISO-8601 timestamp cursor — return messages sent before this time. Omit to start from now.
|
|
1626
|
+
* @param {*} [options] Override http request option.
|
|
1627
|
+
* @throws {RequiredError}
|
|
1628
|
+
*/
|
|
1629
|
+
history(limit: number, sessionId?: string | null, before?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatMessageDTO[], any, {}>>;
|
|
1630
|
+
/**
|
|
1631
|
+
* Stores a chat message from a game server and fans it out to all connected WebSocket clients via PostgreSQL LISTEN/NOTIFY. The session must be currently online. Only the player UUID is stored — usernames are resolved on the web UI from the player database cache.
|
|
1632
|
+
* @summary Ingest a chat message
|
|
1633
|
+
* @param {ChatMessageRequest} chatMessageRequest
|
|
1634
|
+
* @param {*} [options] Override http request option.
|
|
1635
|
+
* @throws {RequiredError}
|
|
1636
|
+
*/
|
|
1637
|
+
ingest(chatMessageRequest: ChatMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatMessageDTO, any, {}>>;
|
|
1638
|
+
}
|
|
1639
|
+
/**
|
|
1640
|
+
* ConnectionApi - axios parameter creator
|
|
1488
1641
|
*/
|
|
1489
|
-
export declare const
|
|
1642
|
+
export declare const ConnectionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1490
1643
|
/**
|
|
1491
|
-
*
|
|
1492
|
-
* @
|
|
1493
|
-
* @param {string
|
|
1644
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
1645
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
1646
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
1647
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
1648
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1494
1649
|
* @param {*} [options] Override http request option.
|
|
1495
1650
|
* @throws {RequiredError}
|
|
1496
1651
|
*/
|
|
1497
|
-
|
|
1652
|
+
getConnectionDetails: (ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1653
|
+
};
|
|
1654
|
+
/**
|
|
1655
|
+
* ConnectionApi - functional programming interface
|
|
1656
|
+
*/
|
|
1657
|
+
export declare const ConnectionApiFp: (configuration?: Configuration) => {
|
|
1498
1658
|
/**
|
|
1499
|
-
*
|
|
1659
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
1660
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
1661
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
1662
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
1663
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1500
1664
|
* @param {*} [options] Override http request option.
|
|
1501
1665
|
* @throws {RequiredError}
|
|
1502
1666
|
*/
|
|
1503
|
-
|
|
1667
|
+
getConnectionDetails(ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionGetConnectionDetailsResponse>>;
|
|
1504
1668
|
};
|
|
1505
1669
|
/**
|
|
1506
|
-
*
|
|
1670
|
+
* ConnectionApi - factory interface
|
|
1507
1671
|
*/
|
|
1508
|
-
export declare
|
|
1672
|
+
export declare const ConnectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1509
1673
|
/**
|
|
1510
|
-
*
|
|
1511
|
-
* @
|
|
1512
|
-
* @param {string
|
|
1674
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
1675
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
1676
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
1677
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
1678
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1513
1679
|
* @param {*} [options] Override http request option.
|
|
1514
1680
|
* @throws {RequiredError}
|
|
1515
1681
|
*/
|
|
1516
|
-
|
|
1682
|
+
getConnectionDetails(ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionGetConnectionDetailsResponse>;
|
|
1683
|
+
};
|
|
1684
|
+
/**
|
|
1685
|
+
* ConnectionApi - object-oriented interface
|
|
1686
|
+
*/
|
|
1687
|
+
export declare class ConnectionApi extends BaseAPI {
|
|
1517
1688
|
/**
|
|
1518
|
-
*
|
|
1689
|
+
* Performs comprehensive analysis of an IPv4 address to detect VPN, proxy, or suspicious connections. **Features:** - Multi-provider VPN/proxy detection with aggregated confidence scoring - Approximate geolocation lookup (city and country) - Connection bypass status and expiration tracking - Optional player UUID association for connection history **Use Cases:** - Prevent VPN/proxy usage during player authentication - Track player connection history across sessions - Implement temporary bypass systems for false positives - Monitor suspicious connection patterns **Query Parameters:** - `force_recheck`: Bypass cache and re-run all detection services - `associate_uuid`: Link this IP to a player UUID and return player info **Caching:** Results are cached unless `force_recheck=true` is specified, reducing API costs and improving response times.
|
|
1690
|
+
* @summary Check Connection and Detect VPN/Proxy
|
|
1691
|
+
* @param {string} ip IPv4 address to analyze for VPN/proxy detection and geolocation
|
|
1692
|
+
* @param {boolean} forceRecheck When true, bypasses cached results and re-runs all VPN detection services. Use this when you need the most up-to-date analysis or suspect cached data may be stale. Default: false
|
|
1693
|
+
* @param {string | null} [associateUuid] Minecraft player UUID to associate with this IP address. When provided, the API will: - Link this connection to the player\'s history - Update the player\'s username from Mojang API - Return player information (first join status, first login time) in the response - Track connection history for fraud detection This operation is asynchronous and won\'t block the response.
|
|
1519
1694
|
* @param {*} [options] Override http request option.
|
|
1520
1695
|
* @throws {RequiredError}
|
|
1521
1696
|
*/
|
|
1522
|
-
|
|
1697
|
+
getConnectionDetails(ip: string, forceRecheck: boolean, associateUuid?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConnectionGetConnectionDetailsResponse, any, {}>>;
|
|
1523
1698
|
}
|
|
1524
1699
|
/**
|
|
1525
1700
|
* PlayerApi - axios parameter creator
|
|
@@ -1527,12 +1702,20 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1527
1702
|
export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1528
1703
|
/**
|
|
1529
1704
|
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
1530
|
-
* @summary Get
|
|
1705
|
+
* @summary Get player information
|
|
1531
1706
|
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
1532
1707
|
* @param {*} [options] Override http request option.
|
|
1533
1708
|
* @throws {RequiredError}
|
|
1534
1709
|
*/
|
|
1535
1710
|
getPlayer1: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1711
|
+
/**
|
|
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 (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
|
|
1713
|
+
* @summary Batch resolve UUIDs to usernames
|
|
1714
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
|
|
1715
|
+
* @param {*} [options] Override http request option.
|
|
1716
|
+
* @throws {RequiredError}
|
|
1717
|
+
*/
|
|
1718
|
+
getUsernames: (uuids: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1536
1719
|
};
|
|
1537
1720
|
/**
|
|
1538
1721
|
* PlayerApi - functional programming interface
|
|
@@ -1540,12 +1723,20 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1540
1723
|
export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
1541
1724
|
/**
|
|
1542
1725
|
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
1543
|
-
* @summary Get
|
|
1726
|
+
* @summary Get player information
|
|
1544
1727
|
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
1545
1728
|
* @param {*} [options] Override http request option.
|
|
1546
1729
|
* @throws {RequiredError}
|
|
1547
1730
|
*/
|
|
1548
1731
|
getPlayer1(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerGetPlayerInformation>>;
|
|
1732
|
+
/**
|
|
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 (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
|
|
1734
|
+
* @summary Batch resolve UUIDs to usernames
|
|
1735
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
|
|
1736
|
+
* @param {*} [options] Override http request option.
|
|
1737
|
+
* @throws {RequiredError}
|
|
1738
|
+
*/
|
|
1739
|
+
getUsernames(uuids: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1549
1740
|
};
|
|
1550
1741
|
/**
|
|
1551
1742
|
* PlayerApi - factory interface
|
|
@@ -1553,12 +1744,20 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
|
1553
1744
|
export declare const PlayerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1554
1745
|
/**
|
|
1555
1746
|
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
1556
|
-
* @summary Get
|
|
1747
|
+
* @summary Get player information
|
|
1557
1748
|
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
1558
1749
|
* @param {*} [options] Override http request option.
|
|
1559
1750
|
* @throws {RequiredError}
|
|
1560
1751
|
*/
|
|
1561
1752
|
getPlayer1(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerGetPlayerInformation>;
|
|
1753
|
+
/**
|
|
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 (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
|
|
1755
|
+
* @summary Batch resolve UUIDs to usernames
|
|
1756
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
|
|
1757
|
+
* @param {*} [options] Override http request option.
|
|
1758
|
+
* @throws {RequiredError}
|
|
1759
|
+
*/
|
|
1760
|
+
getUsernames(uuids: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1562
1761
|
};
|
|
1563
1762
|
/**
|
|
1564
1763
|
* PlayerApi - object-oriented interface
|
|
@@ -1566,12 +1765,20 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
|
|
|
1566
1765
|
export declare class PlayerApi extends BaseAPI {
|
|
1567
1766
|
/**
|
|
1568
1767
|
* Retrieves player information by their Minecraft UUID. Returns whether this is the player\'s first join and their first login timestamp. This endpoint is useful for tracking player join history and implementing first-join rewards or tutorials.
|
|
1569
|
-
* @summary Get
|
|
1768
|
+
* @summary Get player information
|
|
1570
1769
|
* @param {string} uuid The Minecraft player UUID (with or without dashes)
|
|
1571
1770
|
* @param {*} [options] Override http request option.
|
|
1572
1771
|
* @throws {RequiredError}
|
|
1573
1772
|
*/
|
|
1574
1773
|
getPlayer1(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerGetPlayerInformation, any, {}>>;
|
|
1774
|
+
/**
|
|
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 (e.g. players who have never joined) are omitted from the response. Used by the web UI to display player names in the chat log.
|
|
1776
|
+
* @summary Batch resolve UUIDs to usernames
|
|
1777
|
+
* @param {Array<string>} uuids List of player UUIDs to resolve (repeatable query param)
|
|
1778
|
+
* @param {*} [options] Override http request option.
|
|
1779
|
+
* @throws {RequiredError}
|
|
1780
|
+
*/
|
|
1781
|
+
getUsernames(uuids: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1575
1782
|
}
|
|
1576
1783
|
/**
|
|
1577
1784
|
* PunishmentApi - axios parameter creator
|
|
@@ -1761,3 +1968,175 @@ export declare class PunishmentApi extends BaseAPI {
|
|
|
1761
1968
|
*/
|
|
1762
1969
|
getRecentPunishments(limit: number, page: number, issuedAfter?: number | null, issuedBefore?: number | null, expiresAfter?: number | null, expiresBefore?: number | null, type?: Array<string> | null, uuid?: string | null, ipAddress?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PunishmentGetPunishmentResponse[], any, {}>>;
|
|
1763
1970
|
}
|
|
1971
|
+
/**
|
|
1972
|
+
* ServerSessionsApi - axios parameter creator
|
|
1973
|
+
*/
|
|
1974
|
+
export declare const ServerSessionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1975
|
+
/**
|
|
1976
|
+
* Updates the `last_heartbeat` timestamp for the given session, keeping it marked as online. Sessions that miss heartbeats for more than 2 minutes are automatically tombstoned by the scheduler. Call this every 30 seconds from the game server.
|
|
1977
|
+
* @summary Send a heartbeat
|
|
1978
|
+
* @param {string} id Session UUID returned from the registration call
|
|
1979
|
+
* @param {*} [options] Override http request option.
|
|
1980
|
+
* @throws {RequiredError}
|
|
1981
|
+
*/
|
|
1982
|
+
heartbeat: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1983
|
+
/**
|
|
1984
|
+
* Returns all server sessions — both online and historical — ordered by start time descending. Used by the web UI to populate the session filter dropdown.
|
|
1985
|
+
* @summary List all server sessions
|
|
1986
|
+
* @param {*} [options] Override http request option.
|
|
1987
|
+
* @throws {RequiredError}
|
|
1988
|
+
*/
|
|
1989
|
+
listAll: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1990
|
+
/**
|
|
1991
|
+
* Returns all currently online server sessions, ordered by start time descending.
|
|
1992
|
+
* @summary List online server sessions
|
|
1993
|
+
* @param {*} [options] Override http request option.
|
|
1994
|
+
* @throws {RequiredError}
|
|
1995
|
+
*/
|
|
1996
|
+
listOnline: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1997
|
+
/**
|
|
1998
|
+
* Marks the session as offline with the current timestamp as `endedAt`. Call this from the game server\'s shutdown hook for a clean shutdown signal. Sessions that crash without calling this endpoint will be tombstoned automatically by the 2-minute heartbeat scheduler.
|
|
1999
|
+
* @summary Mark a session offline
|
|
2000
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2001
|
+
* @param {*} [options] Override http request option.
|
|
2002
|
+
* @throws {RequiredError}
|
|
2003
|
+
*/
|
|
2004
|
+
markOffline: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2005
|
+
/**
|
|
2006
|
+
* Registers a game server instance and returns a session ID used for subsequent heartbeats and chat ingestion. If a `containerId` is provided and an online session already exists for that container (e.g. after a Velocity restart), the existing session is returned unchanged. Otherwise a fresh session is created with an auto-generated instance name.
|
|
2007
|
+
* @summary Register a server session
|
|
2008
|
+
* @param {ServerRegisterRequest} serverRegisterRequest
|
|
2009
|
+
* @param {*} [options] Override http request option.
|
|
2010
|
+
* @throws {RequiredError}
|
|
2011
|
+
*/
|
|
2012
|
+
register: (serverRegisterRequest: ServerRegisterRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2013
|
+
};
|
|
2014
|
+
/**
|
|
2015
|
+
* ServerSessionsApi - functional programming interface
|
|
2016
|
+
*/
|
|
2017
|
+
export declare const ServerSessionsApiFp: (configuration?: Configuration) => {
|
|
2018
|
+
/**
|
|
2019
|
+
* Updates the `last_heartbeat` timestamp for the given session, keeping it marked as online. Sessions that miss heartbeats for more than 2 minutes are automatically tombstoned by the scheduler. Call this every 30 seconds from the game server.
|
|
2020
|
+
* @summary Send a heartbeat
|
|
2021
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2022
|
+
* @param {*} [options] Override http request option.
|
|
2023
|
+
* @throws {RequiredError}
|
|
2024
|
+
*/
|
|
2025
|
+
heartbeat(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2026
|
+
/**
|
|
2027
|
+
* Returns all server sessions — both online and historical — ordered by start time descending. Used by the web UI to populate the session filter dropdown.
|
|
2028
|
+
* @summary List all server sessions
|
|
2029
|
+
* @param {*} [options] Override http request option.
|
|
2030
|
+
* @throws {RequiredError}
|
|
2031
|
+
*/
|
|
2032
|
+
listAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServerSessionDTO>>>;
|
|
2033
|
+
/**
|
|
2034
|
+
* Returns all currently online server sessions, ordered by start time descending.
|
|
2035
|
+
* @summary List online server sessions
|
|
2036
|
+
* @param {*} [options] Override http request option.
|
|
2037
|
+
* @throws {RequiredError}
|
|
2038
|
+
*/
|
|
2039
|
+
listOnline(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServerSessionDTO>>>;
|
|
2040
|
+
/**
|
|
2041
|
+
* Marks the session as offline with the current timestamp as `endedAt`. Call this from the game server\'s shutdown hook for a clean shutdown signal. Sessions that crash without calling this endpoint will be tombstoned automatically by the 2-minute heartbeat scheduler.
|
|
2042
|
+
* @summary Mark a session offline
|
|
2043
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2044
|
+
* @param {*} [options] Override http request option.
|
|
2045
|
+
* @throws {RequiredError}
|
|
2046
|
+
*/
|
|
2047
|
+
markOffline(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2048
|
+
/**
|
|
2049
|
+
* Registers a game server instance and returns a session ID used for subsequent heartbeats and chat ingestion. If a `containerId` is provided and an online session already exists for that container (e.g. after a Velocity restart), the existing session is returned unchanged. Otherwise a fresh session is created with an auto-generated instance name.
|
|
2050
|
+
* @summary Register a server session
|
|
2051
|
+
* @param {ServerRegisterRequest} serverRegisterRequest
|
|
2052
|
+
* @param {*} [options] Override http request option.
|
|
2053
|
+
* @throws {RequiredError}
|
|
2054
|
+
*/
|
|
2055
|
+
register(serverRegisterRequest: ServerRegisterRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerSessionDTO>>;
|
|
2056
|
+
};
|
|
2057
|
+
/**
|
|
2058
|
+
* ServerSessionsApi - factory interface
|
|
2059
|
+
*/
|
|
2060
|
+
export declare const ServerSessionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2061
|
+
/**
|
|
2062
|
+
* Updates the `last_heartbeat` timestamp for the given session, keeping it marked as online. Sessions that miss heartbeats for more than 2 minutes are automatically tombstoned by the scheduler. Call this every 30 seconds from the game server.
|
|
2063
|
+
* @summary Send a heartbeat
|
|
2064
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2065
|
+
* @param {*} [options] Override http request option.
|
|
2066
|
+
* @throws {RequiredError}
|
|
2067
|
+
*/
|
|
2068
|
+
heartbeat(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2069
|
+
/**
|
|
2070
|
+
* Returns all server sessions — both online and historical — ordered by start time descending. Used by the web UI to populate the session filter dropdown.
|
|
2071
|
+
* @summary List all server sessions
|
|
2072
|
+
* @param {*} [options] Override http request option.
|
|
2073
|
+
* @throws {RequiredError}
|
|
2074
|
+
*/
|
|
2075
|
+
listAll(options?: RawAxiosRequestConfig): AxiosPromise<Array<ServerSessionDTO>>;
|
|
2076
|
+
/**
|
|
2077
|
+
* Returns all currently online server sessions, ordered by start time descending.
|
|
2078
|
+
* @summary List online server sessions
|
|
2079
|
+
* @param {*} [options] Override http request option.
|
|
2080
|
+
* @throws {RequiredError}
|
|
2081
|
+
*/
|
|
2082
|
+
listOnline(options?: RawAxiosRequestConfig): AxiosPromise<Array<ServerSessionDTO>>;
|
|
2083
|
+
/**
|
|
2084
|
+
* Marks the session as offline with the current timestamp as `endedAt`. Call this from the game server\'s shutdown hook for a clean shutdown signal. Sessions that crash without calling this endpoint will be tombstoned automatically by the 2-minute heartbeat scheduler.
|
|
2085
|
+
* @summary Mark a session offline
|
|
2086
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2087
|
+
* @param {*} [options] Override http request option.
|
|
2088
|
+
* @throws {RequiredError}
|
|
2089
|
+
*/
|
|
2090
|
+
markOffline(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2091
|
+
/**
|
|
2092
|
+
* Registers a game server instance and returns a session ID used for subsequent heartbeats and chat ingestion. If a `containerId` is provided and an online session already exists for that container (e.g. after a Velocity restart), the existing session is returned unchanged. Otherwise a fresh session is created with an auto-generated instance name.
|
|
2093
|
+
* @summary Register a server session
|
|
2094
|
+
* @param {ServerRegisterRequest} serverRegisterRequest
|
|
2095
|
+
* @param {*} [options] Override http request option.
|
|
2096
|
+
* @throws {RequiredError}
|
|
2097
|
+
*/
|
|
2098
|
+
register(serverRegisterRequest: ServerRegisterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ServerSessionDTO>;
|
|
2099
|
+
};
|
|
2100
|
+
/**
|
|
2101
|
+
* ServerSessionsApi - object-oriented interface
|
|
2102
|
+
*/
|
|
2103
|
+
export declare class ServerSessionsApi extends BaseAPI {
|
|
2104
|
+
/**
|
|
2105
|
+
* Updates the `last_heartbeat` timestamp for the given session, keeping it marked as online. Sessions that miss heartbeats for more than 2 minutes are automatically tombstoned by the scheduler. Call this every 30 seconds from the game server.
|
|
2106
|
+
* @summary Send a heartbeat
|
|
2107
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2108
|
+
* @param {*} [options] Override http request option.
|
|
2109
|
+
* @throws {RequiredError}
|
|
2110
|
+
*/
|
|
2111
|
+
heartbeat(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2112
|
+
/**
|
|
2113
|
+
* Returns all server sessions — both online and historical — ordered by start time descending. Used by the web UI to populate the session filter dropdown.
|
|
2114
|
+
* @summary List all server sessions
|
|
2115
|
+
* @param {*} [options] Override http request option.
|
|
2116
|
+
* @throws {RequiredError}
|
|
2117
|
+
*/
|
|
2118
|
+
listAll(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerSessionDTO[], any, {}>>;
|
|
2119
|
+
/**
|
|
2120
|
+
* Returns all currently online server sessions, ordered by start time descending.
|
|
2121
|
+
* @summary List online server sessions
|
|
2122
|
+
* @param {*} [options] Override http request option.
|
|
2123
|
+
* @throws {RequiredError}
|
|
2124
|
+
*/
|
|
2125
|
+
listOnline(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerSessionDTO[], any, {}>>;
|
|
2126
|
+
/**
|
|
2127
|
+
* Marks the session as offline with the current timestamp as `endedAt`. Call this from the game server\'s shutdown hook for a clean shutdown signal. Sessions that crash without calling this endpoint will be tombstoned automatically by the 2-minute heartbeat scheduler.
|
|
2128
|
+
* @summary Mark a session offline
|
|
2129
|
+
* @param {string} id Session UUID returned from the registration call
|
|
2130
|
+
* @param {*} [options] Override http request option.
|
|
2131
|
+
* @throws {RequiredError}
|
|
2132
|
+
*/
|
|
2133
|
+
markOffline(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2134
|
+
/**
|
|
2135
|
+
* Registers a game server instance and returns a session ID used for subsequent heartbeats and chat ingestion. If a `containerId` is provided and an online session already exists for that container (e.g. after a Velocity restart), the existing session is returned unchanged. Otherwise a fresh session is created with an auto-generated instance name.
|
|
2136
|
+
* @summary Register a server session
|
|
2137
|
+
* @param {ServerRegisterRequest} serverRegisterRequest
|
|
2138
|
+
* @param {*} [options] Override http request option.
|
|
2139
|
+
* @throws {RequiredError}
|
|
2140
|
+
*/
|
|
2141
|
+
register(serverRegisterRequest: ServerRegisterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerSessionDTO, any, {}>>;
|
|
2142
|
+
}
|