@smartico/public-api 0.0.400 → 0.0.402

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 (67) hide show
  1. package/dist/ActivityLog/ActivityLogEntry.d.ts +2 -0
  2. package/dist/Avatars/AvatarCustomized.d.ts +2 -2
  3. package/dist/Core/index.d.ts +1 -0
  4. package/dist/GamePick/GamePickTypes.d.ts +14 -14
  5. package/dist/Level/Level.d.ts +1 -0
  6. package/dist/SmarticoGlobal.d.ts +190 -0
  7. package/dist/WSAPI/WSAPIAvatars.d.ts +1 -1
  8. package/dist/WSAPI/WSAPIGamePick.d.ts +6 -6
  9. package/dist/WSAPI/WSAPIMiniGames.d.ts +55 -42
  10. package/dist/WSAPI/WSAPITypes.d.ts +9 -6
  11. package/dist/index.d.ts +2 -0
  12. package/dist/index.js +73 -57
  13. package/dist/index.js.map +1 -1
  14. package/dist/index.modern.mjs +64 -51
  15. package/dist/index.modern.mjs.map +1 -1
  16. package/docs/api/README.md +20 -0
  17. package/docs/api/classes/WSAPIAvatars.md +2 -9
  18. package/docs/api/classes/WSAPIGamePick.md +48 -48
  19. package/docs/api/classes/WSAPIMiniGames.md +132 -70
  20. package/docs/api/enumerations/GPRoundStatus.md +43 -0
  21. package/docs/api/enumerations/GamePickMarketType.md +19 -0
  22. package/docs/api/enumerations/GamePickResolutionType.md +35 -0
  23. package/docs/api/enumerations/GamePickScoreType.md +19 -0
  24. package/docs/api/enumerations/GamePickSportType.md +375 -0
  25. package/docs/api/enumerations/GameRoundOrderType.md +35 -0
  26. package/docs/api/enumerations/LiquidEntityData.md +6 -0
  27. package/docs/api/interfaces/AvatarCustomized.md +2 -2
  28. package/docs/api/interfaces/GamePickBoardUser.md +75 -0
  29. package/docs/api/interfaces/GamePickEvent.md +123 -0
  30. package/docs/api/interfaces/GamePickEventMeta.md +201 -0
  31. package/docs/api/interfaces/GamePickGameInfo.md +27 -0
  32. package/docs/api/interfaces/GamePickRequestParams.md +39 -0
  33. package/docs/api/interfaces/GamePickRound.md +383 -0
  34. package/docs/api/interfaces/GamePickRoundBase.md +232 -0
  35. package/docs/api/interfaces/GamePickRoundBoard.md +359 -0
  36. package/docs/api/interfaces/GamePickRoundPublicMeta.md +103 -0
  37. package/docs/api/interfaces/GamePickRoundRequestParams.md +63 -0
  38. package/docs/api/interfaces/GamePickUserInfo.md +107 -0
  39. package/docs/api/interfaces/GamesApiResponse.md +33 -0
  40. package/docs/api/interfaces/GemsDiamondsLog.md +2 -0
  41. package/docs/api/interfaces/Level.md +8 -0
  42. package/docs/api/interfaces/PointsLog.md +2 -0
  43. package/docs/api/interfaces/QuizEventMeta.md +61 -0
  44. package/docs/api/interfaces/RafflePrizePublicMeta.md +9 -0
  45. package/docs/api/interfaces/TAvatarCustomized.md +2 -2
  46. package/docs/api/interfaces/TInboxMessage.md +2 -1
  47. package/docs/api/interfaces/TMiniGamePlayResult.md +11 -0
  48. package/docs/api/interfaces/TMissionOrBadge.md +3 -1
  49. package/docs/api/interfaces/TRafflePrize.md +9 -0
  50. package/docs/api/variables/AllRoundsGameBoardID.md +5 -0
  51. package/docs/ui/minigames/UIGuide_playMiniGame.md +6 -5
  52. package/package.json +1 -1
  53. package/src/ActivityLog/ActivityLogEntry.ts +2 -0
  54. package/src/Avatars/AvatarCustomized.ts +2 -2
  55. package/src/Core/index.ts +1 -0
  56. package/src/GamePick/GamePickTypes.ts +14 -14
  57. package/src/Level/Level.ts +1 -0
  58. package/src/Missions/UserAchievement.ts +2 -2
  59. package/src/SmarticoAPI.ts +2 -1
  60. package/src/SmarticoGlobal.ts +209 -0
  61. package/src/Store/StoreItem.ts +1 -1
  62. package/src/WSAPI/WSAPIAvatars.ts +1 -1
  63. package/src/WSAPI/WSAPIGamePick.ts +6 -6
  64. package/src/WSAPI/WSAPIMiniGames.ts +55 -42
  65. package/src/WSAPI/WSAPITypes.ts +9 -6
  66. package/src/index.ts +21 -0
  67. package/tsconfig.json +1 -0
@@ -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**: `string`
18
+
19
+ ISO 8601 date-time string when the event was resolved; null until resolved.
20
+
21
+ ***
22
+
23
+ ### match\_date
24
+
25
+ > **match\_date**: `string`
26
+
27
+ ISO 8601 date-time string 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)
@@ -0,0 +1,201 @@
1
+ # Interface: GamePickEventMeta
2
+
3
+ GamePickEventMeta describes metadata for a MatchX or Quiz event, including team info and sport context
4
+
5
+ ## Extends
6
+
7
+ - [`QuizEventMeta`](QuizEventMeta.md)
8
+
9
+ ## Properties
10
+
11
+ ### answers?
12
+
13
+ > `optional` **answers?**: `object`[]
14
+
15
+ List of possible answer options for the quiz question
16
+
17
+ #### value
18
+
19
+ > **value**: `string`
20
+
21
+ Answer identifier value sent on submission
22
+
23
+ #### text
24
+
25
+ > **text**: `string`
26
+
27
+ Localized display text of the answer
28
+
29
+ #### \_translations
30
+
31
+ > **\_translations**: `object`
32
+
33
+ Per-language overrides for the answer text
34
+
35
+ ##### Index Signature
36
+
37
+ \[`key`: `string`\]: `object`
38
+
39
+ #### Inherited from
40
+
41
+ [`QuizEventMeta`](QuizEventMeta.md).[`answers`](QuizEventMeta.md#answers)
42
+
43
+ ***
44
+
45
+ ### question\_image?
46
+
47
+ > `optional` **question\_image?**: `string`
48
+
49
+ URL of an image associated with the question
50
+
51
+ #### Inherited from
52
+
53
+ [`QuizEventMeta`](QuizEventMeta.md).[`question_image`](QuizEventMeta.md#question_image)
54
+
55
+ ***
56
+
57
+ ### result?
58
+
59
+ > `optional` **result?**: [`QuizAnswersValueType`](../enumerations/QuizAnswersValueType.md)
60
+
61
+ Correct answer value after resolution
62
+
63
+ #### Inherited from
64
+
65
+ [`QuizEventMeta`](QuizEventMeta.md).[`result`](QuizEventMeta.md#result)
66
+
67
+ ***
68
+
69
+ ### custom\_question
70
+
71
+ > **custom\_question**: `string`
72
+
73
+ Custom question text displayed to the user
74
+
75
+ #### Inherited from
76
+
77
+ [`QuizEventMeta`](QuizEventMeta.md).[`custom_question`](QuizEventMeta.md#custom_question)
78
+
79
+ ***
80
+
81
+ ### event\_name?
82
+
83
+ > `optional` **event\_name?**: `string`
84
+
85
+ Display name of the event/match
86
+
87
+ ***
88
+
89
+ ### team1\_name
90
+
91
+ > **team1\_name**: `string`
92
+
93
+ Name of the first team (home)
94
+
95
+ ***
96
+
97
+ ### team1\_image
98
+
99
+ > **team1\_image**: `string`
100
+
101
+ URL of the first team's logo image
102
+
103
+ ***
104
+
105
+ ### team2\_name
106
+
107
+ > **team2\_name**: `string`
108
+
109
+ Name of the second team (away)
110
+
111
+ ***
112
+
113
+ ### team2\_image
114
+
115
+ > **team2\_image**: `string`
116
+
117
+ URL of the second team's logo image
118
+
119
+ ***
120
+
121
+ ### team1\_result?
122
+
123
+ > `optional` **team1\_result?**: `number`
124
+
125
+ Actual result score for team 1 after resolution
126
+
127
+ ***
128
+
129
+ ### team2\_result?
130
+
131
+ > `optional` **team2\_result?**: `number`
132
+
133
+ Actual result score for team 2 after resolution
134
+
135
+ ***
136
+
137
+ ### sport\_type\_id?
138
+
139
+ > `optional` **sport\_type\_id?**: `number`
140
+
141
+ Betradar sport type ID for the event
142
+
143
+ ***
144
+
145
+ ### is\_canceled?
146
+
147
+ > `optional` **is\_canceled?**: `boolean`
148
+
149
+ Whether the event has been canceled
150
+
151
+ ***
152
+
153
+ ### auto\_resolve\_enabled?
154
+
155
+ > `optional` **auto\_resolve\_enabled?**: `boolean`
156
+
157
+ Whether auto-resolution from live data feed is enabled
158
+
159
+ ***
160
+
161
+ ### auto\_resolve\_date?
162
+
163
+ > `optional` **auto\_resolve\_date?**: `string`
164
+
165
+ ISO date string for when auto-resolution is expected
166
+
167
+ ***
168
+
169
+ ### team1\_auto\_result?
170
+
171
+ > `optional` **team1\_auto\_result?**: `number`
172
+
173
+ Auto-resolved score for team 1 from live data feed
174
+
175
+ ***
176
+
177
+ ### team2\_auto\_result?
178
+
179
+ > `optional` **team2\_auto\_result?**: `number`
180
+
181
+ Auto-resolved score for team 2 from live data feed
182
+
183
+ ***
184
+
185
+ ### auto\_result?
186
+
187
+ > `optional` **auto\_result?**: `string`
188
+
189
+ Auto-resolved answer value from live data feed (for quiz events)
190
+
191
+ ***
192
+
193
+ ### \_translations
194
+
195
+ > **\_translations**: `object`
196
+
197
+ Per-language overrides for team names, event name, and custom question
198
+
199
+ #### Index Signature
200
+
201
+ \[`key`: `string`\]: `object`
@@ -0,0 +1,27 @@
1
+ # Interface: GamePickGameInfo
2
+
3
+ GamePickGameInfo describes the game configuration including SAW template, rounds list, and label settings
4
+
5
+ ## Properties
6
+
7
+ ### sawTemplate
8
+
9
+ > **sawTemplate**: [`SAWTemplate`](SAWTemplate.md)
10
+
11
+ Game template configuration (SAW template) with UI settings, buy-in type, cost, and spin count
12
+
13
+ ***
14
+
15
+ ### allRounds
16
+
17
+ > **allRounds**: [`GamePickRoundBase`](GamePickRoundBase.md)[]
18
+
19
+ List of all rounds (metadata only, no events)
20
+
21
+ ***
22
+
23
+ ### labelInfo
24
+
25
+ > **labelInfo**: `any`
26
+
27
+ Label/brand configuration and settings
@@ -0,0 +1,39 @@
1
+ # Interface: GamePickRequestParams
2
+
3
+ GamePickRequestParams describes the base parameters required for GamePick API calls
4
+
5
+ ## Extended by
6
+
7
+ - [`GamePickRoundRequestParams`](GamePickRoundRequestParams.md)
8
+
9
+ ## Properties
10
+
11
+ ### saw\_template\_id
12
+
13
+ > **saw\_template\_id**: `number`
14
+
15
+ ID of the MatchX or Quiz game template. The only field the consumer supplies.
16
+
17
+ ***
18
+
19
+ ### ext\_user\_id?
20
+
21
+ > `optional` **ext\_user\_id?**: `string`
22
+
23
+ External user ID. Injected by the SDK from the active session; consumers omit it.
24
+
25
+ ***
26
+
27
+ ### smartico\_ext\_user\_id?
28
+
29
+ > `optional` **smartico\_ext\_user\_id?**: `string`
30
+
31
+ Platform external user ID. Injected by the SDK from the active session; consumers omit it.
32
+
33
+ ***
34
+
35
+ ### lang?
36
+
37
+ > `optional` **lang?**: `string`
38
+
39
+ Language code for translations (e.g. 'EN', 'DE'). Defaults to the session language.