@smartico/public-api 0.0.399 → 0.0.401

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 (53) hide show
  1. package/dist/Core/index.d.ts +1 -0
  2. package/dist/GamePick/GamePickTypes.d.ts +8 -8
  3. package/dist/Level/Level.d.ts +1 -0
  4. package/dist/SmarticoGlobal.d.ts +190 -0
  5. package/dist/WSAPI/WSAPIGamePick.d.ts +6 -6
  6. package/dist/WSAPI/WSAPIMiniGames.d.ts +60 -52
  7. package/dist/WSAPI/WSAPITypes.d.ts +5 -0
  8. package/dist/index.d.ts +1 -0
  9. package/dist/index.js +78 -66
  10. package/dist/index.js.map +1 -1
  11. package/dist/index.modern.mjs +69 -60
  12. package/dist/index.modern.mjs.map +1 -1
  13. package/docs/api/README.md +20 -0
  14. package/docs/api/classes/WSAPIAvatars.md +1 -8
  15. package/docs/api/classes/WSAPIGamePick.md +48 -48
  16. package/docs/api/classes/WSAPIMiniGames.md +132 -70
  17. package/docs/api/enumerations/GPRoundStatus.md +43 -0
  18. package/docs/api/enumerations/GamePickMarketType.md +19 -0
  19. package/docs/api/enumerations/GamePickResolutionType.md +35 -0
  20. package/docs/api/enumerations/GamePickScoreType.md +19 -0
  21. package/docs/api/enumerations/GamePickSportType.md +375 -0
  22. package/docs/api/enumerations/GameRoundOrderType.md +35 -0
  23. package/docs/api/enumerations/LiquidEntityData.md +6 -0
  24. package/docs/api/interfaces/GamePickBoardUser.md +75 -0
  25. package/docs/api/interfaces/GamePickEvent.md +123 -0
  26. package/docs/api/interfaces/GamePickEventMeta.md +201 -0
  27. package/docs/api/interfaces/GamePickGameInfo.md +27 -0
  28. package/docs/api/interfaces/GamePickRequestParams.md +39 -0
  29. package/docs/api/interfaces/GamePickRound.md +383 -0
  30. package/docs/api/interfaces/GamePickRoundBase.md +232 -0
  31. package/docs/api/interfaces/GamePickRoundBoard.md +359 -0
  32. package/docs/api/interfaces/GamePickRoundPublicMeta.md +103 -0
  33. package/docs/api/interfaces/GamePickRoundRequestParams.md +63 -0
  34. package/docs/api/interfaces/GamePickUserInfo.md +107 -0
  35. package/docs/api/interfaces/GamesApiResponse.md +33 -0
  36. package/docs/api/interfaces/Level.md +8 -0
  37. package/docs/api/interfaces/QuizEventMeta.md +61 -0
  38. package/docs/api/interfaces/RafflePrizePublicMeta.md +9 -0
  39. package/docs/api/interfaces/TMiniGamePlayResult.md +11 -0
  40. package/docs/api/interfaces/TRafflePrize.md +9 -0
  41. package/docs/api/variables/AllRoundsGameBoardID.md +5 -0
  42. package/docs/ui/minigames/UIGuide_playMiniGame.md +6 -5
  43. package/package.json +1 -1
  44. package/src/Core/index.ts +1 -0
  45. package/src/GamePick/GamePickTypes.ts +8 -8
  46. package/src/Level/Level.ts +1 -0
  47. package/src/SmarticoAPI.ts +2 -1
  48. package/src/SmarticoGlobal.ts +209 -0
  49. package/src/WSAPI/WSAPIGamePick.ts +6 -6
  50. package/src/WSAPI/WSAPIMiniGames.ts +61 -52
  51. package/src/WSAPI/WSAPITypes.ts +5 -0
  52. package/src/index.ts +1 -0
  53. package/tsconfig.json +1 -0
@@ -0,0 +1,43 @@
1
+ # Enumeration: GPRoundStatus
2
+
3
+ GPRoundStatus defines the lifecycle stage of a game round
4
+
5
+ ## Enumeration Members
6
+
7
+ ### Other
8
+
9
+ > **Other**: `-1`
10
+
11
+ Round is in an active/other state
12
+
13
+ ***
14
+
15
+ ### NoEventsDefined
16
+
17
+ > **NoEventsDefined**: `1`
18
+
19
+ Round exists but has no events defined yet
20
+
21
+ ***
22
+
23
+ ### NoMoreBetsAllowed
24
+
25
+ > **NoMoreBetsAllowed**: `2`
26
+
27
+ Betting deadline has passed, no more bets allowed
28
+
29
+ ***
30
+
31
+ ### AllEventsResolved\_ButNotRound
32
+
33
+ > **AllEventsResolved\_ButNotRound**: `3`
34
+
35
+ All events in the round are resolved, but the round itself is not finalized
36
+
37
+ ***
38
+
39
+ ### RoundResolved
40
+
41
+ > **RoundResolved**: `4`
42
+
43
+ Round is fully resolved and scored
@@ -0,0 +1,19 @@
1
+ # Enumeration: GamePickMarketType
2
+
3
+ GamePickMarketType defines legacy market categories for MatchX events
4
+
5
+ ## Enumeration Members
6
+
7
+ ### Goals
8
+
9
+ > **Goals**: `1`
10
+
11
+ Predict the number of goals
12
+
13
+ ***
14
+
15
+ ### Winner
16
+
17
+ > **Winner**: `2`
18
+
19
+ Predict the winner
@@ -0,0 +1,35 @@
1
+ # Enumeration: GamePickResolutionType
2
+
3
+ GamePickResolutionType defines how a user's prediction was scored after event resolution
4
+
5
+ ## Enumeration Members
6
+
7
+ ### None
8
+
9
+ > **None**: `0`
10
+
11
+ Event not yet resolved
12
+
13
+ ***
14
+
15
+ ### Lost
16
+
17
+ > **Lost**: `2`
18
+
19
+ Prediction was wrong
20
+
21
+ ***
22
+
23
+ ### PartialWin
24
+
25
+ > **PartialWin**: `3`
26
+
27
+ Prediction was partially correct (e.g. correct winner but wrong score)
28
+
29
+ ***
30
+
31
+ ### FullWin
32
+
33
+ > **FullWin**: `4`
34
+
35
+ Prediction was fully correct
@@ -0,0 +1,19 @@
1
+ # Enumeration: GamePickScoreType
2
+
3
+ GamePickScoreType defines how scores are calculated for predictions
4
+
5
+ ## Enumeration Members
6
+
7
+ ### ExactScore
8
+
9
+ > **ExactScore**: `1`
10
+
11
+ Score based on exact match of predicted result
12
+
13
+ ***
14
+
15
+ ### PointsDifference
16
+
17
+ > **PointsDifference**: `2`
18
+
19
+ Score based on closeness (difference) of predicted result
@@ -0,0 +1,375 @@
1
+ # Enumeration: GamePickSportType
2
+
3
+ GamePickSportType defines supported sport types for events, using Betradar sport IDs
4
+
5
+ ## Enumeration Members
6
+
7
+ ### Soccer
8
+
9
+ > **Soccer**: `1`
10
+
11
+ ***
12
+
13
+ ### Basketball
14
+
15
+ > **Basketball**: `2`
16
+
17
+ ***
18
+
19
+ ### Baseball
20
+
21
+ > **Baseball**: `3`
22
+
23
+ ***
24
+
25
+ ### IceHockey
26
+
27
+ > **IceHockey**: `4`
28
+
29
+ ***
30
+
31
+ ### Tennis
32
+
33
+ > **Tennis**: `5`
34
+
35
+ ***
36
+
37
+ ### Handball
38
+
39
+ > **Handball**: `6`
40
+
41
+ ***
42
+
43
+ ### Floorball
44
+
45
+ > **Floorball**: `7`
46
+
47
+ ***
48
+
49
+ ### Golf
50
+
51
+ > **Golf**: `9`
52
+
53
+ ***
54
+
55
+ ### Boxing
56
+
57
+ > **Boxing**: `10`
58
+
59
+ ***
60
+
61
+ ### Motorsport
62
+
63
+ > **Motorsport**: `11`
64
+
65
+ ***
66
+
67
+ ### Rugby
68
+
69
+ > **Rugby**: `12`
70
+
71
+ ***
72
+
73
+ ### AussieRules
74
+
75
+ > **AussieRules**: `13`
76
+
77
+ ***
78
+
79
+ ### Bandy
80
+
81
+ > **Bandy**: `15`
82
+
83
+ ***
84
+
85
+ ### AmericanFootball
86
+
87
+ > **AmericanFootball**: `16`
88
+
89
+ ***
90
+
91
+ ### Cycling
92
+
93
+ > **Cycling**: `17`
94
+
95
+ ***
96
+
97
+ ### Specials
98
+
99
+ > **Specials**: `18`
100
+
101
+ ***
102
+
103
+ ### Snooker
104
+
105
+ > **Snooker**: `19`
106
+
107
+ ***
108
+
109
+ ### TableTennis
110
+
111
+ > **TableTennis**: `20`
112
+
113
+ ***
114
+
115
+ ### Cricket
116
+
117
+ > **Cricket**: `21`
118
+
119
+ ***
120
+
121
+ ### Darts
122
+
123
+ > **Darts**: `22`
124
+
125
+ ***
126
+
127
+ ### Volleyball
128
+
129
+ > **Volleyball**: `23`
130
+
131
+ ***
132
+
133
+ ### FieldHockey
134
+
135
+ > **FieldHockey**: `24`
136
+
137
+ ***
138
+
139
+ ### Waterpolo
140
+
141
+ > **Waterpolo**: `26`
142
+
143
+ ***
144
+
145
+ ### Curling
146
+
147
+ > **Curling**: `28`
148
+
149
+ ***
150
+
151
+ ### Futsal
152
+
153
+ > **Futsal**: `29`
154
+
155
+ ***
156
+
157
+ ### Badminton
158
+
159
+ > **Badminton**: `31`
160
+
161
+ ***
162
+
163
+ ### Bowls
164
+
165
+ > **Bowls**: `32`
166
+
167
+ ***
168
+
169
+ ### Chess
170
+
171
+ > **Chess**: `33`
172
+
173
+ ***
174
+
175
+ ### BeachVolley
176
+
177
+ > **BeachVolley**: `34`
178
+
179
+ ***
180
+
181
+ ### Netball
182
+
183
+ > **Netball**: `35`
184
+
185
+ ***
186
+
187
+ ### Athletics
188
+
189
+ > **Athletics**: `36`
190
+
191
+ ***
192
+
193
+ ### Squash
194
+
195
+ > **Squash**: `37`
196
+
197
+ ***
198
+
199
+ ### Lacrosse
200
+
201
+ > **Lacrosse**: `39`
202
+
203
+ ***
204
+
205
+ ### Formula1
206
+
207
+ > **Formula1**: `40`
208
+
209
+ ***
210
+
211
+ ### AlpineSkiing
212
+
213
+ > **AlpineSkiing**: `43`
214
+
215
+ ***
216
+
217
+ ### Biathlon
218
+
219
+ > **Biathlon**: `44`
220
+
221
+ ***
222
+
223
+ ### CrossCountry
224
+
225
+ > **CrossCountry**: `46`
226
+
227
+ ***
228
+
229
+ ### NordicCombined
230
+
231
+ > **NordicCombined**: `47`
232
+
233
+ ***
234
+
235
+ ### SkiJumping
236
+
237
+ > **SkiJumping**: `48`
238
+
239
+ ***
240
+
241
+ ### Schwingen
242
+
243
+ > **Schwingen**: `56`
244
+
245
+ ***
246
+
247
+ ### BeachSoccer
248
+
249
+ > **BeachSoccer**: `60`
250
+
251
+ ***
252
+
253
+ ### Pesapallo
254
+
255
+ > **Pesapallo**: `61`
256
+
257
+ ***
258
+
259
+ ### ESportCounterStrike
260
+
261
+ > **ESportCounterStrike**: `109`
262
+
263
+ ***
264
+
265
+ ### ESportLeagueofLegends
266
+
267
+ > **ESportLeagueofLegends**: `110`
268
+
269
+ ***
270
+
271
+ ### ESportDota
272
+
273
+ > **ESportDota**: `111`
274
+
275
+ ***
276
+
277
+ ### StarCraft
278
+
279
+ > **StarCraft**: `112`
280
+
281
+ ***
282
+
283
+ ### MMA
284
+
285
+ > **MMA**: `117`
286
+
287
+ ***
288
+
289
+ ### CallOfDuty
290
+
291
+ > **CallOfDuty**: `118`
292
+
293
+ ***
294
+
295
+ ### ESportOverwatch
296
+
297
+ > **ESportOverwatch**: `121`
298
+
299
+ ***
300
+
301
+ ### ESportRocketLeague
302
+
303
+ > **ESportRocketLeague**: `128`
304
+
305
+ ***
306
+
307
+ ### IndyRacing
308
+
309
+ > **IndyRacing**: `129`
310
+
311
+ ***
312
+
313
+ ### Speedway
314
+
315
+ > **Speedway**: `131`
316
+
317
+ ***
318
+
319
+ ### GaelicFootball
320
+
321
+ > **GaelicFootball**: `135`
322
+
323
+ ***
324
+
325
+ ### GaelicHurling
326
+
327
+ > **GaelicHurling**: `136`
328
+
329
+ ***
330
+
331
+ ### ESporteSoccer
332
+
333
+ > **ESporteSoccer**: `137`
334
+
335
+ ***
336
+
337
+ ### Kabaddi
338
+
339
+ > **Kabaddi**: `138`
340
+
341
+ ***
342
+
343
+ ### ESporteBasketball
344
+
345
+ > **ESporteBasketball**: `153`
346
+
347
+ ***
348
+
349
+ ### Basketball3x3
350
+
351
+ > **Basketball3x3**: `155`
352
+
353
+ ***
354
+
355
+ ### ESportArenaofValor
356
+
357
+ > **ESportArenaofValor**: `158`
358
+
359
+ ***
360
+
361
+ ### TouringCarRacing
362
+
363
+ > **TouringCarRacing**: `188`
364
+
365
+ ***
366
+
367
+ ### MotorcycleRacing
368
+
369
+ > **MotorcycleRacing**: `190`
370
+
371
+ ***
372
+
373
+ ### StockCarRacing
374
+
375
+ > **StockCarRacing**: `191`
@@ -0,0 +1,35 @@
1
+ # Enumeration: GameRoundOrderType
2
+
3
+ GameRoundOrderType defines how events within a round are ordered for display
4
+
5
+ ## Enumeration Members
6
+
7
+ ### HowAdded
8
+
9
+ > **HowAdded**: `1`
10
+
11
+ Display in the order events were added
12
+
13
+ ***
14
+
15
+ ### HowAddedReversed
16
+
17
+ > **HowAddedReversed**: `2`
18
+
19
+ Display in reverse of the order events were added
20
+
21
+ ***
22
+
23
+ ### EventDateAscending
24
+
25
+ > **EventDateAscending**: `3`
26
+
27
+ Display ordered by event/match date ascending (earliest first)
28
+
29
+ ***
30
+
31
+ ### EventDateDescending
32
+
33
+ > **EventDateDescending**: `4`
34
+
35
+ Display ordered by event/match date descending (latest first)
@@ -71,3 +71,9 @@
71
71
  ### SingleRaffle
72
72
 
73
73
  > **SingleRaffle**: `12`
74
+
75
+ ***
76
+
77
+ ### Clans
78
+
79
+ > **Clans**: `13`
@@ -0,0 +1,75 @@
1
+ # Interface: GamePickBoardUser
2
+
3
+ GamePickBoardUser describes a user's entry on the round leaderboard
4
+
5
+ ## Properties
6
+
7
+ ### ext\_user\_id
8
+
9
+ > **ext\_user\_id**: `string`
10
+
11
+ External user ID (Smartico numeric user ID)
12
+
13
+ ***
14
+
15
+ ### int\_user\_id
16
+
17
+ > **int\_user\_id**: `number`
18
+
19
+ Internal user ID within the games system
20
+
21
+ ***
22
+
23
+ ### public\_username
24
+
25
+ > **public\_username**: `string`
26
+
27
+ Display name shown on the leaderboard
28
+
29
+ ***
30
+
31
+ ### avatar\_url
32
+
33
+ > **avatar\_url**: `string`
34
+
35
+ URL of the user's avatar image
36
+
37
+ ***
38
+
39
+ ### gp\_position
40
+
41
+ > **gp\_position**: `number`
42
+
43
+ User's rank position on the leaderboard, null if not yet ranked
44
+
45
+ ***
46
+
47
+ ### resolution\_score
48
+
49
+ > **resolution\_score**: `number`
50
+
51
+ User's total score in this round/season
52
+
53
+ ***
54
+
55
+ ### full\_wins\_count
56
+
57
+ > **full\_wins\_count**: `number`
58
+
59
+ Number of fully correct predictions
60
+
61
+ ***
62
+
63
+ ### part\_wins\_count
64
+
65
+ > **part\_wins\_count**: `number`
66
+
67
+ Number of partially correct predictions
68
+
69
+ ***
70
+
71
+ ### lost\_count
72
+
73
+ > **lost\_count**: `number`
74
+
75
+ Number of incorrect predictions
@@ -0,0 +1,123 @@
1
+ # Interface: GamePickEvent
2
+
3
+ GamePickEvent describes a single event (match or question) within a round, including the user's prediction and resolution
4
+
5
+ ## Properties
6
+
7
+ ### gp\_event\_id
8
+
9
+ > **gp\_event\_id**: `number`
10
+
11
+ Unique identifier of the event
12
+
13
+ ***
14
+
15
+ ### event\_resolution\_date
16
+
17
+ > **event\_resolution\_date**: `number`
18
+
19
+ Timestamp (ms) when the event was resolved, null if not yet resolved
20
+
21
+ ***
22
+
23
+ ### match\_date
24
+
25
+ > **match\_date**: `number`
26
+
27
+ Timestamp (ms) of the match/event start time
28
+
29
+ ***
30
+
31
+ ### market\_type\_id
32
+
33
+ > **market\_type\_id**: [`SAWGPMarketType`](../enumerations/SAWGPMarketType.md)
34
+
35
+ Market type defining the prediction format (e.g. two-team score, quiz question, custom)
36
+
37
+ ***
38
+
39
+ ### event\_meta
40
+
41
+ > **event\_meta**: [`GamePickEventMeta`](GamePickEventMeta.md)
42
+
43
+ Event metadata containing team names, images, sport type, and question details
44
+
45
+ ***
46
+
47
+ ### user\_placed\_bet
48
+
49
+ > **user\_placed\_bet**: `boolean`
50
+
51
+ Whether the current user has submitted a prediction for this event
52
+
53
+ ***
54
+
55
+ ### team1\_user\_selection?
56
+
57
+ > `optional` **team1\_user\_selection?**: `number` \| \{ `from`: `number`; `to`: `number`; \}
58
+
59
+ User's predicted score for team 1 (MatchX only). Can be a number or a range object
60
+
61
+ ***
62
+
63
+ ### team2\_user\_selection?
64
+
65
+ > `optional` **team2\_user\_selection?**: `number` \| \{ `from`: `number`; `to`: `number`; \}
66
+
67
+ User's predicted score for team 2 (MatchX only). Can be a number or a range object
68
+
69
+ ***
70
+
71
+ ### user\_selection?
72
+
73
+ > `optional` **user\_selection?**: [`QuizAnswersValueType`](../enumerations/QuizAnswersValueType.md)
74
+
75
+ User's selected answer (Quiz only). Value depends on market type (e.g. '1', '2', 'x', 'yes', 'no')
76
+
77
+ ***
78
+
79
+ ### resolution\_type\_id
80
+
81
+ > **resolution\_type\_id**: [`GamePickResolutionType`](../enumerations/GamePickResolutionType.md)
82
+
83
+ How the user's prediction was scored after resolution
84
+
85
+ ***
86
+
87
+ ### resolution\_score?
88
+
89
+ > `optional` **resolution\_score?**: `number`
90
+
91
+ Points awarded for this event based on prediction accuracy
92
+
93
+ ***
94
+
95
+ ### is\_open\_for\_bets?
96
+
97
+ > `optional` **is\_open\_for\_bets?**: `boolean`
98
+
99
+ Whether this event is still accepting predictions
100
+
101
+ ***
102
+
103
+ ### odds\_details?
104
+
105
+ > `optional` **odds\_details?**: `object`
106
+
107
+ Betting odds details for the event outcomes
108
+
109
+ #### odd\_value
110
+
111
+ > **odd\_value**: `object`
112
+
113
+ ##### Index Signature
114
+
115
+ \[`key`: `string`\]: `number`
116
+
117
+ ***
118
+
119
+ ### question\_image?
120
+
121
+ > `optional` **question\_image?**: `string`
122
+
123
+ URL of a question-specific image (quiz events)