@smartico/public-api 0.0.420 → 0.0.422

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 (133) hide show
  1. package/README.md +14 -0
  2. package/dist/ActivityLog/ActivityLogActivities.d.ts +1 -1
  3. package/dist/ActivityLog/ActivityLogEntry.d.ts +35 -17
  4. package/dist/ActivityLog/ActivityLogMeta.d.ts +31 -0
  5. package/dist/ActivityLog/GetActivityLogRequest.d.ts +2 -0
  6. package/dist/ActivityLog/GetActivityLogResponse.d.ts +1 -2
  7. package/dist/Jackpots/JackPotWinPushWinner.d.ts +34 -0
  8. package/dist/Jackpots/JackPotWinner.d.ts +3 -1
  9. package/dist/Jackpots/JackpotContributionRule.d.ts +23 -0
  10. package/dist/Jackpots/JackpotDetails.d.ts +8 -0
  11. package/dist/Jackpots/JackpotPot.d.ts +4 -2
  12. package/dist/Jackpots/JackpotPublicMeta.d.ts +6 -2
  13. package/dist/Jackpots/JackpotWinPush.d.ts +14 -2
  14. package/dist/Jackpots/index.d.ts +2 -0
  15. package/dist/SmarticoAPI.d.ts +1 -3
  16. package/dist/WSAPI/WSAPIBase.d.ts +0 -1
  17. package/dist/WSAPI/WSAPIJackpots.d.ts +2 -0
  18. package/dist/WSAPI/WSAPITypes.d.ts +19 -17
  19. package/dist/WSAPI/WSAPIUser.d.ts +11 -36
  20. package/dist/index.js +36 -128
  21. package/dist/index.js.map +1 -1
  22. package/dist/index.modern.mjs +34 -100
  23. package/dist/index.modern.mjs.map +1 -1
  24. package/docs/Callbacks.md +1 -1
  25. package/docs/api/README.md +4 -4
  26. package/docs/api/classes/WSAPIJackpots.md +2 -0
  27. package/docs/api/classes/WSAPIUser.md +30 -59
  28. package/docs/api/documents/Callbacks.md +1 -1
  29. package/docs/api/enumerations/ActivityLogActivities.md +1 -1
  30. package/docs/api/enumerations/PointChangeSourceType.md +6 -0
  31. package/docs/api/interfaces/ActivityLogEntry.md +124 -0
  32. package/docs/api/interfaces/ActivityLogMeta.md +100 -0
  33. package/docs/api/interfaces/JackPotWinPushWinner.md +103 -0
  34. package/docs/api/interfaces/JackPotWinner.md +9 -1
  35. package/docs/api/interfaces/JackpotContributionRule.md +49 -0
  36. package/docs/api/interfaces/JackpotDetails.md +24 -0
  37. package/docs/api/interfaces/JackpotPot.md +9 -1
  38. package/docs/api/interfaces/JackpotPublicMeta.md +12 -2
  39. package/docs/api/interfaces/JackpotWinPush.md +14 -1
  40. package/docs/api/interfaces/TActivityLog.md +70 -2
  41. package/docs/api/type-aliases/TActivityLogEntry.md +7 -0
  42. package/docs/capabilities/_responses/gamePickGetActiveRound.json +37 -37
  43. package/docs/capabilities/_responses/gamePickGetActiveRounds.json +37 -131
  44. package/docs/capabilities/_responses/gamePickGetBoard.json +25 -14
  45. package/docs/capabilities/_responses/gamePickGetGameInfo.json +93 -79
  46. package/docs/capabilities/_responses/gamePickGetHistory.json +37 -131
  47. package/docs/capabilities/_responses/gamePickGetUserInfo.json +5 -5
  48. package/docs/capabilities/_responses/getActivityLog.json +106 -1
  49. package/docs/capabilities/_responses/getAvatarsCustomized.json +4 -4
  50. package/docs/capabilities/_responses/getAvatarsList.json +2 -2
  51. package/docs/capabilities/_responses/getBadges.json +27 -29
  52. package/docs/capabilities/_responses/getBonuses.json +1 -18
  53. package/docs/capabilities/_responses/getClanInfo.json +13 -13
  54. package/docs/capabilities/_responses/getClans.json +6 -6
  55. package/docs/capabilities/_responses/getCurrentLevel.json +12 -12
  56. package/docs/capabilities/_responses/getInboxMessageBody.json +2 -2
  57. package/docs/capabilities/_responses/getInboxMessages.json +6 -6
  58. package/docs/capabilities/_responses/getInboxUnreadCount.json +1 -1
  59. package/docs/capabilities/_responses/getJackpotWinners.json +14 -14
  60. package/docs/capabilities/_responses/getLeaderBoard.json +8 -8
  61. package/docs/capabilities/_responses/getMiniGames.json +92 -90
  62. package/docs/capabilities/_responses/getMiniGamesHistory.json +874 -1
  63. package/docs/capabilities/_responses/getMissions.json +2 -2
  64. package/docs/capabilities/_responses/getRaffleDrawRun.json +7 -7
  65. package/docs/capabilities/_responses/getRaffleDrawRunsHistory.json +6 -6
  66. package/docs/capabilities/_responses/getRaffles.json +14 -14
  67. package/docs/capabilities/_responses/getStorePurchasedItems.json +5 -5
  68. package/docs/capabilities/_responses/getTournamentInstanceInfo.json +100 -53
  69. package/docs/capabilities/_responses/getTournamentsList.json +12 -12
  70. package/docs/capabilities/_responses/getTranslations.json +1 -1
  71. package/docs/capabilities/_responses/getUserProfile.json +10 -10
  72. package/docs/capabilities/_responses/jackpotGet.json +33 -34
  73. package/docs/capabilities/gamePickGetActiveRound.md +22 -23
  74. package/docs/capabilities/gamePickGetActiveRounds.md +22 -23
  75. package/docs/capabilities/gamePickGetBoard.md +14 -14
  76. package/docs/capabilities/gamePickGetGameInfo.md +24 -44
  77. package/docs/capabilities/gamePickGetHistory.md +22 -23
  78. package/docs/capabilities/gamePickGetUserInfo.md +5 -5
  79. package/docs/capabilities/getActivityLog.md +69 -9
  80. package/docs/capabilities/getAvatarsCustomized.md +3 -3
  81. package/docs/capabilities/getBadges.md +13 -14
  82. package/docs/capabilities/getBonuses.md +2 -17
  83. package/docs/capabilities/getClanInfo.md +8 -8
  84. package/docs/capabilities/getClans.md +4 -4
  85. package/docs/capabilities/getCurrentLevel.md +12 -12
  86. package/docs/capabilities/getInboxMessageBody.md +2 -2
  87. package/docs/capabilities/getInboxMessages.md +3 -3
  88. package/docs/capabilities/getInboxUnreadCount.md +6 -0
  89. package/docs/capabilities/getJackpotWinners.md +9 -8
  90. package/docs/capabilities/getLeaderBoard.md +5 -5
  91. package/docs/capabilities/getMiniGames.md +35 -37
  92. package/docs/capabilities/getMiniGamesHistory.md +83 -2
  93. package/docs/capabilities/getMissions.md +1 -1
  94. package/docs/capabilities/getRaffleDrawRun.md +7 -7
  95. package/docs/capabilities/getRaffleDrawRunsHistory.md +3 -3
  96. package/docs/capabilities/getRaffles.md +8 -8
  97. package/docs/capabilities/getStorePurchasedItems.md +2 -2
  98. package/docs/capabilities/getTournamentInstanceInfo.md +45 -37
  99. package/docs/capabilities/getTournamentsList.md +6 -6
  100. package/docs/capabilities/getTranslations.md +1 -1
  101. package/docs/capabilities/getUserProfile.md +10 -10
  102. package/docs/capabilities/jackpotGet.md +56 -28
  103. package/docs/capabilities/jackpotOptIn.md +2 -0
  104. package/docs/capabilities/smarticoCallbacks.md +1 -1
  105. package/docs/native/PROTOCOL.md +141 -18
  106. package/docs/ui/jackpots/UIGuide_jackpotGet.md +1 -1
  107. package/docs/ui/user/UIGuide_getActivityLog.md +4 -2
  108. package/package.json +4 -3
  109. package/scripts/capture-responses-browser.mjs +8 -1
  110. package/src/ActivityLog/ActivityLogActivities.ts +1 -1
  111. package/src/ActivityLog/ActivityLogEntry.ts +33 -21
  112. package/src/ActivityLog/ActivityLogMeta.ts +31 -0
  113. package/src/ActivityLog/GetActivityLogRequest.ts +2 -0
  114. package/src/ActivityLog/GetActivityLogResponse.ts +23 -49
  115. package/src/Jackpots/JackPotWinPushWinner.ts +35 -0
  116. package/src/Jackpots/JackPotWinner.ts +3 -1
  117. package/src/Jackpots/JackpotContributionRule.ts +25 -0
  118. package/src/Jackpots/JackpotDetails.ts +8 -0
  119. package/src/Jackpots/JackpotPot.ts +4 -2
  120. package/src/Jackpots/JackpotPublicMeta.ts +6 -2
  121. package/src/Jackpots/JackpotWinPush.ts +14 -2
  122. package/src/Jackpots/index.ts +2 -0
  123. package/src/MiniGames/SAWGetTemplatesResponse.ts +1 -0
  124. package/src/SmarticoAPI.ts +1 -44
  125. package/src/WSAPI/WSAPIBase.ts +0 -1
  126. package/src/WSAPI/WSAPIJackpots.ts +2 -0
  127. package/src/WSAPI/WSAPITypes.ts +20 -18
  128. package/src/WSAPI/WSAPIUser.ts +10 -53
  129. package/docs/api/interfaces/GemsDiamondsLog.md +0 -45
  130. package/docs/api/interfaces/PointsLog.md +0 -45
  131. package/docs/api/interfaces/TActivityLogEntry.md +0 -100
  132. package/docs/api/type-aliases/ActivityLogEntry.md +0 -3
  133. package/docs/capabilities/getActivityLogV2.md +0 -62
@@ -1,94 +1,94 @@
1
1
  [
2
2
  {
3
- "id": 656,
4
- "name": "Scratch & Love",
3
+ "id": 651,
4
+ "name": "Wheel of Love",
5
5
  "description": "This is demo description of mini game. <br/>\n <hr/>\n\n You can <b>use tags</b> like {{spins_available}}, to show number of spins that user can use in this game. <br/>\n …",
6
6
  "thumbnail": "https://cdn.example/00000000-0000-0000-0000-000000000000/ico.png",
7
7
  "visibile_when_can_spin": false,
8
- "saw_game_type": "scratch",
9
- "saw_buyin_type": "spins",
8
+ "over_limit_message": "That's enough for today, please come back tomorrow",
9
+ "no_attempts_message": "You don't have any more attempts on this minigame",
10
+ "jackpot_symbol": "hugs",
11
+ "saw_game_type": "wheel",
12
+ "saw_buyin_type": "free",
10
13
  "jackpot_add_on_attempt": 1,
11
- "jackpot_current": 1070,
12
- "spin_count": 5,
13
- "promo_image": "https://cdn.example/d3d65f1bc722a8c66a9493-PromoImagefromTinyPNG.png",
14
- "promo_text": "The Scratch of Love is better than any other scratch!",
14
+ "jackpot_current": 5339,
15
+ "spin_count": 1,
16
+ "promo_image": "https://cdn.example/31c0db8a8d3e9888ba009a-promo-image.png",
15
17
  "custom_data": {},
16
18
  "expose_game_stat_on_api": false,
17
19
  "relative_period_timezone": 0,
18
20
  "activeFromDate": -9223372036854776000,
19
21
  "activeTillDate": 9223372036854776000,
20
22
  "next_available_spin_ts": null,
21
- "earliest_expiration_dt": 1952155860877,
22
- "latest_expiration_dt": 1952155860877,
23
- "custom_section_id": 491,
23
+ "earliest_expiration_dt": null,
24
+ "latest_expiration_dt": null,
24
25
  "saw_template_ui_definition": {
25
- "scratch_bg_mobile": "",
26
- "promo_text": "The Scratch of Love is better than any other scratch!",
27
26
  "thumbnail": "",
28
- "only_in_custom_section": false,
29
- "scratch_logo": "",
27
+ "jackpot_symbol": "hugs",
28
+ "over_limit_message": "That's enough for today, please come back tomorrow",
30
29
  "description": "This is demo description of mini game. <br/>\n <hr/>\n\n You can <b>use tags</b> like {{spins_available}}, to show number of spins that user can use in this game. <br/>\n …",
31
30
  "background_image_mobile": "",
32
- "custom_css": ".scratch-card-root-mobile .scratch-area .button-area div {\n background-image: linear-gradient(180deg,#BD0A42,50%,#BD0A42);\n}\n.scratch-card-root .scratch-area .button-area div {\n background-im…",
33
- "hide_prize_names": false,
34
- "scratch_bg_desktop": "",
31
+ "custom_css": "/* text of the prize on sector */\n.saw-view .wheel-sector-name .sector-text {\n\n}\n\n/* the name of the game shown under the wheel */\n.saw-info-name {\n \n}\n\n/* style of the \"?\" mark opening descripti…",
35
32
  "priority": 1,
36
- "scratch_cover": "",
37
33
  "background_image": "",
38
- "sectors_count": 6,
39
- "show_countdown_for_next_availability": false,
40
- "promo_image": "https://cdn.example/d3d65f1bc722a8c66a9493-PromoImagefromTinyPNG.png",
41
- "disable_background_music": true,
42
- "scratch_cursor": "",
34
+ "wheel_layout": 1,
35
+ "sectors_count": 7,
36
+ "show_countdown_for_next_availability": true,
37
+ "promo_image": "https://cdn.example/31c0db8a8d3e9888ba009a-promo-image.png",
38
+ "disable_background_music": false,
43
39
  "background_sound": "",
44
- "name": "Scratch & Love",
45
- "spin_animation_duration": 15,
40
+ "name": "Wheel of Love",
41
+ "max_spins_period_ms": 60000,
42
+ "spin_animation_duration": 10,
46
43
  "flow_builder_only": false,
47
- "custom_section_id": 491,
48
- "background_music_volume": 10
44
+ "wheel_pointer_rotation": 0,
45
+ "background_music_volume": 10,
46
+ "no_attempts_message": "You don't have any more attempts on this minigame"
49
47
  },
50
48
  "show_prize_history": true,
51
- "max_number_of_attempts": 0,
49
+ "max_number_of_attempts": 1,
52
50
  "prizes": [
53
51
  {
54
- "id": 15589,
55
- "name": "No luck this time =(",
52
+ "id": 3272,
53
+ "name": "Try again!",
56
54
  "prize_type": "no-prize",
57
55
  "prize_value": 1,
58
- "font_size": null,
59
- "position": 7,
56
+ "font_size": 20,
57
+ "icon": "",
60
58
  "sectors": [
61
- ""
59
+ 1
62
60
  ],
63
61
  "acknowledge_type": "silent",
64
62
  "acknowledge_dp": "dp:ok",
65
63
  "acknowledge_action_title": "OK",
66
64
  "pool": null,
67
- "pool_initial": 100,
65
+ "pool_initial": 500,
68
66
  "wins_count": null,
69
67
  "weekdays": null,
70
68
  "active_from_ts": null,
71
69
  "active_till_ts": null,
72
70
  "relative_period_timezone": 0,
73
- "is_surcharge": false,
71
+ "is_surcharge": true,
74
72
  "is_deleted": false,
75
73
  "custom_data": {},
76
74
  "max_give_period_type_id": 2
77
75
  },
78
76
  {
79
- "id": 3301,
80
- "name": "150 Points",
77
+ "id": 3273,
78
+ "name": "25 Points",
81
79
  "prize_type": "points",
82
- "prize_value": 150,
83
- "font_size": null,
84
- "icon": "https://cdn.example/cbc28c039c3b2b4f91034c-Storeitemcopy18.png",
85
- "position": 5,
80
+ "prize_value": 25,
81
+ "font_size": 20,
82
+ "icon": "",
86
83
  "sectors": [
87
- ""
84
+ 2
88
85
  ],
89
- "acknowledge_type": "silent",
86
+ "acknowledge_type": "explicity-acknowledge",
87
+ "aknowledge_message": "You've won 25 gamification points! You may spend them in the store to purchase a bonus, a minigame, or a tangible prize!",
90
88
  "acknowledge_dp": "dp:ok",
91
- "acknowledge_action_title": "OK",
89
+ "acknowledge_action_title": "Claim the prize",
90
+ "acknowledge_dp_additional": "dp:ok",
91
+ "acknowledge_action_title_additional": "Cancel",
92
92
  "pool": null,
93
93
  "pool_initial": 1000,
94
94
  "wins_count": null,
@@ -96,7 +96,7 @@
96
96
  "active_from_ts": null,
97
97
  "active_till_ts": null,
98
98
  "relative_period_timezone": 0,
99
- "is_surcharge": true,
99
+ "is_surcharge": false,
100
100
  "is_deleted": false,
101
101
  "custom_data": {},
102
102
  "max_give_period_type_id": 2
@@ -104,93 +104,95 @@
104
104
  ]
105
105
  },
106
106
  {
107
- "id": 651,
108
- "name": "Wheel of Love",
107
+ "id": 656,
108
+ "name": "Scratch & Love",
109
109
  "description": "This is demo description of mini game. <br/>\n <hr/>\n\n You can <b>use tags</b> like {{spins_available}}, to show number of spins that user can use in this game. <br/>\n …",
110
110
  "thumbnail": "https://cdn.example/00000000-0000-0000-0000-000000000000/ico.png",
111
111
  "visibile_when_can_spin": false,
112
- "over_limit_message": "That's enough for today, please come back tomorrow",
113
- "no_attempts_message": "You don't have any more attempts on this minigame",
114
- "jackpot_symbol": "hugs",
115
- "saw_game_type": "wheel",
116
- "saw_buyin_type": "free",
112
+ "saw_game_type": "scratch",
113
+ "saw_buyin_type": "spins",
117
114
  "jackpot_add_on_attempt": 1,
118
- "jackpot_current": 5180,
119
- "spin_count": 1,
120
- "promo_image": "https://cdn.example/31c0db8a8d3e9888ba009a-promo-image.png",
115
+ "jackpot_current": 1048,
116
+ "spin_count": 5,
117
+ "promo_image": "https://cdn.example/d3d65f1bc722a8c66a9493-PromoImagefromTinyPNG.png",
118
+ "promo_text": "The Scratch of Love is better than any other scratch!",
121
119
  "custom_data": {},
122
120
  "expose_game_stat_on_api": false,
123
121
  "relative_period_timezone": 0,
124
122
  "activeFromDate": -9223372036854776000,
125
123
  "activeTillDate": 9223372036854776000,
126
124
  "next_available_spin_ts": null,
125
+ "earliest_expiration_dt": null,
126
+ "latest_expiration_dt": null,
127
+ "custom_section_id": 491,
127
128
  "saw_template_ui_definition": {
129
+ "scratch_bg_mobile": "",
130
+ "promo_text": "The Scratch of Love is better than any other scratch!",
128
131
  "thumbnail": "",
129
- "jackpot_symbol": "hugs",
130
- "over_limit_message": "That's enough for today, please come back tomorrow",
132
+ "only_in_custom_section": false,
133
+ "scratch_logo": "",
131
134
  "description": "This is demo description of mini game. <br/>\n <hr/>\n\n You can <b>use tags</b> like {{spins_available}}, to show number of spins that user can use in this game. <br/>\n …",
132
135
  "background_image_mobile": "",
133
- "custom_css": "/* text of the prize on sector */\n.saw-view .wheel-sector-name .sector-text {\n\n}\n\n/* the name of the game shown under the wheel */\n.saw-info-name {\n \n}\n\n/* style of the \"?\" mark opening descripti…",
136
+ "custom_css": ".scratch-card-root-mobile .scratch-area .button-area div {\n background-image: linear-gradient(180deg,#BD0A42,50%,#BD0A42);\n}\n.scratch-card-root .scratch-area .button-area div {\n background-im…",
137
+ "hide_prize_names": false,
138
+ "scratch_bg_desktop": "",
134
139
  "priority": 1,
140
+ "scratch_cover": "",
135
141
  "background_image": "",
136
- "wheel_layout": 1,
137
- "sectors_count": 7,
138
- "show_countdown_for_next_availability": true,
139
- "promo_image": "https://cdn.example/31c0db8a8d3e9888ba009a-promo-image.png",
140
- "disable_background_music": false,
142
+ "sectors_count": 6,
143
+ "show_countdown_for_next_availability": false,
144
+ "promo_image": "https://cdn.example/d3d65f1bc722a8c66a9493-PromoImagefromTinyPNG.png",
145
+ "disable_background_music": true,
146
+ "scratch_cursor": "",
141
147
  "background_sound": "",
142
- "name": "Wheel of Love",
143
- "max_spins_period_ms": 60000,
144
- "spin_animation_duration": 10,
148
+ "name": "Scratch & Love",
149
+ "spin_animation_duration": 15,
145
150
  "flow_builder_only": false,
146
- "wheel_pointer_rotation": 0,
147
- "background_music_volume": 10,
148
- "no_attempts_message": "You don't have any more attempts on this minigame"
151
+ "custom_section_id": 491,
152
+ "background_music_volume": 10
149
153
  },
150
154
  "show_prize_history": true,
151
- "max_number_of_attempts": 1,
155
+ "max_number_of_attempts": 0,
152
156
  "prizes": [
153
157
  {
154
- "id": 3272,
155
- "name": "Try again!",
158
+ "id": 15589,
159
+ "name": "No luck this time =(",
156
160
  "prize_type": "no-prize",
157
161
  "prize_value": 1,
158
- "font_size": 20,
159
- "icon": "",
162
+ "font_size": null,
163
+ "position": 7,
160
164
  "sectors": [
161
- 1
165
+ ""
162
166
  ],
163
167
  "acknowledge_type": "silent",
164
168
  "acknowledge_dp": "dp:ok",
165
169
  "acknowledge_action_title": "OK",
166
170
  "pool": null,
167
- "pool_initial": 500,
171
+ "pool_initial": 100,
168
172
  "wins_count": null,
169
173
  "weekdays": null,
170
174
  "active_from_ts": null,
171
175
  "active_till_ts": null,
172
176
  "relative_period_timezone": 0,
173
- "is_surcharge": true,
177
+ "is_surcharge": false,
174
178
  "is_deleted": false,
175
179
  "custom_data": {},
176
180
  "max_give_period_type_id": 2
177
181
  },
178
182
  {
179
- "id": 3273,
180
- "name": "25 Points",
183
+ "id": 3301,
184
+ "name": "150 Points",
181
185
  "prize_type": "points",
182
- "prize_value": 25,
183
- "font_size": 20,
184
- "icon": "",
186
+ "prize_value": 150,
187
+ "font_size": null,
188
+ "icon": "https://cdn.example/cbc28c039c3b2b4f91034c-Storeitemcopy18.png",
189
+ "position": 5,
185
190
  "sectors": [
186
- 2
191
+ ""
187
192
  ],
188
- "acknowledge_type": "explicity-acknowledge",
189
- "aknowledge_message": "You've won 25 gamification points! You may spend them in the store to purchase a bonus, a minigame, or a tangible prize!",
193
+ "acknowledge_type": "silent",
190
194
  "acknowledge_dp": "dp:ok",
191
- "acknowledge_action_title": "Claim the prize",
192
- "acknowledge_dp_additional": "dp:ok",
193
- "acknowledge_action_title_additional": "Cancel",
195
+ "acknowledge_action_title": "OK",
194
196
  "pool": null,
195
197
  "pool_initial": 1000,
196
198
  "wins_count": null,
@@ -198,7 +200,7 @@
198
200
  "active_from_ts": null,
199
201
  "active_till_ts": null,
200
202
  "relative_period_timezone": 0,
201
- "is_surcharge": false,
203
+ "is_surcharge": true,
202
204
  "is_deleted": false,
203
205
  "custom_data": {},
204
206
  "max_give_period_type_id": 2