@smartico/public-api 0.0.357 → 0.0.359

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 (47) hide show
  1. package/dist/WSAPI/WSAPI.d.ts +24 -19
  2. package/dist/index.js +27 -20
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.modern.mjs +27 -20
  5. package/dist/index.modern.mjs.map +1 -1
  6. package/docs/api/README.md +58 -3
  7. package/docs/api/classes/WSAPI.md +24 -22
  8. package/docs/api/enums/AchievementStatus.md +49 -0
  9. package/docs/api/enums/AchievementTaskType.md +13 -0
  10. package/docs/api/enums/AchievementType.md +13 -0
  11. package/docs/api/enums/ActivityTypeLimited.md +115 -0
  12. package/docs/api/enums/BadgesTimeLimitStates.md +49 -0
  13. package/docs/api/enums/InboxMessageType.md +55 -0
  14. package/docs/api/enums/InboxReadStatus.md +13 -0
  15. package/docs/api/enums/OpenLinksType.md +13 -0
  16. package/docs/api/enums/ScheduledMissionType.md +19 -0
  17. package/docs/api/enums/StoreItemPurchaseType.md +19 -0
  18. package/docs/api/enums/StoreItemType.md +37 -0
  19. package/docs/api/enums/StoreItemTypeName.md +43 -0
  20. package/docs/api/enums/TournamentInstanceStatus.md +43 -0
  21. package/docs/api/enums/TournamentRegistrationError.md +55 -0
  22. package/docs/api/enums/TournamentType.md +19 -0
  23. package/docs/api/interfaces/AchievementTaskPublicMeta.md +35 -0
  24. package/docs/api/interfaces/AffectsProgress.md +25 -0
  25. package/docs/api/interfaces/Bonus.md +2 -2
  26. package/docs/api/interfaces/BonusMetaMap-1.md +9 -0
  27. package/docs/api/interfaces/BonusMetaMap.md +0 -2
  28. package/docs/api/interfaces/BonusTemplateMetaMap-1.md +33 -0
  29. package/docs/api/interfaces/BonusTemplateMetaMap.md +0 -8
  30. package/docs/api/interfaces/GetCustomSectionsResponse.md +67 -0
  31. package/docs/api/interfaces/GetRelatedAchTourResponse.md +69 -0
  32. package/docs/api/interfaces/InboxMessageBody.md +2 -2
  33. package/docs/api/interfaces/StoreItem.md +2 -2
  34. package/docs/api/interfaces/StoreItemPublicMeta.md +127 -0
  35. package/docs/api/interfaces/TBonus.md +2 -2
  36. package/docs/api/interfaces/TMissionOrBadge.md +1 -1
  37. package/docs/api/interfaces/TTournamentRegistrationResult.md +1 -1
  38. package/docs/api/interfaces/Tournament.md +3 -3
  39. package/docs/api/interfaces/TournamentPrize.md +1 -1
  40. package/docs/api/interfaces/TournamentPublicMeta.md +115 -0
  41. package/docs/api/interfaces/UserAchievement.md +4 -4
  42. package/docs/api/interfaces/UserAchievementTask.md +3 -3
  43. package/package.json +1 -1
  44. package/src/Missions/MissionsUtils.ts +6 -3
  45. package/src/SmarticoAPI.ts +1 -1
  46. package/src/WSAPI/WSAPI.ts +29 -23
  47. package/tsconfig.json +23 -1
@@ -0,0 +1,19 @@
1
+ # Enumeration: StoreItemPurchaseType
2
+
3
+ ## Enumeration Members
4
+
5
+ ### Points
6
+
7
+ • **Points** = ``0``
8
+
9
+ ___
10
+
11
+ ### Gems
12
+
13
+ • **Gems** = ``1``
14
+
15
+ ___
16
+
17
+ ### Diamonds
18
+
19
+ • **Diamonds** = ``2``
@@ -0,0 +1,37 @@
1
+ # Enumeration: StoreItemType
2
+
3
+ ## Enumeration Members
4
+
5
+ ### Bonus
6
+
7
+ • **Bonus** = ``1``
8
+
9
+ ___
10
+
11
+ ### Tangible
12
+
13
+ • **Tangible** = ``2``
14
+
15
+ ___
16
+
17
+ ### MiniGameSpin
18
+
19
+ • **MiniGameSpin** = ``3``
20
+
21
+ ___
22
+
23
+ ### ChangeLevel
24
+
25
+ • **ChangeLevel** = ``4``
26
+
27
+ ___
28
+
29
+ ### PrizeDrop
30
+
31
+ • **PrizeDrop** = ``5``
32
+
33
+ ___
34
+
35
+ ### RaffleTicket
36
+
37
+ • **RaffleTicket** = ``6``
@@ -0,0 +1,43 @@
1
+ # Enumeration: StoreItemTypeName
2
+
3
+ ## Enumeration Members
4
+
5
+ ### Bonus
6
+
7
+ • **Bonus** = ``"bonus"``
8
+
9
+ ___
10
+
11
+ ### Tangible
12
+
13
+ • **Tangible** = ``"tangible"``
14
+
15
+ ___
16
+
17
+ ### MiniGameSpin
18
+
19
+ • **MiniGameSpin** = ``"minigamespin"``
20
+
21
+ ___
22
+
23
+ ### ChangeLevel
24
+
25
+ • **ChangeLevel** = ``"changelevel"``
26
+
27
+ ___
28
+
29
+ ### PrizeDrop
30
+
31
+ • **PrizeDrop** = ``"prizedrop"``
32
+
33
+ ___
34
+
35
+ ### RaffleTicket
36
+
37
+ • **RaffleTicket** = ``"raffleticket"``
38
+
39
+ ___
40
+
41
+ ### Unknown
42
+
43
+ • **Unknown** = ``"unknown"``
@@ -0,0 +1,43 @@
1
+ # Enumeration: TournamentInstanceStatus
2
+
3
+ ## Enumeration Members
4
+
5
+ ### PUBLISHED
6
+
7
+ • **PUBLISHED** = ``1``
8
+
9
+ ___
10
+
11
+ ### REGISTER
12
+
13
+ • **REGISTER** = ``2``
14
+
15
+ ___
16
+
17
+ ### STARTED
18
+
19
+ • **STARTED** = ``3``
20
+
21
+ ___
22
+
23
+ ### FINISHED
24
+
25
+ • **FINISHED** = ``4``
26
+
27
+ ___
28
+
29
+ ### CANCELLED
30
+
31
+ • **CANCELLED** = ``5``
32
+
33
+ ___
34
+
35
+ ### FAILED
36
+
37
+ • **FAILED** = ``6``
38
+
39
+ ___
40
+
41
+ ### FINALIZING
42
+
43
+ • **FINALIZING** = ``7``
@@ -0,0 +1,55 @@
1
+ # Enumeration: TournamentRegistrationError
2
+
3
+ ## Enumeration Members
4
+
5
+ ### NO\_ERROR
6
+
7
+ • **NO\_ERROR** = ``0``
8
+
9
+ ___
10
+
11
+ ### TOURNAMENT\_INSTANCE\_NOT\_FOUND
12
+
13
+ • **TOURNAMENT\_INSTANCE\_NOT\_FOUND** = ``30001``
14
+
15
+ ___
16
+
17
+ ### TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS
18
+
19
+ • **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS** = ``30002``
20
+
21
+ ___
22
+
23
+ ### TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE
24
+
25
+ • **TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE** = ``30003``
26
+
27
+ ___
28
+
29
+ ### TOURNAMENT\_ALREADY\_REGISTERED
30
+
31
+ • **TOURNAMENT\_ALREADY\_REGISTERED** = ``30004``
32
+
33
+ ___
34
+
35
+ ### TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS
36
+
37
+ • **TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS** = ``30005``
38
+
39
+ ___
40
+
41
+ ### TOURNAMENT\_USER\_NOT\_REGISTERED
42
+
43
+ • **TOURNAMENT\_USER\_NOT\_REGISTERED** = ``30006``
44
+
45
+ ___
46
+
47
+ ### TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS
48
+
49
+ • **TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS** = ``30007``
50
+
51
+ ___
52
+
53
+ ### TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED
54
+
55
+ • **TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED** = ``30008``
@@ -0,0 +1,19 @@
1
+ # Enumeration: TournamentType
2
+
3
+ ## Enumeration Members
4
+
5
+ ### SCHEDULED
6
+
7
+ • **SCHEDULED** = ``1``
8
+
9
+ ___
10
+
11
+ ### SNG
12
+
13
+ • **SNG** = ``2``
14
+
15
+ ___
16
+
17
+ ### TEST
18
+
19
+ • **TEST** = ``3``
@@ -0,0 +1,35 @@
1
+ # Interface: AchievementTaskPublicMeta
2
+
3
+ ## Properties
4
+
5
+ ### name
6
+
7
+ • `Optional` **name**: `string`
8
+
9
+ ___
10
+
11
+ ### display\_progress\_as\_count
12
+
13
+ • `Optional` **display\_progress\_as\_count**: `boolean`
14
+
15
+ ___
16
+
17
+ ### stage\_image
18
+
19
+ • `Optional` **stage\_image**: `string`
20
+
21
+ ___
22
+
23
+ ### priority
24
+
25
+ • `Optional` **priority**: `number`
26
+
27
+ ___
28
+
29
+ ### user\_state\_operations
30
+
31
+ • `Optional` **user\_state\_operations**: `Object`
32
+
33
+ #### Index signature
34
+
35
+ ▪ [key: `string`]: \{ `op`: `string` }
@@ -0,0 +1,25 @@
1
+ # Interface: AffectsProgress
2
+
3
+ ## Properties
4
+
5
+ ### affects\_level
6
+
7
+ • **affects\_level**: `boolean`
8
+
9
+ ___
10
+
11
+ ### affects\_leaderboard
12
+
13
+ • **affects\_leaderboard**: `boolean`
14
+
15
+ ___
16
+
17
+ ### affects\_current\_balance
18
+
19
+ • **affects\_current\_balance**: `boolean`
20
+
21
+ ___
22
+
23
+ ### rewardPoints
24
+
25
+ • **rewardPoints**: `number`
@@ -70,10 +70,10 @@ ___
70
70
 
71
71
  ### labelBonusTemplateMetaMap
72
72
 
73
- • `Optional` **labelBonusTemplateMetaMap**: `BonusTemplateMetaMap`
73
+ • `Optional` **labelBonusTemplateMetaMap**: [`BonusTemplateMetaMap`](BonusTemplateMetaMap.md)
74
74
 
75
75
  ___
76
76
 
77
77
  ### bonusMetaMap
78
78
 
79
- • `Optional` **bonusMetaMap**: `BonusMetaMap`
79
+ • `Optional` **bonusMetaMap**: [`BonusMetaMap`](BonusMetaMap.md)
@@ -0,0 +1,9 @@
1
+ # Interface: BonusMetaMap
2
+
3
+ ## Properties
4
+
5
+ ### uiAmount
6
+
7
+ • `Optional` **uiAmount**: `string`
8
+
9
+ Label and description of the bonus sent to the player
@@ -5,5 +5,3 @@
5
5
  ### uiAmount
6
6
 
7
7
  • `Optional` **uiAmount**: `string`
8
-
9
- Label and description of the bonus sent to the player
@@ -0,0 +1,33 @@
1
+ # Interface: BonusTemplateMetaMap
2
+
3
+ ## Properties
4
+
5
+ ### description
6
+
7
+ • **description**: `string`
8
+
9
+ Description of the bonus template
10
+
11
+ ___
12
+
13
+ ### acknowledge
14
+
15
+ • **acknowledge**: `string`
16
+
17
+ Acknowledge message setup in the bonus template
18
+
19
+ ___
20
+
21
+ ### image\_url
22
+
23
+ • **image\_url**: `string`
24
+
25
+ Image URL of the bonus template, 1:1 aspect ratio
26
+
27
+ ___
28
+
29
+ ### redirect\_url
30
+
31
+ • `Optional` **redirect\_url**: `string`
32
+
33
+ Redirect URL of the bonus template
@@ -6,28 +6,20 @@
6
6
 
7
7
  • **description**: `string`
8
8
 
9
- Description of the bonus template
10
-
11
9
  ___
12
10
 
13
11
  ### acknowledge
14
12
 
15
13
  • **acknowledge**: `string`
16
14
 
17
- Acknowledge message setup in the bonus template
18
-
19
15
  ___
20
16
 
21
17
  ### image\_url
22
18
 
23
19
  • **image\_url**: `string`
24
20
 
25
- Image URL of the bonus template, 1:1 aspect ratio
26
-
27
21
  ___
28
22
 
29
23
  ### redirect\_url
30
24
 
31
25
  • `Optional` **redirect\_url**: `string`
32
-
33
- Redirect URL of the bonus template
@@ -0,0 +1,67 @@
1
+ # Interface: GetCustomSectionsResponse
2
+
3
+ ## Hierarchy
4
+
5
+ - `ProtocolResponse`
6
+
7
+ ↳ **`GetCustomSectionsResponse`**
8
+
9
+ ## Properties
10
+
11
+ ### cid
12
+
13
+ • **cid**: `number`
14
+
15
+ #### Inherited from
16
+
17
+ ProtocolResponse.cid
18
+
19
+ ___
20
+
21
+ ### ts
22
+
23
+ • `Optional` **ts**: `number`
24
+
25
+ #### Inherited from
26
+
27
+ ProtocolResponse.ts
28
+
29
+ ___
30
+
31
+ ### uuid
32
+
33
+ • `Optional` **uuid**: `string`
34
+
35
+ #### Inherited from
36
+
37
+ ProtocolResponse.uuid
38
+
39
+ ___
40
+
41
+ ### errCode
42
+
43
+ • `Optional` **errCode**: `number`
44
+
45
+ #### Inherited from
46
+
47
+ ProtocolResponse.errCode
48
+
49
+ ___
50
+
51
+ ### errMsg
52
+
53
+ • `Optional` **errMsg**: `string`
54
+
55
+ #### Inherited from
56
+
57
+ ProtocolResponse.errMsg
58
+
59
+ ___
60
+
61
+ ### customSections
62
+
63
+ • **customSections**: `Object`
64
+
65
+ #### Index signature
66
+
67
+ ▪ [key: `string`]: [`UICustomSection`](UICustomSection.md)
@@ -0,0 +1,69 @@
1
+ # Interface: GetRelatedAchTourResponse
2
+
3
+ ## Hierarchy
4
+
5
+ - `ProtocolResponse`
6
+
7
+ ↳ **`GetRelatedAchTourResponse`**
8
+
9
+ ## Properties
10
+
11
+ ### cid
12
+
13
+ • **cid**: `number`
14
+
15
+ #### Inherited from
16
+
17
+ ProtocolResponse.cid
18
+
19
+ ___
20
+
21
+ ### ts
22
+
23
+ • `Optional` **ts**: `number`
24
+
25
+ #### Inherited from
26
+
27
+ ProtocolResponse.ts
28
+
29
+ ___
30
+
31
+ ### uuid
32
+
33
+ • `Optional` **uuid**: `string`
34
+
35
+ #### Inherited from
36
+
37
+ ProtocolResponse.uuid
38
+
39
+ ___
40
+
41
+ ### errCode
42
+
43
+ • `Optional` **errCode**: `number`
44
+
45
+ #### Inherited from
46
+
47
+ ProtocolResponse.errCode
48
+
49
+ ___
50
+
51
+ ### errMsg
52
+
53
+ • `Optional` **errMsg**: `string`
54
+
55
+ #### Inherited from
56
+
57
+ ProtocolResponse.errMsg
58
+
59
+ ___
60
+
61
+ ### achievements
62
+
63
+ • **achievements**: [`UserAchievement`](UserAchievement.md)[]
64
+
65
+ ___
66
+
67
+ ### tournaments
68
+
69
+ • `Optional` **tournaments**: [`Tournament`](Tournament.md)[]
@@ -16,7 +16,7 @@ ___
16
16
 
17
17
  ### type
18
18
 
19
- • **type**: `InboxMessageType`
19
+ • **type**: [`InboxMessageType`](../enums/InboxMessageType.md)
20
20
 
21
21
  ___
22
22
 
@@ -64,7 +64,7 @@ ___
64
64
 
65
65
  ### open\_links
66
66
 
67
- • `Optional` **open\_links**: `OpenLinksType`
67
+ • `Optional` **open\_links**: [`OpenLinksType`](../enums/OpenLinksType.md)
68
68
 
69
69
  ___
70
70
 
@@ -10,13 +10,13 @@ ___
10
10
 
11
11
  ### itemTypeId
12
12
 
13
- • **itemTypeId**: `StoreItemType`
13
+ • **itemTypeId**: [`StoreItemType`](../enums/StoreItemType.md)
14
14
 
15
15
  ___
16
16
 
17
17
  ### itemPublicMeta
18
18
 
19
- • **itemPublicMeta**: `StoreItemPublicMeta`
19
+ • **itemPublicMeta**: [`StoreItemPublicMeta`](StoreItemPublicMeta.md)
20
20
 
21
21
  ___
22
22
 
@@ -0,0 +1,127 @@
1
+ # Interface: StoreItemPublicMeta
2
+
3
+ ## Properties
4
+
5
+ ### price
6
+
7
+ • **price**: `string`
8
+
9
+ ___
10
+
11
+ ### image\_url
12
+
13
+ • **image\_url**: `string`
14
+
15
+ ___
16
+
17
+ ### purchase\_type
18
+
19
+ • **purchase\_type**: [`StoreItemPurchaseType`](../enums/StoreItemPurchaseType.md)
20
+
21
+ ___
22
+
23
+ ### name
24
+
25
+ • **name**: `string`
26
+
27
+ ___
28
+
29
+ ### description
30
+
31
+ • **description**: `string`
32
+
33
+ ___
34
+
35
+ ### label\_tag
36
+
37
+ • **label\_tag**: `string`
38
+
39
+ ___
40
+
41
+ ### custom\_label\_tag
42
+
43
+ • `Optional` **custom\_label\_tag**: `string`
44
+
45
+ ___
46
+
47
+ ### limit\_message
48
+
49
+ • **limit\_message**: `string`
50
+
51
+ ___
52
+
53
+ ### priority
54
+
55
+ • **priority**: `number`
56
+
57
+ ___
58
+
59
+ ### related\_items
60
+
61
+ • **related\_items**: `number`[]
62
+
63
+ ___
64
+
65
+ ### hint\_text
66
+
67
+ • **hint\_text**: `string`
68
+
69
+ ___
70
+
71
+ ### custom\_data
72
+
73
+ • **custom\_data**: `string`
74
+
75
+ ___
76
+
77
+ ### show\_timer
78
+
79
+ • `Optional` **show\_timer**: `boolean`
80
+
81
+ ___
82
+
83
+ ### cant\_buy\_message
84
+
85
+ • `Optional` **cant\_buy\_message**: `string`
86
+
87
+ ___
88
+
89
+ ### discount\_prize
90
+
91
+ • `Optional` **discount\_prize**: `number`
92
+
93
+ ___
94
+
95
+ ### discount\_prize\_ribbon
96
+
97
+ • `Optional` **discount\_prize\_ribbon**: `string`
98
+
99
+ ___
100
+
101
+ ### custom\_ribbon\_image
102
+
103
+ • `Optional` **custom\_ribbon\_image**: `string`
104
+
105
+ ___
106
+
107
+ ### purchase\_limit\_message
108
+
109
+ • `Optional` **purchase\_limit\_message**: `string`
110
+
111
+ ___
112
+
113
+ ### custom\_section\_id
114
+
115
+ • `Optional` **custom\_section\_id**: `number`
116
+
117
+ ___
118
+
119
+ ### only\_in\_custom\_section
120
+
121
+ • `Optional` **only\_in\_custom\_section**: `boolean`
122
+
123
+ ___
124
+
125
+ ### custom\_section\_type\_id
126
+
127
+ • `Optional` **custom\_section\_type\_id**: `number`
@@ -52,7 +52,7 @@ ___
52
52
 
53
53
  ### label\_bonus\_template\_meta\_map
54
54
 
55
- • `Optional` **label\_bonus\_template\_meta\_map**: [`BonusTemplateMetaMap`](BonusTemplateMetaMap.md)
55
+ • `Optional` **label\_bonus\_template\_meta\_map**: [`BonusTemplateMetaMap`](BonusTemplateMetaMap-1.md)
56
56
 
57
57
  Additional information about the bonus(edscription, image,name, acknowledge)
58
58
 
@@ -60,6 +60,6 @@ ___
60
60
 
61
61
  ### bonus\_meta\_map
62
62
 
63
- • `Optional` **bonus\_meta\_map**: [`BonusMetaMap`](BonusMetaMap.md)
63
+ • `Optional` **bonus\_meta\_map**: [`BonusMetaMap`](BonusMetaMap-1.md)
64
64
 
65
65
  Additional information presented to the player when the bonus is redeemed
@@ -355,7 +355,7 @@ ___
355
355
 
356
356
  ### badgeTimeLimitState
357
357
 
358
- • `Optional` **badgeTimeLimitState**: `BadgesTimeLimitStates`
358
+ • `Optional` **badgeTimeLimitState**: [`BadgesTimeLimitStates`](../enums/BadgesTimeLimitStates.md)
359
359
 
360
360
  Badge time limit state for badges with time restrictions
361
361
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ### err\_code
6
6
 
7
- • **err\_code**: `TournamentRegistrationError`
7
+ • **err\_code**: [`TournamentRegistrationError`](../enums/TournamentRegistrationError.md)
8
8
 
9
9
  Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0
10
10