@ughuuu/game_server 1.0.1001 → 1.0.1003

package/README.md

@@ -177,7 +177,7 @@ webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 }))
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.1001
+- API version: 1.0.1003
 - Package version: 1.0.0
 - Generator version: 7.23.0
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
@@ -438,45 +438,47 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [UghuuuGameServer.AcceptPartyInvite200Response](docs/AcceptPartyInvite200Response.md)
+ - [UghuuuGameServer.AcceptPartyInvite200ResponseMembersInner](docs/AcceptPartyInvite200ResponseMembersInner.md)
  - [UghuuuGameServer.AcceptPartyInviteRequest](docs/AcceptPartyInviteRequest.md)
  - [UghuuuGameServer.AdminCreateAchievementRequest](docs/AdminCreateAchievementRequest.md)
- - [UghuuuGameServer.AdminCreateKvEntry200Response](docs/AdminCreateKvEntry200Response.md)
- - [UghuuuGameServer.AdminCreateKvEntryRequest](docs/AdminCreateKvEntryRequest.md)
+ - [UghuuuGameServer.AdminCreateLeaderboard200Response](docs/AdminCreateLeaderboard200Response.md)
+ - [UghuuuGameServer.AdminCreateLeaderboard200ResponseData](docs/AdminCreateLeaderboard200ResponseData.md)
  - [UghuuuGameServer.AdminCreateLeaderboardRequest](docs/AdminCreateLeaderboardRequest.md)
- - [UghuuuGameServer.AdminCreateNotification400Response](docs/AdminCreateNotification400Response.md)
  - [UghuuuGameServer.AdminCreateNotificationRequest](docs/AdminCreateNotificationRequest.md)
- - [UghuuuGameServer.AdminEndLeaderboard200Response](docs/AdminEndLeaderboard200Response.md)
- - [UghuuuGameServer.AdminEndLeaderboard200ResponseData](docs/AdminEndLeaderboard200ResponseData.md)
+ - [UghuuuGameServer.AdminDeleteChatConversation200Response](docs/AdminDeleteChatConversation200Response.md)
+ - [UghuuuGameServer.AdminGrantAchievementRequest](docs/AdminGrantAchievementRequest.md)
  - [UghuuuGameServer.AdminIncrementAchievementRequest](docs/AdminIncrementAchievementRequest.md)
  - [UghuuuGameServer.AdminListAchievements200Response](docs/AdminListAchievements200Response.md)
+ - [UghuuuGameServer.AdminListAchievements200ResponseDataInner](docs/AdminListAchievements200ResponseDataInner.md)
  - [UghuuuGameServer.AdminListChatMessages200Response](docs/AdminListChatMessages200Response.md)
  - [UghuuuGameServer.AdminListChatMessages200ResponseDataInner](docs/AdminListChatMessages200ResponseDataInner.md)
  - [UghuuuGameServer.AdminListGroups200Response](docs/AdminListGroups200Response.md)
  - [UghuuuGameServer.AdminListKvEntries200Response](docs/AdminListKvEntries200Response.md)
- - [UghuuuGameServer.AdminListKvEntries200ResponseDataInner](docs/AdminListKvEntries200ResponseDataInner.md)
  - [UghuuuGameServer.AdminListLobbies200Response](docs/AdminListLobbies200Response.md)
  - [UghuuuGameServer.AdminListLobbies200ResponseDataInner](docs/AdminListLobbies200ResponseDataInner.md)
  - [UghuuuGameServer.AdminListNotifications200Response](docs/AdminListNotifications200Response.md)
  - [UghuuuGameServer.AdminListNotifications200ResponseDataInner](docs/AdminListNotifications200ResponseDataInner.md)
- - [UghuuuGameServer.AdminListNotifications200ResponseMeta](docs/AdminListNotifications200ResponseMeta.md)
  - [UghuuuGameServer.AdminListSessions200Response](docs/AdminListSessions200Response.md)
  - [UghuuuGameServer.AdminListSessions200ResponseDataInner](docs/AdminListSessions200ResponseDataInner.md)
  - [UghuuuGameServer.AdminRevokeAchievementRequest](docs/AdminRevokeAchievementRequest.md)
- - [UghuuuGameServer.AdminSubmitLeaderboardScore200Response](docs/AdminSubmitLeaderboardScore200Response.md)
- - [UghuuuGameServer.AdminSubmitLeaderboardScore200ResponseData](docs/AdminSubmitLeaderboardScore200ResponseData.md)
  - [UghuuuGameServer.AdminSubmitLeaderboardScoreRequest](docs/AdminSubmitLeaderboardScoreRequest.md)
- - [UghuuuGameServer.AdminUnlockAchievementRequest](docs/AdminUnlockAchievementRequest.md)
- - [UghuuuGameServer.AdminUpdateAchievement200Response](docs/AdminUpdateAchievement200Response.md)
  - [UghuuuGameServer.AdminUpdateAchievementRequest](docs/AdminUpdateAchievementRequest.md)
  - [UghuuuGameServer.AdminUpdateGroup200Response](docs/AdminUpdateGroup200Response.md)
  - [UghuuuGameServer.AdminUpdateGroupRequest](docs/AdminUpdateGroupRequest.md)
  - [UghuuuGameServer.AdminUpdateKvEntryRequest](docs/AdminUpdateKvEntryRequest.md)
+ - [UghuuuGameServer.AdminUpdateLeaderboardRecord200Response](docs/AdminUpdateLeaderboardRecord200Response.md)
+ - [UghuuuGameServer.AdminUpdateLeaderboardRecord200ResponseData](docs/AdminUpdateLeaderboardRecord200ResponseData.md)
  - [UghuuuGameServer.AdminUpdateLeaderboardRecordRequest](docs/AdminUpdateLeaderboardRecordRequest.md)
  - [UghuuuGameServer.AdminUpdateLeaderboardRequest](docs/AdminUpdateLeaderboardRequest.md)
  - [UghuuuGameServer.AdminUpdateLobby200Response](docs/AdminUpdateLobby200Response.md)
  - [UghuuuGameServer.AdminUpdateUser200Response](docs/AdminUpdateUser200Response.md)
  - [UghuuuGameServer.AdminUpdateUser200ResponseData](docs/AdminUpdateUser200ResponseData.md)
  - [UghuuuGameServer.AdminUpdateUserRequest](docs/AdminUpdateUserRequest.md)
+ - [UghuuuGameServer.AdminUpsertKv200Response](docs/AdminUpsertKv200Response.md)
+ - [UghuuuGameServer.AdminUpsertKv200ResponseData](docs/AdminUpsertKv200ResponseData.md)
+ - [UghuuuGameServer.AdminUpsertKvRequest](docs/AdminUpsertKvRequest.md)
+ - [UghuuuGameServer.ApproveJoinRequest200Response](docs/ApproveJoinRequest200Response.md)
  - [UghuuuGameServer.CallHook200Response](docs/CallHook200Response.md)
  - [UghuuuGameServer.CallHookRequest](docs/CallHookRequest.md)
  - [UghuuuGameServer.CancelJoinRequest200Response](docs/CancelJoinRequest200Response.md)
@@ -484,36 +486,34 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.CreateGroupRequest](docs/CreateGroupRequest.md)
  - [UghuuuGameServer.CreateLobbyRequest](docs/CreateLobbyRequest.md)
  - [UghuuuGameServer.CreatePartyRequest](docs/CreatePartyRequest.md)
- - [UghuuuGameServer.DeleteNotifications200Response](docs/DeleteNotifications200Response.md)
+ - [UghuuuGameServer.DeclineGroupInvite200Response](docs/DeclineGroupInvite200Response.md)
  - [UghuuuGameServer.DeleteNotificationsRequest](docs/DeleteNotificationsRequest.md)
  - [UghuuuGameServer.DeviceLoginRequest](docs/DeviceLoginRequest.md)
  - [UghuuuGameServer.ErrorResponse](docs/ErrorResponse.md)
- - [UghuuuGameServer.GetChatMessage200Response](docs/GetChatMessage200Response.md)
  - [UghuuuGameServer.GetCurrentUser200Response](docs/GetCurrentUser200Response.md)
  - [UghuuuGameServer.GetCurrentUser200ResponseLinkedProviders](docs/GetCurrentUser200ResponseLinkedProviders.md)
  - [UghuuuGameServer.GetKv200Response](docs/GetKv200Response.md)
  - [UghuuuGameServer.GetLobby200Response](docs/GetLobby200Response.md)
  - [UghuuuGameServer.GetMyRecord200Response](docs/GetMyRecord200Response.md)
+ - [UghuuuGameServer.GetMyRecord200ResponseData](docs/GetMyRecord200ResponseData.md)
  - [UghuuuGameServer.HealthResponse](docs/HealthResponse.md)
- - [UghuuuGameServer.InviteToGroup200Response](docs/InviteToGroup200Response.md)
- - [UghuuuGameServer.InviteToGroupRequest](docs/InviteToGroupRequest.md)
+ - [UghuuuGameServer.InviteToPartyRequest](docs/InviteToPartyRequest.md)
  - [UghuuuGameServer.ListBlockedFriends200Response](docs/ListBlockedFriends200Response.md)
  - [UghuuuGameServer.ListBlockedFriends200ResponseDataInner](docs/ListBlockedFriends200ResponseDataInner.md)
  - [UghuuuGameServer.ListBlockedFriends200ResponseDataInnerRequester](docs/ListBlockedFriends200ResponseDataInnerRequester.md)
  - [UghuuuGameServer.ListChatMessages200Response](docs/ListChatMessages200Response.md)
+ - [UghuuuGameServer.ListChatMessages200ResponseDataInner](docs/ListChatMessages200ResponseDataInner.md)
  - [UghuuuGameServer.ListFriendRequests200Response](docs/ListFriendRequests200Response.md)
  - [UghuuuGameServer.ListFriendRequests200ResponseIncomingInner](docs/ListFriendRequests200ResponseIncomingInner.md)
  - [UghuuuGameServer.ListFriendRequests200ResponseIncomingInnerRequester](docs/ListFriendRequests200ResponseIncomingInnerRequester.md)
  - [UghuuuGameServer.ListFriendRequests200ResponseMeta](docs/ListFriendRequests200ResponseMeta.md)
  - [UghuuuGameServer.ListFriends200Response](docs/ListFriends200Response.md)
  - [UghuuuGameServer.ListFriends200ResponseDataInner](docs/ListFriends200ResponseDataInner.md)
+ - [UghuuuGameServer.ListFriends200ResponseMeta](docs/ListFriends200ResponseMeta.md)
  - [UghuuuGameServer.ListGroupMembers200Response](docs/ListGroupMembers200Response.md)
- - [UghuuuGameServer.ListGroupMembers200ResponseDataInner](docs/ListGroupMembers200ResponseDataInner.md)
  - [UghuuuGameServer.ListJoinRequests200Response](docs/ListJoinRequests200Response.md)
  - [UghuuuGameServer.ListLeaderboardRecords200Response](docs/ListLeaderboardRecords200Response.md)
- - [UghuuuGameServer.ListLeaderboardRecords200ResponseDataInner](docs/ListLeaderboardRecords200ResponseDataInner.md)
  - [UghuuuGameServer.ListLeaderboards200Response](docs/ListLeaderboards200Response.md)
- - [UghuuuGameServer.ListLeaderboards200ResponseDataInner](docs/ListLeaderboards200ResponseDataInner.md)
  - [UghuuuGameServer.ListLobbies200Response](docs/ListLobbies200Response.md)
  - [UghuuuGameServer.ListLobbies200ResponseDataInner](docs/ListLobbies200ResponseDataInner.md)
  - [UghuuuGameServer.ListMyGroups200Response](docs/ListMyGroups200Response.md)
@@ -524,6 +524,8 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.ListSentInvitations200ResponseDataInner](docs/ListSentInvitations200ResponseDataInner.md)
  - [UghuuuGameServer.LoginRequest](docs/LoginRequest.md)
  - [UghuuuGameServer.MarkChatReadRequest](docs/MarkChatReadRequest.md)
+ - [UghuuuGameServer.MyAchievements200Response](docs/MyAchievements200Response.md)
+ - [UghuuuGameServer.MyAchievements200ResponseDataInner](docs/MyAchievements200ResponseDataInner.md)
  - [UghuuuGameServer.NotifyGroup200Response](docs/NotifyGroup200Response.md)
  - [UghuuuGameServer.NotifyGroupRequest](docs/NotifyGroupRequest.md)
  - [UghuuuGameServer.OAuthSessionData](docs/OAuthSessionData.md)
@@ -537,6 +539,7 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.OauthSessionStatus404Response](docs/OauthSessionStatus404Response.md)
  - [UghuuuGameServer.PartyCreateLobbyRequest](docs/PartyCreateLobbyRequest.md)
  - [UghuuuGameServer.PartyJoinLobbyRequest](docs/PartyJoinLobbyRequest.md)
+ - [UghuuuGameServer.PaymentsEntitlements401Response](docs/PaymentsEntitlements401Response.md)
  - [UghuuuGameServer.PaymentsSteamCheckoutRequest](docs/PaymentsSteamCheckoutRequest.md)
  - [UghuuuGameServer.PaymentsSteamFinalizeRequest](docs/PaymentsSteamFinalizeRequest.md)
  - [UghuuuGameServer.PaymentsStripeCheckoutRequest](docs/PaymentsStripeCheckoutRequest.md)
@@ -545,22 +548,19 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.RefreshToken200ResponseData](docs/RefreshToken200ResponseData.md)
  - [UghuuuGameServer.RefreshTokenRequest](docs/RefreshTokenRequest.md)
  - [UghuuuGameServer.ResolveLeaderboardSlugs200Response](docs/ResolveLeaderboardSlugs200Response.md)
+ - [UghuuuGameServer.ResolveLeaderboardSlugs200ResponseDataValue](docs/ResolveLeaderboardSlugs200ResponseDataValue.md)
  - [UghuuuGameServer.ResolveLeaderboardSlugsRequest](docs/ResolveLeaderboardSlugsRequest.md)
  - [UghuuuGameServer.SearchUsers200Response](docs/SearchUsers200Response.md)
  - [UghuuuGameServer.SearchUsers200ResponseDataInner](docs/SearchUsers200ResponseDataInner.md)
  - [UghuuuGameServer.SendChatMessageRequest](docs/SendChatMessageRequest.md)
  - [UghuuuGameServer.SendNotificationRequest](docs/SendNotificationRequest.md)
- - [UghuuuGameServer.ShowParty200Response](docs/ShowParty200Response.md)
- - [UghuuuGameServer.ShowParty200ResponseMembersInner](docs/ShowParty200ResponseMembersInner.md)
  - [UghuuuGameServer.UpdateChatMessageRequest](docs/UpdateChatMessageRequest.md)
+ - [UghuuuGameServer.UpdateCurrentUserDisplayName400Response](docs/UpdateCurrentUserDisplayName400Response.md)
  - [UghuuuGameServer.UpdateCurrentUserDisplayNameRequest](docs/UpdateCurrentUserDisplayNameRequest.md)
- - [UghuuuGameServer.UpdateCurrentUserPassword400Response](docs/UpdateCurrentUserPassword400Response.md)
  - [UghuuuGameServer.UpdateCurrentUserPasswordRequest](docs/UpdateCurrentUserPasswordRequest.md)
  - [UghuuuGameServer.UpdateGroupRequest](docs/UpdateGroupRequest.md)
  - [UghuuuGameServer.UpdateLobbyRequest](docs/UpdateLobbyRequest.md)
  - [UghuuuGameServer.UpdatePartyRequest](docs/UpdatePartyRequest.md)
- - [UghuuuGameServer.UserAchievements200Response](docs/UserAchievements200Response.md)
- - [UghuuuGameServer.UserAchievements200ResponseDataInner](docs/UserAchievements200ResponseDataInner.md)
 
 
 ## Documentation for Authorization

package/dist/ApiClient.js

@@ -15,7 +15,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * Game Server API
  * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal.  ## **1. Authentication**  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## **3. Friends** The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## **5. Notifications** Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect  ## **6. Groups** Groups provide persistent community management for players:  - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"`  ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):  - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel  ## **8. Chat** Real-time messaging across multiple conversation types:  - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking  ## **9. Leaderboards** Server-managed ranked scoreboards:  - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically  ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings:  - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata  ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements:  - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements  ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.  ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ```  ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat  ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`  ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).  ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency  ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync  ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, {   onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ``` 
  *
- * The version of the OpenAPI document: 1.0.1001
+ * The version of the OpenAPI document: 1.0.1003
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/AchievementsApi.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _UserAchievements200Response = _interopRequireDefault(require("../model/UserAchievements200Response"));
-var _UserAchievements200ResponseDataInner = _interopRequireDefault(require("../model/UserAchievements200ResponseDataInner"));
+var _MyAchievements200Response = _interopRequireDefault(require("../model/MyAchievements200Response"));
+var _MyAchievements200ResponseDataInner = _interopRequireDefault(require("../model/MyAchievements200ResponseDataInner"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -17,7 +17,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * Game Server API
  * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal.  ## **1. Authentication**  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## **3. Friends** The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## **5. Notifications** Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect  ## **6. Groups** Groups provide persistent community management for players:  - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"`  ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):  - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel  ## **8. Chat** Real-time messaging across multiple conversation types:  - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking  ## **9. Leaderboards** Server-managed ranked scoreboards:  - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically  ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings:  - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata  ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements:  - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements  ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.  ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ```  ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat  ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`  ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).  ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency  ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync  ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, {   onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ``` 
  *
- * The version of the OpenAPI document: 1.0.1001
+ * The version of the OpenAPI document: 1.0.1003
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -47,7 +47,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
    * Get achievement details
    * Get a specific achievement by slug. If authenticated, includes user progress.
    * @param {String} slug 
-   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserAchievements200ResponseDataInner} and HTTP response
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MyAchievements200ResponseDataInner} and HTTP response
    */
   return _createClass(AchievementsApi, [{
     key: "getAchievementWithHttpInfo",
@@ -66,7 +66,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = [];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _UserAchievements200ResponseDataInner["default"];
+      var returnType = _MyAchievements200ResponseDataInner["default"];
       return this.apiClient.callApi('/api/v1/achievements/{slug}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -74,7 +74,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * Get achievement details
      * Get a specific achievement by slug. If authenticated, includes user progress.
      * @param {String} slug 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserAchievements200ResponseDataInner}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MyAchievements200ResponseDataInner}
      */
   }, {
     key: "getAchievement",
@@ -90,7 +90,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {Number} [page] 
      * @param {Number} [pageSize] 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserAchievements200Response} and HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MyAchievements200Response} and HTTP response
      */
   }, {
     key: "listAchievementsWithHttpInfo",
@@ -107,7 +107,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = [];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _UserAchievements200Response["default"];
+      var returnType = _MyAchievements200Response["default"];
       return this.apiClient.callApi('/api/v1/achievements', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -117,7 +117,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {Number} opts.page 
      * @param {Number} opts.pageSize 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserAchievements200Response}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MyAchievements200Response}
      */
   }, {
     key: "listAchievements",
@@ -133,7 +133,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {Number} [page] 
      * @param {Number} [pageSize] 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserAchievements200Response} and HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MyAchievements200Response} and HTTP response
      */
   }, {
     key: "myAchievementsWithHttpInfo",
@@ -150,7 +150,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = [];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _UserAchievements200Response["default"];
+      var returnType = _MyAchievements200Response["default"];
       return this.apiClient.callApi('/api/v1/achievements/me', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -160,7 +160,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {Number} opts.page 
      * @param {Number} opts.pageSize 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserAchievements200Response}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MyAchievements200Response}
      */
   }, {
     key: "myAchievements",
@@ -177,7 +177,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {Number} [page] 
      * @param {Number} [pageSize] 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserAchievements200Response} and HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MyAchievements200Response} and HTTP response
      */
   }, {
     key: "userAchievementsWithHttpInfo",
@@ -200,7 +200,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = [];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _UserAchievements200Response["default"];
+      var returnType = _MyAchievements200Response["default"];
       return this.apiClient.callApi('/api/v1/achievements/user/{user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -211,7 +211,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {Number} opts.page 
      * @param {Number} opts.pageSize 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserAchievements200Response}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MyAchievements200Response}
      */
   }, {
     key: "userAchievements",

package/dist/api/AdminAchievementsApi.js

@@ -6,13 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _AdminCreateAchievementRequest = _interopRequireDefault(require("../model/AdminCreateAchievementRequest"));
-var _AdminCreateNotification400Response = _interopRequireDefault(require("../model/AdminCreateNotification400Response"));
+var _AdminGrantAchievementRequest = _interopRequireDefault(require("../model/AdminGrantAchievementRequest"));
 var _AdminIncrementAchievementRequest = _interopRequireDefault(require("../model/AdminIncrementAchievementRequest"));
 var _AdminListAchievements200Response = _interopRequireDefault(require("../model/AdminListAchievements200Response"));
+var _AdminListAchievements200ResponseDataInner = _interopRequireDefault(require("../model/AdminListAchievements200ResponseDataInner"));
 var _AdminRevokeAchievementRequest = _interopRequireDefault(require("../model/AdminRevokeAchievementRequest"));
-var _AdminUnlockAchievementRequest = _interopRequireDefault(require("../model/AdminUnlockAchievementRequest"));
-var _AdminUpdateAchievement200Response = _interopRequireDefault(require("../model/AdminUpdateAchievement200Response"));
 var _AdminUpdateAchievementRequest = _interopRequireDefault(require("../model/AdminUpdateAchievementRequest"));
+var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -23,7 +23,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * Game Server API
  * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal.  ## **1. Authentication**  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## **3. Friends** The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## **5. Notifications** Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect  ## **6. Groups** Groups provide persistent community management for players:  - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"`  ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):  - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel  ## **8. Chat** Real-time messaging across multiple conversation types:  - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking  ## **9. Leaderboards** Server-managed ranked scoreboards:  - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically  ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings:  - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata  ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements:  - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements  ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.  ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ```  ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat  ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`  ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).  ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency  ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync  ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, {   onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ``` 
  *
- * The version of the OpenAPI document: 1.0.1001
+ * The version of the OpenAPI document: 1.0.1003
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -53,7 +53,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
    * Create achievement (admin)
    * @param {Object} opts Optional parameters
    * @param {module:model/AdminCreateAchievementRequest} [adminCreateAchievementRequest] Achievement
-   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateAchievement200Response} and HTTP response
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminListAchievements200ResponseDataInner} and HTTP response
    */
   return _createClass(AdminAchievementsApi, [{
     key: "adminCreateAchievementWithHttpInfo",
@@ -67,7 +67,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['authorization'];
       var contentTypes = ['application/json'];
       var accepts = ['application/json'];
-      var returnType = _AdminUpdateAchievement200Response["default"];
+      var returnType = _AdminListAchievements200ResponseDataInner["default"];
       return this.apiClient.callApi('/api/v1/admin/achievements', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -75,7 +75,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * Create achievement (admin)
      * @param {Object} opts Optional parameters
      * @param {module:model/AdminCreateAchievementRequest} opts.adminCreateAchievementRequest Achievement
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateAchievement200Response}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminListAchievements200ResponseDataInner}
      */
   }, {
     key: "adminCreateAchievement",
@@ -127,14 +127,14 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Grant achievement to user (admin)
      * @param {Object} opts Optional parameters
-     * @param {module:model/AdminUnlockAchievementRequest} [adminUnlockAchievementRequest] Grant
+     * @param {module:model/AdminGrantAchievementRequest} [adminGrantAchievementRequest] Grant
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
      */
   }, {
     key: "adminGrantAchievementWithHttpInfo",
     value: function adminGrantAchievementWithHttpInfo(opts) {
       opts = opts || {};
-      var postBody = opts['adminUnlockAchievementRequest'];
+      var postBody = opts['adminGrantAchievementRequest'];
       var pathParams = {};
       var queryParams = {};
       var headerParams = {};
@@ -149,7 +149,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Grant achievement to user (admin)
      * @param {Object} opts Optional parameters
-     * @param {module:model/AdminUnlockAchievementRequest} opts.adminUnlockAchievementRequest Grant
+     * @param {module:model/AdminGrantAchievementRequest} opts.adminGrantAchievementRequest Grant
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
      */
   }, {
@@ -276,14 +276,14 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Unlock achievement for user (admin)
      * @param {Object} opts Optional parameters
-     * @param {module:model/AdminUnlockAchievementRequest} [adminUnlockAchievementRequest] Unlock
+     * @param {module:model/AdminGrantAchievementRequest} [adminGrantAchievementRequest] Unlock
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
      */
   }, {
     key: "adminUnlockAchievementWithHttpInfo",
     value: function adminUnlockAchievementWithHttpInfo(opts) {
       opts = opts || {};
-      var postBody = opts['adminUnlockAchievementRequest'];
+      var postBody = opts['adminGrantAchievementRequest'];
       var pathParams = {};
       var queryParams = {};
       var headerParams = {};
@@ -298,7 +298,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Unlock achievement for user (admin)
      * @param {Object} opts Optional parameters
-     * @param {module:model/AdminUnlockAchievementRequest} opts.adminUnlockAchievementRequest Unlock
+     * @param {module:model/AdminGrantAchievementRequest} opts.adminGrantAchievementRequest Unlock
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
      */
   }, {
@@ -314,7 +314,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Number} id 
      * @param {Object} opts Optional parameters
      * @param {module:model/AdminUpdateAchievementRequest} [adminUpdateAchievementRequest] Achievement
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateAchievement200Response} and HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminListAchievements200ResponseDataInner} and HTTP response
      */
   }, {
     key: "adminUpdateAchievementWithHttpInfo",
@@ -334,7 +334,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['authorization'];
       var contentTypes = ['application/json'];
       var accepts = ['application/json'];
-      var returnType = _AdminUpdateAchievement200Response["default"];
+      var returnType = _AdminListAchievements200ResponseDataInner["default"];
       return this.apiClient.callApi('/api/v1/admin/achievements/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -343,7 +343,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Number} id 
      * @param {Object} opts Optional parameters
      * @param {module:model/AdminUpdateAchievementRequest} opts.adminUpdateAchievementRequest Achievement
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateAchievement200Response}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminListAchievements200ResponseDataInner}
      */
   }, {
     key: "adminUpdateAchievement",

package/dist/api/AdminChatApi.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AdminCreateNotification400Response = _interopRequireDefault(require("../model/AdminCreateNotification400Response"));
+var _AdminDeleteChatConversation200Response = _interopRequireDefault(require("../model/AdminDeleteChatConversation200Response"));
 var _AdminListChatMessages200Response = _interopRequireDefault(require("../model/AdminListChatMessages200Response"));
-var _DeleteNotifications200Response = _interopRequireDefault(require("../model/DeleteNotifications200Response"));
+var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -18,7 +18,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * Game Server API
  * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal.  ## **1. Authentication**  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## **3. Friends** The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## **5. Notifications** Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect  ## **6. Groups** Groups provide persistent community management for players:  - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"`  ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):  - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel  ## **8. Chat** Real-time messaging across multiple conversation types:  - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking  ## **9. Leaderboards** Server-managed ranked scoreboards:  - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically  ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings:  - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata  ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements:  - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements  ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.  ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ```  ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat  ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`  ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).  ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency  ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync  ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, {   onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ``` 
  *
- * The version of the OpenAPI document: 1.0.1001
+ * The version of the OpenAPI document: 1.0.1003
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -49,7 +49,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
    * Delete all messages for a given chat_type and chat_ref_id.
    * @param {module:model/String} chatType 
    * @param {Number} chatRefId 
-   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteNotifications200Response} and HTTP response
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminDeleteChatConversation200Response} and HTTP response
    */
   return _createClass(AdminChatApi, [{
     key: "adminDeleteChatConversationWithHttpInfo",
@@ -73,7 +73,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['authorization'];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _DeleteNotifications200Response["default"];
+      var returnType = _AdminDeleteChatConversation200Response["default"];
       return this.apiClient.callApi('/api/v1/admin/chat/conversation', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
@@ -82,7 +82,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
      * Delete all messages for a given chat_type and chat_ref_id.
      * @param {module:model/String} chatType 
      * @param {Number} chatRefId 
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteNotifications200Response}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminDeleteChatConversation200Response}
      */
   }, {
     key: "adminDeleteChatConversation",

package/dist/api/AdminGroupsApi.js

@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AdminCreateNotification400Response = _interopRequireDefault(require("../model/AdminCreateNotification400Response"));
 var _AdminListGroups200Response = _interopRequireDefault(require("../model/AdminListGroups200Response"));
 var _AdminUpdateGroup200Response = _interopRequireDefault(require("../model/AdminUpdateGroup200Response"));
 var _AdminUpdateGroupRequest = _interopRequireDefault(require("../model/AdminUpdateGroupRequest"));
+var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -19,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * Game Server API
  * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal.  ## **1. Authentication**  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## **3. Friends** The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## **5. Notifications** Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect  ## **6. Groups** Groups provide persistent community management for players:  - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"`  ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):  - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel  ## **8. Chat** Real-time messaging across multiple conversation types:  - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking  ## **9. Leaderboards** Server-managed ranked scoreboards:  - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically  ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings:  - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata  ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements:  - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements  ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.  ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ```  ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat  ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`  ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).  ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency  ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync  ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, {   onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ``` 
  *
- * The version of the OpenAPI document: 1.0.1001
+ * The version of the OpenAPI document: 1.0.1003
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).