@xmobitea/gn-typescript-client 2.6.13-tsc → 2.6.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (400) hide show
  1. package/AGENTS.md +37 -0
  2. package/README.MD +420 -1
  3. package/dist/gearn.js.client.js +71354 -0
  4. package/dist/gearn.js.client.min.js +2 -0
  5. package/dist/gearn.js.client.min.js.LICENSE.txt +14 -0
  6. package/dist/index.d.ts +30 -0
  7. package/dist/index.js +58386 -339
  8. package/dist/runtime/GNNetwork.d.ts +687 -3
  9. package/dist/runtime/GNNetworkAuthenticateApi.d.ts +327 -0
  10. package/dist/runtime/GNNetworkCharacterPlayerApi.d.ts +1026 -0
  11. package/dist/runtime/GNNetworkCloudScriptApi.d.ts +141 -0
  12. package/dist/runtime/GNNetworkContentApi.d.ts +243 -0
  13. package/dist/runtime/GNNetworkDashboardApi.d.ts +221 -0
  14. package/dist/runtime/GNNetworkGamePlayerApi.d.ts +1033 -0
  15. package/dist/runtime/GNNetworkGroupApi.d.ts +783 -0
  16. package/dist/runtime/GNNetworkInventoryApi.d.ts +673 -0
  17. package/dist/runtime/GNNetworkMasterPlayerApi.d.ts +1614 -6
  18. package/dist/runtime/GNNetworkMultiplayerApi.d.ts +234 -0
  19. package/dist/runtime/GNNetworkStoreInventoryApi.d.ts +309 -0
  20. package/dist/runtime/common/Action0.d.ts +30 -0
  21. package/dist/runtime/common/Action1.d.ts +32 -0
  22. package/dist/runtime/common/Action2.d.ts +21 -0
  23. package/dist/runtime/common/Action3.d.ts +16 -0
  24. package/dist/runtime/common/Action4.d.ts +17 -0
  25. package/dist/runtime/common/GNData.d.ts +368 -0
  26. package/dist/runtime/config/GNServerSettings.d.ts +442 -12
  27. package/dist/runtime/constant/Commands.d.ts +80 -0
  28. package/dist/runtime/constant/EventCode.d.ts +48 -0
  29. package/dist/runtime/constant/OperationCode.d.ts +74 -1
  30. package/dist/runtime/constant/ReturnCode.d.ts +72 -0
  31. package/dist/runtime/constant/enumType/ExecuteResponseStatus.d.ts +31 -0
  32. package/dist/runtime/constant/enumType/FriendStatus.d.ts +39 -0
  33. package/dist/runtime/constant/enumType/GoogleLoginType.d.ts +23 -0
  34. package/dist/runtime/constant/enumType/GroupStatus.d.ts +32 -0
  35. package/dist/runtime/constant/enumType/InvalidMemberType.d.ts +75 -0
  36. package/dist/runtime/constant/enumType/ItemType.d.ts +23 -0
  37. package/dist/runtime/constant/enumType/MatchStatus.d.ts +30 -0
  38. package/dist/runtime/constant/enumType/MatchmakingMemberStatus.d.ts +24 -0
  39. package/dist/runtime/constant/enumType/MatchmakingTicketStatus.d.ts +34 -0
  40. package/dist/runtime/constant/enumType/OwnerType.d.ts +40 -0
  41. package/dist/runtime/constant/enumType/PermissionDataItem.d.ts +22 -0
  42. package/dist/runtime/constant/enumType/PushPlatformType.d.ts +18 -0
  43. package/dist/runtime/constant/enumType/RequestRole.d.ts +32 -0
  44. package/dist/runtime/constant/enumType/RequestType.d.ts +70 -0
  45. package/dist/runtime/constant/enumType/StoreItemType.d.ts +21 -0
  46. package/dist/runtime/constant/enumType/StoreReceiveType.d.ts +30 -0
  47. package/dist/runtime/constant/errorCode/ErrorCode.d.ts +190 -8
  48. package/dist/runtime/constant/parameterCode/ParameterCode.d.ts +35 -5
  49. package/dist/runtime/entity/DataMember.d.ts +338 -0
  50. package/dist/runtime/entity/GNMetadata.d.ts +101 -0
  51. package/dist/runtime/entity/InvalidMember.d.ts +28 -0
  52. package/dist/runtime/entity/OperationEvent.d.ts +49 -0
  53. package/dist/runtime/entity/OperationRequest.d.ts +108 -0
  54. package/dist/runtime/entity/OperationResponse.d.ts +110 -0
  55. package/dist/runtime/entity/models/AuthenticateModels.d.ts +115 -0
  56. package/dist/runtime/entity/models/AuthenticateRequestModels.d.ts +131 -0
  57. package/dist/runtime/entity/models/AuthenticateResponseModels.d.ts +131 -0
  58. package/dist/runtime/entity/models/CharacterPlayerModels.d.ts +625 -1
  59. package/dist/runtime/entity/models/CharacterPlayerRequestModels.d.ts +972 -0
  60. package/dist/runtime/entity/models/CharacterPlayerResponseModels.d.ts +332 -0
  61. package/dist/runtime/entity/models/CloudScriptModels.d.ts +109 -0
  62. package/dist/runtime/entity/models/CloudScriptRequestModels.d.ts +107 -0
  63. package/dist/runtime/entity/models/CloudScriptResponseModels.d.ts +46 -0
  64. package/dist/runtime/entity/models/ContentModels.d.ts +124 -0
  65. package/dist/runtime/entity/models/ContentRequestModels.d.ts +152 -0
  66. package/dist/runtime/entity/models/ContentResponseModels.d.ts +58 -0
  67. package/dist/runtime/entity/models/DashboardModels.d.ts +371 -8
  68. package/dist/runtime/entity/models/DashboardRequestModels.d.ts +172 -0
  69. package/dist/runtime/entity/models/DashboardResponseModels.d.ts +170 -0
  70. package/dist/runtime/entity/models/GamePlayerModels.d.ts +644 -1
  71. package/dist/runtime/entity/models/GamePlayerRequestModels.d.ts +959 -0
  72. package/dist/runtime/entity/models/GamePlayerResponseModels.d.ts +333 -1
  73. package/dist/runtime/entity/models/GenericModels.d.ts +94 -0
  74. package/dist/runtime/entity/models/GroupModels.d.ts +484 -2
  75. package/dist/runtime/entity/models/GroupRequestModels.d.ts +737 -0
  76. package/dist/runtime/entity/models/GroupResponseModels.d.ts +254 -0
  77. package/dist/runtime/entity/models/InventoryModels.d.ts +415 -0
  78. package/dist/runtime/entity/models/InventoryRequestModels.d.ts +629 -0
  79. package/dist/runtime/entity/models/InventoryResponseModels.d.ts +218 -0
  80. package/dist/runtime/entity/models/MasterPlayerModels.d.ts +1065 -3
  81. package/dist/runtime/entity/models/MasterPlayerRequestModels.d.ts +1560 -6
  82. package/dist/runtime/entity/models/MasterPlayerResponseModels.d.ts +532 -1
  83. package/dist/runtime/entity/models/MultiplayerModels.d.ts +199 -0
  84. package/dist/runtime/entity/models/MultiplayerRequestModels.d.ts +196 -0
  85. package/dist/runtime/entity/models/MultiplayerResponseModels.d.ts +74 -0
  86. package/dist/runtime/entity/models/StoreInventoryModels.d.ts +262 -0
  87. package/dist/runtime/entity/models/StoreInventoryRequestModels.d.ts +268 -0
  88. package/dist/runtime/entity/models/StoreInventoryResponseModels.d.ts +98 -0
  89. package/dist/runtime/entity/request/CustomOperationRequest.d.ts +99 -0
  90. package/dist/runtime/entity/response/CustomOperationResponse.d.ts +118 -0
  91. package/dist/runtime/entity/response/GetAuthInfoResponse.d.ts +53 -0
  92. package/dist/runtime/entity/response/HealthCheckResponse.d.ts +56 -0
  93. package/dist/runtime/entity/response/UploadFileResponse.d.ts +19 -0
  94. package/dist/runtime/helper/CodeHelper.d.ts +122 -0
  95. package/dist/runtime/helper/ConverterService.d.ts +74 -0
  96. package/dist/runtime/helper/EnumUtility.d.ts +63 -0
  97. package/dist/runtime/helper/GNSupport.d.ts +64 -4
  98. package/dist/runtime/helper/GNUtils.d.ts +54 -0
  99. package/dist/runtime/helper/MessagePackConverterService.d.ts +48 -0
  100. package/dist/runtime/helper/OperationHelper.d.ts +51 -0
  101. package/dist/runtime/helper/StorageService.d.ts +48 -8
  102. package/dist/runtime/logger/GNDebug.d.ts +117 -0
  103. package/dist/runtime/networking/AuthenticateStatus.d.ts +64 -0
  104. package/dist/runtime/networking/IPeer.d.ts +83 -0
  105. package/dist/runtime/networking/NetworkingPeer.d.ts +256 -1
  106. package/dist/runtime/networking/OperationPending.d.ts +112 -0
  107. package/dist/runtime/networking/PeerBase.d.ts +231 -0
  108. package/dist/runtime/networking/handler/IServerEventHandler.d.ts +84 -0
  109. package/dist/runtime/networking/handler/OnCharacterPlayerFriendUpdateEventHandler.d.ts +69 -0
  110. package/dist/runtime/networking/handler/OnCharacterPlayerGroupUpdateEventHandler.d.ts +49 -0
  111. package/dist/runtime/networking/handler/OnGamePlayerFriendUpdateEventHandler.d.ts +50 -0
  112. package/dist/runtime/networking/handler/OnGamePlayerGroupUpdateEventHandler.d.ts +41 -0
  113. package/dist/runtime/networking/handler/OnGroupMemberUpdateEventHandler.d.ts +47 -0
  114. package/dist/runtime/networking/handler/OnGroupMessageUpdateEventHandler.d.ts +46 -0
  115. package/dist/runtime/networking/http/HttpPeer.d.ts +173 -0
  116. package/dist/runtime/networking/http/NetworkingHttpPeerBase.d.ts +87 -0
  117. package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.d.ts +113 -0
  118. package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.d.ts +145 -0
  119. package/dist/runtime/networking/socket/NetworkingSocketPeerBase.d.ts +198 -0
  120. package/dist/runtime/networking/socket/SocketPeer.d.ts +155 -0
  121. package/dist/runtime/typescript/ServiceUpdate.d.ts +46 -0
  122. package/docs/AI_CHEATSHEET.md +211 -0
  123. package/docs/COOKBOOK.md +912 -0
  124. package/docs/RULES.md +307 -0
  125. package/docs/ai-manifest.json +725 -0
  126. package/docs/guides/AUTHENTICATE.md +246 -0
  127. package/docs/guides/CHARACTER_PLAYER.md +439 -0
  128. package/docs/guides/CLOUDSCRIPT.md +335 -0
  129. package/docs/guides/COCOS_CREATOR_INTEGRATION.md +150 -0
  130. package/docs/guides/CONTENT.md +291 -0
  131. package/docs/guides/DASHBOARD.md +262 -0
  132. package/docs/guides/GAME_PLAYER.md +473 -0
  133. package/docs/guides/GROUP.md +412 -0
  134. package/docs/guides/INVENTORY.md +375 -0
  135. package/docs/guides/MASTER_PLAYER.md +458 -0
  136. package/docs/guides/MULTIPLAYER.md +303 -0
  137. package/docs/guides/STORE_INVENTORY.md +313 -0
  138. package/docs/llms-full.txt +43 -0
  139. package/docs/reference/API_AUTHENTICATE.md +75 -0
  140. package/docs/reference/API_CHARACTER_PLAYER.md +226 -0
  141. package/docs/reference/API_CLOUDSCRIPT.md +82 -0
  142. package/docs/reference/API_CONTENT.md +88 -0
  143. package/docs/reference/API_DASHBOARD.md +82 -0
  144. package/docs/reference/API_GAME_PLAYER.md +223 -0
  145. package/docs/reference/API_GROUP.md +187 -0
  146. package/docs/reference/API_INDEX.md +57 -0
  147. package/docs/reference/API_INVENTORY.md +169 -0
  148. package/docs/reference/API_MASTER_PLAYER.md +323 -0
  149. package/docs/reference/API_MULTIPLAYER.md +97 -0
  150. package/docs/reference/API_STORE_INVENTORY.md +109 -0
  151. package/docs/reference/CONFIG.md +107 -0
  152. package/docs/reference/DTO_INDEX.md +2543 -0
  153. package/docs/reference/ENUMS.md +433 -0
  154. package/docs/reference/ERROR_HANDLING.md +159 -0
  155. package/docs/reference/EVENTS.md +188 -0
  156. package/docs/reference/PERMISSION_RULES.md +55 -0
  157. package/docs/reference/dto/AUTHENTICATE.md +619 -0
  158. package/docs/reference/dto/CHARACTER_PLAYER.md +3686 -0
  159. package/docs/reference/dto/CLOUDSCRIPT.md +400 -0
  160. package/docs/reference/dto/CONTENT.md +548 -0
  161. package/docs/reference/dto/DASHBOARD.md +1980 -0
  162. package/docs/reference/dto/GAME_PLAYER.md +3631 -0
  163. package/docs/reference/dto/GENERIC.md +151 -0
  164. package/docs/reference/dto/GROUP.md +2842 -0
  165. package/docs/reference/dto/INVENTORY.md +2385 -0
  166. package/docs/reference/dto/MASTER_PLAYER.md +6024 -0
  167. package/docs/reference/dto/MULTIPLAYER.md +850 -0
  168. package/docs/reference/dto/STORE_INVENTORY.md +1262 -0
  169. package/llms.txt +47 -0
  170. package/package.json +11 -2
  171. package/GNServerSettings.debug.json +0 -21
  172. package/dist/runtime/GNNetwork.js +0 -273
  173. package/dist/runtime/GNNetworkAuthenticateApi.js +0 -122
  174. package/dist/runtime/GNNetworkCharacterPlayerApi.js +0 -968
  175. package/dist/runtime/GNNetworkCloudScriptApi.js +0 -104
  176. package/dist/runtime/GNNetworkContentApi.js +0 -140
  177. package/dist/runtime/GNNetworkDashboardApi.js +0 -170
  178. package/dist/runtime/GNNetworkGamePlayerApi.js +0 -950
  179. package/dist/runtime/GNNetworkGroupApi.js +0 -734
  180. package/dist/runtime/GNNetworkInventoryApi.js +0 -626
  181. package/dist/runtime/GNNetworkMasterPlayerApi.js +0 -1550
  182. package/dist/runtime/GNNetworkMultiplayerApi.js +0 -194
  183. package/dist/runtime/GNNetworkStoreInventoryApi.js +0 -266
  184. package/dist/runtime/common/Action0.js +0 -1
  185. package/dist/runtime/common/Action1.js +0 -1
  186. package/dist/runtime/common/Action2.js +0 -1
  187. package/dist/runtime/common/Action3.js +0 -1
  188. package/dist/runtime/common/Action4.js +0 -1
  189. package/dist/runtime/common/GNData.js +0 -209
  190. package/dist/runtime/config/GNServerSettings.js +0 -156
  191. package/dist/runtime/constant/Commands.js +0 -20
  192. package/dist/runtime/constant/EventCode.js +0 -8
  193. package/dist/runtime/constant/OperationCode.js +0 -221
  194. package/dist/runtime/constant/ReturnCode.js +0 -14
  195. package/dist/runtime/constant/enumType/ExecuteResponseStatus.js +0 -8
  196. package/dist/runtime/constant/enumType/FriendStatus.js +0 -7
  197. package/dist/runtime/constant/enumType/GoogleLoginType.js +0 -5
  198. package/dist/runtime/constant/enumType/GroupStatus.js +0 -7
  199. package/dist/runtime/constant/enumType/InvalidMemberType.js +0 -18
  200. package/dist/runtime/constant/enumType/ItemType.js +0 -5
  201. package/dist/runtime/constant/enumType/MatchmakingMemberStatus.js +0 -6
  202. package/dist/runtime/constant/enumType/MatchmakingTicketStatus.js +0 -8
  203. package/dist/runtime/constant/enumType/OwnerType.js +0 -9
  204. package/dist/runtime/constant/enumType/PermissionDataItem.js +0 -5
  205. package/dist/runtime/constant/enumType/PushPlatformType.js +0 -5
  206. package/dist/runtime/constant/enumType/RequestRole.js +0 -6
  207. package/dist/runtime/constant/enumType/RequestType.js +0 -15
  208. package/dist/runtime/constant/enumType/StoreItemType.js +0 -5
  209. package/dist/runtime/constant/enumType/StoreReceiveType.js +0 -8
  210. package/dist/runtime/constant/errorCode/ErrorCode.js +0 -52
  211. package/dist/runtime/constant/parameterCode/ParameterCode.js +0 -617
  212. package/dist/runtime/entity/DataMember.js +0 -208
  213. package/dist/runtime/entity/GNMetadata.js +0 -11
  214. package/dist/runtime/entity/InvalidMember.js +0 -1
  215. package/dist/runtime/entity/OperationEvent.js +0 -24
  216. package/dist/runtime/entity/OperationRequest.js +0 -42
  217. package/dist/runtime/entity/OperationResponse.js +0 -73
  218. package/dist/runtime/entity/models/AuthenticateModels.js +0 -426
  219. package/dist/runtime/entity/models/AuthenticateRequestModels.js +0 -188
  220. package/dist/runtime/entity/models/AuthenticateResponseModels.js +0 -131
  221. package/dist/runtime/entity/models/CharacterPlayerModels.js +0 -1433
  222. package/dist/runtime/entity/models/CharacterPlayerRequestModels.js +0 -1386
  223. package/dist/runtime/entity/models/CharacterPlayerResponseModels.js +0 -376
  224. package/dist/runtime/entity/models/CloudScriptModels.js +0 -197
  225. package/dist/runtime/entity/models/CloudScriptRequestModels.js +0 -138
  226. package/dist/runtime/entity/models/CloudScriptResponseModels.js +0 -40
  227. package/dist/runtime/entity/models/ContentModels.js +0 -203
  228. package/dist/runtime/entity/models/ContentRequestModels.js +0 -190
  229. package/dist/runtime/entity/models/ContentResponseModels.js +0 -54
  230. package/dist/runtime/entity/models/DashboardModels.js +0 -3002
  231. package/dist/runtime/entity/models/DashboardRequestModels.js +0 -268
  232. package/dist/runtime/entity/models/DashboardResponseModels.js +0 -187
  233. package/dist/runtime/entity/models/GamePlayerModels.js +0 -1591
  234. package/dist/runtime/entity/models/GamePlayerRequestModels.js +0 -1360
  235. package/dist/runtime/entity/models/GamePlayerResponseModels.js +0 -369
  236. package/dist/runtime/entity/models/GenericModels.js +0 -177
  237. package/dist/runtime/entity/models/GroupModels.js +0 -1135
  238. package/dist/runtime/entity/models/GroupRequestModels.js +0 -1048
  239. package/dist/runtime/entity/models/GroupResponseModels.js +0 -285
  240. package/dist/runtime/entity/models/InventoryModels.js +0 -915
  241. package/dist/runtime/entity/models/InventoryRequestModels.js +0 -892
  242. package/dist/runtime/entity/models/InventoryResponseModels.js +0 -243
  243. package/dist/runtime/entity/models/MasterPlayerModels.js +0 -2573
  244. package/dist/runtime/entity/models/MasterPlayerRequestModels.js +0 -2228
  245. package/dist/runtime/entity/models/MasterPlayerResponseModels.js +0 -607
  246. package/dist/runtime/entity/models/MultiplayerModels.js +0 -404
  247. package/dist/runtime/entity/models/MultiplayerRequestModels.js +0 -268
  248. package/dist/runtime/entity/models/MultiplayerResponseModels.js +0 -75
  249. package/dist/runtime/entity/models/StoreInventoryModels.js +0 -797
  250. package/dist/runtime/entity/models/StoreInventoryRequestModels.js +0 -372
  251. package/dist/runtime/entity/models/StoreInventoryResponseModels.js +0 -103
  252. package/dist/runtime/entity/request/CustomOperationRequest.js +0 -24
  253. package/dist/runtime/entity/response/CustomOperationResponse.js +0 -29
  254. package/dist/runtime/entity/response/GetAuthInfoResponse.js +0 -2
  255. package/dist/runtime/entity/response/HealthCheckResponse.js +0 -2
  256. package/dist/runtime/entity/response/UploadFileResponse.js +0 -2
  257. package/dist/runtime/helper/CodeHelper.js +0 -63
  258. package/dist/runtime/helper/ConverterService.js +0 -275
  259. package/dist/runtime/helper/EnumUtility.js +0 -33
  260. package/dist/runtime/helper/GNSupport.js +0 -47
  261. package/dist/runtime/helper/GNUtils.js +0 -72
  262. package/dist/runtime/helper/MessagePackConverterService.js +0 -9
  263. package/dist/runtime/helper/OperationHelper.js +0 -24
  264. package/dist/runtime/helper/StorageService.js +0 -62
  265. package/dist/runtime/logger/GNDebug.js +0 -29
  266. package/dist/runtime/networking/AuthenticateStatus.js +0 -14
  267. package/dist/runtime/networking/IPeer.js +0 -1
  268. package/dist/runtime/networking/NetworkingPeer.js +0 -210
  269. package/dist/runtime/networking/OperationPending.js +0 -53
  270. package/dist/runtime/networking/PeerBase.js +0 -161
  271. package/dist/runtime/networking/handler/IServerEventHandler.js +0 -13
  272. package/dist/runtime/networking/handler/OnCharacterPlayerFriendUpdateEventHandler.js +0 -39
  273. package/dist/runtime/networking/handler/OnCharacterPlayerGroupUpdateEventHandler.js +0 -39
  274. package/dist/runtime/networking/handler/OnGamePlayerFriendUpdateEventHandler.js +0 -39
  275. package/dist/runtime/networking/handler/OnGamePlayerGroupUpdateEventHandler.js +0 -39
  276. package/dist/runtime/networking/handler/OnGroupMemberUpdateEventHandler.js +0 -35
  277. package/dist/runtime/networking/handler/OnGroupMessageUpdateEventHandler.js +0 -43
  278. package/dist/runtime/networking/http/HttpPeer.js +0 -123
  279. package/dist/runtime/networking/http/NetworkingHttpPeerBase.js +0 -9
  280. package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.js +0 -179
  281. package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.js +0 -130
  282. package/dist/runtime/networking/socket/NetworkingSocketPeerBase.js +0 -165
  283. package/dist/runtime/networking/socket/SocketPeer.js +0 -115
  284. package/dist/runtime/typescript/ServiceUpdate.js +0 -22
  285. package/docs/COCOS_CREATOR_INTEGRATION.md +0 -116
  286. package/examples/cocos-creator/GearNExample.ts.txt +0 -176
  287. package/srcSwift/Package.swift +0 -32
  288. package/srcSwift/Sources/GearN/runtime/GNNetwork.swift +0 -530
  289. package/srcSwift/Sources/GearN/runtime/GNNetworkAuthenticateApi.swift +0 -178
  290. package/srcSwift/Sources/GearN/runtime/GNNetworkCharacterPlayerApi.swift +0 -1162
  291. package/srcSwift/Sources/GearN/runtime/GNNetworkCloudScriptApi.swift +0 -154
  292. package/srcSwift/Sources/GearN/runtime/GNNetworkContentApi.swift +0 -208
  293. package/srcSwift/Sources/GearN/runtime/GNNetworkDashboardApi.swift +0 -240
  294. package/srcSwift/Sources/GearN/runtime/GNNetworkGamePlayerApi.swift +0 -1369
  295. package/srcSwift/Sources/GearN/runtime/GNNetworkGroupApi.swift +0 -1100
  296. package/srcSwift/Sources/GearN/runtime/GNNetworkInventoryApi.swift +0 -937
  297. package/srcSwift/Sources/GearN/runtime/GNNetworkMasterPlayerApi.swift +0 -2323
  298. package/srcSwift/Sources/GearN/runtime/GNNetworkMultiplayerApi.swift +0 -298
  299. package/srcSwift/Sources/GearN/runtime/GNNetworkStoreInventoryApi.swift +0 -397
  300. package/srcSwift/Sources/GearN/runtime/common/Action0.swift +0 -3
  301. package/srcSwift/Sources/GearN/runtime/common/Action1.swift +0 -3
  302. package/srcSwift/Sources/GearN/runtime/common/Action2.swift +0 -3
  303. package/srcSwift/Sources/GearN/runtime/common/Action3.swift +0 -3
  304. package/srcSwift/Sources/GearN/runtime/common/Action4.swift +0 -3
  305. package/srcSwift/Sources/GearN/runtime/common/GNArray.swift +0 -204
  306. package/srcSwift/Sources/GearN/runtime/common/GNData.swift +0 -108
  307. package/srcSwift/Sources/GearN/runtime/common/GNHashtable.swift +0 -200
  308. package/srcSwift/Sources/GearN/runtime/config/GNServerSettings.swift +0 -95
  309. package/srcSwift/Sources/GearN/runtime/constant/Commands.swift +0 -28
  310. package/srcSwift/Sources/GearN/runtime/constant/EventCode.swift +0 -10
  311. package/srcSwift/Sources/GearN/runtime/constant/OperationCode.swift +0 -252
  312. package/srcSwift/Sources/GearN/runtime/constant/ReturnCode.swift +0 -19
  313. package/srcSwift/Sources/GearN/runtime/constant/enumType/ExecuteResponseStatus.swift +0 -9
  314. package/srcSwift/Sources/GearN/runtime/constant/enumType/FriendStatus.swift +0 -8
  315. package/srcSwift/Sources/GearN/runtime/constant/enumType/GoogleLoginType.swift +0 -6
  316. package/srcSwift/Sources/GearN/runtime/constant/enumType/GroupStatus.swift +0 -8
  317. package/srcSwift/Sources/GearN/runtime/constant/enumType/InvalidMemberType.swift +0 -19
  318. package/srcSwift/Sources/GearN/runtime/constant/enumType/ItemType.swift +0 -6
  319. package/srcSwift/Sources/GearN/runtime/constant/enumType/MatchmakingMemberStatus.swift +0 -7
  320. package/srcSwift/Sources/GearN/runtime/constant/enumType/MatchmakingTicketStatus.swift +0 -9
  321. package/srcSwift/Sources/GearN/runtime/constant/enumType/OwnerType.swift +0 -10
  322. package/srcSwift/Sources/GearN/runtime/constant/enumType/PermissionDataItem.swift +0 -6
  323. package/srcSwift/Sources/GearN/runtime/constant/enumType/PushPlatformType.swift +0 -6
  324. package/srcSwift/Sources/GearN/runtime/constant/enumType/RequestRole.swift +0 -7
  325. package/srcSwift/Sources/GearN/runtime/constant/enumType/RequestType.swift +0 -16
  326. package/srcSwift/Sources/GearN/runtime/constant/enumType/StoreItemType.swift +0 -6
  327. package/srcSwift/Sources/GearN/runtime/constant/enumType/StoreReceiveType.swift +0 -9
  328. package/srcSwift/Sources/GearN/runtime/constant/errorCode/ErrorCode.swift +0 -58
  329. package/srcSwift/Sources/GearN/runtime/constant/parameterCode/ParameterCode.swift +0 -672
  330. package/srcSwift/Sources/GearN/runtime/entity/DataMember.swift +0 -196
  331. package/srcSwift/Sources/GearN/runtime/entity/GNMetadata.swift +0 -9
  332. package/srcSwift/Sources/GearN/runtime/entity/InvalidMember.swift +0 -11
  333. package/srcSwift/Sources/GearN/runtime/entity/OperationEvent.swift +0 -38
  334. package/srcSwift/Sources/GearN/runtime/entity/OperationHelper.swift +0 -28
  335. package/srcSwift/Sources/GearN/runtime/entity/OperationRequest.swift +0 -62
  336. package/srcSwift/Sources/GearN/runtime/entity/OperationResponse.swift +0 -98
  337. package/srcSwift/Sources/GearN/runtime/entity/models/AuthenticateModels.swift +0 -351
  338. package/srcSwift/Sources/GearN/runtime/entity/models/AuthenticateRequestModels.swift +0 -81
  339. package/srcSwift/Sources/GearN/runtime/entity/models/AuthenticateResponseModels.swift +0 -108
  340. package/srcSwift/Sources/GearN/runtime/entity/models/CharacterPlayerModels.swift +0 -1045
  341. package/srcSwift/Sources/GearN/runtime/entity/models/CharacterPlayerRequestModels.swift +0 -821
  342. package/srcSwift/Sources/GearN/runtime/entity/models/CharacterPlayerResponseModels.swift +0 -588
  343. package/srcSwift/Sources/GearN/runtime/entity/models/CloudScriptModels.swift +0 -187
  344. package/srcSwift/Sources/GearN/runtime/entity/models/CloudScriptRequestModels.swift +0 -84
  345. package/srcSwift/Sources/GearN/runtime/entity/models/CloudScriptResponseModels.swift +0 -59
  346. package/srcSwift/Sources/GearN/runtime/entity/models/ContentModels.swift +0 -195
  347. package/srcSwift/Sources/GearN/runtime/entity/models/ContentRequestModels.swift +0 -116
  348. package/srcSwift/Sources/GearN/runtime/entity/models/ContentResponseModels.swift +0 -81
  349. package/srcSwift/Sources/GearN/runtime/entity/models/DashboardModels.swift +0 -426
  350. package/srcSwift/Sources/GearN/runtime/entity/models/DashboardRequestModels.swift +0 -160
  351. package/srcSwift/Sources/GearN/runtime/entity/models/DashboardResponseModels.swift +0 -82
  352. package/srcSwift/Sources/GearN/runtime/entity/models/GamePlayerModels.swift +0 -1334
  353. package/srcSwift/Sources/GearN/runtime/entity/models/GamePlayerRequestModels.swift +0 -643
  354. package/srcSwift/Sources/GearN/runtime/entity/models/GamePlayerResponseModels.swift +0 -213
  355. package/srcSwift/Sources/GearN/runtime/entity/models/GenericModels.swift +0 -171
  356. package/srcSwift/Sources/GearN/runtime/entity/models/GroupModels.swift +0 -850
  357. package/srcSwift/Sources/GearN/runtime/entity/models/GroupRequestModels.swift +0 -485
  358. package/srcSwift/Sources/GearN/runtime/entity/models/GroupResponseModels.swift +0 -165
  359. package/srcSwift/Sources/GearN/runtime/entity/models/InventoryModels.swift +0 -679
  360. package/srcSwift/Sources/GearN/runtime/entity/models/InventoryRequestModels.swift +0 -413
  361. package/srcSwift/Sources/GearN/runtime/entity/models/InventoryResponseModels.swift +0 -141
  362. package/srcSwift/Sources/GearN/runtime/entity/models/MasterPlayerModels.swift +0 -378
  363. package/srcSwift/Sources/GearN/runtime/entity/models/MasterPlayerRequestModels.swift +0 -147
  364. package/srcSwift/Sources/GearN/runtime/entity/models/MasterPlayerResponseModels.swift +0 -318
  365. package/srcSwift/Sources/GearN/runtime/entity/models/MultiplayerModels.swift +0 -319
  366. package/srcSwift/Sources/GearN/runtime/entity/models/MultiplayerRequestModels.swift +0 -125
  367. package/srcSwift/Sources/GearN/runtime/entity/models/MultiplayerResponseModels.swift +0 -45
  368. package/srcSwift/Sources/GearN/runtime/entity/models/StoreInventoryModels.swift +0 -633
  369. package/srcSwift/Sources/GearN/runtime/entity/models/StoreInventoryRequestModels.swift +0 -173
  370. package/srcSwift/Sources/GearN/runtime/entity/models/StoreInventoryResponseModels.swift +0 -61
  371. package/srcSwift/Sources/GearN/runtime/entity/request/CustomOperationRequest.swift +0 -42
  372. package/srcSwift/Sources/GearN/runtime/entity/response/CustomOperationResponse.swift +0 -49
  373. package/srcSwift/Sources/GearN/runtime/entity/response/GetAuthInfoResponse.swift +0 -43
  374. package/srcSwift/Sources/GearN/runtime/entity/response/HealthCheckResponse.swift +0 -86
  375. package/srcSwift/Sources/GearN/runtime/entity/response/UploadFileResponse.swift +0 -15
  376. package/srcSwift/Sources/GearN/runtime/helper/CodeHelper.swift +0 -107
  377. package/srcSwift/Sources/GearN/runtime/helper/ConverterService.swift +0 -98
  378. package/srcSwift/Sources/GearN/runtime/helper/EnumUtility.swift +0 -34
  379. package/srcSwift/Sources/GearN/runtime/helper/GNSupport.swift +0 -41
  380. package/srcSwift/Sources/GearN/runtime/helper/GNUtils.swift +0 -66
  381. package/srcSwift/Sources/GearN/runtime/helper/MessagePackConverterService.swift +0 -21
  382. package/srcSwift/Sources/GearN/runtime/helper/StorageService.swift +0 -29
  383. package/srcSwift/Sources/GearN/runtime/logger/GNDebug.swift +0 -33
  384. package/srcSwift/Sources/GearN/runtime/networking/AuthenticateStatus.swift +0 -24
  385. package/srcSwift/Sources/GearN/runtime/networking/IPeer.swift +0 -8
  386. package/srcSwift/Sources/GearN/runtime/networking/NetworkingPeer.swift +0 -368
  387. package/srcSwift/Sources/GearN/runtime/networking/OperationPending.swift +0 -81
  388. package/srcSwift/Sources/GearN/runtime/networking/PeerBase.swift +0 -228
  389. package/srcSwift/Sources/GearN/runtime/networking/handler/IServerEventHandler.swift +0 -20
  390. package/srcSwift/Sources/GearN/runtime/networking/http/HttpPeer.swift +0 -226
  391. package/srcSwift/Sources/GearN/runtime/networking/http/HttpTypes.swift +0 -24
  392. package/srcSwift/Sources/GearN/runtime/networking/http/NetworkingHttpPeerBase.swift +0 -13
  393. package/srcSwift/Sources/GearN/runtime/networking/http/NetworkingPeerUrlSession.swift +0 -125
  394. package/srcSwift/Sources/GearN/runtime/networking/request/NetRequest.swift +0 -19
  395. package/srcSwift/Sources/GearN/runtime/networking/response/NetResponse.swift +0 -13
  396. package/srcSwift/Sources/GearN/runtime/networking/socket/NetworkingPeerSocketIOClient.swift +0 -244
  397. package/srcSwift/Sources/GearN/runtime/networking/socket/NetworkingSocketPeerBase.swift +0 -59
  398. package/srcSwift/Sources/GearN/runtime/networking/socket/SocketPeer.swift +0 -136
  399. package/tsconfig-build.cocos.json +0 -31
  400. package/webpack.config.cocos.mjs +0 -78
@@ -0,0 +1,619 @@
1
+ # DTO Reference: Authenticate
2
+
3
+ Player login (account, social, device id), register, refresh auth token.
4
+
5
+ Related API reference: [API_AUTHENTICATE.md](../API_AUTHENTICATE.md).
6
+
7
+ Mỗi section bên dưới là 1 class DTO trong namespace `<Models>`. Field table cho biết: tên field, TS type, có `required` hay không (suy từ decorator `mustNonNull` / `isOptional` / dấu `?` trong declaration), doc comment, và ràng buộc length/range/default nếu có.
8
+
9
+ > **Cách dùng**: khi gọi `*Async()`, bạn truyền object literal matching các field required (+ optional nếu cần). SDK sẽ serialize field dựa trên decorator `@<Type>DataMember({ code })`. Response class expose `responseData` là instance của class `*ResponseData` tương ứng, đọc theo field name dưới đây.
10
+
11
+ ## Danh sách
12
+
13
+ - **AuthenticateModels** (from `AuthenticateModels.ts`)
14
+ - [InfoRequestParam](#inforequestparam)
15
+ - [LoginByAccountRequestData](#loginbyaccountrequestdata)
16
+ - [LoginByAndroidDeviceIdRequestData](#loginbyandroiddeviceidrequestdata)
17
+ - [LoginByAppleRequestData](#loginbyapplerequestdata)
18
+ - [LoginByCustomDeviceIdRequestData](#loginbycustomdeviceidrequestdata)
19
+ - [LoginByCustomIdRequestData](#loginbycustomidrequestdata)
20
+ - [LoginByEditorDeviceIdRequestData](#loginbyeditordeviceidrequestdata)
21
+ - [LoginByFacebookRequestData](#loginbyfacebookrequestdata)
22
+ - [LoginByGenericServiceRequestData](#loginbygenericservicerequestdata)
23
+ - [LoginByGoogleRequestData](#loginbygooglerequestdata)
24
+ - [LoginByGooglePlayGameServiceRequestData](#loginbygoogleplaygameservicerequestdata)
25
+ - [LoginByGameCenterRequestData](#loginbygamecenterrequestdata)
26
+ - [LoginByiOSDeviceIdRequestData](#loginbyiosdeviceidrequestdata)
27
+ - [LoginByLinuxDeviceIdRequestData](#loginbylinuxdeviceidrequestdata)
28
+ - [LoginByMacOSDeviceIdRequestData](#loginbymacosdeviceidrequestdata)
29
+ - [LoginByWindowsDeviceIdRequestData](#loginbywindowsdeviceidrequestdata)
30
+ - [LoginByWindowsPhoneDeviceIdRequestData](#loginbywindowsphonedeviceidrequestdata)
31
+ - [RegisterAccountRequestData](#registeraccountrequestdata)
32
+ - [RefreshAuthTokenRequestData](#refreshauthtokenrequestdata)
33
+ - [AuthenticateResponseData](#authenticateresponsedata)
34
+ - [GenericServiceAuthenticateResponseData](#genericserviceauthenticateresponsedata)
35
+ - [RefreshAuthTokenResponseData](#refreshauthtokenresponsedata)
36
+ - [EmptyResponseData](#emptyresponsedata)
37
+ - **AuthenticateRequestModels** (from `AuthenticateRequestModels.ts`)
38
+ - [LoginByAccountOperationRequest](#loginbyaccountoperationrequest)
39
+ - [LoginByAndroidDeviceIdOperationRequest](#loginbyandroiddeviceidoperationrequest)
40
+ - [LoginByAppleOperationRequest](#loginbyappleoperationrequest)
41
+ - [LoginByCustomDeviceIdOperationRequest](#loginbycustomdeviceidoperationrequest)
42
+ - [LoginByCustomIdOperationRequest](#loginbycustomidoperationrequest)
43
+ - [LoginByEditorDeviceIdOperationRequest](#loginbyeditordeviceidoperationrequest)
44
+ - [LoginByFacebookOperationRequest](#loginbyfacebookoperationrequest)
45
+ - [LoginByGenericServiceOperationRequest](#loginbygenericserviceoperationrequest)
46
+ - [LoginByGoogleOperationRequest](#loginbygoogleoperationrequest)
47
+ - [LoginByGooglePlayGameServiceOperationRequest](#loginbygoogleplaygameserviceoperationrequest)
48
+ - [LoginByGameCenterOperationRequest](#loginbygamecenteroperationrequest)
49
+ - [LoginByiOSDeviceIdOperationRequest](#loginbyiosdeviceidoperationrequest)
50
+ - [LoginByLinuxDeviceIdOperationRequest](#loginbylinuxdeviceidoperationrequest)
51
+ - [LoginByMacOSDeviceIdOperationRequest](#loginbymacosdeviceidoperationrequest)
52
+ - [LoginByWindowsDeviceIdOperationRequest](#loginbywindowsdeviceidoperationrequest)
53
+ - [LoginByWindowsPhoneDeviceIdOperationRequest](#loginbywindowsphonedeviceidoperationrequest)
54
+ - [RegisterAccountOperationRequest](#registeraccountoperationrequest)
55
+ - [RefreshAuthTokenOperationRequest](#refreshauthtokenoperationrequest)
56
+ - **AuthenticateResponseModels** (from `AuthenticateResponseModels.ts`)
57
+ - [LoginByAccountOperationResponse](#loginbyaccountoperationresponse)
58
+ - [LoginByAndroidDeviceIdOperationResponse](#loginbyandroiddeviceidoperationresponse)
59
+ - [LoginByAppleOperationResponse](#loginbyappleoperationresponse)
60
+ - [LoginByCustomDeviceIdOperationResponse](#loginbycustomdeviceidoperationresponse)
61
+ - [LoginByCustomIdOperationResponse](#loginbycustomidoperationresponse)
62
+ - [LoginByEditorDeviceIdOperationResponse](#loginbyeditordeviceidoperationresponse)
63
+ - [LoginByFacebookOperationResponse](#loginbyfacebookoperationresponse)
64
+ - [LoginByGenericServiceOperationResponse](#loginbygenericserviceoperationresponse)
65
+ - [LoginByGoogleOperationResponse](#loginbygoogleoperationresponse)
66
+ - [LoginByGooglePlayGameServiceOperationResponse](#loginbygoogleplaygameserviceoperationresponse)
67
+ - [LoginByGameCenterOperationResponse](#loginbygamecenteroperationresponse)
68
+ - [LoginByiOSDeviceIdOperationResponse](#loginbyiosdeviceidoperationresponse)
69
+ - [LoginByLinuxDeviceIdOperationResponse](#loginbylinuxdeviceidoperationresponse)
70
+ - [LoginByMacOSDeviceIdOperationResponse](#loginbymacosdeviceidoperationresponse)
71
+ - [LoginByWindowsDeviceIdOperationResponse](#loginbywindowsdeviceidoperationresponse)
72
+ - [LoginByWindowsPhoneDeviceIdOperationResponse](#loginbywindowsphonedeviceidoperationresponse)
73
+ - [RegisterAccountOperationResponse](#registeraccountoperationresponse)
74
+ - [RefreshAuthTokenOperationResponse](#refreshauthtokenoperationresponse)
75
+
76
+ ---
77
+
78
+ ## Namespace `AuthenticateModels`
79
+
80
+ ### InfoRequestParam
81
+
82
+ Defines the reusable parameter block `infoRequestParam`. This object controls which optional profile fields should be returned together with the auth response. Every boolean flag defaults to `false`, so omit fields you do not need.
83
+
84
+ | Field | Type | Required | Notes |
85
+ |-------|------|----------|-------|
86
+ | `external` | `boolean` | no | Include linked external identity data. — _default=false_ |
87
+ | `segments` | `boolean` | no | Include segment assignments. — _default=false_ |
88
+ | `customDatas` | `boolean` | no | Include custom data entries, optionally filtered by `customDataKeys`. — _default=false_ |
89
+ | `displayName` | `boolean` | no | Include display-name data. — _default=false_ |
90
+ | `avatar` | `boolean` | no | Include avatar data. — _default=false_ |
91
+ | `tsCreate` | `boolean` | no | _default=false_ |
92
+ | `tags` | `boolean` | no | _default=false_ |
93
+ | `playerBan` | `boolean` | no | _default=false_ |
94
+ | `playerCurrencies` | `boolean` | no | _default=false_ |
95
+ | `playerStatistics` | `boolean` | no | _default=false_ |
96
+ | `playerDatas` | `boolean` | no | _default=false_ |
97
+ | `ipAddressCreate` | `boolean` | no | _default=false_ |
98
+ | `countryCode` | `boolean` | no | _default=false_ |
99
+ | `email` | `boolean` | no | _default=false_ |
100
+ | `tsLastLogin` | `boolean` | no | _default=false_ |
101
+ | `pushNotifications` | `boolean` | no | _default=false_ |
102
+ | `playerDataKeys` | `Array<string>` | no | Filter the returned player data fields. — _elementCls=String_ |
103
+ | `playerCurrencyKeys` | `Array<string>` | no | Filter the returned player currency fields. — _elementCls=String_ |
104
+ | `playerStatisticsKeys` | `Array<string>` | no | Filter the returned player statistics fields. — _elementCls=String_ |
105
+ | `customDataKeys` | `Array<string>` | no | Filter the returned custom-data fields. — _elementCls=String_ |
106
+ | `tagKeys` | `Array<string>` | no | Filter the returned tags by key. — _elementCls=String_ |
107
+
108
+ ### LoginByAccountRequestData
109
+
110
+ Defines the request payload for `loginByAccount`. Use this flow when the player authenticates with a GearN username and password.
111
+
112
+ | Field | Type | Required | Notes |
113
+ |-------|------|----------|-------|
114
+ | `username` | `string` | yes | _minLength=6, maxLength=32_ |
115
+ | `password` | `string` | yes | _minLength=6, maxLength=64_ |
116
+ | `infoRequestParam` | `InfoRequestParam` | yes | Controls which optional profile fields should be returned together with the auth payload. |
117
+
118
+ ### LoginByAndroidDeviceIdRequestData
119
+
120
+ Defines the request payload for LoginByAndroidDeviceId.
121
+
122
+ | Field | Type | Required | Notes |
123
+ |-------|------|----------|-------|
124
+ | `androidDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
125
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
126
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
127
+
128
+ ### LoginByAppleRequestData
129
+
130
+ Defines the request payload for LoginByApple.
131
+
132
+ | Field | Type | Required | Notes |
133
+ |-------|------|----------|-------|
134
+ | `token` | `string` | yes | _minLength=32, maxLength=2048_ |
135
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
136
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
137
+
138
+ ### LoginByCustomDeviceIdRequestData
139
+
140
+ Defines the request payload for LoginByCustomDeviceId.
141
+
142
+ | Field | Type | Required | Notes |
143
+ |-------|------|----------|-------|
144
+ | `customDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
145
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
146
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
147
+
148
+ ### LoginByCustomIdRequestData
149
+
150
+ Defines the request payload for LoginByCustomId.
151
+
152
+ | Field | Type | Required | Notes |
153
+ |-------|------|----------|-------|
154
+ | `customId` | `string` | yes | _minLength=6, maxLength=64_ |
155
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
156
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
157
+
158
+ ### LoginByEditorDeviceIdRequestData
159
+
160
+ Defines the request payload for LoginByEditorDeviceId.
161
+
162
+ | Field | Type | Required | Notes |
163
+ |-------|------|----------|-------|
164
+ | `editorDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
165
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
166
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
167
+
168
+ ### LoginByFacebookRequestData
169
+
170
+ Defines the request payload for LoginByFacebook.
171
+
172
+ | Field | Type | Required | Notes |
173
+ |-------|------|----------|-------|
174
+ | `token` | `string` | yes | _minLength=32, maxLength=2048_ |
175
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
176
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
177
+
178
+ ### LoginByGenericServiceRequestData
179
+
180
+ Defines the request payload for `loginByGenericService`. `serviceData` is provider-defined and is not constrained by a public typed schema beyond `GNHashtable`.
181
+
182
+ | Field | Type | Required | Notes |
183
+ |-------|------|----------|-------|
184
+ | `serviceName` | `string` | yes | _minLength=6, maxLength=32_ |
185
+ | `serviceData` | `GNHashtable` | yes | Provider-defined payload consumed by the backend integration for `serviceName`. |
186
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
187
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
188
+
189
+ ### LoginByGoogleRequestData
190
+
191
+ Defines the request payload for `loginByGoogle`. `type` should be mapped with the public `GoogleLoginType` enum.
192
+
193
+ | Field | Type | Required | Notes |
194
+ |-------|------|----------|-------|
195
+ | `token` | `string` | yes | _minLength=32, maxLength=2048_ |
196
+ | `type` | `number` | yes | _min=1, max=2_ |
197
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
198
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
199
+
200
+ ### LoginByGooglePlayGameServiceRequestData
201
+
202
+ Defines the request payload for LoginByGooglePlayGameService.
203
+
204
+ | Field | Type | Required | Notes |
205
+ |-------|------|----------|-------|
206
+ | `token` | `string` | yes | _minLength=32, maxLength=2048_ |
207
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
208
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
209
+
210
+ ### LoginByGameCenterRequestData
211
+
212
+ Defines the request payload for LoginByGameCenter.
213
+
214
+ | Field | Type | Required | Notes |
215
+ |-------|------|----------|-------|
216
+ | `playerId` | `string` | yes | _minLength=2, maxLength=64_ |
217
+ | `name` | `string` | yes | _minLength=2, maxLength=128_ |
218
+ | `publicKeyUrl` | `string` | yes | _minLength=2, maxLength=2048_ |
219
+ | `signature` | `string` | yes | _minLength=2, maxLength=2048_ |
220
+ | `salt` | `string` | yes | _minLength=2, maxLength=256_ |
221
+ | `timestamp` | `number` | yes | — |
222
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
223
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
224
+
225
+ ### LoginByiOSDeviceIdRequestData
226
+
227
+ Defines the request payload for LoginByiOSDeviceId.
228
+
229
+ | Field | Type | Required | Notes |
230
+ |-------|------|----------|-------|
231
+ | `iOSDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
232
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
233
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
234
+
235
+ ### LoginByLinuxDeviceIdRequestData
236
+
237
+ Defines the request payload for LoginByLinuxDeviceId.
238
+
239
+ | Field | Type | Required | Notes |
240
+ |-------|------|----------|-------|
241
+ | `linuxDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
242
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
243
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
244
+
245
+ ### LoginByMacOSDeviceIdRequestData
246
+
247
+ Defines the request payload for LoginByMacOSDeviceId.
248
+
249
+ | Field | Type | Required | Notes |
250
+ |-------|------|----------|-------|
251
+ | `macOSDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
252
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
253
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
254
+
255
+ ### LoginByWindowsDeviceIdRequestData
256
+
257
+ Defines the request payload for LoginByWindowsDeviceId.
258
+
259
+ | Field | Type | Required | Notes |
260
+ |-------|------|----------|-------|
261
+ | `windowsDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
262
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
263
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
264
+
265
+ ### LoginByWindowsPhoneDeviceIdRequestData
266
+
267
+ Defines the request payload for LoginByWindowsPhoneDeviceId.
268
+
269
+ | Field | Type | Required | Notes |
270
+ |-------|------|----------|-------|
271
+ | `windowsPhoneDeviceId` | `string` | yes | _minLength=6, maxLength=64_ |
272
+ | `createPlayerIfNotExists` | `boolean` | no | _default=false_ |
273
+ | `infoRequestParam` | `InfoRequestParam` | yes | — |
274
+
275
+ ### RegisterAccountRequestData
276
+
277
+ Defines the request payload for `registerAccount`. This creates a GearN account and returns the same profile-style payload shape used by the normal login flows.
278
+
279
+ | Field | Type | Required | Notes |
280
+ |-------|------|----------|-------|
281
+ | `username` | `string` | yes | _minLength=6, maxLength=32_ |
282
+ | `password` | `string` | yes | _minLength=6, maxLength=64_ |
283
+ | `infoRequestParam` | `InfoRequestParam` | yes | Controls which optional profile fields should be returned together with the auth payload. |
284
+
285
+ ### RefreshAuthTokenRequestData
286
+
287
+ Defines the request payload for `refreshAuthToken`. The request body is intentionally empty. The current auth context comes from the stored auth token or from `overrideAuthToken` passed to the API call.
288
+
289
+ _Không có field public (payload rỗng)._
290
+
291
+ ### AuthenticateResponseData
292
+
293
+ Extends: `MasterPlayerModels.MasterPlayerWithUserIdResponseData`
294
+
295
+ Defines the response payload returned by most login and register flows. This payload extends `MasterPlayerWithUserIdResponseData`, so it may already include profile data requested through `infoRequestParam` in addition to auth-specific fields.
296
+
297
+ | Field | Type | Required | Notes |
298
+ |-------|------|----------|-------|
299
+ | `newlyCreated` | `boolean` | no | Indicates whether the backend created a new player as part of the login flow. |
300
+ | `authToken` | `string` | no | Auth token to cache locally and reuse for future HTTP or socket auth flows. |
301
+ | `playerBan` | `GenericModels.BanItem` | no | Optional ban state returned together with the auth payload. |
302
+
303
+ ### GenericServiceAuthenticateResponseData
304
+
305
+ Extends: `AuthenticateResponseData`
306
+
307
+ Defines the response payload for `loginByGenericService`. This extends the normal auth response and adds an optional backend error message for the external provider flow.
308
+
309
+ | Field | Type | Required | Notes |
310
+ |-------|------|----------|-------|
311
+ | `errorMessage` | `string` | no | Optional provider-specific error message returned by the backend integration. |
312
+
313
+ ### RefreshAuthTokenResponseData
314
+
315
+ Defines the response payload for `refreshAuthToken`. Unlike the normal login flows, this response only returns the refreshed auth token and optional ban state.
316
+
317
+ | Field | Type | Required | Notes |
318
+ |-------|------|----------|-------|
319
+ | `authToken` | `string` | no | Refreshed auth token that should replace the previously stored token. |
320
+ | `playerBan` | `GenericModels.BanItem` | no | Optional ban state returned together with the refreshed token. |
321
+
322
+ ### EmptyResponseData
323
+
324
+ Defines an intentionally empty response payload.
325
+
326
+ _Không có field public (payload rỗng)._
327
+
328
+ ## Namespace `AuthenticateRequestModels`
329
+
330
+ ### LoginByAccountOperationRequest
331
+
332
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByAccountRequestData>`
333
+
334
+ Maps the LoginByAccount operation to a typed request wrapper.
335
+
336
+ _Không có field public (payload rỗng)._
337
+
338
+ ### LoginByAndroidDeviceIdOperationRequest
339
+
340
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByAndroidDeviceIdRequestData>`
341
+
342
+ Maps the LoginByAndroidDeviceId operation to a typed request wrapper.
343
+
344
+ _Không có field public (payload rỗng)._
345
+
346
+ ### LoginByAppleOperationRequest
347
+
348
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByAppleRequestData>`
349
+
350
+ Maps the LoginByApple operation to a typed request wrapper.
351
+
352
+ _Không có field public (payload rỗng)._
353
+
354
+ ### LoginByCustomDeviceIdOperationRequest
355
+
356
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByCustomDeviceIdRequestData>`
357
+
358
+ Maps the LoginByCustomDeviceId operation to a typed request wrapper.
359
+
360
+ _Không có field public (payload rỗng)._
361
+
362
+ ### LoginByCustomIdOperationRequest
363
+
364
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByCustomIdRequestData>`
365
+
366
+ Maps the LoginByCustomId operation to a typed request wrapper.
367
+
368
+ _Không có field public (payload rỗng)._
369
+
370
+ ### LoginByEditorDeviceIdOperationRequest
371
+
372
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByEditorDeviceIdRequestData>`
373
+
374
+ Maps the LoginByEditorDeviceId operation to a typed request wrapper.
375
+
376
+ _Không có field public (payload rỗng)._
377
+
378
+ ### LoginByFacebookOperationRequest
379
+
380
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByFacebookRequestData>`
381
+
382
+ Maps the LoginByFacebook operation to a typed request wrapper.
383
+
384
+ _Không có field public (payload rỗng)._
385
+
386
+ ### LoginByGenericServiceOperationRequest
387
+
388
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByGenericServiceRequestData>`
389
+
390
+ Maps the LoginByGenericService operation to a typed request wrapper.
391
+
392
+ _Không có field public (payload rỗng)._
393
+
394
+ ### LoginByGoogleOperationRequest
395
+
396
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByGoogleRequestData>`
397
+
398
+ Maps the LoginByGoogle operation to a typed request wrapper.
399
+
400
+ _Không có field public (payload rỗng)._
401
+
402
+ ### LoginByGooglePlayGameServiceOperationRequest
403
+
404
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByGooglePlayGameServiceRequestData>`
405
+
406
+ Maps the LoginByGooglePlayGameService operation to a typed request wrapper.
407
+
408
+ _Không có field public (payload rỗng)._
409
+
410
+ ### LoginByGameCenterOperationRequest
411
+
412
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByGameCenterRequestData>`
413
+
414
+ Maps the LoginByGameCenter operation to a typed request wrapper.
415
+
416
+ _Không có field public (payload rỗng)._
417
+
418
+ ### LoginByiOSDeviceIdOperationRequest
419
+
420
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByiOSDeviceIdRequestData>`
421
+
422
+ Maps the LoginByiOSDeviceId operation to a typed request wrapper.
423
+
424
+ _Không có field public (payload rỗng)._
425
+
426
+ ### LoginByLinuxDeviceIdOperationRequest
427
+
428
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByLinuxDeviceIdRequestData>`
429
+
430
+ Maps the LoginByLinuxDeviceId operation to a typed request wrapper.
431
+
432
+ _Không có field public (payload rỗng)._
433
+
434
+ ### LoginByMacOSDeviceIdOperationRequest
435
+
436
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByMacOSDeviceIdRequestData>`
437
+
438
+ Maps the LoginByMacOSDeviceId operation to a typed request wrapper.
439
+
440
+ _Không có field public (payload rỗng)._
441
+
442
+ ### LoginByWindowsDeviceIdOperationRequest
443
+
444
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByWindowsDeviceIdRequestData>`
445
+
446
+ Maps the LoginByWindowsDeviceId operation to a typed request wrapper.
447
+
448
+ _Không có field public (payload rỗng)._
449
+
450
+ ### LoginByWindowsPhoneDeviceIdOperationRequest
451
+
452
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.LoginByWindowsPhoneDeviceIdRequestData>`
453
+
454
+ Maps the LoginByWindowsPhoneDeviceId operation to a typed request wrapper.
455
+
456
+ _Không có field public (payload rỗng)._
457
+
458
+ ### RegisterAccountOperationRequest
459
+
460
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.RegisterAccountRequestData>`
461
+
462
+ Maps the RegisterAccount operation to a typed request wrapper.
463
+
464
+ _Không có field public (payload rỗng)._
465
+
466
+ ### RefreshAuthTokenOperationRequest
467
+
468
+ Extends: `CustomOperationRequestAbstract<AuthenticateModels.RefreshAuthTokenRequestData>`
469
+
470
+ Maps the `RefreshAuthToken` operation to a typed request wrapper. The wrapped request body is intentionally empty; auth context still comes from the current token.
471
+
472
+ _Không có field public (payload rỗng)._
473
+
474
+ ## Namespace `AuthenticateResponseModels`
475
+
476
+ ### LoginByAccountOperationResponse
477
+
478
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
479
+
480
+ Maps the LoginByAccount operation to a typed response wrapper.
481
+
482
+ _Không có field public (payload rỗng)._
483
+
484
+ ### LoginByAndroidDeviceIdOperationResponse
485
+
486
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
487
+
488
+ Maps the LoginByAndroidDeviceId operation to a typed response wrapper.
489
+
490
+ _Không có field public (payload rỗng)._
491
+
492
+ ### LoginByAppleOperationResponse
493
+
494
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
495
+
496
+ Maps the LoginByApple operation to a typed response wrapper.
497
+
498
+ _Không có field public (payload rỗng)._
499
+
500
+ ### LoginByCustomDeviceIdOperationResponse
501
+
502
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
503
+
504
+ Maps the LoginByCustomDeviceId operation to a typed response wrapper.
505
+
506
+ _Không có field public (payload rỗng)._
507
+
508
+ ### LoginByCustomIdOperationResponse
509
+
510
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
511
+
512
+ Maps the LoginByCustomId operation to a typed response wrapper.
513
+
514
+ _Không có field public (payload rỗng)._
515
+
516
+ ### LoginByEditorDeviceIdOperationResponse
517
+
518
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
519
+
520
+ Maps the LoginByEditorDeviceId operation to a typed response wrapper.
521
+
522
+ _Không có field public (payload rỗng)._
523
+
524
+ ### LoginByFacebookOperationResponse
525
+
526
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
527
+
528
+ Maps the LoginByFacebook operation to a typed response wrapper.
529
+
530
+ _Không có field public (payload rỗng)._
531
+
532
+ ### LoginByGenericServiceOperationResponse
533
+
534
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.GenericServiceAuthenticateResponseData>`
535
+
536
+ Maps the LoginByGenericService operation to a typed response wrapper.
537
+
538
+ _Không có field public (payload rỗng)._
539
+
540
+ ### LoginByGoogleOperationResponse
541
+
542
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
543
+
544
+ Maps the LoginByGoogle operation to a typed response wrapper.
545
+
546
+ _Không có field public (payload rỗng)._
547
+
548
+ ### LoginByGooglePlayGameServiceOperationResponse
549
+
550
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
551
+
552
+ Maps the LoginByGooglePlayGameService operation to a typed response wrapper.
553
+
554
+ _Không có field public (payload rỗng)._
555
+
556
+ ### LoginByGameCenterOperationResponse
557
+
558
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
559
+
560
+ Maps the LoginByGameCenter operation to a typed response wrapper.
561
+
562
+ _Không có field public (payload rỗng)._
563
+
564
+ ### LoginByiOSDeviceIdOperationResponse
565
+
566
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
567
+
568
+ Maps the LoginByiOSDeviceId operation to a typed response wrapper.
569
+
570
+ _Không có field public (payload rỗng)._
571
+
572
+ ### LoginByLinuxDeviceIdOperationResponse
573
+
574
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
575
+
576
+ Maps the LoginByLinuxDeviceId operation to a typed response wrapper.
577
+
578
+ _Không có field public (payload rỗng)._
579
+
580
+ ### LoginByMacOSDeviceIdOperationResponse
581
+
582
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
583
+
584
+ Maps the LoginByMacOSDeviceId operation to a typed response wrapper.
585
+
586
+ _Không có field public (payload rỗng)._
587
+
588
+ ### LoginByWindowsDeviceIdOperationResponse
589
+
590
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
591
+
592
+ Maps the LoginByWindowsDeviceId operation to a typed response wrapper.
593
+
594
+ _Không có field public (payload rỗng)._
595
+
596
+ ### LoginByWindowsPhoneDeviceIdOperationResponse
597
+
598
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
599
+
600
+ Maps the LoginByWindowsPhoneDeviceId operation to a typed response wrapper.
601
+
602
+ _Không có field public (payload rỗng)._
603
+
604
+ ### RegisterAccountOperationResponse
605
+
606
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData>`
607
+
608
+ Maps the RegisterAccount operation to a typed response wrapper.
609
+
610
+ _Không có field public (payload rỗng)._
611
+
612
+ ### RefreshAuthTokenOperationResponse
613
+
614
+ Extends: `CustomOperationResponseAbstract<AuthenticateModels.RefreshAuthTokenResponseData>`
615
+
616
+ Maps the RefreshAuthToken operation to a typed response wrapper.
617
+
618
+ _Không có field public (payload rỗng)._
619
+