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

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