@smartico/public-api 0.0.158 → 0.0.160

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 (185) hide show
  1. package/.prettierrc +10 -10
  2. package/dist/Bonuses/Bonus.d.ts +20 -0
  3. package/dist/Bonuses/BonusMetaMap.d.ts +3 -0
  4. package/dist/Bonuses/BonusStatus.d.ts +8 -0
  5. package/dist/Bonuses/BonusTemplateMetaMap.d.ts +5 -0
  6. package/dist/Bonuses/ClaimBonusRequest.d.ts +4 -0
  7. package/dist/Bonuses/ClaimBonusResponse.d.ts +4 -0
  8. package/dist/Bonuses/GetBonusesRequest.d.ts +3 -0
  9. package/dist/Bonuses/GetBonusesResponse.d.ts +5 -0
  10. package/dist/Bonuses/index.d.ts +7 -0
  11. package/dist/SmarticoAPI.d.ts +5 -1
  12. package/dist/SmarticoLib/index.d.ts +58 -2
  13. package/dist/WSAPI/WSAPI.d.ts +18 -3
  14. package/dist/WSAPI/WSAPITypes.d.ts +32 -0
  15. package/dist/index.d.ts +1 -0
  16. package/dist/index.js +254 -147
  17. package/dist/index.js.map +1 -1
  18. package/dist/index.modern.mjs +72 -2
  19. package/dist/index.modern.mjs.map +1 -1
  20. package/docs/README.md +2 -0
  21. package/docs/classes/WSAPI.md +109 -72
  22. package/docs/interfaces/TBonus.md +65 -0
  23. package/docs/interfaces/TClaimBonusResult.md +27 -0
  24. package/docs/interfaces/TInboxMessageBody.md +2 -2
  25. package/docs/interfaces/TLevel.md +2 -2
  26. package/docs/interfaces/TMissionOrBadgeTask.md +1 -10
  27. package/docs/interfaces/TTournament.md +1 -1
  28. package/docs/interfaces/TTournamentDetailed.md +2 -2
  29. package/docs/interfaces/TUserProfile.md +2 -2
  30. package/package.json +41 -41
  31. package/src/Base/AchRelatedGame.ts +10 -10
  32. package/src/Base/ProtocolMessage.ts +4 -4
  33. package/src/Base/ProtocolRequest.ts +4 -4
  34. package/src/Base/ProtocolResponse.ts +3 -3
  35. package/src/Bonuses/Bonus.ts +40 -0
  36. package/src/Bonuses/BonusMetaMap.ts +3 -0
  37. package/src/Bonuses/BonusStatus.ts +8 -0
  38. package/src/Bonuses/BonusTemplateMetaMap.ts +6 -0
  39. package/src/Bonuses/ClaimBonusRequest.ts +5 -0
  40. package/src/Bonuses/ClaimBonusResponse.ts +5 -0
  41. package/src/Bonuses/GetBonusesRequest.ts +3 -0
  42. package/src/Bonuses/GetBonusesResponse.ts +6 -0
  43. package/src/Bonuses/index.ts +7 -0
  44. package/src/CookieStore.ts +6 -6
  45. package/src/Core/CheckSegmentMatchRequest.ts +2 -2
  46. package/src/Core/CheckSegmentMatchResponse.ts +4 -4
  47. package/src/Core/CoreUtils.ts +12 -7
  48. package/src/Core/GetAchievementsUserInfoRequest.ts +1 -1
  49. package/src/Core/GetAchievementsUserInfoResponse.ts +3 -3
  50. package/src/Core/GetLabelInfoRequest.ts +1 -1
  51. package/src/Core/GetLabelInfoResponse.ts +3 -3
  52. package/src/Core/GetTranslationsRequest.ts +5 -5
  53. package/src/Core/GetTranslationsResponse.ts +3 -3
  54. package/src/Core/PublicProperties.ts +7 -7
  55. package/src/Core/ResponseIdentify.ts +10 -10
  56. package/src/Core/TranslationArea.ts +1 -1
  57. package/src/Core/index.ts +9 -9
  58. package/src/CustomSections/GetCustomSectionsRequest.ts +1 -1
  59. package/src/CustomSections/GetCustomSectionsResponse.ts +3 -3
  60. package/src/CustomSections/UICustomSection.ts +21 -16
  61. package/src/CustomSections/index.ts +4 -4
  62. package/src/ErrorCodes.ts +2 -2
  63. package/src/GResponse.ts +5 -5
  64. package/src/ILogger.ts +5 -5
  65. package/src/Inbox/GetInboxMessagesRequest.ts +4 -4
  66. package/src/Inbox/GetInboxMessagesResponse.ts +8 -8
  67. package/src/Inbox/InboxMessage.ts +20 -20
  68. package/src/Inbox/MarkInboxMessageDeletedRequest.ts +3 -3
  69. package/src/Inbox/MarkInboxMessageDeletedResponse.ts +3 -3
  70. package/src/Inbox/MarkInboxMessageReadRequest.ts +3 -3
  71. package/src/Inbox/MarkInboxMessageReadResponse.ts +3 -3
  72. package/src/Inbox/MarkInboxMessageStarredRequest.ts +3 -3
  73. package/src/Inbox/MarkInboxMessageStarredResponse.ts +3 -3
  74. package/src/Inbox/index.ts +10 -10
  75. package/src/IntUtils.ts +36 -28
  76. package/src/Jackpots/GetJackpotsPotsRequest.ts +2 -2
  77. package/src/Jackpots/GetJackpotsPotsResponse.ts +3 -3
  78. package/src/Jackpots/GetJackpotsRequest.ts +3 -3
  79. package/src/Jackpots/GetJackpotsResponse.ts +4 -4
  80. package/src/Jackpots/JackPotWinner.ts +6 -6
  81. package/src/Jackpots/JackpotContributionType.ts +1 -1
  82. package/src/Jackpots/JackpotDetails.ts +18 -18
  83. package/src/Jackpots/JackpotHtmlTemplate.ts +3 -3
  84. package/src/Jackpots/JackpotPot.ts +6 -6
  85. package/src/Jackpots/JackpotPublicMeta.ts +9 -9
  86. package/src/Jackpots/JackpotType.ts +1 -1
  87. package/src/Jackpots/JackpotWinPush.ts +5 -5
  88. package/src/Jackpots/JackpotsOptinRequest.ts +2 -2
  89. package/src/Jackpots/JackpotsOptinResponse.ts +1 -1
  90. package/src/Jackpots/JackpotsOptoutRequest.ts +2 -2
  91. package/src/Jackpots/JackpotsOptoutResponse.ts +1 -1
  92. package/src/Jackpots/index.ts +16 -16
  93. package/src/Leaderboard/GetLeaderBoardsRequest.ts +5 -5
  94. package/src/Leaderboard/GetLeaderBoardsResponse.ts +3 -3
  95. package/src/Leaderboard/LeaderBoardDetails.ts +11 -11
  96. package/src/Leaderboard/LeaderBoardPosition.ts +8 -8
  97. package/src/Leaderboard/LeaderBoardPublicMeta.ts +3 -3
  98. package/src/Leaderboard/LeaderBoards.ts +16 -16
  99. package/src/Leaderboard/index.ts +6 -6
  100. package/src/Level/GetLevelMapResponse.ts +7 -7
  101. package/src/Level/Level.ts +9 -9
  102. package/src/Level/LevelPublicMeta.ts +10 -10
  103. package/src/Level/index.ts +3 -3
  104. package/src/MiniGames/SAWAcknowledgeSpinPushRequest.ts +3 -3
  105. package/src/MiniGames/SAWBuyInType.ts +2 -2
  106. package/src/MiniGames/SAWDoAknowledgeRequest.ts +2 -2
  107. package/src/MiniGames/SAWDoAknowledgeResponse.ts +2 -2
  108. package/src/MiniGames/SAWDoSpinRequest.ts +3 -3
  109. package/src/MiniGames/SAWDoSpinResponse.ts +9 -9
  110. package/src/MiniGames/SAWEventSawPush.ts +3 -3
  111. package/src/MiniGames/SAWGameType.ts +2 -2
  112. package/src/MiniGames/SAWGetTemplatesRequest.ts +3 -3
  113. package/src/MiniGames/SAWGetTemplatesResponse.ts +18 -16
  114. package/src/MiniGames/SAWPrize.ts +11 -11
  115. package/src/MiniGames/SAWPrizeDropAknowledgeRequest.ts +4 -4
  116. package/src/MiniGames/SAWPrizeDropAknowledgeResponse.ts +2 -2
  117. package/src/MiniGames/SAWPrizeDropWinPush.ts +8 -8
  118. package/src/MiniGames/SAWPrizeType.ts +2 -2
  119. package/src/MiniGames/SAWPrizeUI.ts +16 -16
  120. package/src/MiniGames/SAWSpinsCountPush.ts +3 -3
  121. package/src/MiniGames/SAWTemplate.ts +26 -26
  122. package/src/MiniGames/SAWTemplateUI.ts +42 -42
  123. package/src/MiniGames/SAWUtils.ts +10 -10
  124. package/src/MiniGames/SAWWinSoundType.ts +1 -1
  125. package/src/MiniGames/index.ts +24 -24
  126. package/src/Missions/AchCategoryPublicMeta.ts +2 -2
  127. package/src/Missions/AchClaimPrizeRequest.ts +3 -3
  128. package/src/Missions/AchClaimPrizeResponse.ts +1 -1
  129. package/src/Missions/AchievementCategory.ts +8 -8
  130. package/src/Missions/AchievementOptinRequest.ts +2 -2
  131. package/src/Missions/AchievementOptinResponse.ts +1 -1
  132. package/src/Missions/AchievementPublicMeta.ts +19 -19
  133. package/src/Missions/AchievementTaskPublicMeta.ts +2 -2
  134. package/src/Missions/GetAchCategoriesRequest.ts +1 -1
  135. package/src/Missions/GetAchCategoriesResponse.ts +3 -3
  136. package/src/Missions/GetAchievementMapRequest.ts +1 -1
  137. package/src/Missions/GetAchievementMapResponse.ts +3 -3
  138. package/src/Missions/GetRelatedAchTourRequest.ts +2 -2
  139. package/src/Missions/GetRelatedAchTourResponse.ts +5 -5
  140. package/src/Missions/ReloadAchievementsEvent.ts +3 -3
  141. package/src/Missions/UserAchievement.ts +48 -46
  142. package/src/Missions/UserAchievementTask.ts +13 -13
  143. package/src/Missions/index.ts +19 -19
  144. package/src/NodeCache.ts +12 -12
  145. package/src/OCache.ts +22 -22
  146. package/src/Quiz/MarketsAnswers.ts +9 -9
  147. package/src/Quiz/MarketsInfo.ts +62 -23
  148. package/src/Quiz/MarketsPerSport.ts +11 -4
  149. package/src/Quiz/ScoreResultTypes.ts +22 -22
  150. package/src/Quiz/SportTypes.ts +1 -1
  151. package/src/Quiz/index.ts +6 -6
  152. package/src/SmarticoAPI.ts +556 -303
  153. package/src/SmarticoLib/index.ts +956 -840
  154. package/src/Store/BuyStoreItemRequest.ts +2 -2
  155. package/src/Store/BuyStoreItemResponse.ts +2 -2
  156. package/src/Store/GetCategoriesStoreResponse.ts +3 -3
  157. package/src/Store/GetStoreHistoryRequest.ts +3 -3
  158. package/src/Store/GetStoreHistoryResponse.ts +4 -4
  159. package/src/Store/GetStoreItemsResponse.ts +3 -3
  160. package/src/Store/StoreCategory.ts +8 -8
  161. package/src/Store/StoreCategoryPublicMeta.ts +2 -2
  162. package/src/Store/StoreItem.ts +13 -13
  163. package/src/Store/StoreItemPublicMeta.ts +10 -10
  164. package/src/Store/StoreItemPurchased.ts +17 -17
  165. package/src/Store/StoreItemType.ts +2 -2
  166. package/src/Store/index.ts +13 -13
  167. package/src/Tournaments/GetTournamentInfoRequest.ts +2 -2
  168. package/src/Tournaments/GetTournamentInfoResponse.ts +18 -18
  169. package/src/Tournaments/GetTournamentsRequest.ts +1 -1
  170. package/src/Tournaments/GetTournamentsResponse.ts +6 -6
  171. package/src/Tournaments/Tournament.ts +43 -39
  172. package/src/Tournaments/TournamentInstanceStatus.ts +2 -2
  173. package/src/Tournaments/TournamentPlayer.ts +7 -7
  174. package/src/Tournaments/TournamentPrize.ts +8 -8
  175. package/src/Tournaments/TournamentPublicMeta.ts +16 -16
  176. package/src/Tournaments/TournamentRegisterRequest.ts +2 -2
  177. package/src/Tournaments/TournamentRegisterResponse.ts +3 -3
  178. package/src/Tournaments/TournamentRegistrationStatus.ts +6 -4
  179. package/src/Tournaments/TournamentRegistrationType.ts +9 -3
  180. package/src/Tournaments/TournamentUtils.ts +44 -38
  181. package/src/Tournaments/index.ts +16 -16
  182. package/src/WSAPI/WSAPI.ts +244 -132
  183. package/src/WSAPI/WSAPITypes.ts +287 -250
  184. package/src/index.ts +16 -15
  185. package/tsconfig.json +41 -43
package/docs/README.md CHANGED
@@ -57,6 +57,8 @@
57
57
  - [UserLevelExtraCountersT](interfaces/UserLevelExtraCountersT.md)
58
58
  - [TSegmentCheckResult](interfaces/TSegmentCheckResult.md)
59
59
  - [TUICustomSection](interfaces/TUICustomSection.md)
60
+ - [TBonus](interfaces/TBonus.md)
61
+ - [TClaimBonusResult](interfaces/TClaimBonusResult.md)
60
62
 
61
63
  ## General API
62
64
 
@@ -24,7 +24,7 @@ ___
24
24
 
25
25
  ### checkSegmentMatch
26
26
 
27
- ▸ **checkSegmentMatch**(`segment_id`): `Promise`<`boolean`\>
27
+ ▸ **checkSegmentMatch**(`segment_id`): `Promise`\<`boolean`\>
28
28
 
29
29
  Check if user belongs to specific segments
30
30
  **Example**:
@@ -44,13 +44,13 @@ _smartico.api.checkSegmentMatch(1).then((result) => {
44
44
 
45
45
  #### Returns
46
46
 
47
- `Promise`<`boolean`\>
47
+ `Promise`\<`boolean`\>
48
48
 
49
49
  ___
50
50
 
51
51
  ### checkSegmentListMatch
52
52
 
53
- ▸ **checkSegmentListMatch**(`segment_ids`): `Promise`<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
53
+ ▸ **checkSegmentListMatch**(`segment_ids`): `Promise`\<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
54
54
 
55
55
  Check if user belongs to specific list of segments
56
56
  **Example**:
@@ -69,13 +69,13 @@ _smartico.api.checkSegmentListMatch([1, 2, 3]).then((result) => {
69
69
 
70
70
  #### Returns
71
71
 
72
- `Promise`<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
72
+ `Promise`\<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
73
73
 
74
74
  ___
75
75
 
76
76
  ### getLevels
77
77
 
78
- ▸ **getLevels**(): `Promise`<[`TLevel`](../interfaces/TLevel.md)[]\>
78
+ ▸ **getLevels**(): `Promise`\<[`TLevel`](../interfaces/TLevel.md)[]\>
79
79
 
80
80
  Returns all the levels available the current user
81
81
  **Example**:
@@ -94,17 +94,17 @@ _smartico.vapi('EN').getLevels().then((result) => {
94
94
 
95
95
  #### Returns
96
96
 
97
- `Promise`<[`TLevel`](../interfaces/TLevel.md)[]\>
97
+ `Promise`\<[`TLevel`](../interfaces/TLevel.md)[]\>
98
98
 
99
99
  ___
100
100
 
101
101
  ### getMissions
102
102
 
103
- ▸ **getMissions**(`«destructured»?`): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
103
+ ▸ **getMissions**(`«destructured»?`): `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
104
104
 
105
105
  Returns all the missions available the current user.
106
106
  The returned missions are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
107
- Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one.
107
+ Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one.
108
108
  The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it.
109
109
 
110
110
  **Example**:
@@ -130,13 +130,13 @@ _smartico.vapi('EN').getMissions().then((result) => {
130
130
 
131
131
  #### Returns
132
132
 
133
- `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
133
+ `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
134
134
 
135
135
  ___
136
136
 
137
137
  ### getBadges
138
138
 
139
- ▸ **getBadges**(): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
139
+ ▸ **getBadges**(): `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
140
140
 
141
141
  Returns all the badges available the current user
142
142
 
@@ -144,13 +144,50 @@ Returns all the badges available the current user
144
144
 
145
145
  #### Returns
146
146
 
147
- `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
147
+ `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
148
+
149
+ ___
150
+
151
+ ### getBonuses
152
+
153
+ ▸ **getBonuses**(): `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
154
+
155
+ Returns all the bonuses for the current user
156
+
157
+ **Visitor mode: not supported**
158
+
159
+ #### Returns
160
+
161
+ `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
162
+
163
+ ___
164
+
165
+ ### claimBonus
166
+
167
+ ▸ **claimBonus**(`bonus_id`): `Promise`\<[`TClaimBonusResult`](../interfaces/TClaimBonusResult.md)\>
168
+
169
+ Claim the bonus by bonus_id. Returns the err_code in case of success or error.
170
+ Note that this method can be used only on integrations where originally failed bonus can be claimed again.
171
+ For example, user won a bonus in the mini-game, but Operator rejected this bonus.
172
+ This bonus will be available for the user to claim again.
173
+
174
+ **Visitor mode: not supported**
175
+
176
+ #### Parameters
177
+
178
+ | Name | Type |
179
+ | :------ | :------ |
180
+ | `bonus_id` | `number` |
181
+
182
+ #### Returns
183
+
184
+ `Promise`\<[`TClaimBonusResult`](../interfaces/TClaimBonusResult.md)\>
148
185
 
149
186
  ___
150
187
 
151
188
  ### getUserLevelExtraCounters
152
189
 
153
- ▸ **getUserLevelExtraCounters**(): `Promise`<[`UserLevelExtraCountersT`](../interfaces/UserLevelExtraCountersT.md)\>
190
+ ▸ **getUserLevelExtraCounters**(): `Promise`\<[`UserLevelExtraCountersT`](../interfaces/UserLevelExtraCountersT.md)\>
154
191
 
155
192
  Returns the extra counters for the current user level.
156
193
  These are counters that are configured for each Smartico client separatly by request.
@@ -167,13 +204,13 @@ _smartico.api.getUserLevelExtraCounters().then((result) => {
167
204
 
168
205
  #### Returns
169
206
 
170
- `Promise`<[`UserLevelExtraCountersT`](../interfaces/UserLevelExtraCountersT.md)\>
207
+ `Promise`\<[`UserLevelExtraCountersT`](../interfaces/UserLevelExtraCountersT.md)\>
171
208
 
172
209
  ___
173
210
 
174
211
  ### getStoreItems
175
212
 
176
- ▸ **getStoreItems**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
213
+ ▸ **getStoreItems**(): `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
177
214
 
178
215
  Returns all the store items available the current user
179
216
 
@@ -193,13 +230,13 @@ _smartico.vapi('EN').getStoreItems().then((result) => {
193
230
 
194
231
  #### Returns
195
232
 
196
- `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
233
+ `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
197
234
 
198
235
  ___
199
236
 
200
237
  ### buyStoreItem
201
238
 
202
- ▸ **buyStoreItem**(`item_id`): `Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
239
+ ▸ **buyStoreItem**(`item_id`): `Promise`\<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
203
240
 
204
241
  Buy the specific shop item by item_id. Returns the err_code in case of success or error.
205
242
  **Example**:
@@ -219,13 +256,13 @@ _smartico.api.buyStoreItem(1).then((result) => {
219
256
 
220
257
  #### Returns
221
258
 
222
- `Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
259
+ `Promise`\<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
223
260
 
224
261
  ___
225
262
 
226
263
  ### getStoreCategories
227
264
 
228
- ▸ **getStoreCategories**(): `Promise`<[`TStoreCategory`](../interfaces/TStoreCategory.md)[]\>
265
+ ▸ **getStoreCategories**(): `Promise`\<[`TStoreCategory`](../interfaces/TStoreCategory.md)[]\>
229
266
 
230
267
  Returns store categories
231
268
 
@@ -245,16 +282,16 @@ _smartico.vapi('EN').getStoreCategories().then((result) => {
245
282
 
246
283
  #### Returns
247
284
 
248
- `Promise`<[`TStoreCategory`](../interfaces/TStoreCategory.md)[]\>
285
+ `Promise`\<[`TStoreCategory`](../interfaces/TStoreCategory.md)[]\>
249
286
 
250
287
  ___
251
288
 
252
289
  ### getStorePurchasedItems
253
290
 
254
- ▸ **getStorePurchasedItems**(`«destructured»?`): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
291
+ ▸ **getStorePurchasedItems**(`«destructured»?`): `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
255
292
 
256
- Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
257
- The maximum number of items per request is limited to 20.
293
+ Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
294
+ The maximum number of items per request is limited to 20.
258
295
  You can leave this params empty and by default it will return list of purchased items ranging from 0 to 20.
259
296
 
260
297
  **Example**:
@@ -277,13 +314,13 @@ _smartico.api.getStorePurchasedItems().then((result) => {
277
314
 
278
315
  #### Returns
279
316
 
280
- `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
317
+ `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
281
318
 
282
319
  ___
283
320
 
284
321
  ### getAchCategories
285
322
 
286
- ▸ **getAchCategories**(): `Promise`<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
323
+ ▸ **getAchCategories**(): `Promise`\<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
287
324
 
288
325
  Returns missions & badges categories
289
326
 
@@ -303,13 +340,13 @@ _smartico.vapi('EN').getAchCategories().then((result) => {
303
340
 
304
341
  #### Returns
305
342
 
306
- `Promise`<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
343
+ `Promise`\<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
307
344
 
308
345
  ___
309
346
 
310
347
  ### getCustomSections
311
348
 
312
- ▸ **getCustomSections**(): `Promise`<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
349
+ ▸ **getCustomSections**(): `Promise`\<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
313
350
 
314
351
  Returns list of custom sections
315
352
 
@@ -329,16 +366,16 @@ _smartico.vapi('EN').getCustomSections().then((result) => {
329
366
 
330
367
  #### Returns
331
368
 
332
- `Promise`<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
369
+ `Promise`\<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
333
370
 
334
371
  ___
335
372
 
336
373
  ### getMiniGames
337
374
 
338
- ▸ **getMiniGames**(`«destructured»?`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
375
+ ▸ **getMiniGames**(`«destructured»?`): `Promise`\<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
339
376
 
340
- Returns the list of mini-games available for user
341
- The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one.
377
+ Returns the list of mini-games available for user
378
+ The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one.
342
379
  The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
343
380
 
344
381
  **Example**:
@@ -364,13 +401,13 @@ _smartico.vapi('EN').getMiniGames().then((result) => {
364
401
 
365
402
  #### Returns
366
403
 
367
- `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
404
+ `Promise`\<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
368
405
 
369
406
  ___
370
407
 
371
408
  ### playMiniGame
372
409
 
373
- ▸ **playMiniGame**(`template_id`): `Promise`<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
410
+ ▸ **playMiniGame**(`template_id`): `Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
374
411
 
375
412
  Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
376
413
 
@@ -384,13 +421,13 @@ Plays the specified by template_id mini-game on behalf of user and returns prize
384
421
 
385
422
  #### Returns
386
423
 
387
- `Promise`<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
424
+ `Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
388
425
 
389
426
  ___
390
427
 
391
428
  ### requestMissionOptIn
392
429
 
393
- ▸ **requestMissionOptIn**(`mission_id`): `Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
430
+ ▸ **requestMissionOptIn**(`mission_id`): `Promise`\<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
394
431
 
395
432
  Requests an opt-in for the specified mission_id. Returns the err_code.
396
433
 
@@ -404,13 +441,13 @@ Requests an opt-in for the specified mission_id. Returns the err_code.
404
441
 
405
442
  #### Returns
406
443
 
407
- `Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
444
+ `Promise`\<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
408
445
 
409
446
  ___
410
447
 
411
448
  ### requestMissionClaimReward
412
449
 
413
- ▸ **requestMissionClaimReward**(`mission_id`, `ach_completed_id`): `Promise`<[`TMissionClaimRewardResult`](../interfaces/TMissionClaimRewardResult.md)\>
450
+ ▸ **requestMissionClaimReward**(`mission_id`, `ach_completed_id`): `Promise`\<[`TMissionClaimRewardResult`](../interfaces/TMissionClaimRewardResult.md)\>
414
451
 
415
452
  Request for claim reward for the specified mission id. Returns the err_code.
416
453
 
@@ -425,16 +462,16 @@ Request for claim reward for the specified mission id. Returns the err_code.
425
462
 
426
463
  #### Returns
427
464
 
428
- `Promise`<[`TMissionClaimRewardResult`](../interfaces/TMissionClaimRewardResult.md)\>
465
+ `Promise`\<[`TMissionClaimRewardResult`](../interfaces/TMissionClaimRewardResult.md)\>
429
466
 
430
467
  ___
431
468
 
432
469
  ### getTournamentsList
433
470
 
434
- ▸ **getTournamentsList**(`«destructured»?`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
471
+ ▸ **getTournamentsList**(`«destructured»?`): `Promise`\<[`TTournament`](../interfaces/TTournament.md)[]\>
435
472
 
436
- Returns all the active instances of tournaments
437
- The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one.
473
+ Returns all the active instances of tournaments
474
+ The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one.
438
475
  The onUpdate callback will be called when the user has registered in a tournament. Updated list will be passed to onUpdate callback.
439
476
 
440
477
  **Example**:
@@ -460,13 +497,13 @@ _smartico.vapi('EN').getTournamentsList().then((result) => {
460
497
 
461
498
  #### Returns
462
499
 
463
- `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
500
+ `Promise`\<[`TTournament`](../interfaces/TTournament.md)[]\>
464
501
 
465
502
  ___
466
503
 
467
504
  ### getTournamentInstanceInfo
468
505
 
469
- ▸ **getTournamentInstanceInfo**(`tournamentInstanceId`): `Promise`<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
506
+ ▸ **getTournamentInstanceInfo**(`tournamentInstanceId`): `Promise`\<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
470
507
 
471
508
  Returns details information of specific tournament instance, the response will include tournament info and the leaderboard of players
472
509
 
@@ -500,13 +537,13 @@ _smartico.vapi('EN').getTournamentsList().then((result) => {
500
537
 
501
538
  #### Returns
502
539
 
503
- `Promise`<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
540
+ `Promise`\<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
504
541
 
505
542
  ___
506
543
 
507
544
  ### registerInTournament
508
545
 
509
- ▸ **registerInTournament**(`tournamentInstanceId`): `Promise`<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
546
+ ▸ **registerInTournament**(`tournamentInstanceId`): `Promise`\<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
510
547
 
511
548
  Requests registration for the specified tournament instance. Returns the err_code.
512
549
 
@@ -520,13 +557,13 @@ Requests registration for the specified tournament instance. Returns the err_cod
520
557
 
521
558
  #### Returns
522
559
 
523
- `Promise`<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
560
+ `Promise`\<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
524
561
 
525
562
  ___
526
563
 
527
564
  ### getLeaderBoard
528
565
 
529
- ▸ **getLeaderBoard**(`periodType`, `getPreviousPeriod?`): `Promise`<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
566
+ ▸ **getLeaderBoard**(`periodType`, `getPreviousPeriod?`): `Promise`\<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
530
567
 
531
568
  Returns the leaderboard for the current type (default is Daily). If getPreviousPeriod is passed as true, a leaderboard for the previous period for the current type will be returned.
532
569
  For example, if the type is Weekly and getPreviousPeriod is true, a leaderboard for the previous week will be returned.
@@ -554,18 +591,18 @@ _smartico.vapi('EN').getLeaderBoard(1).then((result) => {
554
591
 
555
592
  #### Returns
556
593
 
557
- `Promise`<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
594
+ `Promise`\<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
558
595
 
559
596
  ___
560
597
 
561
598
  ### getInboxMessages
562
599
 
563
- ▸ **getInboxMessages**(`params?`): `Promise`<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
600
+ ▸ **getInboxMessages**(`params?`): `Promise`\<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
564
601
 
565
- Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched.
566
- The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
602
+ Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched.
603
+ The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
567
604
  You can leave this params empty and by default it will return list of messages ranging from 0 to 20.
568
- This functions return list of messages without the body of the message.
605
+ This functions return list of messages without the body of the message.
569
606
  To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
570
607
  All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
571
608
  The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function.
@@ -584,13 +621,13 @@ The "onUpdate" callback will be triggered when the user receives a new message.
584
621
 
585
622
  #### Returns
586
623
 
587
- `Promise`<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
624
+ `Promise`\<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
588
625
 
589
626
  ___
590
627
 
591
628
  ### getInboxMessageBody
592
629
 
593
- ▸ **getInboxMessageBody**(`messageGuid`): `Promise`<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
630
+ ▸ **getInboxMessageBody**(`messageGuid`): `Promise`\<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
594
631
 
595
632
  Returns the message body of the specified message guid.
596
633
 
@@ -604,13 +641,13 @@ Returns the message body of the specified message guid.
604
641
 
605
642
  #### Returns
606
643
 
607
- `Promise`<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
644
+ `Promise`\<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
608
645
 
609
646
  ___
610
647
 
611
648
  ### markInboxMessageAsRead
612
649
 
613
- ▸ **markInboxMessageAsRead**(`messageGuid`): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
650
+ ▸ **markInboxMessageAsRead**(`messageGuid`): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
614
651
 
615
652
  Requests to mark inbox message with specified guid as read
616
653
 
@@ -624,13 +661,13 @@ Requests to mark inbox message with specified guid as read
624
661
 
625
662
  #### Returns
626
663
 
627
- `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
664
+ `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
628
665
 
629
666
  ___
630
667
 
631
668
  ### markAllInboxMessagesAsRead
632
669
 
633
- ▸ **markAllInboxMessagesAsRead**(): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
670
+ ▸ **markAllInboxMessagesAsRead**(): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
634
671
 
635
672
  Requests to mark all inbox messages as rea
636
673
 
@@ -638,13 +675,13 @@ Requests to mark all inbox messages as rea
638
675
 
639
676
  #### Returns
640
677
 
641
- `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
678
+ `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
642
679
 
643
680
  ___
644
681
 
645
682
  ### markUnmarkInboxMessageAsFavorite
646
683
 
647
- ▸ **markUnmarkInboxMessageAsFavorite**(`messageGuid`, `mark`): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
684
+ ▸ **markUnmarkInboxMessageAsFavorite**(`messageGuid`, `mark`): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
648
685
 
649
686
  Requests to mark inbox message with specified guid as favorite. Pass mark true to add message to favorite and false to remove.
650
687
 
@@ -659,13 +696,13 @@ Requests to mark inbox message with specified guid as favorite. Pass mark true t
659
696
 
660
697
  #### Returns
661
698
 
662
- `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
699
+ `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
663
700
 
664
701
  ___
665
702
 
666
703
  ### deleteInboxMessage
667
704
 
668
- ▸ **deleteInboxMessage**(`messageGuid`): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
705
+ ▸ **deleteInboxMessage**(`messageGuid`): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
669
706
 
670
707
  Requests to delete inbox message
671
708
 
@@ -679,13 +716,13 @@ Requests to delete inbox message
679
716
 
680
717
  #### Returns
681
718
 
682
- `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
719
+ `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
683
720
 
684
721
  ___
685
722
 
686
723
  ### deleteAllInboxMessages
687
724
 
688
- ▸ **deleteAllInboxMessages**(): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
725
+ ▸ **deleteAllInboxMessages**(): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
689
726
 
690
727
  Requests to delete all inbox messages
691
728
 
@@ -693,13 +730,13 @@ Requests to delete all inbox messages
693
730
 
694
731
  #### Returns
695
732
 
696
- `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
733
+ `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
697
734
 
698
735
  ___
699
736
 
700
737
  ### getTranslations
701
738
 
702
- ▸ **getTranslations**(`lang_code`): `Promise`<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
739
+ ▸ **getTranslations**(`lang_code`): `Promise`\<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
703
740
 
704
741
  Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office.
705
742
 
@@ -711,13 +748,13 @@ Requests translations for the given language. Returns the object including trans
711
748
 
712
749
  #### Returns
713
750
 
714
- `Promise`<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
751
+ `Promise`\<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
715
752
 
716
753
  ___
717
754
 
718
755
  ### jackpotGet
719
756
 
720
- ▸ **jackpotGet**(`filter?`): `Promise`<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
757
+ ▸ **jackpotGet**(`filter?`): `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
721
758
 
722
759
  Returns list of Jackpots that are active in the systen and matching to the filter definition.
723
760
  If filter is not provided, all active jackpots will be returned.
@@ -748,13 +785,13 @@ _smartico.vapi('EN').jackpotGet({ related_game_id: 'wooko-slot' }).then((result)
748
785
 
749
786
  #### Returns
750
787
 
751
- `Promise`<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
788
+ `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
752
789
 
753
790
  ___
754
791
 
755
792
  ### jackpotOptIn
756
793
 
757
- ▸ **jackpotOptIn**(`filter`): `Promise`<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
794
+ ▸ **jackpotOptIn**(`filter`): `Promise`\<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
758
795
 
759
796
  Opt-in currently logged in user to the jackpot with the specified jp_template_id.
760
797
  You may call jackpotGet method after doing optin to see that user is opted in to the jackpot.
@@ -777,13 +814,13 @@ _smartico.api.jackpotOptIn({ jp_template_id: 123 }).then((result) => {
777
814
 
778
815
  #### Returns
779
816
 
780
- `Promise`<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
817
+ `Promise`\<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
781
818
 
782
819
  ___
783
820
 
784
821
  ### jackpotOptOut
785
822
 
786
- ▸ **jackpotOptOut**(`filter`): `Promise`<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
823
+ ▸ **jackpotOptOut**(`filter`): `Promise`\<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
787
824
 
788
825
  Opt-out currently logged in user from the jackpot with the specified jp_template_id.
789
826
  You may call jackpotGet method after doing optout to see that user is not opted in to the jackpot.
@@ -806,4 +843,4 @@ _smartico.api.jackpotOptOut({ jp_template_id: 123 }).then((result) => {
806
843
 
807
844
  #### Returns
808
845
 
809
- `Promise`<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
846
+ `Promise`\<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
@@ -0,0 +1,65 @@
1
+ # Interface: TBonus
2
+
3
+ ## Properties
4
+
5
+ ### bonus\_id
6
+
7
+ • **bonus\_id**: `number`
8
+
9
+ ID of the bonus
10
+
11
+ ___
12
+
13
+ ### is\_redeemable
14
+
15
+ • `Optional` **is\_redeemable**: `boolean`
16
+
17
+ Can the bonus be redeemed (if bonus is redeemable the user needs to claim it)
18
+
19
+ ___
20
+
21
+ ### create\_date
22
+
23
+ • `Optional` **create\_date**: `string`
24
+
25
+ Date of creation
26
+
27
+ ___
28
+
29
+ ### redeem\_date
30
+
31
+ • `Optional` **redeem\_date**: `string`
32
+
33
+ Date of redemption
34
+
35
+ ___
36
+
37
+ ### label\_bonus\_template\_id
38
+
39
+ • `Optional` **label\_bonus\_template\_id**: `number`
40
+
41
+ ID of template used
42
+
43
+ ___
44
+
45
+ ### bonus\_status\_id
46
+
47
+ • `Optional` **bonus\_status\_id**: `BonusStatus`
48
+
49
+ ID of the bonus status
50
+
51
+ ___
52
+
53
+ ### label\_bonus\_template\_meta\_map
54
+
55
+ • `Optional` **label\_bonus\_template\_meta\_map**: `BonusTemplateMetaMap`
56
+
57
+ Additional information about the bonus(edscription, image,name, acknowledge)
58
+
59
+ ___
60
+
61
+ ### bonus\_meta\_map
62
+
63
+ • `Optional` **bonus\_meta\_map**: `BonusMetaMap`
64
+
65
+ Additional information presented to the player when the bonus is redeemed
@@ -0,0 +1,27 @@
1
+ # Interface: TClaimBonusResult
2
+
3
+ TClaimBonusResult describes the response of call to _smartico.api.claimBonus(bonus_id) method
4
+
5
+ ## Properties
6
+
7
+ ### err\_code
8
+
9
+ • **err\_code**: [`SAWSpinErrorCode`](../enums/SAWSpinErrorCode.md)
10
+
11
+ Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0
12
+
13
+ ___
14
+
15
+ ### err\_message
16
+
17
+ • **err\_message**: `string`
18
+
19
+ Optional error message
20
+
21
+ ___
22
+
23
+ ### success
24
+
25
+ • `Optional` **success**: `boolean`
26
+
27
+ If the bonus was claimed successfully, then success is true
@@ -32,7 +32,7 @@ ___
32
32
 
33
33
  The action that should be performed when user clicks on the message.
34
34
  Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
35
- The 'dp' function will handle the CTA and will execute it in the most safe way.
35
+ The 'dp' function will handle the CTA and will execute it in the most safe way.
36
36
  If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered.
37
37
 
38
38
  ___
@@ -47,6 +47,6 @@ ___
47
47
 
48
48
  ### buttons
49
49
 
50
- • `Optional` **buttons**: { `action`: `string` ; `text`: `string` }[]
50
+ • `Optional` **buttons**: \{ `action`: `string` ; `text`: `string` }[]
51
51
 
52
52
  Optional additional buttons to show in the message, available only if message has rich HTML body. Max count - 2.