@rebornteam/reborn-api 2.5.1 → 2.6.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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +18 -6
  3. package/api.ts +881 -67
  4. package/base.ts +2 -2
  5. package/common.ts +2 -2
  6. package/configuration.ts +2 -2
  7. package/dist/api.d.ts +480 -10
  8. package/dist/api.js +639 -38
  9. package/dist/base.d.ts +2 -2
  10. package/dist/base.js +2 -2
  11. package/dist/common.d.ts +2 -2
  12. package/dist/common.js +2 -2
  13. package/dist/configuration.d.ts +2 -2
  14. package/dist/configuration.js +2 -2
  15. package/dist/esm/api.d.ts +480 -10
  16. package/dist/esm/api.js +626 -37
  17. package/dist/esm/base.d.ts +2 -2
  18. package/dist/esm/base.js +2 -2
  19. package/dist/esm/common.d.ts +2 -2
  20. package/dist/esm/common.js +2 -2
  21. package/dist/esm/configuration.d.ts +2 -2
  22. package/dist/esm/configuration.js +2 -2
  23. package/dist/esm/index.d.ts +2 -2
  24. package/dist/esm/index.js +2 -2
  25. package/dist/index.d.ts +2 -2
  26. package/dist/index.js +2 -2
  27. package/docs/AdminClientCredentialResponse.md +2 -0
  28. package/docs/AdminClientCredentialsApi.md +17 -17
  29. package/docs/AdminConnectionsApi.md +70 -4
  30. package/docs/AdminDashboardApi.md +2 -2
  31. package/docs/AdminPagedConnectionResponse.md +29 -0
  32. package/docs/AdminPagedPlayerResponse.md +29 -0
  33. package/docs/AdminPagedPunishmentResponse.md +29 -0
  34. package/docs/AdminPlayerDetailResponse.md +37 -0
  35. package/docs/AdminPlayerSummary.md +35 -0
  36. package/docs/AdminPlayersApi.md +122 -0
  37. package/docs/AdminPunishmentsApi.md +82 -0
  38. package/docs/AdminUsernameHistoryEntry.md +23 -0
  39. package/docs/ClientCredentialRequest.md +2 -0
  40. package/docs/ConnectionApi.md +1 -1
  41. package/docs/DefaultApi.md +105 -0
  42. package/docs/PlayerApi.md +5 -5
  43. package/docs/PunishmentApi.md +10 -10
  44. package/index.ts +2 -2
  45. package/package.json +2 -2
@@ -0,0 +1,122 @@
1
+ # AdminPlayersApi
2
+
3
+ All URIs are relative to *https://api.smsh.sh*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getPlayer**](#getplayer) | **GET** /admin/player/{uuid} | Get player detail|
8
+ |[**listPlayers**](#listplayers) | **GET** /admin/player | List players|
9
+
10
+ # **getPlayer**
11
+ > AdminPlayerDetailResponse getPlayer()
12
+
13
+ Returns full detail for a single player including all known usernames and punishment scoring.
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ AdminPlayersApi,
20
+ Configuration
21
+ } from '@rebornteam/reborn-api';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new AdminPlayersApi(configuration);
25
+
26
+ let uuid: string; //Player Minecraft UUID (default to undefined)
27
+
28
+ const { status, data } = await apiInstance.getPlayer(
29
+ uuid
30
+ );
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **uuid** | [**string**] | Player Minecraft UUID | defaults to undefined|
38
+
39
+
40
+ ### Return type
41
+
42
+ **AdminPlayerDetailResponse**
43
+
44
+ ### Authorization
45
+
46
+ [DiscordAuth](../README.md#DiscordAuth)
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: Not defined
51
+ - **Accept**: application/json
52
+
53
+
54
+ ### HTTP response details
55
+ | Status code | Description | Response headers |
56
+ |-------------|-------------|------------------|
57
+ |**200** | Player detail retrieved successfully | - |
58
+ |**404** | Player not found | - |
59
+ |**401** | Unauthorized | - |
60
+ |**403** | Forbidden - Administrator role required | - |
61
+
62
+ [[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)
63
+
64
+ # **listPlayers**
65
+ > AdminPagedPlayerResponse listPlayers()
66
+
67
+ Returns up to 500 players ordered by most recently seen. Optionally filter by UUID or username substring.
68
+
69
+ ### Example
70
+
71
+ ```typescript
72
+ import {
73
+ AdminPlayersApi,
74
+ Configuration
75
+ } from '@rebornteam/reborn-api';
76
+
77
+ const configuration = new Configuration();
78
+ const apiInstance = new AdminPlayersApi(configuration);
79
+
80
+ let page: number; //Page number (1-indexed) (default to 1)
81
+ let limit: number; //Page size (default to 50)
82
+ let search: string; //Optional search string matched against UUID or username (case-insensitive substring) (optional) (default to undefined)
83
+
84
+ const { status, data } = await apiInstance.listPlayers(
85
+ page,
86
+ limit,
87
+ search
88
+ );
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ |Name | Type | Description | Notes|
94
+ |------------- | ------------- | ------------- | -------------|
95
+ | **page** | [**number**] | Page number (1-indexed) | defaults to 1|
96
+ | **limit** | [**number**] | Page size | defaults to 50|
97
+ | **search** | [**string**] | Optional search string matched against UUID or username (case-insensitive substring) | (optional) defaults to undefined|
98
+
99
+
100
+ ### Return type
101
+
102
+ **AdminPagedPlayerResponse**
103
+
104
+ ### Authorization
105
+
106
+ [DiscordAuth](../README.md#DiscordAuth)
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: Not defined
111
+ - **Accept**: application/json
112
+
113
+
114
+ ### HTTP response details
115
+ | Status code | Description | Response headers |
116
+ |-------------|-------------|------------------|
117
+ |**200** | Player list retrieved successfully | - |
118
+ |**401** | Unauthorized | - |
119
+ |**403** | Forbidden - Administrator role required | - |
120
+
121
+ [[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)
122
+
@@ -0,0 +1,82 @@
1
+ # AdminPunishmentsApi
2
+
3
+ All URIs are relative to *https://api.smsh.sh*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getPunishments**](#getpunishments) | **GET** /admin/punishment | List punishments|
8
+
9
+ # **getPunishments**
10
+ > AdminPagedPunishmentResponse getPunishments()
11
+
12
+ Returns a paginated list of punishments with optional filtering by player UUID, username, IP address, type, and date range.
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ AdminPunishmentsApi,
19
+ Configuration
20
+ } from '@rebornteam/reborn-api';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new AdminPunishmentsApi(configuration);
24
+
25
+ let page: number; //Page number (1-indexed) (default to 1)
26
+ let limit: number; //Page size (default to 50)
27
+ let uuid: string; //Filter by player UUID (optional) (default to undefined)
28
+ let username: string; //Filter by player username (case-insensitive substring match) (optional) (default to undefined)
29
+ let ipAddress: string; //Filter by IP address (optional) (default to undefined)
30
+ let type: Array<string>; //Filter by punishment type (BAN, MUTE, KICK, WARNING). Repeatable. (optional) (default to undefined)
31
+ let issuedAfter: number; //Filter punishments issued after this epoch timestamp (ms) (optional) (default to undefined)
32
+ let issuedBefore: number; //Filter punishments issued before this epoch timestamp (ms) (optional) (default to undefined)
33
+
34
+ const { status, data } = await apiInstance.getPunishments(
35
+ page,
36
+ limit,
37
+ uuid,
38
+ username,
39
+ ipAddress,
40
+ type,
41
+ issuedAfter,
42
+ issuedBefore
43
+ );
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ |Name | Type | Description | Notes|
49
+ |------------- | ------------- | ------------- | -------------|
50
+ | **page** | [**number**] | Page number (1-indexed) | defaults to 1|
51
+ | **limit** | [**number**] | Page size | defaults to 50|
52
+ | **uuid** | [**string**] | Filter by player UUID | (optional) defaults to undefined|
53
+ | **username** | [**string**] | Filter by player username (case-insensitive substring match) | (optional) defaults to undefined|
54
+ | **ipAddress** | [**string**] | Filter by IP address | (optional) defaults to undefined|
55
+ | **type** | **Array&lt;string&gt;** | Filter by punishment type (BAN, MUTE, KICK, WARNING). Repeatable. | (optional) defaults to undefined|
56
+ | **issuedAfter** | [**number**] | Filter punishments issued after this epoch timestamp (ms) | (optional) defaults to undefined|
57
+ | **issuedBefore** | [**number**] | Filter punishments issued before this epoch timestamp (ms) | (optional) defaults to undefined|
58
+
59
+
60
+ ### Return type
61
+
62
+ **AdminPagedPunishmentResponse**
63
+
64
+ ### Authorization
65
+
66
+ [DiscordAuth](../README.md#DiscordAuth)
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: Not defined
71
+ - **Accept**: application/json
72
+
73
+
74
+ ### HTTP response details
75
+ | Status code | Description | Response headers |
76
+ |-------------|-------------|------------------|
77
+ |**200** | Punishment list retrieved successfully | - |
78
+ |**401** | Unauthorized | - |
79
+ |**403** | Forbidden - Administrator role required | - |
80
+
81
+ [[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)
82
+
@@ -0,0 +1,23 @@
1
+ # AdminUsernameHistoryEntry
2
+
3
+ A single entry in a player\'s username history
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **username** | **string** | The username at this point in time | [optional] [default to undefined]
10
+ **changedAt** | **string** | When this username was first observed (ISO-8601) | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AdminUsernameHistoryEntry } from '@rebornteam/reborn-api';
16
+
17
+ const instance: AdminUsernameHistoryEntry = {
18
+ username,
19
+ changedAt,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **name** | **string** | Human-readable name for the client | [default to undefined]
10
10
  **description** | **string** | Optional description of the client\&#39;s purpose | [optional] [default to undefined]
11
+ **expiresAt** | **string** | Optional expiration timestamp (ISO-8601). Null means the credential never expires. | [optional] [default to undefined]
11
12
 
12
13
  ## Example
13
14
 
@@ -17,6 +18,7 @@ import { ClientCredentialRequest } from '@rebornteam/reborn-api';
17
18
  const instance: ClientCredentialRequest = {
18
19
  name,
19
20
  description,
21
+ expiresAt,
20
22
  };
21
23
  ```
22
24
 
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.getConnectionDetails(
48
48
 
49
49
  ### Authorization
50
50
 
51
- [CognitoAuth](../README.md#CognitoAuth)
51
+ [DiscordAuth](../README.md#DiscordAuth)
52
52
 
53
53
  ### HTTP request headers
54
54
 
@@ -0,0 +1,105 @@
1
+ # DefaultApi
2
+
3
+ All URIs are relative to *https://api.smsh.sh*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**callback**](#callback) | **GET** /auth/discord/callback | |
8
+ |[**initiateLogin**](#initiatelogin) | **GET** /auth/discord | |
9
+
10
+ # **callback**
11
+ > object callback()
12
+
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ DefaultApi,
19
+ Configuration
20
+ } from '@rebornteam/reborn-api';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new DefaultApi(configuration);
24
+
25
+ let code: string; // (optional) (default to undefined)
26
+ let error: string; // (optional) (default to undefined)
27
+
28
+ const { status, data } = await apiInstance.callback(
29
+ code,
30
+ error
31
+ );
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes|
37
+ |------------- | ------------- | ------------- | -------------|
38
+ | **code** | [**string**] | | (optional) defaults to undefined|
39
+ | **error** | [**string**] | | (optional) defaults to undefined|
40
+
41
+
42
+ ### Return type
43
+
44
+ **object**
45
+
46
+ ### Authorization
47
+
48
+ [DiscordAuth](../README.md#DiscordAuth)
49
+
50
+ ### HTTP request headers
51
+
52
+ - **Content-Type**: Not defined
53
+ - **Accept**: application/json
54
+
55
+
56
+ ### HTTP response details
57
+ | Status code | Description | Response headers |
58
+ |-------------|-------------|------------------|
59
+ |**200** | callback 200 response | - |
60
+
61
+ [[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)
62
+
63
+ # **initiateLogin**
64
+ > object initiateLogin()
65
+
66
+
67
+ ### Example
68
+
69
+ ```typescript
70
+ import {
71
+ DefaultApi,
72
+ Configuration
73
+ } from '@rebornteam/reborn-api';
74
+
75
+ const configuration = new Configuration();
76
+ const apiInstance = new DefaultApi(configuration);
77
+
78
+ const { status, data } = await apiInstance.initiateLogin();
79
+ ```
80
+
81
+ ### Parameters
82
+ This endpoint does not have any parameters.
83
+
84
+
85
+ ### Return type
86
+
87
+ **object**
88
+
89
+ ### Authorization
90
+
91
+ [DiscordAuth](../README.md#DiscordAuth)
92
+
93
+ ### HTTP request headers
94
+
95
+ - **Content-Type**: Not defined
96
+ - **Accept**: application/json
97
+
98
+
99
+ ### HTTP response details
100
+ | Status code | Description | Response headers |
101
+ |-------------|-------------|------------------|
102
+ |**200** | initiateLogin 200 response | - |
103
+
104
+ [[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)
105
+
package/docs/PlayerApi.md CHANGED
@@ -4,10 +4,10 @@ All URIs are relative to *https://api.smsh.sh*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getPlayer**](#getplayer) | **GET** /v1/player/{uuid} | Get Player Information|
7
+ |[**getPlayer1**](#getplayer1) | **GET** /v1/player/{uuid} | Get Player Information|
8
8
 
9
- # **getPlayer**
10
- > PlayerGetPlayerInformation getPlayer()
9
+ # **getPlayer1**
10
+ > PlayerGetPlayerInformation getPlayer1()
11
11
 
12
12
  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.
13
13
 
@@ -24,7 +24,7 @@ const apiInstance = new PlayerApi(configuration);
24
24
 
25
25
  let uuid: string; //The Minecraft player UUID (with or without dashes) (default to undefined)
26
26
 
27
- const { status, data } = await apiInstance.getPlayer(
27
+ const { status, data } = await apiInstance.getPlayer1(
28
28
  uuid
29
29
  );
30
30
  ```
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.getPlayer(
42
42
 
43
43
  ### Authorization
44
44
 
45
- [CognitoAuth](../README.md#CognitoAuth)
45
+ [DiscordAuth](../README.md#DiscordAuth)
46
46
 
47
47
  ### HTTP request headers
48
48
 
@@ -7,7 +7,7 @@ All URIs are relative to *https://api.smsh.sh*
7
7
  |[**applyPunishment**](#applypunishment) | **POST** /v1/punishment/apply | Apply a punishment|
8
8
  |[**createPunishmentDraft**](#createpunishmentdraft) | **POST** /v1/punishment/draft | Create a punishment draft|
9
9
  |[**getPunishmentSeverities**](#getpunishmentseverities) | **GET** /v1/punishment/severities | Get punishment severities|
10
- |[**getPunishments**](#getpunishments) | **GET** /v1/punishment | Get punishments by player|
10
+ |[**getPunishments1**](#getpunishments1) | **GET** /v1/punishment | Get punishments by player|
11
11
  |[**getPunishmentsByIp**](#getpunishmentsbyip) | **GET** /v1/punishment/ip | Get punishments by IP address|
12
12
  |[**getRecentPunishments**](#getrecentpunishments) | **GET** /v1/punishment/recent | List recent punishments|
13
13
 
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.applyPunishment(
48
48
 
49
49
  ### Authorization
50
50
 
51
- [CognitoAuth](../README.md#CognitoAuth)
51
+ [DiscordAuth](../README.md#DiscordAuth)
52
52
 
53
53
  ### HTTP request headers
54
54
 
@@ -100,7 +100,7 @@ const { status, data } = await apiInstance.createPunishmentDraft(
100
100
 
101
101
  ### Authorization
102
102
 
103
- [CognitoAuth](../README.md#CognitoAuth)
103
+ [DiscordAuth](../README.md#DiscordAuth)
104
104
 
105
105
  ### HTTP request headers
106
106
 
@@ -144,7 +144,7 @@ This endpoint does not have any parameters.
144
144
 
145
145
  ### Authorization
146
146
 
147
- [CognitoAuth](../README.md#CognitoAuth)
147
+ [DiscordAuth](../README.md#DiscordAuth)
148
148
 
149
149
  ### HTTP request headers
150
150
 
@@ -159,8 +159,8 @@ This endpoint does not have any parameters.
159
159
 
160
160
  [[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)
161
161
 
162
- # **getPunishments**
163
- > Array<PunishmentGetPunishmentResponse> getPunishments()
162
+ # **getPunishments1**
163
+ > Array<PunishmentGetPunishmentResponse> getPunishments1()
164
164
 
165
165
  Retrieve all active punishments for a player by UUID or username, optionally filtered by type and time
166
166
 
@@ -180,7 +180,7 @@ let username: string; //Player username (optional) (default to undefined)
180
180
  let type: Array<string>; //Filter by punishment types (optional) (default to undefined)
181
181
  let since: number; //Filter punishments created after this Unix epoch timestamp (milliseconds) (optional) (default to undefined)
182
182
 
183
- const { status, data } = await apiInstance.getPunishments(
183
+ const { status, data } = await apiInstance.getPunishments1(
184
184
  uuid,
185
185
  username,
186
186
  type,
@@ -204,7 +204,7 @@ const { status, data } = await apiInstance.getPunishments(
204
204
 
205
205
  ### Authorization
206
206
 
207
- [CognitoAuth](../README.md#CognitoAuth)
207
+ [DiscordAuth](../README.md#DiscordAuth)
208
208
 
209
209
  ### HTTP request headers
210
210
 
@@ -255,7 +255,7 @@ const { status, data } = await apiInstance.getPunishmentsByIp(
255
255
 
256
256
  ### Authorization
257
257
 
258
- [CognitoAuth](../README.md#CognitoAuth)
258
+ [DiscordAuth](../README.md#DiscordAuth)
259
259
 
260
260
  ### HTTP request headers
261
261
 
@@ -330,7 +330,7 @@ const { status, data } = await apiInstance.getRecentPunishments(
330
330
 
331
331
  ### Authorization
332
332
 
333
- [CognitoAuth](../README.md#CognitoAuth)
333
+ [DiscordAuth](../README.md#DiscordAuth)
334
334
 
335
335
  ### HTTP request headers
336
336
 
package/index.ts CHANGED
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Reborn API
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 - **Cognito Bearer Token**: For admin endpoints requiring AWS Cognito authentication
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: 2.5.1
7
+ * The version of the OpenAPI document: 2.6.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@rebornteam/reborn-api",
3
- "version": "2.5.1",
3
+ "version": "2.6.0",
4
4
  "description": "OpenAPI client for @rebornteam/reborn-api",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
7
7
  "type": "git",
8
- "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
8
+ "url": "git+https://github.com/Smash-Reborn/Reborn-API-Clients.git"
9
9
  },
10
10
  "keywords": [
11
11
  "axios",