@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/docs/reference/API_MULTIPLAYER.md

@@ -0,0 +1,97 @@
+# API Reference: MultiplayerApi
+
+Matchmaking ticket lifecycle, queue statistics, match query.
+
+Domain guide: [guides/MULTIPLAYER.md](../guides/MULTIPLAYER.md). DTO shapes: [dto/MULTIPLAYER.md](dto/MULTIPLAYER.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
+
+## Namespaces
+
+- `GNNetwork.multiplayer` — `RequestRole.Client`
+- `GNNetwork.multiplayer.server` — `RequestRole.Server`
+- `GNNetwork.multiplayer.admin` — `RequestRole.Admin`
+
+## Convention
+
+Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
+
+```ts
+// Callback
+GNNetwork.multiplayer.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
+
+// Async
+const res = await GNNetwork.multiplayer.<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.multiplayer.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `cancelAllMatchmakingTicket` | `MultiplayerModels.CancelAllMatchmakingTicketRequestData` | `cancelAllMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CancelAllMatchmakingTicketOperationResponse` | `multiplayer.cancelAllMatchmakingTicket.selfEnable` |
+| `cancelMatchmakingTicket` | `MultiplayerModels.CancelMatchmakingTicketRequestData` | `cancelMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CancelMatchmakingTicketOperationResponse` | `multiplayer.cancelMatchmakingTicket.selfEnable` |
+| `createMatchmakingTicket` | `MultiplayerModels.CreateMatchmakingTicketRequestData` | `createMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CreateMatchmakingTicketOperationResponse` | `multiplayer.createMatchmakingTicket.selfEnable` |
+| `getMatchmakingTicket` | `MultiplayerModels.GetMatchmakingTicketRequestData` | `getMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.GetMatchmakingTicketOperationResponse` | `multiplayer.getMatchmakingTicket.selfEnable` |
+| `getMatch` | `MultiplayerModels.GetMatchRequestData` | `getMatchAsync(...)` | `MultiplayerResponseModels.GetMatchOperationResponse` | `multiplayer.getMatch.selfEnable` |
+| `getQueueStatistics` | `MultiplayerModels.GetQueueStatisticsRequestData` | `getQueueStatisticsAsync(...)` | `MultiplayerResponseModels.GetQueueStatisticsOperationResponse` | `multiplayer.getQueueStatistics.selfEnable` |
+| `joinMatchmakingTicket` | `MultiplayerModels.JoinMatchmakingTicketRequestData` | `joinMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.JoinMatchmakingTicketOperationResponse` | `multiplayer.joinMatchmakingTicket.selfEnable` |
+| `listMatchmakingTicketsForPlayer` | `MultiplayerModels.ListMatchmakingTicketsForPlayerRequestData` | `listMatchmakingTicketsForPlayerAsync(...)` | `MultiplayerResponseModels.ListMatchmakingTicketsForPlayerOperationResponse` | `multiplayer.listMatchmakingTicketsForPlayer.selfEnable` |
+| `getAllMatch` | `MultiplayerModels.GetAllMatchRequestData` | `getAllMatchAsync(...)` | `MultiplayerResponseModels.GetAllMatchOperationResponse` | `multiplayer.getAllMatch.selfEnable` |
+| `getAllMatchmakingTicket` | `MultiplayerModels.GetAllMatchmakingTicketRequestData` | `getAllMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.GetAllMatchmakingTicketOperationResponse` | `multiplayer.getAllMatchmakingTicket.selfEnable` |
+
+
+## Server methods (`GNNetwork.multiplayer.server.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `cancelAllMatchmakingTicket` | `MultiplayerModels.ServerCancelAllMatchmakingTicketRequestData` | `cancelAllMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CancelAllMatchmakingTicketOperationResponse` | `multiplayer.cancelAllMatchmakingTicket.serverSelfEnable` |
+| `cancelMatchmakingTicket` | `MultiplayerModels.ServerCancelMatchmakingTicketRequestData` | `cancelMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CancelMatchmakingTicketOperationResponse` | `multiplayer.cancelMatchmakingTicket.serverSelfEnable` |
+| `createMatchmakingTicket` | `MultiplayerModels.ServerCreateMatchmakingTicketRequestData` | `createMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CreateMatchmakingTicketOperationResponse` | `multiplayer.createMatchmakingTicket.serverSelfEnable` |
+| `getMatchmakingTicket` | `MultiplayerModels.ServerGetMatchmakingTicketRequestData` | `getMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.GetMatchmakingTicketOperationResponse` | `multiplayer.getMatchmakingTicket.serverSelfEnable` |
+| `getMatch` | `MultiplayerModels.ServerGetMatchRequestData` | `getMatchAsync(...)` | `MultiplayerResponseModels.GetMatchOperationResponse` | `multiplayer.getMatch.serverSelfEnable` |
+| `getQueueStatistics` | `MultiplayerModels.ServerGetQueueStatisticsRequestData` | `getQueueStatisticsAsync(...)` | `MultiplayerResponseModels.GetQueueStatisticsOperationResponse` | `multiplayer.getQueueStatistics.serverSelfEnable` |
+| `joinMatchmakingTicket` | `MultiplayerModels.ServerJoinMatchmakingTicketRequestData` | `joinMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.JoinMatchmakingTicketOperationResponse` | `multiplayer.joinMatchmakingTicket.serverSelfEnable` |
+| `listMatchmakingTicketsForPlayer` | `MultiplayerModels.ServerListMatchmakingTicketsForPlayerRequestData` | `listMatchmakingTicketsForPlayerAsync(...)` | `MultiplayerResponseModels.ListMatchmakingTicketsForPlayerOperationResponse` | `multiplayer.listMatchmakingTicketsForPlayer.serverSelfEnable` |
+| `getAllMatch` | `MultiplayerModels.ServerGetAllMatchRequestData` | `getAllMatchAsync(...)` | `MultiplayerResponseModels.GetAllMatchOperationResponse` | `multiplayer.getAllMatch.serverSelfEnable` |
+| `getAllMatchmakingTicket` | `MultiplayerModels.ServerGetAllMatchmakingTicketRequestData` | `getAllMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.GetAllMatchmakingTicketOperationResponse` | `multiplayer.getAllMatchmakingTicket.serverSelfEnable` |
+
+
+## Admin methods (`GNNetwork.multiplayer.admin.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `cancelAllMatchmakingTicket` | `MultiplayerModels.AdminCancelAllMatchmakingTicketRequestData` | `cancelAllMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CancelAllMatchmakingTicketOperationResponse` | `multiplayer.cancelAllMatchmakingTicket.adminSelfEnable` |
+| `cancelMatchmakingTicket` | `MultiplayerModels.AdminCancelMatchmakingTicketRequestData` | `cancelMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CancelMatchmakingTicketOperationResponse` | `multiplayer.cancelMatchmakingTicket.adminSelfEnable` |
+| `createMatchmakingTicket` | `MultiplayerModels.AdminCreateMatchmakingTicketRequestData` | `createMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.CreateMatchmakingTicketOperationResponse` | `multiplayer.createMatchmakingTicket.adminSelfEnable` |
+| `getMatchmakingTicket` | `MultiplayerModels.AdminGetMatchmakingTicketRequestData` | `getMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.GetMatchmakingTicketOperationResponse` | `multiplayer.getMatchmakingTicket.adminSelfEnable` |
+| `getMatch` | `MultiplayerModels.AdminGetMatchRequestData` | `getMatchAsync(...)` | `MultiplayerResponseModels.GetMatchOperationResponse` | `multiplayer.getMatch.adminSelfEnable` |
+| `getQueueStatistics` | `MultiplayerModels.AdminGetQueueStatisticsRequestData` | `getQueueStatisticsAsync(...)` | `MultiplayerResponseModels.GetQueueStatisticsOperationResponse` | `multiplayer.getQueueStatistics.adminSelfEnable` |
+| `joinMatchmakingTicket` | `MultiplayerModels.AdminJoinMatchmakingTicketRequestData` | `joinMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.JoinMatchmakingTicketOperationResponse` | `multiplayer.joinMatchmakingTicket.adminSelfEnable` |
+| `listMatchmakingTicketsForPlayer` | `MultiplayerModels.AdminListMatchmakingTicketsForPlayerRequestData` | `listMatchmakingTicketsForPlayerAsync(...)` | `MultiplayerResponseModels.ListMatchmakingTicketsForPlayerOperationResponse` | `multiplayer.listMatchmakingTicketsForPlayer.adminSelfEnable` |
+| `getAllMatch` | `MultiplayerModels.AdminGetAllMatchRequestData` | `getAllMatchAsync(...)` | `MultiplayerResponseModels.GetAllMatchOperationResponse` | `multiplayer.getAllMatch.adminSelfEnable` |
+| `getAllMatchmakingTicket` | `MultiplayerModels.AdminGetAllMatchmakingTicketRequestData` | `getAllMatchmakingTicketAsync(...)` | `MultiplayerResponseModels.GetAllMatchmakingTicketOperationResponse` | `multiplayer.getAllMatchmakingTicket.adminSelfEnable` |
+
+
+## Ví dụ tối thiểu
+
+```ts
+import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
+
+// requestData: MultiplayerModels.CancelAllMatchmakingTicketRequestData đã build theo dto/MULTIPLAYER.md
+const res = await GNNetwork.multiplayer.cancelAllMatchmakingTicketAsync(requestData);
+if (res.returnCode !== ReturnCode.Ok) return;
+if (res.errorCode !== ErrorCode.Ok) return;
+// res.responseData có typed payload
+```

package/docs/reference/API_STORE_INVENTORY.md

@@ -0,0 +1,109 @@
+# API Reference: StoreInventoryApi
+
+Store catalog, buy/present, receipt validation, store log.
+
+Domain guide: [guides/STORE_INVENTORY.md](../guides/STORE_INVENTORY.md). DTO shapes: [dto/STORE_INVENTORY.md](dto/STORE_INVENTORY.md) hoặc grep [DTO_INDEX.md](DTO_INDEX.md).
+
+## Namespaces
+
+- `GNNetwork.storeInventory` — `RequestRole.Client`
+- `GNNetwork.storeInventory.server` — `RequestRole.Server`
+- `GNNetwork.storeInventory.admin` — `RequestRole.Admin`
+
+## Convention
+
+Mỗi method dưới đây có 2 form — callback và `*Async()` Promise. Ưu tiên `*Async()`.
+
+```ts
+// Callback
+GNNetwork.storeInventory.<method>(requestData, onResponse?, overrideAuthToken?, overrideSecretKey?, customTags?, timeout?);
+
+// Async
+const res = await GNNetwork.storeInventory.<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.storeInventory.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules | Permission Rules khi truyền `id` khác với những `entity` liên quan mà `gamePlayer` đang được authenticated không phải owner nếu `type` là `OwnerType.CharacterPlayer` hoặc không phải member nếu là `type` `OwnerType.Group` |
+|--------|-------------|------------|----------------|--------------------------|---------------------------------------------------------------------------------------------------------|
+| `buyStoreItem` | `StoreInventoryModels.BuyStoreItemRequestData` | `buyStoreItemAsync(...)` | `StoreInventoryResponseModels.BuyStoreItemOperationResponse` | `storeInventory.buyStoreItem.selfEnable` | `storeInventory.buyStoreItem.otherSelfEnable` |
+| `getStoreItemInformation` | `StoreInventoryModels.GetStoreItemInformationRequestData` | `getStoreItemInformationAsync(...)` | `StoreInventoryResponseModels.GetStoreItemInformationOperationResponse` | `storeInventory.getStoreItemInformation.otherSelfEnable` | |
+| `getStoreItemsWithTag` | `StoreInventoryModels.GetStoreItemsWithTagRequestData` | `getStoreItemsWithTagAsync(...)` | `StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse` | `storeInventory.getStoreItemsWithTag.otherSelfEnable` | |
+| `createStoreItem` | `StoreInventoryModels.CreateStoreItemRequestData` | `createStoreItemAsync(...)` | `StoreInventoryResponseModels.CreateStoreItemOperationResponse` | `storeInventory.createStoreItem.otherSelfEnable` | |
+| `setRemoveStatus` | `StoreInventoryModels.SetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `StoreInventoryResponseModels.SetRemoveStatusOperationResponse` | `storeInventory.setRemoveStatus.otherSelfEnable` | |
+| `setStoreItemInformation` | `StoreInventoryModels.SetStoreItemInformationRequestData` | `setStoreItemInformationAsync(...)` | `StoreInventoryResponseModels.SetStoreItemInformationOperationResponse` | `storeInventory.setStoreItemInformation.otherSelfEnable` | |
+| `validateAppleAppStoreReceipt` | `StoreInventoryModels.ValidateAppleAppStoreReceiptRequestData` | `validateAppleAppStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse` | `storeInventory.validateAppleAppStoreReceipt.selfEnable` | `storeInventory.validateAppleAppStoreReceipt.otherSelfEnable` |
+| `validateFacebookStoreReceipt` | `StoreInventoryModels.ValidateFacebookStoreReceiptRequestData` | `validateFacebookStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse` | `storeInventory.validateFacebookStoreReceipt.selfEnable` | `storeInventory.validateFacebookStoreReceipt.otherSelfEnable` |
+| `validateGooglePlayStoreReceipt` | `StoreInventoryModels.ValidateGooglePlayStoreReceiptRequestData` | `validateGooglePlayStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse` | `storeInventory.validateGooglePlayStoreReceipt.selfEnable` | `storeInventory.validateGooglePlayStoreReceipt.otherSelfEnable` |
+| `getCreateLeaderboard` | `StoreInventoryModels.GetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse` | `storeInventory.getCreateLeaderboard.otherSelfEnable` | |
+| `presentStoreItem` | `StoreInventoryModels.PresentStoreItemRequestData` | `presentStoreItemAsync(...)` | `StoreInventoryResponseModels.PresentStoreItemOperationResponse` | `storeInventory.presentStoreItem.selfEnable` | `storeInventory.presentStoreItem.otherSelfEnable` |
+| `getStoreLog` | `StoreInventoryModels.GetStoreLogRequestData` | `getStoreLogAsync(...)` | `StoreInventoryResponseModels.GetStoreLogOperationResponse` | `storeInventory.getStoreLog.otherSelfEnable` | |
+| `getStoreUsed` | `StoreInventoryModels.GetStoreUsedRequestData` | `getStoreUsedAsync(...)` | `StoreInventoryResponseModels.GetStoreUsedOperationResponse` | `storeInventory.getStoreUsed.otherSelfEnable` | |
+| `removeStoreUsed` | `StoreInventoryModels.RemoveStoreUsedRequestData` | `removeStoreUsedAsync(...)` | `StoreInventoryResponseModels.RemoveStoreUsedOperationResponse` | `storeInventory.removeStoreUsed.otherSelfEnable` | |
+
+
+## Server methods (`GNNetwork.storeInventory.server.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `buyStoreItem` | `StoreInventoryModels.ServerBuyStoreItemRequestData` | `buyStoreItemAsync(...)` | `StoreInventoryResponseModels.BuyStoreItemOperationResponse` | `storeInventory.buyStoreItem.serverSelfEnable` |
+| `getStoreItemInformation` | `StoreInventoryModels.ServerGetStoreItemInformationRequestData` | `getStoreItemInformationAsync(...)` | `StoreInventoryResponseModels.GetStoreItemInformationOperationResponse` | `storeInventory.getStoreItemInformation.serverSelfEnable` |
+| `getStoreItemsWithTag` | `StoreInventoryModels.ServerGetStoreItemsWithTagRequestData` | `getStoreItemsWithTagAsync(...)` | `StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse` | `storeInventory.getStoreItemsWithTag.serverSelfEnable` |
+| `createStoreItem` | `StoreInventoryModels.ServerCreateStoreItemRequestData` | `createStoreItemAsync(...)` | `StoreInventoryResponseModels.CreateStoreItemOperationResponse` | `storeInventory.createStoreItem.serverSelfEnable` |
+| `setRemoveStatus` | `StoreInventoryModels.ServerSetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `StoreInventoryResponseModels.SetRemoveStatusOperationResponse` | `storeInventory.setRemoveStatus.serverSelfEnable` |
+| `setStoreItemInformation` | `StoreInventoryModels.ServerSetStoreItemInformationRequestData` | `setStoreItemInformationAsync(...)` | `StoreInventoryResponseModels.SetStoreItemInformationOperationResponse` | `storeInventory.setStoreItemInformation.serverSelfEnable` |
+| `validateAppleAppStoreReceipt` | `StoreInventoryModels.ServerValidateAppleAppStoreReceiptRequestData` | `validateAppleAppStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse` | `storeInventory.validateAppleAppStoreReceipt.serverSelfEnable` |
+| `validateFacebookStoreReceipt` | `StoreInventoryModels.ServerValidateFacebookStoreReceiptRequestData` | `validateFacebookStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse` | `storeInventory.validateFacebookStoreReceipt.serverSelfEnable` |
+| `validateGooglePlayStoreReceipt` | `StoreInventoryModels.ServerValidateGooglePlayStoreReceiptRequestData` | `validateGooglePlayStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse` | `storeInventory.validateGooglePlayStoreReceipt.serverSelfEnable` |
+| `getCreateLeaderboard` | `StoreInventoryModels.ServerGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse` | `storeInventory.getCreateLeaderboard.serverSelfEnable` |
+| `presentStoreItem` | `StoreInventoryModels.ServerPresentStoreItemRequestData` | `presentStoreItemAsync(...)` | `StoreInventoryResponseModels.PresentStoreItemOperationResponse` | `storeInventory.presentStoreItem.serverSelfEnable` |
+| `getStoreLog` | `StoreInventoryModels.ServerGetStoreLogRequestData` | `getStoreLogAsync(...)` | `StoreInventoryResponseModels.GetStoreLogOperationResponse` | `storeInventory.getStoreLog.serverSelfEnable` |
+| `getStoreUsed` | `StoreInventoryModels.ServerGetStoreUsedRequestData` | `getStoreUsedAsync(...)` | `StoreInventoryResponseModels.GetStoreUsedOperationResponse` | `storeInventory.getStoreUsed.serverSelfEnable` |
+| `removeStoreUsed` | `StoreInventoryModels.ServerRemoveStoreUsedRequestData` | `removeStoreUsedAsync(...)` | `StoreInventoryResponseModels.RemoveStoreUsedOperationResponse` | `storeInventory.removeStoreUsed.serverSelfEnable` |
+
+
+## Admin methods (`GNNetwork.storeInventory.admin.*`)
+
+| Method | Request DTO | Async form | Response class | Default Permission Rules |
+|--------|-------------|------------|----------------|--------------------------|
+| `buyStoreItem` | `StoreInventoryModels.AdminBuyStoreItemRequestData` | `buyStoreItemAsync(...)` | `StoreInventoryResponseModels.BuyStoreItemOperationResponse` | `storeInventory.buyStoreItem.adminSelfEnable` |
+| `getStoreItemInformation` | `StoreInventoryModels.AdminGetStoreItemInformationRequestData` | `getStoreItemInformationAsync(...)` | `StoreInventoryResponseModels.GetStoreItemInformationOperationResponse` | `storeInventory.getStoreItemInformation.adminSelfEnable` |
+| `getStoreItemsWithTag` | `StoreInventoryModels.AdminGetStoreItemsWithTagRequestData` | `getStoreItemsWithTagAsync(...)` | `StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse` | `storeInventory.getStoreItemsWithTag.adminSelfEnable` |
+| `createStoreItem` | `StoreInventoryModels.AdminCreateStoreItemRequestData` | `createStoreItemAsync(...)` | `StoreInventoryResponseModels.CreateStoreItemOperationResponse` | `storeInventory.createStoreItem.adminSelfEnable` |
+| `setRemoveStatus` | `StoreInventoryModels.AdminSetRemoveStatusRequestData` | `setRemoveStatusAsync(...)` | `StoreInventoryResponseModels.SetRemoveStatusOperationResponse` | `storeInventory.setRemoveStatus.adminSelfEnable` |
+| `setStoreItemInformation` | `StoreInventoryModels.AdminSetStoreItemInformationRequestData` | `setStoreItemInformationAsync(...)` | `StoreInventoryResponseModels.SetStoreItemInformationOperationResponse` | `storeInventory.setStoreItemInformation.adminSelfEnable` |
+| `validateAppleAppStoreReceipt` | `StoreInventoryModels.AdminValidateAppleAppStoreReceiptRequestData` | `validateAppleAppStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse` | `storeInventory.validateAppleAppStoreReceipt.adminSelfEnable` |
+| `validateFacebookStoreReceipt` | `StoreInventoryModels.AdminValidateFacebookStoreReceiptRequestData` | `validateFacebookStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse` | `storeInventory.validateFacebookStoreReceipt.adminSelfEnable` |
+| `validateGooglePlayStoreReceipt` | `StoreInventoryModels.AdminValidateGooglePlayStoreReceiptRequestData` | `validateGooglePlayStoreReceiptAsync(...)` | `StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse` | `storeInventory.validateGooglePlayStoreReceipt.adminSelfEnable` |
+| `getCreateLeaderboard` | `StoreInventoryModels.AdminGetCreateLeaderboardRequestData` | `getCreateLeaderboardAsync(...)` | `StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse` | `storeInventory.getCreateLeaderboard.adminSelfEnable` |
+| `presentStoreItem` | `StoreInventoryModels.AdminPresentStoreItemRequestData` | `presentStoreItemAsync(...)` | `StoreInventoryResponseModels.PresentStoreItemOperationResponse` | `storeInventory.presentStoreItem.adminSelfEnable` |
+| `getStoreLog` | `StoreInventoryModels.AdminGetStoreLogRequestData` | `getStoreLogAsync(...)` | `StoreInventoryResponseModels.GetStoreLogOperationResponse` | `storeInventory.getStoreLog.adminSelfEnable` |
+| `getStoreUsed` | `StoreInventoryModels.AdminGetStoreUsedRequestData` | `getStoreUsedAsync(...)` | `StoreInventoryResponseModels.GetStoreUsedOperationResponse` | `storeInventory.getStoreUsed.adminSelfEnable` |
+| `removeStoreUsed` | `StoreInventoryModels.AdminRemoveStoreUsedRequestData` | `removeStoreUsedAsync(...)` | `StoreInventoryResponseModels.RemoveStoreUsedOperationResponse` | `storeInventory.removeStoreUsed.adminSelfEnable` |
+
+
+## Ví dụ tối thiểu
+
+```ts
+import { GNNetwork, ReturnCode, ErrorCode } from "@xmobitea/gn-typescript-client";
+
+// requestData: StoreInventoryModels.BuyStoreItemRequestData đã build theo dto/STORE_INVENTORY.md
+const res = await GNNetwork.storeInventory.buyStoreItemAsync(requestData);
+if (res.returnCode !== ReturnCode.Ok) return;
+if (res.errorCode !== ErrorCode.Ok) return;
+// res.responseData có typed payload
+```

package/docs/reference/CONFIG.md

@@ -0,0 +1,107 @@
+# Reference: Config (`GNServerSettingsOptions`)
+
+Schema đầy đủ của object truyền vào `GNNetwork.init(settings)`.
+
+```ts
+import { GNNetwork, GNServerSettings, GNServerSettingsOptions, MessageType, LogType } from "@xmobitea/gn-typescript-client";
+
+const settings = new GNServerSettings();
+settings.config({
+	serverAddress: "api.example.com",
+	serverPort: -1,
+	serverSocketPort: -1,
+	useSsl: true,
+	useSocket: true,
+	useHttp: true,
+
+	defaultTimeoutInSeconds: 20,
+	messageType: MessageType.MsgPack,
+	sendRate: 20,
+	reconnectDelay: 5000,
+	pingInterval: 20000,
+	pingTimeout: 20000,
+
+	secretKey: "<secret-key>",
+	gameId: "<game-id>",
+
+	logType: LogType.All,
+} satisfies GNServerSettingsOptions);
+
+GNNetwork.init(settings);
+```
+
+## Rule cứng
+
+- `GNNetwork.init(settings)` là **idempotent**: gọi 1 lần ở bootstrap, các lần sau bị bỏ qua (không reset config).
+- `GNServerSettings.config(options)` thay thế toàn bộ snapshot — không merge partial. Nếu muốn đổi từng field, dùng setter như `setServerAddress`.
+- Không commit `secretKey` chứa `permission rules` có permission `admin` hoặc `server` vào production.
+
+---
+
+## Bảng field
+
+| Field | Type | Required | Default | Unit | Notes |
+|-------|------|----------|---------|------|-------|
+| `serverAddress` | `string` | yes | `"127.0.0.1"` | host | Host name hoặc IP public của GearN Server |
+| `serverPort` | `number` | yes | `2202` | port | HTTP port. Set `-1` khi proxy đã expose default port trực tiếp |
+| `serverSocketPort` | `number` | yes | `2901` | port | Socket port. Set `-1` khi proxy đã expose default port trực tiếp |
+| `useSsl` | `boolean` | yes | `false` | — | `true` để build HTTPS/WSS URL |
+| `useSocket` | `boolean` | yes | `true` | — | Bật socket transport và realtime feature |
+| `useHttp` | `boolean` | yes | `true` | — | Bật HTTP transport (mọi public API wrapper đều dựa vào) |
+| `defaultTimeoutInSeconds` | `number` | yes | `20` | giây | Timeout mặc định cho request không override `timeout` |
+| `messageType` | `MessageType` | yes | `MessageType.MsgPack` | enum | Payload format. Browser HTTP với MsgPack tự fallback JSON |
+| `sendRate` | `number` | yes | `20` | msg/giây | Max send rate request bởi transport loop |
+| `reconnectDelay` | `number` | yes | `5000` | ms | Reconnect delay của socket client |
+| `pingInterval` | `number` | yes | `20000` | ms | Ping interval socket client |
+| `pingTimeout` | `number` | yes | `20000` | ms | Timeout phát hiện socket stale |
+| `secretKey` | `string` | yes | — | — | Auto gắn cho mọi route nếu không dùng overrideSecretKey |
+| `gameId` | `string` | yes | — | — | Game/application id khớp với `secretKey`; dùng để chọn đúng game context trên GearN Server |
+| `logType` | `LogType` | yes | `LogType.All` | enum | Verbosity `GNDebug` |
+
+Default column phản ánh giá trị khởi tạo trong class `GNServerSettings` trước khi gọi `config()`. `config()` yêu cầu cung cấp đầy đủ mọi field (strict replace).
+
+---
+
+## URL building behavior
+
+SDK tự build base URL từ `serverAddress` + port + `useSsl`:
+
+- `getHttpUrl()`:
+  - `serverPort >= 0` → `{http|https}://{serverAddress}:{serverPort}`
+  - `serverPort < 0` → `{http|https}://{serverAddress}` (reverse proxy mode)
+- `getSocketUrl()`: same pattern dùng `serverSocketPort`.
+
+Set `serverPort: -1` hoặc `serverSocketPort: -1` khi proxy (nginx, ALB, Cloudflare) đã terminate port 80/443.
+
+---
+
+## Setter runtime (khi cần đổi sau init)
+
+`GNServerSettings` expose setter cho mọi field. Sau `init`, SDK vẫn giữ reference tới cùng `settings` object, nên một số request mới có thể thấy giá trị setter mới. Đây không phải cách đổi toàn bộ app config an toàn; route/socket đang mở không tự reset.
+
+```ts
+settings.setServerAddress("prod-api.example.com");
+settings.setLogType(LogType.Error);
+```
+
+Lưu ý: gọi lại `GNNetwork.init()` để đổi config sẽ bị ignore. Đổi host/port sau khi socket đã connect **không** tự reconnect; phải `disconnectSocket()` rồi `connectSocket()` lại.
+
+---
+
+## Reverse proxy flag
+
+`GNServerSettings` có property nội bộ `useReverseProxy` (default `false`):
+
+```ts
+settings.setUseReverseProxy(true);
+```
+
+Khi bật, low-level HTTP helper có thể bỏ qua việc tự thêm request path prefix vì proxy đã route. Chỉ bật khi infra yêu cầu — default giữ nguyên `false`.
+
+---
+
+## Liên kết
+
+- Secret key và route permission: xem [RULES.md § 3](../RULES.md#3-route--trust-boundary-của-caller)
+- Socket auth flow: xem [RULES.md § 7](../RULES.md#7-auth--socket-flow) và [EVENTS.md](EVENTS.md)
+- `MessageType` / `LogType` enum: [ENUMS.md](ENUMS.md#messagetype)