@smartico/public-api 0.0.420 → 0.0.421

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 (131) hide show
  1. package/dist/ActivityLog/ActivityLogActivities.d.ts +1 -1
  2. package/dist/ActivityLog/ActivityLogEntry.d.ts +35 -17
  3. package/dist/ActivityLog/ActivityLogMeta.d.ts +31 -0
  4. package/dist/ActivityLog/GetActivityLogRequest.d.ts +2 -0
  5. package/dist/ActivityLog/GetActivityLogResponse.d.ts +1 -2
  6. package/dist/Jackpots/JackPotWinPushWinner.d.ts +34 -0
  7. package/dist/Jackpots/JackPotWinner.d.ts +3 -1
  8. package/dist/Jackpots/JackpotContributionRule.d.ts +23 -0
  9. package/dist/Jackpots/JackpotDetails.d.ts +8 -0
  10. package/dist/Jackpots/JackpotPot.d.ts +4 -2
  11. package/dist/Jackpots/JackpotPublicMeta.d.ts +6 -2
  12. package/dist/Jackpots/JackpotWinPush.d.ts +14 -2
  13. package/dist/Jackpots/index.d.ts +2 -0
  14. package/dist/SmarticoAPI.d.ts +1 -3
  15. package/dist/WSAPI/WSAPIBase.d.ts +0 -1
  16. package/dist/WSAPI/WSAPIJackpots.d.ts +2 -0
  17. package/dist/WSAPI/WSAPITypes.d.ts +17 -17
  18. package/dist/WSAPI/WSAPIUser.d.ts +11 -36
  19. package/dist/index.js +35 -128
  20. package/dist/index.js.map +1 -1
  21. package/dist/index.modern.mjs +33 -100
  22. package/dist/index.modern.mjs.map +1 -1
  23. package/docs/Callbacks.md +1 -1
  24. package/docs/api/README.md +4 -4
  25. package/docs/api/classes/WSAPIJackpots.md +2 -0
  26. package/docs/api/classes/WSAPIUser.md +30 -59
  27. package/docs/api/documents/Callbacks.md +1 -1
  28. package/docs/api/enumerations/ActivityLogActivities.md +1 -1
  29. package/docs/api/enumerations/PointChangeSourceType.md +6 -0
  30. package/docs/api/interfaces/ActivityLogEntry.md +124 -0
  31. package/docs/api/interfaces/ActivityLogMeta.md +100 -0
  32. package/docs/api/interfaces/JackPotWinPushWinner.md +103 -0
  33. package/docs/api/interfaces/JackPotWinner.md +9 -1
  34. package/docs/api/interfaces/JackpotContributionRule.md +49 -0
  35. package/docs/api/interfaces/JackpotDetails.md +24 -0
  36. package/docs/api/interfaces/JackpotPot.md +9 -1
  37. package/docs/api/interfaces/JackpotPublicMeta.md +12 -2
  38. package/docs/api/interfaces/JackpotWinPush.md +14 -1
  39. package/docs/api/interfaces/TActivityLog.md +70 -2
  40. package/docs/api/type-aliases/TActivityLogEntry.md +7 -0
  41. package/docs/capabilities/_responses/gamePickGetActiveRound.json +37 -37
  42. package/docs/capabilities/_responses/gamePickGetActiveRounds.json +37 -131
  43. package/docs/capabilities/_responses/gamePickGetBoard.json +25 -14
  44. package/docs/capabilities/_responses/gamePickGetGameInfo.json +93 -79
  45. package/docs/capabilities/_responses/gamePickGetHistory.json +37 -131
  46. package/docs/capabilities/_responses/gamePickGetUserInfo.json +5 -5
  47. package/docs/capabilities/_responses/getActivityLog.json +106 -1
  48. package/docs/capabilities/_responses/getAvatarsCustomized.json +4 -4
  49. package/docs/capabilities/_responses/getAvatarsList.json +2 -2
  50. package/docs/capabilities/_responses/getBadges.json +27 -29
  51. package/docs/capabilities/_responses/getBonuses.json +1 -18
  52. package/docs/capabilities/_responses/getClanInfo.json +13 -13
  53. package/docs/capabilities/_responses/getClans.json +6 -6
  54. package/docs/capabilities/_responses/getCurrentLevel.json +12 -12
  55. package/docs/capabilities/_responses/getInboxMessageBody.json +2 -2
  56. package/docs/capabilities/_responses/getInboxMessages.json +6 -6
  57. package/docs/capabilities/_responses/getInboxUnreadCount.json +1 -1
  58. package/docs/capabilities/_responses/getJackpotWinners.json +14 -14
  59. package/docs/capabilities/_responses/getLeaderBoard.json +8 -8
  60. package/docs/capabilities/_responses/getMiniGames.json +92 -90
  61. package/docs/capabilities/_responses/getMiniGamesHistory.json +874 -1
  62. package/docs/capabilities/_responses/getMissions.json +2 -2
  63. package/docs/capabilities/_responses/getRaffleDrawRun.json +7 -7
  64. package/docs/capabilities/_responses/getRaffleDrawRunsHistory.json +6 -6
  65. package/docs/capabilities/_responses/getRaffles.json +14 -14
  66. package/docs/capabilities/_responses/getStorePurchasedItems.json +5 -5
  67. package/docs/capabilities/_responses/getTournamentInstanceInfo.json +100 -53
  68. package/docs/capabilities/_responses/getTournamentsList.json +12 -12
  69. package/docs/capabilities/_responses/getTranslations.json +1 -1
  70. package/docs/capabilities/_responses/getUserProfile.json +10 -10
  71. package/docs/capabilities/_responses/jackpotGet.json +33 -34
  72. package/docs/capabilities/gamePickGetActiveRound.md +22 -23
  73. package/docs/capabilities/gamePickGetActiveRounds.md +22 -23
  74. package/docs/capabilities/gamePickGetBoard.md +14 -14
  75. package/docs/capabilities/gamePickGetGameInfo.md +24 -44
  76. package/docs/capabilities/gamePickGetHistory.md +22 -23
  77. package/docs/capabilities/gamePickGetUserInfo.md +5 -5
  78. package/docs/capabilities/getActivityLog.md +69 -9
  79. package/docs/capabilities/getAvatarsCustomized.md +3 -3
  80. package/docs/capabilities/getBadges.md +13 -14
  81. package/docs/capabilities/getBonuses.md +2 -17
  82. package/docs/capabilities/getClanInfo.md +8 -8
  83. package/docs/capabilities/getClans.md +4 -4
  84. package/docs/capabilities/getCurrentLevel.md +12 -12
  85. package/docs/capabilities/getInboxMessageBody.md +2 -2
  86. package/docs/capabilities/getInboxMessages.md +3 -3
  87. package/docs/capabilities/getInboxUnreadCount.md +6 -0
  88. package/docs/capabilities/getJackpotWinners.md +9 -8
  89. package/docs/capabilities/getLeaderBoard.md +5 -5
  90. package/docs/capabilities/getMiniGames.md +35 -37
  91. package/docs/capabilities/getMiniGamesHistory.md +83 -2
  92. package/docs/capabilities/getMissions.md +1 -1
  93. package/docs/capabilities/getRaffleDrawRun.md +7 -7
  94. package/docs/capabilities/getRaffleDrawRunsHistory.md +3 -3
  95. package/docs/capabilities/getRaffles.md +8 -8
  96. package/docs/capabilities/getStorePurchasedItems.md +2 -2
  97. package/docs/capabilities/getTournamentInstanceInfo.md +45 -37
  98. package/docs/capabilities/getTournamentsList.md +6 -6
  99. package/docs/capabilities/getTranslations.md +1 -1
  100. package/docs/capabilities/getUserProfile.md +10 -10
  101. package/docs/capabilities/jackpotGet.md +56 -28
  102. package/docs/capabilities/jackpotOptIn.md +2 -0
  103. package/docs/capabilities/smarticoCallbacks.md +1 -1
  104. package/docs/native/PROTOCOL.md +141 -18
  105. package/docs/ui/jackpots/UIGuide_jackpotGet.md +1 -1
  106. package/docs/ui/user/UIGuide_getActivityLog.md +4 -2
  107. package/package.json +4 -3
  108. package/scripts/capture-responses-browser.mjs +8 -1
  109. package/src/ActivityLog/ActivityLogActivities.ts +1 -1
  110. package/src/ActivityLog/ActivityLogEntry.ts +33 -21
  111. package/src/ActivityLog/ActivityLogMeta.ts +31 -0
  112. package/src/ActivityLog/GetActivityLogRequest.ts +2 -0
  113. package/src/ActivityLog/GetActivityLogResponse.ts +23 -49
  114. package/src/Jackpots/JackPotWinPushWinner.ts +35 -0
  115. package/src/Jackpots/JackPotWinner.ts +3 -1
  116. package/src/Jackpots/JackpotContributionRule.ts +25 -0
  117. package/src/Jackpots/JackpotDetails.ts +8 -0
  118. package/src/Jackpots/JackpotPot.ts +4 -2
  119. package/src/Jackpots/JackpotPublicMeta.ts +6 -2
  120. package/src/Jackpots/JackpotWinPush.ts +14 -2
  121. package/src/Jackpots/index.ts +2 -0
  122. package/src/SmarticoAPI.ts +1 -44
  123. package/src/WSAPI/WSAPIBase.ts +0 -1
  124. package/src/WSAPI/WSAPIJackpots.ts +2 -0
  125. package/src/WSAPI/WSAPITypes.ts +18 -18
  126. package/src/WSAPI/WSAPIUser.ts +10 -53
  127. package/docs/api/interfaces/GemsDiamondsLog.md +0 -45
  128. package/docs/api/interfaces/PointsLog.md +0 -45
  129. package/docs/api/interfaces/TActivityLogEntry.md +0 -100
  130. package/docs/api/type-aliases/ActivityLogEntry.md +0 -3
  131. package/docs/capabilities/getActivityLogV2.md +0 -62
@@ -1,45 +0,0 @@
1
- # Interface: PointsLog
2
-
3
- ## Properties
4
-
5
- ### create\_date
6
-
7
- > **create\_date**: `number`
8
-
9
- Epoch timestamp in SECONDS (not ms — unlike most SDK timestamps).
10
-
11
- ***
12
-
13
- ### user\_ext\_id
14
-
15
- > **user\_ext\_id**: `string`
16
-
17
- ***
18
-
19
- ### crm\_brand\_id
20
-
21
- > **crm\_brand\_id**: `number`
22
-
23
- ***
24
-
25
- ### points\_collected
26
-
27
- > **points\_collected**: `number`
28
-
29
- ***
30
-
31
- ### user\_points\_ever
32
-
33
- > **user\_points\_ever**: `number`
34
-
35
- ***
36
-
37
- ### user\_points\_balance
38
-
39
- > **user\_points\_balance**: `number`
40
-
41
- ***
42
-
43
- ### source\_type\_id
44
-
45
- > **source\_type\_id**: [`PointChangeSourceType`](../enumerations/PointChangeSourceType.md)
@@ -1,100 +0,0 @@
1
- # Interface: TActivityLogEntry
2
-
3
- Full activity-log row returned by [WSAPIUser.getActivityLogV2](../classes/WSAPIUser.md#getactivitylogv2).
4
- Includes wallet changes and non-wallet activities (missions, badges, levels, …).
5
-
6
- ## Properties
7
-
8
- ### create\_date
9
-
10
- > **create\_date**: `number`
11
-
12
- ***
13
-
14
- ### user\_ext\_id
15
-
16
- > **user\_ext\_id**: `string`
17
-
18
- ***
19
-
20
- ### crm\_brand\_id
21
-
22
- > **crm\_brand\_id**: `number`
23
-
24
- ***
25
-
26
- ### type
27
-
28
- > **type**: [`UserBalanceType`](../enumerations/UserBalanceType.md)
29
-
30
- ***
31
-
32
- ### amount
33
-
34
- > **amount**: `number`
35
-
36
- ***
37
-
38
- ### balance
39
-
40
- > **balance**: `number`
41
-
42
- ***
43
-
44
- ### total\_ever?
45
-
46
- > `optional` **total\_ever?**: `number`
47
-
48
- ***
49
-
50
- ### source\_type\_id
51
-
52
- > **source\_type\_id**: [`PointChangeSourceType`](../enumerations/PointChangeSourceType.md)
53
-
54
- ***
55
-
56
- ### activity\_type\_id?
57
-
58
- > `optional` **activity\_type\_id?**: [`ActivityLogActivities`](../enumerations/ActivityLogActivities.md)
59
-
60
- ***
61
-
62
- ### context\_value\_1?
63
-
64
- > `optional` **context\_value\_1?**: `number`
65
-
66
- ***
67
-
68
- ### meta?
69
-
70
- > `optional` **meta?**: [`ActivityLogMeta`](ActivityLogMeta.md)
71
-
72
- ***
73
-
74
- ### source\_entity\_name?
75
-
76
- > `optional` **source\_entity\_name?**: `string`
77
-
78
- ***
79
-
80
- ### source\_entity\_id?
81
-
82
- > `optional` **source\_entity\_id?**: `number`
83
-
84
- ***
85
-
86
- ### source\_reference\_id?
87
-
88
- > `optional` **source\_reference\_id?**: `number`
89
-
90
- ***
91
-
92
- ### source\_root\_id?
93
-
94
- > `optional` **source\_root\_id?**: `number`
95
-
96
- ***
97
-
98
- ### is\_wallet\_entry
99
-
100
- > **is\_wallet\_entry**: `boolean`
@@ -1,3 +0,0 @@
1
- # Type Alias: ActivityLogEntry
2
-
3
- > **ActivityLogEntry** = [`PointsLog`](../interfaces/PointsLog.md) \| [`GemsDiamondsLog`](../interfaces/GemsDiamondsLog.md)
@@ -1,62 +0,0 @@
1
- # getActivityLogV2 — API (TActivityLogEntry)
2
-
3
- > Returns the full activity log (v2) — wallet changes **and** non-wallet activities (missions, badges, levels, tournaments, avatars, …).
4
- > Import: `import { TActivityLogEntry } from '@smartico/public-api'`
5
- > Search terms: getActivityLogV2, user, TActivityLogEntry, UserBalanceType, PointChangeSourceType, ActivityLogActivities, ActivityLogMeta
6
-
7
- ## Signature
8
- ```ts
9
- _smartico.api.getActivityLogV2({
10
- startTimeSeconds,
11
- endTimeSeconds,
12
- from,
13
- to,
14
- types,
15
- }: {
16
- startTimeSeconds: number;
17
- endTimeSeconds: number;
18
- from: number;
19
- to: number;
20
- types?: number[];
21
- }): Promise<TActivityLogEntry[]>
22
- ```
23
-
24
- ## Parameters
25
- _None._
26
-
27
- ## Returns — `Promise<TActivityLogEntry[]>`
28
- Array of `TActivityLogEntry`. Each item:
29
- - `create_date` (number)
30
- - `user_ext_id` (string)
31
- - `crm_brand_id` (number)
32
- - `type` (UserBalanceType)
33
- - `amount` (number)
34
- - `balance` (number)
35
- - `total_ever` (number)
36
- - `source_type_id` (PointChangeSourceType)
37
- - `activity_type_id` (ActivityLogActivities)
38
- - `context_value_1` (number)
39
- - `meta` (ActivityLogMeta)
40
- - `name` (string)
41
- - `image_url` (string)
42
- - `position` (number)
43
- - `user_points_balance_before` (number)
44
- - `points_requested` (number)
45
- - `user_points_ever` (number)
46
- - `source_entity_name` (string)
47
- - `source_entity_id` (number)
48
- - `source_reference_id` (number)
49
- - `source_root_id` (number)
50
- - `is_wallet_entry` (boolean)
51
-
52
- ## Behavioral contract
53
- See the [UI guide](../ui/user/UIGuide_getActivityLogV2.md) if present.
54
-
55
- ## Errors
56
- See this method's TSDoc / the mutation pages for `err_code` handling.
57
-
58
- ## Related
59
- - `getActivityLog`
60
- - `TActivityLog`
61
- - `ActivityLogActivities`
62
- - `TActivityLogEntry`