@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/docs/reference/API_GAME_PLAYER.md

@@ -0,0 +1,223 @@
+# API Reference: GamePlayerApi
+
+Game-player profile, friend/group relation, currency, statistics, segment, tag, social identity.
+
+Domain guide: [guides/GAME_PLAYER.md](../guides/GAME_PLAYER.md). DTO shapes: [dto/GAME_PLAYER.md](dto/GAME_PLAYER.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
+
+## Namespaces
+
+- `GNNetwork.gamePlayer` — `RequestRole.Client`
+- `GNNetwork.gamePlayer.server` — `RequestRole.Server`
+- `GNNetwork.gamePlayer.admin` — `RequestRole.Admin`
+
+## Convention
+
+Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
+
+```ts
+// Callback
+GNNetwork.gamePlayer.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
+
+// Async
+const res = await GNNetwork.gamePlayer.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
+```
+
+Param chung:
+
+| Param | Type | Optional | Notes |
+|-------|------|----------|-------|
+| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
+| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
+| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
+| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
+| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
+| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
+
+Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
+
+
+## Client methods (`GNNetwork.gamePlayer.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules | Permission Rules khi truyền `userId` khác với `gamePlayer` đang authenticated |
+|--------|-------------|------------|----------------|--------------------------|-------------------------------------------------------------------------------|
+| `addPlayerFriend` | `GamePlayerModels.AddPlayerFriendRequestData` | `addPlayerFriendAsync(...)` | `GamePlayerResponseModels.AddPlayerFriendOperationResponse` | `gamePlayer.addPlayerFriend.selfEnable` | `gamePlayer.addPlayerFriend.otherSelfEnable` |
+| `addSegment` | `GamePlayerModels.AddSegmentRequestData` | `addSegmentAsync(...)` | `GamePlayerResponseModels.AddSegmentOperationResponse` | `gamePlayer.addSegment.selfEnable` | `gamePlayer.addSegment.otherSelfEnable` |
+| `getAvatar` | `GamePlayerModels.GetAvatarRequestData` | `getAvatarAsync(...)` | `GamePlayerResponseModels.GetAvatarOperationResponse` | `gamePlayer.getAvatar.selfEnable` | `gamePlayer.getAvatar.otherSelfEnable` |
+| `getCountryCode` | `GamePlayerModels.GetCountryCodeRequestData` | `getCountryCodeAsync(...)` | `GamePlayerResponseModels.GetCountryCodeOperationResponse` | `gamePlayer.getCountryCode.selfEnable` | `gamePlayer.getCountryCode.otherSelfEnable` |
+| `getCustomData` | `GamePlayerModels.GetCustomDataRequestData` | `getCustomDataAsync(...)` | `GamePlayerResponseModels.GetCustomDataOperationResponse` | `gamePlayer.getCustomData.selfEnable` | `gamePlayer.getCustomData.otherSelfEnable` |
+| `getDisplayName` | `GamePlayerModels.GetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `GamePlayerResponseModels.GetDisplayNameOperationResponse` | `gamePlayer.getDisplayName.selfEnable` | `gamePlayer.getDisplayName.otherSelfEnable` |
+| `getFriendStatisticsLeaderboardAroundPlayer` | `GamePlayerModels.GetFriendStatisticsLeaderboardAroundPlayerRequestData` | `getFriendStatisticsLeaderboardAroundPlayerAsync(...)` | `GamePlayerResponseModels.GetFriendStatisticsLeaderboardAroundPlayerOperationResponse` | `gamePlayer.getFriendStatisticsLeaderboardAroundPlayer.selfEnable` | `gamePlayer.getFriendStatisticsLeaderboardAroundPlayer.otherSelfEnable` |
+| `getFriendStatisticsLeaderboard` | `GamePlayerModels.GetFriendStatisticsLeaderboardRequestData` | `getFriendStatisticsLeaderboardAsync(...)` | `GamePlayerResponseModels.GetFriendStatisticsLeaderboardOperationResponse` | `gamePlayer.getFriendStatisticsLeaderboard.selfEnable` | `gamePlayer.getFriendStatisticsLeaderboard.otherSelfEnable` |
+| `getIpAddressCreate` | `GamePlayerModels.GetIpAddressCreateRequestData` | `getIpAddressCreateAsync(...)` | `GamePlayerResponseModels.GetIpAddressCreateOperationResponse` | `gamePlayer.getIpAddressCreate.selfEnable` | `gamePlayer.getIpAddressCreate.otherSelfEnable` |
+| `getOnlineStatus` | `GamePlayerModels.GetOnlineStatusRequestData` | `getOnlineStatusAsync(...)` | `GamePlayerResponseModels.GetOnlineStatusOperationResponse` | `gamePlayer.getOnlineStatus.selfEnable` | `gamePlayer.getOnlineStatus.otherSelfEnable` |
+| `getPlayerBan` | `GamePlayerModels.GetPlayerBanRequestData` | `getPlayerBanAsync(...)` | `GamePlayerResponseModels.GetPlayerBanOperationResponse` | `gamePlayer.getPlayerBan.selfEnable` | `gamePlayer.getPlayerBan.otherSelfEnable` |
+| `getPlayerCharacter` | `GamePlayerModels.GetPlayerCharacterRequestData` | `getPlayerCharacterAsync(...)` | `GamePlayerResponseModels.GetPlayerCharacterOperationResponse` | `gamePlayer.getPlayerCharacter.selfEnable` | `gamePlayer.getPlayerCharacter.otherSelfEnable` |
+| `getPlayerCurrency` | `GamePlayerModels.GetPlayerCurrencyRequestData` | `getPlayerCurrencyAsync(...)` | `GamePlayerResponseModels.GetPlayerCurrencyOperationResponse` | `gamePlayer.getPlayerCurrency.selfEnable` | `gamePlayer.getPlayerCurrency.otherSelfEnable` |
+| `getPlayerData` | `GamePlayerModels.GetPlayerDataRequestData` | `getPlayerDataAsync(...)` | `GamePlayerResponseModels.GetPlayerDataOperationResponse` | `gamePlayer.getPlayerData.selfEnable` | `gamePlayer.getPlayerData.otherSelfEnable` |
+| `getPlayerFriend` | `GamePlayerModels.GetPlayerFriendRequestData` | `getPlayerFriendAsync(...)` | `GamePlayerResponseModels.GetPlayerFriendOperationResponse` | `gamePlayer.getPlayerFriend.selfEnable` | `gamePlayer.getPlayerFriend.otherSelfEnable` |
+| `getPlayerGroup` | `GamePlayerModels.GetPlayerGroupRequestData` | `getPlayerGroupAsync(...)` | `GamePlayerResponseModels.GetPlayerGroupOperationResponse` | `gamePlayer.getPlayerGroup.selfEnable` | `gamePlayer.getPlayerGroup.otherSelfEnable` |
+| `getPlayerInformation` | `GamePlayerModels.GetPlayerInformationRequestData` | `getPlayerInformationAsync(...)` | `GamePlayerResponseModels.GetPlayerInformationOperationResponse` | `gamePlayer.getPlayerInformation.selfEnable` | `gamePlayer.getPlayerInformation.otherSelfEnable` |
+| `getPlayerInventory` | `GamePlayerModels.GetPlayerInventoryRequestData` | `getPlayerInventoryAsync(...)` | `GamePlayerResponseModels.GetPlayerInventoryOperationResponse` | `gamePlayer.getPlayerInventory.selfEnable` | `gamePlayer.getPlayerInventory.otherSelfEnable` |
+| `getPlayerStatistics` | `GamePlayerModels.GetPlayerStatisticsRequestData` | `getPlayerStatisticsAsync(...)` | `GamePlayerResponseModels.GetPlayerStatisticsOperationResponse` | `gamePlayer.getPlayerStatistics.selfEnable` | `gamePlayer.getPlayerStatistics.otherSelfEnable` |
+| `getPlayersWithDisplayName` | `GamePlayerModels.GetPlayersWithDisplayNameRequestData` | `getPlayersWithDisplayNameAsync(...)` | `GamePlayerResponseModels.GetPlayersWithDisplayNameOperationResponse` | `gamePlayer.getPlayersWithDisplayName.otherSelfEnable` | |
+| `getPlayersWithSegment` | `GamePlayerModels.GetPlayersWithSegmentRequestData` | `getPlayersWithSegmentAsync(...)` | `GamePlayerResponseModels.GetPlayersWithSegmentOperationResponse` | `gamePlayer.getPlayersWithSegment.otherSelfEnable` | |
+| `getPlayersWithTag` | `GamePlayerModels.GetPlayersWithTagRequestData` | `getPlayersWithTagAsync(...)` | `GamePlayerResponseModels.GetPlayersWithTagOperationResponse` | `gamePlayer.getPlayersWithTag.otherSelfEnable` | |
+| `getSegment` | `GamePlayerModels.GetSegmentRequestData` | `getSegmentAsync(...)` | `GamePlayerResponseModels.GetSegmentOperationResponse` | `gamePlayer.getSegment.selfEnable` | `gamePlayer.getSegment.otherSelfEnable` |
+| `getStatisticsLeaderboardAroundPlayer` | `GamePlayerModels.GetStatisticsLeaderboardAroundPlayerRequestData` | `getStatisticsLeaderboardAroundPlayerAsync(...)` | `GamePlayerResponseModels.GetStatisticsLeaderboardAroundPlayerOperationResponse` | `gamePlayer.getStatisticsLeaderboardAroundPlayer.selfEnable` | `gamePlayer.getStatisticsLeaderboardAroundPlayer.otherSelfEnable` |
+| `getStatisticsLeaderboard` | `GamePlayerModels.GetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `GamePlayerResponseModels.GetStatisticsLeaderboardOperationResponse` | `gamePlayer.getStatisticsLeaderboard.otherSelfEnable` | |
+| `getTag` | `GamePlayerModels.GetTagRequestData` | `getTagAsync(...)` | `GamePlayerResponseModels.GetTagOperationResponse` | `gamePlayer.getTag.selfEnable` | `gamePlayer.getTag.otherSelfEnable` |
+| `getTsCreate` | `GamePlayerModels.GetTsCreateRequestData` | `getTsCreateAsync(...)` | `GamePlayerResponseModels.GetTsCreateOperationResponse` | `gamePlayer.getTsCreate.selfEnable` | `gamePlayer.getTsCreate.otherSelfEnable` |
+| `getTsLastLogin` | `GamePlayerModels.GetTsLastLoginRequestData` | `getTsLastLoginAsync(...)` | `GamePlayerResponseModels.GetTsLastLoginOperationResponse` | `gamePlayer.getTsLastLogin.selfEnable` | `gamePlayer.getTsLastLogin.otherSelfEnable` |
+| `createGroup` | `GamePlayerModels.CreateGroupRequestData` | `createGroupAsync(...)` | `GamePlayerResponseModels.CreateGroupOperationResponse` | `gamePlayer.createGroup.selfEnable` | `gamePlayer.createGroup.otherSelfEnable` |
+| `createPlayerCharacter` | `GamePlayerModels.CreatePlayerCharacterRequestData` | `createPlayerCharacterAsync(...)` | `GamePlayerResponseModels.CreatePlayerCharacterOperationResponse` | `gamePlayer.createPlayerCharacter.selfEnable` | `gamePlayer.createPlayerCharacter.otherSelfEnable` |
+| `createPlayerItem` | `GamePlayerModels.CreatePlayerItemRequestData` | `createPlayerItemAsync(...)` | `GamePlayerResponseModels.CreatePlayerItemOperationResponse` | `gamePlayer.createPlayerItem.selfEnable` | `gamePlayer.createPlayerItem.otherSelfEnable` |
+| `joinGroup` | `GamePlayerModels.JoinGroupRequestData` | `joinGroupAsync(...)` | `GamePlayerResponseModels.JoinGroupOperationResponse` | `gamePlayer.joinGroup.selfEnable` | `gamePlayer.joinGroup.otherSelfEnable` |
+| `leaveGroup` | `GamePlayerModels.LeaveGroupRequestData` | `leaveGroupAsync(...)` | `GamePlayerResponseModels.LeaveGroupOperationResponse` | `gamePlayer.leaveGroup.selfEnable` | `gamePlayer.leaveGroup.otherSelfEnable` |
+| `removePlayerCharacter` | `GamePlayerModels.RemovePlayerCharacterRequestData` | `removePlayerCharacterAsync(...)` | `GamePlayerResponseModels.RemovePlayerCharacterOperationResponse` | `gamePlayer.removePlayerCharacter.selfEnable` | `gamePlayer.removePlayerCharacter.otherSelfEnable` |
+| `removePlayerFriend` | `GamePlayerModels.RemovePlayerFriendRequestData` | `removePlayerFriendAsync(...)` | `GamePlayerResponseModels.RemovePlayerFriendOperationResponse` | `gamePlayer.removePlayerFriend.selfEnable` | `gamePlayer.removePlayerFriend.otherSelfEnable` |
+| `removePlayerItem` | `GamePlayerModels.RemovePlayerItemRequestData` | `removePlayerItemAsync(...)` | `GamePlayerResponseModels.RemovePlayerItemOperationResponse` | `gamePlayer.removePlayerItem.selfEnable` | `gamePlayer.removePlayerItem.otherSelfEnable` |
+| `removeSegment` | `GamePlayerModels.RemoveSegmentRequestData` | `removeSegmentAsync(...)` | `GamePlayerResponseModels.RemoveSegmentOperationResponse` | `gamePlayer.removeSegment.selfEnable` | `gamePlayer.removeSegment.otherSelfEnable` |
+| `removeTag` | `GamePlayerModels.RemoveTagRequestData` | `removeTagAsync(...)` | `GamePlayerResponseModels.RemoveTagOperationResponse` | `gamePlayer.removeTag.selfEnable` | `gamePlayer.removeTag.otherSelfEnable` |
+| `setAvatar` | `GamePlayerModels.SetAvatarRequestData` | `setAvatarAsync(...)` | `GamePlayerResponseModels.SetAvatarOperationResponse` | `gamePlayer.setAvatar.selfEnable` | `gamePlayer.setAvatar.otherSelfEnable` |
+| `setCountryCode` | `GamePlayerModels.SetCountryCodeRequestData` | `setCountryCodeAsync(...)` | `GamePlayerResponseModels.SetCountryCodeOperationResponse` | `gamePlayer.setCountryCode.selfEnable` | `gamePlayer.setCountryCode.otherSelfEnable` |
+| `setCustomData` | `GamePlayerModels.SetCustomDataRequestData` | `setCustomDataAsync(...)` | `GamePlayerResponseModels.SetCustomDataOperationResponse` | `gamePlayer.setCustomData.selfEnable` | `gamePlayer.setCustomData.otherSelfEnable` |
+| `setDisplayName` | `GamePlayerModels.SetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `GamePlayerResponseModels.SetDisplayNameOperationResponse` | `gamePlayer.setDisplayName.selfEnable` | `gamePlayer.setDisplayName.otherSelfEnable` |
+| `setPlayerBan` | `GamePlayerModels.SetPlayerBanRequestData` | `setPlayerBanAsync(...)` | `GamePlayerResponseModels.SetPlayerBanOperationResponse` | `gamePlayer.setPlayerBan.selfEnable` | `gamePlayer.setPlayerBan.otherSelfEnable` |
+| `changePlayerCurrency` | `GamePlayerModels.ChangePlayerCurrencyRequestData` | `changePlayerCurrencyAsync(...)` | `GamePlayerResponseModels.ChangePlayerCurrencyOperationResponse` | `gamePlayer.changePlayerCurrency.selfEnable` | `gamePlayer.changePlayerCurrency.otherSelfEnable` |
+| `setPlayerData` | `GamePlayerModels.SetPlayerDataRequestData` | `setPlayerDataAsync(...)` | `GamePlayerResponseModels.SetPlayerDataOperationResponse` | `gamePlayer.setPlayerData.selfEnable` | `gamePlayer.setPlayerData.otherSelfEnable` |
+| `changePlayerStatistics` | `GamePlayerModels.ChangePlayerStatisticsRequestData` | `changePlayerStatisticsAsync(...)` | `GamePlayerResponseModels.ChangePlayerStatisticsOperationResponse` | `gamePlayer.changePlayerStatistics.selfEnable` | `gamePlayer.changePlayerStatistics.otherSelfEnable` |
+| `setTag` | `GamePlayerModels.SetTagRequestData` | `setTagAsync(...)` | `GamePlayerResponseModels.SetTagOperationResponse` | `gamePlayer.setTag.selfEnable` | `gamePlayer.setTag.otherSelfEnable` |
+| `getCurrencyLeaderboard` | `GamePlayerModels.GetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `GamePlayerResponseModels.GetCurrencyLeaderboardOperationResponse` | `gamePlayer.getCurrencyLeaderboard.otherSelfEnable` | |
+| `getLastLoginLeaderboard` | `GamePlayerModels.GetLastLoginLeaderboardRequestData` | `getLastLoginLeaderboardAsync(...)` | `GamePlayerResponseModels.GetLastLoginLeaderboardOperationResponse` | `gamePlayer.getLastLoginLeaderboard.otherSelfEnable` | |
+| `getCreateLeaderboard` | `GamePlayerModels.GetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `GamePlayerResponseModels.GetCreateLeaderboardOperationResponse` | `gamePlayer.getCreateLeaderboard.otherSelfEnable` | |
+| `getStatisticsLog` | `GamePlayerModels.GetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `GamePlayerResponseModels.GetStatisticsLogOperationResponse` | `gamePlayer.getStatisticsLog.selfEnable` | `gamePlayer.getStatisticsLog.otherSelfEnable` |
+| `getCurrencyLog` | `GamePlayerModels.GetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `GamePlayerResponseModels.GetCurrencyLogOperationResponse` | `gamePlayer.getCurrencyLog.selfEnable` | `gamePlayer.getCurrencyLog.otherSelfEnable` |
+
+
+## Server methods (`GNNetwork.gamePlayer.server.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `addPlayerFriend` | `GamePlayerModels.ServerAddPlayerFriendRequestData` | `addPlayerFriendAsync(...)` | `GamePlayerResponseModels.AddPlayerFriendOperationResponse` | `gamePlayer.addPlayerFriend.serverSelfEnable` |
+| `addSegment` | `GamePlayerModels.ServerAddSegmentRequestData` | `addSegmentAsync(...)` | `GamePlayerResponseModels.AddSegmentOperationResponse` | `gamePlayer.addSegment.serverSelfEnable` |
+| `getAvatar` | `GamePlayerModels.ServerGetAvatarRequestData` | `getAvatarAsync(...)` | `GamePlayerResponseModels.GetAvatarOperationResponse` | `gamePlayer.getAvatar.serverSelfEnable` |
+| `getCountryCode` | `GamePlayerModels.ServerGetCountryCodeRequestData` | `getCountryCodeAsync(...)` | `GamePlayerResponseModels.GetCountryCodeOperationResponse` | `gamePlayer.getCountryCode.serverSelfEnable` |
+| `getCustomData` | `GamePlayerModels.ServerGetCustomDataRequestData` | `getCustomDataAsync(...)` | `GamePlayerResponseModels.GetCustomDataOperationResponse` | `gamePlayer.getCustomData.serverSelfEnable` |
+| `getDisplayName` | `GamePlayerModels.ServerGetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `GamePlayerResponseModels.GetDisplayNameOperationResponse` | `gamePlayer.getDisplayName.serverSelfEnable` |
+| `getFriendStatisticsLeaderboardAroundPlayer` | `GamePlayerModels.ServerGetFriendStatisticsLeaderboardAroundPlayerRequestData` | `getFriendStatisticsLeaderboardAroundPlayerAsync(...)` | `GamePlayerResponseModels.GetFriendStatisticsLeaderboardAroundPlayerOperationResponse` | `gamePlayer.getFriendStatisticsLeaderboardAroundPlayer.serverSelfEnable` |
+| `getFriendStatisticsLeaderboard` | `GamePlayerModels.ServerGetFriendStatisticsLeaderboardRequestData` | `getFriendStatisticsLeaderboardAsync(...)` | `GamePlayerResponseModels.GetFriendStatisticsLeaderboardOperationResponse` | `gamePlayer.getFriendStatisticsLeaderboard.serverSelfEnable` |
+| `getIpAddressCreate` | `GamePlayerModels.ServerGetIpAddressCreateRequestData` | `getIpAddressCreateAsync(...)` | `GamePlayerResponseModels.GetIpAddressCreateOperationResponse` | `gamePlayer.getIpAddressCreate.serverSelfEnable` |
+| `getOnlineStatus` | `GamePlayerModels.ServerGetOnlineStatusRequestData` | `getOnlineStatusAsync(...)` | `GamePlayerResponseModels.GetOnlineStatusOperationResponse` | `gamePlayer.getOnlineStatus.serverSelfEnable` |
+| `getPlayerBan` | `GamePlayerModels.ServerGetPlayerBanRequestData` | `getPlayerBanAsync(...)` | `GamePlayerResponseModels.GetPlayerBanOperationResponse` | `gamePlayer.getPlayerBan.serverSelfEnable` |
+| `getPlayerCharacter` | `GamePlayerModels.ServerGetPlayerCharacterRequestData` | `getPlayerCharacterAsync(...)` | `GamePlayerResponseModels.GetPlayerCharacterOperationResponse` | `gamePlayer.getPlayerCharacter.serverSelfEnable` |
+| `getPlayerCurrency` | `GamePlayerModels.ServerGetPlayerCurrencyRequestData` | `getPlayerCurrencyAsync(...)` | `GamePlayerResponseModels.GetPlayerCurrencyOperationResponse` | `gamePlayer.getPlayerCurrency.serverSelfEnable` |
+| `getPlayerData` | `GamePlayerModels.ServerGetPlayerDataRequestData` | `getPlayerDataAsync(...)` | `GamePlayerResponseModels.GetPlayerDataOperationResponse` | `gamePlayer.getPlayerData.serverSelfEnable` |
+| `getPlayerFriend` | `GamePlayerModels.ServerGetPlayerFriendRequestData` | `getPlayerFriendAsync(...)` | `GamePlayerResponseModels.GetPlayerFriendOperationResponse` | `gamePlayer.getPlayerFriend.serverSelfEnable` |
+| `getPlayerGroup` | `GamePlayerModels.ServerGetPlayerGroupRequestData` | `getPlayerGroupAsync(...)` | `GamePlayerResponseModels.GetPlayerGroupOperationResponse` | `gamePlayer.getPlayerGroup.serverSelfEnable` |
+| `getPlayerInformation` | `GamePlayerModels.ServerGetPlayerInformationRequestData` | `getPlayerInformationAsync(...)` | `GamePlayerResponseModels.GetPlayerInformationOperationResponse` | `gamePlayer.getPlayerInformation.serverSelfEnable` |
+| `getPlayerInventory` | `GamePlayerModels.ServerGetPlayerInventoryRequestData` | `getPlayerInventoryAsync(...)` | `GamePlayerResponseModels.GetPlayerInventoryOperationResponse` | `gamePlayer.getPlayerInventory.serverSelfEnable` |
+| `getPlayerStatistics` | `GamePlayerModels.ServerGetPlayerStatisticsRequestData` | `getPlayerStatisticsAsync(...)` | `GamePlayerResponseModels.GetPlayerStatisticsOperationResponse` | `gamePlayer.getPlayerStatistics.serverSelfEnable` |
+| `getPlayersWithDisplayName` | `GamePlayerModels.ServerGetPlayersWithDisplayNameRequestData` | `getPlayersWithDisplayNameAsync(...)` | `GamePlayerResponseModels.GetPlayersWithDisplayNameOperationResponse` | `gamePlayer.getPlayersWithDisplayName.serverSelfEnable` |
+| `getPlayersWithSegment` | `GamePlayerModels.ServerGetPlayersWithSegmentRequestData` | `getPlayersWithSegmentAsync(...)` | `GamePlayerResponseModels.GetPlayersWithSegmentOperationResponse` | `gamePlayer.getPlayersWithSegment.serverSelfEnable` |
+| `getPlayersWithTag` | `GamePlayerModels.ServerGetPlayersWithTagRequestData` | `getPlayersWithTagAsync(...)` | `GamePlayerResponseModels.GetPlayersWithTagOperationResponse` | `gamePlayer.getPlayersWithTag.serverSelfEnable` |
+| `getSegment` | `GamePlayerModels.ServerGetSegmentRequestData` | `getSegmentAsync(...)` | `GamePlayerResponseModels.GetSegmentOperationResponse` | `gamePlayer.getSegment.serverSelfEnable` |
+| `getStatisticsLeaderboardAroundPlayer` | `GamePlayerModels.ServerGetStatisticsLeaderboardAroundPlayerRequestData` | `getStatisticsLeaderboardAroundPlayerAsync(...)` | `GamePlayerResponseModels.GetStatisticsLeaderboardAroundPlayerOperationResponse` | `gamePlayer.getStatisticsLeaderboardAroundPlayer.serverSelfEnable` |
+| `getStatisticsLeaderboard` | `GamePlayerModels.ServerGetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `GamePlayerResponseModels.GetStatisticsLeaderboardOperationResponse` | `gamePlayer.getStatisticsLeaderboard.serverSelfEnable` |
+| `getTag` | `GamePlayerModels.ServerGetTagRequestData` | `getTagAsync(...)` | `GamePlayerResponseModels.GetTagOperationResponse` | `gamePlayer.getTag.serverSelfEnable` |
+| `getTsCreate` | `GamePlayerModels.ServerGetTsCreateRequestData` | `getTsCreateAsync(...)` | `GamePlayerResponseModels.GetTsCreateOperationResponse` | `gamePlayer.getTsCreate.serverSelfEnable` |
+| `getTsLastLogin` | `GamePlayerModels.ServerGetTsLastLoginRequestData` | `getTsLastLoginAsync(...)` | `GamePlayerResponseModels.GetTsLastLoginOperationResponse` | `gamePlayer.getTsLastLogin.serverSelfEnable` |
+| `createGroup` | `GamePlayerModels.ServerCreateGroupRequestData` | `createGroupAsync(...)` | `GamePlayerResponseModels.CreateGroupOperationResponse` | `gamePlayer.createGroup.serverSelfEnable` |
+| `createPlayerCharacter` | `GamePlayerModels.ServerCreatePlayerCharacterRequestData` | `createPlayerCharacterAsync(...)` | `GamePlayerResponseModels.CreatePlayerCharacterOperationResponse` | `gamePlayer.createPlayerCharacter.serverSelfEnable` |
+| `createPlayerItem` | `GamePlayerModels.ServerCreatePlayerItemRequestData` | `createPlayerItemAsync(...)` | `GamePlayerResponseModels.CreatePlayerItemOperationResponse` | `gamePlayer.createPlayerItem.serverSelfEnable` |
+| `joinGroup` | `GamePlayerModels.ServerJoinGroupRequestData` | `joinGroupAsync(...)` | `GamePlayerResponseModels.JoinGroupOperationResponse` | `gamePlayer.joinGroup.serverSelfEnable` |
+| `leaveGroup` | `GamePlayerModels.ServerLeaveGroupRequestData` | `leaveGroupAsync(...)` | `GamePlayerResponseModels.LeaveGroupOperationResponse` | `gamePlayer.leaveGroup.serverSelfEnable` |
+| `removePlayerCharacter` | `GamePlayerModels.ServerRemovePlayerCharacterRequestData` | `removePlayerCharacterAsync(...)` | `GamePlayerResponseModels.RemovePlayerCharacterOperationResponse` | `gamePlayer.removePlayerCharacter.serverSelfEnable` |
+| `removePlayerFriend` | `GamePlayerModels.ServerRemovePlayerFriendRequestData` | `removePlayerFriendAsync(...)` | `GamePlayerResponseModels.RemovePlayerFriendOperationResponse` | `gamePlayer.removePlayerFriend.serverSelfEnable` |
+| `removePlayerItem` | `GamePlayerModels.ServerRemovePlayerItemRequestData` | `removePlayerItemAsync(...)` | `GamePlayerResponseModels.RemovePlayerItemOperationResponse` | `gamePlayer.removePlayerItem.serverSelfEnable` |
+| `removeSegment` | `GamePlayerModels.ServerRemoveSegmentRequestData` | `removeSegmentAsync(...)` | `GamePlayerResponseModels.RemoveSegmentOperationResponse` | `gamePlayer.removeSegment.serverSelfEnable` |
+| `removeTag` | `GamePlayerModels.ServerRemoveTagRequestData` | `removeTagAsync(...)` | `GamePlayerResponseModels.RemoveTagOperationResponse` | `gamePlayer.removeTag.serverSelfEnable` |
+| `setAvatar` | `GamePlayerModels.ServerSetAvatarRequestData` | `setAvatarAsync(...)` | `GamePlayerResponseModels.SetAvatarOperationResponse` | `gamePlayer.setAvatar.serverSelfEnable` |
+| `setCountryCode` | `GamePlayerModels.ServerSetCountryCodeRequestData` | `setCountryCodeAsync(...)` | `GamePlayerResponseModels.SetCountryCodeOperationResponse` | `gamePlayer.setCountryCode.serverSelfEnable` |
+| `setCustomData` | `GamePlayerModels.ServerSetCustomDataRequestData` | `setCustomDataAsync(...)` | `GamePlayerResponseModels.SetCustomDataOperationResponse` | `gamePlayer.setCustomData.serverSelfEnable` |
+| `setDisplayName` | `GamePlayerModels.ServerSetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `GamePlayerResponseModels.SetDisplayNameOperationResponse` | `gamePlayer.setDisplayName.serverSelfEnable` |
+| `setPlayerBan` | `GamePlayerModels.ServerSetPlayerBanRequestData` | `setPlayerBanAsync(...)` | `GamePlayerResponseModels.SetPlayerBanOperationResponse` | `gamePlayer.setPlayerBan.serverSelfEnable` |
+| `changePlayerCurrency` | `GamePlayerModels.ServerChangePlayerCurrencyRequestData` | `changePlayerCurrencyAsync(...)` | `GamePlayerResponseModels.ChangePlayerCurrencyOperationResponse` | `gamePlayer.changePlayerCurrency.serverSelfEnable` |
+| `setPlayerData` | `GamePlayerModels.ServerSetPlayerDataRequestData` | `setPlayerDataAsync(...)` | `GamePlayerResponseModels.SetPlayerDataOperationResponse` | `gamePlayer.setPlayerData.serverSelfEnable` |
+| `changePlayerStatistics` | `GamePlayerModels.ServerChangePlayerStatisticsRequestData` | `changePlayerStatisticsAsync(...)` | `GamePlayerResponseModels.ChangePlayerStatisticsOperationResponse` | `gamePlayer.changePlayerStatistics.serverSelfEnable` |
+| `setTag` | `GamePlayerModels.ServerSetTagRequestData` | `setTagAsync(...)` | `GamePlayerResponseModels.SetTagOperationResponse` | `gamePlayer.setTag.serverSelfEnable` |
+| `getCurrencyLeaderboard` | `GamePlayerModels.ServerGetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `GamePlayerResponseModels.GetCurrencyLeaderboardOperationResponse` | `gamePlayer.getCurrencyLeaderboard.serverSelfEnable` |
+| `getLastLoginLeaderboard` | `GamePlayerModels.ServerGetLastLoginLeaderboardRequestData` | `getLastLoginLeaderboardAsync(...)` | `GamePlayerResponseModels.GetLastLoginLeaderboardOperationResponse` | `gamePlayer.getLastLoginLeaderboard.serverSelfEnable` |
+| `getCreateLeaderboard` | `GamePlayerModels.ServerGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `GamePlayerResponseModels.GetCreateLeaderboardOperationResponse` | `gamePlayer.getCreateLeaderboard.serverSelfEnable` |
+| `getStatisticsLog` | `GamePlayerModels.ServerGetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `GamePlayerResponseModels.GetStatisticsLogOperationResponse` | `gamePlayer.getStatisticsLog.serverSelfEnable` |
+| `getCurrencyLog` | `GamePlayerModels.ServerGetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `GamePlayerResponseModels.GetCurrencyLogOperationResponse` | `gamePlayer.getCurrencyLog.serverSelfEnable` |
+
+
+## Admin methods (`GNNetwork.gamePlayer.admin.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `addPlayerFriend` | `GamePlayerModels.AdminAddPlayerFriendRequestData` | `addPlayerFriendAsync(...)` | `GamePlayerResponseModels.AddPlayerFriendOperationResponse` | `gamePlayer.addPlayerFriend.adminSelfEnable` |
+| `addSegment` | `GamePlayerModels.AdminAddSegmentRequestData` | `addSegmentAsync(...)` | `GamePlayerResponseModels.AddSegmentOperationResponse` | `gamePlayer.addSegment.adminSelfEnable` |
+| `getAvatar` | `GamePlayerModels.AdminGetAvatarRequestData` | `getAvatarAsync(...)` | `GamePlayerResponseModels.GetAvatarOperationResponse` | `gamePlayer.getAvatar.adminSelfEnable` |
+| `getCountryCode` | `GamePlayerModels.AdminGetCountryCodeRequestData` | `getCountryCodeAsync(...)` | `GamePlayerResponseModels.GetCountryCodeOperationResponse` | `gamePlayer.getCountryCode.adminSelfEnable` |
+| `getCustomData` | `GamePlayerModels.AdminGetCustomDataRequestData` | `getCustomDataAsync(...)` | `GamePlayerResponseModels.GetCustomDataOperationResponse` | `gamePlayer.getCustomData.adminSelfEnable` |
+| `getDisplayName` | `GamePlayerModels.AdminGetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `GamePlayerResponseModels.GetDisplayNameOperationResponse` | `gamePlayer.getDisplayName.adminSelfEnable` |
+| `getFriendStatisticsLeaderboardAroundPlayer` | `GamePlayerModels.AdminGetFriendStatisticsLeaderboardAroundPlayerRequestData` | `getFriendStatisticsLeaderboardAroundPlayerAsync(...)` | `GamePlayerResponseModels.GetFriendStatisticsLeaderboardAroundPlayerOperationResponse` | `gamePlayer.getFriendStatisticsLeaderboardAroundPlayer.adminSelfEnable` |
+| `getFriendStatisticsLeaderboard` | `GamePlayerModels.AdminGetFriendStatisticsLeaderboardRequestData` | `getFriendStatisticsLeaderboardAsync(...)` | `GamePlayerResponseModels.GetFriendStatisticsLeaderboardOperationResponse` | `gamePlayer.getFriendStatisticsLeaderboard.adminSelfEnable` |
+| `getIpAddressCreate` | `GamePlayerModels.AdminGetIpAddressCreateRequestData` | `getIpAddressCreateAsync(...)` | `GamePlayerResponseModels.GetIpAddressCreateOperationResponse` | `gamePlayer.getIpAddressCreate.adminSelfEnable` |
+| `getOnlineStatus` | `GamePlayerModels.AdminGetOnlineStatusRequestData` | `getOnlineStatusAsync(...)` | `GamePlayerResponseModels.GetOnlineStatusOperationResponse` | `gamePlayer.getOnlineStatus.adminSelfEnable` |
+| `getPlayerBan` | `GamePlayerModels.AdminGetPlayerBanRequestData` | `getPlayerBanAsync(...)` | `GamePlayerResponseModels.GetPlayerBanOperationResponse` | `gamePlayer.getPlayerBan.adminSelfEnable` |
+| `getPlayerCharacter` | `GamePlayerModels.AdminGetPlayerCharacterRequestData` | `getPlayerCharacterAsync(...)` | `GamePlayerResponseModels.GetPlayerCharacterOperationResponse` | `gamePlayer.getPlayerCharacter.adminSelfEnable` |
+| `getPlayerCurrency` | `GamePlayerModels.AdminGetPlayerCurrencyRequestData` | `getPlayerCurrencyAsync(...)` | `GamePlayerResponseModels.GetPlayerCurrencyOperationResponse` | `gamePlayer.getPlayerCurrency.adminSelfEnable` |
+| `getPlayerData` | `GamePlayerModels.AdminGetPlayerDataRequestData` | `getPlayerDataAsync(...)` | `GamePlayerResponseModels.GetPlayerDataOperationResponse` | `gamePlayer.getPlayerData.adminSelfEnable` |
+| `getPlayerFriend` | `GamePlayerModels.AdminGetPlayerFriendRequestData` | `getPlayerFriendAsync(...)` | `GamePlayerResponseModels.GetPlayerFriendOperationResponse` | `gamePlayer.getPlayerFriend.adminSelfEnable` |
+| `getPlayerGroup` | `GamePlayerModels.AdminGetPlayerGroupRequestData` | `getPlayerGroupAsync(...)` | `GamePlayerResponseModels.GetPlayerGroupOperationResponse` | `gamePlayer.getPlayerGroup.adminSelfEnable` |
+| `getPlayerInformation` | `GamePlayerModels.AdminGetPlayerInformationRequestData` | `getPlayerInformationAsync(...)` | `GamePlayerResponseModels.GetPlayerInformationOperationResponse` | `gamePlayer.getPlayerInformation.adminSelfEnable` |
+| `getPlayerInventory` | `GamePlayerModels.AdminGetPlayerInventoryRequestData` | `getPlayerInventoryAsync(...)` | `GamePlayerResponseModels.GetPlayerInventoryOperationResponse` | `gamePlayer.getPlayerInventory.adminSelfEnable` |
+| `getPlayerStatistics` | `GamePlayerModels.AdminGetPlayerStatisticsRequestData` | `getPlayerStatisticsAsync(...)` | `GamePlayerResponseModels.GetPlayerStatisticsOperationResponse` | `gamePlayer.getPlayerStatistics.adminSelfEnable` |
+| `getPlayersWithDisplayName` | `GamePlayerModels.AdminGetPlayersWithDisplayNameRequestData` | `getPlayersWithDisplayNameAsync(...)` | `GamePlayerResponseModels.GetPlayersWithDisplayNameOperationResponse` | `gamePlayer.getPlayersWithDisplayName.adminSelfEnable` |
+| `getPlayersWithSegment` | `GamePlayerModels.AdminGetPlayersWithSegmentRequestData` | `getPlayersWithSegmentAsync(...)` | `GamePlayerResponseModels.GetPlayersWithSegmentOperationResponse` | `gamePlayer.getPlayersWithSegment.adminSelfEnable` |
+| `getPlayersWithTag` | `GamePlayerModels.AdminGetPlayersWithTagRequestData` | `getPlayersWithTagAsync(...)` | `GamePlayerResponseModels.GetPlayersWithTagOperationResponse` | `gamePlayer.getPlayersWithTag.adminSelfEnable` |
+| `getSegment` | `GamePlayerModels.AdminGetSegmentRequestData` | `getSegmentAsync(...)` | `GamePlayerResponseModels.GetSegmentOperationResponse` | `gamePlayer.getSegment.adminSelfEnable` |
+| `getStatisticsLeaderboardAroundPlayer` | `GamePlayerModels.AdminGetStatisticsLeaderboardAroundPlayerRequestData` | `getStatisticsLeaderboardAroundPlayerAsync(...)` | `GamePlayerResponseModels.GetStatisticsLeaderboardAroundPlayerOperationResponse` | `gamePlayer.getStatisticsLeaderboardAroundPlayer.adminSelfEnable` |
+| `getStatisticsLeaderboard` | `GamePlayerModels.AdminGetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `GamePlayerResponseModels.GetStatisticsLeaderboardOperationResponse` | `gamePlayer.getStatisticsLeaderboard.adminSelfEnable` |
+| `getTag` | `GamePlayerModels.AdminGetTagRequestData` | `getTagAsync(...)` | `GamePlayerResponseModels.GetTagOperationResponse` | `gamePlayer.getTag.adminSelfEnable` |
+| `getTsCreate` | `GamePlayerModels.AdminGetTsCreateRequestData` | `getTsCreateAsync(...)` | `GamePlayerResponseModels.GetTsCreateOperationResponse` | `gamePlayer.getTsCreate.adminSelfEnable` |
+| `getTsLastLogin` | `GamePlayerModels.AdminGetTsLastLoginRequestData` | `getTsLastLoginAsync(...)` | `GamePlayerResponseModels.GetTsLastLoginOperationResponse` | `gamePlayer.getTsLastLogin.adminSelfEnable` |
+| `createGroup` | `GamePlayerModels.AdminCreateGroupRequestData` | `createGroupAsync(...)` | `GamePlayerResponseModels.CreateGroupOperationResponse` | `gamePlayer.createGroup.adminSelfEnable` |
+| `createPlayerCharacter` | `GamePlayerModels.AdminCreatePlayerCharacterRequestData` | `createPlayerCharacterAsync(...)` | `GamePlayerResponseModels.CreatePlayerCharacterOperationResponse` | `gamePlayer.createPlayerCharacter.adminSelfEnable` |
+| `createPlayerItem` | `GamePlayerModels.AdminCreatePlayerItemRequestData` | `createPlayerItemAsync(...)` | `GamePlayerResponseModels.CreatePlayerItemOperationResponse` | `gamePlayer.createPlayerItem.adminSelfEnable` |
+| `joinGroup` | `GamePlayerModels.AdminJoinGroupRequestData` | `joinGroupAsync(...)` | `GamePlayerResponseModels.JoinGroupOperationResponse` | `gamePlayer.joinGroup.adminSelfEnable` |
+| `leaveGroup` | `GamePlayerModels.AdminLeaveGroupRequestData` | `leaveGroupAsync(...)` | `GamePlayerResponseModels.LeaveGroupOperationResponse` | `gamePlayer.leaveGroup.adminSelfEnable` |
+| `removePlayerCharacter` | `GamePlayerModels.AdminRemovePlayerCharacterRequestData` | `removePlayerCharacterAsync(...)` | `GamePlayerResponseModels.RemovePlayerCharacterOperationResponse` | `gamePlayer.removePlayerCharacter.adminSelfEnable` |
+| `removePlayerFriend` | `GamePlayerModels.AdminRemovePlayerFriendRequestData` | `removePlayerFriendAsync(...)` | `GamePlayerResponseModels.RemovePlayerFriendOperationResponse` | `gamePlayer.removePlayerFriend.adminSelfEnable` |
+| `removePlayerItem` | `GamePlayerModels.AdminRemovePlayerItemRequestData` | `removePlayerItemAsync(...)` | `GamePlayerResponseModels.RemovePlayerItemOperationResponse` | `gamePlayer.removePlayerItem.adminSelfEnable` |
+| `removeSegment` | `GamePlayerModels.AdminRemoveSegmentRequestData` | `removeSegmentAsync(...)` | `GamePlayerResponseModels.RemoveSegmentOperationResponse` | `gamePlayer.removeSegment.adminSelfEnable` |
+| `removeTag` | `GamePlayerModels.AdminRemoveTagRequestData` | `removeTagAsync(...)` | `GamePlayerResponseModels.RemoveTagOperationResponse` | `gamePlayer.removeTag.adminSelfEnable` |
+| `setAvatar` | `GamePlayerModels.AdminSetAvatarRequestData` | `setAvatarAsync(...)` | `GamePlayerResponseModels.SetAvatarOperationResponse` | `gamePlayer.setAvatar.adminSelfEnable` |
+| `setCountryCode` | `GamePlayerModels.AdminSetCountryCodeRequestData` | `setCountryCodeAsync(...)` | `GamePlayerResponseModels.SetCountryCodeOperationResponse` | `gamePlayer.setCountryCode.adminSelfEnable` |
+| `setCustomData` | `GamePlayerModels.AdminSetCustomDataRequestData` | `setCustomDataAsync(...)` | `GamePlayerResponseModels.SetCustomDataOperationResponse` | `gamePlayer.setCustomData.adminSelfEnable` |
+| `setDisplayName` | `GamePlayerModels.AdminSetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `GamePlayerResponseModels.SetDisplayNameOperationResponse` | `gamePlayer.setDisplayName.adminSelfEnable` |
+| `setPlayerBan` | `GamePlayerModels.AdminSetPlayerBanRequestData` | `setPlayerBanAsync(...)` | `GamePlayerResponseModels.SetPlayerBanOperationResponse` | `gamePlayer.setPlayerBan.adminSelfEnable` |
+| `changePlayerCurrency` | `GamePlayerModels.AdminChangePlayerCurrencyRequestData` | `changePlayerCurrencyAsync(...)` | `GamePlayerResponseModels.ChangePlayerCurrencyOperationResponse` | `gamePlayer.changePlayerCurrency.adminSelfEnable` |
+| `setPlayerData` | `GamePlayerModels.AdminSetPlayerDataRequestData` | `setPlayerDataAsync(...)` | `GamePlayerResponseModels.SetPlayerDataOperationResponse` | `gamePlayer.setPlayerData.adminSelfEnable` |
+| `changePlayerStatistics` | `GamePlayerModels.AdminChangePlayerStatisticsRequestData` | `changePlayerStatisticsAsync(...)` | `GamePlayerResponseModels.ChangePlayerStatisticsOperationResponse` | `gamePlayer.changePlayerStatistics.adminSelfEnable` |
+| `setTag` | `GamePlayerModels.AdminSetTagRequestData` | `setTagAsync(...)` | `GamePlayerResponseModels.SetTagOperationResponse` | `gamePlayer.setTag.adminSelfEnable` |
+| `getCurrencyLeaderboard` | `GamePlayerModels.AdminGetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `GamePlayerResponseModels.GetCurrencyLeaderboardOperationResponse` | `gamePlayer.getCurrencyLeaderboard.adminSelfEnable` |
+| `getLastLoginLeaderboard` | `GamePlayerModels.AdminGetLastLoginLeaderboardRequestData` | `getLastLoginLeaderboardAsync(...)` | `GamePlayerResponseModels.GetLastLoginLeaderboardOperationResponse` | `gamePlayer.getLastLoginLeaderboard.adminSelfEnable` |
+| `getCreateLeaderboard` | `GamePlayerModels.AdminGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `GamePlayerResponseModels.GetCreateLeaderboardOperationResponse` | `gamePlayer.getCreateLeaderboard.adminSelfEnable` |
+| `getStatisticsLog` | `GamePlayerModels.AdminGetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `GamePlayerResponseModels.GetStatisticsLogOperationResponse` | `gamePlayer.getStatisticsLog.adminSelfEnable` |
+| `getCurrencyLog` | `GamePlayerModels.AdminGetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `GamePlayerResponseModels.GetCurrencyLogOperationResponse` | `gamePlayer.getCurrencyLog.adminSelfEnable` |
+
+
+## Ví dụ tối thiểu
+
+```ts
+import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
+
+// requestData: GamePlayerModels.AddPlayerFriendRequestData đã build theo dto/GAME_PLAYER.md
+const res = await GNNetwork.gamePlayer.addPlayerFriendAsync(requestData);
+if (res.returnCode !== ReturnCode.Ok) return;
+if (res.errorCode !== ErrorCode.Ok) return;
+// res.responseData có typed payload
+```

package/docs/reference/API_GROUP.md

@@ -0,0 +1,187 @@
+# API Reference: GroupApi
+
+Group metadata, member roster, message stream, group-level currency/inventory/statistics.
+
+Domain guide: [guides/GROUP.md](../guides/GROUP.md). DTO shapes: [dto/GROUP.md](dto/GROUP.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
+
+## Namespaces
+
+- `GNNetwork.group` — `RequestRole.Client`
+- `GNNetwork.group.server` — `RequestRole.Server`
+- `GNNetwork.group.admin` — `RequestRole.Admin`
+
+## Convention
+
+Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
+
+```ts
+// Callback
+GNNetwork.group.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
+
+// Async
+const res = await GNNetwork.group.<method>Async(requestData, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
+```
+
+Param chung:
+
+| Param | Type | Optional | Notes |
+|-------|------|----------|-------|
+| `requestData` | domain-specific (xem bảng dưới) | no | Payload chính |
+| `onResponse` | `Action1<TResponse>` | yes | Chỉ có ở callback form |
+| `overrideAuthToken` | `string` | yes | Override `authToken` cache cho request này |
+| `overrideSecretKey` | `string` | yes | Override secret key mặc định của route |
+| `customTags` | `GNHashtable` | yes | Tags gắn vào request, backend có thể log/route |
+| `timeout` | `number` | yes | Timeout giây; default = `OperationRequest.defaultTimeOut` |
+
+Response class expose field: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
+
+
+## Client methods (`GNNetwork.group.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules | Permission Rules khi truyền `groupId` mà `gamePlayer` đang authenticated và những `characterPlayer` có owner của `gamePlayer` đều không phải là member của `group` này |
+|--------|-------------|------------|----------------|--------------------------|-------------------------------------------------------------------------------|
+| `addMember` | `GroupModels.AddMemberRequestData` | `addMemberAsync(...)` | `GroupResponseModels.AddMemberOperationResponse` | `group.addMember.selfEnable` | `group.addMember.otherSelfEnable` |
+| `addSegment` | `GroupModels.AddSegmentRequestData` | `addSegmentAsync(...)` | `GroupResponseModels.AddSegmentOperationResponse` | `group.addSegment.selfEnable` | `group.addSegment.otherSelfEnable` |
+| `getAvatar` | `GroupModels.GetAvatarRequestData` | `getAvatarAsync(...)` | `GroupResponseModels.GetAvatarOperationResponse` | `group.getAvatar.selfEnable` | `group.getAvatar.otherSelfEnable` |
+| `getCatalogId` | `GroupModels.GetCatalogIdRequestData` | `getCatalogIdAsync(...)` | `GroupResponseModels.GetCatalogIdOperationResponse` | `group.getCatalogId.selfEnable` | `group.getCatalogId.otherSelfEnable` |
+| `getCustomData` | `GroupModels.GetCustomDataRequestData` | `getCustomDataAsync(...)` | `GroupResponseModels.GetCustomDataOperationResponse` | `group.getCustomData.selfEnable` | `group.getCustomData.otherSelfEnable` |
+| `getDisplayName` | `GroupModels.GetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `GroupResponseModels.GetDisplayNameOperationResponse` | `group.getDisplayName.selfEnable` | `group.getDisplayName.otherSelfEnable` |
+| `getGroupCurrency` | `GroupModels.GetGroupCurrencyRequestData` | `getGroupCurrencyAsync(...)` | `GroupResponseModels.GetGroupCurrencyOperationResponse` | `group.getGroupCurrency.selfEnable` | `group.getGroupCurrency.otherSelfEnable` |
+| `getGroupData` | `GroupModels.GetGroupDataRequestData` | `getGroupDataAsync(...)` | `GroupResponseModels.GetGroupDataOperationResponse` | `group.getGroupData.selfEnable` | `group.getGroupData.otherSelfEnable` |
+| `getGroupInformation` | `GroupModels.GetGroupInformationRequestData` | `getGroupInformationAsync(...)` | `GroupResponseModels.GetGroupInformationOperationResponse` | `group.getGroupInformation.selfEnable` | `group.getGroupInformation.otherSelfEnable` |
+| `getGroupInventory` | `GroupModels.GetGroupInventoryRequestData` | `getGroupInventoryAsync(...)` | `GroupResponseModels.GetGroupInventoryOperationResponse` | `group.getGroupInventory.selfEnable` | `group.getGroupInventory.otherSelfEnable` |
+| `getGroupMessage` | `GroupModels.GetGroupMessageRequestData` | `getGroupMessageAsync(...)` | `GroupResponseModels.GetGroupMessageOperationResponse` | `group.getGroupMessage.selfEnable` | `group.getGroupMessage.otherSelfEnable` |
+| `getGroupStatistics` | `GroupModels.GetGroupStatisticsRequestData` | `getGroupStatisticsAsync(...)` | `GroupResponseModels.GetGroupStatisticsOperationResponse` | `group.getGroupStatistics.selfEnable` | `group.getGroupStatistics.otherSelfEnable` |
+| `getGroupsWithDisplayName` | `GroupModels.GetGroupsWithDisplayNameRequestData` | `getGroupsWithDisplayNameAsync(...)` | `GroupResponseModels.GetGroupsWithDisplayNameOperationResponse` | `group.getGroupsWithDisplayName.otherSelfEnable` | |
+| `getGroupsWithSegment` | `GroupModels.GetGroupsWithSegmentRequestData` | `getGroupsWithSegmentAsync(...)` | `GroupResponseModels.GetGroupsWithSegmentOperationResponse` | `group.getGroupsWithSegment.otherSelfEnable` | |
+| `getGroupsWithTag` | `GroupModels.GetGroupsWithTagRequestData` | `getGroupsWithTagAsync(...)` | `GroupResponseModels.GetGroupsWithTagOperationResponse` | `group.getGroupsWithTag.otherSelfEnable` | |
+| `getMembers` | `GroupModels.GetMembersRequestData` | `getMembersAsync(...)` | `GroupResponseModels.GetMembersOperationResponse` | `group.getMembers.selfEnable` | `group.getMembers.otherSelfEnable` |
+| `getRemoveStatus` | `GroupModels.GetRemoveStatusRequestData` | `getRemoveStatusAsync(...)` | `GroupResponseModels.GetRemoveStatusOperationResponse` | `group.getRemoveStatus.selfEnable` | `group.getRemoveStatus.otherSelfEnable` |
+| `getSegment` | `GroupModels.GetSegmentRequestData` | `getSegmentAsync(...)` | `GroupResponseModels.GetSegmentOperationResponse` | `group.getSegment.selfEnable` | `group.getSegment.otherSelfEnable` |
+| `getStatisticsLeaderboardAroundGroup` | `GroupModels.GetStatisticsLeaderboardAroundGroupRequestData` | `getStatisticsLeaderboardAroundGroupAsync(...)` | `GroupResponseModels.GetStatisticsLeaderboardAroundGroupOperationResponse` | `group.getStatisticsLeaderboardAroundGroup.selfEnable` | `group.getStatisticsLeaderboardAroundGroup.otherSelfEnable` |
+| `getStatisticsLeaderboard` | `GroupModels.GetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `GroupResponseModels.GetStatisticsLeaderboardOperationResponse` | `group.getStatisticsLeaderboard.otherSelfEnable` | |
+| `getTag` | `GroupModels.GetTagRequestData` | `getTagAsync(...)` | `GroupResponseModels.GetTagOperationResponse` | `group.getTag.selfEnable` | `group.getTag.otherSelfEnable` |
+| `getTsCreate` | `GroupModels.GetTsCreateRequestData` | `getTsCreateAsync(...)` | `GroupResponseModels.GetTsCreateOperationResponse` | `group.getTsCreate.selfEnable` | `group.getTsCreate.otherSelfEnable` |
+| `createGroupItem` | `GroupModels.CreateGroupItemRequestData` | `createGroupItemAsync(...)` | `GroupResponseModels.CreateGroupItemOperationResponse` | `group.createGroupItem.selfEnable` | `group.createGroupItem.otherSelfEnable` |
+| `removeGroupItem` | `GroupModels.RemoveGroupItemRequestData` | `removeGroupItemAsync(...)` | `GroupResponseModels.RemoveGroupItemOperationResponse` | `group.removeGroupItem.selfEnable` | `group.removeGroupItem.otherSelfEnable` |
+| `removeMember` | `GroupModels.RemoveMemberRequestData` | `removeMemberAsync(...)` | `GroupResponseModels.RemoveMemberOperationResponse` | `group.removeMember.selfEnable` | `group.removeMember.otherSelfEnable` |
+| `removeSegment` | `GroupModels.RemoveSegmentRequestData` | `removeSegmentAsync(...)` | `GroupResponseModels.RemoveSegmentOperationResponse` | `group.removeSegment.selfEnable` | `group.removeSegment.otherSelfEnable` |
+| `removeTag` | `GroupModels.RemoveTagRequestData` | `removeTagAsync(...)` | `GroupResponseModels.RemoveTagOperationResponse` | `group.removeTag.selfEnable` | `group.removeTag.otherSelfEnable` |
+| `sendGroupMessage` | `GroupModels.SendGroupMessageRequestData` | `sendGroupMessageAsync(...)` | `GroupResponseModels.SendGroupMessageOperationResponse` | `group.sendGroupMessage.selfEnable` | `group.sendGroupMessage.otherSelfEnable` |
+| `setAvatar` | `GroupModels.SetAvatarRequestData` | `setAvatarAsync(...)` | `GroupResponseModels.SetAvatarOperationResponse` | `group.setAvatar.selfEnable` | `group.setAvatar.otherSelfEnable` |
+| `setCustomData` | `GroupModels.SetCustomDataRequestData` | `setCustomDataAsync(...)` | `GroupResponseModels.SetCustomDataOperationResponse` | `group.setCustomData.selfEnable` | `group.setCustomData.otherSelfEnable` |
+| `setDisplayName` | `GroupModels.SetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `GroupResponseModels.SetDisplayNameOperationResponse` | `group.setDisplayName.selfEnable` | `group.setDisplayName.otherSelfEnable` |
+| `changeGroupCurrency` | `GroupModels.ChangeGroupCurrencyRequestData` | `changeGroupCurrencyAsync(...)` | `GroupResponseModels.ChangeGroupCurrencyOperationResponse` | `group.changeGroupCurrency.selfEnable` | `group.changeGroupCurrency.otherSelfEnable` |
+| `setGroupData` | `GroupModels.SetGroupDataRequestData` | `setGroupDataAsync(...)` | `GroupResponseModels.SetGroupDataOperationResponse` | `group.setGroupData.selfEnable` | `group.setGroupData.otherSelfEnable` |
+| `changeGroupStatistics` | `GroupModels.ChangeGroupStatisticsRequestData` | `changeGroupStatisticsAsync(...)` | `GroupResponseModels.ChangeGroupStatisticsOperationResponse` | `group.changeGroupStatistics.selfEnable` | `group.changeGroupStatistics.otherSelfEnable` |
+| `setRemoveStatus` | `GroupModels.SetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `GroupResponseModels.SetRemoveStatusOperationResponse` | `group.setRemoveStatus.selfEnable` | `group.setRemoveStatus.otherSelfEnable` |
+| `setTag` | `GroupModels.SetTagRequestData` | `setTagAsync(...)` | `GroupResponseModels.SetTagOperationResponse` | `group.setTag.selfEnable` | `group.setTag.otherSelfEnable` |
+| `getCurrencyLeaderboard` | `GroupModels.GetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `GroupResponseModels.GetCurrencyLeaderboardOperationResponse` | `group.getCurrencyLeaderboard.otherSelfEnable` | |
+| `getCreateLeaderboard` | `GroupModels.GetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `GroupResponseModels.GetCreateLeaderboardOperationResponse` | `group.getCreateLeaderboard.otherSelfEnable` | |
+| `getStatisticsLog` | `GroupModels.GetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `GroupResponseModels.GetStatisticsLogOperationResponse` | `group.getStatisticsLog.selfEnable` | `group.getStatisticsLog.otherSelfEnable` |
+| `getCurrencyLog` | `GroupModels.GetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `GroupResponseModels.GetCurrencyLogOperationResponse` | `group.getCurrencyLog.selfEnable` | `group.getCurrencyLog.otherSelfEnable` |
+
+
+## Server methods (`GNNetwork.group.server.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `addMember` | `GroupModels.ServerAddMemberRequestData` | `addMemberAsync(...)` | `GroupResponseModels.AddMemberOperationResponse` | `group.addMember.serverSelfEnable` |
+| `addSegment` | `GroupModels.ServerAddSegmentRequestData` | `addSegmentAsync(...)` | `GroupResponseModels.AddSegmentOperationResponse` | `group.addSegment.serverSelfEnable` |
+| `getAvatar` | `GroupModels.ServerGetAvatarRequestData` | `getAvatarAsync(...)` | `GroupResponseModels.GetAvatarOperationResponse` | `group.getAvatar.serverSelfEnable` |
+| `getCatalogId` | `GroupModels.ServerGetCatalogIdRequestData` | `getCatalogIdAsync(...)` | `GroupResponseModels.GetCatalogIdOperationResponse` | `group.getCatalogId.serverSelfEnable` |
+| `getCustomData` | `GroupModels.ServerGetCustomDataRequestData` | `getCustomDataAsync(...)` | `GroupResponseModels.GetCustomDataOperationResponse` | `group.getCustomData.serverSelfEnable` |
+| `getDisplayName` | `GroupModels.ServerGetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `GroupResponseModels.GetDisplayNameOperationResponse` | `group.getDisplayName.serverSelfEnable` |
+| `getGroupCurrency` | `GroupModels.ServerGetGroupCurrencyRequestData` | `getGroupCurrencyAsync(...)` | `GroupResponseModels.GetGroupCurrencyOperationResponse` | `group.getGroupCurrency.serverSelfEnable` |
+| `getGroupData` | `GroupModels.ServerGetGroupDataRequestData` | `getGroupDataAsync(...)` | `GroupResponseModels.GetGroupDataOperationResponse` | `group.getGroupData.serverSelfEnable` |
+| `getGroupInformation` | `GroupModels.ServerGetGroupInformationRequestData` | `getGroupInformationAsync(...)` | `GroupResponseModels.GetGroupInformationOperationResponse` | `group.getGroupInformation.serverSelfEnable` |
+| `getGroupInventory` | `GroupModels.ServerGetGroupInventoryRequestData` | `getGroupInventoryAsync(...)` | `GroupResponseModels.GetGroupInventoryOperationResponse` | `group.getGroupInventory.serverSelfEnable` |
+| `getGroupMessage` | `GroupModels.ServerGetGroupMessageRequestData` | `getGroupMessageAsync(...)` | `GroupResponseModels.GetGroupMessageOperationResponse` | `group.getGroupMessage.serverSelfEnable` |
+| `getGroupStatistics` | `GroupModels.ServerGetGroupStatisticsRequestData` | `getGroupStatisticsAsync(...)` | `GroupResponseModels.GetGroupStatisticsOperationResponse` | `group.getGroupStatistics.serverSelfEnable` |
+| `getGroupsWithDisplayName` | `GroupModels.ServerGetGroupsWithDisplayNameRequestData` | `getGroupsWithDisplayNameAsync(...)` | `GroupResponseModels.GetGroupsWithDisplayNameOperationResponse` | `group.getGroupsWithDisplayName.serverSelfEnable` |
+| `getGroupsWithSegment` | `GroupModels.ServerGetGroupsWithSegmentRequestData` | `getGroupsWithSegmentAsync(...)` | `GroupResponseModels.GetGroupsWithSegmentOperationResponse` | `group.getGroupsWithSegment.serverSelfEnable` |
+| `getGroupsWithTag` | `GroupModels.ServerGetGroupsWithTagRequestData` | `getGroupsWithTagAsync(...)` | `GroupResponseModels.GetGroupsWithTagOperationResponse` | `group.getGroupsWithTag.serverSelfEnable` |
+| `getMembers` | `GroupModels.ServerGetMembersRequestData` | `getMembersAsync(...)` | `GroupResponseModels.GetMembersOperationResponse` | `group.getMembers.serverSelfEnable` |
+| `getRemoveStatus` | `GroupModels.ServerGetRemoveStatusRequestData` | `getRemoveStatusAsync(...)` | `GroupResponseModels.GetRemoveStatusOperationResponse` | `group.getRemoveStatus.serverSelfEnable` |
+| `getSegment` | `GroupModels.ServerGetSegmentRequestData` | `getSegmentAsync(...)` | `GroupResponseModels.GetSegmentOperationResponse` | `group.getSegment.serverSelfEnable` |
+| `getStatisticsLeaderboardAroundGroup` | `GroupModels.ServerGetStatisticsLeaderboardAroundGroupRequestData` | `getStatisticsLeaderboardAroundGroupAsync(...)` | `GroupResponseModels.GetStatisticsLeaderboardAroundGroupOperationResponse` | `group.getStatisticsLeaderboardAroundGroup.serverSelfEnable` |
+| `getStatisticsLeaderboard` | `GroupModels.ServerGetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `GroupResponseModels.GetStatisticsLeaderboardOperationResponse` | `group.getStatisticsLeaderboard.serverSelfEnable` |
+| `getTag` | `GroupModels.ServerGetTagRequestData` | `getTagAsync(...)` | `GroupResponseModels.GetTagOperationResponse` | `group.getTag.serverSelfEnable` |
+| `getTsCreate` | `GroupModels.ServerGetTsCreateRequestData` | `getTsCreateAsync(...)` | `GroupResponseModels.GetTsCreateOperationResponse` | `group.getTsCreate.serverSelfEnable` |
+| `createGroupItem` | `GroupModels.ServerCreateGroupItemRequestData` | `createGroupItemAsync(...)` | `GroupResponseModels.CreateGroupItemOperationResponse` | `group.createGroupItem.serverSelfEnable` |
+| `removeGroupItem` | `GroupModels.ServerRemoveGroupItemRequestData` | `removeGroupItemAsync(...)` | `GroupResponseModels.RemoveGroupItemOperationResponse` | `group.removeGroupItem.serverSelfEnable` |
+| `removeMember` | `GroupModels.ServerRemoveMemberRequestData` | `removeMemberAsync(...)` | `GroupResponseModels.RemoveMemberOperationResponse` | `group.removeMember.serverSelfEnable` |
+| `removeSegment` | `GroupModels.ServerRemoveSegmentRequestData` | `removeSegmentAsync(...)` | `GroupResponseModels.RemoveSegmentOperationResponse` | `group.removeSegment.serverSelfEnable` |
+| `removeTag` | `GroupModels.ServerRemoveTagRequestData` | `removeTagAsync(...)` | `GroupResponseModels.RemoveTagOperationResponse` | `group.removeTag.serverSelfEnable` |
+| `sendGroupMessage` | `GroupModels.ServerSendGroupMessageRequestData` | `sendGroupMessageAsync(...)` | `GroupResponseModels.SendGroupMessageOperationResponse` | `group.sendGroupMessage.serverSelfEnable` |
+| `setAvatar` | `GroupModels.ServerSetAvatarRequestData` | `setAvatarAsync(...)` | `GroupResponseModels.SetAvatarOperationResponse` | `group.setAvatar.serverSelfEnable` |
+| `setCustomData` | `GroupModels.ServerSetCustomDataRequestData` | `setCustomDataAsync(...)` | `GroupResponseModels.SetCustomDataOperationResponse` | `group.setCustomData.serverSelfEnable` |
+| `setDisplayName` | `GroupModels.ServerSetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `GroupResponseModels.SetDisplayNameOperationResponse` | `group.setDisplayName.serverSelfEnable` |
+| `changeGroupCurrency` | `GroupModels.ServerChangeGroupCurrencyRequestData` | `changeGroupCurrencyAsync(...)` | `GroupResponseModels.ChangeGroupCurrencyOperationResponse` | `group.changeGroupCurrency.serverSelfEnable` |
+| `setGroupData` | `GroupModels.ServerSetGroupDataRequestData` | `setGroupDataAsync(...)` | `GroupResponseModels.SetGroupDataOperationResponse` | `group.setGroupData.serverSelfEnable` |
+| `changeGroupStatistics` | `GroupModels.ServerChangeGroupStatisticsRequestData` | `changeGroupStatisticsAsync(...)` | `GroupResponseModels.ChangeGroupStatisticsOperationResponse` | `group.changeGroupStatistics.serverSelfEnable` |
+| `setRemoveStatus` | `GroupModels.ServerSetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `GroupResponseModels.SetRemoveStatusOperationResponse` | `group.setRemoveStatus.serverSelfEnable` |
+| `setTag` | `GroupModels.ServerSetTagRequestData` | `setTagAsync(...)` | `GroupResponseModels.SetTagOperationResponse` | `group.setTag.serverSelfEnable` |
+| `getCurrencyLeaderboard` | `GroupModels.ServerGetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `GroupResponseModels.GetCurrencyLeaderboardOperationResponse` | `group.getCurrencyLeaderboard.serverSelfEnable` |
+| `getCreateLeaderboard` | `GroupModels.ServerGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `GroupResponseModels.GetCreateLeaderboardOperationResponse` | `group.getCreateLeaderboard.serverSelfEnable` |
+| `getStatisticsLog` | `GroupModels.ServerGetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `GroupResponseModels.GetStatisticsLogOperationResponse` | `group.getStatisticsLog.serverSelfEnable` |
+| `getCurrencyLog` | `GroupModels.ServerGetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `GroupResponseModels.GetCurrencyLogOperationResponse` | `group.getCurrencyLog.serverSelfEnable` |
+
+
+## Admin methods (`GNNetwork.group.admin.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `addMember` | `GroupModels.AdminAddMemberRequestData` | `addMemberAsync(...)` | `GroupResponseModels.AddMemberOperationResponse` | `group.addMember.adminSelfEnable` |
+| `addSegment` | `GroupModels.AdminAddSegmentRequestData` | `addSegmentAsync(...)` | `GroupResponseModels.AddSegmentOperationResponse` | `group.addSegment.adminSelfEnable` |
+| `getAvatar` | `GroupModels.AdminGetAvatarRequestData` | `getAvatarAsync(...)` | `GroupResponseModels.GetAvatarOperationResponse` | `group.getAvatar.adminSelfEnable` |
+| `getCatalogId` | `GroupModels.AdminGetCatalogIdRequestData` | `getCatalogIdAsync(...)` | `GroupResponseModels.GetCatalogIdOperationResponse` | `group.getCatalogId.adminSelfEnable` |
+| `getCustomData` | `GroupModels.AdminGetCustomDataRequestData` | `getCustomDataAsync(...)` | `GroupResponseModels.GetCustomDataOperationResponse` | `group.getCustomData.adminSelfEnable` |
+| `getDisplayName` | `GroupModels.AdminGetDisplayNameRequestData` | `getDisplayNameAsync(...)` | `GroupResponseModels.GetDisplayNameOperationResponse` | `group.getDisplayName.adminSelfEnable` |
+| `getGroupCurrency` | `GroupModels.AdminGetGroupCurrencyRequestData` | `getGroupCurrencyAsync(...)` | `GroupResponseModels.GetGroupCurrencyOperationResponse` | `group.getGroupCurrency.adminSelfEnable` |
+| `getGroupData` | `GroupModels.AdminGetGroupDataRequestData` | `getGroupDataAsync(...)` | `GroupResponseModels.GetGroupDataOperationResponse` | `group.getGroupData.adminSelfEnable` |
+| `getGroupInformation` | `GroupModels.AdminGetGroupInformationRequestData` | `getGroupInformationAsync(...)` | `GroupResponseModels.GetGroupInformationOperationResponse` | `group.getGroupInformation.adminSelfEnable` |
+| `getGroupInventory` | `GroupModels.AdminGetGroupInventoryRequestData` | `getGroupInventoryAsync(...)` | `GroupResponseModels.GetGroupInventoryOperationResponse` | `group.getGroupInventory.adminSelfEnable` |
+| `getGroupMessage` | `GroupModels.AdminGetGroupMessageRequestData` | `getGroupMessageAsync(...)` | `GroupResponseModels.GetGroupMessageOperationResponse` | `group.getGroupMessage.adminSelfEnable` |
+| `getGroupStatistics` | `GroupModels.AdminGetGroupStatisticsRequestData` | `getGroupStatisticsAsync(...)` | `GroupResponseModels.GetGroupStatisticsOperationResponse` | `group.getGroupStatistics.adminSelfEnable` |
+| `getGroupsWithDisplayName` | `GroupModels.AdminGetGroupsWithDisplayNameRequestData` | `getGroupsWithDisplayNameAsync(...)` | `GroupResponseModels.GetGroupsWithDisplayNameOperationResponse` | `group.getGroupsWithDisplayName.adminSelfEnable` |
+| `getGroupsWithSegment` | `GroupModels.AdminGetGroupsWithSegmentRequestData` | `getGroupsWithSegmentAsync(...)` | `GroupResponseModels.GetGroupsWithSegmentOperationResponse` | `group.getGroupsWithSegment.adminSelfEnable` |
+| `getGroupsWithTag` | `GroupModels.AdminGetGroupsWithTagRequestData` | `getGroupsWithTagAsync(...)` | `GroupResponseModels.GetGroupsWithTagOperationResponse` | `group.getGroupsWithTag.adminSelfEnable` |
+| `getMembers` | `GroupModels.AdminGetMembersRequestData` | `getMembersAsync(...)` | `GroupResponseModels.GetMembersOperationResponse` | `group.getMembers.adminSelfEnable` |
+| `getRemoveStatus` | `GroupModels.AdminGetRemoveStatusRequestData` | `getRemoveStatusAsync(...)` | `GroupResponseModels.GetRemoveStatusOperationResponse` | `group.getRemoveStatus.adminSelfEnable` |
+| `getSegment` | `GroupModels.AdminGetSegmentRequestData` | `getSegmentAsync(...)` | `GroupResponseModels.GetSegmentOperationResponse` | `group.getSegment.adminSelfEnable` |
+| `getStatisticsLeaderboardAroundGroup` | `GroupModels.AdminGetStatisticsLeaderboardAroundGroupRequestData` | `getStatisticsLeaderboardAroundGroupAsync(...)` | `GroupResponseModels.GetStatisticsLeaderboardAroundGroupOperationResponse` | `group.getStatisticsLeaderboardAroundGroup.adminSelfEnable` |
+| `getStatisticsLeaderboard` | `GroupModels.AdminGetStatisticsLeaderboardRequestData` | `getStatisticsLeaderboardAsync(...)` | `GroupResponseModels.GetStatisticsLeaderboardOperationResponse` | `group.getStatisticsLeaderboard.adminSelfEnable` |
+| `getTag` | `GroupModels.AdminGetTagRequestData` | `getTagAsync(...)` | `GroupResponseModels.GetTagOperationResponse` | `group.getTag.adminSelfEnable` |
+| `getTsCreate` | `GroupModels.AdminGetTsCreateRequestData` | `getTsCreateAsync(...)` | `GroupResponseModels.GetTsCreateOperationResponse` | `group.getTsCreate.adminSelfEnable` |
+| `createGroupItem` | `GroupModels.AdminCreateGroupItemRequestData` | `createGroupItemAsync(...)` | `GroupResponseModels.CreateGroupItemOperationResponse` | `group.createGroupItem.adminSelfEnable` |
+| `removeGroupItem` | `GroupModels.AdminRemoveGroupItemRequestData` | `removeGroupItemAsync(...)` | `GroupResponseModels.RemoveGroupItemOperationResponse` | `group.removeGroupItem.adminSelfEnable` |
+| `removeMember` | `GroupModels.AdminRemoveMemberRequestData` | `removeMemberAsync(...)` | `GroupResponseModels.RemoveMemberOperationResponse` | `group.removeMember.adminSelfEnable` |
+| `removeSegment` | `GroupModels.AdminRemoveSegmentRequestData` | `removeSegmentAsync(...)` | `GroupResponseModels.RemoveSegmentOperationResponse` | `group.removeSegment.adminSelfEnable` |
+| `removeTag` | `GroupModels.AdminRemoveTagRequestData` | `removeTagAsync(...)` | `GroupResponseModels.RemoveTagOperationResponse` | `group.removeTag.adminSelfEnable` |
+| `sendGroupMessage` | `GroupModels.AdminSendGroupMessageRequestData` | `sendGroupMessageAsync(...)` | `GroupResponseModels.SendGroupMessageOperationResponse` | `group.sendGroupMessage.adminSelfEnable` |
+| `setAvatar` | `GroupModels.AdminSetAvatarRequestData` | `setAvatarAsync(...)` | `GroupResponseModels.SetAvatarOperationResponse` | `group.setAvatar.adminSelfEnable` |
+| `setCustomData` | `GroupModels.AdminSetCustomDataRequestData` | `setCustomDataAsync(...)` | `GroupResponseModels.SetCustomDataOperationResponse` | `group.setCustomData.adminSelfEnable` |
+| `setDisplayName` | `GroupModels.AdminSetDisplayNameRequestData` | `setDisplayNameAsync(...)` | `GroupResponseModels.SetDisplayNameOperationResponse` | `group.setDisplayName.adminSelfEnable` |
+| `changeGroupCurrency` | `GroupModels.AdminChangeGroupCurrencyRequestData` | `changeGroupCurrencyAsync(...)` | `GroupResponseModels.ChangeGroupCurrencyOperationResponse` | `group.changeGroupCurrency.adminSelfEnable` |
+| `setGroupData` | `GroupModels.AdminSetGroupDataRequestData` | `setGroupDataAsync(...)` | `GroupResponseModels.SetGroupDataOperationResponse` | `group.setGroupData.adminSelfEnable` |
+| `changeGroupStatistics` | `GroupModels.AdminChangeGroupStatisticsRequestData` | `changeGroupStatisticsAsync(...)` | `GroupResponseModels.ChangeGroupStatisticsOperationResponse` | `group.changeGroupStatistics.adminSelfEnable` |
+| `setRemoveStatus` | `GroupModels.AdminSetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `GroupResponseModels.SetRemoveStatusOperationResponse` | `group.setRemoveStatus.adminSelfEnable` |
+| `setTag` | `GroupModels.AdminSetTagRequestData` | `setTagAsync(...)` | `GroupResponseModels.SetTagOperationResponse` | `group.setTag.adminSelfEnable` |
+| `getCurrencyLeaderboard` | `GroupModels.AdminGetCurrencyLeaderboardRequestData` | `getCurrencyLeaderboardAsync(...)` | `GroupResponseModels.GetCurrencyLeaderboardOperationResponse` | `group.getCurrencyLeaderboard.adminSelfEnable` |
+| `getCreateLeaderboard` | `GroupModels.AdminGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `GroupResponseModels.GetCreateLeaderboardOperationResponse` | `group.getCreateLeaderboard.adminSelfEnable` |
+| `getStatisticsLog` | `GroupModels.AdminGetStatisticsLogRequestData` | `getStatisticsLogAsync(...)` | `GroupResponseModels.GetStatisticsLogOperationResponse` | `group.getStatisticsLog.adminSelfEnable` |
+| `getCurrencyLog` | `GroupModels.AdminGetCurrencyLogRequestData` | `getCurrencyLogAsync(...)` | `GroupResponseModels.GetCurrencyLogOperationResponse` | `group.getCurrencyLog.adminSelfEnable` |
+
+
+## Ví dụ tối thiểu
+
+```ts
+import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
+
+// requestData: GroupModels.AddMemberRequestData đã build theo dto/GROUP.md
+const res = await GNNetwork.group.addMemberAsync(requestData);
+if (res.returnCode !== ReturnCode.Ok) return;
+if (res.errorCode !== ErrorCode.Ok) return;
+// res.responseData có typed payload
+```

package/docs/reference/API_INDEX.md

@@ -0,0 +1,57 @@
+# API Reference Index
+
+Tổng cộng **945** public async method trên **11 API group**. Mỗi group có 1 file reference riêng (bảng method + request DTO + async form + response class).
+
+Các khái niệm chung (áp dụng cho mọi group):
+
+- Namespace gốc: `GNNetwork.<group>` (role `Client`); một số group có thêm `.server` (`Server`) và `.admin` (`Admin`).
+- Mỗi method có 2 form: callback (`method(data, onResponse?, ...)`) và Promise (`methodAsync(data, ...)`). Ưu tiên `*Async()`.
+- Param chung của mọi method: `(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?)` — xem chi tiết trong từng file.
+- Response class expose field PUBLIC: `returnCode`, `errorCode`, `invalidMembers`, `debugMessage`, `responseData`. Check 2 tầng (`ReturnCode` → `ErrorCode`); xem [ERROR_HANDLING.md](ERROR_HANDLING.md).
+- Enum value cụ thể: [ENUMS.md](ENUMS.md). Config SDK: [CONFIG.md](CONFIG.md). Permission flags: [PERMISSION_RULES.md](PERMISSION_RULES.md). Realtime event: [EVENTS.md](EVENTS.md).
+
+## API groups
+
+| Group | File reference | Namespaces | Public methods | Chịu trách nhiệm |
+|-------|----------------|------------|----------------|------------------|
+| Authenticate | [API_AUTHENTICATE.md](API_AUTHENTICATE.md) | `authenticate` | 18 | Player login (account, social, device id), register, refresh auth token. |
+| CharacterPlayer | [API_CHARACTER_PLAYER.md](API_CHARACTER_PLAYER.md) | `characterPlayer`, `.server`, `.admin` | 159 (53/53/53) | Character-level gameplay: profile, inventory relation, friend/group relation, statistics, currency, segment, tag. |
+| CloudScript | [API_CLOUDSCRIPT.md](API_CLOUDSCRIPT.md) | `cloudScript`, `.server`, `.admin` | 15 (5/5/5) | CloudScript function add/edit/execute + version/listing. |
+| Content | [API_CONTENT.md](API_CONTENT.md) | `content`, `.server`, `.admin` | 21 (7/7/7) | Content data key-value, file upload info, download token. |
+| Dashboard | [API_DASHBOARD.md](API_DASHBOARD.md) | `dashboard` | 26 | Admin login, game/admin account/secret management, analytics, server log, maintenance tools. Dùng `RequestRole.Client` transport; admin context resolve từ auth token. |
+| GamePlayer | [API_GAME_PLAYER.md](API_GAME_PLAYER.md) | `gamePlayer`, `.server`, `.admin` | 156 (52/52/52) | Game-player profile, friend/group relation, currency, statistics, segment, tag, social identity. |
+| Group | [API_GROUP.md](API_GROUP.md) | `group`, `.server`, `.admin` | 120 (40/40/40) | Group metadata, member roster, message stream, group-level currency/inventory/statistics. |
+| Inventory | [API_INVENTORY.md](API_INVENTORY.md) | `inventory`, `.server`, `.admin` | 102 (34/34/34) | Inventory item metadata, ownership, amount, statistics, activity log. |
+| MasterPlayer | [API_MASTER_PLAYER.md](API_MASTER_PLAYER.md) | `masterPlayer`, `.server`, `.admin` | 256 (86/85/85) | Master-player account: identity linking, profile, contact info, external providers. |
+| Multiplayer | [API_MULTIPLAYER.md](API_MULTIPLAYER.md) | `multiplayer`, `.server`, `.admin` | 30 (10/10/10) | Matchmaking ticket lifecycle, queue statistics, match query. |
+| StoreInventory | [API_STORE_INVENTORY.md](API_STORE_INVENTORY.md) | `storeInventory`, `.server`, `.admin` | 42 (14/14/14) | Store catalog, buy/present, receipt validation, store log. |
+
+Format count: `client/server/admin`. Nếu chỉ có 1 số → chỉ có client variant.
+
+## Cách đọc file reference
+
+Mỗi `API_<GROUP>.md` có:
+
+1. **Namespaces** — danh sách namespace + role transport.
+2. **Convention** — template signature chung + param table.
+3. **Method tables** — 1 bảng cho client, và (nếu có) 1 bảng cho server + 1 cho admin. Mỗi hàng: `Method | Request DTO | Async form | Response class`.
+4. **Ví dụ tối thiểu** — snippet `*Async()` đầu tiên của group với check `returnCode` + `errorCode`.
+
+DTO shape (field-by-field) không inline trong API reference — xem [DTO_INDEX.md](DTO_INDEX.md) và thư mục [dto/](dto/).
+
+## Khi nào dùng `server` / `admin` variant?
+
+- `.server` (role `Server`) — trusted backend-to-backend call, ví dụ CloudScript runtime gọi SDK, hoặc backend microservice grant item cho player khác.
+- `.admin` (role `Admin`) — admin tool / dashboard script mutate state bất kỳ player.
+- Không có `.server` / `.admin` namespace nghĩa là group đó chỉ expose cho client (hoặc admin flow đã wrap trong namespace riêng, ví dụ `dashboard`).
+
+Xem [AI_CHEATSHEET.md](../AI_CHEATSHEET.md#2-decision-tree-tôi-cần-làm-gì) để chọn đúng API group + [CONFIG.md](CONFIG.md) cho secret key config.
+
+## Liên kết nhanh
+
+- Error / return code → [ERROR_HANDLING.md](ERROR_HANDLING.md)
+- Enum value cụ thể → [ENUMS.md](ENUMS.md)
+- Permission route/flag → [PERMISSION_RULES.md](PERMISSION_RULES.md)
+- Config `GNServerSettings` → [CONFIG.md](CONFIG.md)
+- Realtime event handler → [EVENTS.md](EVENTS.md)
+- Kịch bản end-to-end → [../COOKBOOK.md](../COOKBOOK.md)