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

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 (201) hide show
  1. package/dist/gearn.js.client.js +46911 -0
  2. package/dist/gearn.js.client.min.js +2 -0
  3. package/dist/gearn.js.client.min.js.LICENSE.txt +14 -0
  4. package/dist/index.js +34189 -337
  5. package/dist/runtime/config/GNServerSettings.d.ts +3 -0
  6. package/dist/runtime/constant/Commands.d.ts +1 -0
  7. package/dist/runtime/networking/http/NetworkingHttpPeerBase.d.ts +2 -0
  8. package/package.json +1 -1
  9. package/dist/runtime/GNNetwork.js +0 -250
  10. package/dist/runtime/GNNetworkAuthenticateApi.js +0 -122
  11. package/dist/runtime/GNNetworkCharacterPlayerApi.js +0 -968
  12. package/dist/runtime/GNNetworkCloudScriptApi.js +0 -104
  13. package/dist/runtime/GNNetworkContentApi.js +0 -140
  14. package/dist/runtime/GNNetworkDashboardApi.js +0 -170
  15. package/dist/runtime/GNNetworkGamePlayerApi.js +0 -950
  16. package/dist/runtime/GNNetworkGroupApi.js +0 -734
  17. package/dist/runtime/GNNetworkInventoryApi.js +0 -626
  18. package/dist/runtime/GNNetworkMasterPlayerApi.js +0 -1550
  19. package/dist/runtime/GNNetworkMultiplayerApi.js +0 -194
  20. package/dist/runtime/GNNetworkStoreInventoryApi.js +0 -266
  21. package/dist/runtime/common/Action0.js +0 -1
  22. package/dist/runtime/common/Action1.js +0 -1
  23. package/dist/runtime/common/Action2.js +0 -1
  24. package/dist/runtime/common/Action3.js +0 -1
  25. package/dist/runtime/common/Action4.js +0 -1
  26. package/dist/runtime/common/GNData.js +0 -211
  27. package/dist/runtime/config/GNServerSettings.js +0 -149
  28. package/dist/runtime/constant/Commands.js +0 -19
  29. package/dist/runtime/constant/EventCode.js +0 -8
  30. package/dist/runtime/constant/OperationCode.js +0 -221
  31. package/dist/runtime/constant/ReturnCode.js +0 -14
  32. package/dist/runtime/constant/enumType/ExecuteResponseStatus.js +0 -8
  33. package/dist/runtime/constant/enumType/FriendStatus.js +0 -7
  34. package/dist/runtime/constant/enumType/GoogleLoginType.js +0 -5
  35. package/dist/runtime/constant/enumType/GroupStatus.js +0 -7
  36. package/dist/runtime/constant/enumType/InvalidMemberType.js +0 -18
  37. package/dist/runtime/constant/enumType/ItemType.js +0 -5
  38. package/dist/runtime/constant/enumType/MatchmakingMemberStatus.js +0 -6
  39. package/dist/runtime/constant/enumType/MatchmakingTicketStatus.js +0 -8
  40. package/dist/runtime/constant/enumType/OwnerType.js +0 -9
  41. package/dist/runtime/constant/enumType/PermissionDataItem.js +0 -5
  42. package/dist/runtime/constant/enumType/PushPlatformType.js +0 -5
  43. package/dist/runtime/constant/enumType/RequestRole.js +0 -6
  44. package/dist/runtime/constant/enumType/RequestType.js +0 -15
  45. package/dist/runtime/constant/enumType/StoreItemType.js +0 -5
  46. package/dist/runtime/constant/enumType/StoreReceiveType.js +0 -8
  47. package/dist/runtime/constant/errorCode/ErrorCode.js +0 -52
  48. package/dist/runtime/constant/parameterCode/ParameterCode.js +0 -617
  49. package/dist/runtime/entity/DataMember.js +0 -208
  50. package/dist/runtime/entity/GNMetadata.js +0 -11
  51. package/dist/runtime/entity/InvalidMember.js +0 -1
  52. package/dist/runtime/entity/OperationEvent.js +0 -24
  53. package/dist/runtime/entity/OperationHelper.js +0 -24
  54. package/dist/runtime/entity/OperationRequest.js +0 -42
  55. package/dist/runtime/entity/OperationResponse.js +0 -73
  56. package/dist/runtime/entity/models/AuthenticateModels.js +0 -426
  57. package/dist/runtime/entity/models/AuthenticateRequestModels.js +0 -188
  58. package/dist/runtime/entity/models/AuthenticateResponseModels.js +0 -131
  59. package/dist/runtime/entity/models/CharacterPlayerModels.js +0 -1433
  60. package/dist/runtime/entity/models/CharacterPlayerRequestModels.js +0 -1386
  61. package/dist/runtime/entity/models/CharacterPlayerResponseModels.js +0 -376
  62. package/dist/runtime/entity/models/CloudScriptModels.js +0 -197
  63. package/dist/runtime/entity/models/CloudScriptRequestModels.js +0 -138
  64. package/dist/runtime/entity/models/CloudScriptResponseModels.js +0 -40
  65. package/dist/runtime/entity/models/ContentModels.js +0 -203
  66. package/dist/runtime/entity/models/ContentRequestModels.js +0 -190
  67. package/dist/runtime/entity/models/ContentResponseModels.js +0 -54
  68. package/dist/runtime/entity/models/DashboardModels.js +0 -3002
  69. package/dist/runtime/entity/models/DashboardRequestModels.js +0 -268
  70. package/dist/runtime/entity/models/DashboardResponseModels.js +0 -187
  71. package/dist/runtime/entity/models/GamePlayerModels.js +0 -1591
  72. package/dist/runtime/entity/models/GamePlayerRequestModels.js +0 -1360
  73. package/dist/runtime/entity/models/GamePlayerResponseModels.js +0 -369
  74. package/dist/runtime/entity/models/GenericModels.js +0 -177
  75. package/dist/runtime/entity/models/GroupModels.js +0 -1135
  76. package/dist/runtime/entity/models/GroupRequestModels.js +0 -1048
  77. package/dist/runtime/entity/models/GroupResponseModels.js +0 -285
  78. package/dist/runtime/entity/models/InventoryModels.js +0 -915
  79. package/dist/runtime/entity/models/InventoryRequestModels.js +0 -892
  80. package/dist/runtime/entity/models/InventoryResponseModels.js +0 -243
  81. package/dist/runtime/entity/models/MasterPlayerModels.js +0 -2573
  82. package/dist/runtime/entity/models/MasterPlayerRequestModels.js +0 -2228
  83. package/dist/runtime/entity/models/MasterPlayerResponseModels.js +0 -607
  84. package/dist/runtime/entity/models/MultiplayerModels.js +0 -404
  85. package/dist/runtime/entity/models/MultiplayerRequestModels.js +0 -268
  86. package/dist/runtime/entity/models/MultiplayerResponseModels.js +0 -75
  87. package/dist/runtime/entity/models/StoreInventoryModels.js +0 -797
  88. package/dist/runtime/entity/models/StoreInventoryRequestModels.js +0 -372
  89. package/dist/runtime/entity/models/StoreInventoryResponseModels.js +0 -103
  90. package/dist/runtime/entity/request/CustomOperationRequest.js +0 -24
  91. package/dist/runtime/entity/response/CustomOperationResponse.js +0 -29
  92. package/dist/runtime/entity/response/GetAuthInfoResponse.js +0 -2
  93. package/dist/runtime/entity/response/UploadFileResponse.js +0 -2
  94. package/dist/runtime/helper/CodeHelper.js +0 -63
  95. package/dist/runtime/helper/ConverterService.js +0 -275
  96. package/dist/runtime/helper/EnumUtility.js +0 -33
  97. package/dist/runtime/helper/GNSupport.js +0 -8
  98. package/dist/runtime/helper/GNUtils.js +0 -72
  99. package/dist/runtime/helper/MessagePackConverterService.js +0 -9
  100. package/dist/runtime/logger/GNDebug.js +0 -29
  101. package/dist/runtime/networking/AuthenticateStatus.js +0 -14
  102. package/dist/runtime/networking/IPeer.js +0 -1
  103. package/dist/runtime/networking/NetworkingPeer.js +0 -178
  104. package/dist/runtime/networking/OperationPending.js +0 -53
  105. package/dist/runtime/networking/PeerBase.js +0 -161
  106. package/dist/runtime/networking/handler/IServerEventHandler.js +0 -13
  107. package/dist/runtime/networking/handler/OnCharacterPlayerFriendUpdateEventHandler.js +0 -39
  108. package/dist/runtime/networking/handler/OnCharacterPlayerGroupUpdateEventHandler.js +0 -39
  109. package/dist/runtime/networking/handler/OnGamePlayerFriendUpdateEventHandler.js +0 -39
  110. package/dist/runtime/networking/handler/OnGamePlayerGroupUpdateEventHandler.js +0 -39
  111. package/dist/runtime/networking/handler/OnGroupMemberUpdateEventHandler.js +0 -35
  112. package/dist/runtime/networking/handler/OnGroupMessageUpdateEventHandler.js +0 -43
  113. package/dist/runtime/networking/http/HttpPeer.js +0 -122
  114. package/dist/runtime/networking/http/NetworkingHttpPeerBase.js +0 -6
  115. package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.js +0 -164
  116. package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.js +0 -130
  117. package/dist/runtime/networking/socket/NetworkingSocketPeerBase.js +0 -165
  118. package/dist/runtime/networking/socket/SocketPeer.js +0 -115
  119. package/dist/runtime/typescript/ServiceUpdate.js +0 -12
  120. package/responseModel/chatgpt/Authenticate.json +0 -724
  121. package/responseModel/chatgpt/CharacterPlayer.json +0 -1890
  122. package/responseModel/chatgpt/CloudScript.json +0 -254
  123. package/responseModel/chatgpt/Content.json +0 -273
  124. package/responseModel/chatgpt/Dashboard.json +0 -4110
  125. package/responseModel/chatgpt/GamePlayer.json +0 -2306
  126. package/responseModel/chatgpt/Generic.json +0 -253
  127. package/responseModel/chatgpt/Group.json +0 -1509
  128. package/responseModel/chatgpt/Inventory.json +0 -1211
  129. package/responseModel/chatgpt/MasterPlayer.json +0 -3801
  130. package/responseModel/chatgpt/Multiplayer.json +0 -634
  131. package/responseModel/chatgpt/StoreInventory.json +0 -1099
  132. package/responseModel/clients/AuthenticateModels.json +0 -271
  133. package/responseModel/clients/CharacterPlayerModels.json +0 -792
  134. package/responseModel/clients/CloudScriptModels.json +0 -191
  135. package/responseModel/clients/ContentModels.json +0 -178
  136. package/responseModel/clients/DashboardModels.json +0 -5423
  137. package/responseModel/clients/GamePlayerModels.json +0 -781
  138. package/responseModel/clients/GenericModels.json +0 -344
  139. package/responseModel/clients/GroupModels.json +0 -705
  140. package/responseModel/clients/InventoryModels.json +0 -568
  141. package/responseModel/clients/MasterPlayerModels.json +0 -1281
  142. package/responseModel/clients/MultiplayerModels.json +0 -439
  143. package/responseModel/clients/StoreInventoryModels.json +0 -971
  144. package/responseModel/finalChatgpt/Authenticate.json +0 -1475
  145. package/responseModel/finalChatgpt/CharacterPlayer.json +0 -4104
  146. package/responseModel/finalChatgpt/CloudScript.json +0 -515
  147. package/responseModel/finalChatgpt/Content.json +0 -536
  148. package/responseModel/finalChatgpt/Dashboard.json +0 -6712
  149. package/responseModel/finalChatgpt/GamePlayer.json +0 -5142
  150. package/responseModel/finalChatgpt/Generic.json +0 -333
  151. package/responseModel/finalChatgpt/Group.json +0 -3232
  152. package/responseModel/finalChatgpt/Inventory.json +0 -2606
  153. package/responseModel/finalChatgpt/MasterPlayer.json +0 -8385
  154. package/responseModel/finalChatgpt/Multiplayer.json +0 -1196
  155. package/responseModel/finalChatgpt/StoreInventory.json +0 -2085
  156. package/responseModel/finals/Authenticate.json +0 -1460
  157. package/responseModel/finals/CharacterPlayer.json +0 -3639
  158. package/responseModel/finals/CloudScript.json +0 -465
  159. package/responseModel/finals/Content.json +0 -479
  160. package/responseModel/finals/Dashboard.json +0 -6718
  161. package/responseModel/finals/GamePlayer.json +0 -4291
  162. package/responseModel/finals/Generic.json +0 -345
  163. package/responseModel/finals/Group.json +0 -2885
  164. package/responseModel/finals/Inventory.json +0 -2309
  165. package/responseModel/finals/MasterPlayer.json +0 -7018
  166. package/responseModel/finals/Multiplayer.json +0 -1082
  167. package/responseModel/finals/StoreInventory.json +0 -1979
  168. package/responseModel/finalsShort/Authenticate.json +0 -723
  169. package/responseModel/finalsShort/CharacterPlayer.json +0 -1889
  170. package/responseModel/finalsShort/CloudScript.json +0 -253
  171. package/responseModel/finalsShort/Content.json +0 -272
  172. package/responseModel/finalsShort/Dashboard.json +0 -4109
  173. package/responseModel/finalsShort/GamePlayer.json +0 -2305
  174. package/responseModel/finalsShort/Generic.json +0 -252
  175. package/responseModel/finalsShort/Group.json +0 -1508
  176. package/responseModel/finalsShort/Inventory.json +0 -1210
  177. package/responseModel/finalsShort/MasterPlayer.json +0 -3800
  178. package/responseModel/finalsShort/Multiplayer.json +0 -633
  179. package/responseModel/finalsShort/StoreInventory.json +0 -1098
  180. package/responseModel/operationResponse/AuthenticateResponseModels.json +0 -77
  181. package/responseModel/operationResponse/CharacterPlayerResponseModels.json +0 -217
  182. package/responseModel/operationResponse/CloudScriptResponseModels.json +0 -25
  183. package/responseModel/operationResponse/ContentResponseModels.json +0 -33
  184. package/responseModel/operationResponse/DashboardResponseModels.json +0 -109
  185. package/responseModel/operationResponse/GamePlayerResponseModels.json +0 -213
  186. package/responseModel/operationResponse/GroupResponseModels.json +0 -165
  187. package/responseModel/operationResponse/InventoryResponseModels.json +0 -141
  188. package/responseModel/operationResponse/MasterPlayerResponseModels.json +0 -349
  189. package/responseModel/operationResponse/MultiplayerResponseModels.json +0 -45
  190. package/responseModel/operationResponse/StoreInventoryResponseModels.json +0 -61
  191. package/responseModel/servers/Authenticate.json +0 -1328
  192. package/responseModel/servers/CharacterPlayer.json +0 -3199
  193. package/responseModel/servers/CloudScript.json +0 -278
  194. package/responseModel/servers/Content.json +0 -324
  195. package/responseModel/servers/GamePlayer.json +0 -3844
  196. package/responseModel/servers/Group.json +0 -2454
  197. package/responseModel/servers/Inventory.json +0 -1964
  198. package/responseModel/servers/MasterAdmin.json +0 -5569
  199. package/responseModel/servers/MasterPlayer.json +0 -5924
  200. package/responseModel/servers/Multiplayer.json +0 -545
  201. package/responseModel/servers/StoreInventory.json +0 -1290
package/responseModel/chatgpt/GamePlayer.json DELETED
@@ -1,2306 +0,0 @@
1
- {
2
- "requestType": "GamePlayer",
3
- "description": "API requests for managing game player data, including profile information, virtual currencies, statistics, custom metadata, inventory, and social interactions such as friends, groups, and segments.",
4
- "operations": [
5
- {
6
- "operationCode": "AddPlayerFriend",
7
- "details": [
8
- {
9
- "role": "Client",
10
- "requestData": [
11
- {
12
- "code": "UserId",
13
- "description": "Unique identifier of the player who is the subject of the request.",
14
- "type": "string"
15
- },
16
- {
17
- "code": "FriendId",
18
- "description": "Unique identifier of the player to be added or removed as a friend.",
19
- "type": "string"
20
- },
21
- {
22
- "code": "CatalogId",
23
- "description": "Identifier of the catalog associated with the action or item.",
24
- "type": "string"
25
- }
26
- ]
27
- },
28
- {
29
- "role": "Server",
30
- "requestData": [
31
- {
32
- "code": "UserId",
33
- "description": "Unique identifier of the player who is the subject of the request.",
34
- "type": "string"
35
- }
36
- ]
37
- }
38
- ],
39
- "description": "Send a friend request from one player to another."
40
- },
41
- {
42
- "operationCode": "AddSegment",
43
- "details": [
44
- {
45
- "role": "Client",
46
- "requestData": [
47
- {
48
- "code": "UserId",
49
- "description": "Unique identifier of the player who is the subject of the request.",
50
- "type": "string"
51
- },
52
- {
53
- "code": "Value",
54
- "description": "String value representing the name or identifier of a segment or tag.",
55
- "type": "string"
56
- }
57
- ]
58
- },
59
- {
60
- "role": "Server",
61
- "requestData": [
62
- {
63
- "code": "UserId",
64
- "description": "Unique identifier of the player who is the subject of the request.",
65
- "type": "string"
66
- }
67
- ]
68
- }
69
- ],
70
- "description": "Assign a player to a specific segment for grouping or analysis."
71
- },
72
- {
73
- "operationCode": "ChangePlayerCurrency",
74
- "details": [
75
- {
76
- "role": "Client",
77
- "requestData": [
78
- {
79
- "code": "UserId",
80
- "description": "Unique identifier of the player who is the subject of the request.",
81
- "type": "string"
82
- },
83
- {
84
- "code": "PlayerCurrencies",
85
- "description": "List of currency modifications to be applied to the player's account.",
86
- "type": "Array<PlayerCurrencyParam>"
87
- },
88
- {
89
- "code": "Log",
90
- "description": "Optional log message or metadata describing the reason for the currency change.",
91
- "type": "string"
92
- }
93
- ]
94
- },
95
- {
96
- "role": "Server",
97
- "requestData": [
98
- {
99
- "code": "UserId",
100
- "description": "Unique identifier of the player who is the subject of the request.",
101
- "type": "string"
102
- }
103
- ]
104
- }
105
- ],
106
- "description": "Modify a player's virtual currency balance."
107
- },
108
- {
109
- "operationCode": "ChangePlayerStatistics",
110
- "details": [
111
- {
112
- "role": "Client",
113
- "requestData": [
114
- {
115
- "code": "UserId",
116
- "description": "Unique identifier of the player who is the subject of the request.",
117
- "type": "string"
118
- },
119
- {
120
- "code": "PlayerStatistics",
121
- "description": "List of statistic modifications to be applied to the player's profile.",
122
- "type": "Array<PlayerStatisticsParam>"
123
- },
124
- {
125
- "code": "Log",
126
- "description": "Optional log message or metadata describing the reason for the currency change.",
127
- "type": "string"
128
- }
129
- ]
130
- },
131
- {
132
- "role": "Server",
133
- "requestData": [
134
- {
135
- "code": "UserId",
136
- "description": "Unique identifier of the player who is the subject of the request.",
137
- "type": "string"
138
- }
139
- ]
140
- }
141
- ],
142
- "description": "Adjust one or more statistical values for the player."
143
- },
144
- {
145
- "operationCode": "CreateGroup",
146
- "details": [
147
- {
148
- "role": "Client",
149
- "requestData": [
150
- {
151
- "code": "UserId",
152
- "description": "Unique identifier of the player who is the subject of the request.",
153
- "type": "string"
154
- },
155
- {
156
- "code": "CatalogId",
157
- "description": "Identifier of the catalog associated with the action or item.",
158
- "type": "string"
159
- },
160
- {
161
- "code": "GroupMembers",
162
- "description": "GroupMembers parameter.",
163
- "type": "Array<GroupMemberParam>"
164
- },
165
- {
166
- "code": "DisplayName",
167
- "description": "The player's public name shown in leaderboards and friend lists.",
168
- "type": "string",
169
- "defaultValue": "\"\""
170
- }
171
- ]
172
- },
173
- {
174
- "role": "Server",
175
- "requestData": [
176
- {
177
- "code": "UserId",
178
- "description": "Unique identifier of the player who is the subject of the request.",
179
- "type": "string"
180
- }
181
- ]
182
- }
183
- ],
184
- "description": "Create a new player group with specified members."
185
- },
186
- {
187
- "operationCode": "CreatePlayerCharacter",
188
- "details": [
189
- {
190
- "role": "Client",
191
- "requestData": [
192
- {
193
- "code": "UserId",
194
- "description": "Unique identifier of the player who is the subject of the request.",
195
- "type": "string"
196
- },
197
- {
198
- "code": "CatalogId",
199
- "description": "Identifier of the catalog associated with the action or item.",
200
- "type": "string"
201
- },
202
- {
203
- "code": "DisplayName",
204
- "description": "The player's public name shown in leaderboards and friend lists.",
205
- "type": "string",
206
- "defaultValue": "\"\""
207
- },
208
- {
209
- "code": "UniqueDisplayName",
210
- "description": "UniqueDisplayName parameter.",
211
- "type": "boolean",
212
- "defaultValue": "false"
213
- }
214
- ]
215
- },
216
- {
217
- "role": "Server",
218
- "requestData": [
219
- {
220
- "code": "UserId",
221
- "description": "Unique identifier of the player who is the subject of the request.",
222
- "type": "string"
223
- }
224
- ]
225
- }
226
- ],
227
- "description": "Initialize a new character associated with the player."
228
- },
229
- {
230
- "operationCode": "CreatePlayerItem",
231
- "details": [
232
- {
233
- "role": "Client",
234
- "requestData": [
235
- {
236
- "code": "UserId",
237
- "description": "Unique identifier of the player who is the subject of the request.",
238
- "type": "string"
239
- },
240
- {
241
- "code": "CatalogId",
242
- "description": "Identifier of the catalog associated with the action or item.",
243
- "type": "string"
244
- },
245
- {
246
- "code": "ClassId",
247
- "description": "ClassId parameter.",
248
- "type": "string"
249
- },
250
- {
251
- "code": "DisplayName",
252
- "description": "The player's public name shown in leaderboards and friend lists.",
253
- "type": "string",
254
- "defaultValue": "\"\""
255
- },
256
- {
257
- "code": "Amount",
258
- "description": "Amount parameter.",
259
- "type": "number",
260
- "defaultValue": "1"
261
- }
262
- ]
263
- },
264
- {
265
- "role": "Server",
266
- "requestData": [
267
- {
268
- "code": "UserId",
269
- "description": "Unique identifier of the player who is the subject of the request.",
270
- "type": "string"
271
- }
272
- ]
273
- }
274
- ],
275
- "description": "Add a new item to the player’s inventory."
276
- },
277
- {
278
- "operationCode": "GetAvatar",
279
- "details": [
280
- {
281
- "role": "Client",
282
- "requestData": [
283
- {
284
- "code": "UserId",
285
- "description": "Unique identifier of the player who is the subject of the request.",
286
- "type": "string"
287
- }
288
- ]
289
- },
290
- {
291
- "role": "Server",
292
- "requestData": [
293
- {
294
- "code": "UserId",
295
- "description": "Unique identifier of the player who is the subject of the request.",
296
- "type": "string"
297
- }
298
- ]
299
- }
300
- ],
301
- "description": "Retrieve the player’s avatar image URL."
302
- },
303
- {
304
- "operationCode": "GetCountryCode",
305
- "details": [
306
- {
307
- "role": "Client",
308
- "requestData": [
309
- {
310
- "code": "UserId",
311
- "description": "Unique identifier of the player who is the subject of the request.",
312
- "type": "string"
313
- }
314
- ]
315
- },
316
- {
317
- "role": "Server",
318
- "requestData": [
319
- {
320
- "code": "UserId",
321
- "description": "Unique identifier of the player who is the subject of the request.",
322
- "type": "string"
323
- }
324
- ]
325
- }
326
- ],
327
- "description": "Get the country code associated with the player’s IP address."
328
- },
329
- {
330
- "operationCode": "GetCreateLeaderboard",
331
- "details": [
332
- {
333
- "role": "Client",
334
- "requestData": [
335
- {
336
- "code": "InfoRequestParam",
337
- "description": "InfoRequestParam parameter.",
338
- "type": "InfoRequestParam"
339
- },
340
- {
341
- "code": "Skip",
342
- "description": "Skip parameter.",
343
- "type": "number",
344
- "defaultValue": "0"
345
- },
346
- {
347
- "code": "Limit",
348
- "description": "Limit parameter.",
349
- "type": "number",
350
- "defaultValue": "10"
351
- },
352
- {
353
- "code": "LoadFromCache",
354
- "description": "LoadFromCache parameter.",
355
- "type": "boolean",
356
- "defaultValue": "true"
357
- }
358
- ]
359
- }
360
- ],
361
- "description": "Fetch data used to generate a leaderboard for player creation times."
362
- },
363
- {
364
- "operationCode": "GetCurrencyLeaderboard",
365
- "details": [
366
- {
367
- "role": "Client",
368
- "requestData": [
369
- {
370
- "code": "Key",
371
- "description": "Key parameter.",
372
- "type": "string"
373
- },
374
- {
375
- "code": "InfoRequestParam",
376
- "description": "InfoRequestParam parameter.",
377
- "type": "InfoRequestParam"
378
- },
379
- {
380
- "code": "Skip",
381
- "description": "Skip parameter.",
382
- "type": "number",
383
- "defaultValue": "0"
384
- },
385
- {
386
- "code": "Limit",
387
- "description": "Limit parameter.",
388
- "type": "number",
389
- "defaultValue": "10"
390
- },
391
- {
392
- "code": "LoadFromCache",
393
- "description": "LoadFromCache parameter.",
394
- "type": "boolean",
395
- "defaultValue": "true"
396
- }
397
- ]
398
- }
399
- ],
400
- "description": "Retrieve a leaderboard based on players’ currency balances."
401
- },
402
- {
403
- "operationCode": "GetCurrencyLog",
404
- "details": [
405
- {
406
- "role": "Client",
407
- "requestData": [
408
- {
409
- "code": "Keys",
410
- "description": "List of key names to retrieve specific custom data entries.",
411
- "type": "Array<string>"
412
- },
413
- {
414
- "code": "UserId",
415
- "description": "Unique identifier of the player who is the subject of the request.",
416
- "type": "string"
417
- },
418
- {
419
- "code": "Limit",
420
- "description": "Limit parameter.",
421
- "type": "number",
422
- "defaultValue": "10"
423
- },
424
- {
425
- "code": "Token",
426
- "description": "Token parameter.",
427
- "type": "string"
428
- }
429
- ]
430
- }
431
- ],
432
- "description": "View historical records of currency transactions for a player."
433
- },
434
- {
435
- "operationCode": "GetCustomData",
436
- "details": [
437
- {
438
- "role": "Client",
439
- "requestData": [
440
- {
441
- "code": "UserId",
442
- "description": "Unique identifier of the player who is the subject of the request.",
443
- "type": "string"
444
- },
445
- {
446
- "code": "CustomDataKeys",
447
- "description": "CustomDataKeys parameter.",
448
- "type": "Array<string>"
449
- }
450
- ]
451
- },
452
- {
453
- "role": "Server",
454
- "requestData": [
455
- {
456
- "code": "UserId",
457
- "description": "Unique identifier of the player who is the subject of the request.",
458
- "type": "string"
459
- }
460
- ]
461
- }
462
- ],
463
- "description": "Retrieve custom key-value data stored for a player."
464
- },
465
- {
466
- "operationCode": "GetDisplayName",
467
- "details": [
468
- {
469
- "role": "Client",
470
- "requestData": [
471
- {
472
- "code": "UserId",
473
- "description": "Unique identifier of the player who is the subject of the request.",
474
- "type": "string"
475
- }
476
- ]
477
- },
478
- {
479
- "role": "Server",
480
- "requestData": [
481
- {
482
- "code": "UserId",
483
- "description": "Unique identifier of the player who is the subject of the request.",
484
- "type": "string"
485
- }
486
- ]
487
- }
488
- ],
489
- "description": "Retrieve the player's current display name."
490
- },
491
- {
492
- "operationCode": "GetFriendStatisticsLeaderboardAroundPlayer",
493
- "details": [
494
- {
495
- "role": "Client",
496
- "requestData": [
497
- {
498
- "code": "UserId",
499
- "description": "Unique identifier of the player who is the subject of the request.",
500
- "type": "string"
501
- },
502
- {
503
- "code": "Key",
504
- "description": "Key parameter.",
505
- "type": "string"
506
- },
507
- {
508
- "code": "InfoRequestParam",
509
- "description": "InfoRequestParam parameter.",
510
- "type": "InfoRequestParam"
511
- },
512
- {
513
- "code": "Skip",
514
- "description": "Skip parameter.",
515
- "type": "number",
516
- "defaultValue": "0"
517
- },
518
- {
519
- "code": "Limit",
520
- "description": "Limit parameter.",
521
- "type": "number",
522
- "defaultValue": "10"
523
- },
524
- {
525
- "code": "LoadFromCache",
526
- "description": "LoadFromCache parameter.",
527
- "type": "boolean",
528
- "defaultValue": "true"
529
- }
530
- ]
531
- },
532
- {
533
- "role": "Server",
534
- "requestData": [
535
- {
536
- "code": "UserId",
537
- "description": "Unique identifier of the player who is the subject of the request.",
538
- "type": "string"
539
- }
540
- ]
541
- }
542
- ],
543
- "description": "Get the leaderboard centered on the player's ranking among friends for a specific statistic."
544
- },
545
- {
546
- "operationCode": "GetFriendStatisticsLeaderboard",
547
- "details": [
548
- {
549
- "role": "Client",
550
- "requestData": [
551
- {
552
- "code": "UserId",
553
- "description": "Unique identifier of the player who is the subject of the request.",
554
- "type": "string"
555
- },
556
- {
557
- "code": "Key",
558
- "description": "Key parameter.",
559
- "type": "string"
560
- },
561
- {
562
- "code": "InfoRequestParam",
563
- "description": "InfoRequestParam parameter.",
564
- "type": "InfoRequestParam"
565
- },
566
- {
567
- "code": "Skip",
568
- "description": "Skip parameter.",
569
- "type": "number",
570
- "defaultValue": "0"
571
- },
572
- {
573
- "code": "Limit",
574
- "description": "Limit parameter.",
575
- "type": "number",
576
- "defaultValue": "10"
577
- },
578
- {
579
- "code": "LoadFromCache",
580
- "description": "LoadFromCache parameter.",
581
- "type": "boolean",
582
- "defaultValue": "true"
583
- }
584
- ]
585
- },
586
- {
587
- "role": "Server",
588
- "requestData": [
589
- {
590
- "code": "UserId",
591
- "description": "Unique identifier of the player who is the subject of the request.",
592
- "type": "string"
593
- }
594
- ]
595
- }
596
- ],
597
- "description": "Get the full leaderboard among a player’s friends for a given statistic."
598
- },
599
- {
600
- "operationCode": "GetIpAddressCreate",
601
- "details": [
602
- {
603
- "role": "Client",
604
- "requestData": [
605
- {
606
- "code": "UserId",
607
- "description": "Unique identifier of the player who is the subject of the request.",
608
- "type": "string"
609
- }
610
- ]
611
- },
612
- {
613
- "role": "Server",
614
- "requestData": [
615
- {
616
- "code": "UserId",
617
- "description": "Unique identifier of the player who is the subject of the request.",
618
- "type": "string"
619
- }
620
- ]
621
- }
622
- ],
623
- "description": "Return the IP address used when the player's account was created."
624
- },
625
- {
626
- "operationCode": "GetLastLoginLeaderboard",
627
- "details": [
628
- {
629
- "role": "Client",
630
- "requestData": [
631
- {
632
- "code": "InfoRequestParam",
633
- "description": "InfoRequestParam parameter.",
634
- "type": "InfoRequestParam"
635
- },
636
- {
637
- "code": "Skip",
638
- "description": "Skip parameter.",
639
- "type": "number",
640
- "defaultValue": "0"
641
- },
642
- {
643
- "code": "Limit",
644
- "description": "Limit parameter.",
645
- "type": "number",
646
- "defaultValue": "10"
647
- },
648
- {
649
- "code": "LoadFromCache",
650
- "description": "LoadFromCache parameter.",
651
- "type": "boolean",
652
- "defaultValue": "true"
653
- }
654
- ]
655
- }
656
- ],
657
- "description": "Get a leaderboard sorted by the most recent player login times."
658
- },
659
- {
660
- "operationCode": "GetOnlineStatus",
661
- "details": [
662
- {
663
- "role": "Client",
664
- "requestData": [
665
- {
666
- "code": "UserId",
667
- "description": "Unique identifier of the player who is the subject of the request.",
668
- "type": "string"
669
- }
670
- ]
671
- },
672
- {
673
- "role": "Server",
674
- "requestData": [
675
- {
676
- "code": "UserId",
677
- "description": "Unique identifier of the player who is the subject of the request.",
678
- "type": "string"
679
- }
680
- ]
681
- }
682
- ],
683
- "description": "Check whether a specific player is currently online."
684
- },
685
- {
686
- "operationCode": "GetPlayerBan",
687
- "details": [
688
- {
689
- "role": "Client",
690
- "requestData": [
691
- {
692
- "code": "UserId",
693
- "description": "Unique identifier of the player who is the subject of the request.",
694
- "type": "string"
695
- }
696
- ]
697
- },
698
- {
699
- "role": "Server",
700
- "requestData": [
701
- {
702
- "code": "UserId",
703
- "description": "Unique identifier of the player who is the subject of the request.",
704
- "type": "string"
705
- }
706
- ]
707
- }
708
- ],
709
- "description": "Retrieve ban status and details for a specific player."
710
- },
711
- {
712
- "operationCode": "GetPlayerCharacter",
713
- "details": [
714
- {
715
- "role": "Client",
716
- "requestData": [
717
- {
718
- "code": "UserId",
719
- "description": "Unique identifier of the player who is the subject of the request.",
720
- "type": "string"
721
- },
722
- {
723
- "code": "CharacterCatalogIds",
724
- "description": "CharacterCatalogIds parameter.",
725
- "type": "Array<string>"
726
- }
727
- ]
728
- },
729
- {
730
- "role": "Server",
731
- "requestData": [
732
- {
733
- "code": "UserId",
734
- "description": "Unique identifier of the player who is the subject of the request.",
735
- "type": "string"
736
- }
737
- ]
738
- }
739
- ],
740
- "description": "Get all characters created by a player."
741
- },
742
- {
743
- "operationCode": "GetPlayerCurrency",
744
- "details": [
745
- {
746
- "role": "Client",
747
- "requestData": [
748
- {
749
- "code": "UserId",
750
- "description": "Unique identifier of the player who is the subject of the request.",
751
- "type": "string"
752
- },
753
- {
754
- "code": "PlayerCurrencyKeys",
755
- "description": "PlayerCurrencyKeys parameter.",
756
- "type": "Array<string>"
757
- }
758
- ]
759
- },
760
- {
761
- "role": "Server",
762
- "requestData": [
763
- {
764
- "code": "UserId",
765
- "description": "Unique identifier of the player who is the subject of the request.",
766
- "type": "string"
767
- }
768
- ]
769
- }
770
- ],
771
- "description": "Retrieve the current currency balances for a player."
772
- },
773
- {
774
- "operationCode": "GetPlayerData",
775
- "details": [
776
- {
777
- "role": "Client",
778
- "requestData": [
779
- {
780
- "code": "UserId",
781
- "description": "Unique identifier of the player who is the subject of the request.",
782
- "type": "string"
783
- },
784
- {
785
- "code": "PlayerDataKeys",
786
- "description": "PlayerDataKeys parameter.",
787
- "type": "Array<string>"
788
- }
789
- ]
790
- },
791
- {
792
- "role": "Server",
793
- "requestData": [
794
- {
795
- "code": "UserId",
796
- "description": "Unique identifier of the player who is the subject of the request.",
797
- "type": "string"
798
- }
799
- ]
800
- }
801
- ],
802
- "description": "Retrieve player-specific key-value data entries."
803
- },
804
- {
805
- "operationCode": "GetPlayerFriend",
806
- "details": [
807
- {
808
- "role": "Client",
809
- "requestData": [
810
- {
811
- "code": "UserId",
812
- "description": "Unique identifier of the player who is the subject of the request.",
813
- "type": "string"
814
- },
815
- {
816
- "code": "FriendCatalogIds",
817
- "description": "FriendCatalogIds parameter.",
818
- "type": "Array<string>"
819
- }
820
- ]
821
- },
822
- {
823
- "role": "Server",
824
- "requestData": [
825
- {
826
- "code": "UserId",
827
- "description": "Unique identifier of the player who is the subject of the request.",
828
- "type": "string"
829
- }
830
- ]
831
- }
832
- ],
833
- "description": "Retrieve the player’s full friend list."
834
- },
835
- {
836
- "operationCode": "GetPlayerGroup",
837
- "details": [
838
- {
839
- "role": "Client",
840
- "requestData": [
841
- {
842
- "code": "UserId",
843
- "description": "Unique identifier of the player who is the subject of the request.",
844
- "type": "string"
845
- },
846
- {
847
- "code": "GroupCatalogIds",
848
- "description": "GroupCatalogIds parameter.",
849
- "type": "Array<string>"
850
- }
851
- ]
852
- },
853
- {
854
- "role": "Server",
855
- "requestData": [
856
- {
857
- "code": "UserId",
858
- "description": "Unique identifier of the player who is the subject of the request.",
859
- "type": "string"
860
- }
861
- ]
862
- }
863
- ],
864
- "description": "Get all groups that the player is currently a member of."
865
- },
866
- {
867
- "operationCode": "GetPlayerInformation",
868
- "details": [
869
- {
870
- "role": "Client",
871
- "requestData": [
872
- {
873
- "code": "UserId",
874
- "description": "Unique identifier of the player who is the subject of the request.",
875
- "type": "string"
876
- },
877
- {
878
- "code": "InfoRequestParam",
879
- "description": "InfoRequestParam parameter.",
880
- "type": "InfoRequestParam"
881
- }
882
- ]
883
- },
884
- {
885
- "role": "Server",
886
- "requestData": [
887
- {
888
- "code": "UserId",
889
- "description": "Unique identifier of the player who is the subject of the request.",
890
- "type": "string"
891
- },
892
- {
893
- "code": "CreatePlayerIfNotExists",
894
- "description": "CreatePlayerIfNotExists parameter.",
895
- "type": "boolean",
896
- "defaultValue": "false"
897
- }
898
- ]
899
- }
900
- ],
901
- "description": "Fetch high-level metadata and profile information for a player."
902
- },
903
- {
904
- "operationCode": "GetPlayerInventory",
905
- "details": [
906
- {
907
- "role": "Client",
908
- "requestData": [
909
- {
910
- "code": "UserId",
911
- "description": "Unique identifier of the player who is the subject of the request.",
912
- "type": "string"
913
- },
914
- {
915
- "code": "ItemCatalogIds",
916
- "description": "ItemCatalogIds parameter.",
917
- "type": "Array<string>"
918
- }
919
- ]
920
- },
921
- {
922
- "role": "Server",
923
- "requestData": [
924
- {
925
- "code": "UserId",
926
- "description": "Unique identifier of the player who is the subject of the request.",
927
- "type": "string"
928
- }
929
- ]
930
- }
931
- ],
932
- "description": "Retrieve the player’s current inventory of items."
933
- },
934
- {
935
- "operationCode": "GetPlayerStatistics",
936
- "details": [
937
- {
938
- "role": "Client",
939
- "requestData": [
940
- {
941
- "code": "UserId",
942
- "description": "Unique identifier of the player who is the subject of the request.",
943
- "type": "string"
944
- },
945
- {
946
- "code": "StatisticsKeys",
947
- "description": "StatisticsKeys parameter.",
948
- "type": "Array<string>"
949
- }
950
- ]
951
- },
952
- {
953
- "role": "Server",
954
- "requestData": [
955
- {
956
- "code": "UserId",
957
- "description": "Unique identifier of the player who is the subject of the request.",
958
- "type": "string"
959
- }
960
- ]
961
- }
962
- ],
963
- "description": "Return a list of the player’s statistics and their values."
964
- },
965
- {
966
- "operationCode": "GetPlayersWithDisplayName",
967
- "details": [
968
- {
969
- "role": "Client",
970
- "requestData": [
971
- {
972
- "code": "Keyword",
973
- "description": "Keyword parameter.",
974
- "type": "string"
975
- },
976
- {
977
- "code": "InfoRequestParam",
978
- "description": "InfoRequestParam parameter.",
979
- "type": "InfoRequestParam"
980
- },
981
- {
982
- "code": "Skip",
983
- "description": "Skip parameter.",
984
- "type": "number",
985
- "defaultValue": "0"
986
- },
987
- {
988
- "code": "Limit",
989
- "description": "Limit parameter.",
990
- "type": "number",
991
- "defaultValue": "10"
992
- }
993
- ]
994
- }
995
- ],
996
- "description": "Find players with an exact or partial match on display name."
997
- },
998
- {
999
- "operationCode": "GetPlayersWithSegment",
1000
- "details": [
1001
- {
1002
- "role": "Client",
1003
- "requestData": [
1004
- {
1005
- "code": "Value",
1006
- "description": "String value representing the name or identifier of a segment or tag.",
1007
- "type": "string"
1008
- },
1009
- {
1010
- "code": "InfoRequestParam",
1011
- "description": "InfoRequestParam parameter.",
1012
- "type": "InfoRequestParam"
1013
- },
1014
- {
1015
- "code": "Skip",
1016
- "description": "Skip parameter.",
1017
- "type": "number",
1018
- "defaultValue": "0"
1019
- },
1020
- {
1021
- "code": "Limit",
1022
- "description": "Limit parameter.",
1023
- "type": "number",
1024
- "defaultValue": "10"
1025
- }
1026
- ]
1027
- }
1028
- ],
1029
- "description": "Get all players who belong to a specific segment."
1030
- },
1031
- {
1032
- "operationCode": "GetPlayersWithTag",
1033
- "details": [
1034
- {
1035
- "role": "Client",
1036
- "requestData": [
1037
- {
1038
- "code": "Key",
1039
- "description": "Key parameter.",
1040
- "type": "string"
1041
- },
1042
- {
1043
- "code": "Value",
1044
- "description": "String value representing the name or identifier of a segment or tag.",
1045
- "type": "string"
1046
- },
1047
- {
1048
- "code": "InfoRequestParam",
1049
- "description": "InfoRequestParam parameter.",
1050
- "type": "InfoRequestParam"
1051
- },
1052
- {
1053
- "code": "Skip",
1054
- "description": "Skip parameter.",
1055
- "type": "number",
1056
- "defaultValue": "0"
1057
- },
1058
- {
1059
- "code": "Limit",
1060
- "description": "Limit parameter.",
1061
- "type": "number",
1062
- "defaultValue": "10"
1063
- }
1064
- ]
1065
- }
1066
- ],
1067
- "description": "List all players who have been assigned a specific tag."
1068
- },
1069
- {
1070
- "operationCode": "GetSegment",
1071
- "details": [
1072
- {
1073
- "role": "Client",
1074
- "requestData": [
1075
- {
1076
- "code": "UserId",
1077
- "description": "Unique identifier of the player who is the subject of the request.",
1078
- "type": "string"
1079
- }
1080
- ]
1081
- },
1082
- {
1083
- "role": "Server",
1084
- "requestData": [
1085
- {
1086
- "code": "UserId",
1087
- "description": "Unique identifier of the player who is the subject of the request.",
1088
- "type": "string"
1089
- }
1090
- ]
1091
- }
1092
- ],
1093
- "description": "Retrieve a list of all available player segments."
1094
- },
1095
- {
1096
- "operationCode": "GetStatisticsLeaderboardAroundPlayer",
1097
- "details": [
1098
- {
1099
- "role": "Client",
1100
- "requestData": [
1101
- {
1102
- "code": "UserId",
1103
- "description": "Unique identifier of the player who is the subject of the request.",
1104
- "type": "string"
1105
- },
1106
- {
1107
- "code": "Key",
1108
- "description": "Key parameter.",
1109
- "type": "string"
1110
- },
1111
- {
1112
- "code": "InfoRequestParam",
1113
- "description": "InfoRequestParam parameter.",
1114
- "type": "InfoRequestParam"
1115
- },
1116
- {
1117
- "code": "Skip",
1118
- "description": "Skip parameter.",
1119
- "type": "number",
1120
- "defaultValue": "0"
1121
- },
1122
- {
1123
- "code": "Limit",
1124
- "description": "Limit parameter.",
1125
- "type": "number",
1126
- "defaultValue": "10"
1127
- },
1128
- {
1129
- "code": "LoadFromCache",
1130
- "description": "LoadFromCache parameter.",
1131
- "type": "boolean",
1132
- "defaultValue": "true"
1133
- }
1134
- ]
1135
- },
1136
- {
1137
- "role": "Server",
1138
- "requestData": [
1139
- {
1140
- "code": "UserId",
1141
- "description": "Unique identifier of the player who is the subject of the request.",
1142
- "type": "string"
1143
- }
1144
- ]
1145
- }
1146
- ],
1147
- "description": "Get a leaderboard centered on the player’s position for a given statistic."
1148
- },
1149
- {
1150
- "operationCode": "GetStatisticsLeaderboard",
1151
- "details": [
1152
- {
1153
- "role": "Client",
1154
- "requestData": [
1155
- {
1156
- "code": "Key",
1157
- "description": "Key parameter.",
1158
- "type": "string"
1159
- },
1160
- {
1161
- "code": "InfoRequestParam",
1162
- "description": "InfoRequestParam parameter.",
1163
- "type": "InfoRequestParam"
1164
- },
1165
- {
1166
- "code": "Skip",
1167
- "description": "Skip parameter.",
1168
- "type": "number",
1169
- "defaultValue": "0"
1170
- },
1171
- {
1172
- "code": "Limit",
1173
- "description": "Limit parameter.",
1174
- "type": "number",
1175
- "defaultValue": "10"
1176
- },
1177
- {
1178
- "code": "LoadFromCache",
1179
- "description": "LoadFromCache parameter.",
1180
- "type": "boolean",
1181
- "defaultValue": "true"
1182
- },
1183
- {
1184
- "code": "Version",
1185
- "description": "Version parameter.",
1186
- "type": "string"
1187
- }
1188
- ]
1189
- }
1190
- ],
1191
- "description": "Retrieve the full leaderboard for a given statistic."
1192
- },
1193
- {
1194
- "operationCode": "GetStatisticsLog",
1195
- "details": [
1196
- {
1197
- "role": "Client",
1198
- "requestData": [
1199
- {
1200
- "code": "Keys",
1201
- "description": "List of key names to retrieve specific custom data entries.",
1202
- "type": "Array<string>"
1203
- },
1204
- {
1205
- "code": "UserId",
1206
- "description": "Unique identifier of the player who is the subject of the request.",
1207
- "type": "string"
1208
- },
1209
- {
1210
- "code": "Limit",
1211
- "description": "Limit parameter.",
1212
- "type": "number",
1213
- "defaultValue": "10"
1214
- },
1215
- {
1216
- "code": "Token",
1217
- "description": "Token parameter.",
1218
- "type": "string"
1219
- }
1220
- ]
1221
- }
1222
- ],
1223
- "description": "Get the full history of updates made to a player's statistics."
1224
- },
1225
- {
1226
- "operationCode": "GetTag",
1227
- "details": [
1228
- {
1229
- "role": "Client",
1230
- "requestData": [
1231
- {
1232
- "code": "UserId",
1233
- "description": "Unique identifier of the player who is the subject of the request.",
1234
- "type": "string"
1235
- },
1236
- {
1237
- "code": "TagKeys",
1238
- "description": "TagKeys parameter.",
1239
- "type": "Array<string>"
1240
- }
1241
- ]
1242
- },
1243
- {
1244
- "role": "Server",
1245
- "requestData": [
1246
- {
1247
- "code": "UserId",
1248
- "description": "Unique identifier of the player who is the subject of the request.",
1249
- "type": "string"
1250
- }
1251
- ]
1252
- }
1253
- ],
1254
- "description": "Return a list of all custom tags currently assigned to the player."
1255
- },
1256
- {
1257
- "operationCode": "GetTsCreate",
1258
- "details": [
1259
- {
1260
- "role": "Client",
1261
- "requestData": [
1262
- {
1263
- "code": "UserId",
1264
- "description": "Unique identifier of the player who is the subject of the request.",
1265
- "type": "string"
1266
- }
1267
- ]
1268
- },
1269
- {
1270
- "role": "Server",
1271
- "requestData": [
1272
- {
1273
- "code": "UserId",
1274
- "description": "Unique identifier of the player who is the subject of the request.",
1275
- "type": "string"
1276
- }
1277
- ]
1278
- }
1279
- ],
1280
- "description": "Get the timestamp when the player’s account was created."
1281
- },
1282
- {
1283
- "operationCode": "GetTsLastLogin",
1284
- "details": [
1285
- {
1286
- "role": "Client",
1287
- "requestData": [
1288
- {
1289
- "code": "UserId",
1290
- "description": "Unique identifier of the player who is the subject of the request.",
1291
- "type": "string"
1292
- }
1293
- ]
1294
- },
1295
- {
1296
- "role": "Server",
1297
- "requestData": [
1298
- {
1299
- "code": "UserId",
1300
- "description": "Unique identifier of the player who is the subject of the request.",
1301
- "type": "string"
1302
- }
1303
- ]
1304
- }
1305
- ],
1306
- "description": "Get the timestamp of the player's most recent login."
1307
- },
1308
- {
1309
- "operationCode": "JoinGroup",
1310
- "details": [
1311
- {
1312
- "role": "Client",
1313
- "requestData": [
1314
- {
1315
- "code": "UserId",
1316
- "description": "Unique identifier of the player who is the subject of the request.",
1317
- "type": "string"
1318
- },
1319
- {
1320
- "code": "GroupId",
1321
- "description": "Unique identifier of the group being joined or left.",
1322
- "type": "string"
1323
- }
1324
- ]
1325
- },
1326
- {
1327
- "role": "Server",
1328
- "requestData": [
1329
- {
1330
- "code": "UserId",
1331
- "description": "Unique identifier of the player who is the subject of the request.",
1332
- "type": "string"
1333
- }
1334
- ]
1335
- }
1336
- ],
1337
- "description": "Add a player to a group as a member."
1338
- },
1339
- {
1340
- "operationCode": "LeaveGroup",
1341
- "details": [
1342
- {
1343
- "role": "Client",
1344
- "requestData": [
1345
- {
1346
- "code": "UserId",
1347
- "description": "Unique identifier of the player who is the subject of the request.",
1348
- "type": "string"
1349
- },
1350
- {
1351
- "code": "GroupId",
1352
- "description": "Unique identifier of the group being joined or left.",
1353
- "type": "string"
1354
- }
1355
- ]
1356
- },
1357
- {
1358
- "role": "Server",
1359
- "requestData": [
1360
- {
1361
- "code": "UserId",
1362
- "description": "Unique identifier of the player who is the subject of the request.",
1363
- "type": "string"
1364
- }
1365
- ]
1366
- }
1367
- ],
1368
- "description": "Remove a player from a group."
1369
- },
1370
- {
1371
- "operationCode": "RemovePlayerCharacter",
1372
- "details": [
1373
- {
1374
- "role": "Client",
1375
- "requestData": [
1376
- {
1377
- "code": "UserId",
1378
- "description": "Unique identifier of the player who is the subject of the request.",
1379
- "type": "string"
1380
- },
1381
- {
1382
- "code": "CharacterId",
1383
- "description": "Identifier of the character associated with the request.",
1384
- "type": "string"
1385
- }
1386
- ]
1387
- },
1388
- {
1389
- "role": "Server",
1390
- "requestData": [
1391
- {
1392
- "code": "UserId",
1393
- "description": "Unique identifier of the player who is the subject of the request.",
1394
- "type": "string"
1395
- }
1396
- ]
1397
- }
1398
- ],
1399
- "description": "Delete a character previously created by the player."
1400
- },
1401
- {
1402
- "operationCode": "RemovePlayerFriend",
1403
- "details": [
1404
- {
1405
- "role": "Client",
1406
- "requestData": [
1407
- {
1408
- "code": "UserId",
1409
- "description": "Unique identifier of the player who is the subject of the request.",
1410
- "type": "string"
1411
- },
1412
- {
1413
- "code": "FriendId",
1414
- "description": "Unique identifier of the player to be added or removed as a friend.",
1415
- "type": "string"
1416
- }
1417
- ]
1418
- },
1419
- {
1420
- "role": "Server",
1421
- "requestData": [
1422
- {
1423
- "code": "UserId",
1424
- "description": "Unique identifier of the player who is the subject of the request.",
1425
- "type": "string"
1426
- }
1427
- ]
1428
- }
1429
- ],
1430
- "description": "Remove another player from the player’s friend list."
1431
- },
1432
- {
1433
- "operationCode": "RemovePlayerItem",
1434
- "details": [
1435
- {
1436
- "role": "Client",
1437
- "requestData": [
1438
- {
1439
- "code": "UserId",
1440
- "description": "Unique identifier of the player who is the subject of the request.",
1441
- "type": "string"
1442
- },
1443
- {
1444
- "code": "ItemId",
1445
- "description": "Identifier of the item being added, removed, or modified.",
1446
- "type": "string"
1447
- }
1448
- ]
1449
- },
1450
- {
1451
- "role": "Server",
1452
- "requestData": [
1453
- {
1454
- "code": "UserId",
1455
- "description": "Unique identifier of the player who is the subject of the request.",
1456
- "type": "string"
1457
- }
1458
- ]
1459
- }
1460
- ],
1461
- "description": "Delete an item from the player’s inventory."
1462
- },
1463
- {
1464
- "operationCode": "RemoveSegment",
1465
- "details": [
1466
- {
1467
- "role": "Client",
1468
- "requestData": [
1469
- {
1470
- "code": "UserId",
1471
- "description": "Unique identifier of the player who is the subject of the request.",
1472
- "type": "string"
1473
- },
1474
- {
1475
- "code": "Value",
1476
- "description": "String value representing the name or identifier of a segment or tag.",
1477
- "type": "string"
1478
- }
1479
- ]
1480
- },
1481
- {
1482
- "role": "Server",
1483
- "requestData": [
1484
- {
1485
- "code": "UserId",
1486
- "description": "Unique identifier of the player who is the subject of the request.",
1487
- "type": "string"
1488
- }
1489
- ]
1490
- }
1491
- ],
1492
- "description": "Remove the player from a previously assigned segment."
1493
- },
1494
- {
1495
- "operationCode": "RemoveTag",
1496
- "details": [
1497
- {
1498
- "role": "Client",
1499
- "requestData": [
1500
- {
1501
- "code": "UserId",
1502
- "description": "Unique identifier of the player who is the subject of the request.",
1503
- "type": "string"
1504
- },
1505
- {
1506
- "code": "Key",
1507
- "description": "Key parameter.",
1508
- "type": "string"
1509
- }
1510
- ]
1511
- },
1512
- {
1513
- "role": "Server",
1514
- "requestData": [
1515
- {
1516
- "code": "UserId",
1517
- "description": "Unique identifier of the player who is the subject of the request.",
1518
- "type": "string"
1519
- }
1520
- ]
1521
- }
1522
- ],
1523
- "description": "Delete a tag that was assigned to the player."
1524
- },
1525
- {
1526
- "operationCode": "SetAvatar",
1527
- "details": [
1528
- {
1529
- "role": "Client",
1530
- "requestData": [
1531
- {
1532
- "code": "UserId",
1533
- "description": "Unique identifier of the player who is the subject of the request.",
1534
- "type": "string"
1535
- },
1536
- {
1537
- "code": "Type",
1538
- "description": "Type parameter.",
1539
- "type": "number"
1540
- },
1541
- {
1542
- "code": "Value",
1543
- "description": "String value representing the name or identifier of a segment or tag.",
1544
- "type": "string"
1545
- }
1546
- ]
1547
- },
1548
- {
1549
- "role": "Server",
1550
- "requestData": [
1551
- {
1552
- "code": "UserId",
1553
- "description": "Unique identifier of the player who is the subject of the request.",
1554
- "type": "string"
1555
- }
1556
- ]
1557
- }
1558
- ],
1559
- "description": "Update the player’s avatar image."
1560
- },
1561
- {
1562
- "operationCode": "SetCountryCode",
1563
- "details": [
1564
- {
1565
- "role": "Client",
1566
- "requestData": [
1567
- {
1568
- "code": "UserId",
1569
- "description": "Unique identifier of the player who is the subject of the request.",
1570
- "type": "string"
1571
- },
1572
- {
1573
- "code": "CountryCode",
1574
- "description": "Two-letter ISO country code to assign to the player.",
1575
- "type": "string"
1576
- }
1577
- ]
1578
- },
1579
- {
1580
- "role": "Server",
1581
- "requestData": [
1582
- {
1583
- "code": "UserId",
1584
- "description": "Unique identifier of the player who is the subject of the request.",
1585
- "type": "string"
1586
- }
1587
- ]
1588
- }
1589
- ],
1590
- "description": "Manually set the player’s country code."
1591
- },
1592
- {
1593
- "operationCode": "SetCustomData",
1594
- "details": [
1595
- {
1596
- "role": "Client",
1597
- "requestData": [
1598
- {
1599
- "code": "UserId",
1600
- "description": "Unique identifier of the player who is the subject of the request.",
1601
- "type": "string"
1602
- },
1603
- {
1604
- "code": "CustomDatas",
1605
- "description": "CustomDatas parameter.",
1606
- "type": "Array<CustomDataParam>"
1607
- }
1608
- ]
1609
- },
1610
- {
1611
- "role": "Server",
1612
- "requestData": [
1613
- {
1614
- "code": "UserId",
1615
- "description": "Unique identifier of the player who is the subject of the request.",
1616
- "type": "string"
1617
- }
1618
- ]
1619
- }
1620
- ],
1621
- "description": "Update or create key-value custom data entries for a player."
1622
- },
1623
- {
1624
- "operationCode": "SetDisplayName",
1625
- "details": [
1626
- {
1627
- "role": "Client",
1628
- "requestData": [
1629
- {
1630
- "code": "UserId",
1631
- "description": "Unique identifier of the player who is the subject of the request.",
1632
- "type": "string"
1633
- },
1634
- {
1635
- "code": "DisplayName",
1636
- "description": "The player's public name shown in leaderboards and friend lists.",
1637
- "type": "string"
1638
- },
1639
- {
1640
- "code": "UniqueDisplayName",
1641
- "description": "UniqueDisplayName parameter.",
1642
- "type": "boolean",
1643
- "defaultValue": "false"
1644
- }
1645
- ]
1646
- },
1647
- {
1648
- "role": "Server",
1649
- "requestData": [
1650
- {
1651
- "code": "UserId",
1652
- "description": "Unique identifier of the player who is the subject of the request.",
1653
- "type": "string"
1654
- }
1655
- ]
1656
- }
1657
- ],
1658
- "description": "Change the player’s display name."
1659
- },
1660
- {
1661
- "operationCode": "SetPlayerBan",
1662
- "details": [
1663
- {
1664
- "role": "Client",
1665
- "requestData": [
1666
- {
1667
- "code": "UserId",
1668
- "description": "Unique identifier of the player who is the subject of the request.",
1669
- "type": "string"
1670
- },
1671
- {
1672
- "code": "TsExpire",
1673
- "description": "TsExpire parameter.",
1674
- "type": "number"
1675
- },
1676
- {
1677
- "code": "Reason",
1678
- "description": "Reason parameter.",
1679
- "type": "string"
1680
- }
1681
- ]
1682
- },
1683
- {
1684
- "role": "Server",
1685
- "requestData": [
1686
- {
1687
- "code": "UserId",
1688
- "description": "Unique identifier of the player who is the subject of the request.",
1689
- "type": "string"
1690
- }
1691
- ]
1692
- }
1693
- ],
1694
- "description": "Apply a ban to a player with specific reason and duration."
1695
- },
1696
- {
1697
- "operationCode": "SetPlayerData",
1698
- "details": [
1699
- {
1700
- "role": "Client",
1701
- "requestData": [
1702
- {
1703
- "code": "UserId",
1704
- "description": "Unique identifier of the player who is the subject of the request.",
1705
- "type": "string"
1706
- },
1707
- {
1708
- "code": "PlayerDatas",
1709
- "description": "PlayerDatas parameter.",
1710
- "type": "Array<PlayerDataParam>"
1711
- }
1712
- ]
1713
- },
1714
- {
1715
- "role": "Server",
1716
- "requestData": [
1717
- {
1718
- "code": "UserId",
1719
- "description": "Unique identifier of the player who is the subject of the request.",
1720
- "type": "string"
1721
- }
1722
- ]
1723
- }
1724
- ],
1725
- "description": "Replace or modify structured player data."
1726
- },
1727
- {
1728
- "operationCode": "SetTag",
1729
- "details": [
1730
- {
1731
- "role": "Client",
1732
- "requestData": [
1733
- {
1734
- "code": "UserId",
1735
- "description": "Unique identifier of the player who is the subject of the request.",
1736
- "type": "string"
1737
- },
1738
- {
1739
- "code": "Key",
1740
- "description": "Key parameter.",
1741
- "type": "string"
1742
- },
1743
- {
1744
- "code": "Value",
1745
- "description": "String value representing the name or identifier of a segment or tag.",
1746
- "type": "string"
1747
- }
1748
- ]
1749
- },
1750
- {
1751
- "role": "Server",
1752
- "requestData": [
1753
- {
1754
- "code": "UserId",
1755
- "description": "Unique identifier of the player who is the subject of the request.",
1756
- "type": "string"
1757
- }
1758
- ]
1759
- }
1760
- ],
1761
- "description": "Assign a custom tag to the player for classification or filtering."
1762
- }
1763
- ],
1764
- "models": [
1765
- {
1766
- "name": "CustomDataParam",
1767
- "details": [
1768
- {
1769
- "code": "Key",
1770
- "description": "The key used to identify a custom data entry.",
1771
- "type": "string"
1772
- },
1773
- {
1774
- "code": "Value",
1775
- "description": "The value assigned to a custom or structured data key.",
1776
- "type": "any"
1777
- }
1778
- ],
1779
- "description": "Represents a key-value pair for custom player data."
1780
- },
1781
- {
1782
- "name": "GroupMemberParam",
1783
- "details": [
1784
- {
1785
- "code": "UserId",
1786
- "description": "Unique identifier of the player targeted by the operation.",
1787
- "type": "string"
1788
- }
1789
- ],
1790
- "description": "Specifies the user to be added to or removed from a group."
1791
- },
1792
- {
1793
- "name": "InfoRequestParam",
1794
- "details": [
1795
- {
1796
- "code": "Segments",
1797
- "description": "Include player segment information in the response.",
1798
- "type": "boolean",
1799
- "defaultValue": "false"
1800
- },
1801
- {
1802
- "code": "CustomDatas",
1803
- "description": "Include key-value custom data fields in the response.",
1804
- "type": "boolean",
1805
- "defaultValue": "false"
1806
- },
1807
- {
1808
- "code": "DisplayName",
1809
- "description": "Include the player's display name in the response.",
1810
- "type": "boolean",
1811
- "defaultValue": "false"
1812
- },
1813
- {
1814
- "code": "Avatar",
1815
- "description": "Include the player's avatar URL or image reference.",
1816
- "type": "boolean",
1817
- "defaultValue": "false"
1818
- },
1819
- {
1820
- "code": "TsCreate",
1821
- "description": "Include the timestamp when the player account was created.",
1822
- "type": "boolean",
1823
- "defaultValue": "false"
1824
- },
1825
- {
1826
- "code": "Tags",
1827
- "description": "Include tags assigned to the player.",
1828
- "type": "boolean",
1829
- "defaultValue": "false"
1830
- },
1831
- {
1832
- "code": "PlayerBan",
1833
- "description": "Include any ban status information in the response.",
1834
- "type": "boolean",
1835
- "defaultValue": "false"
1836
- },
1837
- {
1838
- "code": "PlayerCurrencies",
1839
- "description": "Include the player's virtual currency balances.",
1840
- "type": "boolean",
1841
- "defaultValue": "false"
1842
- },
1843
- {
1844
- "code": "PlayerStatistics",
1845
- "description": "Include the player's statistics.",
1846
- "type": "boolean",
1847
- "defaultValue": "false"
1848
- },
1849
- {
1850
- "code": "PlayerDatas",
1851
- "description": "PlayerDatas field in model InfoRequestParam.",
1852
- "type": "boolean",
1853
- "defaultValue": "false"
1854
- },
1855
- {
1856
- "code": "IpAddressCreate",
1857
- "description": "IpAddressCreate field in model InfoRequestParam.",
1858
- "type": "boolean",
1859
- "defaultValue": "false"
1860
- },
1861
- {
1862
- "code": "CountryCode",
1863
- "description": "CountryCode field in model InfoRequestParam.",
1864
- "type": "boolean",
1865
- "defaultValue": "false"
1866
- },
1867
- {
1868
- "code": "TsLastLogin",
1869
- "description": "TsLastLogin field in model InfoRequestParam.",
1870
- "type": "boolean",
1871
- "defaultValue": "false"
1872
- },
1873
- {
1874
- "code": "PlayerCharacters",
1875
- "description": "PlayerCharacters field in model InfoRequestParam.",
1876
- "type": "boolean",
1877
- "defaultValue": "false"
1878
- },
1879
- {
1880
- "code": "PlayerInventories",
1881
- "description": "PlayerInventories field in model InfoRequestParam.",
1882
- "type": "boolean",
1883
- "defaultValue": "false"
1884
- },
1885
- {
1886
- "code": "PlayerGroups",
1887
- "description": "PlayerGroups field in model InfoRequestParam.",
1888
- "type": "boolean",
1889
- "defaultValue": "false"
1890
- },
1891
- {
1892
- "code": "PlayerFriends",
1893
- "description": "PlayerFriends field in model InfoRequestParam.",
1894
- "type": "boolean",
1895
- "defaultValue": "false"
1896
- },
1897
- {
1898
- "code": "PlayerDataKeys",
1899
- "description": "PlayerDataKeys field in model InfoRequestParam.",
1900
- "type": "Array<string>"
1901
- },
1902
- {
1903
- "code": "PlayerCurrencyKeys",
1904
- "description": "PlayerCurrencyKeys field in model InfoRequestParam.",
1905
- "type": "Array<string>"
1906
- },
1907
- {
1908
- "code": "PlayerStatisticsKeys",
1909
- "description": "PlayerStatisticsKeys field in model InfoRequestParam.",
1910
- "type": "Array<string>"
1911
- },
1912
- {
1913
- "code": "CustomDataKeys",
1914
- "description": "CustomDataKeys field in model InfoRequestParam.",
1915
- "type": "Array<string>"
1916
- },
1917
- {
1918
- "code": "TagKeys",
1919
- "description": "TagKeys field in model InfoRequestParam.",
1920
- "type": "Array<string>"
1921
- },
1922
- {
1923
- "code": "CharacterCatalogIds",
1924
- "description": "CharacterCatalogIds field in model InfoRequestParam.",
1925
- "type": "Array<string>"
1926
- },
1927
- {
1928
- "code": "ItemCatalogIds",
1929
- "description": "ItemCatalogIds field in model InfoRequestParam.",
1930
- "type": "Array<string>"
1931
- },
1932
- {
1933
- "code": "GroupCatalogIds",
1934
- "description": "GroupCatalogIds field in model InfoRequestParam.",
1935
- "type": "Array<string>"
1936
- },
1937
- {
1938
- "code": "FriendCatalogIds",
1939
- "description": "FriendCatalogIds field in model InfoRequestParam.",
1940
- "type": "Array<string>"
1941
- }
1942
- ],
1943
- "description": "Defines which optional fields should be included in player information responses."
1944
- },
1945
- {
1946
- "name": "PlayerCurrencyParam",
1947
- "details": [
1948
- {
1949
- "code": "Key",
1950
- "description": "The key used to identify a custom data entry.",
1951
- "type": "string"
1952
- },
1953
- {
1954
- "code": "Amount",
1955
- "description": "Amount of currency added or removed.",
1956
- "type": "number"
1957
- }
1958
- ],
1959
- "description": "Specifies a currency type and the amount to modify."
1960
- },
1961
- {
1962
- "name": "PlayerDataParam",
1963
- "details": [
1964
- {
1965
- "code": "Key",
1966
- "description": "The key used to identify a custom data entry.",
1967
- "type": "string"
1968
- },
1969
- {
1970
- "code": "Value",
1971
- "description": "The value assigned to a custom or structured data key.",
1972
- "type": "any"
1973
- }
1974
- ],
1975
- "description": "Defines a key and value pair for structured player data."
1976
- },
1977
- {
1978
- "name": "PlayerStatisticsParam",
1979
- "details": [
1980
- {
1981
- "code": "Key",
1982
- "description": "The key used to identify a custom data entry.",
1983
- "type": "string"
1984
- },
1985
- {
1986
- "code": "Value",
1987
- "description": "The value assigned to a custom or structured data key.",
1988
- "type": "number"
1989
- }
1990
- ],
1991
- "description": "Specifies a statistic name and the value to set or increment."
1992
- },
1993
- {
1994
- "name": "InfoResponseParameters",
1995
- "details": [
1996
- {
1997
- "code": "Segments",
1998
- "description": "Include player segment information in the response.",
1999
- "type": "Array<string>"
2000
- },
2001
- {
2002
- "code": "CustomDatas",
2003
- "description": "Include key-value custom data fields in the response.",
2004
- "type": "Array<GenericModels.DataItem>"
2005
- },
2006
- {
2007
- "code": "DisplayName",
2008
- "description": "Include the player's display name in the response.",
2009
- "type": "string"
2010
- },
2011
- {
2012
- "code": "Avatar",
2013
- "description": "Include the player's avatar URL or image reference.",
2014
- "type": "GenericModels.AvatarItem"
2015
- },
2016
- {
2017
- "code": "TsCreate",
2018
- "description": "Include the timestamp when the player account was created.",
2019
- "type": "number"
2020
- },
2021
- {
2022
- "code": "Tags",
2023
- "description": "Include tags assigned to the player.",
2024
- "type": "Array<GenericModels.TagItem>"
2025
- },
2026
- {
2027
- "code": "PlayerBan",
2028
- "description": "Include any ban status information in the response.",
2029
- "type": "GenericModels.BanItem"
2030
- },
2031
- {
2032
- "code": "PlayerDatas",
2033
- "description": "PlayerDatas field in model InfoResponseParameters.",
2034
- "type": "Array<GenericModels.DataItem>"
2035
- },
2036
- {
2037
- "code": "PlayerCurrencies",
2038
- "description": "Include the player's virtual currency balances.",
2039
- "type": "Array<GenericModels.CurrencyItem>"
2040
- },
2041
- {
2042
- "code": "PlayerStatistics",
2043
- "description": "Include the player's statistics.",
2044
- "type": "Array<GenericModels.StatisticsItem>"
2045
- },
2046
- {
2047
- "code": "PlayerCharacters",
2048
- "description": "PlayerCharacters field in model InfoResponseParameters.",
2049
- "type": "Array<GenericModels.CharacterItem>"
2050
- },
2051
- {
2052
- "code": "PlayerInventories",
2053
- "description": "PlayerInventories field in model InfoResponseParameters.",
2054
- "type": "Array<GenericModels.InventoryItem>"
2055
- },
2056
- {
2057
- "code": "PlayerGroups",
2058
- "description": "PlayerGroups field in model InfoResponseParameters.",
2059
- "type": "Array<GenericModels.GroupItem>"
2060
- },
2061
- {
2062
- "code": "PlayerFriends",
2063
- "description": "PlayerFriends field in model InfoResponseParameters.",
2064
- "type": "Array<GenericModels.FriendItem>"
2065
- },
2066
- {
2067
- "code": "TsLastLogin",
2068
- "description": "TsLastLogin field in model InfoResponseParameters.",
2069
- "type": "number"
2070
- },
2071
- {
2072
- "code": "IpAddressCreate",
2073
- "description": "IpAddressCreate field in model InfoResponseParameters.",
2074
- "type": "string"
2075
- },
2076
- {
2077
- "code": "CountryCode",
2078
- "description": "CountryCode field in model InfoResponseParameters.",
2079
- "type": "string"
2080
- }
2081
- ],
2082
- "extends": null,
2083
- "description": "Contains optional metadata fields returned when requesting player info."
2084
- },
2085
- {
2086
- "name": "GamePlayerResponseData",
2087
- "details": [
2088
- {
2089
- "code": "InfoResponseParameters",
2090
- "description": "InfoResponseParameters field in model GamePlayerResponseData.",
2091
- "type": "InfoResponseParameters"
2092
- }
2093
- ],
2094
- "extends": null,
2095
- "description": "Contains detailed information about a single player."
2096
- },
2097
- {
2098
- "name": "GamePlayerWithUserIdResponseData",
2099
- "details": [
2100
- {
2101
- "code": "UserId",
2102
- "description": "Unique identifier of the player targeted by the operation.",
2103
- "type": "string"
2104
- },
2105
- {
2106
- "code": "InfoResponseParameters",
2107
- "description": "InfoResponseParameters field in model GamePlayerWithUserIdResponseData.",
2108
- "type": "InfoResponseParameters"
2109
- }
2110
- ],
2111
- "extends": null,
2112
- "description": "Player profile data returned using a UserId-based query."
2113
- },
2114
- {
2115
- "name": "GamePlayerLeaderboardResponseData",
2116
- "details": [
2117
- {
2118
- "code": "Position",
2119
- "description": "Position field in model GamePlayerLeaderboardResponseData.",
2120
- "type": "number"
2121
- },
2122
- {
2123
- "code": "BackupValue",
2124
- "description": "BackupValue field in model GamePlayerLeaderboardResponseData.",
2125
- "type": "number"
2126
- },
2127
- {
2128
- "code": "UserId",
2129
- "description": "Unique identifier of the player targeted by the operation.",
2130
- "type": "string"
2131
- },
2132
- {
2133
- "code": "InfoResponseParameters",
2134
- "description": "InfoResponseParameters field in model GamePlayerLeaderboardResponseData.",
2135
- "type": "InfoResponseParameters"
2136
- }
2137
- ],
2138
- "extends": null,
2139
- "description": "Leaderboard entry for a player including rank and statistic value."
2140
- },
2141
- {
2142
- "name": "GamePlayerLogResponseData",
2143
- "details": [
2144
- {
2145
- "code": "UserId",
2146
- "description": "Unique identifier of the player targeted by the operation.",
2147
- "type": "string"
2148
- },
2149
- {
2150
- "code": "TsCreate",
2151
- "description": "Include the timestamp when the player account was created.",
2152
- "type": "number"
2153
- },
2154
- {
2155
- "code": "Log",
2156
- "description": "Log field in model GamePlayerLogResponseData.",
2157
- "type": "string"
2158
- },
2159
- {
2160
- "code": "Key",
2161
- "description": "The key used to identify a custom data entry.",
2162
- "type": "string"
2163
- },
2164
- {
2165
- "code": "Amount",
2166
- "description": "Amount of currency added or removed.",
2167
- "type": "number"
2168
- },
2169
- {
2170
- "code": "StartValue",
2171
- "description": "StartValue field in model GamePlayerLogResponseData.",
2172
- "type": "number"
2173
- },
2174
- {
2175
- "code": "FinalValue",
2176
- "description": "FinalValue field in model GamePlayerLogResponseData.",
2177
- "type": "number"
2178
- }
2179
- ],
2180
- "extends": null,
2181
- "description": "A single log record from a player's history of actions or events."
2182
- },
2183
- {
2184
- "name": "GetStatisticsLeaderboardResponseData",
2185
- "details": [
2186
- {
2187
- "code": "Results",
2188
- "description": "Results field in model GetStatisticsLeaderboardResponseData.",
2189
- "type": "Array<GamePlayerLeaderboardResponseData>"
2190
- },
2191
- {
2192
- "code": "TsCreate",
2193
- "description": "Include the timestamp when the player account was created.",
2194
- "type": "number"
2195
- }
2196
- ],
2197
- "extends": null,
2198
- "description": "Response data containing ranked entries for a statistic-based leaderboard."
2199
- },
2200
- {
2201
- "name": "GetCurrencyLeaderboardResponseData",
2202
- "details": [
2203
- {
2204
- "code": "Results",
2205
- "description": "Results field in model GetCurrencyLeaderboardResponseData.",
2206
- "type": "Array<GamePlayerLeaderboardResponseData>"
2207
- }
2208
- ],
2209
- "extends": null,
2210
- "description": "Response data containing ranked entries for a currency-based leaderboard."
2211
- },
2212
- {
2213
- "name": "GetLastLoginLeaderboardResponseData",
2214
- "details": [
2215
- {
2216
- "code": "Results",
2217
- "description": "Results field in model GetLastLoginLeaderboardResponseData.",
2218
- "type": "Array<GamePlayerLeaderboardResponseData>"
2219
- }
2220
- ],
2221
- "extends": null,
2222
- "description": "Response data for a leaderboard ranked by last login times."
2223
- },
2224
- {
2225
- "name": "GetCreateLeaderboardResponseData",
2226
- "details": [
2227
- {
2228
- "code": "Results",
2229
- "description": "Results field in model GetCreateLeaderboardResponseData.",
2230
- "type": "Array<GamePlayerLeaderboardResponseData>"
2231
- }
2232
- ],
2233
- "extends": null,
2234
- "description": "Response data for a leaderboard ranked by account creation times."
2235
- },
2236
- {
2237
- "name": "GamePlayersWithUserIdResponseData",
2238
- "details": [
2239
- {
2240
- "code": "Results",
2241
- "description": "Results field in model GamePlayersWithUserIdResponseData.",
2242
- "type": "Array<GamePlayerWithUserIdResponseData>"
2243
- }
2244
- ],
2245
- "extends": null,
2246
- "description": "List of player profiles resolved from a list of UserIds."
2247
- },
2248
- {
2249
- "name": "OnlineStatusResponseData",
2250
- "details": [
2251
- {
2252
- "code": "TsLastLogin",
2253
- "description": "TsLastLogin field in model OnlineStatusResponseData.",
2254
- "type": "number"
2255
- },
2256
- {
2257
- "code": "SocketId",
2258
- "description": "SocketId field in model OnlineStatusResponseData.",
2259
- "type": "string"
2260
- }
2261
- ],
2262
- "extends": null,
2263
- "description": "Online/offline status and session metadata for a player."
2264
- },
2265
- {
2266
- "name": "GetStatisticsLogResponseData",
2267
- "details": [
2268
- {
2269
- "code": "Results",
2270
- "description": "Results field in model GetStatisticsLogResponseData.",
2271
- "type": "Array<GamePlayerLogResponseData>"
2272
- },
2273
- {
2274
- "code": "Token",
2275
- "description": "Token field in model GetStatisticsLogResponseData.",
2276
- "type": "string"
2277
- }
2278
- ],
2279
- "extends": null,
2280
- "description": "Record of changes made to a player's statistics."
2281
- },
2282
- {
2283
- "name": "GetCurrencyLogResponseData",
2284
- "details": [
2285
- {
2286
- "code": "Results",
2287
- "description": "Results field in model GetCurrencyLogResponseData.",
2288
- "type": "Array<GamePlayerLogResponseData>"
2289
- },
2290
- {
2291
- "code": "Token",
2292
- "description": "Token field in model GetCurrencyLogResponseData.",
2293
- "type": "string"
2294
- }
2295
- ],
2296
- "extends": null,
2297
- "description": "Record of virtual currency transactions for a player."
2298
- },
2299
- {
2300
- "name": "EmptyResponseData",
2301
- "details": [],
2302
- "extends": null,
2303
- "description": "Generic success response returned when no body content is required."
2304
- }
2305
- ]
2306
- }