@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
@@ -1,1211 +0,0 @@
1
- {
2
- "requestType": "Inventory",
3
- "description": "API endpoints for accessing and managing in-game items, their metadata, ownership, segments, and statistics.",
4
- "operations": [
5
- {
6
- "operationCode": "AddSegment",
7
- "details": [
8
- {
9
- "role": "Client",
10
- "requestData": [
11
- {
12
- "code": "ItemId",
13
- "description": "The unique identifier of the inventory item involved in the request.",
14
- "type": "string"
15
- },
16
- {
17
- "code": "Value",
18
- "description": "The value representing a segment, tag, or metadata label to assign or remove.",
19
- "type": "string"
20
- }
21
- ]
22
- }
23
- ],
24
- "description": "Adds a segment label to the specified inventory item for grouping or categorization."
25
- },
26
- {
27
- "operationCode": "ChangeItemStatistics",
28
- "details": [
29
- {
30
- "role": "Client",
31
- "requestData": [
32
- {
33
- "code": "ItemId",
34
- "description": "The unique identifier of the inventory item involved in the request.",
35
- "type": "string"
36
- },
37
- {
38
- "code": "ItemStatistics",
39
- "description": "A list of statistics to update on the specified inventory item.",
40
- "type": "Array<ItemStatisticsParam>"
41
- },
42
- {
43
- "code": "Log",
44
- "description": "An optional note describing the context or purpose of the operation.",
45
- "type": "string"
46
- }
47
- ]
48
- }
49
- ],
50
- "description": "Modifies one or more statistical values associated with the specified inventory item."
51
- },
52
- {
53
- "operationCode": "GetAmount",
54
- "details": [
55
- {
56
- "role": "Client",
57
- "requestData": [
58
- {
59
- "code": "ItemId",
60
- "description": "The unique identifier of the inventory item involved in the request.",
61
- "type": "string"
62
- }
63
- ]
64
- }
65
- ],
66
- "description": "Returns the current quantity of the specified inventory item."
67
- },
68
- {
69
- "operationCode": "GetAvatar",
70
- "details": [
71
- {
72
- "role": "Client",
73
- "requestData": [
74
- {
75
- "code": "ItemId",
76
- "description": "The unique identifier of the inventory item involved in the request.",
77
- "type": "string"
78
- }
79
- ]
80
- }
81
- ],
82
- "description": "Returns the avatar image or visual representation assigned to the specified item."
83
- },
84
- {
85
- "operationCode": "GetCatalogId",
86
- "details": [
87
- {
88
- "role": "Client",
89
- "requestData": [
90
- {
91
- "code": "ItemId",
92
- "description": "The unique identifier of the inventory item involved in the request.",
93
- "type": "string"
94
- }
95
- ]
96
- }
97
- ],
98
- "description": "Returns the catalog identifier from which the item was created."
99
- },
100
- {
101
- "operationCode": "GetClassId",
102
- "details": [
103
- {
104
- "role": "Client",
105
- "requestData": [
106
- {
107
- "code": "ItemId",
108
- "description": "The unique identifier of the inventory item involved in the request.",
109
- "type": "string"
110
- }
111
- ]
112
- }
113
- ],
114
- "description": "Executes the GetClassId operation on an inventory item."
115
- },
116
- {
117
- "operationCode": "GetCreateLeaderboard",
118
- "details": [
119
- {
120
- "role": "Client",
121
- "requestData": [
122
- {
123
- "code": "InfoRequestParam",
124
- "description": "InfoRequestParam parameter.",
125
- "type": "InfoRequestParam"
126
- },
127
- {
128
- "code": "Skip",
129
- "description": "Skip parameter.",
130
- "type": "number",
131
- "defaultValue": "0"
132
- },
133
- {
134
- "code": "Limit",
135
- "description": "Limit parameter.",
136
- "type": "number",
137
- "defaultValue": "10"
138
- },
139
- {
140
- "code": "LoadFromCache",
141
- "description": "LoadFromCache parameter.",
142
- "type": "boolean",
143
- "defaultValue": "true"
144
- }
145
- ]
146
- }
147
- ],
148
- "description": "Executes the GetCreateLeaderboard operation on an inventory item."
149
- },
150
- {
151
- "operationCode": "GetCustomData",
152
- "details": [
153
- {
154
- "role": "Client",
155
- "requestData": [
156
- {
157
- "code": "ItemId",
158
- "description": "The unique identifier of the inventory item involved in the request.",
159
- "type": "string"
160
- },
161
- {
162
- "code": "CustomDataKeys",
163
- "description": "CustomDataKeys parameter.",
164
- "type": "Array<string>"
165
- }
166
- ]
167
- }
168
- ],
169
- "description": "Executes the GetCustomData operation on an inventory item."
170
- },
171
- {
172
- "operationCode": "GetDisplayName",
173
- "details": [
174
- {
175
- "role": "Client",
176
- "requestData": [
177
- {
178
- "code": "ItemId",
179
- "description": "The unique identifier of the inventory item involved in the request.",
180
- "type": "string"
181
- }
182
- ]
183
- }
184
- ],
185
- "description": "Executes the GetDisplayName operation on an inventory item."
186
- },
187
- {
188
- "operationCode": "GetItemData",
189
- "details": [
190
- {
191
- "role": "Client",
192
- "requestData": [
193
- {
194
- "code": "ItemId",
195
- "description": "The unique identifier of the inventory item involved in the request.",
196
- "type": "string"
197
- },
198
- {
199
- "code": "ItemDataKeys",
200
- "description": "ItemDataKeys parameter.",
201
- "type": "Array<string>"
202
- }
203
- ]
204
- }
205
- ],
206
- "description": "Executes the GetItemData operation on an inventory item."
207
- },
208
- {
209
- "operationCode": "GetItemInformation",
210
- "details": [
211
- {
212
- "role": "Client",
213
- "requestData": [
214
- {
215
- "code": "ItemId",
216
- "description": "The unique identifier of the inventory item involved in the request.",
217
- "type": "string"
218
- },
219
- {
220
- "code": "InfoRequestParam",
221
- "description": "InfoRequestParam parameter.",
222
- "type": "InfoRequestParam"
223
- }
224
- ]
225
- }
226
- ],
227
- "description": "Executes the GetItemInformation operation on an inventory item."
228
- },
229
- {
230
- "operationCode": "GetItemStatistics",
231
- "details": [
232
- {
233
- "role": "Client",
234
- "requestData": [
235
- {
236
- "code": "ItemId",
237
- "description": "The unique identifier of the inventory item involved in the request.",
238
- "type": "string"
239
- },
240
- {
241
- "code": "StatisticsKeys",
242
- "description": "StatisticsKeys parameter.",
243
- "type": "Array<string>"
244
- }
245
- ]
246
- }
247
- ],
248
- "description": "Executes the GetItemStatistics operation on an inventory item."
249
- },
250
- {
251
- "operationCode": "GetItemsWithDisplayName",
252
- "details": [
253
- {
254
- "role": "Client",
255
- "requestData": [
256
- {
257
- "code": "Keyword",
258
- "description": "Keyword parameter.",
259
- "type": "string"
260
- },
261
- {
262
- "code": "InfoRequestParam",
263
- "description": "InfoRequestParam parameter.",
264
- "type": "InfoRequestParam"
265
- },
266
- {
267
- "code": "Skip",
268
- "description": "Skip parameter.",
269
- "type": "number",
270
- "defaultValue": "0"
271
- },
272
- {
273
- "code": "Limit",
274
- "description": "Limit parameter.",
275
- "type": "number",
276
- "defaultValue": "10"
277
- }
278
- ]
279
- }
280
- ],
281
- "description": "Executes the GetItemsWithDisplayName operation on an inventory item."
282
- },
283
- {
284
- "operationCode": "GetItemsWithSegment",
285
- "details": [
286
- {
287
- "role": "Client",
288
- "requestData": [
289
- {
290
- "code": "Value",
291
- "description": "The value representing a segment, tag, or metadata label to assign or remove.",
292
- "type": "string"
293
- },
294
- {
295
- "code": "InfoRequestParam",
296
- "description": "InfoRequestParam parameter.",
297
- "type": "InfoRequestParam"
298
- },
299
- {
300
- "code": "Skip",
301
- "description": "Skip parameter.",
302
- "type": "number",
303
- "defaultValue": "0"
304
- },
305
- {
306
- "code": "Limit",
307
- "description": "Limit parameter.",
308
- "type": "number",
309
- "defaultValue": "10"
310
- }
311
- ]
312
- }
313
- ],
314
- "description": "Executes the GetItemsWithSegment operation on an inventory item."
315
- },
316
- {
317
- "operationCode": "GetItemsWithTag",
318
- "details": [
319
- {
320
- "role": "Client",
321
- "requestData": [
322
- {
323
- "code": "Key",
324
- "description": "Key parameter.",
325
- "type": "string"
326
- },
327
- {
328
- "code": "Value",
329
- "description": "The value representing a segment, tag, or metadata label to assign or remove.",
330
- "type": "string"
331
- },
332
- {
333
- "code": "InfoRequestParam",
334
- "description": "InfoRequestParam parameter.",
335
- "type": "InfoRequestParam"
336
- },
337
- {
338
- "code": "Skip",
339
- "description": "Skip parameter.",
340
- "type": "number",
341
- "defaultValue": "0"
342
- },
343
- {
344
- "code": "Limit",
345
- "description": "Limit parameter.",
346
- "type": "number",
347
- "defaultValue": "10"
348
- }
349
- ]
350
- }
351
- ],
352
- "description": "Executes the GetItemsWithTag operation on an inventory item."
353
- },
354
- {
355
- "operationCode": "GetItemType",
356
- "details": [
357
- {
358
- "role": "Client",
359
- "requestData": [
360
- {
361
- "code": "ItemId",
362
- "description": "The unique identifier of the inventory item involved in the request.",
363
- "type": "string"
364
- }
365
- ]
366
- }
367
- ],
368
- "description": "Executes the GetItemType operation on an inventory item."
369
- },
370
- {
371
- "operationCode": "GetOwner",
372
- "details": [
373
- {
374
- "role": "Client",
375
- "requestData": [
376
- {
377
- "code": "ItemId",
378
- "description": "The unique identifier of the inventory item involved in the request.",
379
- "type": "string"
380
- }
381
- ]
382
- }
383
- ],
384
- "description": "Executes the GetOwner operation on an inventory item."
385
- },
386
- {
387
- "operationCode": "GetRemoveStatus",
388
- "details": [
389
- {
390
- "role": "Client",
391
- "requestData": [
392
- {
393
- "code": "ItemId",
394
- "description": "The unique identifier of the inventory item involved in the request.",
395
- "type": "string"
396
- }
397
- ]
398
- }
399
- ],
400
- "description": "Executes the GetRemoveStatus operation on an inventory item."
401
- },
402
- {
403
- "operationCode": "GetSegment",
404
- "details": [
405
- {
406
- "role": "Client",
407
- "requestData": [
408
- {
409
- "code": "ItemId",
410
- "description": "The unique identifier of the inventory item involved in the request.",
411
- "type": "string"
412
- }
413
- ]
414
- }
415
- ],
416
- "description": "Executes the GetSegment operation on an inventory item."
417
- },
418
- {
419
- "operationCode": "GetStatisticsLeaderboardAroundItem",
420
- "details": [
421
- {
422
- "role": "Client",
423
- "requestData": [
424
- {
425
- "code": "ItemId",
426
- "description": "The unique identifier of the inventory item involved in the request.",
427
- "type": "string"
428
- },
429
- {
430
- "code": "Key",
431
- "description": "Key parameter.",
432
- "type": "string"
433
- },
434
- {
435
- "code": "InfoRequestParam",
436
- "description": "InfoRequestParam parameter.",
437
- "type": "InfoRequestParam"
438
- },
439
- {
440
- "code": "Skip",
441
- "description": "Skip parameter.",
442
- "type": "number",
443
- "defaultValue": "0"
444
- },
445
- {
446
- "code": "Limit",
447
- "description": "Limit parameter.",
448
- "type": "number",
449
- "defaultValue": "10"
450
- },
451
- {
452
- "code": "LoadFromCache",
453
- "description": "LoadFromCache parameter.",
454
- "type": "boolean",
455
- "defaultValue": "true"
456
- },
457
- {
458
- "code": "CatalogId",
459
- "description": "Identifier of the item catalog used to create this item.",
460
- "type": "string"
461
- }
462
- ]
463
- }
464
- ],
465
- "description": "Executes the GetStatisticsLeaderboardAroundItem operation on an inventory item."
466
- },
467
- {
468
- "operationCode": "GetStatisticsLeaderboard",
469
- "details": [
470
- {
471
- "role": "Client",
472
- "requestData": [
473
- {
474
- "code": "Key",
475
- "description": "Key parameter.",
476
- "type": "string"
477
- },
478
- {
479
- "code": "InfoRequestParam",
480
- "description": "InfoRequestParam parameter.",
481
- "type": "InfoRequestParam"
482
- },
483
- {
484
- "code": "Skip",
485
- "description": "Skip parameter.",
486
- "type": "number",
487
- "defaultValue": "0"
488
- },
489
- {
490
- "code": "Limit",
491
- "description": "Limit parameter.",
492
- "type": "number",
493
- "defaultValue": "10"
494
- },
495
- {
496
- "code": "LoadFromCache",
497
- "description": "LoadFromCache parameter.",
498
- "type": "boolean",
499
- "defaultValue": "true"
500
- },
501
- {
502
- "code": "Version",
503
- "description": "Version parameter.",
504
- "type": "string"
505
- },
506
- {
507
- "code": "CatalogId",
508
- "description": "Identifier of the item catalog used to create this item.",
509
- "type": "string"
510
- }
511
- ]
512
- }
513
- ],
514
- "description": "Executes the GetStatisticsLeaderboard operation on an inventory item."
515
- },
516
- {
517
- "operationCode": "GetStatisticsLog",
518
- "details": [
519
- {
520
- "role": "Client",
521
- "requestData": [
522
- {
523
- "code": "Keys",
524
- "description": "A list of field names to retrieve from item data or custom fields.",
525
- "type": "Array<string>"
526
- },
527
- {
528
- "code": "ItemId",
529
- "description": "The unique identifier of the inventory item involved in the request.",
530
- "type": "string"
531
- },
532
- {
533
- "code": "Limit",
534
- "description": "Limit parameter.",
535
- "type": "number",
536
- "defaultValue": "10"
537
- },
538
- {
539
- "code": "Token",
540
- "description": "Token parameter.",
541
- "type": "string"
542
- }
543
- ]
544
- }
545
- ],
546
- "description": "Executes the GetStatisticsLog operation on an inventory item."
547
- },
548
- {
549
- "operationCode": "GetTag",
550
- "details": [
551
- {
552
- "role": "Client",
553
- "requestData": [
554
- {
555
- "code": "ItemId",
556
- "description": "The unique identifier of the inventory item involved in the request.",
557
- "type": "string"
558
- },
559
- {
560
- "code": "TagKeys",
561
- "description": "TagKeys parameter.",
562
- "type": "Array<string>"
563
- }
564
- ]
565
- }
566
- ],
567
- "description": "Executes the GetTag operation on an inventory item."
568
- },
569
- {
570
- "operationCode": "GetTsCreate",
571
- "details": [
572
- {
573
- "role": "Client",
574
- "requestData": [
575
- {
576
- "code": "ItemId",
577
- "description": "The unique identifier of the inventory item involved in the request.",
578
- "type": "string"
579
- }
580
- ]
581
- }
582
- ],
583
- "description": "Executes the GetTsCreate operation on an inventory item."
584
- },
585
- {
586
- "operationCode": "RemoveSegment",
587
- "details": [
588
- {
589
- "role": "Client",
590
- "requestData": [
591
- {
592
- "code": "ItemId",
593
- "description": "The unique identifier of the inventory item involved in the request.",
594
- "type": "string"
595
- },
596
- {
597
- "code": "Value",
598
- "description": "The value representing a segment, tag, or metadata label to assign or remove.",
599
- "type": "string"
600
- }
601
- ]
602
- }
603
- ],
604
- "description": "Executes the RemoveSegment operation on an inventory item."
605
- },
606
- {
607
- "operationCode": "RemoveTag",
608
- "details": [
609
- {
610
- "role": "Client",
611
- "requestData": [
612
- {
613
- "code": "ItemId",
614
- "description": "The unique identifier of the inventory item involved in the request.",
615
- "type": "string"
616
- },
617
- {
618
- "code": "Key",
619
- "description": "Key parameter.",
620
- "type": "string"
621
- }
622
- ]
623
- }
624
- ],
625
- "description": "Executes the RemoveTag operation on an inventory item."
626
- },
627
- {
628
- "operationCode": "SetAmount",
629
- "details": [
630
- {
631
- "role": "Client",
632
- "requestData": [
633
- {
634
- "code": "ItemId",
635
- "description": "The unique identifier of the inventory item involved in the request.",
636
- "type": "string"
637
- },
638
- {
639
- "code": "Amount",
640
- "description": "The quantity or stack size of the item.",
641
- "type": "number"
642
- }
643
- ]
644
- }
645
- ],
646
- "description": "Executes the SetAmount operation on an inventory item."
647
- },
648
- {
649
- "operationCode": "SetAvatar",
650
- "details": [
651
- {
652
- "role": "Client",
653
- "requestData": [
654
- {
655
- "code": "ItemId",
656
- "description": "The unique identifier of the inventory item involved in the request.",
657
- "type": "string"
658
- },
659
- {
660
- "code": "Type",
661
- "description": "Type parameter.",
662
- "type": "number"
663
- },
664
- {
665
- "code": "Value",
666
- "description": "The value representing a segment, tag, or metadata label to assign or remove.",
667
- "type": "string"
668
- }
669
- ]
670
- }
671
- ],
672
- "description": "Executes the SetAvatar operation on an inventory item."
673
- },
674
- {
675
- "operationCode": "SetCustomData",
676
- "details": [
677
- {
678
- "role": "Client",
679
- "requestData": [
680
- {
681
- "code": "ItemId",
682
- "description": "The unique identifier of the inventory item involved in the request.",
683
- "type": "string"
684
- },
685
- {
686
- "code": "CustomDatas",
687
- "description": "CustomDatas parameter.",
688
- "type": "Array<CustomDataParam>"
689
- }
690
- ]
691
- }
692
- ],
693
- "description": "Executes the SetCustomData operation on an inventory item."
694
- },
695
- {
696
- "operationCode": "SetDisplayName",
697
- "details": [
698
- {
699
- "role": "Client",
700
- "requestData": [
701
- {
702
- "code": "ItemId",
703
- "description": "The unique identifier of the inventory item involved in the request.",
704
- "type": "string"
705
- },
706
- {
707
- "code": "DisplayName",
708
- "description": "The human-readable name to assign or retrieve for the item.",
709
- "type": "string"
710
- }
711
- ]
712
- }
713
- ],
714
- "description": "Executes the SetDisplayName operation on an inventory item."
715
- },
716
- {
717
- "operationCode": "SetItemData",
718
- "details": [
719
- {
720
- "role": "Client",
721
- "requestData": [
722
- {
723
- "code": "ItemId",
724
- "description": "The unique identifier of the inventory item involved in the request.",
725
- "type": "string"
726
- },
727
- {
728
- "code": "ItemDatas",
729
- "description": "ItemDatas parameter.",
730
- "type": "Array<ItemDataParam>"
731
- }
732
- ]
733
- }
734
- ],
735
- "description": "Executes the SetItemData operation on an inventory item."
736
- },
737
- {
738
- "operationCode": "SetOwner",
739
- "details": [
740
- {
741
- "role": "Client",
742
- "requestData": [
743
- {
744
- "code": "ItemId",
745
- "description": "The unique identifier of the inventory item involved in the request.",
746
- "type": "string"
747
- },
748
- {
749
- "code": "NewOwnerId",
750
- "description": "NewOwnerId parameter.",
751
- "type": "string"
752
- },
753
- {
754
- "code": "NewOwnerType",
755
- "description": "NewOwnerType parameter.",
756
- "type": "number"
757
- }
758
- ]
759
- }
760
- ],
761
- "description": "Executes the SetOwner operation on an inventory item."
762
- },
763
- {
764
- "operationCode": "SetRemoveStatus",
765
- "details": [
766
- {
767
- "role": "Client",
768
- "requestData": [
769
- {
770
- "code": "ItemId",
771
- "description": "The unique identifier of the inventory item involved in the request.",
772
- "type": "string"
773
- },
774
- {
775
- "code": "Reason",
776
- "description": "Reason parameter.",
777
- "type": "string",
778
- "defaultValue": "\"\""
779
- }
780
- ]
781
- }
782
- ],
783
- "description": "Executes the SetRemoveStatus operation on an inventory item."
784
- },
785
- {
786
- "operationCode": "SetTag",
787
- "details": [
788
- {
789
- "role": "Client",
790
- "requestData": [
791
- {
792
- "code": "ItemId",
793
- "description": "The unique identifier of the inventory item involved in the request.",
794
- "type": "string"
795
- },
796
- {
797
- "code": "Key",
798
- "description": "Key parameter.",
799
- "type": "string"
800
- },
801
- {
802
- "code": "Value",
803
- "description": "The value representing a segment, tag, or metadata label to assign or remove.",
804
- "type": "string"
805
- }
806
- ]
807
- }
808
- ],
809
- "description": "Executes the SetTag operation on an inventory item."
810
- }
811
- ],
812
- "models": [
813
- {
814
- "name": "CustomDataParam",
815
- "details": [
816
- {
817
- "code": "Key",
818
- "description": "Key used to identify a custom or structured data entry.",
819
- "type": "string"
820
- },
821
- {
822
- "code": "Value",
823
- "description": "The value stored for the specified key.",
824
- "type": "any"
825
- }
826
- ],
827
- "description": "Represents a custom key-value entry associated with an item."
828
- },
829
- {
830
- "name": "InfoRequestParam",
831
- "details": [
832
- {
833
- "code": "CatalogId",
834
- "description": "CatalogId field in InfoRequestParam.",
835
- "type": "boolean",
836
- "defaultValue": "false"
837
- },
838
- {
839
- "code": "ClassId",
840
- "description": "ClassId field in InfoRequestParam.",
841
- "type": "boolean",
842
- "defaultValue": "false"
843
- },
844
- {
845
- "code": "ItemType",
846
- "description": "ItemType field in InfoRequestParam.",
847
- "type": "boolean",
848
- "defaultValue": "false"
849
- },
850
- {
851
- "code": "Amount",
852
- "description": "Amount field in InfoRequestParam.",
853
- "type": "boolean",
854
- "defaultValue": "false"
855
- },
856
- {
857
- "code": "Owner",
858
- "description": "Owner field in InfoRequestParam.",
859
- "type": "boolean",
860
- "defaultValue": "false"
861
- },
862
- {
863
- "code": "RemoveStatus",
864
- "description": "RemoveStatus field in InfoRequestParam.",
865
- "type": "boolean",
866
- "defaultValue": "false"
867
- },
868
- {
869
- "code": "Segments",
870
- "description": "Whether to include item segment data in the response.",
871
- "type": "boolean",
872
- "defaultValue": "false"
873
- },
874
- {
875
- "code": "CustomDatas",
876
- "description": "Whether to include custom data in the item response.",
877
- "type": "boolean",
878
- "defaultValue": "false"
879
- },
880
- {
881
- "code": "DisplayName",
882
- "description": "Whether to include the item's display name.",
883
- "type": "boolean",
884
- "defaultValue": "false"
885
- },
886
- {
887
- "code": "Avatar",
888
- "description": "Whether to include the item’s avatar or image reference.",
889
- "type": "boolean",
890
- "defaultValue": "false"
891
- },
892
- {
893
- "code": "TsCreate",
894
- "description": "Whether to include the timestamp of item creation.",
895
- "type": "boolean",
896
- "defaultValue": "false"
897
- },
898
- {
899
- "code": "Tags",
900
- "description": "Whether to include tags associated with the item.",
901
- "type": "boolean",
902
- "defaultValue": "false"
903
- },
904
- {
905
- "code": "ItemStatistics",
906
- "description": "List of statistics stored on the item.",
907
- "type": "boolean",
908
- "defaultValue": "false"
909
- },
910
- {
911
- "code": "ItemDatas",
912
- "description": "ItemDatas field in InfoRequestParam.",
913
- "type": "boolean",
914
- "defaultValue": "false"
915
- },
916
- {
917
- "code": "ItemDataKeys",
918
- "description": "ItemDataKeys field in InfoRequestParam.",
919
- "type": "Array<string>"
920
- },
921
- {
922
- "code": "ItemStatisticsKeys",
923
- "description": "ItemStatisticsKeys field in InfoRequestParam.",
924
- "type": "Array<string>"
925
- },
926
- {
927
- "code": "CustomDataKeys",
928
- "description": "CustomDataKeys field in InfoRequestParam.",
929
- "type": "Array<string>"
930
- },
931
- {
932
- "code": "TagKeys",
933
- "description": "TagKeys field in InfoRequestParam.",
934
- "type": "Array<string>"
935
- }
936
- ],
937
- "description": "Flags for selecting which optional fields to include in the item response."
938
- },
939
- {
940
- "name": "ItemDataParam",
941
- "details": [
942
- {
943
- "code": "Key",
944
- "description": "Key used to identify a custom or structured data entry.",
945
- "type": "string"
946
- },
947
- {
948
- "code": "Value",
949
- "description": "The value stored for the specified key.",
950
- "type": "any"
951
- }
952
- ],
953
- "description": "Structured key-value pair representing core data assigned to an item."
954
- },
955
- {
956
- "name": "ItemStatisticsParam",
957
- "details": [
958
- {
959
- "code": "Key",
960
- "description": "Key used to identify a custom or structured data entry.",
961
- "type": "string"
962
- },
963
- {
964
- "code": "Value",
965
- "description": "The value stored for the specified key.",
966
- "type": "number"
967
- }
968
- ],
969
- "description": "Defines a statistic name and value to update for an item."
970
- },
971
- {
972
- "name": "InfoResponseParameters",
973
- "details": [
974
- {
975
- "code": "CatalogId",
976
- "description": "CatalogId field in InfoResponseParameters.",
977
- "type": "string"
978
- },
979
- {
980
- "code": "ClassId",
981
- "description": "ClassId field in InfoResponseParameters.",
982
- "type": "string"
983
- },
984
- {
985
- "code": "ItemType",
986
- "description": "ItemType field in InfoResponseParameters.",
987
- "type": "number"
988
- },
989
- {
990
- "code": "Amount",
991
- "description": "Amount field in InfoResponseParameters.",
992
- "type": "number"
993
- },
994
- {
995
- "code": "Owner",
996
- "description": "Owner field in InfoResponseParameters.",
997
- "type": "GenericModels.OwnerItem"
998
- },
999
- {
1000
- "code": "RemoveStatus",
1001
- "description": "RemoveStatus field in InfoResponseParameters.",
1002
- "type": "GenericModels.RemoveStatusItem"
1003
- },
1004
- {
1005
- "code": "Segments",
1006
- "description": "Whether to include item segment data in the response.",
1007
- "type": "Array<string>"
1008
- },
1009
- {
1010
- "code": "CustomDatas",
1011
- "description": "Whether to include custom data in the item response.",
1012
- "type": "Array<GenericModels.DataItem>"
1013
- },
1014
- {
1015
- "code": "DisplayName",
1016
- "description": "Whether to include the item's display name.",
1017
- "type": "string"
1018
- },
1019
- {
1020
- "code": "Avatar",
1021
- "description": "Whether to include the item’s avatar or image reference.",
1022
- "type": "GenericModels.AvatarItem"
1023
- },
1024
- {
1025
- "code": "TsCreate",
1026
- "description": "Whether to include the timestamp of item creation.",
1027
- "type": "number"
1028
- },
1029
- {
1030
- "code": "Tags",
1031
- "description": "Whether to include tags associated with the item.",
1032
- "type": "Array<GenericModels.TagItem>"
1033
- },
1034
- {
1035
- "code": "ItemDatas",
1036
- "description": "ItemDatas field in InfoResponseParameters.",
1037
- "type": "Array<GenericModels.DataItem>"
1038
- },
1039
- {
1040
- "code": "ItemStatistics",
1041
- "description": "List of statistics stored on the item.",
1042
- "type": "Array<GenericModels.StatisticsItem>"
1043
- }
1044
- ],
1045
- "extends": null,
1046
- "description": "Contains optional fields included in item responses."
1047
- },
1048
- {
1049
- "name": "InventoryResponseData",
1050
- "details": [
1051
- {
1052
- "code": "InfoResponseParameters",
1053
- "description": "InfoResponseParameters field in InventoryResponseData.",
1054
- "type": "InfoResponseParameters"
1055
- }
1056
- ],
1057
- "extends": null,
1058
- "description": "Contains profile and metadata for a single item."
1059
- },
1060
- {
1061
- "name": "InventoryWithItemIdResponseData",
1062
- "details": [
1063
- {
1064
- "code": "ItemId",
1065
- "description": "ItemId field in InventoryWithItemIdResponseData.",
1066
- "type": "string"
1067
- },
1068
- {
1069
- "code": "InfoResponseParameters",
1070
- "description": "InfoResponseParameters field in InventoryWithItemIdResponseData.",
1071
- "type": "InfoResponseParameters"
1072
- }
1073
- ],
1074
- "extends": null,
1075
- "description": "Response data for a query targeting a specific ItemId."
1076
- },
1077
- {
1078
- "name": "InventoryLeaderboardResponseData",
1079
- "details": [
1080
- {
1081
- "code": "Position",
1082
- "description": "Position field in InventoryLeaderboardResponseData.",
1083
- "type": "number"
1084
- },
1085
- {
1086
- "code": "BackupValue",
1087
- "description": "BackupValue field in InventoryLeaderboardResponseData.",
1088
- "type": "number"
1089
- },
1090
- {
1091
- "code": "ItemId",
1092
- "description": "ItemId field in InventoryLeaderboardResponseData.",
1093
- "type": "string"
1094
- },
1095
- {
1096
- "code": "InfoResponseParameters",
1097
- "description": "InfoResponseParameters field in InventoryLeaderboardResponseData.",
1098
- "type": "InfoResponseParameters"
1099
- }
1100
- ],
1101
- "extends": null,
1102
- "description": "Leaderboard entry including rank and value for an item."
1103
- },
1104
- {
1105
- "name": "InventoryLogResponseData",
1106
- "details": [
1107
- {
1108
- "code": "ItemId",
1109
- "description": "ItemId field in InventoryLogResponseData.",
1110
- "type": "string"
1111
- },
1112
- {
1113
- "code": "TsCreate",
1114
- "description": "Whether to include the timestamp of item creation.",
1115
- "type": "number"
1116
- },
1117
- {
1118
- "code": "Log",
1119
- "description": "Log field in InventoryLogResponseData.",
1120
- "type": "string"
1121
- },
1122
- {
1123
- "code": "Key",
1124
- "description": "Key used to identify a custom or structured data entry.",
1125
- "type": "string"
1126
- },
1127
- {
1128
- "code": "Amount",
1129
- "description": "Amount field in InventoryLogResponseData.",
1130
- "type": "number"
1131
- },
1132
- {
1133
- "code": "StartValue",
1134
- "description": "StartValue field in InventoryLogResponseData.",
1135
- "type": "number"
1136
- },
1137
- {
1138
- "code": "FinalValue",
1139
- "description": "FinalValue field in InventoryLogResponseData.",
1140
- "type": "number"
1141
- }
1142
- ],
1143
- "extends": null,
1144
- "description": "Log entry capturing a change event for the item."
1145
- },
1146
- {
1147
- "name": "GetStatisticsLeaderboardResponseData",
1148
- "details": [
1149
- {
1150
- "code": "Results",
1151
- "description": "Results field in GetStatisticsLeaderboardResponseData.",
1152
- "type": "Array<InventoryLeaderboardResponseData>"
1153
- },
1154
- {
1155
- "code": "TsCreate",
1156
- "description": "Whether to include the timestamp of item creation.",
1157
- "type": "number"
1158
- }
1159
- ],
1160
- "extends": null,
1161
- "description": "Leaderboard entries ranked by a specific statistic."
1162
- },
1163
- {
1164
- "name": "InventoriesWithItemIdResponseData",
1165
- "details": [
1166
- {
1167
- "code": "Results",
1168
- "description": "Results field in InventoriesWithItemIdResponseData.",
1169
- "type": "Array<InventoryWithItemIdResponseData>"
1170
- }
1171
- ],
1172
- "extends": null,
1173
- "description": "Response containing multiple items resolved by ItemId."
1174
- },
1175
- {
1176
- "name": "GetCreateLeaderboardResponseData",
1177
- "details": [
1178
- {
1179
- "code": "Results",
1180
- "description": "Results field in GetCreateLeaderboardResponseData.",
1181
- "type": "Array<InventoryLeaderboardResponseData>"
1182
- }
1183
- ],
1184
- "extends": null,
1185
- "description": "Leaderboard entries ranked by item creation timestamps."
1186
- },
1187
- {
1188
- "name": "GetStatisticsLogResponseData",
1189
- "details": [
1190
- {
1191
- "code": "Results",
1192
- "description": "Results field in GetStatisticsLogResponseData.",
1193
- "type": "Array<InventoryLogResponseData>"
1194
- },
1195
- {
1196
- "code": "Token",
1197
- "description": "Token field in GetStatisticsLogResponseData.",
1198
- "type": "string"
1199
- }
1200
- ],
1201
- "extends": null,
1202
- "description": "Log history of statistic updates for an item."
1203
- },
1204
- {
1205
- "name": "EmptyResponseData",
1206
- "details": [],
1207
- "extends": null,
1208
- "description": "Generic response used for successful operations that return no content."
1209
- }
1210
- ]
1211
- }