@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,1980 @@
1
+ # DTO Reference: Dashboard
2
+
3
+ Admin login, game/admin account/secret management, analytics, server log, maintenance tools.
4
+
5
+ Related API reference: [API_DASHBOARD.md](../API_DASHBOARD.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
+ - **DashboardModels** (from `DashboardModels.ts`)
14
+ - [PermissionRulesParam](#permissionrulesparam)
15
+ - [FriendCatalogSettingsParam](#friendcatalogsettingsparam)
16
+ - [ItemClassSettingsParam](#itemclasssettingsparam)
17
+ - [ItemCatalogSettingsParam](#itemcatalogsettingsparam)
18
+ - [GroupCatalogSettingsParam](#groupcatalogsettingsparam)
19
+ - [TagSettingsParam](#tagsettingsparam)
20
+ - [DataSettingsParam](#datasettingsparam)
21
+ - [StatisticsSettingsParam](#statisticssettingsparam)
22
+ - [CurrencySettingsParam](#currencysettingsparam)
23
+ - [CharacterCatalogSettingsParam](#charactercatalogsettingsparam)
24
+ - [CharacterPlayerPermissionRulesParam](#characterplayerpermissionrulesparam)
25
+ - [CharacterPlayerSettingsParam](#characterplayersettingsparam)
26
+ - [ContentPermissionRulesParam](#contentpermissionrulesparam)
27
+ - [ThirtPartyAppleSettingsParam](#thirtpartyapplesettingsparam)
28
+ - [ThirtPartyFacebookSettingsParam](#thirtpartyfacebooksettingsparam)
29
+ - [ThirtPartyGoogleSettingsParam](#thirtpartygooglesettingsparam)
30
+ - [ThirtPartyGameCenterSettingsParam](#thirtpartygamecentersettingsparam)
31
+ - [ThirtPartyGooglePlayGameSettingsParam](#thirtpartygoogleplaygamesettingsparam)
32
+ - [ThirtPartyParam](#thirtpartyparam)
33
+ - [EmailSettingsParam](#emailsettingsparam)
34
+ - [PushNotificationSettingsParam](#pushnotificationsettingsparam)
35
+ - [GamePlayerPermissionRulesParam](#gameplayerpermissionrulesparam)
36
+ - [GamePlayerSettingsParam](#gameplayersettingsparam)
37
+ - [GroupSettingsParam](#groupsettingsparam)
38
+ - [InventorySettingsParam](#inventorysettingsparam)
39
+ - [GameSettingsParam](#gamesettingsparam)
40
+ - [GenericServiceSettingsParam](#genericservicesettingsparam)
41
+ - [GroupPermissionRulesParam](#grouppermissionrulesparam)
42
+ - [InventoryPermissionRulesParam](#inventorypermissionrulesparam)
43
+ - [DashboardPermissionRulesParam](#dashboardpermissionrulesparam)
44
+ - [MultiplayerPermissionRulesParam](#multiplayerpermissionrulesparam)
45
+ - [MasterPlayerPermissionRulesParam](#masterplayerpermissionrulesparam)
46
+ - [MasterPlayerSettingsParam](#masterplayersettingsparam)
47
+ - [SizeParam](#sizeparam)
48
+ - [TeamParam](#teamparam)
49
+ - [LinearExpansionsParam](#linearexpansionsparam)
50
+ - [CustomExpansionsParam](#customexpansionsparam)
51
+ - [AdvancedSettingsParam](#advancedsettingsparam)
52
+ - [RuleParam](#ruleparam)
53
+ - [ServerAllocationParam](#serverallocationparam)
54
+ - [MatchmakingQueueSettingsParam](#matchmakingqueuesettingsparam)
55
+ - [AuthenticatePermissionRulesParam](#authenticatepermissionrulesparam)
56
+ - [StoreInventoryPermissionRulesParam](#storeinventorypermissionrulesparam)
57
+ - [CloudScriptPermissionRulesParam](#cloudscriptpermissionrulesparam)
58
+ - [PermissionParam](#permissionparam)
59
+ - [ChangePasswordAdminAccountRequestData](#changepasswordadminaccountrequestdata)
60
+ - [GetAdminAccountListRequestData](#getadminaccountlistrequestdata)
61
+ - [GetGameInformationRequestData](#getgameinformationrequestdata)
62
+ - [GetGameListRequestData](#getgamelistrequestdata)
63
+ - [GetMasterGameSettingsRequestData](#getmastergamesettingsrequestdata)
64
+ - [GetSecretInfoInformationRequestData](#getsecretinfoinformationrequestdata)
65
+ - [GetSecretInfoListRequestData](#getsecretinfolistrequestdata)
66
+ - [GetServerLogRequestData](#getserverlogrequestdata)
67
+ - [CreateAdminAccountRequestData](#createadminaccountrequestdata)
68
+ - [CreateGameRequestData](#creategamerequestdata)
69
+ - [CreateSecretInfoRequestData](#createsecretinforequestdata)
70
+ - [LoginByAdminAccountRequestData](#loginbyadminaccountrequestdata)
71
+ - [RemoveAdminAccountRequestData](#removeadminaccountrequestdata)
72
+ - [SetGameInformationRequestData](#setgameinformationrequestdata)
73
+ - [SetMasterGameSettingsRequestData](#setmastergamesettingsrequestdata)
74
+ - [SetPasswordAdminAccountRequestData](#setpasswordadminaccountrequestdata)
75
+ - [SetSecretInfoInformationRequestData](#setsecretinfoinformationrequestdata)
76
+ - [SetSecretKeyAdminAccountRequestData](#setsecretkeyadminaccountrequestdata)
77
+ - [GetAnalyticsRequestData](#getanalyticsrequestdata)
78
+ - [GetUsernameAdminAccountRequestData](#getusernameadminaccountrequestdata)
79
+ - [GetEventCallbackCloudScriptRequestData](#geteventcallbackcloudscriptrequestdata)
80
+ - [SetEventCallbackCloudScriptRequestData](#seteventcallbackcloudscriptrequestdata)
81
+ - [ResetStatisticsLeaderboardRequestData](#resetstatisticsleaderboardrequestdata)
82
+ - [DeleteInDatabaseRequestData](#deleteindatabaserequestdata)
83
+ - [GetBackupStatisticsLeaderboardVersionRequestData](#getbackupstatisticsleaderboardversionrequestdata)
84
+ - [GetServerGameDataRequestData](#getservergamedatarequestdata)
85
+ - [AdminAccountResponseData](#adminaccountresponsedata)
86
+ - [GetAdminAccountListResponseData](#getadminaccountlistresponsedata)
87
+ - [GetGameInformationResponseData](#getgameinformationresponsedata)
88
+ - [GameWithGameIdResponseData](#gamewithgameidresponsedata)
89
+ - [GetGameListResponseData](#getgamelistresponsedata)
90
+ - [GetMasterGameSettingsResponseData](#getmastergamesettingsresponsedata)
91
+ - [GetSecretInfoInformationResponseData](#getsecretinfoinformationresponsedata)
92
+ - [SecretInfoWithSecretKeyResponseData](#secretinfowithsecretkeyresponsedata)
93
+ - [GetSecretInfoListResponseData](#getsecretinfolistresponsedata)
94
+ - [AdminAccountWithUserIdResponseData](#adminaccountwithuseridresponsedata)
95
+ - [CreateAdminAccountResponseData](#createadminaccountresponsedata)
96
+ - [LoginByAdminAccountResponseData](#loginbyadminaccountresponsedata)
97
+ - [GetServerLogResponseData](#getserverlogresponsedata)
98
+ - [CountryRegionResponseData](#countryregionresponsedata)
99
+ - [CountryResponseData](#countryresponsedata)
100
+ - [AnalyticsItemResponseData](#analyticsitemresponsedata)
101
+ - [MemoryUsageResponseData](#memoryusageresponsedata)
102
+ - [StorageUsageResponseData](#storageusageresponsedata)
103
+ - [DatabaseSystemResponseData](#databasesystemresponsedata)
104
+ - [OperationSystemResponseData](#operationsystemresponsedata)
105
+ - [RequestCompleteErrorCodeResponseData](#requestcompleteerrorcoderesponsedata)
106
+ - [RequestCompleteResponseData](#requestcompleteresponsedata)
107
+ - [CostResponseData](#costresponsedata)
108
+ - [GetAnalyticsResponseData](#getanalyticsresponsedata)
109
+ - [GetUsernameAdminAccountResponseData](#getusernameadminaccountresponsedata)
110
+ - [ChildScriptResponseData](#childscriptresponsedata)
111
+ - [EventCallbackCloudScriptResponseData](#eventcallbackcloudscriptresponsedata)
112
+ - [GetEventCallbackCloudScriptResponseData](#geteventcallbackcloudscriptresponsedata)
113
+ - [SetEventCallbackCloudScriptResponseData](#seteventcallbackcloudscriptresponsedata)
114
+ - [BackupStatisticsLeaderboardVersionResponseData](#backupstatisticsleaderboardversionresponsedata)
115
+ - [GetBackupStatisticsLeaderboardVersionResponseData](#getbackupstatisticsleaderboardversionresponsedata)
116
+ - [GetServerGameDataResponseData](#getservergamedataresponsedata)
117
+ - [EmptyResponseData](#emptyresponsedata)
118
+ - **DashboardRequestModels** (from `DashboardRequestModels.ts`)
119
+ - [ChangePasswordAdminAccountOperationRequest](#changepasswordadminaccountoperationrequest)
120
+ - [GetAdminAccountListOperationRequest](#getadminaccountlistoperationrequest)
121
+ - [GetGameInformationOperationRequest](#getgameinformationoperationrequest)
122
+ - [GetGameListOperationRequest](#getgamelistoperationrequest)
123
+ - [GetMasterGameSettingsOperationRequest](#getmastergamesettingsoperationrequest)
124
+ - [GetSecretInfoInformationOperationRequest](#getsecretinfoinformationoperationrequest)
125
+ - [GetSecretInfoListOperationRequest](#getsecretinfolistoperationrequest)
126
+ - [GetServerLogOperationRequest](#getserverlogoperationrequest)
127
+ - [CreateAdminAccountOperationRequest](#createadminaccountoperationrequest)
128
+ - [CreateGameOperationRequest](#creategameoperationrequest)
129
+ - [CreateSecretInfoOperationRequest](#createsecretinfooperationrequest)
130
+ - [LoginByAdminAccountOperationRequest](#loginbyadminaccountoperationrequest)
131
+ - [RemoveAdminAccountOperationRequest](#removeadminaccountoperationrequest)
132
+ - [SetGameInformationOperationRequest](#setgameinformationoperationrequest)
133
+ - [SetMasterGameSettingsOperationRequest](#setmastergamesettingsoperationrequest)
134
+ - [SetPasswordAdminAccountOperationRequest](#setpasswordadminaccountoperationrequest)
135
+ - [SetSecretInfoInformationOperationRequest](#setsecretinfoinformationoperationrequest)
136
+ - [SetSecretKeyAdminAccountOperationRequest](#setsecretkeyadminaccountoperationrequest)
137
+ - [GetUsernameAdminAccountOperationRequest](#getusernameadminaccountoperationrequest)
138
+ - [GetAnalyticsOperationRequest](#getanalyticsoperationrequest)
139
+ - [GetEventCallbackCloudScriptOperationRequest](#geteventcallbackcloudscriptoperationrequest)
140
+ - [SetEventCallbackCloudScriptOperationRequest](#seteventcallbackcloudscriptoperationrequest)
141
+ - [ResetStatisticsLeaderboardOperationRequest](#resetstatisticsleaderboardoperationrequest)
142
+ - [GetBackupStatisticsLeaderboardVersionOperationRequest](#getbackupstatisticsleaderboardversionoperationrequest)
143
+ - [GetServerGameDataOperationRequest](#getservergamedataoperationrequest)
144
+ - [DeleteInDatabaseOperationRequest](#deleteindatabaseoperationrequest)
145
+ - **DashboardResponseModels** (from `DashboardResponseModels.ts`)
146
+ - [ChangePasswordAdminAccountOperationResponse](#changepasswordadminaccountoperationresponse)
147
+ - [GetAdminAccountListOperationResponse](#getadminaccountlistoperationresponse)
148
+ - [GetGameInformationOperationResponse](#getgameinformationoperationresponse)
149
+ - [GetGameListOperationResponse](#getgamelistoperationresponse)
150
+ - [GetMasterGameSettingsOperationResponse](#getmastergamesettingsoperationresponse)
151
+ - [GetSecretInfoInformationOperationResponse](#getsecretinfoinformationoperationresponse)
152
+ - [GetSecretInfoListOperationResponse](#getsecretinfolistoperationresponse)
153
+ - [GetServerLogOperationResponse](#getserverlogoperationresponse)
154
+ - [CreateAdminAccountOperationResponse](#createadminaccountoperationresponse)
155
+ - [CreateGameOperationResponse](#creategameoperationresponse)
156
+ - [CreateSecretInfoOperationResponse](#createsecretinfooperationresponse)
157
+ - [LoginByAdminAccountOperationResponse](#loginbyadminaccountoperationresponse)
158
+ - [RemoveAdminAccountOperationResponse](#removeadminaccountoperationresponse)
159
+ - [SetGameInformationOperationResponse](#setgameinformationoperationresponse)
160
+ - [SetMasterGameSettingsOperationResponse](#setmastergamesettingsoperationresponse)
161
+ - [SetPasswordAdminAccountOperationResponse](#setpasswordadminaccountoperationresponse)
162
+ - [SetSecretInfoInformationOperationResponse](#setsecretinfoinformationoperationresponse)
163
+ - [SetSecretKeyAdminAccountOperationResponse](#setsecretkeyadminaccountoperationresponse)
164
+ - [GetUsernameAdminAccountOperationResponse](#getusernameadminaccountoperationresponse)
165
+ - [GetAnalyticsOperationResponse](#getanalyticsoperationresponse)
166
+ - [GetEventCallbackCloudScriptOperationResponse](#geteventcallbackcloudscriptoperationresponse)
167
+ - [SetEventCallbackCloudScriptOperationResponse](#seteventcallbackcloudscriptoperationresponse)
168
+ - [ResetStatisticsLeaderboardOperationResponse](#resetstatisticsleaderboardoperationresponse)
169
+ - [GetBackupStatisticsLeaderboardVersionOperationResponse](#getbackupstatisticsleaderboardversionoperationresponse)
170
+ - [GetServerGameDataOperationResponse](#getservergamedataoperationresponse)
171
+ - [DeleteInDatabaseOperationResponse](#deleteindatabaseoperationresponse)
172
+
173
+ ---
174
+
175
+ ## Namespace `DashboardModels`
176
+
177
+ ### PermissionRulesParam
178
+
179
+ Defines the reusable permission-rule block used by secret-info and master settings payloads. These flags map directly to the GearN Server permission checks described in the public docs.
180
+
181
+ | Field | Type | Required | Notes |
182
+ |-------|------|----------|-------|
183
+ | `selfEnable` | `boolean` | no | Allows the operation on resources that belong to the authenticated user context. |
184
+ | `otherSelfEnable` | `boolean` | no | Allows the operation on resources that do not belong to the authenticated user context. |
185
+ | `adminSelfEnable` | `boolean` | no | Allows the operation through admin-scoped execution context. |
186
+ | `serverSelfEnable` | `boolean` | no | Allows the operation through server-scoped execution context. |
187
+
188
+ ### FriendCatalogSettingsParam
189
+
190
+ Defines the reusable parameter block FriendCatalogSettingsParam.
191
+
192
+ | Field | Type | Required | Notes |
193
+ |-------|------|----------|-------|
194
+ | `catalogId` | `string` | yes | _minLength=2, maxLength=32_ |
195
+ | `description` | `string` | yes | — |
196
+ | `forceAcceptFriend` | `boolean` | yes | — |
197
+
198
+ ### ItemClassSettingsParam
199
+
200
+ Defines the reusable parameter block ItemClassSettingsParam.
201
+
202
+ | Field | Type | Required | Notes |
203
+ |-------|------|----------|-------|
204
+ | `classId` | `string` | yes | _minLength=2, maxLength=32_ |
205
+ | `description` | `string` | yes | — |
206
+
207
+ ### ItemCatalogSettingsParam
208
+
209
+ Defines the reusable parameter block ItemCatalogSettingsParam.
210
+
211
+ | Field | Type | Required | Notes |
212
+ |-------|------|----------|-------|
213
+ | `catalogId` | `string` | yes | _minLength=2, maxLength=32_ |
214
+ | `itemType` | `number` | yes | — |
215
+ | `itemClassSettings` | `Array<ItemClassSettingsParam>` | yes | _elementCls=ItemClassSettingsParam_ |
216
+
217
+ ### GroupCatalogSettingsParam
218
+
219
+ Defines the reusable parameter block GroupCatalogSettingsParam.
220
+
221
+ | Field | Type | Required | Notes |
222
+ |-------|------|----------|-------|
223
+ | `catalogId` | `string` | yes | _minLength=2, maxLength=32_ |
224
+ | `description` | `string` | yes | — |
225
+ | `forceAcceptMember` | `boolean` | yes | — |
226
+
227
+ ### TagSettingsParam
228
+
229
+ Defines the reusable parameter block TagSettingsParam.
230
+
231
+ | Field | Type | Required | Notes |
232
+ |-------|------|----------|-------|
233
+ | `key` | `string` | yes | _minLength=2, maxLength=32_ |
234
+ | `description` | `string` | yes | — |
235
+ | `index` | `boolean` | yes | — |
236
+
237
+ ### DataSettingsParam
238
+
239
+ Defines the reusable parameter block DataSettingsParam.
240
+
241
+ | Field | Type | Required | Notes |
242
+ |-------|------|----------|-------|
243
+ | `key` | `string` | yes | _minLength=2, maxLength=32_ |
244
+ | `description` | `string` | yes | — |
245
+ | `permission` | `number` | yes | — |
246
+
247
+ ### StatisticsSettingsParam
248
+
249
+ Defines the reusable parameter block StatisticsSettingsParam.
250
+
251
+ | Field | Type | Required | Notes |
252
+ |-------|------|----------|-------|
253
+ | `key` | `string` | yes | _minLength=2, maxLength=32_ |
254
+ | `statisticsAggregationMethod` | `number` | yes | — |
255
+ | `maximumValue` | `number` | no | _default=0_ |
256
+ | `minimumValue` | `number` | no | _default=0_ |
257
+ | `initialValue` | `number` | yes | — |
258
+ | `description` | `string` | yes | — |
259
+ | `index` | `boolean` | yes | — |
260
+
261
+ ### CurrencySettingsParam
262
+
263
+ Defines the reusable parameter block CurrencySettingsParam.
264
+
265
+ | Field | Type | Required | Notes |
266
+ |-------|------|----------|-------|
267
+ | `key` | `string` | yes | _minLength=2, maxLength=32_ |
268
+ | `initialValue` | `number` | yes | — |
269
+ | `description` | `string` | yes | — |
270
+ | `index` | `boolean` | yes | — |
271
+
272
+ ### CharacterCatalogSettingsParam
273
+
274
+ Defines the reusable parameter block CharacterCatalogSettingsParam.
275
+
276
+ | Field | Type | Required | Notes |
277
+ |-------|------|----------|-------|
278
+ | `catalogId` | `string` | yes | _minLength=2, maxLength=32_ |
279
+ | `description` | `string` | yes | — |
280
+
281
+ ### CharacterPlayerPermissionRulesParam
282
+
283
+ Defines the reusable parameter block CharacterPlayerPermissionRulesParam.
284
+
285
+ | Field | Type | Required | Notes |
286
+ |-------|------|----------|-------|
287
+ | `addSegment` | `PermissionRulesParam` | no | — |
288
+ | `removeSegment` | `PermissionRulesParam` | no | — |
289
+ | `getSegment` | `PermissionRulesParam` | no | — |
290
+ | `setTag` | `PermissionRulesParam` | no | — |
291
+ | `removeTag` | `PermissionRulesParam` | no | — |
292
+ | `getTag` | `PermissionRulesParam` | no | — |
293
+ | `getDisplayName` | `PermissionRulesParam` | no | — |
294
+ | `setDisplayName` | `PermissionRulesParam` | no | — |
295
+ | `getTsCreate` | `PermissionRulesParam` | no | — |
296
+ | `getIpAddressCreate` | `PermissionRulesParam` | no | — |
297
+ | `getTsLastLogin` | `PermissionRulesParam` | no | — |
298
+ | `setPlayerBan` | `PermissionRulesParam` | no | — |
299
+ | `getPlayerBan` | `PermissionRulesParam` | no | — |
300
+ | `setCountryCode` | `PermissionRulesParam` | no | — |
301
+ | `getCountryCode` | `PermissionRulesParam` | no | — |
302
+ | `setAvatar` | `PermissionRulesParam` | no | — |
303
+ | `getAvatar` | `PermissionRulesParam` | no | — |
304
+ | `changePlayerCurrency` | `PermissionRulesParam` | no | — |
305
+ | `getPlayerCurrency` | `PermissionRulesParam` | no | — |
306
+ | `changePlayerStatistics` | `PermissionRulesParam` | no | — |
307
+ | `getPlayerStatistics` | `PermissionRulesParam` | no | — |
308
+ | `getStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
309
+ | `getStatisticsLeaderboardAroundPlayer` | `PermissionRulesParam` | no | — |
310
+ | `getCustomData` | `PermissionRulesParam` | no | — |
311
+ | `setCustomData` | `PermissionRulesParam` | no | — |
312
+ | `setPlayerData` | `PermissionRulesParam` | no | — |
313
+ | `getPlayerData` | `PermissionRulesParam` | no | — |
314
+ | `getPlayerInformation` | `PermissionRulesParam` | no | — |
315
+ | `getPlayersWithSegment` | `PermissionRulesParam` | no | — |
316
+ | `getPlayersWithTag` | `PermissionRulesParam` | no | — |
317
+ | `getCatalogId` | `PermissionRulesParam` | no | — |
318
+ | `getOwner` | `PermissionRulesParam` | no | — |
319
+ | `getRemoveStatus` | `PermissionRulesParam` | no | — |
320
+ | `getPlayerFriend` | `PermissionRulesParam` | no | — |
321
+ | `getPlayerGroup` | `PermissionRulesParam` | no | — |
322
+ | `getPlayerInventory` | `PermissionRulesParam` | no | — |
323
+ | `removePlayerItem` | `PermissionRulesParam` | no | — |
324
+ | `createPlayerItem` | `PermissionRulesParam` | no | — |
325
+ | `createGroup` | `PermissionRulesParam` | no | — |
326
+ | `joinGroup` | `PermissionRulesParam` | no | — |
327
+ | `leaveGroup` | `PermissionRulesParam` | no | — |
328
+ | `setOwner` | `PermissionRulesParam` | no | — |
329
+ | `addPlayerFriend` | `PermissionRulesParam` | no | — |
330
+ | `removePlayerFriend` | `PermissionRulesParam` | no | — |
331
+ | `getPlayersWithDisplayName` | `PermissionRulesParam` | no | — |
332
+ | `setRemoveStatus` | `PermissionRulesParam` | no | — |
333
+ | `getFriendStatisticsLeaderboardAroundPlayer` | `PermissionRulesParam` | no | — |
334
+ | `getFriendStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
335
+ | `getCurrencyLeaderboard` | `PermissionRulesParam` | no | — |
336
+ | `getCreateLeaderboard` | `PermissionRulesParam` | no | — |
337
+ | `getLastLoginLeaderboard` | `PermissionRulesParam` | no | — |
338
+ | `getStatisticsLog` | `PermissionRulesParam` | no | — |
339
+ | `getCurrencyLog` | `PermissionRulesParam` | no | — |
340
+
341
+ ### CharacterPlayerSettingsParam
342
+
343
+ Defines the reusable parameter block CharacterPlayerSettingsParam.
344
+
345
+ | Field | Type | Required | Notes |
346
+ |-------|------|----------|-------|
347
+ | `playerCurrenciesSettings` | `Array<CurrencySettingsParam>` | no | _elementCls=CurrencySettingsParam_ |
348
+ | `playerStatisticsSettings` | `Array<StatisticsSettingsParam>` | no | _elementCls=StatisticsSettingsParam_ |
349
+ | `playerDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
350
+ | `customDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
351
+ | `tagsSettings` | `Array<TagSettingsParam>` | no | _elementCls=TagSettingsParam_ |
352
+ | `playerGroupCatalogSettings` | `Array<GroupCatalogSettingsParam>` | no | _elementCls=GroupCatalogSettingsParam_ |
353
+ | `playerItemCatalogSettings` | `Array<ItemCatalogSettingsParam>` | no | _elementCls=ItemCatalogSettingsParam_ |
354
+ | `playerFriendCatalogSettings` | `Array<FriendCatalogSettingsParam>` | no | _elementCls=FriendCatalogSettingsParam_ |
355
+
356
+ ### ContentPermissionRulesParam
357
+
358
+ Defines the reusable parameter block ContentPermissionRulesParam.
359
+
360
+ | Field | Type | Required | Notes |
361
+ |-------|------|----------|-------|
362
+ | `getContentData` | `PermissionRulesParam` | no | — |
363
+ | `setContentData` | `PermissionRulesParam` | no | — |
364
+ | `createNewFileUploadInfo` | `PermissionRulesParam` | no | — |
365
+ | `getFileUploadInfoList` | `PermissionRulesParam` | no | — |
366
+ | `getFileUploadInfo` | `PermissionRulesParam` | no | — |
367
+ | `removeFileUploadInfo` | `PermissionRulesParam` | no | — |
368
+ | `requestDownloadFileUploadInfo` | `PermissionRulesParam` | no | — |
369
+
370
+ ### ThirtPartyAppleSettingsParam
371
+
372
+ Defines the reusable parameter block ThirtPartyAppleSettingsParam.
373
+
374
+ | Field | Type | Required | Notes |
375
+ |-------|------|----------|-------|
376
+ | `appleClientId` | `string` | yes | — |
377
+ | `sandboxEnable` | `boolean` | yes | — |
378
+ | `issuerId` | `string` | yes | — |
379
+ | `keyId` | `string` | yes | — |
380
+ | `p8Content` | `string` | yes | — |
381
+
382
+ ### ThirtPartyFacebookSettingsParam
383
+
384
+ Defines the reusable parameter block ThirtPartyFacebookSettingsParam.
385
+
386
+ | Field | Type | Required | Notes |
387
+ |-------|------|----------|-------|
388
+ | `facebookAppId` | `string` | yes | — |
389
+ | `facebookAppToken` | `string` | yes | — |
390
+ | `facebookInappSecret` | `string` | yes | — |
391
+
392
+ ### ThirtPartyGoogleSettingsParam
393
+
394
+ Defines the reusable parameter block ThirtPartyGoogleSettingsParam.
395
+
396
+ | Field | Type | Required | Notes |
397
+ |-------|------|----------|-------|
398
+ | `googleClientId` | `string` | yes | — |
399
+ | `packageId` | `string` | yes | — |
400
+ | `publicRSAKey` | `string` | yes | — |
401
+
402
+ ### ThirtPartyGameCenterSettingsParam
403
+
404
+ Defines the reusable parameter block ThirtPartyGameCenterSettingsParam.
405
+
406
+ | Field | Type | Required | Notes |
407
+ |-------|------|----------|-------|
408
+ | `packageId` | `string` | yes | — |
409
+
410
+ ### ThirtPartyGooglePlayGameSettingsParam
411
+
412
+ Defines the reusable parameter block ThirtPartyGooglePlayGameSettingsParam.
413
+
414
+ | Field | Type | Required | Notes |
415
+ |-------|------|----------|-------|
416
+ | `redirectUri` | `string` | yes | — |
417
+ | `clientId` | `string` | yes | — |
418
+ | `clientSecret` | `string` | yes | — |
419
+ | `applicationId` | `string` | yes | — |
420
+
421
+ ### ThirtPartyParam
422
+
423
+ Defines the reusable parameter block ThirtPartyParam.
424
+
425
+ | Field | Type | Required | Notes |
426
+ |-------|------|----------|-------|
427
+ | `googleSettings` | `ThirtPartyGoogleSettingsParam` | no | — |
428
+ | `facebookSettings` | `ThirtPartyFacebookSettingsParam` | no | — |
429
+ | `appleSettings` | `ThirtPartyAppleSettingsParam` | no | — |
430
+ | `googlePlayGameSettings` | `ThirtPartyGooglePlayGameSettingsParam` | no | — |
431
+ | `gameCenterSettings` | `ThirtPartyGameCenterSettingsParam` | no | — |
432
+
433
+ ### EmailSettingsParam
434
+
435
+ Defines the reusable parameter block EmailSettingsParam.
436
+
437
+ | Field | Type | Required | Notes |
438
+ |-------|------|----------|-------|
439
+ | `sendFrom` | `string` | yes | — |
440
+ | `secure` | `boolean` | yes | — |
441
+ | `host` | `string` | yes | — |
442
+ | `port` | `number` | yes | — |
443
+ | `username` | `string` | yes | — |
444
+ | `password` | `string` | yes | — |
445
+
446
+ ### PushNotificationSettingsParam
447
+
448
+ Defines the reusable parameter block PushNotificationSettingsParam.
449
+
450
+ | Field | Type | Required | Notes |
451
+ |-------|------|----------|-------|
452
+ | `projectId` | `string` | yes | — |
453
+ | `clientEmail` | `string` | yes | — |
454
+ | `privateKey` | `string` | yes | — |
455
+
456
+ ### GamePlayerPermissionRulesParam
457
+
458
+ Defines the reusable parameter block GamePlayerPermissionRulesParam.
459
+
460
+ | Field | Type | Required | Notes |
461
+ |-------|------|----------|-------|
462
+ | `addSegment` | `PermissionRulesParam` | no | — |
463
+ | `removeSegment` | `PermissionRulesParam` | no | — |
464
+ | `getSegment` | `PermissionRulesParam` | no | — |
465
+ | `setTag` | `PermissionRulesParam` | no | — |
466
+ | `removeTag` | `PermissionRulesParam` | no | — |
467
+ | `getTag` | `PermissionRulesParam` | no | — |
468
+ | `getDisplayName` | `PermissionRulesParam` | no | — |
469
+ | `setDisplayName` | `PermissionRulesParam` | no | — |
470
+ | `getTsCreate` | `PermissionRulesParam` | no | — |
471
+ | `getIpAddressCreate` | `PermissionRulesParam` | no | — |
472
+ | `getTsLastLogin` | `PermissionRulesParam` | no | — |
473
+ | `setPlayerBan` | `PermissionRulesParam` | no | — |
474
+ | `getPlayerBan` | `PermissionRulesParam` | no | — |
475
+ | `setCountryCode` | `PermissionRulesParam` | no | — |
476
+ | `getCountryCode` | `PermissionRulesParam` | no | — |
477
+ | `setAvatar` | `PermissionRulesParam` | no | — |
478
+ | `getAvatar` | `PermissionRulesParam` | no | — |
479
+ | `changePlayerCurrency` | `PermissionRulesParam` | no | — |
480
+ | `getPlayerCurrency` | `PermissionRulesParam` | no | — |
481
+ | `changePlayerStatistics` | `PermissionRulesParam` | no | — |
482
+ | `getPlayerStatistics` | `PermissionRulesParam` | no | — |
483
+ | `getStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
484
+ | `getStatisticsLeaderboardAroundPlayer` | `PermissionRulesParam` | no | — |
485
+ | `getCustomData` | `PermissionRulesParam` | no | — |
486
+ | `setCustomData` | `PermissionRulesParam` | no | — |
487
+ | `setPlayerData` | `PermissionRulesParam` | no | — |
488
+ | `getPlayerData` | `PermissionRulesParam` | no | — |
489
+ | `getPlayerInformation` | `PermissionRulesParam` | no | — |
490
+ | `getPlayersWithSegment` | `PermissionRulesParam` | no | — |
491
+ | `getPlayersWithTag` | `PermissionRulesParam` | no | — |
492
+ | `getPlayerCharacter` | `PermissionRulesParam` | no | — |
493
+ | `getPlayerInventory` | `PermissionRulesParam` | no | — |
494
+ | `getPlayerGroup` | `PermissionRulesParam` | no | — |
495
+ | `getPlayerFriend` | `PermissionRulesParam` | no | — |
496
+ | `removePlayerItem` | `PermissionRulesParam` | no | — |
497
+ | `getOnlineStatus` | `PermissionRulesParam` | no | — |
498
+ | `createGroup` | `PermissionRulesParam` | no | — |
499
+ | `createPlayerItem` | `PermissionRulesParam` | no | — |
500
+ | `createPlayerCharacter` | `PermissionRulesParam` | no | — |
501
+ | `addPlayerFriend` | `PermissionRulesParam` | no | — |
502
+ | `removePlayerFriend` | `PermissionRulesParam` | no | — |
503
+ | `removePlayerCharacter` | `PermissionRulesParam` | no | — |
504
+ | `joinGroup` | `PermissionRulesParam` | no | — |
505
+ | `leaveGroup` | `PermissionRulesParam` | no | — |
506
+ | `getPlayersWithDisplayName` | `PermissionRulesParam` | no | — |
507
+ | `getFriendStatisticsLeaderboardAroundPlayer` | `PermissionRulesParam` | no | — |
508
+ | `getFriendStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
509
+ | `getCurrencyLeaderboard` | `PermissionRulesParam` | no | — |
510
+ | `getCreateLeaderboard` | `PermissionRulesParam` | no | — |
511
+ | `getLastLoginLeaderboard` | `PermissionRulesParam` | no | — |
512
+ | `getStatisticsLog` | `PermissionRulesParam` | no | — |
513
+ | `getCurrencyLog` | `PermissionRulesParam` | no | — |
514
+
515
+ ### GamePlayerSettingsParam
516
+
517
+ Defines the reusable parameter block GamePlayerSettingsParam.
518
+
519
+ | Field | Type | Required | Notes |
520
+ |-------|------|----------|-------|
521
+ | `playerCurrenciesSettings` | `Array<CurrencySettingsParam>` | no | _elementCls=CurrencySettingsParam_ |
522
+ | `playerStatisticsSettings` | `Array<StatisticsSettingsParam>` | no | _elementCls=StatisticsSettingsParam_ |
523
+ | `playerDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
524
+ | `customDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
525
+ | `tagsSettings` | `Array<TagSettingsParam>` | no | _elementCls=TagSettingsParam_ |
526
+ | `playerCharacterCatalogSettings` | `Array<CharacterCatalogSettingsParam>` | no | _elementCls=CharacterCatalogSettingsParam_ |
527
+ | `playerGroupCatalogSettings` | `Array<GroupCatalogSettingsParam>` | no | _elementCls=GroupCatalogSettingsParam_ |
528
+ | `playerItemCatalogSettings` | `Array<ItemCatalogSettingsParam>` | no | _elementCls=ItemCatalogSettingsParam_ |
529
+ | `playerFriendCatalogSettings` | `Array<FriendCatalogSettingsParam>` | no | _elementCls=FriendCatalogSettingsParam_ |
530
+
531
+ ### GroupSettingsParam
532
+
533
+ Defines the reusable parameter block GroupSettingsParam.
534
+
535
+ | Field | Type | Required | Notes |
536
+ |-------|------|----------|-------|
537
+ | `groupCurrenciesSettings` | `Array<CurrencySettingsParam>` | no | _elementCls=CurrencySettingsParam_ |
538
+ | `groupStatisticsSettings` | `Array<StatisticsSettingsParam>` | no | _elementCls=StatisticsSettingsParam_ |
539
+ | `groupDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
540
+ | `customDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
541
+ | `tagsSettings` | `Array<TagSettingsParam>` | no | _elementCls=TagSettingsParam_ |
542
+ | `groupItemCatalogSettings` | `Array<ItemCatalogSettingsParam>` | no | _elementCls=ItemCatalogSettingsParam_ |
543
+
544
+ ### InventorySettingsParam
545
+
546
+ Defines the reusable parameter block InventorySettingsParam.
547
+
548
+ | Field | Type | Required | Notes |
549
+ |-------|------|----------|-------|
550
+ | `itemStatisticsSettings` | `Array<StatisticsSettingsParam>` | no | _elementCls=StatisticsSettingsParam_ |
551
+ | `itemDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
552
+ | `customDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
553
+ | `tagsSettings` | `Array<TagSettingsParam>` | no | _elementCls=TagSettingsParam_ |
554
+
555
+ ### GameSettingsParam
556
+
557
+ Defines the reusable parameter block GameSettingsParam.
558
+
559
+ | Field | Type | Required | Notes |
560
+ |-------|------|----------|-------|
561
+ | `gamePlayerSettings` | `GamePlayerSettingsParam` | no | — |
562
+ | `characterPlayerSettings` | `CharacterPlayerSettingsParam` | no | — |
563
+ | `groupSettings` | `GroupSettingsParam` | no | — |
564
+ | `inventorySettings` | `InventorySettingsParam` | no | — |
565
+
566
+ ### GenericServiceSettingsParam
567
+
568
+ Defines the reusable parameter block GenericServiceSettingsParam.
569
+
570
+ | Field | Type | Required | Notes |
571
+ |-------|------|----------|-------|
572
+ | `serviceName` | `string` | yes | _minLength=2, maxLength=32_ |
573
+
574
+ ### GroupPermissionRulesParam
575
+
576
+ Defines the reusable parameter block GroupPermissionRulesParam.
577
+
578
+ | Field | Type | Required | Notes |
579
+ |-------|------|----------|-------|
580
+ | `addSegment` | `PermissionRulesParam` | no | — |
581
+ | `removeSegment` | `PermissionRulesParam` | no | — |
582
+ | `getSegment` | `PermissionRulesParam` | no | — |
583
+ | `setTag` | `PermissionRulesParam` | no | — |
584
+ | `removeTag` | `PermissionRulesParam` | no | — |
585
+ | `getTag` | `PermissionRulesParam` | no | — |
586
+ | `getDisplayName` | `PermissionRulesParam` | no | — |
587
+ | `setDisplayName` | `PermissionRulesParam` | no | — |
588
+ | `getTsCreate` | `PermissionRulesParam` | no | — |
589
+ | `setAvatar` | `PermissionRulesParam` | no | — |
590
+ | `getAvatar` | `PermissionRulesParam` | no | — |
591
+ | `changeGroupCurrency` | `PermissionRulesParam` | no | — |
592
+ | `getGroupCurrency` | `PermissionRulesParam` | no | — |
593
+ | `changeGroupStatistics` | `PermissionRulesParam` | no | — |
594
+ | `getGroupStatistics` | `PermissionRulesParam` | no | — |
595
+ | `getStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
596
+ | `getStatisticsLeaderboardAroundGroup` | `PermissionRulesParam` | no | — |
597
+ | `getCustomData` | `PermissionRulesParam` | no | — |
598
+ | `setCustomData` | `PermissionRulesParam` | no | — |
599
+ | `setGroupData` | `PermissionRulesParam` | no | — |
600
+ | `getGroupData` | `PermissionRulesParam` | no | — |
601
+ | `getGroupInformation` | `PermissionRulesParam` | no | — |
602
+ | `getGroupsWithSegment` | `PermissionRulesParam` | no | — |
603
+ | `getGroupsWithTag` | `PermissionRulesParam` | no | — |
604
+ | `getCatalogId` | `PermissionRulesParam` | no | — |
605
+ | `getRemoveStatus` | `PermissionRulesParam` | no | — |
606
+ | `getGroupInventory` | `PermissionRulesParam` | no | — |
607
+ | `removeGroupItem` | `PermissionRulesParam` | no | — |
608
+ | `createGroupItem` | `PermissionRulesParam` | no | — |
609
+ | `getMembers` | `PermissionRulesParam` | no | — |
610
+ | `addMember` | `PermissionRulesParam` | no | — |
611
+ | `removeMember` | `PermissionRulesParam` | no | — |
612
+ | `sendGroupMessage` | `PermissionRulesParam` | no | — |
613
+ | `getGroupMessage` | `PermissionRulesParam` | no | — |
614
+ | `setRemoveStatus` | `PermissionRulesParam` | no | — |
615
+ | `getGroupsWithDisplayName` | `PermissionRulesParam` | no | — |
616
+ | `getCurrencyLeaderboard` | `PermissionRulesParam` | no | — |
617
+ | `getCreateLeaderboard` | `PermissionRulesParam` | no | — |
618
+ | `getStatisticsLog` | `PermissionRulesParam` | no | — |
619
+ | `getCurrencyLog` | `PermissionRulesParam` | no | — |
620
+
621
+ ### InventoryPermissionRulesParam
622
+
623
+ Defines the reusable parameter block InventoryPermissionRulesParam.
624
+
625
+ | Field | Type | Required | Notes |
626
+ |-------|------|----------|-------|
627
+ | `addSegment` | `PermissionRulesParam` | no | — |
628
+ | `removeSegment` | `PermissionRulesParam` | no | — |
629
+ | `getSegment` | `PermissionRulesParam` | no | — |
630
+ | `setTag` | `PermissionRulesParam` | no | — |
631
+ | `removeTag` | `PermissionRulesParam` | no | — |
632
+ | `getTag` | `PermissionRulesParam` | no | — |
633
+ | `getDisplayName` | `PermissionRulesParam` | no | — |
634
+ | `setDisplayName` | `PermissionRulesParam` | no | — |
635
+ | `getTsCreate` | `PermissionRulesParam` | no | — |
636
+ | `setAvatar` | `PermissionRulesParam` | no | — |
637
+ | `getAvatar` | `PermissionRulesParam` | no | — |
638
+ | `changeItemStatistics` | `PermissionRulesParam` | no | — |
639
+ | `getItemStatistics` | `PermissionRulesParam` | no | — |
640
+ | `getStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
641
+ | `getStatisticsLeaderboardAroundItem` | `PermissionRulesParam` | no | — |
642
+ | `getCustomData` | `PermissionRulesParam` | no | — |
643
+ | `setCustomData` | `PermissionRulesParam` | no | — |
644
+ | `setItemData` | `PermissionRulesParam` | no | — |
645
+ | `getItemData` | `PermissionRulesParam` | no | — |
646
+ | `getItemInformation` | `PermissionRulesParam` | no | — |
647
+ | `getItemsWithSegment` | `PermissionRulesParam` | no | — |
648
+ | `getItemsWithTag` | `PermissionRulesParam` | no | — |
649
+ | `getCatalogId` | `PermissionRulesParam` | no | — |
650
+ | `getClassId` | `PermissionRulesParam` | no | — |
651
+ | `getItemType` | `PermissionRulesParam` | no | — |
652
+ | `getAmount` | `PermissionRulesParam` | no | — |
653
+ | `getOwner` | `PermissionRulesParam` | no | — |
654
+ | `getRemoveStatus` | `PermissionRulesParam` | no | — |
655
+ | `setAmount` | `PermissionRulesParam` | no | — |
656
+ | `setOwner` | `PermissionRulesParam` | no | — |
657
+ | `setRemoveStatus` | `PermissionRulesParam` | no | — |
658
+ | `getItemsWithDisplayName` | `PermissionRulesParam` | no | — |
659
+ | `getCreateLeaderboard` | `PermissionRulesParam` | no | — |
660
+ | `getStatisticsLog` | `PermissionRulesParam` | no | — |
661
+
662
+ ### DashboardPermissionRulesParam
663
+
664
+ Defines the reusable parameter block DashboardPermissionRulesParam.
665
+
666
+ | Field | Type | Required | Notes |
667
+ |-------|------|----------|-------|
668
+ | `setMasterGameSettings` | `PermissionRulesParam` | no | — |
669
+ | `createAdminAccount` | `PermissionRulesParam` | no | — |
670
+ | `removeAdminAccount` | `PermissionRulesParam` | no | — |
671
+ | `setPasswordAdminAccount` | `PermissionRulesParam` | no | — |
672
+ | `setSecretKeyAdminAccount` | `PermissionRulesParam` | no | — |
673
+ | `setGameInformation` | `PermissionRulesParam` | no | — |
674
+ | `createGame` | `PermissionRulesParam` | no | — |
675
+ | `changePasswordAdminAccount` | `PermissionRulesParam` | no | — |
676
+ | `getAdminAccountList` | `PermissionRulesParam` | no | — |
677
+ | `getGameInformation` | `PermissionRulesParam` | no | — |
678
+ | `getGameList` | `PermissionRulesParam` | no | — |
679
+ | `getMasterGameSettings` | `PermissionRulesParam` | no | — |
680
+ | `getServerLog` | `PermissionRulesParam` | no | — |
681
+ | `getSecretInfoInformation` | `PermissionRulesParam` | no | — |
682
+ | `getSecretInfoList` | `PermissionRulesParam` | no | — |
683
+ | `createSecretInfo` | `PermissionRulesParam` | no | — |
684
+ | `setSecretInfoInformation` | `PermissionRulesParam` | no | — |
685
+ | `getUsernameAdminAccount` | `PermissionRulesParam` | no | — |
686
+ | `getAnalytics` | `PermissionRulesParam` | no | — |
687
+ | `getEventCallbackCloudScript` | `PermissionRulesParam` | no | — |
688
+ | `setEventCallbackCloudScript` | `PermissionRulesParam` | no | — |
689
+ | `resetStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
690
+ | `getBackupStatisticsLeaderboardVersion` | `PermissionRulesParam` | no | — |
691
+ | `getServerGameData` | `PermissionRulesParam` | no | — |
692
+ | `deleteInDatabase` | `PermissionRulesParam` | no | — |
693
+
694
+ ### MultiplayerPermissionRulesParam
695
+
696
+ Defines the reusable parameter block MultiplayerPermissionRulesParam.
697
+
698
+ | Field | Type | Required | Notes |
699
+ |-------|------|----------|-------|
700
+ | `cancelAllMatchmakingTicket` | `PermissionRulesParam` | no | — |
701
+ | `cancelMatchmakingTicket` | `PermissionRulesParam` | no | — |
702
+ | `createMatchmakingTicket` | `PermissionRulesParam` | no | — |
703
+ | `getMatchmakingTicket` | `PermissionRulesParam` | no | — |
704
+ | `getMatch` | `PermissionRulesParam` | no | — |
705
+ | `getQueueStatistics` | `PermissionRulesParam` | no | — |
706
+ | `joinMatchmakingTicket` | `PermissionRulesParam` | no | — |
707
+ | `listMatchmakingTicketsForPlayer` | `PermissionRulesParam` | no | — |
708
+ | `getAllMatchmakingTicket` | `PermissionRulesParam` | no | — |
709
+ | `getAllMatch` | `PermissionRulesParam` | no | — |
710
+
711
+ ### MasterPlayerPermissionRulesParam
712
+
713
+ Defines the reusable parameter block MasterPlayerPermissionRulesParam.
714
+
715
+ | Field | Type | Required | Notes |
716
+ |-------|------|----------|-------|
717
+ | `linkAccount` | `PermissionRulesParam` | no | — |
718
+ | `linkAndroidDeviceId` | `PermissionRulesParam` | no | — |
719
+ | `linkApple` | `PermissionRulesParam` | no | — |
720
+ | `linkCustomDeviceId` | `PermissionRulesParam` | no | — |
721
+ | `linkCustomId` | `PermissionRulesParam` | no | — |
722
+ | `linkEditorDeviceId` | `PermissionRulesParam` | no | — |
723
+ | `linkFacebook` | `PermissionRulesParam` | no | — |
724
+ | `linkGenericService` | `PermissionRulesParam` | no | — |
725
+ | `linkGoogle` | `PermissionRulesParam` | no | — |
726
+ | `linkGooglePlayGameService` | `PermissionRulesParam` | no | — |
727
+ | `linkGameCenter` | `PermissionRulesParam` | no | — |
728
+ | `linkiOSDeviceId` | `PermissionRulesParam` | no | — |
729
+ | `linkLinuxDeviceId` | `PermissionRulesParam` | no | — |
730
+ | `linkMacOSDeviceId` | `PermissionRulesParam` | no | — |
731
+ | `linkWindowsDeviceId` | `PermissionRulesParam` | no | — |
732
+ | `linkWindowsPhoneDeviceId` | `PermissionRulesParam` | no | — |
733
+ | `unlinkAccount` | `PermissionRulesParam` | no | — |
734
+ | `unlinkAndroidDeviceId` | `PermissionRulesParam` | no | — |
735
+ | `unlinkApple` | `PermissionRulesParam` | no | — |
736
+ | `unlinkCustomDeviceId` | `PermissionRulesParam` | no | — |
737
+ | `unlinkCustomId` | `PermissionRulesParam` | no | — |
738
+ | `unlinkEditorDeviceId` | `PermissionRulesParam` | no | — |
739
+ | `unlinkFacebook` | `PermissionRulesParam` | no | — |
740
+ | `unlinkGenericService` | `PermissionRulesParam` | no | — |
741
+ | `unlinkGoogle` | `PermissionRulesParam` | no | — |
742
+ | `unlinkGooglePlayGameService` | `PermissionRulesParam` | no | — |
743
+ | `unlinkGameCenter` | `PermissionRulesParam` | no | — |
744
+ | `unlinkiOSDeviceId` | `PermissionRulesParam` | no | — |
745
+ | `unlinkLinuxDeviceId` | `PermissionRulesParam` | no | — |
746
+ | `unlinkMacOSDeviceId` | `PermissionRulesParam` | no | — |
747
+ | `unlinkWindowsDeviceId` | `PermissionRulesParam` | no | — |
748
+ | `unlinkWindowsPhoneDeviceId` | `PermissionRulesParam` | no | — |
749
+ | `addSegment` | `PermissionRulesParam` | no | — |
750
+ | `removeSegment` | `PermissionRulesParam` | no | — |
751
+ | `getSegment` | `PermissionRulesParam` | no | — |
752
+ | `setTag` | `PermissionRulesParam` | no | — |
753
+ | `removeTag` | `PermissionRulesParam` | no | — |
754
+ | `getTag` | `PermissionRulesParam` | no | — |
755
+ | `getDisplayName` | `PermissionRulesParam` | no | — |
756
+ | `setDisplayName` | `PermissionRulesParam` | no | — |
757
+ | `getTsCreate` | `PermissionRulesParam` | no | — |
758
+ | `getIpAddressCreate` | `PermissionRulesParam` | no | — |
759
+ | `updateTsLastLogin` | `PermissionRulesParam` | no | — |
760
+ | `getTsLastLogin` | `PermissionRulesParam` | no | — |
761
+ | `setPlayerBan` | `PermissionRulesParam` | no | — |
762
+ | `getPlayerBan` | `PermissionRulesParam` | no | — |
763
+ | `setCountryCode` | `PermissionRulesParam` | no | — |
764
+ | `getCountryCode` | `PermissionRulesParam` | no | — |
765
+ | `changeAccountPassword` | `PermissionRulesParam` | no | — |
766
+ | `resetAccountPassword` | `PermissionRulesParam` | no | — |
767
+ | `setAvatar` | `PermissionRulesParam` | no | — |
768
+ | `getAvatar` | `PermissionRulesParam` | no | — |
769
+ | `changePlayerCurrency` | `PermissionRulesParam` | no | — |
770
+ | `getPlayerCurrency` | `PermissionRulesParam` | no | — |
771
+ | `changePlayerStatistics` | `PermissionRulesParam` | no | — |
772
+ | `getPlayerStatistics` | `PermissionRulesParam` | no | — |
773
+ | `getStatisticsLeaderboard` | `PermissionRulesParam` | no | — |
774
+ | `getStatisticsLeaderboardAroundPlayer` | `PermissionRulesParam` | no | — |
775
+ | `getCustomData` | `PermissionRulesParam` | no | — |
776
+ | `setCustomData` | `PermissionRulesParam` | no | — |
777
+ | `setPlayerData` | `PermissionRulesParam` | no | — |
778
+ | `getPlayerData` | `PermissionRulesParam` | no | — |
779
+ | `getPlayerInformation` | `PermissionRulesParam` | no | — |
780
+ | `getPlayersWithApple` | `PermissionRulesParam` | no | — |
781
+ | `getPlayersWithFacebook` | `PermissionRulesParam` | no | — |
782
+ | `getPlayersWithGoogle` | `PermissionRulesParam` | no | — |
783
+ | `getPlayersWithGenericService` | `PermissionRulesParam` | no | — |
784
+ | `getPlayersWithSegment` | `PermissionRulesParam` | no | — |
785
+ | `getPlayersWithTag` | `PermissionRulesParam` | no | — |
786
+ | `getPlayersWithGooglePlayGameService` | `PermissionRulesParam` | no | — |
787
+ | `getPlayersWithGameCenter` | `PermissionRulesParam` | no | — |
788
+ | `getExternal` | `PermissionRulesParam` | no | — |
789
+ | `getPlayersWithDisplayName` | `PermissionRulesParam` | no | — |
790
+ | `getEmail` | `PermissionRulesParam` | no | — |
791
+ | `setEmail` | `PermissionRulesParam` | no | — |
792
+ | `getCurrencyLeaderboard` | `PermissionRulesParam` | no | — |
793
+ | `getLastLoginLeaderboard` | `PermissionRulesParam` | no | — |
794
+ | `getCreateLeaderboard` | `PermissionRulesParam` | no | — |
795
+ | `getStatisticsLog` | `PermissionRulesParam` | no | — |
796
+ | `getCurrencyLog` | `PermissionRulesParam` | no | — |
797
+ | `sendSocketOperationEvent` | `PermissionRulesParam` | no | — |
798
+ | `sendEmail` | `PermissionRulesParam` | no | — |
799
+ | `sendPushNotification` | `PermissionRulesParam` | no | — |
800
+ | `addPushNotification` | `PermissionRulesParam` | no | — |
801
+ | `removePushNotification` | `PermissionRulesParam` | no | — |
802
+ | `getPushNotification` | `PermissionRulesParam` | no | — |
803
+
804
+ ### MasterPlayerSettingsParam
805
+
806
+ Defines the reusable parameter block MasterPlayerSettingsParam.
807
+
808
+ | Field | Type | Required | Notes |
809
+ |-------|------|----------|-------|
810
+ | `genericServiceSettings` | `Array<GenericServiceSettingsParam>` | no | _elementCls=GenericServiceSettingsParam_ |
811
+ | `playerCurrenciesSettings` | `Array<CurrencySettingsParam>` | no | _elementCls=CurrencySettingsParam_ |
812
+ | `playerStatisticsSettings` | `Array<StatisticsSettingsParam>` | no | _elementCls=StatisticsSettingsParam_ |
813
+ | `playerDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
814
+ | `customDatasSettings` | `Array<DataSettingsParam>` | no | _elementCls=DataSettingsParam_ |
815
+ | `tagsSettings` | `Array<TagSettingsParam>` | no | _elementCls=TagSettingsParam_ |
816
+
817
+ ### SizeParam
818
+
819
+ Defines the reusable parameter block SizeParam.
820
+
821
+ | Field | Type | Required | Notes |
822
+ |-------|------|----------|-------|
823
+ | `min` | `number` | yes | _min=1_ |
824
+ | `max` | `number` | yes | _min=1_ |
825
+
826
+ ### TeamParam
827
+
828
+ Defines the reusable parameter block TeamParam.
829
+
830
+ | Field | Type | Required | Notes |
831
+ |-------|------|----------|-------|
832
+ | `teamId` | `string` | yes | _minLength=1, maxLength=32_ |
833
+ | `teamSize` | `SizeParam` | yes | — |
834
+
835
+ ### LinearExpansionsParam
836
+
837
+ Defines the reusable parameter block LinearExpansionsParam.
838
+
839
+ | Field | Type | Required | Notes |
840
+ |-------|------|----------|-------|
841
+ | `secondsBetweenExpansions` | `number` | yes | _min=1_ |
842
+ | `delta` | `number` | no | — |
843
+ | `limit` | `number` | no | — |
844
+
845
+ ### CustomExpansionsParam
846
+
847
+ Defines the reusable parameter block CustomExpansionsParam.
848
+
849
+ | Field | Type | Required | Notes |
850
+ |-------|------|----------|-------|
851
+ | `secondsBetweenExpansions` | `number` | yes | _min=1_ |
852
+ | `overrideValue` | `Array<any>` | no | _elementCls=Object_ |
853
+ | `overrideMin` | `Array<any>` | no | _elementCls=Object_ |
854
+ | `overrideMax` | `Array<any>` | no | _elementCls=Object_ |
855
+
856
+ ### AdvancedSettingsParam
857
+
858
+ Defines the reusable parameter block AdvancedSettingsParam.
859
+
860
+ | Field | Type | Required | Notes |
861
+ |-------|------|----------|-------|
862
+ | `secondsUntilOptional` | `number` | yes | _min=1_ |
863
+ | `expansionType` | `number` | no | _min=1, max=3_ |
864
+ | `linearExpansions` | `LinearExpansionsParam` | no | — |
865
+ | `customExpansions` | `CustomExpansionsParam` | no | — |
866
+
867
+ ### RuleParam
868
+
869
+ Defines the reusable parameter block RuleParam.
870
+
871
+ | Field | Type | Required | Notes |
872
+ |-------|------|----------|-------|
873
+ | `name` | `string` | yes | _minLength=1, maxLength=32_ |
874
+ | `type` | `number` | yes | _min=1, max=8_ |
875
+ | `attributeSource` | `number` | no | _min=1, max=2_ |
876
+ | `attributePath` | `string` | no | _minLength=1, maxLength=32_ |
877
+ | `defaultValue` | `any` | no | — |
878
+ | `compairType` | `number` | no | _min=1, max=2_ |
879
+ | `allowedDifference` | `number` | no | _min=0_ |
880
+ | `min` | `number` | no | — |
881
+ | `max` | `number` | no | — |
882
+ | `advancedSettings` | `AdvancedSettingsParam` | no | — |
883
+
884
+ ### ServerAllocationParam
885
+
886
+ Defines the reusable parameter block ServerAllocationParam.
887
+
888
+ | Field | Type | Required | Notes |
889
+ |-------|------|----------|-------|
890
+ | `enable` | `boolean` | yes | — |
891
+
892
+ ### MatchmakingQueueSettingsParam
893
+
894
+ Defines the reusable parameter block MatchmakingQueueSettingsParam.
895
+
896
+ | Field | Type | Required | Notes |
897
+ |-------|------|----------|-------|
898
+ | `queueName` | `string` | yes | _minLength=6, maxLength=32_ |
899
+ | `matchSize` | `SizeParam` | yes | — |
900
+ | `ticketSize` | `SizeParam` | yes | — |
901
+ | `serverAllocation` | `ServerAllocationParam` | yes | — |
902
+ | `teams` | `Array<TeamParam>` | no | _elementCls=TeamParam_ |
903
+ | `rules` | `Array<RuleParam>` | no | _elementCls=RuleParam_ |
904
+ | `remove` | `boolean` | no | — |
905
+
906
+ ### AuthenticatePermissionRulesParam
907
+
908
+ Defines the reusable parameter block AuthenticatePermissionRulesParam.
909
+
910
+ | Field | Type | Required | Notes |
911
+ |-------|------|----------|-------|
912
+ | `loginByAccount` | `PermissionRulesParam` | no | — |
913
+ | `loginByAndroidDeviceId` | `PermissionRulesParam` | no | — |
914
+ | `loginByApple` | `PermissionRulesParam` | no | — |
915
+ | `loginByCustomDeviceId` | `PermissionRulesParam` | no | — |
916
+ | `loginByCustomId` | `PermissionRulesParam` | no | — |
917
+ | `loginByFacebook` | `PermissionRulesParam` | no | — |
918
+ | `loginByGenericService` | `PermissionRulesParam` | no | — |
919
+ | `loginByGoogle` | `PermissionRulesParam` | no | — |
920
+ | `loginByGooglePlayGameService` | `PermissionRulesParam` | no | — |
921
+ | `loginByGameCenter` | `PermissionRulesParam` | no | — |
922
+ | `loginByiOSDeviceId` | `PermissionRulesParam` | no | — |
923
+ | `loginByWindowsPhoneDeviceId` | `PermissionRulesParam` | no | — |
924
+ | `registerAccount` | `PermissionRulesParam` | no | — |
925
+ | `loginByEditorDeviceId` | `PermissionRulesParam` | no | — |
926
+ | `loginByLinuxDeviceId` | `PermissionRulesParam` | no | — |
927
+ | `loginByMacOSDeviceId` | `PermissionRulesParam` | no | — |
928
+ | `loginByWindowsDeviceId` | `PermissionRulesParam` | no | — |
929
+ | `refreshAuthToken` | `PermissionRulesParam` | no | — |
930
+
931
+ ### StoreInventoryPermissionRulesParam
932
+
933
+ Defines the reusable parameter block StoreInventoryPermissionRulesParam.
934
+
935
+ | Field | Type | Required | Notes |
936
+ |-------|------|----------|-------|
937
+ | `buyStoreItem` | `PermissionRulesParam` | no | — |
938
+ | `getStoreItemInformation` | `PermissionRulesParam` | no | — |
939
+ | `getStoreItemsWithTag` | `PermissionRulesParam` | no | — |
940
+ | `createStoreItem` | `PermissionRulesParam` | no | — |
941
+ | `setRemoveStatus` | `PermissionRulesParam` | no | — |
942
+ | `setStoreItemInformation` | `PermissionRulesParam` | no | — |
943
+ | `validateAppleAppStoreReceipt` | `PermissionRulesParam` | no | — |
944
+ | `validateGooglePlayStoreReceipt` | `PermissionRulesParam` | no | — |
945
+ | `validateFacebookStoreReceipt` | `PermissionRulesParam` | no | — |
946
+ | `getCreateLeaderboard` | `PermissionRulesParam` | no | — |
947
+ | `presentStoreItem` | `PermissionRulesParam` | no | — |
948
+ | `getStoreLog` | `PermissionRulesParam` | no | — |
949
+ | `getStoreUsed` | `PermissionRulesParam` | no | — |
950
+ | `removeStoreUsed` | `PermissionRulesParam` | no | — |
951
+
952
+ ### CloudScriptPermissionRulesParam
953
+
954
+ Defines the reusable parameter block CloudScriptPermissionRulesParam.
955
+
956
+ | Field | Type | Required | Notes |
957
+ |-------|------|----------|-------|
958
+ | `executeFunction` | `PermissionRulesParam` | no | — |
959
+ | `addFunction` | `PermissionRulesParam` | no | — |
960
+ | `getFunctions` | `PermissionRulesParam` | no | — |
961
+ | `getFunction` | `PermissionRulesParam` | no | — |
962
+ | `editFunction` | `PermissionRulesParam` | no | — |
963
+
964
+ ### PermissionParam
965
+
966
+ Defines the top-level permission tree assigned to one secret info entry. Each optional property groups `permission rules` by API domain.
967
+
968
+ | Field | Type | Required | Notes |
969
+ |-------|------|----------|-------|
970
+ | `authenticate` | `AuthenticatePermissionRulesParam` | no | — |
971
+ | `masterPlayer` | `MasterPlayerPermissionRulesParam` | no | — |
972
+ | `gamePlayer` | `GamePlayerPermissionRulesParam` | no | — |
973
+ | `characterPlayer` | `CharacterPlayerPermissionRulesParam` | no | — |
974
+ | `content` | `ContentPermissionRulesParam` | no | — |
975
+ | `group` | `GroupPermissionRulesParam` | no | — |
976
+ | `inventory` | `InventoryPermissionRulesParam` | no | — |
977
+ | `storeInventory` | `StoreInventoryPermissionRulesParam` | no | — |
978
+ | `dashboard` | `DashboardPermissionRulesParam` | no | — |
979
+ | `multiplayer` | `MultiplayerPermissionRulesParam` | no | — |
980
+ | `cloudScript` | `CloudScriptPermissionRulesParam` | no | — |
981
+
982
+ ### ChangePasswordAdminAccountRequestData
983
+
984
+ Defines the request payload for ChangePasswordAdminAccount.
985
+
986
+ | Field | Type | Required | Notes |
987
+ |-------|------|----------|-------|
988
+ | `currentPassword` | `string` | yes | _minLength=6, maxLength=64_ |
989
+ | `password` | `string` | yes | _minLength=6, maxLength=64_ |
990
+
991
+ ### GetAdminAccountListRequestData
992
+
993
+ Defines the request payload for GetAdminAccountList.
994
+
995
+ _Không có field public (payload rỗng)._
996
+
997
+ ### GetGameInformationRequestData
998
+
999
+ Defines the request payload for GetGameInformation.
1000
+
1001
+ | Field | Type | Required | Notes |
1002
+ |-------|------|----------|-------|
1003
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1004
+
1005
+ ### GetGameListRequestData
1006
+
1007
+ Defines the request payload for GetGameList.
1008
+
1009
+ _Không có field public (payload rỗng)._
1010
+
1011
+ ### GetMasterGameSettingsRequestData
1012
+
1013
+ Defines the request payload for GetMasterGameSettings.
1014
+
1015
+ _Không có field public (payload rỗng)._
1016
+
1017
+ ### GetSecretInfoInformationRequestData
1018
+
1019
+ Defines the request payload for GetSecretInfoInformation.
1020
+
1021
+ | Field | Type | Required | Notes |
1022
+ |-------|------|----------|-------|
1023
+ | `secretKey` | `string` | yes | _minLength=6, maxLength=64_ |
1024
+
1025
+ ### GetSecretInfoListRequestData
1026
+
1027
+ Defines the request payload for GetSecretInfoList.
1028
+
1029
+ _Không có field public (payload rỗng)._
1030
+
1031
+ ### GetServerLogRequestData
1032
+
1033
+ Defines the request payload for GetServerLog.
1034
+
1035
+ _Không có field public (payload rỗng)._
1036
+
1037
+ ### CreateAdminAccountRequestData
1038
+
1039
+ Defines the request payload for CreateAdminAccount.
1040
+
1041
+ | Field | Type | Required | Notes |
1042
+ |-------|------|----------|-------|
1043
+ | `username` | `string` | yes | _minLength=6, maxLength=32_ |
1044
+ | `password` | `string` | yes | _minLength=6, maxLength=64_ |
1045
+ | `secretKey` | `string` | yes | _minLength=6, maxLength=64_ |
1046
+
1047
+ ### CreateGameRequestData
1048
+
1049
+ Defines the request payload for CreateGame.
1050
+
1051
+ | Field | Type | Required | Notes |
1052
+ |-------|------|----------|-------|
1053
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1054
+
1055
+ ### CreateSecretInfoRequestData
1056
+
1057
+ Defines the request payload for `createSecretInfo`. `permissionParam` is the authoritative permission tree that controls which operations the created secret key may execute on the GearN Server.
1058
+
1059
+ | Field | Type | Required | Notes |
1060
+ |-------|------|----------|-------|
1061
+ | `secretKey` | `string` | yes | Optional custom secret key. If omitted, the backend may generate one. — _minLength=6, maxLength=64_ |
1062
+ | `gameId` | `string` | yes | Optional target game id when creating a secret for a specific game. — _minLength=2, maxLength=32_ |
1063
+ | `permissionParam` | `PermissionParam` | no | Optional permission tree granted to the new secret key. |
1064
+
1065
+ ### LoginByAdminAccountRequestData
1066
+
1067
+ Defines the request payload for `loginByAdminAccount`. A successful response returns an auth token that later dashboard calls reuse so backend middleware can resolve admin context.
1068
+
1069
+ | Field | Type | Required | Notes |
1070
+ |-------|------|----------|-------|
1071
+ | `username` | `string` | yes | _minLength=4, maxLength=32_ |
1072
+ | `password` | `string` | yes | _minLength=6, maxLength=64_ |
1073
+
1074
+ ### RemoveAdminAccountRequestData
1075
+
1076
+ Defines the request payload for RemoveAdminAccount.
1077
+
1078
+ | Field | Type | Required | Notes |
1079
+ |-------|------|----------|-------|
1080
+ | `userId` | `string` | yes | _minLength=10, maxLength=10_ |
1081
+
1082
+ ### SetGameInformationRequestData
1083
+
1084
+ Defines the request payload for SetGameInformation.
1085
+
1086
+ | Field | Type | Required | Notes |
1087
+ |-------|------|----------|-------|
1088
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1089
+ | `gameName` | `string` | no | — |
1090
+ | `gameDescription` | `string` | no | — |
1091
+ | `gameIconUrl` | `string` | no | — |
1092
+ | `gameSettings` | `GameSettingsParam` | no | — |
1093
+ | `matchmakingQueueSettings` | `Array<MatchmakingQueueSettingsParam>` | no | _elementCls=MatchmakingQueueSettingsParam_ |
1094
+
1095
+ ### SetMasterGameSettingsRequestData
1096
+
1097
+ Defines the request payload for SetMasterGameSettings.
1098
+
1099
+ | Field | Type | Required | Notes |
1100
+ |-------|------|----------|-------|
1101
+ | `thirtPartySettings` | `ThirtPartyParam` | no | — |
1102
+ | `masterPlayerSettings` | `MasterPlayerSettingsParam` | no | — |
1103
+ | `emailSettings` | `EmailSettingsParam` | no | — |
1104
+ | `pushNotificationSettings` | `PushNotificationSettingsParam` | no | — |
1105
+
1106
+ ### SetPasswordAdminAccountRequestData
1107
+
1108
+ Defines the request payload for SetPasswordAdminAccount.
1109
+
1110
+ | Field | Type | Required | Notes |
1111
+ |-------|------|----------|-------|
1112
+ | `userId` | `string` | yes | _minLength=10, maxLength=10_ |
1113
+ | `password` | `string` | yes | _minLength=6, maxLength=64_ |
1114
+
1115
+ ### SetSecretInfoInformationRequestData
1116
+
1117
+ Defines the request payload for SetSecretInfoInformation.
1118
+
1119
+ | Field | Type | Required | Notes |
1120
+ |-------|------|----------|-------|
1121
+ | `secretKey` | `string` | yes | _minLength=6, maxLength=64_ |
1122
+ | `remove` | `boolean` | no | — |
1123
+ | `tsExpire` | `number` | no | — |
1124
+ | `description` | `string` | no | — |
1125
+ | `permissionParam` | `PermissionParam` | no | — |
1126
+
1127
+ ### SetSecretKeyAdminAccountRequestData
1128
+
1129
+ Defines the request payload for SetSecretKeyAdminAccount.
1130
+
1131
+ | Field | Type | Required | Notes |
1132
+ |-------|------|----------|-------|
1133
+ | `userId` | `string` | yes | _minLength=10, maxLength=10_ |
1134
+ | `secretKey` | `string` | yes | _minLength=6, maxLength=64_ |
1135
+
1136
+ ### GetAnalyticsRequestData
1137
+
1138
+ Defines the request payload for GetAnalytics.
1139
+
1140
+ | Field | Type | Required | Notes |
1141
+ |-------|------|----------|-------|
1142
+ | `timestamp` | `number` | no | _min=0_ |
1143
+ | `analyticsItem` | `boolean` | no | — |
1144
+ | `country` | `boolean` | no | — |
1145
+ | `requestComplete` | `boolean` | no | — |
1146
+ | `operationSystem` | `boolean` | no | — |
1147
+ | `databaseSystem` | `boolean` | no | — |
1148
+ | `logDatabaseSystem` | `boolean` | no | — |
1149
+ | `cost` | `boolean` | no | — |
1150
+ | `monthlyCost` | `boolean` | no | — |
1151
+
1152
+ ### GetUsernameAdminAccountRequestData
1153
+
1154
+ Defines the request payload for GetUsernameAdminAccount.
1155
+
1156
+ | Field | Type | Required | Notes |
1157
+ |-------|------|----------|-------|
1158
+ | `userId` | `string` | yes | _minLength=10, maxLength=10_ |
1159
+
1160
+ ### GetEventCallbackCloudScriptRequestData
1161
+
1162
+ Defines the request payload for GetEventCallbackCloudScript.
1163
+
1164
+ _Không có field public (payload rỗng)._
1165
+
1166
+ ### SetEventCallbackCloudScriptRequestData
1167
+
1168
+ Defines the request payload for SetEventCallbackCloudScript.
1169
+
1170
+ | Field | Type | Required | Notes |
1171
+ |-------|------|----------|-------|
1172
+ | `eventName` | `string` | yes | _minLength=6, maxLength=128_ |
1173
+ | `script` | `string` | yes | _minLength=6, maxLength=Number.MAX_SAFE_INTEGER_ |
1174
+
1175
+ ### ResetStatisticsLeaderboardRequestData
1176
+
1177
+ Defines the request payload for ResetStatisticsLeaderboard.
1178
+
1179
+ | Field | Type | Required | Notes |
1180
+ |-------|------|----------|-------|
1181
+ | `type` | `number` | yes | — |
1182
+ | `key` | `string` | yes | _minLength=2, maxLength=32_ |
1183
+ | `version` | `string` | yes | _minLength=2, maxLength=32_ |
1184
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1185
+ | `log` | `string` | yes | _minLength=1, maxLength=256_ |
1186
+ | `catalogId` | `string` | yes | _minLength=2, maxLength=32_ |
1187
+
1188
+ ### DeleteInDatabaseRequestData
1189
+
1190
+ Defines the request payload for DeleteInDatabase.
1191
+
1192
+ | Field | Type | Required | Notes |
1193
+ |-------|------|----------|-------|
1194
+ | `type` | `number` | yes | — |
1195
+ | `id` | `string` | yes | _minLength=2, maxLength=32_ |
1196
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1197
+ | `log` | `string` | yes | _minLength=1, maxLength=256_ |
1198
+
1199
+ ### GetBackupStatisticsLeaderboardVersionRequestData
1200
+
1201
+ Defines the request payload for GetBackupStatisticsLeaderboardVersion.
1202
+
1203
+ | Field | Type | Required | Notes |
1204
+ |-------|------|----------|-------|
1205
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1206
+ | `type` | `number` | yes | — |
1207
+ | `key` | `string` | yes | _minLength=2, maxLength=32_ |
1208
+
1209
+ ### GetServerGameDataRequestData
1210
+
1211
+ Defines the request payload for GetServerGameData.
1212
+
1213
+ | Field | Type | Required | Notes |
1214
+ |-------|------|----------|-------|
1215
+ | `gameId` | `string` | yes | _minLength=2, maxLength=32_ |
1216
+ | `masterPlayerCount` | `boolean` | no | — |
1217
+ | `gamePlayerCount` | `boolean` | no | — |
1218
+ | `characterPlayerCount` | `boolean` | no | — |
1219
+ | `inventoryCount` | `boolean` | no | — |
1220
+ | `storeInventoryCount` | `boolean` | no | — |
1221
+ | `groupCount` | `boolean` | no | — |
1222
+ | `country` | `boolean` | no | — |
1223
+ | `version` | `boolean` | no | — |
1224
+
1225
+ ### AdminAccountResponseData
1226
+
1227
+ Defines the response payload for AdminAccount.
1228
+
1229
+ | Field | Type | Required | Notes |
1230
+ |-------|------|----------|-------|
1231
+ | `userId` | `string` | yes | — |
1232
+ | `username` | `string` | yes | — |
1233
+ | `secretKey` | `string` | yes | — |
1234
+
1235
+ ### GetAdminAccountListResponseData
1236
+
1237
+ Defines the response payload for GetAdminAccountList.
1238
+
1239
+ | Field | Type | Required | Notes |
1240
+ |-------|------|----------|-------|
1241
+ | `results` | `Array<AdminAccountResponseData>` | yes | _elementCls=AdminAccountResponseData_ |
1242
+
1243
+ ### GetGameInformationResponseData
1244
+
1245
+ Defines the response payload for GetGameInformation.
1246
+
1247
+ | Field | Type | Required | Notes |
1248
+ |-------|------|----------|-------|
1249
+ | `gameId` | `string` | yes | — |
1250
+ | `tsCreate` | `number` | yes | — |
1251
+ | `gameName` | `string` | yes | — |
1252
+ | `creatorId` | `string` | yes | — |
1253
+ | `gameDescription` | `string` | yes | — |
1254
+ | `gameIconUrl` | `string` | yes | — |
1255
+ | `gameSettings` | `GameSettingsParam` | yes | — |
1256
+ | `matchmakingQueueSettings` | `Array<MatchmakingQueueSettingsParam>` | yes | _elementCls=MatchmakingQueueSettingsParam_ |
1257
+
1258
+ ### GameWithGameIdResponseData
1259
+
1260
+ Defines the response payload for GameWithGameId.
1261
+
1262
+ | Field | Type | Required | Notes |
1263
+ |-------|------|----------|-------|
1264
+ | `gameId` | `string` | yes | — |
1265
+
1266
+ ### GetGameListResponseData
1267
+
1268
+ Defines the response payload for GetGameList.
1269
+
1270
+ | Field | Type | Required | Notes |
1271
+ |-------|------|----------|-------|
1272
+ | `results` | `Array<GameWithGameIdResponseData>` | yes | _elementCls=GameWithGameIdResponseData_ |
1273
+
1274
+ ### GetMasterGameSettingsResponseData
1275
+
1276
+ Defines the response payload for `getMasterGameSettings`. This payload contains the full top-level dashboard configuration snapshot used to provision a game.
1277
+
1278
+ | Field | Type | Required | Notes |
1279
+ |-------|------|----------|-------|
1280
+ | `thirtPartySettings` | `ThirtPartyParam` | yes | — |
1281
+ | `masterPlayerSettings` | `MasterPlayerSettingsParam` | yes | — |
1282
+ | `emailSettings` | `EmailSettingsParam` | yes | — |
1283
+ | `pushNotificationSettings` | `PushNotificationSettingsParam` | yes | — |
1284
+
1285
+ ### GetSecretInfoInformationResponseData
1286
+
1287
+ Defines the response payload for `getSecretInfoInformation`. This is the detailed secret-info record, including role, lifecycle flags, and permission tree.
1288
+
1289
+ | Field | Type | Required | Notes |
1290
+ |-------|------|----------|-------|
1291
+ | `secretKey` | `string` | yes | Secret key whose detailed configuration was requested. |
1292
+ | `gameId` | `string` | yes | — |
1293
+ | `tsCreate` | `number` | yes | — |
1294
+ | `creatorId` | `string` | yes | — |
1295
+ | `remove` | `boolean` | yes | — |
1296
+ | `tsExpire` | `number` | yes | — |
1297
+ | `description` | `string` | yes | — |
1298
+ | `permissionParam` | `PermissionParam` | yes | Permission tree granted to this secret key. |
1299
+
1300
+ ### SecretInfoWithSecretKeyResponseData
1301
+
1302
+ Defines a lightweight secret-info item returned by secret-list queries.
1303
+
1304
+ | Field | Type | Required | Notes |
1305
+ |-------|------|----------|-------|
1306
+ | `secretKey` | `string` | yes | — |
1307
+
1308
+ ### GetSecretInfoListResponseData
1309
+
1310
+ Defines the response payload for `getSecretInfoList`. Results are grouped by secret role instead of being returned as one flat array.
1311
+
1312
+ | Field | Type | Required | Notes |
1313
+ |-------|------|----------|-------|
1314
+ | `secretKeys` | `Array<SecretInfoWithSecretKeyResponseData>` | yes | Secret keys. — _elementCls=SecretInfoWithSecretKeyResponseData_ |
1315
+
1316
+ ### AdminAccountWithUserIdResponseData
1317
+
1318
+ Defines the response payload for AdminAccountWithUserId.
1319
+
1320
+ | Field | Type | Required | Notes |
1321
+ |-------|------|----------|-------|
1322
+ | `userId` | `string` | yes | — |
1323
+
1324
+ ### CreateAdminAccountResponseData
1325
+
1326
+ Defines the response payload for CreateAdminAccount.
1327
+
1328
+ | Field | Type | Required | Notes |
1329
+ |-------|------|----------|-------|
1330
+ | `results` | `Array<AdminAccountWithUserIdResponseData>` | yes | _elementCls=AdminAccountWithUserIdResponseData_ |
1331
+
1332
+ ### LoginByAdminAccountResponseData
1333
+
1334
+ Defines the response payload for `loginByAdminAccount`. The returned auth token should be cached and reused for subsequent dashboard requests.
1335
+
1336
+ | Field | Type | Required | Notes |
1337
+ |-------|------|----------|-------|
1338
+ | `authToken` | `string` | yes | Auth token representing the authenticated admin account. |
1339
+
1340
+ ### GetServerLogResponseData
1341
+
1342
+ Defines the response payload for GetServerLog.
1343
+
1344
+ | Field | Type | Required | Notes |
1345
+ |-------|------|----------|-------|
1346
+ | `results` | `Array<string>` | yes | _elementCls=String_ |
1347
+
1348
+ ### CountryRegionResponseData
1349
+
1350
+ Defines the response payload for CountryRegion.
1351
+
1352
+ | Field | Type | Required | Notes |
1353
+ |-------|------|----------|-------|
1354
+ | `regionCode` | `string` | yes | — |
1355
+ | `regionName` | `string` | yes | — |
1356
+ | `ccu` | `number` | yes | — |
1357
+ | `latitude` | `number` | no | _default=0_ |
1358
+ | `longitude` | `number` | no | _default=0_ |
1359
+
1360
+ ### CountryResponseData
1361
+
1362
+ Defines the response payload for Country.
1363
+
1364
+ | Field | Type | Required | Notes |
1365
+ |-------|------|----------|-------|
1366
+ | `countryCode` | `string` | yes | — |
1367
+ | `regions` | `Array<CountryRegionResponseData>` | yes | _elementCls=CountryRegionResponseData_ |
1368
+
1369
+ ### AnalyticsItemResponseData
1370
+
1371
+ Defines the response payload for AnalyticsItem.
1372
+
1373
+ | Field | Type | Required | Notes |
1374
+ |-------|------|----------|-------|
1375
+ | `ccu` | `number` | yes | — |
1376
+ | `dau` | `number` | yes | — |
1377
+ | `dauSince0h` | `number` | yes | — |
1378
+ | `dnu` | `number` | yes | — |
1379
+ | `dnuSince0h` | `number` | yes | — |
1380
+ | `drt` | `number` | yes | — |
1381
+ | `drtSince0h` | `number` | yes | — |
1382
+ | `mau` | `number` | yes | — |
1383
+ | `mauSince0h1` | `number` | yes | — |
1384
+ | `mnu` | `number` | yes | — |
1385
+ | `mnuSince0h1` | `number` | yes | — |
1386
+ | `mrt` | `number` | yes | — |
1387
+ | `mrtSince0h1` | `number` | yes | — |
1388
+ | `analyticsPrice` | `number` | yes | — |
1389
+
1390
+ ### MemoryUsageResponseData
1391
+
1392
+ Defines the response payload for MemoryUsage.
1393
+
1394
+ | Field | Type | Required | Notes |
1395
+ |-------|------|----------|-------|
1396
+ | `freeMemoryInBytes` | `number` | yes | — |
1397
+ | `totalMemoryInBytes` | `number` | yes | — |
1398
+
1399
+ ### StorageUsageResponseData
1400
+
1401
+ Defines the response payload for StorageUsage.
1402
+
1403
+ | Field | Type | Required | Notes |
1404
+ |-------|------|----------|-------|
1405
+ | `name` | `string` | yes | — |
1406
+ | `fsTotalSizeInBytes` | `number` | yes | — |
1407
+ | `fsUsedSizeInBytes` | `number` | yes | — |
1408
+
1409
+ ### DatabaseSystemResponseData
1410
+
1411
+ Defines the response payload for DatabaseSystem.
1412
+
1413
+ | Field | Type | Required | Notes |
1414
+ |-------|------|----------|-------|
1415
+ | `fsTotalSizeInBytes` | `number` | yes | — |
1416
+ | `fsUsedSizeInBytes` | `number` | yes | — |
1417
+ | `totalSizeInBytes` | `number` | yes | — |
1418
+ | `collections` | `number` | yes | — |
1419
+ | `objects` | `number` | yes | — |
1420
+ | `indexes` | `number` | yes | — |
1421
+
1422
+ ### OperationSystemResponseData
1423
+
1424
+ Defines the response payload for OperationSystem.
1425
+
1426
+ | Field | Type | Required | Notes |
1427
+ |-------|------|----------|-------|
1428
+ | `cpuUsage` | `number` | yes | — |
1429
+ | `memoryUsage` | `MemoryUsageResponseData` | yes | — |
1430
+ | `storageUsage` | `Array<StorageUsageResponseData>` | yes | _elementCls=StorageUsageResponseData_ |
1431
+
1432
+ ### RequestCompleteErrorCodeResponseData
1433
+
1434
+ Defines the response payload for RequestCompleteErrorCode.
1435
+
1436
+ | Field | Type | Required | Notes |
1437
+ |-------|------|----------|-------|
1438
+ | `errorCode` | `number` | yes | — |
1439
+ | `count` | `number` | yes | — |
1440
+
1441
+ ### RequestCompleteResponseData
1442
+
1443
+ Defines the response payload for RequestComplete.
1444
+
1445
+ | Field | Type | Required | Notes |
1446
+ |-------|------|----------|-------|
1447
+ | `eventName` | `string` | yes | — |
1448
+ | `results` | `Array<RequestCompleteErrorCodeResponseData>` | yes | _elementCls=RequestCompleteErrorCodeResponseData_ |
1449
+
1450
+ ### CostResponseData
1451
+
1452
+ Defines the response payload for Cost.
1453
+
1454
+ | Field | Type | Required | Notes |
1455
+ |-------|------|----------|-------|
1456
+ | `requestCount` | `number` | yes | — |
1457
+ | `matchmakingRequestCount` | `number` | yes | — |
1458
+ | `cloudScriptGBs` | `number` | yes | — |
1459
+ | `storageSizeInBytes` | `number` | yes | — |
1460
+ | `dataTransferSizeInBytes` | `number` | yes | — |
1461
+
1462
+ ### GetAnalyticsResponseData
1463
+
1464
+ Defines the response payload for GetAnalytics.
1465
+
1466
+ | Field | Type | Required | Notes |
1467
+ |-------|------|----------|-------|
1468
+ | `analyticsItem` | `AnalyticsItemResponseData` | no | — |
1469
+ | `country` | `Array<CountryResponseData>` | no | _elementCls=CountryResponseData_ |
1470
+ | `operationSystem` | `OperationSystemResponseData` | no | — |
1471
+ | `requestComplete` | `Array<RequestCompleteResponseData>` | no | _elementCls=RequestCompleteResponseData_ |
1472
+ | `databaseSystem` | `DatabaseSystemResponseData` | no | — |
1473
+ | `logDatabaseSystem` | `DatabaseSystemResponseData` | no | — |
1474
+ | `cost` | `CostResponseData` | no | — |
1475
+ | `monthlyCost` | `CostResponseData` | no | — |
1476
+
1477
+ ### GetUsernameAdminAccountResponseData
1478
+
1479
+ Defines the response payload for GetUsernameAdminAccount.
1480
+
1481
+ | Field | Type | Required | Notes |
1482
+ |-------|------|----------|-------|
1483
+ | `username` | `string` | yes | — |
1484
+
1485
+ ### ChildScriptResponseData
1486
+
1487
+ Defines the response payload for ChildScript.
1488
+
1489
+ | Field | Type | Required | Notes |
1490
+ |-------|------|----------|-------|
1491
+ | `eventName` | `string` | yes | — |
1492
+ | `script` | `string` | yes | — |
1493
+ | `hasEdit` | `boolean` | yes | — |
1494
+
1495
+ ### EventCallbackCloudScriptResponseData
1496
+
1497
+ Defines the response payload for EventCallbackCloudScript.
1498
+
1499
+ | Field | Type | Required | Notes |
1500
+ |-------|------|----------|-------|
1501
+ | `type` | `string` | yes | — |
1502
+ | `tsCreate` | `number` | yes | — |
1503
+ | `version` | `string` | yes | — |
1504
+ | `childScripts` | `Array<ChildScriptResponseData>` | yes | _elementCls=ChildScriptResponseData_ |
1505
+
1506
+ ### GetEventCallbackCloudScriptResponseData
1507
+
1508
+ Defines the response payload for `getEventCallbackCloudScript`. Each result links one event callback registration to a CloudScript target.
1509
+
1510
+ | Field | Type | Required | Notes |
1511
+ |-------|------|----------|-------|
1512
+ | `results` | `Array<EventCallbackCloudScriptResponseData>` | yes | _elementCls=EventCallbackCloudScriptResponseData_ |
1513
+
1514
+ ### SetEventCallbackCloudScriptResponseData
1515
+
1516
+ Defines the response payload for SetEventCallbackCloudScript.
1517
+
1518
+ | Field | Type | Required | Notes |
1519
+ |-------|------|----------|-------|
1520
+ | `errorMessage` | `string` | yes | — |
1521
+
1522
+ ### BackupStatisticsLeaderboardVersionResponseData
1523
+
1524
+ Defines the response payload for BackupStatisticsLeaderboardVersion.
1525
+
1526
+ | Field | Type | Required | Notes |
1527
+ |-------|------|----------|-------|
1528
+ | `version` | `string` | yes | — |
1529
+ | `log` | `string` | yes | — |
1530
+ | `tsCreate` | `number` | yes | — |
1531
+
1532
+ ### GetBackupStatisticsLeaderboardVersionResponseData
1533
+
1534
+ Defines the response payload for GetBackupStatisticsLeaderboardVersion.
1535
+
1536
+ | Field | Type | Required | Notes |
1537
+ |-------|------|----------|-------|
1538
+ | `results` | `Array<BackupStatisticsLeaderboardVersionResponseData>` | yes | _elementCls=BackupStatisticsLeaderboardVersionResponseData_ |
1539
+
1540
+ ### GetServerGameDataResponseData
1541
+
1542
+ Defines the response payload for `getServerGameData`. This is a high-level telemetry snapshot of entity counts, country breakdown, and server version data.
1543
+
1544
+ | Field | Type | Required | Notes |
1545
+ |-------|------|----------|-------|
1546
+ | `masterPlayerCount` | `number` | no | — |
1547
+ | `gamePlayerCount` | `number` | no | — |
1548
+ | `characterPlayerCount` | `number` | no | — |
1549
+ | `inventoryCount` | `number` | no | — |
1550
+ | `storeInventoryCount` | `number` | no | — |
1551
+ | `groupCount` | `number` | no | — |
1552
+ | `country` | `Array<CountryResponseData>` | no | Optional country-level breakdown returned by the backend. — _elementCls=CountryResponseData_ |
1553
+ | `version` | `string` | no | Optional server or game-data version string reported by the backend. |
1554
+
1555
+ ### EmptyResponseData
1556
+
1557
+ Defines an intentionally empty response payload.
1558
+
1559
+ _Không có field public (payload rỗng)._
1560
+
1561
+ ## Namespace `DashboardRequestModels`
1562
+
1563
+ ### ChangePasswordAdminAccountOperationRequest
1564
+
1565
+ Extends: `CustomOperationRequestAbstract<DashboardModels.ChangePasswordAdminAccountRequestData>`
1566
+
1567
+ Maps the ChangePasswordAdminAccount operation to a typed request wrapper.
1568
+
1569
+ _Không có field public (payload rỗng)._
1570
+
1571
+ ### GetAdminAccountListOperationRequest
1572
+
1573
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetAdminAccountListRequestData>`
1574
+
1575
+ Maps the GetAdminAccountList operation to a typed request wrapper.
1576
+
1577
+ _Không có field public (payload rỗng)._
1578
+
1579
+ ### GetGameInformationOperationRequest
1580
+
1581
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetGameInformationRequestData>`
1582
+
1583
+ Maps the GetGameInformation operation to a typed request wrapper.
1584
+
1585
+ _Không có field public (payload rỗng)._
1586
+
1587
+ ### GetGameListOperationRequest
1588
+
1589
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetGameListRequestData>`
1590
+
1591
+ Maps the GetGameList operation to a typed request wrapper.
1592
+
1593
+ _Không có field public (payload rỗng)._
1594
+
1595
+ ### GetMasterGameSettingsOperationRequest
1596
+
1597
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetMasterGameSettingsRequestData>`
1598
+
1599
+ Maps the GetMasterGameSettings operation to a typed request wrapper.
1600
+
1601
+ _Không có field public (payload rỗng)._
1602
+
1603
+ ### GetSecretInfoInformationOperationRequest
1604
+
1605
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetSecretInfoInformationRequestData>`
1606
+
1607
+ Maps the GetSecretInfoInformation operation to a typed request wrapper.
1608
+
1609
+ _Không có field public (payload rỗng)._
1610
+
1611
+ ### GetSecretInfoListOperationRequest
1612
+
1613
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetSecretInfoListRequestData>`
1614
+
1615
+ Maps the GetSecretInfoList operation to a typed request wrapper.
1616
+
1617
+ _Không có field public (payload rỗng)._
1618
+
1619
+ ### GetServerLogOperationRequest
1620
+
1621
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetServerLogRequestData>`
1622
+
1623
+ Maps the GetServerLog operation to a typed request wrapper.
1624
+
1625
+ _Không có field public (payload rỗng)._
1626
+
1627
+ ### CreateAdminAccountOperationRequest
1628
+
1629
+ Extends: `CustomOperationRequestAbstract<DashboardModels.CreateAdminAccountRequestData>`
1630
+
1631
+ Maps the CreateAdminAccount operation to a typed request wrapper.
1632
+
1633
+ _Không có field public (payload rỗng)._
1634
+
1635
+ ### CreateGameOperationRequest
1636
+
1637
+ Extends: `CustomOperationRequestAbstract<DashboardModels.CreateGameRequestData>`
1638
+
1639
+ Maps the CreateGame operation to a typed request wrapper.
1640
+
1641
+ _Không có field public (payload rỗng)._
1642
+
1643
+ ### CreateSecretInfoOperationRequest
1644
+
1645
+ Extends: `CustomOperationRequestAbstract<DashboardModels.CreateSecretInfoRequestData>`
1646
+
1647
+ Maps the CreateSecretInfo operation to a typed request wrapper.
1648
+
1649
+ _Không có field public (payload rỗng)._
1650
+
1651
+ ### LoginByAdminAccountOperationRequest
1652
+
1653
+ Extends: `CustomOperationRequestAbstract<DashboardModels.LoginByAdminAccountRequestData>`
1654
+
1655
+ Maps the LoginByAdminAccount operation to a typed request wrapper.
1656
+
1657
+ _Không có field public (payload rỗng)._
1658
+
1659
+ ### RemoveAdminAccountOperationRequest
1660
+
1661
+ Extends: `CustomOperationRequestAbstract<DashboardModels.RemoveAdminAccountRequestData>`
1662
+
1663
+ Maps the RemoveAdminAccount operation to a typed request wrapper.
1664
+
1665
+ _Không có field public (payload rỗng)._
1666
+
1667
+ ### SetGameInformationOperationRequest
1668
+
1669
+ Extends: `CustomOperationRequestAbstract<DashboardModels.SetGameInformationRequestData>`
1670
+
1671
+ Maps the SetGameInformation operation to a typed request wrapper.
1672
+
1673
+ _Không có field public (payload rỗng)._
1674
+
1675
+ ### SetMasterGameSettingsOperationRequest
1676
+
1677
+ Extends: `CustomOperationRequestAbstract<DashboardModels.SetMasterGameSettingsRequestData>`
1678
+
1679
+ Maps the SetMasterGameSettings operation to a typed request wrapper.
1680
+
1681
+ _Không có field public (payload rỗng)._
1682
+
1683
+ ### SetPasswordAdminAccountOperationRequest
1684
+
1685
+ Extends: `CustomOperationRequestAbstract<DashboardModels.SetPasswordAdminAccountRequestData>`
1686
+
1687
+ Maps the SetPasswordAdminAccount operation to a typed request wrapper.
1688
+
1689
+ _Không có field public (payload rỗng)._
1690
+
1691
+ ### SetSecretInfoInformationOperationRequest
1692
+
1693
+ Extends: `CustomOperationRequestAbstract<DashboardModels.SetSecretInfoInformationRequestData>`
1694
+
1695
+ Maps the SetSecretInfoInformation operation to a typed request wrapper.
1696
+
1697
+ _Không có field public (payload rỗng)._
1698
+
1699
+ ### SetSecretKeyAdminAccountOperationRequest
1700
+
1701
+ Extends: `CustomOperationRequestAbstract<DashboardModels.SetSecretKeyAdminAccountRequestData>`
1702
+
1703
+ Maps the SetSecretKeyAdminAccount operation to a typed request wrapper.
1704
+
1705
+ _Không có field public (payload rỗng)._
1706
+
1707
+ ### GetUsernameAdminAccountOperationRequest
1708
+
1709
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetUsernameAdminAccountRequestData>`
1710
+
1711
+ Maps the GetUsernameAdminAccount operation to a typed request wrapper.
1712
+
1713
+ _Không có field public (payload rỗng)._
1714
+
1715
+ ### GetAnalyticsOperationRequest
1716
+
1717
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetAnalyticsRequestData>`
1718
+
1719
+ Maps the GetAnalytics operation to a typed request wrapper.
1720
+
1721
+ _Không có field public (payload rỗng)._
1722
+
1723
+ ### GetEventCallbackCloudScriptOperationRequest
1724
+
1725
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetEventCallbackCloudScriptRequestData>`
1726
+
1727
+ Maps the GetEventCallbackCloudScript operation to a typed request wrapper.
1728
+
1729
+ _Không có field public (payload rỗng)._
1730
+
1731
+ ### SetEventCallbackCloudScriptOperationRequest
1732
+
1733
+ Extends: `CustomOperationRequestAbstract<DashboardModels.SetEventCallbackCloudScriptRequestData>`
1734
+
1735
+ Maps the SetEventCallbackCloudScript operation to a typed request wrapper.
1736
+
1737
+ _Không có field public (payload rỗng)._
1738
+
1739
+ ### ResetStatisticsLeaderboardOperationRequest
1740
+
1741
+ Extends: `CustomOperationRequestAbstract<DashboardModels.ResetStatisticsLeaderboardRequestData>`
1742
+
1743
+ Maps the ResetStatisticsLeaderboard operation to a typed request wrapper.
1744
+
1745
+ _Không có field public (payload rỗng)._
1746
+
1747
+ ### GetBackupStatisticsLeaderboardVersionOperationRequest
1748
+
1749
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetBackupStatisticsLeaderboardVersionRequestData>`
1750
+
1751
+ Maps the GetBackupStatisticsLeaderboardVersion operation to a typed request wrapper.
1752
+
1753
+ _Không có field public (payload rỗng)._
1754
+
1755
+ ### GetServerGameDataOperationRequest
1756
+
1757
+ Extends: `CustomOperationRequestAbstract<DashboardModels.GetServerGameDataRequestData>`
1758
+
1759
+ Maps the GetServerGameData operation to a typed request wrapper.
1760
+
1761
+ _Không có field public (payload rỗng)._
1762
+
1763
+ ### DeleteInDatabaseOperationRequest
1764
+
1765
+ Extends: `CustomOperationRequestAbstract<DashboardModels.DeleteInDatabaseRequestData>`
1766
+
1767
+ Maps the DeleteInDatabase operation to a typed request wrapper.
1768
+
1769
+ _Không có field public (payload rỗng)._
1770
+
1771
+ ## Namespace `DashboardResponseModels`
1772
+
1773
+ ### ChangePasswordAdminAccountOperationResponse
1774
+
1775
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1776
+
1777
+ Maps the ChangePasswordAdminAccount operation to a typed response wrapper.
1778
+
1779
+ _Không có field public (payload rỗng)._
1780
+
1781
+ ### GetAdminAccountListOperationResponse
1782
+
1783
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetAdminAccountListResponseData>`
1784
+
1785
+ Maps the GetAdminAccountList operation to a typed response wrapper.
1786
+
1787
+ _Không có field public (payload rỗng)._
1788
+
1789
+ ### GetGameInformationOperationResponse
1790
+
1791
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetGameInformationResponseData>`
1792
+
1793
+ Maps the GetGameInformation operation to a typed response wrapper.
1794
+
1795
+ _Không có field public (payload rỗng)._
1796
+
1797
+ ### GetGameListOperationResponse
1798
+
1799
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetGameListResponseData>`
1800
+
1801
+ Maps the GetGameList operation to a typed response wrapper.
1802
+
1803
+ _Không có field public (payload rỗng)._
1804
+
1805
+ ### GetMasterGameSettingsOperationResponse
1806
+
1807
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetMasterGameSettingsResponseData>`
1808
+
1809
+ Maps the GetMasterGameSettings operation to a typed response wrapper.
1810
+
1811
+ _Không có field public (payload rỗng)._
1812
+
1813
+ ### GetSecretInfoInformationOperationResponse
1814
+
1815
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetSecretInfoInformationResponseData>`
1816
+
1817
+ Maps the GetSecretInfoInformation operation to a typed response wrapper.
1818
+
1819
+ _Không có field public (payload rỗng)._
1820
+
1821
+ ### GetSecretInfoListOperationResponse
1822
+
1823
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetSecretInfoListResponseData>`
1824
+
1825
+ Maps the GetSecretInfoList operation to a typed response wrapper.
1826
+
1827
+ _Không có field public (payload rỗng)._
1828
+
1829
+ ### GetServerLogOperationResponse
1830
+
1831
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetServerLogResponseData>`
1832
+
1833
+ Maps the GetServerLog operation to a typed response wrapper.
1834
+
1835
+ _Không có field public (payload rỗng)._
1836
+
1837
+ ### CreateAdminAccountOperationResponse
1838
+
1839
+ Extends: `CustomOperationResponseAbstract<DashboardModels.CreateAdminAccountResponseData>`
1840
+
1841
+ Maps the CreateAdminAccount operation to a typed response wrapper.
1842
+
1843
+ _Không có field public (payload rỗng)._
1844
+
1845
+ ### CreateGameOperationResponse
1846
+
1847
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GameWithGameIdResponseData>`
1848
+
1849
+ Maps the CreateGame operation to a typed response wrapper.
1850
+
1851
+ _Không có field public (payload rỗng)._
1852
+
1853
+ ### CreateSecretInfoOperationResponse
1854
+
1855
+ Extends: `CustomOperationResponseAbstract<DashboardModels.SecretInfoWithSecretKeyResponseData>`
1856
+
1857
+ Maps the CreateSecretInfo operation to a typed response wrapper.
1858
+
1859
+ _Không có field public (payload rỗng)._
1860
+
1861
+ ### LoginByAdminAccountOperationResponse
1862
+
1863
+ Extends: `CustomOperationResponseAbstract<DashboardModels.LoginByAdminAccountResponseData>`
1864
+
1865
+ Maps the LoginByAdminAccount operation to a typed response wrapper.
1866
+
1867
+ _Không có field public (payload rỗng)._
1868
+
1869
+ ### RemoveAdminAccountOperationResponse
1870
+
1871
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1872
+
1873
+ Maps the RemoveAdminAccount operation to a typed response wrapper.
1874
+
1875
+ _Không có field public (payload rỗng)._
1876
+
1877
+ ### SetGameInformationOperationResponse
1878
+
1879
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1880
+
1881
+ Maps the SetGameInformation operation to a typed response wrapper.
1882
+
1883
+ _Không có field public (payload rỗng)._
1884
+
1885
+ ### SetMasterGameSettingsOperationResponse
1886
+
1887
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1888
+
1889
+ Maps the SetMasterGameSettings operation to a typed response wrapper.
1890
+
1891
+ _Không có field public (payload rỗng)._
1892
+
1893
+ ### SetPasswordAdminAccountOperationResponse
1894
+
1895
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1896
+
1897
+ Maps the SetPasswordAdminAccount operation to a typed response wrapper.
1898
+
1899
+ _Không có field public (payload rỗng)._
1900
+
1901
+ ### SetSecretInfoInformationOperationResponse
1902
+
1903
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1904
+
1905
+ Maps the SetSecretInfoInformation operation to a typed response wrapper.
1906
+
1907
+ _Không có field public (payload rỗng)._
1908
+
1909
+ ### SetSecretKeyAdminAccountOperationResponse
1910
+
1911
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1912
+
1913
+ Maps the SetSecretKeyAdminAccount operation to a typed response wrapper.
1914
+
1915
+ _Không có field public (payload rỗng)._
1916
+
1917
+ ### GetUsernameAdminAccountOperationResponse
1918
+
1919
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetUsernameAdminAccountResponseData>`
1920
+
1921
+ Maps the GetUsernameAdminAccount operation to a typed response wrapper.
1922
+
1923
+ _Không có field public (payload rỗng)._
1924
+
1925
+ ### GetAnalyticsOperationResponse
1926
+
1927
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetAnalyticsResponseData>`
1928
+
1929
+ Maps the GetAnalytics operation to a typed response wrapper.
1930
+
1931
+ _Không có field public (payload rỗng)._
1932
+
1933
+ ### GetEventCallbackCloudScriptOperationResponse
1934
+
1935
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetEventCallbackCloudScriptResponseData>`
1936
+
1937
+ Maps the GetEventCallbackCloudScript operation to a typed response wrapper.
1938
+
1939
+ _Không có field public (payload rỗng)._
1940
+
1941
+ ### SetEventCallbackCloudScriptOperationResponse
1942
+
1943
+ Extends: `CustomOperationResponseAbstract<DashboardModels.SetEventCallbackCloudScriptResponseData>`
1944
+
1945
+ Maps the SetEventCallbackCloudScript operation to a typed response wrapper.
1946
+
1947
+ _Không có field public (payload rỗng)._
1948
+
1949
+ ### ResetStatisticsLeaderboardOperationResponse
1950
+
1951
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1952
+
1953
+ Maps the ResetStatisticsLeaderboard operation to a typed response wrapper.
1954
+
1955
+ _Không có field public (payload rỗng)._
1956
+
1957
+ ### GetBackupStatisticsLeaderboardVersionOperationResponse
1958
+
1959
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetBackupStatisticsLeaderboardVersionResponseData>`
1960
+
1961
+ Maps the GetBackupStatisticsLeaderboardVersion operation to a typed response wrapper.
1962
+
1963
+ _Không có field public (payload rỗng)._
1964
+
1965
+ ### GetServerGameDataOperationResponse
1966
+
1967
+ Extends: `CustomOperationResponseAbstract<DashboardModels.GetServerGameDataResponseData>`
1968
+
1969
+ Maps the GetServerGameData operation to a typed response wrapper.
1970
+
1971
+ _Không có field public (payload rỗng)._
1972
+
1973
+ ### DeleteInDatabaseOperationResponse
1974
+
1975
+ Extends: `CustomOperationResponseAbstract<DashboardModels.EmptyResponseData>`
1976
+
1977
+ Maps the DeleteInDatabase operation to a typed response wrapper.
1978
+
1979
+ _Không có field public (payload rỗng)._
1980
+