@xmobitea/gn-typescript-client 2.6.8-tsc → 2.6.9

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 (203) hide show
  1. package/LICENSE +198 -5
  2. package/dist/gearn.js.client.js +46884 -0
  3. package/dist/gearn.js.client.min.js +2 -0
  4. package/dist/gearn.js.client.min.js.LICENSE.txt +14 -0
  5. package/dist/index.js +34162 -337
  6. package/dist/runtime/entity/models/CharacterPlayerModels.d.ts +0 -1
  7. package/dist/runtime/entity/models/DashboardModels.d.ts +7 -7
  8. package/dist/runtime/entity/models/GroupModels.d.ts +0 -1
  9. package/dist/runtime/entity/models/MultiplayerModels.d.ts +1 -1
  10. package/package.json +2 -2
  11. package/responseModel/chatgpt/Authenticate.json +724 -0
  12. package/responseModel/chatgpt/CharacterPlayer.json +1890 -0
  13. package/responseModel/chatgpt/CloudScript.json +254 -0
  14. package/responseModel/chatgpt/Content.json +273 -0
  15. package/responseModel/chatgpt/Dashboard.json +4110 -0
  16. package/responseModel/chatgpt/GamePlayer.json +2306 -0
  17. package/responseModel/chatgpt/Generic.json +253 -0
  18. package/responseModel/chatgpt/Group.json +1509 -0
  19. package/responseModel/chatgpt/Inventory.json +1211 -0
  20. package/responseModel/chatgpt/MasterPlayer.json +3801 -0
  21. package/responseModel/chatgpt/Multiplayer.json +634 -0
  22. package/responseModel/chatgpt/StoreInventory.json +1099 -0
  23. package/responseModel/clients/AuthenticateModels.json +271 -0
  24. package/responseModel/clients/CharacterPlayerModels.json +792 -0
  25. package/responseModel/clients/CloudScriptModels.json +191 -0
  26. package/responseModel/clients/ContentModels.json +178 -0
  27. package/responseModel/clients/DashboardModels.json +5423 -0
  28. package/responseModel/clients/GamePlayerModels.json +781 -0
  29. package/responseModel/clients/GenericModels.json +344 -0
  30. package/responseModel/clients/GroupModels.json +705 -0
  31. package/responseModel/clients/InventoryModels.json +568 -0
  32. package/responseModel/clients/MasterPlayerModels.json +1281 -0
  33. package/responseModel/clients/MultiplayerModels.json +439 -0
  34. package/responseModel/clients/StoreInventoryModels.json +971 -0
  35. package/responseModel/finalChatgpt/Authenticate.json +1475 -0
  36. package/responseModel/finalChatgpt/CharacterPlayer.json +4104 -0
  37. package/responseModel/finalChatgpt/CloudScript.json +515 -0
  38. package/responseModel/finalChatgpt/Content.json +536 -0
  39. package/responseModel/finalChatgpt/Dashboard.json +6712 -0
  40. package/responseModel/finalChatgpt/GamePlayer.json +5142 -0
  41. package/responseModel/finalChatgpt/Generic.json +333 -0
  42. package/responseModel/finalChatgpt/Group.json +3232 -0
  43. package/responseModel/finalChatgpt/Inventory.json +2606 -0
  44. package/responseModel/finalChatgpt/MasterPlayer.json +8385 -0
  45. package/responseModel/finalChatgpt/Multiplayer.json +1196 -0
  46. package/responseModel/finalChatgpt/StoreInventory.json +2085 -0
  47. package/responseModel/finals/Authenticate.json +1460 -0
  48. package/responseModel/finals/CharacterPlayer.json +3639 -0
  49. package/responseModel/finals/CloudScript.json +465 -0
  50. package/responseModel/finals/Content.json +479 -0
  51. package/responseModel/finals/Dashboard.json +6718 -0
  52. package/responseModel/finals/GamePlayer.json +4291 -0
  53. package/responseModel/finals/Generic.json +345 -0
  54. package/responseModel/finals/Group.json +2885 -0
  55. package/responseModel/finals/Inventory.json +2309 -0
  56. package/responseModel/finals/MasterPlayer.json +7018 -0
  57. package/responseModel/finals/Multiplayer.json +1082 -0
  58. package/responseModel/finals/StoreInventory.json +1979 -0
  59. package/responseModel/finalsShort/Authenticate.json +723 -0
  60. package/responseModel/finalsShort/CharacterPlayer.json +1889 -0
  61. package/responseModel/finalsShort/CloudScript.json +253 -0
  62. package/responseModel/finalsShort/Content.json +272 -0
  63. package/responseModel/finalsShort/Dashboard.json +4109 -0
  64. package/responseModel/finalsShort/GamePlayer.json +2305 -0
  65. package/responseModel/finalsShort/Generic.json +252 -0
  66. package/responseModel/finalsShort/Group.json +1508 -0
  67. package/responseModel/finalsShort/Inventory.json +1210 -0
  68. package/responseModel/finalsShort/MasterPlayer.json +3800 -0
  69. package/responseModel/finalsShort/Multiplayer.json +633 -0
  70. package/responseModel/finalsShort/StoreInventory.json +1098 -0
  71. package/responseModel/operationResponse/AuthenticateResponseModels.json +77 -0
  72. package/responseModel/operationResponse/CharacterPlayerResponseModels.json +217 -0
  73. package/responseModel/operationResponse/CloudScriptResponseModels.json +25 -0
  74. package/responseModel/operationResponse/ContentResponseModels.json +33 -0
  75. package/responseModel/operationResponse/DashboardResponseModels.json +109 -0
  76. package/responseModel/operationResponse/GamePlayerResponseModels.json +213 -0
  77. package/responseModel/operationResponse/GroupResponseModels.json +165 -0
  78. package/responseModel/operationResponse/InventoryResponseModels.json +141 -0
  79. package/responseModel/operationResponse/MasterPlayerResponseModels.json +349 -0
  80. package/responseModel/operationResponse/MultiplayerResponseModels.json +45 -0
  81. package/responseModel/operationResponse/StoreInventoryResponseModels.json +61 -0
  82. package/responseModel/servers/Authenticate.json +1328 -0
  83. package/responseModel/servers/CharacterPlayer.json +3199 -0
  84. package/responseModel/servers/CloudScript.json +278 -0
  85. package/responseModel/servers/Content.json +324 -0
  86. package/responseModel/servers/GamePlayer.json +3844 -0
  87. package/responseModel/servers/Group.json +2454 -0
  88. package/responseModel/servers/Inventory.json +1964 -0
  89. package/responseModel/servers/MasterAdmin.json +5569 -0
  90. package/responseModel/servers/MasterPlayer.json +5924 -0
  91. package/responseModel/servers/Multiplayer.json +545 -0
  92. package/responseModel/servers/StoreInventory.json +1290 -0
  93. package/dist/runtime/GNNetwork.js +0 -250
  94. package/dist/runtime/GNNetworkAuthenticateApi.js +0 -122
  95. package/dist/runtime/GNNetworkCharacterPlayerApi.js +0 -968
  96. package/dist/runtime/GNNetworkCloudScriptApi.js +0 -104
  97. package/dist/runtime/GNNetworkContentApi.js +0 -140
  98. package/dist/runtime/GNNetworkDashboardApi.js +0 -170
  99. package/dist/runtime/GNNetworkGamePlayerApi.js +0 -950
  100. package/dist/runtime/GNNetworkGroupApi.js +0 -734
  101. package/dist/runtime/GNNetworkInventoryApi.js +0 -626
  102. package/dist/runtime/GNNetworkMasterPlayerApi.js +0 -1550
  103. package/dist/runtime/GNNetworkMultiplayerApi.js +0 -194
  104. package/dist/runtime/GNNetworkStoreInventoryApi.js +0 -266
  105. package/dist/runtime/common/Action0.js +0 -1
  106. package/dist/runtime/common/Action1.js +0 -1
  107. package/dist/runtime/common/Action2.js +0 -1
  108. package/dist/runtime/common/Action3.js +0 -1
  109. package/dist/runtime/common/Action4.js +0 -1
  110. package/dist/runtime/common/GNData.js +0 -211
  111. package/dist/runtime/config/GNServerSettings.js +0 -149
  112. package/dist/runtime/constant/Commands.js +0 -19
  113. package/dist/runtime/constant/EventCode.js +0 -8
  114. package/dist/runtime/constant/OperationCode.js +0 -221
  115. package/dist/runtime/constant/ReturnCode.js +0 -14
  116. package/dist/runtime/constant/enumType/ExecuteResponseStatus.js +0 -8
  117. package/dist/runtime/constant/enumType/FriendStatus.js +0 -7
  118. package/dist/runtime/constant/enumType/GoogleLoginType.js +0 -5
  119. package/dist/runtime/constant/enumType/GroupStatus.js +0 -7
  120. package/dist/runtime/constant/enumType/InvalidMemberType.js +0 -18
  121. package/dist/runtime/constant/enumType/ItemType.js +0 -5
  122. package/dist/runtime/constant/enumType/MatchmakingMemberStatus.js +0 -6
  123. package/dist/runtime/constant/enumType/MatchmakingTicketStatus.js +0 -8
  124. package/dist/runtime/constant/enumType/OwnerType.js +0 -9
  125. package/dist/runtime/constant/enumType/PermissionDataItem.js +0 -5
  126. package/dist/runtime/constant/enumType/PushPlatformType.js +0 -5
  127. package/dist/runtime/constant/enumType/RequestRole.js +0 -6
  128. package/dist/runtime/constant/enumType/RequestType.js +0 -15
  129. package/dist/runtime/constant/enumType/StoreItemType.js +0 -5
  130. package/dist/runtime/constant/enumType/StoreReceiveType.js +0 -8
  131. package/dist/runtime/constant/errorCode/ErrorCode.js +0 -52
  132. package/dist/runtime/constant/parameterCode/ParameterCode.js +0 -617
  133. package/dist/runtime/entity/DataMember.js +0 -208
  134. package/dist/runtime/entity/GNMetadata.js +0 -11
  135. package/dist/runtime/entity/InvalidMember.js +0 -1
  136. package/dist/runtime/entity/OperationEvent.js +0 -24
  137. package/dist/runtime/entity/OperationHelper.js +0 -24
  138. package/dist/runtime/entity/OperationRequest.js +0 -42
  139. package/dist/runtime/entity/OperationResponse.js +0 -73
  140. package/dist/runtime/entity/models/AuthenticateModels.js +0 -426
  141. package/dist/runtime/entity/models/AuthenticateRequestModels.js +0 -188
  142. package/dist/runtime/entity/models/AuthenticateResponseModels.js +0 -131
  143. package/dist/runtime/entity/models/CharacterPlayerModels.js +0 -1437
  144. package/dist/runtime/entity/models/CharacterPlayerRequestModels.js +0 -1386
  145. package/dist/runtime/entity/models/CharacterPlayerResponseModels.js +0 -376
  146. package/dist/runtime/entity/models/CloudScriptModels.js +0 -197
  147. package/dist/runtime/entity/models/CloudScriptRequestModels.js +0 -138
  148. package/dist/runtime/entity/models/CloudScriptResponseModels.js +0 -40
  149. package/dist/runtime/entity/models/ContentModels.js +0 -203
  150. package/dist/runtime/entity/models/ContentRequestModels.js +0 -190
  151. package/dist/runtime/entity/models/ContentResponseModels.js +0 -54
  152. package/dist/runtime/entity/models/DashboardModels.js +0 -3002
  153. package/dist/runtime/entity/models/DashboardRequestModels.js +0 -268
  154. package/dist/runtime/entity/models/DashboardResponseModels.js +0 -187
  155. package/dist/runtime/entity/models/GamePlayerModels.js +0 -1591
  156. package/dist/runtime/entity/models/GamePlayerRequestModels.js +0 -1360
  157. package/dist/runtime/entity/models/GamePlayerResponseModels.js +0 -369
  158. package/dist/runtime/entity/models/GenericModels.js +0 -177
  159. package/dist/runtime/entity/models/GroupModels.js +0 -1139
  160. package/dist/runtime/entity/models/GroupRequestModels.js +0 -1048
  161. package/dist/runtime/entity/models/GroupResponseModels.js +0 -285
  162. package/dist/runtime/entity/models/InventoryModels.js +0 -915
  163. package/dist/runtime/entity/models/InventoryRequestModels.js +0 -892
  164. package/dist/runtime/entity/models/InventoryResponseModels.js +0 -243
  165. package/dist/runtime/entity/models/MasterPlayerModels.js +0 -2573
  166. package/dist/runtime/entity/models/MasterPlayerRequestModels.js +0 -2228
  167. package/dist/runtime/entity/models/MasterPlayerResponseModels.js +0 -607
  168. package/dist/runtime/entity/models/MultiplayerModels.js +0 -404
  169. package/dist/runtime/entity/models/MultiplayerRequestModels.js +0 -268
  170. package/dist/runtime/entity/models/MultiplayerResponseModels.js +0 -75
  171. package/dist/runtime/entity/models/StoreInventoryModels.js +0 -797
  172. package/dist/runtime/entity/models/StoreInventoryRequestModels.js +0 -372
  173. package/dist/runtime/entity/models/StoreInventoryResponseModels.js +0 -103
  174. package/dist/runtime/entity/request/CustomOperationRequest.js +0 -24
  175. package/dist/runtime/entity/response/CustomOperationResponse.js +0 -29
  176. package/dist/runtime/entity/response/GetAuthInfoResponse.js +0 -2
  177. package/dist/runtime/entity/response/UploadFileResponse.js +0 -2
  178. package/dist/runtime/helper/CodeHelper.js +0 -63
  179. package/dist/runtime/helper/ConverterService.js +0 -275
  180. package/dist/runtime/helper/EnumUtility.js +0 -33
  181. package/dist/runtime/helper/GNSupport.js +0 -8
  182. package/dist/runtime/helper/GNUtils.js +0 -72
  183. package/dist/runtime/helper/MessagePackConverterService.js +0 -9
  184. package/dist/runtime/logger/GNDebug.js +0 -29
  185. package/dist/runtime/networking/AuthenticateStatus.js +0 -14
  186. package/dist/runtime/networking/IPeer.js +0 -1
  187. package/dist/runtime/networking/NetworkingPeer.js +0 -178
  188. package/dist/runtime/networking/OperationPending.js +0 -53
  189. package/dist/runtime/networking/PeerBase.js +0 -161
  190. package/dist/runtime/networking/handler/IServerEventHandler.js +0 -13
  191. package/dist/runtime/networking/handler/OnCharacterPlayerFriendUpdateEventHandler.js +0 -39
  192. package/dist/runtime/networking/handler/OnCharacterPlayerGroupUpdateEventHandler.js +0 -39
  193. package/dist/runtime/networking/handler/OnGamePlayerFriendUpdateEventHandler.js +0 -39
  194. package/dist/runtime/networking/handler/OnGamePlayerGroupUpdateEventHandler.js +0 -39
  195. package/dist/runtime/networking/handler/OnGroupMemberUpdateEventHandler.js +0 -35
  196. package/dist/runtime/networking/handler/OnGroupMessageUpdateEventHandler.js +0 -43
  197. package/dist/runtime/networking/http/HttpPeer.js +0 -122
  198. package/dist/runtime/networking/http/NetworkingHttpPeerBase.js +0 -6
  199. package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.js +0 -164
  200. package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.js +0 -130
  201. package/dist/runtime/networking/socket/NetworkingSocketPeerBase.js +0 -165
  202. package/dist/runtime/networking/socket/SocketPeer.js +0 -115
  203. package/dist/runtime/typescript/ServiceUpdate.js +0 -12
@@ -0,0 +1,1475 @@
1
+ {
2
+ "requestType": "Authenticate",
3
+ "operations": [
4
+ {
5
+ "operationCode": "LoginByAccount",
6
+ "details": [
7
+ {
8
+ "role": "Client",
9
+ "requestData": [
10
+ {
11
+ "code": "Username",
12
+ "description": "The username used for account authentication.",
13
+ "optional": false,
14
+ "type": "string",
15
+ "gnType": "String",
16
+ "conditions": {
17
+ "mustNonNull": true,
18
+ "minLength": 6,
19
+ "maxLength": 32
20
+ }
21
+ },
22
+ {
23
+ "code": "Password",
24
+ "description": "The password associated with the username.",
25
+ "optional": false,
26
+ "type": "string",
27
+ "gnType": "String",
28
+ "conditions": {
29
+ "mustNonNull": true,
30
+ "minLength": 6,
31
+ "maxLength": 64
32
+ }
33
+ },
34
+ {
35
+ "code": "InfoRequestParam",
36
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
37
+ "optional": false,
38
+ "type": "InfoRequestParam",
39
+ "gnType": "GNHashtable",
40
+ "conditions": {
41
+ "mustNonNull": true
42
+ }
43
+ }
44
+ ]
45
+ }
46
+ ],
47
+ "responseData": [
48
+ {
49
+ "code": "ErrorCode",
50
+ "value": [
51
+ "AccountNotFound",
52
+ "AccountPasswordWrong",
53
+ "Ok"
54
+ ]
55
+ },
56
+ {
57
+ "code": "UserId"
58
+ },
59
+ {
60
+ "code": "InfoResponseParameters"
61
+ }
62
+ ],
63
+ "description": "Authenticate using a username and password.",
64
+ "operationResponse": "AuthenticateResponseData"
65
+ },
66
+ {
67
+ "operationCode": "LoginByAndroidDeviceId",
68
+ "details": [
69
+ {
70
+ "role": "Client",
71
+ "requestData": [
72
+ {
73
+ "code": "AndroidDeviceId",
74
+ "description": "The device ID of the Android device.",
75
+ "optional": false,
76
+ "type": "string",
77
+ "gnType": "String",
78
+ "conditions": {
79
+ "mustNonNull": true,
80
+ "minLength": 6,
81
+ "maxLength": 64
82
+ }
83
+ },
84
+ {
85
+ "code": "CreatePlayerIfNotExists",
86
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
87
+ "optional": true,
88
+ "type": "boolean",
89
+ "gnType": "Boolean",
90
+ "defaultValue": "false",
91
+ "conditions": {}
92
+ },
93
+ {
94
+ "code": "InfoRequestParam",
95
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
96
+ "optional": false,
97
+ "type": "InfoRequestParam",
98
+ "gnType": "GNHashtable",
99
+ "conditions": {
100
+ "mustNonNull": true
101
+ }
102
+ }
103
+ ]
104
+ }
105
+ ],
106
+ "responseData": [
107
+ {
108
+ "code": "ErrorCode",
109
+ "value": [
110
+ "AccountNotFound",
111
+ "Ok"
112
+ ]
113
+ },
114
+ {
115
+ "code": "NewlyCreated"
116
+ },
117
+ {
118
+ "code": "UserId"
119
+ },
120
+ {
121
+ "code": "InfoResponseParameters"
122
+ }
123
+ ],
124
+ "description": "Authenticate using an Android device ID.",
125
+ "operationResponse": "AuthenticateResponseData"
126
+ },
127
+ {
128
+ "operationCode": "LoginByApple",
129
+ "details": [
130
+ {
131
+ "role": "Client",
132
+ "requestData": [
133
+ {
134
+ "code": "Token",
135
+ "description": "Authentication token from the identity provider.",
136
+ "optional": false,
137
+ "type": "string",
138
+ "gnType": "String",
139
+ "conditions": {
140
+ "mustNonNull": true,
141
+ "minLength": 32,
142
+ "maxLength": 2048
143
+ }
144
+ },
145
+ {
146
+ "code": "CreatePlayerIfNotExists",
147
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
148
+ "optional": true,
149
+ "type": "boolean",
150
+ "gnType": "Boolean",
151
+ "defaultValue": "false",
152
+ "conditions": {}
153
+ },
154
+ {
155
+ "code": "InfoRequestParam",
156
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
157
+ "optional": false,
158
+ "type": "InfoRequestParam",
159
+ "gnType": "GNHashtable",
160
+ "conditions": {
161
+ "mustNonNull": true
162
+ }
163
+ }
164
+ ]
165
+ }
166
+ ],
167
+ "responseData": [
168
+ {
169
+ "code": "ErrorCode",
170
+ "value": [
171
+ "VerifyTokenError",
172
+ "AccountNotFound",
173
+ "Ok"
174
+ ]
175
+ },
176
+ {
177
+ "code": "NewlyCreated"
178
+ },
179
+ {
180
+ "code": "UserId"
181
+ },
182
+ {
183
+ "code": "InfoResponseParameters"
184
+ }
185
+ ],
186
+ "description": "Authenticate using an Apple sign-in token.",
187
+ "operationResponse": "AuthenticateResponseData"
188
+ },
189
+ {
190
+ "operationCode": "LoginByCustomDeviceId",
191
+ "details": [
192
+ {
193
+ "role": "Client",
194
+ "requestData": [
195
+ {
196
+ "code": "CustomDeviceId",
197
+ "description": "A developer-defined device identifier.",
198
+ "optional": false,
199
+ "type": "string",
200
+ "gnType": "String",
201
+ "conditions": {
202
+ "mustNonNull": true,
203
+ "minLength": 6,
204
+ "maxLength": 64
205
+ }
206
+ },
207
+ {
208
+ "code": "CreatePlayerIfNotExists",
209
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
210
+ "optional": true,
211
+ "type": "boolean",
212
+ "gnType": "Boolean",
213
+ "defaultValue": "false",
214
+ "conditions": {}
215
+ },
216
+ {
217
+ "code": "InfoRequestParam",
218
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
219
+ "optional": false,
220
+ "type": "InfoRequestParam",
221
+ "gnType": "GNHashtable",
222
+ "conditions": {
223
+ "mustNonNull": true
224
+ }
225
+ }
226
+ ]
227
+ }
228
+ ],
229
+ "responseData": [
230
+ {
231
+ "code": "ErrorCode",
232
+ "value": [
233
+ "AccountNotFound",
234
+ "Ok"
235
+ ]
236
+ },
237
+ {
238
+ "code": "NewlyCreated"
239
+ },
240
+ {
241
+ "code": "UserId"
242
+ },
243
+ {
244
+ "code": "InfoResponseParameters"
245
+ }
246
+ ],
247
+ "description": "Authenticate using a custom device ID.",
248
+ "operationResponse": "AuthenticateResponseData"
249
+ },
250
+ {
251
+ "operationCode": "LoginByCustomId",
252
+ "details": [
253
+ {
254
+ "role": "Client",
255
+ "requestData": [
256
+ {
257
+ "code": "CustomId",
258
+ "description": "A developer-defined custom user ID.",
259
+ "optional": false,
260
+ "type": "string",
261
+ "gnType": "String",
262
+ "conditions": {
263
+ "mustNonNull": true,
264
+ "minLength": 6,
265
+ "maxLength": 64
266
+ }
267
+ },
268
+ {
269
+ "code": "CreatePlayerIfNotExists",
270
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
271
+ "optional": true,
272
+ "type": "boolean",
273
+ "gnType": "Boolean",
274
+ "defaultValue": "false",
275
+ "conditions": {}
276
+ },
277
+ {
278
+ "code": "InfoRequestParam",
279
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
280
+ "optional": false,
281
+ "type": "InfoRequestParam",
282
+ "gnType": "GNHashtable",
283
+ "conditions": {
284
+ "mustNonNull": true
285
+ }
286
+ }
287
+ ]
288
+ }
289
+ ],
290
+ "responseData": [
291
+ {
292
+ "code": "ErrorCode",
293
+ "value": [
294
+ "AccountNotFound",
295
+ "Ok"
296
+ ]
297
+ },
298
+ {
299
+ "code": "NewlyCreated"
300
+ },
301
+ {
302
+ "code": "UserId"
303
+ },
304
+ {
305
+ "code": "InfoResponseParameters"
306
+ }
307
+ ],
308
+ "description": "Authenticate using a custom user-defined ID.",
309
+ "operationResponse": "AuthenticateResponseData"
310
+ },
311
+ {
312
+ "operationCode": "LoginByEditorDeviceId",
313
+ "details": [
314
+ {
315
+ "role": "Client",
316
+ "requestData": [
317
+ {
318
+ "code": "EditorDeviceId",
319
+ "description": "The unique device ID from the Unity Editor.",
320
+ "optional": false,
321
+ "type": "string",
322
+ "gnType": "String",
323
+ "conditions": {
324
+ "mustNonNull": true,
325
+ "minLength": 6,
326
+ "maxLength": 64
327
+ }
328
+ },
329
+ {
330
+ "code": "CreatePlayerIfNotExists",
331
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
332
+ "optional": true,
333
+ "type": "boolean",
334
+ "gnType": "Boolean",
335
+ "defaultValue": "false",
336
+ "conditions": {}
337
+ },
338
+ {
339
+ "code": "InfoRequestParam",
340
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
341
+ "optional": false,
342
+ "type": "InfoRequestParam",
343
+ "gnType": "GNHashtable",
344
+ "conditions": {
345
+ "mustNonNull": true
346
+ }
347
+ }
348
+ ]
349
+ }
350
+ ],
351
+ "responseData": [
352
+ {
353
+ "code": "ErrorCode",
354
+ "value": [
355
+ "AccountNotFound",
356
+ "Ok"
357
+ ]
358
+ },
359
+ {
360
+ "code": "NewlyCreated"
361
+ },
362
+ {
363
+ "code": "UserId"
364
+ },
365
+ {
366
+ "code": "InfoResponseParameters"
367
+ }
368
+ ],
369
+ "description": "Authenticate using a Unity Editor device ID.",
370
+ "operationResponse": "AuthenticateResponseData"
371
+ },
372
+ {
373
+ "operationCode": "LoginByFacebook",
374
+ "details": [
375
+ {
376
+ "role": "Client",
377
+ "requestData": [
378
+ {
379
+ "code": "Token",
380
+ "description": "Authentication token from the identity provider.",
381
+ "optional": false,
382
+ "type": "string",
383
+ "gnType": "String",
384
+ "conditions": {
385
+ "mustNonNull": true,
386
+ "minLength": 32,
387
+ "maxLength": 2048
388
+ }
389
+ },
390
+ {
391
+ "code": "CreatePlayerIfNotExists",
392
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
393
+ "optional": true,
394
+ "type": "boolean",
395
+ "gnType": "Boolean",
396
+ "defaultValue": "false",
397
+ "conditions": {}
398
+ },
399
+ {
400
+ "code": "InfoRequestParam",
401
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
402
+ "optional": false,
403
+ "type": "InfoRequestParam",
404
+ "gnType": "GNHashtable",
405
+ "conditions": {
406
+ "mustNonNull": true
407
+ }
408
+ }
409
+ ]
410
+ }
411
+ ],
412
+ "responseData": [
413
+ {
414
+ "code": "ErrorCode",
415
+ "value": [
416
+ "VerifyTokenError",
417
+ "AccountNotFound",
418
+ "Ok"
419
+ ]
420
+ },
421
+ {
422
+ "code": "NewlyCreated"
423
+ },
424
+ {
425
+ "code": "UserId"
426
+ },
427
+ {
428
+ "code": "InfoResponseParameters"
429
+ }
430
+ ],
431
+ "description": "Authenticate using a Facebook access token.",
432
+ "operationResponse": "AuthenticateResponseData"
433
+ },
434
+ {
435
+ "operationCode": "LoginByGameCenter",
436
+ "details": [
437
+ {
438
+ "role": "Client",
439
+ "requestData": [
440
+ {
441
+ "code": "PlayerId",
442
+ "description": "The Game Center player ID.",
443
+ "optional": false,
444
+ "type": "string",
445
+ "gnType": "String",
446
+ "conditions": {
447
+ "mustNonNull": true,
448
+ "minLength": 2,
449
+ "maxLength": 64
450
+ }
451
+ },
452
+ {
453
+ "code": "Name",
454
+ "description": "The Game Center player's display name.",
455
+ "optional": false,
456
+ "type": "string",
457
+ "gnType": "String",
458
+ "conditions": {
459
+ "mustNonNull": true,
460
+ "minLength": 2,
461
+ "maxLength": 128
462
+ }
463
+ },
464
+ {
465
+ "code": "PublicKeyUrl",
466
+ "description": "The URL to the Game Center public key.",
467
+ "optional": false,
468
+ "type": "string",
469
+ "gnType": "String",
470
+ "conditions": {
471
+ "mustNonNull": true,
472
+ "minLength": 2,
473
+ "maxLength": 2048
474
+ }
475
+ },
476
+ {
477
+ "code": "Signature",
478
+ "description": "The Game Center signature string.",
479
+ "optional": false,
480
+ "type": "string",
481
+ "gnType": "String",
482
+ "conditions": {
483
+ "mustNonNull": true,
484
+ "minLength": 2,
485
+ "maxLength": 2048
486
+ }
487
+ },
488
+ {
489
+ "code": "Salt",
490
+ "description": "The cryptographic salt from Game Center.",
491
+ "optional": false,
492
+ "type": "string",
493
+ "gnType": "String",
494
+ "conditions": {
495
+ "mustNonNull": true,
496
+ "minLength": 2,
497
+ "maxLength": 256
498
+ }
499
+ },
500
+ {
501
+ "code": "Timestamp",
502
+ "description": "The timestamp used for Game Center verification.",
503
+ "optional": false,
504
+ "type": "number",
505
+ "gnType": "Number",
506
+ "conditions": {}
507
+ },
508
+ {
509
+ "code": "CreatePlayerIfNotExists",
510
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
511
+ "optional": true,
512
+ "type": "boolean",
513
+ "gnType": "Boolean",
514
+ "defaultValue": "false",
515
+ "conditions": {}
516
+ },
517
+ {
518
+ "code": "InfoRequestParam",
519
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
520
+ "optional": false,
521
+ "type": "InfoRequestParam",
522
+ "gnType": "GNHashtable",
523
+ "conditions": {
524
+ "mustNonNull": true
525
+ }
526
+ }
527
+ ]
528
+ }
529
+ ],
530
+ "responseData": [
531
+ {
532
+ "code": "ErrorCode",
533
+ "value": [
534
+ "VerifyTokenError",
535
+ "AccountNotFound",
536
+ "Ok"
537
+ ]
538
+ },
539
+ {
540
+ "code": "NewlyCreated"
541
+ },
542
+ {
543
+ "code": "UserId"
544
+ },
545
+ {
546
+ "code": "InfoResponseParameters"
547
+ }
548
+ ],
549
+ "description": "Authenticate using Apple Game Center credentials.",
550
+ "operationResponse": "AuthenticateResponseData"
551
+ },
552
+ {
553
+ "operationCode": "LoginByGenericService",
554
+ "details": [
555
+ {
556
+ "role": "Client",
557
+ "requestData": [
558
+ {
559
+ "code": "ServiceName",
560
+ "description": "The name of the external generic service.",
561
+ "optional": false,
562
+ "type": "string",
563
+ "gnType": "String",
564
+ "conditions": {
565
+ "mustNonNull": true,
566
+ "minLength": 6,
567
+ "maxLength": 32
568
+ }
569
+ },
570
+ {
571
+ "code": "ServiceData",
572
+ "description": "The payload or authentication data from the external service.",
573
+ "optional": false,
574
+ "type": "GNHashtable",
575
+ "gnType": "GNHashtable",
576
+ "conditions": {
577
+ "mustNonNull": true
578
+ }
579
+ },
580
+ {
581
+ "code": "CreatePlayerIfNotExists",
582
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
583
+ "optional": true,
584
+ "type": "boolean",
585
+ "gnType": "Boolean",
586
+ "defaultValue": "false",
587
+ "conditions": {}
588
+ },
589
+ {
590
+ "code": "InfoRequestParam",
591
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
592
+ "optional": false,
593
+ "type": "InfoRequestParam",
594
+ "gnType": "GNHashtable",
595
+ "conditions": {
596
+ "mustNonNull": true
597
+ }
598
+ }
599
+ ]
600
+ }
601
+ ],
602
+ "responseData": [
603
+ {
604
+ "code": "ErrorCode",
605
+ "value": [
606
+ "VerifyFailed",
607
+ "AccountNotFound",
608
+ "Ok"
609
+ ]
610
+ },
611
+ {
612
+ "code": "ErrorMessage"
613
+ },
614
+ {
615
+ "code": "NewlyCreated"
616
+ },
617
+ {
618
+ "code": "UserId"
619
+ },
620
+ {
621
+ "code": "InfoResponseParameters"
622
+ }
623
+ ],
624
+ "description": "Authenticate using a generic external service and custom data.",
625
+ "operationResponse": "GenericServiceAuthenticateResponseData"
626
+ },
627
+ {
628
+ "operationCode": "LoginByGooglePlayGameService",
629
+ "details": [
630
+ {
631
+ "role": "Client",
632
+ "requestData": [
633
+ {
634
+ "code": "Token",
635
+ "description": "Authentication token from the identity provider.",
636
+ "optional": false,
637
+ "type": "string",
638
+ "gnType": "String",
639
+ "conditions": {
640
+ "mustNonNull": true,
641
+ "minLength": 32,
642
+ "maxLength": 2048
643
+ }
644
+ },
645
+ {
646
+ "code": "CreatePlayerIfNotExists",
647
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
648
+ "optional": true,
649
+ "type": "boolean",
650
+ "gnType": "Boolean",
651
+ "defaultValue": "false",
652
+ "conditions": {}
653
+ },
654
+ {
655
+ "code": "InfoRequestParam",
656
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
657
+ "optional": false,
658
+ "type": "InfoRequestParam",
659
+ "gnType": "GNHashtable",
660
+ "conditions": {
661
+ "mustNonNull": true
662
+ }
663
+ }
664
+ ]
665
+ }
666
+ ],
667
+ "responseData": [
668
+ {
669
+ "code": "ErrorCode",
670
+ "value": [
671
+ "VerifyTokenError",
672
+ "AccountNotFound",
673
+ "Ok"
674
+ ]
675
+ },
676
+ {
677
+ "code": "NewlyCreated"
678
+ },
679
+ {
680
+ "code": "UserId"
681
+ },
682
+ {
683
+ "code": "InfoResponseParameters"
684
+ }
685
+ ],
686
+ "description": "Authenticate using a Google Play Games Services token.",
687
+ "operationResponse": "AuthenticateResponseData"
688
+ },
689
+ {
690
+ "operationCode": "LoginByGoogle",
691
+ "details": [
692
+ {
693
+ "role": "Client",
694
+ "requestData": [
695
+ {
696
+ "code": "Token",
697
+ "description": "Authentication token from the identity provider.",
698
+ "optional": false,
699
+ "type": "string",
700
+ "gnType": "String",
701
+ "conditions": {
702
+ "mustNonNull": true,
703
+ "minLength": 32,
704
+ "maxLength": 2048
705
+ }
706
+ },
707
+ {
708
+ "code": "Type",
709
+ "description": "The login method type used by Google services.",
710
+ "optional": false,
711
+ "type": "number",
712
+ "gnType": "Number",
713
+ "conditions": {
714
+ "mustInt": true,
715
+ "minValue": 1,
716
+ "maxValue": 2
717
+ }
718
+ },
719
+ {
720
+ "code": "CreatePlayerIfNotExists",
721
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
722
+ "optional": true,
723
+ "type": "boolean",
724
+ "gnType": "Boolean",
725
+ "defaultValue": "false",
726
+ "conditions": {}
727
+ },
728
+ {
729
+ "code": "InfoRequestParam",
730
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
731
+ "optional": false,
732
+ "type": "InfoRequestParam",
733
+ "gnType": "GNHashtable",
734
+ "conditions": {
735
+ "mustNonNull": true
736
+ }
737
+ }
738
+ ]
739
+ }
740
+ ],
741
+ "responseData": [
742
+ {
743
+ "code": "ErrorCode",
744
+ "value": [
745
+ "VerifyTokenError",
746
+ "AccountNotFound",
747
+ "Ok"
748
+ ]
749
+ },
750
+ {
751
+ "code": "NewlyCreated"
752
+ },
753
+ {
754
+ "code": "UserId"
755
+ },
756
+ {
757
+ "code": "InfoResponseParameters"
758
+ }
759
+ ],
760
+ "description": "Authenticate using a Google access token.",
761
+ "operationResponse": "AuthenticateResponseData"
762
+ },
763
+ {
764
+ "operationCode": "LoginByiOSDeviceId",
765
+ "details": [
766
+ {
767
+ "role": "Client",
768
+ "requestData": [
769
+ {
770
+ "code": "iOSDeviceId",
771
+ "description": "The iOS device identifier.",
772
+ "optional": false,
773
+ "type": "string",
774
+ "gnType": "String",
775
+ "conditions": {
776
+ "mustNonNull": true,
777
+ "minLength": 6,
778
+ "maxLength": 64
779
+ }
780
+ },
781
+ {
782
+ "code": "CreatePlayerIfNotExists",
783
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
784
+ "optional": true,
785
+ "type": "boolean",
786
+ "gnType": "Boolean",
787
+ "defaultValue": "false",
788
+ "conditions": {}
789
+ },
790
+ {
791
+ "code": "InfoRequestParam",
792
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
793
+ "optional": false,
794
+ "type": "InfoRequestParam",
795
+ "gnType": "GNHashtable",
796
+ "conditions": {
797
+ "mustNonNull": true
798
+ }
799
+ }
800
+ ]
801
+ }
802
+ ],
803
+ "responseData": [
804
+ {
805
+ "code": "ErrorCode",
806
+ "value": [
807
+ "AccountNotFound",
808
+ "Ok"
809
+ ]
810
+ },
811
+ {
812
+ "code": "NewlyCreated"
813
+ },
814
+ {
815
+ "code": "UserId"
816
+ },
817
+ {
818
+ "code": "InfoResponseParameters"
819
+ }
820
+ ],
821
+ "description": "Authenticate using an iOS device ID.",
822
+ "operationResponse": "AuthenticateResponseData"
823
+ },
824
+ {
825
+ "operationCode": "LoginByLinuxDeviceId",
826
+ "details": [
827
+ {
828
+ "role": "Client",
829
+ "requestData": [
830
+ {
831
+ "code": "LinuxDeviceId",
832
+ "description": "The Linux device identifier.",
833
+ "optional": false,
834
+ "type": "string",
835
+ "gnType": "String",
836
+ "conditions": {
837
+ "mustNonNull": true,
838
+ "minLength": 6,
839
+ "maxLength": 64
840
+ }
841
+ },
842
+ {
843
+ "code": "CreatePlayerIfNotExists",
844
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
845
+ "optional": true,
846
+ "type": "boolean",
847
+ "gnType": "Boolean",
848
+ "defaultValue": "false",
849
+ "conditions": {}
850
+ },
851
+ {
852
+ "code": "InfoRequestParam",
853
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
854
+ "optional": false,
855
+ "type": "InfoRequestParam",
856
+ "gnType": "GNHashtable",
857
+ "conditions": {
858
+ "mustNonNull": true
859
+ }
860
+ }
861
+ ]
862
+ }
863
+ ],
864
+ "responseData": [
865
+ {
866
+ "code": "ErrorCode",
867
+ "value": [
868
+ "AccountNotFound",
869
+ "Ok"
870
+ ]
871
+ },
872
+ {
873
+ "code": "NewlyCreated"
874
+ },
875
+ {
876
+ "code": "UserId"
877
+ },
878
+ {
879
+ "code": "InfoResponseParameters"
880
+ }
881
+ ],
882
+ "description": "Authenticate using a Linux device ID.",
883
+ "operationResponse": "AuthenticateResponseData"
884
+ },
885
+ {
886
+ "operationCode": "LoginByMacOSDeviceId",
887
+ "details": [
888
+ {
889
+ "role": "Client",
890
+ "requestData": [
891
+ {
892
+ "code": "MacOSDeviceId",
893
+ "description": "The macOS device identifier.",
894
+ "optional": false,
895
+ "type": "string",
896
+ "gnType": "String",
897
+ "conditions": {
898
+ "mustNonNull": true,
899
+ "minLength": 6,
900
+ "maxLength": 64
901
+ }
902
+ },
903
+ {
904
+ "code": "CreatePlayerIfNotExists",
905
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
906
+ "optional": true,
907
+ "type": "boolean",
908
+ "gnType": "Boolean",
909
+ "defaultValue": "false",
910
+ "conditions": {}
911
+ },
912
+ {
913
+ "code": "InfoRequestParam",
914
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
915
+ "optional": false,
916
+ "type": "InfoRequestParam",
917
+ "gnType": "GNHashtable",
918
+ "conditions": {
919
+ "mustNonNull": true
920
+ }
921
+ }
922
+ ]
923
+ }
924
+ ],
925
+ "responseData": [
926
+ {
927
+ "code": "ErrorCode",
928
+ "value": [
929
+ "AccountNotFound",
930
+ "Ok"
931
+ ]
932
+ },
933
+ {
934
+ "code": "NewlyCreated"
935
+ },
936
+ {
937
+ "code": "UserId"
938
+ },
939
+ {
940
+ "code": "InfoResponseParameters"
941
+ }
942
+ ],
943
+ "description": "Authenticate using a macOS device ID.",
944
+ "operationResponse": "AuthenticateResponseData"
945
+ },
946
+ {
947
+ "operationCode": "LoginByWindowsDeviceId",
948
+ "details": [
949
+ {
950
+ "role": "Client",
951
+ "requestData": [
952
+ {
953
+ "code": "WindowsDeviceId",
954
+ "description": "The Windows device identifier.",
955
+ "optional": false,
956
+ "type": "string",
957
+ "gnType": "String",
958
+ "conditions": {
959
+ "mustNonNull": true,
960
+ "minLength": 6,
961
+ "maxLength": 64
962
+ }
963
+ },
964
+ {
965
+ "code": "CreatePlayerIfNotExists",
966
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
967
+ "optional": true,
968
+ "type": "boolean",
969
+ "gnType": "Boolean",
970
+ "defaultValue": "false",
971
+ "conditions": {}
972
+ },
973
+ {
974
+ "code": "InfoRequestParam",
975
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
976
+ "optional": false,
977
+ "type": "InfoRequestParam",
978
+ "gnType": "GNHashtable",
979
+ "conditions": {
980
+ "mustNonNull": true
981
+ }
982
+ }
983
+ ]
984
+ }
985
+ ],
986
+ "responseData": [
987
+ {
988
+ "code": "ErrorCode",
989
+ "value": [
990
+ "AccountNotFound",
991
+ "Ok"
992
+ ]
993
+ },
994
+ {
995
+ "code": "NewlyCreated"
996
+ },
997
+ {
998
+ "code": "UserId"
999
+ },
1000
+ {
1001
+ "code": "InfoResponseParameters"
1002
+ }
1003
+ ],
1004
+ "description": "Authenticate using a Windows device ID.",
1005
+ "operationResponse": "AuthenticateResponseData"
1006
+ },
1007
+ {
1008
+ "operationCode": "LoginByWindowsPhoneDeviceId",
1009
+ "details": [
1010
+ {
1011
+ "role": "Client",
1012
+ "requestData": [
1013
+ {
1014
+ "code": "WindowsPhoneDeviceId",
1015
+ "description": "The Windows Phone device identifier.",
1016
+ "optional": false,
1017
+ "type": "string",
1018
+ "gnType": "String",
1019
+ "conditions": {
1020
+ "mustNonNull": true,
1021
+ "minLength": 6,
1022
+ "maxLength": 64
1023
+ }
1024
+ },
1025
+ {
1026
+ "code": "CreatePlayerIfNotExists",
1027
+ "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
1028
+ "optional": true,
1029
+ "type": "boolean",
1030
+ "gnType": "Boolean",
1031
+ "defaultValue": "false",
1032
+ "conditions": {}
1033
+ },
1034
+ {
1035
+ "code": "InfoRequestParam",
1036
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
1037
+ "optional": false,
1038
+ "type": "InfoRequestParam",
1039
+ "gnType": "GNHashtable",
1040
+ "conditions": {
1041
+ "mustNonNull": true
1042
+ }
1043
+ }
1044
+ ]
1045
+ }
1046
+ ],
1047
+ "responseData": [
1048
+ {
1049
+ "code": "ErrorCode",
1050
+ "value": [
1051
+ "AccountNotFound",
1052
+ "Ok"
1053
+ ]
1054
+ },
1055
+ {
1056
+ "code": "NewlyCreated"
1057
+ },
1058
+ {
1059
+ "code": "UserId"
1060
+ },
1061
+ {
1062
+ "code": "InfoResponseParameters"
1063
+ }
1064
+ ],
1065
+ "description": "Authenticate using a Windows Phone device ID.",
1066
+ "operationResponse": "AuthenticateResponseData"
1067
+ },
1068
+ {
1069
+ "operationCode": "RefreshAuthToken",
1070
+ "details": [],
1071
+ "responseData": [
1072
+ {
1073
+ "code": "ErrorCode",
1074
+ "value": [
1075
+ "AccountNotFound",
1076
+ "PlayerBan",
1077
+ "Ok"
1078
+ ]
1079
+ },
1080
+ {
1081
+ "code": "PlayerBan"
1082
+ },
1083
+ {
1084
+ "code": "AuthToken"
1085
+ }
1086
+ ],
1087
+ "description": "Refresh the user's authentication token.",
1088
+ "operationResponse": "RefreshAuthTokenResponseData"
1089
+ },
1090
+ {
1091
+ "operationCode": "RegisterAccount",
1092
+ "details": [
1093
+ {
1094
+ "role": "Client",
1095
+ "requestData": [
1096
+ {
1097
+ "code": "Username",
1098
+ "description": "The username used for account authentication.",
1099
+ "optional": false,
1100
+ "type": "string",
1101
+ "gnType": "String",
1102
+ "conditions": {
1103
+ "mustNonNull": true,
1104
+ "minLength": 6,
1105
+ "maxLength": 32
1106
+ }
1107
+ },
1108
+ {
1109
+ "code": "Password",
1110
+ "description": "The password associated with the username.",
1111
+ "optional": false,
1112
+ "type": "string",
1113
+ "gnType": "String",
1114
+ "conditions": {
1115
+ "mustNonNull": true,
1116
+ "minLength": 6,
1117
+ "maxLength": 64
1118
+ }
1119
+ },
1120
+ {
1121
+ "code": "InfoRequestParam",
1122
+ "description": "Flags and filters that specify which additional profile fields to include in the response.",
1123
+ "optional": false,
1124
+ "type": "InfoRequestParam",
1125
+ "gnType": "GNHashtable",
1126
+ "conditions": {
1127
+ "mustNonNull": true
1128
+ }
1129
+ }
1130
+ ]
1131
+ }
1132
+ ],
1133
+ "responseData": [
1134
+ {
1135
+ "code": "ErrorCode",
1136
+ "value": [
1137
+ "AccountUsernameExists",
1138
+ "Ok"
1139
+ ]
1140
+ },
1141
+ {
1142
+ "code": "UserId"
1143
+ },
1144
+ {
1145
+ "code": "InfoResponseParameters"
1146
+ },
1147
+ {
1148
+ "code": "NewlyCreated"
1149
+ }
1150
+ ],
1151
+ "description": "Register a new account using a username and password.",
1152
+ "operationResponse": "AuthenticateResponseData"
1153
+ }
1154
+ ],
1155
+ "models": [
1156
+ {
1157
+ "name": "InfoRequestParam",
1158
+ "details": [
1159
+ {
1160
+ "code": "External",
1161
+ "description": "Include external ID information. Defaults to false.",
1162
+ "optional": true,
1163
+ "type": "boolean",
1164
+ "gnType": "Boolean",
1165
+ "defaultValue": "false",
1166
+ "conditions": {}
1167
+ },
1168
+ {
1169
+ "code": "Segments",
1170
+ "description": "Include segment membership data. Defaults to false.",
1171
+ "optional": true,
1172
+ "type": "boolean",
1173
+ "gnType": "Boolean",
1174
+ "defaultValue": "false",
1175
+ "conditions": {}
1176
+ },
1177
+ {
1178
+ "code": "CustomDatas",
1179
+ "description": "Include custom data values. Defaults to false.",
1180
+ "optional": true,
1181
+ "type": "boolean",
1182
+ "gnType": "Boolean",
1183
+ "defaultValue": "false",
1184
+ "conditions": {}
1185
+ },
1186
+ {
1187
+ "code": "DisplayName",
1188
+ "description": "Include the player's display name. Defaults to false.",
1189
+ "optional": true,
1190
+ "type": "boolean",
1191
+ "gnType": "Boolean",
1192
+ "defaultValue": "false",
1193
+ "conditions": {}
1194
+ },
1195
+ {
1196
+ "code": "Avatar",
1197
+ "description": "Include the player's avatar data. Defaults to false.",
1198
+ "optional": true,
1199
+ "type": "boolean",
1200
+ "gnType": "Boolean",
1201
+ "defaultValue": "false",
1202
+ "conditions": {}
1203
+ },
1204
+ {
1205
+ "code": "TsCreate",
1206
+ "description": "Include the account creation timestamp. Defaults to false.",
1207
+ "optional": true,
1208
+ "type": "boolean",
1209
+ "gnType": "Boolean",
1210
+ "defaultValue": "false",
1211
+ "conditions": {}
1212
+ },
1213
+ {
1214
+ "code": "Tags",
1215
+ "description": "Include tag metadata associated with the player. Defaults to false.",
1216
+ "optional": true,
1217
+ "type": "boolean",
1218
+ "gnType": "Boolean",
1219
+ "defaultValue": "false",
1220
+ "conditions": {}
1221
+ },
1222
+ {
1223
+ "code": "PlayerBan",
1224
+ "description": "Include ban status and reasons. Defaults to false.",
1225
+ "optional": true,
1226
+ "type": "boolean",
1227
+ "gnType": "Boolean",
1228
+ "defaultValue": "false",
1229
+ "conditions": {}
1230
+ },
1231
+ {
1232
+ "code": "PlayerCurrencies",
1233
+ "description": " Defaults to false.",
1234
+ "optional": true,
1235
+ "type": "boolean",
1236
+ "gnType": "Boolean",
1237
+ "defaultValue": "false",
1238
+ "conditions": {}
1239
+ },
1240
+ {
1241
+ "code": "PlayerStatistics",
1242
+ "description": " Defaults to false.",
1243
+ "optional": true,
1244
+ "type": "boolean",
1245
+ "gnType": "Boolean",
1246
+ "defaultValue": "false",
1247
+ "conditions": {}
1248
+ },
1249
+ {
1250
+ "code": "PlayerDatas",
1251
+ "description": " Defaults to false.",
1252
+ "optional": true,
1253
+ "type": "boolean",
1254
+ "gnType": "Boolean",
1255
+ "defaultValue": "false",
1256
+ "conditions": {}
1257
+ },
1258
+ {
1259
+ "code": "IpAddressCreate",
1260
+ "description": " Defaults to false.",
1261
+ "optional": true,
1262
+ "type": "boolean",
1263
+ "gnType": "Boolean",
1264
+ "defaultValue": "false",
1265
+ "conditions": {}
1266
+ },
1267
+ {
1268
+ "code": "CountryCode",
1269
+ "description": " Defaults to false.",
1270
+ "optional": true,
1271
+ "type": "boolean",
1272
+ "gnType": "Boolean",
1273
+ "defaultValue": "false",
1274
+ "conditions": {}
1275
+ },
1276
+ {
1277
+ "code": "Email",
1278
+ "description": " Defaults to false.",
1279
+ "optional": true,
1280
+ "type": "boolean",
1281
+ "gnType": "Boolean",
1282
+ "defaultValue": "false",
1283
+ "conditions": {}
1284
+ },
1285
+ {
1286
+ "code": "TsLastLogin",
1287
+ "description": " Defaults to false.",
1288
+ "optional": true,
1289
+ "type": "boolean",
1290
+ "gnType": "Boolean",
1291
+ "defaultValue": "false",
1292
+ "conditions": {}
1293
+ },
1294
+ {
1295
+ "code": "PushNotifications",
1296
+ "description": " Defaults to false.",
1297
+ "optional": true,
1298
+ "type": "boolean",
1299
+ "gnType": "Boolean",
1300
+ "defaultValue": "false",
1301
+ "conditions": {}
1302
+ },
1303
+ {
1304
+ "code": "PlayerDataKeys",
1305
+ "description": "List of player data keys to retrieve.",
1306
+ "optional": true,
1307
+ "type": "string",
1308
+ "gnType": "GNArray",
1309
+ "conditions": {}
1310
+ },
1311
+ {
1312
+ "code": "PlayerCurrencyKeys",
1313
+ "description": "List of player currency keys to retrieve.",
1314
+ "optional": true,
1315
+ "type": "string",
1316
+ "gnType": "GNArray",
1317
+ "conditions": {}
1318
+ },
1319
+ {
1320
+ "code": "PlayerStatisticsKeys",
1321
+ "description": "List of player statistics keys to retrieve.",
1322
+ "optional": true,
1323
+ "type": "string",
1324
+ "gnType": "GNArray",
1325
+ "conditions": {}
1326
+ },
1327
+ {
1328
+ "code": "CustomDataKeys",
1329
+ "description": "List of custom data keys to retrieve.",
1330
+ "optional": true,
1331
+ "type": "string",
1332
+ "gnType": "GNArray",
1333
+ "conditions": {}
1334
+ },
1335
+ {
1336
+ "code": "TagKeys",
1337
+ "description": "List of tag keys to retrieve.",
1338
+ "optional": true,
1339
+ "type": "string",
1340
+ "gnType": "GNArray",
1341
+ "conditions": {}
1342
+ }
1343
+ ],
1344
+ "description": "Flags used to specify which additional fields to return in the player profile response."
1345
+ },
1346
+ {
1347
+ "name": "AuthenticateResponseData",
1348
+ "details": [
1349
+ {
1350
+ "code": "NewlyCreated",
1351
+ "description": "Indicates whether the player account was newly created.",
1352
+ "optional": true,
1353
+ "type": "boolean",
1354
+ "gnType": "Boolean",
1355
+ "conditions": {}
1356
+ },
1357
+ {
1358
+ "code": "AuthToken",
1359
+ "description": "The authentication token issued to the player.",
1360
+ "optional": true,
1361
+ "type": "string",
1362
+ "gnType": "String",
1363
+ "conditions": {}
1364
+ },
1365
+ {
1366
+ "code": "PlayerBan",
1367
+ "description": "Ban status information for the player.",
1368
+ "optional": true,
1369
+ "type": "GenericModels.BanItem",
1370
+ "gnType": "GNHashtable",
1371
+ "conditions": {}
1372
+ },
1373
+ {
1374
+ "code": "UserId",
1375
+ "description": "The unique identifier of the authenticated user.",
1376
+ "optional": false,
1377
+ "type": "string",
1378
+ "gnType": "String",
1379
+ "conditions": {}
1380
+ },
1381
+ {
1382
+ "code": "InfoResponseParameters",
1383
+ "description": "Profile data returned according to InfoRequestParam filters.",
1384
+ "optional": false,
1385
+ "type": "InfoResponseParameters",
1386
+ "gnType": "GNHashtable",
1387
+ "conditions": {}
1388
+ }
1389
+ ],
1390
+ "description": "Response data returned after a successful authentication request."
1391
+ },
1392
+ {
1393
+ "name": "GenericServiceAuthenticateResponseData",
1394
+ "details": [
1395
+ {
1396
+ "code": "ErrorMessage",
1397
+ "description": "Error message returned by the external service, if any.",
1398
+ "optional": true,
1399
+ "type": "string",
1400
+ "gnType": "String",
1401
+ "conditions": {}
1402
+ },
1403
+ {
1404
+ "code": "NewlyCreated",
1405
+ "description": "Indicates whether the player account was newly created.",
1406
+ "optional": true,
1407
+ "type": "boolean",
1408
+ "gnType": "Boolean",
1409
+ "conditions": {}
1410
+ },
1411
+ {
1412
+ "code": "AuthToken",
1413
+ "description": "The authentication token issued to the player.",
1414
+ "optional": true,
1415
+ "type": "string",
1416
+ "gnType": "String",
1417
+ "conditions": {}
1418
+ },
1419
+ {
1420
+ "code": "PlayerBan",
1421
+ "description": "Ban status information for the player.",
1422
+ "optional": true,
1423
+ "type": "GenericModels.BanItem",
1424
+ "gnType": "GNHashtable",
1425
+ "conditions": {}
1426
+ },
1427
+ {
1428
+ "code": "UserId",
1429
+ "description": "The unique identifier of the authenticated user.",
1430
+ "optional": false,
1431
+ "type": "string",
1432
+ "gnType": "String",
1433
+ "conditions": {}
1434
+ },
1435
+ {
1436
+ "code": "InfoResponseParameters",
1437
+ "description": "Profile data returned according to InfoRequestParam filters.",
1438
+ "optional": false,
1439
+ "type": "InfoResponseParameters",
1440
+ "gnType": "GNHashtable",
1441
+ "conditions": {}
1442
+ }
1443
+ ],
1444
+ "description": "Response data from authentication via a generic external service."
1445
+ },
1446
+ {
1447
+ "name": "RefreshAuthTokenResponseData",
1448
+ "details": [
1449
+ {
1450
+ "code": "AuthToken",
1451
+ "description": "The newly issued authentication token.",
1452
+ "optional": true,
1453
+ "type": "string",
1454
+ "gnType": "String",
1455
+ "conditions": {}
1456
+ },
1457
+ {
1458
+ "code": "PlayerBan",
1459
+ "description": "Ban status information for the player.",
1460
+ "optional": true,
1461
+ "type": "GenericModels.BanItem",
1462
+ "gnType": "GNHashtable",
1463
+ "conditions": {}
1464
+ }
1465
+ ],
1466
+ "description": "Response containing the refreshed authentication token."
1467
+ },
1468
+ {
1469
+ "name": "EmptyResponseData",
1470
+ "details": [],
1471
+ "description": "Empty response object used for operations that return no data."
1472
+ }
1473
+ ],
1474
+ "description": "API requests related to user authentication."
1475
+ }