@smartico/public-api 0.0.356 → 0.0.358

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/README.md +33 -8
  2. package/dist/WSAPI/WSAPI.d.ts +50 -45
  3. package/dist/index.js +49 -44
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.modern.mjs +49 -44
  6. package/dist/index.modern.mjs.map +1 -1
  7. package/docs/api/README.md +58 -3
  8. package/docs/api/classes/WSAPI.md +43 -41
  9. package/docs/api/enums/AchievementStatus.md +49 -0
  10. package/docs/api/enums/AchievementTaskType.md +13 -0
  11. package/docs/api/enums/AchievementType.md +13 -0
  12. package/docs/api/enums/ActivityTypeLimited.md +115 -0
  13. package/docs/api/enums/BadgesTimeLimitStates.md +49 -0
  14. package/docs/api/enums/InboxMessageType.md +55 -0
  15. package/docs/api/enums/InboxReadStatus.md +13 -0
  16. package/docs/api/enums/OpenLinksType.md +13 -0
  17. package/docs/api/enums/ScheduledMissionType.md +19 -0
  18. package/docs/api/enums/StoreItemPurchaseType.md +19 -0
  19. package/docs/api/enums/StoreItemType.md +37 -0
  20. package/docs/api/enums/StoreItemTypeName.md +43 -0
  21. package/docs/api/enums/TournamentInstanceStatus.md +43 -0
  22. package/docs/api/enums/TournamentRegistrationError.md +55 -0
  23. package/docs/api/enums/TournamentType.md +19 -0
  24. package/docs/api/interfaces/AchievementTaskPublicMeta.md +35 -0
  25. package/docs/api/interfaces/AffectsProgress.md +25 -0
  26. package/docs/api/interfaces/Bonus.md +2 -2
  27. package/docs/api/interfaces/BonusMetaMap-1.md +9 -0
  28. package/docs/api/interfaces/BonusMetaMap.md +0 -2
  29. package/docs/api/interfaces/BonusTemplateMetaMap-1.md +33 -0
  30. package/docs/api/interfaces/BonusTemplateMetaMap.md +0 -8
  31. package/docs/api/interfaces/GetCustomSectionsResponse.md +67 -0
  32. package/docs/api/interfaces/GetRelatedAchTourResponse.md +69 -0
  33. package/docs/api/interfaces/InboxMessageBody.md +2 -2
  34. package/docs/api/interfaces/StoreItem.md +2 -2
  35. package/docs/api/interfaces/StoreItemPublicMeta.md +127 -0
  36. package/docs/api/interfaces/TBonus.md +2 -2
  37. package/docs/api/interfaces/TMissionOrBadge.md +1 -1
  38. package/docs/api/interfaces/TTournamentRegistrationResult.md +1 -1
  39. package/docs/api/interfaces/Tournament.md +3 -3
  40. package/docs/api/interfaces/TournamentPrize.md +1 -1
  41. package/docs/api/interfaces/TournamentPublicMeta.md +115 -0
  42. package/docs/api/interfaces/UserAchievement.md +4 -4
  43. package/docs/api/interfaces/UserAchievementTask.md +3 -3
  44. package/package.json +1 -1
  45. package/src/SmarticoAPI.ts +1 -1
  46. package/src/WSAPI/WSAPI.ts +55 -49
  47. package/tsconfig.json +23 -1
@@ -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
 
@@ -20,7 +20,7 @@ ___
20
20
 
21
21
  ### tournamentType
22
22
 
23
- • `Optional` **tournamentType**: `TournamentType`
23
+ • `Optional` **tournamentType**: [`TournamentType`](../enums/TournamentType.md)
24
24
 
25
25
  Type of the tournament. For now only SCHEDULED is support
26
26
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  ### publicMeta
30
30
 
31
- • `Optional` **publicMeta**: `TournamentPublicMeta`
31
+ • `Optional` **publicMeta**: [`TournamentPublicMeta`](TournamentPublicMeta.md)
32
32
 
33
33
  Meta information about tournament that should be used to build UI
34
34
 
@@ -116,7 +116,7 @@ ___
116
116
 
117
117
  ### tournamentInstanceStatus
118
118
 
119
- • `Optional` **tournamentInstanceStatus**: `TournamentInstanceStatus`
119
+ • `Optional` **tournamentInstanceStatus**: [`TournamentInstanceStatus`](../enums/TournamentInstanceStatus.md)
120
120
 
121
121
  Status of tournament instance
122
122
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  ### type
36
36
 
37
- • **type**: `ActivityTypeLimited`
37
+ • **type**: [`ActivityTypeLimited`](../enums/ActivityTypeLimited.md)
38
38
 
39
39
  ___
40
40
 
@@ -0,0 +1,115 @@
1
+ # Interface: TournamentPublicMeta
2
+
3
+ ## Properties
4
+
5
+ ### name
6
+
7
+ • `Optional` **name**: `string`
8
+
9
+ Name of tournament
10
+
11
+ ___
12
+
13
+ ### image\_url
14
+
15
+ • `Optional` **image\_url**: `string`
16
+
17
+ 1st image
18
+
19
+ ___
20
+
21
+ ### image\_url2
22
+
23
+ • `Optional` **image\_url2**: `string`
24
+
25
+ 2nd image
26
+
27
+ ___
28
+
29
+ ### image\_url2\_mobile
30
+
31
+ • `Optional` **image\_url2\_mobile**: `string`
32
+
33
+ 2nd image for mobile
34
+
35
+ ___
36
+
37
+ ### description
38
+
39
+ • `Optional` **description**: `string`
40
+
41
+ Description, html capable
42
+
43
+ ___
44
+
45
+ ### prize\_pool\_short
46
+
47
+ • `Optional` **prize\_pool\_short**: `string`
48
+
49
+ Short explanation of prize pool
50
+
51
+ ___
52
+
53
+ ### segment\_dont\_match\_message
54
+
55
+ • `Optional` **segment\_dont\_match\_message**: `string`
56
+
57
+ Message to show when user is not matching to the segment allowed to register (error code 30005 in registration response)
58
+
59
+ ___
60
+
61
+ ### custom\_price\_text
62
+
63
+ • `Optional` **custom\_price\_text**: `string`
64
+
65
+ Short explanation of registration price
66
+
67
+ ___
68
+
69
+ ### show\_other\_users\_score
70
+
71
+ • `Optional` **show\_other\_users\_score**: `boolean`
72
+
73
+ Indicator if the scores of other users should be shown in the leaderboard of tournament
74
+
75
+ ___
76
+
77
+ ### custom\_section\_id
78
+
79
+ • `Optional` **custom\_section\_id**: `number`
80
+
81
+ ___
82
+
83
+ ### only\_in\_custom\_section
84
+
85
+ • `Optional` **only\_in\_custom\_section**: `boolean`
86
+
87
+ ___
88
+
89
+ ### label\_tag
90
+
91
+ • `Optional` **label\_tag**: `string`
92
+
93
+ ___
94
+
95
+ ### custom\_label\_tag
96
+
97
+ • `Optional` **custom\_label\_tag**: `string`
98
+
99
+ ___
100
+
101
+ ### featured
102
+
103
+ • `Optional` **featured**: `boolean`
104
+
105
+ ___
106
+
107
+ ### position
108
+
109
+ • `Optional` **position**: `number`
110
+
111
+ ___
112
+
113
+ ### custom\_data
114
+
115
+ • `Optional` **custom\_data**: `string`
@@ -10,7 +10,7 @@ ___
10
10
 
11
11
  ### ach\_type\_id
12
12
 
13
- • `Optional` **ach\_type\_id**: `AchievementType`
13
+ • `Optional` **ach\_type\_id**: [`AchievementType`](../enums/AchievementType.md)
14
14
 
15
15
  ___
16
16
 
@@ -112,13 +112,13 @@ ___
112
112
 
113
113
  ### ach\_status\_id
114
114
 
115
- • `Optional` **ach\_status\_id**: `AchievementStatus`
115
+ • `Optional` **ach\_status\_id**: [`AchievementStatus`](../enums/AchievementStatus.md)
116
116
 
117
117
  ___
118
118
 
119
119
  ### scheduledMissionType
120
120
 
121
- • `Optional` **scheduledMissionType**: `ScheduledMissionType`
121
+ • `Optional` **scheduledMissionType**: [`ScheduledMissionType`](../enums/ScheduledMissionType.md)
122
122
 
123
123
  ___
124
124
 
@@ -202,4 +202,4 @@ ___
202
202
 
203
203
  ### badgeTimeLimitState
204
204
 
205
- • `Optional` **badgeTimeLimitState**: `BadgesTimeLimitStates`
205
+ • `Optional` **badgeTimeLimitState**: [`BadgesTimeLimitStates`](../enums/BadgesTimeLimitStates.md)
@@ -10,7 +10,7 @@ ___
10
10
 
11
11
  ### task\_public\_meta
12
12
 
13
- • `Optional` **task\_public\_meta**: `AchievementTaskPublicMeta`
13
+ • `Optional` **task\_public\_meta**: [`AchievementTaskPublicMeta`](AchievementTaskPublicMeta.md)
14
14
 
15
15
  ___
16
16
 
@@ -22,7 +22,7 @@ ___
22
22
 
23
23
  ### task\_type\_id
24
24
 
25
- • **task\_type\_id**: `AchievementTaskType`
25
+ • **task\_type\_id**: [`AchievementTaskType`](../enums/AchievementTaskType.md)
26
26
 
27
27
  ___
28
28
 
@@ -80,4 +80,4 @@ ___
80
80
 
81
81
  ### affects\_progress
82
82
 
83
- • `Optional` **affects\_progress**: `AffectsProgress`
83
+ • `Optional` **affects\_progress**: [`AffectsProgress`](AffectsProgress.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smartico/public-api",
3
- "version": "0.0.356",
3
+ "version": "0.0.358",
4
4
  "description": "Smartico public API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -585,7 +585,7 @@ class SmarticoAPI {
585
585
  { jp_template_id },
586
586
  );
587
587
 
588
- return await this.send<GetJackpotEligibleGamesResponse>(message, ClassId.JP_GET_ELIGIBLE_GAMES_RESPONSE);;
588
+ return await this.send<GetJackpotEligibleGamesResponse>(message, ClassId.JP_GET_ELIGIBLE_GAMES_RESPONSE);
589
589
  }
590
590
 
591
591
  public async getJackpotEligibleGamesT(user_ext_id: string, { jp_template_id }: { jp_template_id: number }): Promise<TGetJackpotEligibleGamesResponse> {