@smartico/public-api 0.0.351 → 0.0.353

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.
@@ -36,6 +36,9 @@
36
36
  - [SAWWheelLayout](enums/SAWWheelLayout.md)
37
37
  - [SAWWinSoundType](enums/SAWWinSoundType.md)
38
38
  - [AchievementAvailabilityStatus](enums/AchievementAvailabilityStatus.md)
39
+ - [QuizAnswersValueType](enums/QuizAnswersValueType.md)
40
+ - [SAWGPMarketType](enums/SAWGPMarketType.md)
41
+ - [RaffleTicketCapVisualization](enums/RaffleTicketCapVisualization.md)
39
42
  - [RaffleDrawInstanceState](enums/RaffleDrawInstanceState.md)
40
43
  - [RaffleDrawTypeExecution](enums/RaffleDrawTypeExecution.md)
41
44
  - [BuyStoreItemErrorCode](enums/BuyStoreItemErrorCode.md)
@@ -1030,6 +1030,205 @@ _smartico.api.getActivityLog({
1030
1030
 
1031
1031
  ___
1032
1032
 
1033
+ ### getGamePickActiveRounds
1034
+
1035
+ ▸ **getGamePickActiveRounds**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRound`[]\>\>
1036
+
1037
+ Returns the active rounds for the specified MatchX or Quiz game.
1038
+ Each round includes its events (matches/questions) along with the current user's selections and scores.
1039
+
1040
+ #### Parameters
1041
+
1042
+ | Name | Type |
1043
+ | :------ | :------ |
1044
+ | `props` | `GamePickRequestParams` |
1045
+
1046
+ #### Returns
1047
+
1048
+ `Promise`\<`GamesApiResponse`\<`GamePickRound`[]\>\>
1049
+
1050
+ ___
1051
+
1052
+ ### getGamePickActiveRound
1053
+
1054
+ ▸ **getGamePickActiveRound**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1055
+
1056
+ Returns a single active round for the specified MatchX or Quiz game.
1057
+ The round includes full event details with the current user's selections.
1058
+
1059
+ #### Parameters
1060
+
1061
+ | Name | Type |
1062
+ | :------ | :------ |
1063
+ | `props` | `GamePickRoundRequestParams` |
1064
+
1065
+ #### Returns
1066
+
1067
+ `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1068
+
1069
+ ___
1070
+
1071
+ ### getGamePickHistory
1072
+
1073
+ ▸ **getGamePickHistory**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRound`[]\>\>
1074
+
1075
+ Returns the history of all rounds (including resolved ones) for the specified MatchX or Quiz game.
1076
+ Each round contains full event details with results and the current user's predictions.
1077
+
1078
+ #### Parameters
1079
+
1080
+ | Name | Type |
1081
+ | :------ | :------ |
1082
+ | `props` | `GamePickRequestParams` |
1083
+
1084
+ #### Returns
1085
+
1086
+ `Promise`\<`GamesApiResponse`\<`GamePickRound`[]\>\>
1087
+
1088
+ ___
1089
+
1090
+ ### getGamePickBoard
1091
+
1092
+ ▸ **getGamePickBoard**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRoundBoard`\>\>
1093
+
1094
+ Returns the leaderboard for a specific round within a MatchX or Quiz game.
1095
+ Use `round_id = -1` (AllRoundsGameBoardID) to get the season/overall leaderboard across all rounds.
1096
+
1097
+ #### Parameters
1098
+
1099
+ | Name | Type |
1100
+ | :------ | :------ |
1101
+ | `props` | `GamePickRoundRequestParams` |
1102
+
1103
+ #### Returns
1104
+
1105
+ `Promise`\<`GamesApiResponse`\<`GamePickRoundBoard`\>\>
1106
+
1107
+ ___
1108
+
1109
+ ### submitGamePickSelection
1110
+
1111
+ ▸ **submitGamePickSelection**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1112
+
1113
+ Submits score predictions for a round in a MatchX game.
1114
+ Sends the round object with user selections for all events at once.
1115
+ Each event must include `team1_user_selection` and `team2_user_selection` representing predicted scores.
1116
+ If the user hasn't placed bets before, one game attempt (spin) will be consumed.
1117
+ Predictions can be edited until each match starts (if `allow_edit_answers` is enabled on the round).
1118
+
1119
+ #### Parameters
1120
+
1121
+ | Name | Type |
1122
+ | :------ | :------ |
1123
+ | `props` | `GamePickRequestParams` & \{ `round`: `Partial`\<`GamePickRound`\> } |
1124
+
1125
+ #### Returns
1126
+
1127
+ `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1128
+
1129
+ ___
1130
+
1131
+ ### submitGamePickSelectionQuiz
1132
+
1133
+ ▸ **submitGamePickSelectionQuiz**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1134
+
1135
+ Submits answers for a round in a Quiz game.
1136
+ Sends the round object with user answers for all events at once.
1137
+ Each event must include `user_selection` with the answer value (e.g. '1', '2', 'x', 'yes', 'no' — depending on the market type).
1138
+ If the user hasn't placed bets before, one game attempt (spin) will be consumed.
1139
+ Answers can be edited until each match starts (if `allow_edit_answers` is enabled on the round).
1140
+
1141
+ #### Parameters
1142
+
1143
+ | Name | Type |
1144
+ | :------ | :------ |
1145
+ | `props` | `GamePickRequestParams` & \{ `round`: `Partial`\<`GamePickRound`\> } |
1146
+
1147
+ #### Returns
1148
+
1149
+ `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1150
+
1151
+ ___
1152
+
1153
+ ### getGamePickUserInfo
1154
+
1155
+ ▸ **getGamePickUserInfo**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickUserInfo`\>\>
1156
+
1157
+ Returns the current user's profile information within the specified MatchX or Quiz game.
1158
+ The user record is synced from the Smartico platform into the games DB (synced every 1 minute).
1159
+ If the user doesn't exist in the games DB yet, it will be created automatically on first call.
1160
+
1161
+ #### Parameters
1162
+
1163
+ | Name | Type |
1164
+ | :------ | :------ |
1165
+ | `props` | `GamePickRequestParams` |
1166
+
1167
+ #### Returns
1168
+
1169
+ `Promise`\<`GamesApiResponse`\<`GamePickUserInfo`\>\>
1170
+
1171
+ ___
1172
+
1173
+ ### getGamePickGameInfo
1174
+
1175
+ ▸ **getGamePickGameInfo**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickGameInfo`\>\>
1176
+
1177
+ Returns the game configuration and the list of all rounds for the specified MatchX or Quiz game.
1178
+ Includes the SAW template definition, label settings, and round metadata (without events).
1179
+
1180
+ #### Parameters
1181
+
1182
+ | Name | Type |
1183
+ | :------ | :------ |
1184
+ | `props` | `GamePickRequestParams` |
1185
+
1186
+ #### Returns
1187
+
1188
+ `Promise`\<`GamesApiResponse`\<`GamePickGameInfo`\>\>
1189
+
1190
+ ___
1191
+
1192
+ ### getGamePickTranslations
1193
+
1194
+ ▸ **getGamePickTranslations**(`props`): `Promise`\<`GamesApiResponse`\<`any`\>\>
1195
+
1196
+ Returns translations for the MatchX/Quiz game UI.
1197
+ Translations are returned as a key-value map for the Gamification and RetentionGames areas,
1198
+ resolved to the current user's language.
1199
+
1200
+ #### Parameters
1201
+
1202
+ | Name | Type |
1203
+ | :------ | :------ |
1204
+ | `props` | `GamePickRequestParams` |
1205
+
1206
+ #### Returns
1207
+
1208
+ `Promise`\<`GamesApiResponse`\<`any`\>\>
1209
+
1210
+ ___
1211
+
1212
+ ### getGamePickRoundInfoForUser
1213
+
1214
+ ▸ **getGamePickRoundInfoForUser**(`props`): `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1215
+
1216
+ Returns round data with events and picks for a specific user (identified by their internal user ID).
1217
+ Useful for viewing another user's predictions from the leaderboard.
1218
+ The `int_user_id` can be obtained from the `getGamePickBoard` response (`users[].int_user_id`).
1219
+
1220
+ #### Parameters
1221
+
1222
+ | Name | Type |
1223
+ | :------ | :------ |
1224
+ | `props` | `GamePickRoundRequestParams` & \{ `int_user_id`: `number` } |
1225
+
1226
+ #### Returns
1227
+
1228
+ `Promise`\<`GamesApiResponse`\<`GamePickRound`\>\>
1229
+
1230
+ ___
1231
+
1033
1232
  ### jackpotGet
1034
1233
 
1035
1234
  ▸ **jackpotGet**(`filter?`): `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
@@ -0,0 +1,121 @@
1
+ # Enumeration: QuizAnswersValueType
2
+
3
+ ## Enumeration Members
4
+
5
+ ### HomeTeam
6
+
7
+ • **HomeTeam** = ``"1"``
8
+
9
+ ___
10
+
11
+ ### AwayTeam
12
+
13
+ • **AwayTeam** = ``"2"``
14
+
15
+ ___
16
+
17
+ ### Draw
18
+
19
+ • **Draw** = ``"x"``
20
+
21
+ ___
22
+
23
+ ### HomeTeamHomeTeam
24
+
25
+ • **HomeTeamHomeTeam** = ``"1/1"``
26
+
27
+ ___
28
+
29
+ ### HomeTeamDraw
30
+
31
+ • **HomeTeamDraw** = ``"1/x"``
32
+
33
+ ___
34
+
35
+ ### HomeTeamAwayTeam
36
+
37
+ • **HomeTeamAwayTeam** = ``"1/2"``
38
+
39
+ ___
40
+
41
+ ### DrawHomeTeam
42
+
43
+ • **DrawHomeTeam** = ``"x/1"``
44
+
45
+ ___
46
+
47
+ ### DrawDraw
48
+
49
+ • **DrawDraw** = ``"x/x"``
50
+
51
+ ___
52
+
53
+ ### DrawAwayTeam
54
+
55
+ • **DrawAwayTeam** = ``"x/2"``
56
+
57
+ ___
58
+
59
+ ### AwayTeamHomeTeam
60
+
61
+ • **AwayTeamHomeTeam** = ``"2/1"``
62
+
63
+ ___
64
+
65
+ ### AwayTeamDraw
66
+
67
+ • **AwayTeamDraw** = ``"2/x"``
68
+
69
+ ___
70
+
71
+ ### AwayTeamAwayTeam
72
+
73
+ • **AwayTeamAwayTeam** = ``"2/2"``
74
+
75
+ ___
76
+
77
+ ### Yes
78
+
79
+ • **Yes** = ``"yes"``
80
+
81
+ ___
82
+
83
+ ### No
84
+
85
+ • **No** = ``"no"``
86
+
87
+ ___
88
+
89
+ ### Odd
90
+
91
+ • **Odd** = ``"odd"``
92
+
93
+ ___
94
+
95
+ ### Even
96
+
97
+ • **Even** = ``"even"``
98
+
99
+ ___
100
+
101
+ ### HomeOdd
102
+
103
+ • **HomeOdd** = ``"1/odd"``
104
+
105
+ ___
106
+
107
+ ### HomeEven
108
+
109
+ • **HomeEven** = ``"1/even"``
110
+
111
+ ___
112
+
113
+ ### AwayOdd
114
+
115
+ • **AwayOdd** = ``"2/odd"``
116
+
117
+ ___
118
+
119
+ ### AwayEven
120
+
121
+ • **AwayEven** = ``"2/even"``
@@ -0,0 +1,25 @@
1
+ # Enumeration: RaffleTicketCapVisualization
2
+
3
+ ## Enumeration Members
4
+
5
+ ### Empty
6
+
7
+ • **Empty** = ``0``
8
+
9
+ Show nothing
10
+
11
+ ___
12
+
13
+ ### Counter
14
+
15
+ • **Counter** = ``1``
16
+
17
+ Show ticket counter
18
+
19
+ ___
20
+
21
+ ### Message
22
+
23
+ • **Message** = ``2``
24
+
25
+ Show message when ticket cap is reached
@@ -0,0 +1,157 @@
1
+ # Enumeration: SAWGPMarketType
2
+
3
+ ## Enumeration Members
4
+
5
+ ### TwoTeamsWithScore
6
+
7
+ • **TwoTeamsWithScore** = ``1``
8
+
9
+ ___
10
+
11
+ ### RedCard
12
+
13
+ • **RedCard** = ``2``
14
+
15
+ ___
16
+
17
+ ### OneXTwo
18
+
19
+ • **OneXTwo** = ``3``
20
+
21
+ ___
22
+
23
+ ### OneXTwoHalftime
24
+
25
+ • **OneXTwoHalftime** = ``4``
26
+
27
+ ___
28
+
29
+ ### FirstGoal
30
+
31
+ • **FirstGoal** = ``6``
32
+
33
+ ___
34
+
35
+ ### DoubleChance
36
+
37
+ • **DoubleChance** = ``7``
38
+
39
+ ___
40
+
41
+ ### OverUnder2\_5
42
+
43
+ • **OverUnder2\_5** = ``8``
44
+
45
+ ___
46
+
47
+ ### OverUnder1\_5Halftime
48
+
49
+ • **OverUnder1\_5Halftime** = ``9``
50
+
51
+ ___
52
+
53
+ ### OverUnder1\_5\_\_2ndHalf
54
+
55
+ • **OverUnder1\_5\_\_2ndHalf** = ``10``
56
+
57
+ ___
58
+
59
+ ### TotalCorners8\_5
60
+
61
+ • **TotalCorners8\_5** = ``11``
62
+
63
+ ___
64
+
65
+ ### TotalCorners9\_5
66
+
67
+ • **TotalCorners9\_5** = ``12``
68
+
69
+ ___
70
+
71
+ ### Corners1x2
72
+
73
+ • **Corners1x2** = ``13``
74
+
75
+ ___
76
+
77
+ ### One\_Two
78
+
79
+ • **One\_Two** = ``14``
80
+
81
+ ___
82
+
83
+ ### Overtime
84
+
85
+ • **Overtime** = ``15``
86
+
87
+ ___
88
+
89
+ ### OddEven
90
+
91
+ • **OddEven** = ``16``
92
+
93
+ ___
94
+
95
+ ### OddEvenHomeAway
96
+
97
+ • **OddEvenHomeAway** = ``17``
98
+
99
+ ___
100
+
101
+ ### FirstSet
102
+
103
+ • **FirstSet** = ``18``
104
+
105
+ ___
106
+
107
+ ### SecondSet
108
+
109
+ • **SecondSet** = ``19``
110
+
111
+ ___
112
+
113
+ ### ThirdSet
114
+
115
+ • **ThirdSet** = ``20``
116
+
117
+ ___
118
+
119
+ ### FourthSet
120
+
121
+ • **FourthSet** = ``21``
122
+
123
+ ___
124
+
125
+ ### FifthSet
126
+
127
+ • **FifthSet** = ``22``
128
+
129
+ ___
130
+
131
+ ### PlayerOneWinsOneSet
132
+
133
+ • **PlayerOneWinsOneSet** = ``23``
134
+
135
+ ___
136
+
137
+ ### PlayerTwoWinsOneSet
138
+
139
+ • **PlayerTwoWinsOneSet** = ``24``
140
+
141
+ ___
142
+
143
+ ### LastGoal
144
+
145
+ • **LastGoal** = ``25``
146
+
147
+ ___
148
+
149
+ ### CustomSport
150
+
151
+ • **CustomSport** = ``26``
152
+
153
+ ___
154
+
155
+ ### CustomNonSport
156
+
157
+ • **CustomNonSport** = ``27``
@@ -57,3 +57,12 @@ ___
57
57
  Custom data as string or JSON string that can be used in API to build custom UI
58
58
  You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
59
59
  Read more here - <https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes>
60
+
61
+ ___
62
+
63
+ ### ticket\_cap\_visualization
64
+
65
+ • `Optional` **ticket\_cap\_visualization**: [`RaffleTicketCapVisualization`](../enums/RaffleTicketCapVisualization.md)
66
+
67
+ - Value 1 (Counter): Shows a real-time "Tickets Remaining" display available during the whole Raffle activity.
68
+ - Value 2 (Message): Will show a specific message that triggers only when the cap is reached and inform users that tickets will be no longer be issued.
@@ -99,3 +99,11 @@ ___
99
99
  List of draws that are available for this raffle.
100
100
  For example, if the raffle is containg one hourly draw, one daily draw and one draw on fixed date like 01/01/2022,
101
101
  Then the list will always return 3 draws, no matter if the draws are already executed or they are in the future.
102
+
103
+ ___
104
+
105
+ ### ticket\_cap\_visualization
106
+
107
+ • **ticket\_cap\_visualization**: [`RaffleTicketCapVisualization`](../enums/RaffleTicketCapVisualization.md)
108
+
109
+ Ticket cap visualization
@@ -316,3 +316,11 @@ ___
316
316
  • `Optional` **hide\_leaderboard\_min\_scores**: `boolean`
317
317
 
318
318
  When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard
319
+
320
+ ___
321
+
322
+ ### total\_scores
323
+
324
+ • `Optional` **total\_scores**: `number`
325
+
326
+ Total scores across all participants in the tournament
@@ -431,6 +431,18 @@ When enabled, users who don’t meet the minimum qualifying score will be hidden
431
431
 
432
432
  ___
433
433
 
434
+ ### total\_scores
435
+
436
+ • `Optional` **total\_scores**: `number`
437
+
438
+ Total scores across all participants in the tournament
439
+
440
+ #### Inherited from
441
+
442
+ [TTournament](TTournament.md).[total_scores](TTournament.md#total_scores)
443
+
444
+ ___
445
+
434
446
  ### related\_games
435
447
 
436
448
  • `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame-1.md)[]
@@ -205,3 +205,11 @@ ___
205
205
  • `Optional` **hideLeaderboardsMinScores**: `boolean`
206
206
 
207
207
  When enabled, users who don't meet the minimum qualifying score will be hidden from the Leaderboard.
208
+
209
+ ___
210
+
211
+ ### totalScores
212
+
213
+ • `Optional` **totalScores**: `number`
214
+
215
+ Total scores across all participants in the tournament
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smartico/public-api",
3
- "version": "0.0.351",
3
+ "version": "0.0.353",
4
4
  "description": "Smartico public API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -33,11 +33,13 @@
33
33
  "typescript-map": "^0.1.0"
34
34
  },
35
35
  "devDependencies": {
36
+ "@types/node": "^18.19.130",
36
37
  "@types/node-fetch": "^2.6.2",
37
38
  "microbundle": "0.15.0",
38
39
  "npm-run-all": "4.1.5",
39
40
  "typedoc": "^0.24.8",
40
41
  "typedoc-plugin-markdown": "^3.15.4",
41
- "typedoc-plugin-merge-modules": "^5.0.1"
42
+ "typedoc-plugin-merge-modules": "^5.0.1",
43
+ "typescript": "~5.1.0"
42
44
  }
43
45
  }