@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.
- package/README.md +33 -8
- package/dist/WSAPI/WSAPI.d.ts +50 -45
- package/dist/index.js +49 -44
- package/dist/index.js.map +1 -1
- package/dist/index.modern.mjs +49 -44
- package/dist/index.modern.mjs.map +1 -1
- package/docs/api/README.md +58 -3
- package/docs/api/classes/WSAPI.md +43 -41
- package/docs/api/enums/AchievementStatus.md +49 -0
- package/docs/api/enums/AchievementTaskType.md +13 -0
- package/docs/api/enums/AchievementType.md +13 -0
- package/docs/api/enums/ActivityTypeLimited.md +115 -0
- package/docs/api/enums/BadgesTimeLimitStates.md +49 -0
- package/docs/api/enums/InboxMessageType.md +55 -0
- package/docs/api/enums/InboxReadStatus.md +13 -0
- package/docs/api/enums/OpenLinksType.md +13 -0
- package/docs/api/enums/ScheduledMissionType.md +19 -0
- package/docs/api/enums/StoreItemPurchaseType.md +19 -0
- package/docs/api/enums/StoreItemType.md +37 -0
- package/docs/api/enums/StoreItemTypeName.md +43 -0
- package/docs/api/enums/TournamentInstanceStatus.md +43 -0
- package/docs/api/enums/TournamentRegistrationError.md +55 -0
- package/docs/api/enums/TournamentType.md +19 -0
- package/docs/api/interfaces/AchievementTaskPublicMeta.md +35 -0
- package/docs/api/interfaces/AffectsProgress.md +25 -0
- package/docs/api/interfaces/Bonus.md +2 -2
- package/docs/api/interfaces/BonusMetaMap-1.md +9 -0
- package/docs/api/interfaces/BonusMetaMap.md +0 -2
- package/docs/api/interfaces/BonusTemplateMetaMap-1.md +33 -0
- package/docs/api/interfaces/BonusTemplateMetaMap.md +0 -8
- package/docs/api/interfaces/GetCustomSectionsResponse.md +67 -0
- package/docs/api/interfaces/GetRelatedAchTourResponse.md +69 -0
- package/docs/api/interfaces/InboxMessageBody.md +2 -2
- package/docs/api/interfaces/StoreItem.md +2 -2
- package/docs/api/interfaces/StoreItemPublicMeta.md +127 -0
- package/docs/api/interfaces/TBonus.md +2 -2
- package/docs/api/interfaces/TMissionOrBadge.md +1 -1
- package/docs/api/interfaces/TTournamentRegistrationResult.md +1 -1
- package/docs/api/interfaces/Tournament.md +3 -3
- package/docs/api/interfaces/TournamentPrize.md +1 -1
- package/docs/api/interfaces/TournamentPublicMeta.md +115 -0
- package/docs/api/interfaces/UserAchievement.md +4 -4
- package/docs/api/interfaces/UserAchievementTask.md +3 -3
- package/package.json +1 -1
- package/src/SmarticoAPI.ts +1 -1
- package/src/WSAPI/WSAPI.ts +55 -49
- package/tsconfig.json +23 -1
package/docs/api/README.md
CHANGED
|
@@ -5,12 +5,16 @@
|
|
|
5
5
|
- [PointChangeSourceType](enums/PointChangeSourceType.md)
|
|
6
6
|
- [UserBalanceType](enums/UserBalanceType.md)
|
|
7
7
|
- [BonusStatus](enums/BonusStatus.md)
|
|
8
|
+
- [ActivityTypeLimited](enums/ActivityTypeLimited.md)
|
|
8
9
|
- [AchCustomSectionType](enums/AchCustomSectionType.md)
|
|
9
10
|
- [AchCustomLayoutTheme](enums/AchCustomLayoutTheme.md)
|
|
10
11
|
- [AchMissionsTabsOptions](enums/AchMissionsTabsOptions.md)
|
|
11
12
|
- [AchOverviewMissionsFilter](enums/AchOverviewMissionsFilter.md)
|
|
12
13
|
- [LiquidEntityData](enums/LiquidEntityData.md)
|
|
13
14
|
- [InboxCategories](enums/InboxCategories.md)
|
|
15
|
+
- [InboxMessageType](enums/InboxMessageType.md)
|
|
16
|
+
- [InboxReadStatus](enums/InboxReadStatus.md)
|
|
17
|
+
- [OpenLinksType](enums/OpenLinksType.md)
|
|
14
18
|
- [JackpotContributionType](enums/JackpotContributionType.md)
|
|
15
19
|
- [JackPotTemparature](enums/JackPotTemparature.md)
|
|
16
20
|
- [JackpotType](enums/JackpotType.md)
|
|
@@ -36,15 +40,26 @@
|
|
|
36
40
|
- [SAWWheelLayout](enums/SAWWheelLayout.md)
|
|
37
41
|
- [SAWWinSoundType](enums/SAWWinSoundType.md)
|
|
38
42
|
- [AchievementAvailabilityStatus](enums/AchievementAvailabilityStatus.md)
|
|
43
|
+
- [AchievementStatus](enums/AchievementStatus.md)
|
|
44
|
+
- [AchievementTaskType](enums/AchievementTaskType.md)
|
|
45
|
+
- [AchievementType](enums/AchievementType.md)
|
|
46
|
+
- [BadgesTimeLimitStates](enums/BadgesTimeLimitStates.md)
|
|
47
|
+
- [ScheduledMissionType](enums/ScheduledMissionType.md)
|
|
39
48
|
- [QuizAnswersValueType](enums/QuizAnswersValueType.md)
|
|
40
49
|
- [SAWGPMarketType](enums/SAWGPMarketType.md)
|
|
41
50
|
- [RaffleTicketCapVisualization](enums/RaffleTicketCapVisualization.md)
|
|
42
51
|
- [RaffleDrawInstanceState](enums/RaffleDrawInstanceState.md)
|
|
43
52
|
- [RaffleDrawTypeExecution](enums/RaffleDrawTypeExecution.md)
|
|
44
53
|
- [BuyStoreItemErrorCode](enums/BuyStoreItemErrorCode.md)
|
|
54
|
+
- [StoreItemPurchaseType](enums/StoreItemPurchaseType.md)
|
|
55
|
+
- [StoreItemType](enums/StoreItemType.md)
|
|
56
|
+
- [StoreItemTypeName](enums/StoreItemTypeName.md)
|
|
57
|
+
- [TournamentInstanceStatus](enums/TournamentInstanceStatus.md)
|
|
58
|
+
- [TournamentRegistrationError](enums/TournamentRegistrationError.md)
|
|
45
59
|
- [TournamentRegistrationStatus](enums/TournamentRegistrationStatus.md)
|
|
46
60
|
- [TournamentRegistrationStatusName](enums/TournamentRegistrationStatusName.md)
|
|
47
61
|
- [TournamentRegistrationType](enums/TournamentRegistrationType.md)
|
|
62
|
+
- [TournamentType](enums/TournamentType.md)
|
|
48
63
|
- [BonusStatus](enums/BonusStatus-1.md)
|
|
49
64
|
- [GamePickMarketType](enums/GamePickMarketType.md)
|
|
50
65
|
- [GamePickResolutionType](enums/GamePickResolutionType.md)
|
|
@@ -61,6 +76,9 @@
|
|
|
61
76
|
|
|
62
77
|
- [AchRelatedGame](interfaces/AchRelatedGame.md)
|
|
63
78
|
- [Bonus](interfaces/Bonus.md)
|
|
79
|
+
- [BonusMetaMap](interfaces/BonusMetaMap.md)
|
|
80
|
+
- [BonusTemplateMetaMap](interfaces/BonusTemplateMetaMap.md)
|
|
81
|
+
- [GetCustomSectionsResponse](interfaces/GetCustomSectionsResponse.md)
|
|
64
82
|
- [UICustomSection](interfaces/UICustomSection.md)
|
|
65
83
|
- [InboxMessageBody](interfaces/InboxMessageBody.md)
|
|
66
84
|
- [InboxMessage](interfaces/InboxMessage.md)
|
|
@@ -109,8 +127,11 @@
|
|
|
109
127
|
- [AchCategoryPublicMeta](interfaces/AchCategoryPublicMeta.md)
|
|
110
128
|
- [AchCategory](interfaces/AchCategory.md)
|
|
111
129
|
- [AchievementPublicMeta](interfaces/AchievementPublicMeta.md)
|
|
130
|
+
- [AchievementTaskPublicMeta](interfaces/AchievementTaskPublicMeta.md)
|
|
131
|
+
- [GetRelatedAchTourResponse](interfaces/GetRelatedAchTourResponse.md)
|
|
112
132
|
- [UserAchievement](interfaces/UserAchievement.md)
|
|
113
133
|
- [UserAchievementTask](interfaces/UserAchievementTask.md)
|
|
134
|
+
- [AffectsProgress](interfaces/AffectsProgress.md)
|
|
114
135
|
- [GetDrawRunRequest](interfaces/GetDrawRunRequest.md)
|
|
115
136
|
- [GetDrawRunResponse](interfaces/GetDrawRunResponse.md)
|
|
116
137
|
- [GetRaffleDrawRunsHistoryRequest](interfaces/GetRaffleDrawRunsHistoryRequest.md)
|
|
@@ -133,10 +154,12 @@
|
|
|
133
154
|
- [StoreCategory](interfaces/StoreCategory.md)
|
|
134
155
|
- [StoreCategoryPublicMeta](interfaces/StoreCategoryPublicMeta.md)
|
|
135
156
|
- [StoreItem](interfaces/StoreItem.md)
|
|
157
|
+
- [StoreItemPublicMeta](interfaces/StoreItemPublicMeta.md)
|
|
136
158
|
- [GetTournamentInfoResponse](interfaces/GetTournamentInfoResponse.md)
|
|
137
159
|
- [Tournament](interfaces/Tournament.md)
|
|
138
160
|
- [TournamentPlayer](interfaces/TournamentPlayer.md)
|
|
139
161
|
- [TournamentPrize](interfaces/TournamentPrize.md)
|
|
162
|
+
- [TournamentPublicMeta](interfaces/TournamentPublicMeta.md)
|
|
140
163
|
- [TMiniGamePrize](interfaces/TMiniGamePrize.md)
|
|
141
164
|
- [TMiniGamePlayResult](interfaces/TMiniGamePlayResult.md)
|
|
142
165
|
- [TMiniGamePlayBatchResult](interfaces/TMiniGamePlayBatchResult.md)
|
|
@@ -167,8 +190,8 @@
|
|
|
167
190
|
- [TSegmentCheckResult](interfaces/TSegmentCheckResult.md)
|
|
168
191
|
- [TUICustomSection](interfaces/TUICustomSection.md)
|
|
169
192
|
- [TBonus](interfaces/TBonus.md)
|
|
170
|
-
- [BonusTemplateMetaMap](interfaces/BonusTemplateMetaMap.md)
|
|
171
|
-
- [BonusMetaMap](interfaces/BonusMetaMap.md)
|
|
193
|
+
- [BonusTemplateMetaMap](interfaces/BonusTemplateMetaMap-1.md)
|
|
194
|
+
- [BonusMetaMap](interfaces/BonusMetaMap-1.md)
|
|
172
195
|
- [TClaimBonusResult](interfaces/TClaimBonusResult.md)
|
|
173
196
|
- [TSawHistory](interfaces/TSawHistory.md)
|
|
174
197
|
- [TRaffle](interfaces/TRaffle.md)
|
|
@@ -272,7 +295,7 @@ ___
|
|
|
272
295
|
|
|
273
296
|
| Name | Type |
|
|
274
297
|
| :------ | :------ |
|
|
275
|
-
| `response` | `GetCustomSectionsResponse` |
|
|
298
|
+
| `response` | [`GetCustomSectionsResponse`](interfaces/GetCustomSectionsResponse.md) |
|
|
276
299
|
|
|
277
300
|
#### Returns
|
|
278
301
|
|
|
@@ -408,6 +431,22 @@ ___
|
|
|
408
431
|
|
|
409
432
|
___
|
|
410
433
|
|
|
434
|
+
### StoreItemTypeNamed
|
|
435
|
+
|
|
436
|
+
▸ **StoreItemTypeNamed**(`type`): [`StoreItemTypeName`](enums/StoreItemTypeName.md)
|
|
437
|
+
|
|
438
|
+
#### Parameters
|
|
439
|
+
|
|
440
|
+
| Name | Type |
|
|
441
|
+
| :------ | :------ |
|
|
442
|
+
| `type` | [`StoreItemType`](enums/StoreItemType.md) |
|
|
443
|
+
|
|
444
|
+
#### Returns
|
|
445
|
+
|
|
446
|
+
[`StoreItemTypeName`](enums/StoreItemTypeName.md)
|
|
447
|
+
|
|
448
|
+
___
|
|
449
|
+
|
|
411
450
|
### tournamentInfoItemTransform
|
|
412
451
|
|
|
413
452
|
▸ **tournamentInfoItemTransform**(`t`): [`TTournamentDetailed`](interfaces/TTournamentDetailed.md)
|
|
@@ -437,3 +476,19 @@ ___
|
|
|
437
476
|
#### Returns
|
|
438
477
|
|
|
439
478
|
[`TTournament`](interfaces/TTournament.md)[]
|
|
479
|
+
|
|
480
|
+
___
|
|
481
|
+
|
|
482
|
+
### TournamentInstanceStatusName
|
|
483
|
+
|
|
484
|
+
▸ **TournamentInstanceStatusName**(`s`): `string`
|
|
485
|
+
|
|
486
|
+
#### Parameters
|
|
487
|
+
|
|
488
|
+
| Name | Type |
|
|
489
|
+
| :------ | :------ |
|
|
490
|
+
| `s` | [`TournamentInstanceStatus`](enums/TournamentInstanceStatus.md) |
|
|
491
|
+
|
|
492
|
+
#### Returns
|
|
493
|
+
|
|
494
|
+
`string`
|
|
@@ -10,7 +10,7 @@ Returns information about current user
|
|
|
10
10
|
Pay attention that this method is synchronous and returns the user profile object immediately, not a promise.
|
|
11
11
|
**Example**:
|
|
12
12
|
```
|
|
13
|
-
var p = _smartico.api.getUserProfile);
|
|
13
|
+
var p = _smartico.api.getUserProfile();
|
|
14
14
|
console.log(p);
|
|
15
15
|
```
|
|
16
16
|
**Visitor mode: not supported**
|
|
@@ -76,7 +76,7 @@ ___
|
|
|
76
76
|
|
|
77
77
|
▸ **getLevels**(): `Promise`\<[`TLevel`](../interfaces/TLevel.md)[]\>
|
|
78
78
|
|
|
79
|
-
Returns all the levels available the current user
|
|
79
|
+
Returns all the levels available to the current user
|
|
80
80
|
**Example**:
|
|
81
81
|
```
|
|
82
82
|
_smartico.api.getLevels().then((result) => {
|
|
@@ -158,7 +158,7 @@ ___
|
|
|
158
158
|
|
|
159
159
|
▸ **getBadges**(): `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
|
|
160
160
|
|
|
161
|
-
Returns all the badges available the current user
|
|
161
|
+
Returns all the badges available to the current user
|
|
162
162
|
|
|
163
163
|
**Visitor mode: not supported**
|
|
164
164
|
|
|
@@ -173,7 +173,7 @@ ___
|
|
|
173
173
|
▸ **getBonuses**(`«destructured»?`): `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
|
|
174
174
|
|
|
175
175
|
Returns all the bonuses for the current user
|
|
176
|
-
The returned
|
|
176
|
+
The returned bonuses are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
|
|
177
177
|
Note that each time you call getBonuses with a new onUpdate callback, the old one will be overwritten by the new one.
|
|
178
178
|
The onUpdate callback will be called on bonus claimed and the updated bonuses will be passed to it.
|
|
179
179
|
|
|
@@ -220,7 +220,7 @@ ___
|
|
|
220
220
|
▸ **getUserLevelExtraCounters**(): `Promise`\<[`UserLevelExtraCountersT`](../interfaces/UserLevelExtraCountersT.md)\>
|
|
221
221
|
|
|
222
222
|
Returns the extra counters for the current user level.
|
|
223
|
-
These are counters that are configured for each Smartico client
|
|
223
|
+
These are counters that are configured for each Smartico client separately by request.
|
|
224
224
|
For example 1st counter could be total wagering amount, 2nd counter could be total deposit amount, etc.
|
|
225
225
|
|
|
226
226
|
**Example**:
|
|
@@ -242,7 +242,7 @@ ___
|
|
|
242
242
|
|
|
243
243
|
▸ **getStoreItems**(`params?`): `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
|
|
244
244
|
|
|
245
|
-
Returns all the store items available the current user
|
|
245
|
+
Returns all the store items available to the current user
|
|
246
246
|
The returned store items are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
|
|
247
247
|
Note that each time you call getStoreItems with a new onUpdate callback, the old one will be overwritten by the new one.
|
|
248
248
|
The onUpdate callback will be called on purchase of the store item.
|
|
@@ -419,7 +419,7 @@ ___
|
|
|
419
419
|
|
|
420
420
|
Returns the list of mini-games configured for the current user (not filtered by spin availability or Widget visibility).
|
|
421
421
|
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.
|
|
422
|
-
The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or
|
|
422
|
+
The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
|
|
423
423
|
|
|
424
424
|
**Example**:
|
|
425
425
|
```
|
|
@@ -487,7 +487,7 @@ ___
|
|
|
487
487
|
|
|
488
488
|
Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
|
|
489
489
|
After playMiniGame is called, you can call getMiniGames to get the list of mini-games.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 playMiniGame with a new onUpdate callback, the old one will be overwritten by the new one.
|
|
490
|
-
The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or
|
|
490
|
+
The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
|
|
491
491
|
|
|
492
492
|
**Example**:
|
|
493
493
|
```
|
|
@@ -542,7 +542,7 @@ ___
|
|
|
542
542
|
|
|
543
543
|
Plays the specified by template_id mini-game on behalf of user spin_count times and returns array of the prizes
|
|
544
544
|
After playMiniGameBatch is called, you can call getMiniGames to get the list of mini-games. 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 playMiniGameBatch with a new onUpdate callback, the old one will be overwritten by the new one.
|
|
545
|
-
The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or
|
|
545
|
+
The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
|
|
546
546
|
|
|
547
547
|
**Example**:
|
|
548
548
|
```
|
|
@@ -559,7 +559,7 @@ _smartico.api.playMiniGameBatch(55, 10).then((result) => {
|
|
|
559
559
|
| `template_id` | `number` |
|
|
560
560
|
| `spin_count` | `number` |
|
|
561
561
|
| `«destructured»` | `Object` |
|
|
562
|
-
| › `onUpdate?` | (`data`: [`
|
|
562
|
+
| › `onUpdate?` | (`data`: [`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]) => `void` |
|
|
563
563
|
|
|
564
564
|
#### Returns
|
|
565
565
|
|
|
@@ -647,7 +647,7 @@ ___
|
|
|
647
647
|
|
|
648
648
|
▸ **getTournamentInstanceInfo**(`tournamentInstanceId`): `Promise`\<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
|
|
649
649
|
|
|
650
|
-
Returns
|
|
650
|
+
Returns detailed information for a specific tournament instance; the response includes tournament info and the leaderboard of players
|
|
651
651
|
|
|
652
652
|
**Example**:
|
|
653
653
|
```
|
|
@@ -746,7 +746,7 @@ The maximum number of messages per request is limited to 20.
|
|
|
746
746
|
An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
|
|
747
747
|
An indicator "read_status" can be passed to get only messages marked as read or unread.
|
|
748
748
|
You can leave this params empty and by default it will return list of messages ranging from 0 to 20.
|
|
749
|
-
This
|
|
749
|
+
This function returns a list of messages without the body of each message.
|
|
750
750
|
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.
|
|
751
751
|
All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
|
|
752
752
|
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.
|
|
@@ -762,7 +762,7 @@ The "onUpdate" callback will be triggered when the user receives a new message.
|
|
|
762
762
|
| `params.to?` | `number` |
|
|
763
763
|
| `params.onlyFavorite?` | `boolean` |
|
|
764
764
|
| `params.categoryId?` | [`InboxCategories`](../enums/InboxCategories.md) |
|
|
765
|
-
| `params.read_status?` | `InboxReadStatus` |
|
|
765
|
+
| `params.read_status?` | [`InboxReadStatus`](../enums/InboxReadStatus.md) |
|
|
766
766
|
| `params.onUpdate?` | (`data`: [`TInboxMessage`](../interfaces/TInboxMessage.md)[]) => `void` |
|
|
767
767
|
|
|
768
768
|
#### Returns
|
|
@@ -836,7 +836,7 @@ ___
|
|
|
836
836
|
|
|
837
837
|
▸ **markAllInboxMessagesAsRead**(): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
|
|
838
838
|
|
|
839
|
-
Requests to mark all inbox messages as
|
|
839
|
+
Requests to mark all inbox messages as read
|
|
840
840
|
|
|
841
841
|
**Visitor mode: not supported**
|
|
842
842
|
|
|
@@ -963,7 +963,7 @@ When using for Inbox cases, you need to use message guid as engagement_uid, and
|
|
|
963
963
|
```
|
|
964
964
|
_smartico.api.reportClickEvent({
|
|
965
965
|
engagement_uid: 'abc123-def456',
|
|
966
|
-
activityType: 31 // Inbox
|
|
966
|
+
activityType: 31 // Inbox
|
|
967
967
|
action: 'dp:gf_missions'
|
|
968
968
|
});
|
|
969
969
|
```
|
|
@@ -1030,9 +1030,9 @@ _smartico.api.getActivityLog({
|
|
|
1030
1030
|
|
|
1031
1031
|
___
|
|
1032
1032
|
|
|
1033
|
-
###
|
|
1033
|
+
### gamePickGetActiveRounds
|
|
1034
1034
|
|
|
1035
|
-
▸ **
|
|
1035
|
+
▸ **gamePickGetActiveRounds**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)[]\>\>
|
|
1036
1036
|
|
|
1037
1037
|
Returns the active rounds for the specified MatchX or Quiz game.
|
|
1038
1038
|
Each round includes its events (matches/questions) along with the current user's selections and scores.
|
|
@@ -1049,9 +1049,9 @@ Each round includes its events (matches/questions) along with the current user's
|
|
|
1049
1049
|
|
|
1050
1050
|
___
|
|
1051
1051
|
|
|
1052
|
-
###
|
|
1052
|
+
### gamePickGetActiveRound
|
|
1053
1053
|
|
|
1054
|
-
▸ **
|
|
1054
|
+
▸ **gamePickGetActiveRound**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
|
|
1055
1055
|
|
|
1056
1056
|
Returns a single active round for the specified MatchX or Quiz game.
|
|
1057
1057
|
The round includes full event details with the current user's selections.
|
|
@@ -1068,9 +1068,9 @@ The round includes full event details with the current user's selections.
|
|
|
1068
1068
|
|
|
1069
1069
|
___
|
|
1070
1070
|
|
|
1071
|
-
###
|
|
1071
|
+
### gamePickGetHistory
|
|
1072
1072
|
|
|
1073
|
-
▸ **
|
|
1073
|
+
▸ **gamePickGetHistory**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)[]\>\>
|
|
1074
1074
|
|
|
1075
1075
|
Returns the history of all rounds (including resolved ones) for the specified MatchX or Quiz game.
|
|
1076
1076
|
Each round contains full event details with results and the current user's predictions.
|
|
@@ -1087,9 +1087,9 @@ Each round contains full event details with results and the current user's predi
|
|
|
1087
1087
|
|
|
1088
1088
|
___
|
|
1089
1089
|
|
|
1090
|
-
###
|
|
1090
|
+
### gamePickGetBoard
|
|
1091
1091
|
|
|
1092
|
-
▸ **
|
|
1092
|
+
▸ **gamePickGetBoard**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRoundBoard`](../interfaces/GamePickRoundBoard.md)\>\>
|
|
1093
1093
|
|
|
1094
1094
|
Returns the leaderboard for a specific round within a MatchX or Quiz game.
|
|
1095
1095
|
Use `round_id = -1` (AllRoundsGameBoardID) to get the season/overall leaderboard across all rounds.
|
|
@@ -1106,9 +1106,9 @@ Use `round_id = -1` (AllRoundsGameBoardID) to get the season/overall leaderboard
|
|
|
1106
1106
|
|
|
1107
1107
|
___
|
|
1108
1108
|
|
|
1109
|
-
###
|
|
1109
|
+
### gamePickSubmitSelection
|
|
1110
1110
|
|
|
1111
|
-
▸ **
|
|
1111
|
+
▸ **gamePickSubmitSelection**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
|
|
1112
1112
|
|
|
1113
1113
|
Submits score predictions for a round in a MatchX game.
|
|
1114
1114
|
Sends the round object with user selections for all events at once.
|
|
@@ -1128,9 +1128,9 @@ Predictions can be edited until each match starts (if `allow_edit_answers` is en
|
|
|
1128
1128
|
|
|
1129
1129
|
___
|
|
1130
1130
|
|
|
1131
|
-
###
|
|
1131
|
+
### gamePickSubmitSelectionQuiz
|
|
1132
1132
|
|
|
1133
|
-
▸ **
|
|
1133
|
+
▸ **gamePickSubmitSelectionQuiz**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
|
|
1134
1134
|
|
|
1135
1135
|
Submits answers for a round in a Quiz game.
|
|
1136
1136
|
Sends the round object with user answers for all events at once.
|
|
@@ -1150,9 +1150,9 @@ Answers can be edited until each match starts (if `allow_edit_answers` is enable
|
|
|
1150
1150
|
|
|
1151
1151
|
___
|
|
1152
1152
|
|
|
1153
|
-
###
|
|
1153
|
+
### gamePickGetUserInfo
|
|
1154
1154
|
|
|
1155
|
-
▸ **
|
|
1155
|
+
▸ **gamePickGetUserInfo**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickUserInfo`](../interfaces/GamePickUserInfo.md)\>\>
|
|
1156
1156
|
|
|
1157
1157
|
Returns the current user's profile information within the specified MatchX or Quiz game.
|
|
1158
1158
|
The user record is synced from the Smartico platform into the games DB (synced every 1 minute).
|
|
@@ -1170,9 +1170,9 @@ If the user doesn't exist in the games DB yet, it will be created automatically
|
|
|
1170
1170
|
|
|
1171
1171
|
___
|
|
1172
1172
|
|
|
1173
|
-
###
|
|
1173
|
+
### gamePickGetGameInfo
|
|
1174
1174
|
|
|
1175
|
-
▸ **
|
|
1175
|
+
▸ **gamePickGetGameInfo**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickGameInfo`](../interfaces/GamePickGameInfo.md)\>\>
|
|
1176
1176
|
|
|
1177
1177
|
Returns the game configuration and the list of all rounds for the specified MatchX or Quiz game.
|
|
1178
1178
|
Includes the SAW template definition, label settings, and round metadata (without events).
|
|
@@ -1189,13 +1189,13 @@ Includes the SAW template definition, label settings, and round metadata (withou
|
|
|
1189
1189
|
|
|
1190
1190
|
___
|
|
1191
1191
|
|
|
1192
|
-
###
|
|
1192
|
+
### gamePickGetRoundInfoForUser
|
|
1193
1193
|
|
|
1194
|
-
▸ **
|
|
1194
|
+
▸ **gamePickGetRoundInfoForUser**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
|
|
1195
1195
|
|
|
1196
1196
|
Returns round data with events and picks for a specific user (identified by their internal user ID).
|
|
1197
1197
|
Useful for viewing another user's predictions from the leaderboard.
|
|
1198
|
-
The `int_user_id` can be obtained from the `
|
|
1198
|
+
The `int_user_id` can be obtained from the `gamePickGetBoard` response (`users[].int_user_id`).
|
|
1199
1199
|
|
|
1200
1200
|
#### Parameters
|
|
1201
1201
|
|
|
@@ -1213,7 +1213,7 @@ ___
|
|
|
1213
1213
|
|
|
1214
1214
|
▸ **jackpotGet**(`filter?`): `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
|
|
1215
1215
|
|
|
1216
|
-
Returns list of Jackpots that are active in the
|
|
1216
|
+
Returns list of Jackpots that are active in the system and matching to the filter definition.
|
|
1217
1217
|
If filter is not provided, all active jackpots will be returned.
|
|
1218
1218
|
Filter can be used to get jackpots related to specific game or specific jackpot template.
|
|
1219
1219
|
You can call this method every second in order to get up to date information about current value of the jackpot(s) and present them to the end-users
|
|
@@ -1308,7 +1308,9 @@ ___
|
|
|
1308
1308
|
|
|
1309
1309
|
▸ **getJackpotWinners**(`«destructured»`): `Promise`\<[`JackpotWinnerHistory`](../interfaces/JackpotWinnerHistory.md)[]\>
|
|
1310
1310
|
|
|
1311
|
-
Returns
|
|
1311
|
+
Returns jackpot winners for the given `jp_template_id` (paginated on the server).
|
|
1312
|
+
Default page size on the wire is 20; use `limit`, `offset`, and repeated calls to load more.
|
|
1313
|
+
The full protocol response also includes `has_more`; this method returns only the `winners` array.
|
|
1312
1314
|
|
|
1313
1315
|
**Example**:
|
|
1314
1316
|
```
|
|
@@ -1367,7 +1369,7 @@ ___
|
|
|
1367
1369
|
|
|
1368
1370
|
### getRelatedItemsForGame
|
|
1369
1371
|
|
|
1370
|
-
▸ **getRelatedItemsForGame**(`related_game_id`): `Promise
|
|
1372
|
+
▸ **getRelatedItemsForGame**(`related_game_id`): `Promise`\<[`GetRelatedAchTourResponse`](../interfaces/GetRelatedAchTourResponse.md)\>
|
|
1371
1373
|
|
|
1372
1374
|
Returns all the related tournaments and missions for the provided game id for the current user
|
|
1373
1375
|
The provided Game ID should correspond to the ID from the Games Catalog - https://help.smartico.ai/welcome/technical-guides/games-catalog-api
|
|
@@ -1394,7 +1396,7 @@ _smartico.vapi('EN').getRelatedItemsForGame('gold-slot2').then((result) => {
|
|
|
1394
1396
|
|
|
1395
1397
|
#### Returns
|
|
1396
1398
|
|
|
1397
|
-
`Promise
|
|
1399
|
+
`Promise`\<[`GetRelatedAchTourResponse`](../interfaces/GetRelatedAchTourResponse.md)\>
|
|
1398
1400
|
|
|
1399
1401
|
___
|
|
1400
1402
|
|
|
@@ -1483,7 +1485,7 @@ Returns history of draw runs for the provided raffle_id and draw_id, if the draw
|
|
|
1483
1485
|
**Example**:
|
|
1484
1486
|
|
|
1485
1487
|
```javascript
|
|
1486
|
-
_smartico.api.
|
|
1488
|
+
_smartico.api.getRaffleDrawRunsHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
|
|
1487
1489
|
console.log(result);
|
|
1488
1490
|
});
|
|
1489
1491
|
```
|
|
@@ -1491,7 +1493,7 @@ _smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((resul
|
|
|
1491
1493
|
**Example in the Visitor mode**:
|
|
1492
1494
|
|
|
1493
1495
|
```javascript
|
|
1494
|
-
_smartico.vapi('EN').
|
|
1496
|
+
_smartico.vapi('EN').getRaffleDrawRunsHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
|
|
1495
1497
|
console.log(result);
|
|
1496
1498
|
});
|
|
1497
1499
|
```
|
|
@@ -1514,7 +1516,7 @@ ___
|
|
|
1514
1516
|
|
|
1515
1517
|
▸ **claimRafflePrize**(`props`): `Promise`\<[`TransformedRaffleClaimPrizeResponse`](../interfaces/TransformedRaffleClaimPrizeResponse.md)\>
|
|
1516
1518
|
|
|
1517
|
-
Returns
|
|
1519
|
+
Returns `err_code` and `err_message` after the call; `err_code` 0 means the request succeeded.
|
|
1518
1520
|
|
|
1519
1521
|
**Example**:
|
|
1520
1522
|
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Enumeration: AchievementStatus
|
|
2
|
+
|
|
3
|
+
## Enumeration Members
|
|
4
|
+
|
|
5
|
+
### Draft
|
|
6
|
+
|
|
7
|
+
• **Draft** = ``1``
|
|
8
|
+
|
|
9
|
+
___
|
|
10
|
+
|
|
11
|
+
### AvailableUnlocked
|
|
12
|
+
|
|
13
|
+
• **AvailableUnlocked** = ``2``
|
|
14
|
+
|
|
15
|
+
___
|
|
16
|
+
|
|
17
|
+
### AvailableLocked
|
|
18
|
+
|
|
19
|
+
• **AvailableLocked** = ``3``
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### Archived
|
|
24
|
+
|
|
25
|
+
• **Archived** = ``4``
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### FeaturedManually
|
|
30
|
+
|
|
31
|
+
• **FeaturedManually** = ``5``
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### FeaturedAI
|
|
36
|
+
|
|
37
|
+
• **FeaturedAI** = ``6``
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### Recurring
|
|
42
|
+
|
|
43
|
+
• **Recurring** = ``7``
|
|
44
|
+
|
|
45
|
+
___
|
|
46
|
+
|
|
47
|
+
### RecurringUponCompletion
|
|
48
|
+
|
|
49
|
+
• **RecurringUponCompletion** = ``8``
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Enumeration: ActivityTypeLimited
|
|
2
|
+
|
|
3
|
+
## Enumeration Members
|
|
4
|
+
|
|
5
|
+
### DoNothing
|
|
6
|
+
|
|
7
|
+
• **DoNothing** = ``8``
|
|
8
|
+
|
|
9
|
+
___
|
|
10
|
+
|
|
11
|
+
### Points
|
|
12
|
+
|
|
13
|
+
• **Points** = ``12``
|
|
14
|
+
|
|
15
|
+
___
|
|
16
|
+
|
|
17
|
+
### GiveMission
|
|
18
|
+
|
|
19
|
+
• **GiveMission** = ``14``
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### StartAnotherCampaign
|
|
24
|
+
|
|
25
|
+
• **StartAnotherCampaign** = ``15``
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### MiniGameAttempt
|
|
30
|
+
|
|
31
|
+
• **MiniGameAttempt** = ``16``
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### DeductPoints
|
|
36
|
+
|
|
37
|
+
• **DeductPoints** = ``21``
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### ResetPoints
|
|
42
|
+
|
|
43
|
+
• **ResetPoints** = ``22``
|
|
44
|
+
|
|
45
|
+
___
|
|
46
|
+
|
|
47
|
+
### AddGemsAndDiamonds
|
|
48
|
+
|
|
49
|
+
• **AddGemsAndDiamonds** = ``25``
|
|
50
|
+
|
|
51
|
+
___
|
|
52
|
+
|
|
53
|
+
### DeductGemsAndDiamonds
|
|
54
|
+
|
|
55
|
+
• **DeductGemsAndDiamonds** = ``26``
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
59
|
+
### ResetGemsAndDiamonds
|
|
60
|
+
|
|
61
|
+
• **ResetGemsAndDiamonds** = ``27``
|
|
62
|
+
|
|
63
|
+
___
|
|
64
|
+
|
|
65
|
+
### Popup
|
|
66
|
+
|
|
67
|
+
• **Popup** = ``30``
|
|
68
|
+
|
|
69
|
+
___
|
|
70
|
+
|
|
71
|
+
### Inbox
|
|
72
|
+
|
|
73
|
+
• **Inbox** = ``31``
|
|
74
|
+
|
|
75
|
+
___
|
|
76
|
+
|
|
77
|
+
### Slack
|
|
78
|
+
|
|
79
|
+
• **Slack** = ``70``
|
|
80
|
+
|
|
81
|
+
___
|
|
82
|
+
|
|
83
|
+
### Email\_To\_Customer\_Support
|
|
84
|
+
|
|
85
|
+
• **Email\_To\_Customer\_Support** = ``80``
|
|
86
|
+
|
|
87
|
+
___
|
|
88
|
+
|
|
89
|
+
### Email\_To\_Risk\_Operator
|
|
90
|
+
|
|
91
|
+
• **Email\_To\_Risk\_Operator** = ``90``
|
|
92
|
+
|
|
93
|
+
___
|
|
94
|
+
|
|
95
|
+
### Bonus
|
|
96
|
+
|
|
97
|
+
• **Bonus** = ``100``
|
|
98
|
+
|
|
99
|
+
___
|
|
100
|
+
|
|
101
|
+
### WebHook
|
|
102
|
+
|
|
103
|
+
• **WebHook** = ``200``
|
|
104
|
+
|
|
105
|
+
___
|
|
106
|
+
|
|
107
|
+
### TagCustomer
|
|
108
|
+
|
|
109
|
+
• **TagCustomer** = ``504``
|
|
110
|
+
|
|
111
|
+
___
|
|
112
|
+
|
|
113
|
+
### UnTagCustomer
|
|
114
|
+
|
|
115
|
+
• **UnTagCustomer** = ``505``
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Enumeration: BadgesTimeLimitStates
|
|
2
|
+
|
|
3
|
+
## Enumeration Members
|
|
4
|
+
|
|
5
|
+
### BeforeStartDate
|
|
6
|
+
|
|
7
|
+
• **BeforeStartDate** = ``0``
|
|
8
|
+
|
|
9
|
+
Before Start Date
|
|
10
|
+
|
|
11
|
+
___
|
|
12
|
+
|
|
13
|
+
### AfterStartDateNoProgress
|
|
14
|
+
|
|
15
|
+
• **AfterStartDateNoProgress** = ``1``
|
|
16
|
+
|
|
17
|
+
After Start Date but before earned
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### AfterStartDateNoProgressAndEndDate
|
|
22
|
+
|
|
23
|
+
• **AfterStartDateNoProgressAndEndDate** = ``2``
|
|
24
|
+
|
|
25
|
+
After Start Date but before started (no progress) + End date
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### AfterStartDateWithProgressAndEndDate
|
|
30
|
+
|
|
31
|
+
• **AfterStartDateWithProgressAndEndDate** = ``3``
|
|
32
|
+
|
|
33
|
+
After Start Date, but with some progress + End date
|
|
34
|
+
|
|
35
|
+
___
|
|
36
|
+
|
|
37
|
+
### AfterEndDateNotStarted
|
|
38
|
+
|
|
39
|
+
• **AfterEndDateNotStarted** = ``4``
|
|
40
|
+
|
|
41
|
+
After End Date (not started)
|
|
42
|
+
|
|
43
|
+
___
|
|
44
|
+
|
|
45
|
+
### AfterEndDateWithProgress
|
|
46
|
+
|
|
47
|
+
• **AfterEndDateWithProgress** = ``5``
|
|
48
|
+
|
|
49
|
+
After End Date (player has some progress, but not completed)
|