@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,1099 +0,0 @@
1
- {
2
- "requestType": "StoreInventory",
3
- "description": "API endpoints for managing virtual store items, in-app purchases, store usage logs, and third-party receipt validation.",
4
- "operations": [
5
- {
6
- "operationCode": "BuyStoreItem",
7
- "details": [
8
- {
9
- "role": "Client",
10
- "requestData": [
11
- {
12
- "code": "StoreId",
13
- "description": "Unique identifier of the store item.",
14
- "type": "string"
15
- },
16
- {
17
- "code": "Id",
18
- "description": "The unique identifier of the in-game item associated with the store entry.",
19
- "type": "string"
20
- },
21
- {
22
- "code": "Type",
23
- "description": "Specifies the item type (e.g., virtual, consumable, bundle) to determine store behavior.",
24
- "type": "number"
25
- },
26
- {
27
- "code": "Log",
28
- "description": "Optional message for audit logs or contextual information during the transaction.",
29
- "type": "string"
30
- }
31
- ]
32
- }
33
- ],
34
- "description": "Processes the purchase of a store item using virtual currencies or in-app purchase identifiers."
35
- },
36
- {
37
- "operationCode": "CreateStoreItem",
38
- "details": [
39
- {
40
- "role": "Client",
41
- "requestData": [
42
- {
43
- "code": "StoreId",
44
- "description": "Unique identifier of the store item.",
45
- "type": "string"
46
- },
47
- {
48
- "code": "DisplayName",
49
- "description": "Public-facing name of the store item.",
50
- "type": "string",
51
- "defaultValue": "\"\""
52
- }
53
- ]
54
- }
55
- ],
56
- "description": "Creates a new store item with specified metadata and pricing information."
57
- },
58
- {
59
- "operationCode": "GetCreateLeaderboard",
60
- "details": [
61
- {
62
- "role": "Client",
63
- "requestData": [
64
- {
65
- "code": "InfoRequestParam",
66
- "description": "Optional flags that determine which additional metadata to include in the response.",
67
- "type": "InfoRequestParam"
68
- },
69
- {
70
- "code": "Skip",
71
- "description": "The number of items to skip when paginating results.",
72
- "type": "number",
73
- "defaultValue": "0"
74
- },
75
- {
76
- "code": "Limit",
77
- "description": "The maximum number of results to return per request.",
78
- "type": "number",
79
- "defaultValue": "10"
80
- },
81
- {
82
- "code": "LoadFromCache",
83
- "description": "Indicates whether cached results are acceptable for this operation.",
84
- "type": "boolean",
85
- "defaultValue": "true"
86
- }
87
- ]
88
- }
89
- ],
90
- "description": "Returns a leaderboard of store items ranked by creation timestamp."
91
- },
92
- {
93
- "operationCode": "GetStoreItemInformation",
94
- "details": [
95
- {
96
- "role": "Client",
97
- "requestData": [
98
- {
99
- "code": "StoreId",
100
- "description": "Unique identifier of the store item.",
101
- "type": "string"
102
- },
103
- {
104
- "code": "InfoRequestParam",
105
- "description": "Optional flags that determine which additional metadata to include in the response.",
106
- "type": "InfoRequestParam"
107
- }
108
- ]
109
- }
110
- ],
111
- "description": "Retrieves metadata and purchase configuration for a specific store item."
112
- },
113
- {
114
- "operationCode": "GetStoreItemsWithTag",
115
- "details": [
116
- {
117
- "role": "Client",
118
- "requestData": [
119
- {
120
- "code": "Key",
121
- "description": "Key used to filter store items based on metadata tags.",
122
- "type": "string"
123
- },
124
- {
125
- "code": "Value",
126
- "description": "Value corresponding to the key for tag-based filtering of store items.",
127
- "type": "string"
128
- },
129
- {
130
- "code": "InfoRequestParam",
131
- "description": "Optional flags that determine which additional metadata to include in the response.",
132
- "type": "InfoRequestParam"
133
- },
134
- {
135
- "code": "Skip",
136
- "description": "The number of items to skip when paginating results.",
137
- "type": "number",
138
- "defaultValue": "0"
139
- },
140
- {
141
- "code": "Limit",
142
- "description": "The maximum number of results to return per request.",
143
- "type": "number",
144
- "defaultValue": "10"
145
- }
146
- ]
147
- }
148
- ],
149
- "description": "Returns all store items that match a specific tag."
150
- },
151
- {
152
- "operationCode": "GetStoreLog",
153
- "details": [
154
- {
155
- "role": "Client",
156
- "requestData": [
157
- {
158
- "code": "StoreId",
159
- "description": "Unique identifier of the store item.",
160
- "type": "string"
161
- },
162
- {
163
- "code": "StoreReceiveTypes",
164
- "description": "StoreReceiveTypes parameter.",
165
- "type": "Array<number>"
166
- },
167
- {
168
- "code": "Id",
169
- "description": "The unique identifier of the in-game item associated with the store entry.",
170
- "type": "string"
171
- },
172
- {
173
- "code": "Limit",
174
- "description": "The maximum number of results to return per request.",
175
- "type": "number",
176
- "defaultValue": "10"
177
- },
178
- {
179
- "code": "Token",
180
- "description": "Token parameter.",
181
- "type": "string"
182
- }
183
- ]
184
- }
185
- ],
186
- "description": "Retrieves a log of purchases or updates made to store items."
187
- },
188
- {
189
- "operationCode": "GetStoreUsed",
190
- "details": [
191
- {
192
- "role": "Client",
193
- "requestData": [
194
- {
195
- "code": "StoreId",
196
- "description": "Unique identifier of the store item.",
197
- "type": "string"
198
- }
199
- ]
200
- }
201
- ],
202
- "description": "Fetches usage history for store items that have been bought or consumed."
203
- },
204
- {
205
- "operationCode": "PresentStoreItem",
206
- "details": [
207
- {
208
- "role": "Client",
209
- "requestData": [
210
- {
211
- "code": "StoreId",
212
- "description": "Unique identifier of the store item.",
213
- "type": "string"
214
- },
215
- {
216
- "code": "Id",
217
- "description": "The unique identifier of the in-game item associated with the store entry.",
218
- "type": "string"
219
- },
220
- {
221
- "code": "Type",
222
- "description": "Specifies the item type (e.g., virtual, consumable, bundle) to determine store behavior.",
223
- "type": "number"
224
- },
225
- {
226
- "code": "Log",
227
- "description": "Optional message for audit logs or contextual information during the transaction.",
228
- "type": "string"
229
- }
230
- ]
231
- }
232
- ],
233
- "description": "Grants a store item to a player without requiring a purchase."
234
- },
235
- {
236
- "operationCode": "RemoveStoreUsed",
237
- "details": [
238
- {
239
- "role": "Client",
240
- "requestData": [
241
- {
242
- "code": "StoreId",
243
- "description": "Unique identifier of the store item.",
244
- "type": "string"
245
- },
246
- {
247
- "code": "OwnerIds",
248
- "description": "OwnerIds parameter.",
249
- "type": "Array<string>"
250
- }
251
- ]
252
- }
253
- ],
254
- "description": "Deletes the usage history or usage marker of a specific store item."
255
- },
256
- {
257
- "operationCode": "SetRemoveStatus",
258
- "details": [
259
- {
260
- "role": "Client",
261
- "requestData": [
262
- {
263
- "code": "StoreId",
264
- "description": "Unique identifier of the store item.",
265
- "type": "string"
266
- },
267
- {
268
- "code": "Reason",
269
- "description": "Reason parameter.",
270
- "type": "string",
271
- "defaultValue": "\"\""
272
- }
273
- ]
274
- }
275
- ],
276
- "description": "Marks a store item as removed or restores a previously removed item."
277
- },
278
- {
279
- "operationCode": "SetStoreItemInformation",
280
- "details": [
281
- {
282
- "role": "Client",
283
- "requestData": [
284
- {
285
- "code": "StoreId",
286
- "description": "Unique identifier of the store item.",
287
- "type": "string"
288
- },
289
- {
290
- "code": "StoreItemType",
291
- "description": "StoreItemType parameter.",
292
- "type": "number"
293
- },
294
- {
295
- "code": "StoreDatas",
296
- "description": "StoreDatas parameter.",
297
- "type": "Array<StoreDataParam>"
298
- },
299
- {
300
- "code": "StoreItems",
301
- "description": "StoreItems parameter.",
302
- "type": "Array<StoreItemParam>"
303
- },
304
- {
305
- "code": "StoreCurrencies",
306
- "description": "StoreCurrencies parameter.",
307
- "type": "Array<CurrencyParam>"
308
- },
309
- {
310
- "code": "PriceCurrencies",
311
- "description": "PriceCurrencies parameter.",
312
- "type": "Array<CurrencyParam>"
313
- },
314
- {
315
- "code": "InAppPurchase",
316
- "description": "InAppPurchase parameter.",
317
- "type": "InAppPurchaseParam"
318
- },
319
- {
320
- "code": "DisplayName",
321
- "description": "Public-facing name of the store item.",
322
- "type": "string"
323
- },
324
- {
325
- "code": "Avatar",
326
- "description": "Visual representation or image URL of the store item.",
327
- "type": "AvatarParam"
328
- },
329
- {
330
- "code": "Tags",
331
- "description": "Tags parameter.",
332
- "type": "Array<TagParam>"
333
- }
334
- ]
335
- }
336
- ],
337
- "description": "Updates pricing, metadata, or configuration for an existing store item."
338
- },
339
- {
340
- "operationCode": "ValidateAppleAppStoreReceipt",
341
- "details": [
342
- {
343
- "role": "Client",
344
- "requestData": [
345
- {
346
- "code": "Receipt",
347
- "description": "Encoded receipt string used to validate the purchase.",
348
- "type": "string"
349
- },
350
- {
351
- "code": "Id",
352
- "description": "The unique identifier of the in-game item associated with the store entry.",
353
- "type": "string"
354
- },
355
- {
356
- "code": "Type",
357
- "description": "Specifies the item type (e.g., virtual, consumable, bundle) to determine store behavior.",
358
- "type": "number"
359
- },
360
- {
361
- "code": "Log",
362
- "description": "Optional message for audit logs or contextual information during the transaction.",
363
- "type": "string"
364
- }
365
- ]
366
- }
367
- ],
368
- "description": "Validates an Apple App Store receipt for an in-app purchase."
369
- },
370
- {
371
- "operationCode": "ValidateFacebookStoreReceipt",
372
- "details": [
373
- {
374
- "role": "Client",
375
- "requestData": [
376
- {
377
- "code": "Receipt",
378
- "description": "Encoded receipt string used to validate the purchase.",
379
- "type": "string"
380
- },
381
- {
382
- "code": "Id",
383
- "description": "The unique identifier of the in-game item associated with the store entry.",
384
- "type": "string"
385
- },
386
- {
387
- "code": "Type",
388
- "description": "Specifies the item type (e.g., virtual, consumable, bundle) to determine store behavior.",
389
- "type": "number"
390
- },
391
- {
392
- "code": "Log",
393
- "description": "Optional message for audit logs or contextual information during the transaction.",
394
- "type": "string"
395
- }
396
- ]
397
- }
398
- ],
399
- "description": "Validates a Facebook payment receipt for a purchased item."
400
- },
401
- {
402
- "operationCode": "ValidateGooglePlayStoreReceipt",
403
- "details": [
404
- {
405
- "role": "Client",
406
- "requestData": [
407
- {
408
- "code": "Receipt",
409
- "description": "Encoded receipt string used to validate the purchase.",
410
- "type": "string"
411
- },
412
- {
413
- "code": "Id",
414
- "description": "The unique identifier of the in-game item associated with the store entry.",
415
- "type": "string"
416
- },
417
- {
418
- "code": "Type",
419
- "description": "Specifies the item type (e.g., virtual, consumable, bundle) to determine store behavior.",
420
- "type": "number"
421
- },
422
- {
423
- "code": "Log",
424
- "description": "Optional message for audit logs or contextual information during the transaction.",
425
- "type": "string"
426
- }
427
- ]
428
- }
429
- ],
430
- "description": "Validates a Google Play receipt for an in-app purchase."
431
- }
432
- ],
433
- "models": [
434
- {
435
- "name": "AvatarParam",
436
- "details": [
437
- {
438
- "code": "Type",
439
- "description": "Type field in AvatarParam.",
440
- "type": "number"
441
- },
442
- {
443
- "code": "Value",
444
- "description": "Value field in AvatarParam.",
445
- "type": "string"
446
- }
447
- ],
448
- "description": "Represents avatar configuration for store items."
449
- },
450
- {
451
- "name": "CurrencyParam",
452
- "details": [
453
- {
454
- "code": "Key",
455
- "description": "Key field in CurrencyParam.",
456
- "type": "string"
457
- },
458
- {
459
- "code": "Value",
460
- "description": "Value field in CurrencyParam.",
461
- "type": "number"
462
- }
463
- ],
464
- "description": "Defines a virtual currency and its corresponding amount."
465
- },
466
- {
467
- "name": "InAppPurchaseParam",
468
- "details": [
469
- {
470
- "code": "FacebookStoreId",
471
- "description": "FacebookStoreId field in InAppPurchaseParam.",
472
- "type": "string"
473
- },
474
- {
475
- "code": "GooglePlayStoreId",
476
- "description": "GooglePlayStoreId field in InAppPurchaseParam.",
477
- "type": "string"
478
- },
479
- {
480
- "code": "AppleAppStoreId",
481
- "description": "AppleAppStoreId field in InAppPurchaseParam.",
482
- "type": "string"
483
- },
484
- {
485
- "code": "AnalyticsPrice",
486
- "description": "AnalyticsPrice field in InAppPurchaseParam.",
487
- "type": "number"
488
- }
489
- ],
490
- "description": "Represents an in-app purchase transaction with its metadata."
491
- },
492
- {
493
- "name": "InfoRequestParam",
494
- "details": [
495
- {
496
- "code": "StoreItems",
497
- "description": "StoreItems field in InfoRequestParam.",
498
- "type": "boolean",
499
- "defaultValue": "false"
500
- },
501
- {
502
- "code": "StoreItemType",
503
- "description": "StoreItemType field in InfoRequestParam.",
504
- "type": "boolean",
505
- "defaultValue": "false"
506
- },
507
- {
508
- "code": "StoreCurrencies",
509
- "description": "StoreCurrencies field in InfoRequestParam.",
510
- "type": "boolean",
511
- "defaultValue": "false"
512
- },
513
- {
514
- "code": "PriceCurrencies",
515
- "description": "PriceCurrencies field in InfoRequestParam.",
516
- "type": "boolean",
517
- "defaultValue": "false"
518
- },
519
- {
520
- "code": "InAppPurchase",
521
- "description": "InAppPurchase field in InfoRequestParam.",
522
- "type": "boolean",
523
- "defaultValue": "false"
524
- },
525
- {
526
- "code": "RemoveStatus",
527
- "description": "RemoveStatus field in InfoRequestParam.",
528
- "type": "boolean",
529
- "defaultValue": "false"
530
- },
531
- {
532
- "code": "DisplayName",
533
- "description": "Display name shown to users for this store item.",
534
- "type": "boolean",
535
- "defaultValue": "false"
536
- },
537
- {
538
- "code": "Avatar",
539
- "description": "Visual image or icon associated with the store item.",
540
- "type": "boolean",
541
- "defaultValue": "false"
542
- },
543
- {
544
- "code": "TsCreate",
545
- "description": "TsCreate field in InfoRequestParam.",
546
- "type": "boolean",
547
- "defaultValue": "false"
548
- },
549
- {
550
- "code": "Tags",
551
- "description": "Tags field in InfoRequestParam.",
552
- "type": "boolean",
553
- "defaultValue": "false"
554
- },
555
- {
556
- "code": "StoreDatas",
557
- "description": "StoreDatas field in InfoRequestParam.",
558
- "type": "boolean",
559
- "defaultValue": "false"
560
- }
561
- ],
562
- "description": "Flags specifying optional fields to include in store responses."
563
- },
564
- {
565
- "name": "StoreDataParam",
566
- "details": [
567
- {
568
- "code": "Key",
569
- "description": "Key field in StoreDataParam.",
570
- "type": "string"
571
- },
572
- {
573
- "code": "Value",
574
- "description": "Value field in StoreDataParam.",
575
- "type": "any"
576
- }
577
- ],
578
- "description": "Contains structured data associated with a store item."
579
- },
580
- {
581
- "name": "StoreItemParam",
582
- "details": [
583
- {
584
- "code": "CatalogId",
585
- "description": "CatalogId field in StoreItemParam.",
586
- "type": "string"
587
- },
588
- {
589
- "code": "ClassId",
590
- "description": "ClassId field in StoreItemParam.",
591
- "type": "string"
592
- },
593
- {
594
- "code": "Amount",
595
- "description": "The quantity or count related to the item operation.",
596
- "type": "number"
597
- }
598
- ],
599
- "description": "Metadata and configuration used when creating or updating a store item."
600
- },
601
- {
602
- "name": "TagParam",
603
- "details": [
604
- {
605
- "code": "Key",
606
- "description": "Key field in TagParam.",
607
- "type": "string"
608
- },
609
- {
610
- "code": "Value",
611
- "description": "Value field in TagParam.",
612
- "type": "string"
613
- }
614
- ],
615
- "description": "Represents a tag or label used to classify a store item."
616
- },
617
- {
618
- "name": "InAppPurchaseItem",
619
- "details": [
620
- {
621
- "code": "FacebookStoreId",
622
- "description": "FacebookStoreId field in InAppPurchaseItem.",
623
- "type": "string"
624
- },
625
- {
626
- "code": "AppleAppStoreId",
627
- "description": "AppleAppStoreId field in InAppPurchaseItem.",
628
- "type": "string"
629
- },
630
- {
631
- "code": "GooglePlayStoreId",
632
- "description": "GooglePlayStoreId field in InAppPurchaseItem.",
633
- "type": "string"
634
- },
635
- {
636
- "code": "AnalyticsPrice",
637
- "description": "AnalyticsPrice field in InAppPurchaseItem.",
638
- "type": "number"
639
- }
640
- ],
641
- "extends": null,
642
- "description": "Describes an individual in-app purchase item configuration."
643
- },
644
- {
645
- "name": "PriceCurrencyItem",
646
- "details": [
647
- {
648
- "code": "Key",
649
- "description": "Key field in PriceCurrencyItem.",
650
- "type": "string"
651
- },
652
- {
653
- "code": "Value",
654
- "description": "Value field in PriceCurrencyItem.",
655
- "type": "number"
656
- }
657
- ],
658
- "extends": null,
659
- "description": "Details a price definition using a virtual currency."
660
- },
661
- {
662
- "name": "OwnerStoreInventoryItem",
663
- "details": [
664
- {
665
- "code": "ItemId",
666
- "description": "Identifier of the in-game item linked to this store item.",
667
- "type": "string"
668
- },
669
- {
670
- "code": "CatalogId",
671
- "description": "CatalogId field in OwnerStoreInventoryItem.",
672
- "type": "string"
673
- },
674
- {
675
- "code": "ClassId",
676
- "description": "ClassId field in OwnerStoreInventoryItem.",
677
- "type": "string"
678
- }
679
- ],
680
- "extends": null,
681
- "description": "Represents a store item owned by a specific player."
682
- },
683
- {
684
- "name": "StoreInventoryItem",
685
- "details": [
686
- {
687
- "code": "CatalogId",
688
- "description": "CatalogId field in StoreInventoryItem.",
689
- "type": "string"
690
- },
691
- {
692
- "code": "ClassId",
693
- "description": "ClassId field in StoreInventoryItem.",
694
- "type": "string"
695
- },
696
- {
697
- "code": "Amount",
698
- "description": "The quantity or count related to the item operation.",
699
- "type": "number"
700
- }
701
- ],
702
- "extends": null,
703
- "description": "Metadata and state information for a single store item."
704
- },
705
- {
706
- "name": "InfoResponseParameters",
707
- "details": [
708
- {
709
- "code": "StoreItems",
710
- "description": "StoreItems field in InfoResponseParameters.",
711
- "type": "Array<StoreInventoryItem>"
712
- },
713
- {
714
- "code": "StoreItemType",
715
- "description": "StoreItemType field in InfoResponseParameters.",
716
- "type": "number"
717
- },
718
- {
719
- "code": "StoreCurrencies",
720
- "description": "StoreCurrencies field in InfoResponseParameters.",
721
- "type": "Array<PriceCurrencyItem>"
722
- },
723
- {
724
- "code": "PriceCurrencies",
725
- "description": "PriceCurrencies field in InfoResponseParameters.",
726
- "type": "Array<PriceCurrencyItem>"
727
- },
728
- {
729
- "code": "InAppPurchase",
730
- "description": "InAppPurchase field in InfoResponseParameters.",
731
- "type": "InAppPurchaseItem"
732
- },
733
- {
734
- "code": "RemoveStatus",
735
- "description": "RemoveStatus field in InfoResponseParameters.",
736
- "type": "GenericModels.RemoveStatusItem"
737
- },
738
- {
739
- "code": "DisplayName",
740
- "description": "Display name shown to users for this store item.",
741
- "type": "string"
742
- },
743
- {
744
- "code": "Avatar",
745
- "description": "Visual image or icon associated with the store item.",
746
- "type": "GenericModels.AvatarItem"
747
- },
748
- {
749
- "code": "TsCreate",
750
- "description": "TsCreate field in InfoResponseParameters.",
751
- "type": "number"
752
- },
753
- {
754
- "code": "Tags",
755
- "description": "Tags field in InfoResponseParameters.",
756
- "type": "Array<GenericModels.TagItem>"
757
- },
758
- {
759
- "code": "StoreDatas",
760
- "description": "StoreDatas field in InfoResponseParameters.",
761
- "type": "Array<GenericModels.DataItem>"
762
- }
763
- ],
764
- "extends": null,
765
- "description": "Optional fields included in store item responses."
766
- },
767
- {
768
- "name": "StoreInventoryResponseData",
769
- "details": [
770
- {
771
- "code": "InfoResponseParameters",
772
- "description": "InfoResponseParameters field in StoreInventoryResponseData.",
773
- "type": "InfoResponseParameters"
774
- }
775
- ],
776
- "extends": null,
777
- "description": "Complete response data for a store item request."
778
- },
779
- {
780
- "name": "StoreInventoryWithStoreIdResponseData",
781
- "details": [
782
- {
783
- "code": "StoreId",
784
- "description": "Unique identifier assigned to the store item.",
785
- "type": "string"
786
- },
787
- {
788
- "code": "InfoResponseParameters",
789
- "description": "InfoResponseParameters field in StoreInventoryWithStoreIdResponseData.",
790
- "type": "InfoResponseParameters"
791
- }
792
- ],
793
- "extends": null,
794
- "description": "Store item response mapped to a specific StoreId."
795
- },
796
- {
797
- "name": "StoreInventoryLeaderboardResponseData",
798
- "details": [
799
- {
800
- "code": "Position",
801
- "description": "Position field in StoreInventoryLeaderboardResponseData.",
802
- "type": "number"
803
- },
804
- {
805
- "code": "StoreId",
806
- "description": "Unique identifier assigned to the store item.",
807
- "type": "string"
808
- },
809
- {
810
- "code": "InfoResponseParameters",
811
- "description": "InfoResponseParameters field in StoreInventoryLeaderboardResponseData.",
812
- "type": "InfoResponseParameters"
813
- }
814
- ],
815
- "extends": null,
816
- "description": "Leaderboard entry related to store item activity."
817
- },
818
- {
819
- "name": "StoreInventoriesWithStoreIdResponseData",
820
- "details": [
821
- {
822
- "code": "Results",
823
- "description": "Results field in StoreInventoriesWithStoreIdResponseData.",
824
- "type": "Array<StoreInventoryWithStoreIdResponseData>"
825
- }
826
- ],
827
- "extends": null,
828
- "description": "List of store items filtered by StoreId."
829
- },
830
- {
831
- "name": "CreateStoreItemResponseData",
832
- "details": [
833
- {
834
- "code": "StoreId",
835
- "description": "Unique identifier assigned to the store item.",
836
- "type": "string"
837
- }
838
- ],
839
- "extends": null,
840
- "description": "Response returned after successfully creating a store item."
841
- },
842
- {
843
- "name": "OwnerInfoResponseParameters",
844
- "details": [
845
- {
846
- "code": "Currencies",
847
- "description": "Currencies field in OwnerInfoResponseParameters.",
848
- "type": "Array<PriceCurrencyItem>"
849
- },
850
- {
851
- "code": "Inventories",
852
- "description": "Inventories field in OwnerInfoResponseParameters.",
853
- "type": "Array<OwnerStoreInventoryItem>"
854
- }
855
- ],
856
- "extends": null,
857
- "description": "Response flags controlling which ownership metadata to include."
858
- },
859
- {
860
- "name": "BuyStoreInventoryResponseData",
861
- "details": [
862
- {
863
- "code": "StoreCurrencies",
864
- "description": "StoreCurrencies field in BuyStoreInventoryResponseData.",
865
- "type": "Array<PriceCurrencyItem>"
866
- },
867
- {
868
- "code": "StoreCurrencies",
869
- "description": "StoreCurrencies field in BuyStoreInventoryResponseData.",
870
- "type": "Array<PriceCurrencyItem>"
871
- },
872
- {
873
- "code": "PriceCurrencies",
874
- "description": "PriceCurrencies field in BuyStoreInventoryResponseData.",
875
- "type": "Array<PriceCurrencyItem>"
876
- },
877
- {
878
- "code": "InfoResponseParameters",
879
- "description": "InfoResponseParameters field in BuyStoreInventoryResponseData.",
880
- "type": "OwnerInfoResponseParameters"
881
- }
882
- ],
883
- "extends": null,
884
- "description": "Response returned after completing a store item purchase."
885
- },
886
- {
887
- "name": "PresentStoreInventoryResponseData",
888
- "details": [
889
- {
890
- "code": "StoreCurrencies",
891
- "description": "StoreCurrencies field in PresentStoreInventoryResponseData.",
892
- "type": "Array<PriceCurrencyItem>"
893
- },
894
- {
895
- "code": "StoreCurrencies",
896
- "description": "StoreCurrencies field in PresentStoreInventoryResponseData.",
897
- "type": "Array<PriceCurrencyItem>"
898
- },
899
- {
900
- "code": "PriceCurrencies",
901
- "description": "PriceCurrencies field in PresentStoreInventoryResponseData.",
902
- "type": "Array<PriceCurrencyItem>"
903
- },
904
- {
905
- "code": "InfoResponseParameters",
906
- "description": "InfoResponseParameters field in PresentStoreInventoryResponseData.",
907
- "type": "OwnerInfoResponseParameters"
908
- }
909
- ],
910
- "extends": null,
911
- "description": "Response for granting a store item to a player."
912
- },
913
- {
914
- "name": "CurrencyResponseData",
915
- "details": [
916
- {
917
- "code": "Key",
918
- "description": "Key field in CurrencyResponseData.",
919
- "type": "string"
920
- },
921
- {
922
- "code": "Value",
923
- "description": "Value field in CurrencyResponseData.",
924
- "type": "number"
925
- }
926
- ],
927
- "extends": null,
928
- "description": "Details of currency changes resulting from a purchase."
929
- },
930
- {
931
- "name": "StoreItemResponseData",
932
- "details": [
933
- {
934
- "code": "CatalogId",
935
- "description": "CatalogId field in StoreItemResponseData.",
936
- "type": "string"
937
- },
938
- {
939
- "code": "ClassId",
940
- "description": "ClassId field in StoreItemResponseData.",
941
- "type": "string"
942
- },
943
- {
944
- "code": "ItemId",
945
- "description": "Identifier of the in-game item linked to this store item.",
946
- "type": "string"
947
- }
948
- ],
949
- "extends": null,
950
- "description": "Store item metadata returned in a get or list query."
951
- },
952
- {
953
- "name": "StoreLogResponseData",
954
- "details": [
955
- {
956
- "code": "StoreId",
957
- "description": "Unique identifier assigned to the store item.",
958
- "type": "string"
959
- },
960
- {
961
- "code": "OwnerId",
962
- "description": "OwnerId field in StoreLogResponseData.",
963
- "type": "string"
964
- },
965
- {
966
- "code": "OwnerType",
967
- "description": "OwnerType field in StoreLogResponseData.",
968
- "type": "number"
969
- },
970
- {
971
- "code": "TransactionId",
972
- "description": "Identifier of the transaction provided by the external store.",
973
- "type": "string"
974
- },
975
- {
976
- "code": "StoreReceiveType",
977
- "description": "StoreReceiveType field in StoreLogResponseData.",
978
- "type": "number"
979
- },
980
- {
981
- "code": "PriceCurrencyStartValues",
982
- "description": "PriceCurrencyStartValues field in StoreLogResponseData.",
983
- "type": "Array<CurrencyResponseData>"
984
- },
985
- {
986
- "code": "PriceCurrencyAmountValues",
987
- "description": "PriceCurrencyAmountValues field in StoreLogResponseData.",
988
- "type": "Array<CurrencyResponseData>"
989
- },
990
- {
991
- "code": "PriceCurrencyFinalValues",
992
- "description": "PriceCurrencyFinalValues field in StoreLogResponseData.",
993
- "type": "Array<CurrencyResponseData>"
994
- },
995
- {
996
- "code": "StoreCurrencyStartValues",
997
- "description": "StoreCurrencyStartValues field in StoreLogResponseData.",
998
- "type": "Array<CurrencyResponseData>"
999
- },
1000
- {
1001
- "code": "StoreCurrencyAmountValues",
1002
- "description": "StoreCurrencyAmountValues field in StoreLogResponseData.",
1003
- "type": "Array<CurrencyResponseData>"
1004
- },
1005
- {
1006
- "code": "StoreCurrencyFinalValues",
1007
- "description": "StoreCurrencyFinalValues field in StoreLogResponseData.",
1008
- "type": "Array<CurrencyResponseData>"
1009
- },
1010
- {
1011
- "code": "StoreItemFinalValues",
1012
- "description": "StoreItemFinalValues field in StoreLogResponseData.",
1013
- "type": "Array<StoreItemResponseData>"
1014
- },
1015
- {
1016
- "code": "TsCreate",
1017
- "description": "TsCreate field in StoreLogResponseData.",
1018
- "type": "number"
1019
- },
1020
- {
1021
- "code": "Log",
1022
- "description": "Log field in StoreLogResponseData.",
1023
- "type": "string"
1024
- }
1025
- ],
1026
- "extends": null,
1027
- "description": "Log entry capturing a change or transaction related to a store item."
1028
- },
1029
- {
1030
- "name": "StoreUsedResponseData",
1031
- "details": [
1032
- {
1033
- "code": "OwnerId",
1034
- "description": "OwnerId field in StoreUsedResponseData.",
1035
- "type": "string"
1036
- },
1037
- {
1038
- "code": "OwnerType",
1039
- "description": "OwnerType field in StoreUsedResponseData.",
1040
- "type": "number"
1041
- },
1042
- {
1043
- "code": "TsCreate",
1044
- "description": "TsCreate field in StoreUsedResponseData.",
1045
- "type": "number"
1046
- }
1047
- ],
1048
- "extends": null,
1049
- "description": "Information about a store item that has been consumed or used."
1050
- },
1051
- {
1052
- "name": "GetCreateLeaderboardResponseData",
1053
- "details": [
1054
- {
1055
- "code": "Results",
1056
- "description": "Results field in GetCreateLeaderboardResponseData.",
1057
- "type": "Array<StoreInventoryLeaderboardResponseData>"
1058
- }
1059
- ],
1060
- "extends": null,
1061
- "description": "Leaderboard data based on store item creation timestamps."
1062
- },
1063
- {
1064
- "name": "GetStoreLogResponseData",
1065
- "details": [
1066
- {
1067
- "code": "Results",
1068
- "description": "Results field in GetStoreLogResponseData.",
1069
- "type": "Array<StoreLogResponseData>"
1070
- },
1071
- {
1072
- "code": "Token",
1073
- "description": "Token field in GetStoreLogResponseData.",
1074
- "type": "string"
1075
- }
1076
- ],
1077
- "extends": null,
1078
- "description": "List of transaction logs or events for store items."
1079
- },
1080
- {
1081
- "name": "GetStoreUsedResponseData",
1082
- "details": [
1083
- {
1084
- "code": "Results",
1085
- "description": "Results field in GetStoreUsedResponseData.",
1086
- "type": "Array<StoreUsedResponseData>"
1087
- }
1088
- ],
1089
- "extends": null,
1090
- "description": "Usage log or consumption record for a specific store item."
1091
- },
1092
- {
1093
- "name": "EmptyResponseData",
1094
- "details": [],
1095
- "extends": null,
1096
- "description": "Standard response for successful operations that return no content."
1097
- }
1098
- ]
1099
- }