@smartico/public-api 0.0.378 → 0.0.380

package/docs/api/README.md

@@ -40,6 +40,7 @@
 - [SAWWheelLayout](enumerations/SAWWheelLayout.md)
 - [SAWWinSoundType](enumerations/SAWWinSoundType.md)
 - [AchievementAvailabilityStatus](enumerations/AchievementAvailabilityStatus.md)
+- [AchievementClaimPeriodTypeId](enumerations/AchievementClaimPeriodTypeId.md)
 - [AchievementStatus](enumerations/AchievementStatus.md)
 - [AchievementTaskType](enumerations/AchievementTaskType.md)
 - [AchievementType](enumerations/AchievementType.md)
@@ -160,6 +161,7 @@
 - [GetTournamentInfoResponse](interfaces/GetTournamentInfoResponse.md)
 - [Tournament](interfaces/Tournament.md)
 - [ClanLeaderboardEntry](interfaces/ClanLeaderboardEntry.md)
+- [ClanPrizePublicMeta](interfaces/ClanPrizePublicMeta.md)
 - [ClanPrizeTier](interfaces/ClanPrizeTier.md)
 - [ClanPrizeStructureEntry](interfaces/ClanPrizeStructureEntry.md)
 - [TournamentPlayer](interfaces/TournamentPlayer.md)
@@ -258,6 +260,58 @@
 - [TournamentItemsTransform](functions/TournamentItemsTransform.md)
 - [TournamentInstanceStatusName](functions/TournamentInstanceStatusName.md)
 
-## General API
+## Avatars
 
-- [WSAPI](classes/WSAPI.md)
+- [WSAPIAvatars](classes/WSAPIAvatars.md)
+
+## Bonuses
+
+- [WSAPIBonuses](classes/WSAPIBonuses.md)
+
+## Clans
+
+- [WSAPIClans](classes/WSAPIClans.md)
+
+## GamePick
+
+- [WSAPIGamePick](classes/WSAPIGamePick.md)
+
+## General
+
+- [WSAPIGeneral](classes/WSAPIGeneral.md)
+
+## Inbox
+
+- [WSAPIInbox](classes/WSAPIInbox.md)
+
+## Jackpots
+
+- [WSAPIJackpots](classes/WSAPIJackpots.md)
+
+## LeaderBoard
+
+- [WSAPILeaderBoard](classes/WSAPILeaderBoard.md)
+
+## MiniGames
+
+- [WSAPIMiniGames](classes/WSAPIMiniGames.md)
+
+## Missions
+
+- [WSAPIMissions](classes/WSAPIMissions.md)
+
+## Raffles
+
+- [WSAPIRaffles](classes/WSAPIRaffles.md)
+
+## Store
+
+- [WSAPIStore](classes/WSAPIStore.md)
+
+## Tournaments
+
+- [WSAPITournaments](classes/WSAPITournaments.md)
+
+## User
+
+- [WSAPIUser](classes/WSAPIUser.md)

package/docs/api/classes/WSAPIAvatars.md

@@ -0,0 +1,116 @@
+# Class: WSAPIAvatars
+## Methods
+
+### getAvatarsList()
+
+> **getAvatarsList**(): `Promise`\<[`TAvatarDefinition`](../interfaces/TAvatarDefinition.md)[]\>
+
+Returns the list of avatars available in the catalog for the current user.
+The response includes both free avatars and earned/purchased ones.
+Avatars with `hide_until_achieved = true` and `is_given = false` should be hidden from the user.
+The result is cached for 30 seconds.
+
+**Example**:
+```
+_smartico.api.getAvatarsList().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Returns
+
+`Promise`\<[`TAvatarDefinition`](../interfaces/TAvatarDefinition.md)[]\>
+
+***
+
+### getAvatarsCustomized()
+
+> **getAvatarsCustomized**(): `Promise`\<[`TAvatarCustomized`](../interfaces/TAvatarCustomized.md)[]\>
+
+Returns the list of AI-customized avatars for the current user.
+Each entry represents a previously generated AI customization for a specific base avatar.
+The result is cached for 30 seconds.
+
+**Example**:
+```
+_smartico.api.getAvatarsCustomized().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Returns
+
+`Promise`\<[`TAvatarCustomized`](../interfaces/TAvatarCustomized.md)[]\>
+
+***
+
+### getAvatarPrompts()
+
+> **getAvatarPrompts**(): `Promise`\<[`TAvatarPrompt`](../interfaces/TAvatarPrompt.md)[]\>
+
+Returns the list of AI customization prompts (styles) available for avatar customization.
+Each prompt represents a visual style that can be applied to a base avatar.
+The result is cached for 30 seconds.
+
+**Example**:
+```
+_smartico.api.getAvatarPrompts().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Returns
+
+`Promise`\<[`TAvatarPrompt`](../interfaces/TAvatarPrompt.md)[]\>
+
+***
+
+### setAvatar()
+
+> **setAvatar**(`props`): `Promise`\<[`TSetAvatarResult`](../interfaces/TSetAvatarResult.md)\>
+
+Sets the specified avatar as the active avatar for the current user.
+Pass `avatar_url` (the `TAvatarDefinition.url` path or a CDN URL for AI-customized avatars)
+and `avatar_real_id` from the avatar catalog.
+After a successful call, the avatar list cache is cleared so the next `getAvatarsList()` call reflects `is_in_use`.
+
+**Example**:
+```
+_smartico.api.getAvatarsList().then((avatars) => {
+     const avatar = avatars.find((a) => !a.hide_until_achieved || a.is_given);
+     if (avatar) {
+         _smartico.api.setAvatar({
+             avatar_url: avatar.url,
+             avatar_real_id: avatar.avatar_real_id,
+         }).then((result) => {
+             console.log(result);
+         });
+     }
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### props
+
+###### avatar_url
+
+`string`
+
+###### avatar_real_id
+
+`number`
+
+#### Returns
+
+`Promise`\<[`TSetAvatarResult`](../interfaces/TSetAvatarResult.md)\>
+
+***

package/docs/api/classes/WSAPIBonuses.md

@@ -0,0 +1,50 @@
+# Class: WSAPIBonuses
+## Methods
+
+### getBonuses()
+
+> **getBonuses**(`__namedParameters?`): `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
+
+Returns all the bonuses for the current user
+The returned bonuses are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
+Note that each time you call getBonuses with a new onUpdate callback, the old one will be overwritten by the new one.
+The onUpdate callback will be called on bonus claimed and the updated bonuses will be passed to it.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### \_\_namedParameters?
+
+###### onUpdate?
+
+(`data`) => `void`
+
+#### Returns
+
+`Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
+
+***
+
+### claimBonus()
+
+> **claimBonus**(`bonus_id`): `Promise`\<[`TClaimBonusResult`](../interfaces/TClaimBonusResult.md)\>
+
+Claim the bonus by bonus_id. Returns the err_code in case of success or error.
+Note that this method can be used only on integrations where originally failed bonus can be claimed again.
+For example, user won a bonus in the mini-game, but Operator rejected this bonus.
+This bonus will be available for the user to claim again.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### bonus\_id
+
+`number`
+
+#### Returns
+
+`Promise`\<[`TClaimBonusResult`](../interfaces/TClaimBonusResult.md)\>
+
+***

package/docs/api/classes/WSAPIClans.md

@@ -0,0 +1,66 @@
+# Class: WSAPIClans
+## Methods
+
+### getClans()
+
+> **getClans**(`__namedParameters?`): `Promise`\<[`TClans`](../interfaces/TClans.md)\>
+
+Returns clans list payload for the current user.
+The returned payload is cached for 30 seconds.
+If onUpdate is passed, it will be called when clans response is received.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### \_\_namedParameters?
+
+###### onUpdate?
+
+(`data`) => `void`
+
+#### Returns
+
+`Promise`\<[`TClans`](../interfaces/TClans.md)\>
+
+***
+
+### getClanInfo()
+
+> **getClanInfo**(`clanId`): `Promise`\<[`TClanInfo`](../interfaces/TClanInfo.md)\>
+
+Returns detailed information for a specific clan including its members.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### clanId
+
+`number`
+
+#### Returns
+
+`Promise`\<[`TClanInfo`](../interfaces/TClanInfo.md)\>
+
+***
+
+### joinClan()
+
+> **joinClan**(`clanId`): `Promise`\<[`TClanJoinResult`](../interfaces/TClanJoinResult.md)\>
+
+Joins a clan on behalf of the current user.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### clanId
+
+`number`
+
+#### Returns
+
+`Promise`\<[`TClanJoinResult`](../interfaces/TClanJoinResult.md)\>
+
+***

package/docs/api/classes/WSAPIGamePick.md

@@ -0,0 +1,181 @@
+# Class: WSAPIGamePick
+## Methods
+
+### gamePickGetActiveRounds()
+
+> **gamePickGetActiveRounds**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)[]\>\>
+
+Returns the active rounds for the specified MatchX or Quiz game.
+Each round includes its events (matches/questions) along with the current user's selections and scores.
+
+#### Parameters
+
+##### props
+
+[`GamePickRequestParams`](../interfaces/GamePickRequestParams.md)
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)[]\>\>
+
+***
+
+### gamePickGetActiveRound()
+
+> **gamePickGetActiveRound**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+Returns a single active round for the specified MatchX or Quiz game.
+The round includes full event details with the current user's selections.
+
+#### Parameters
+
+##### props
+
+[`GamePickRoundRequestParams`](../interfaces/GamePickRoundRequestParams.md)
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+***
+
+### gamePickGetHistory()
+
+> **gamePickGetHistory**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)[]\>\>
+
+Returns the history of all rounds (including resolved ones) for the specified MatchX or Quiz game.
+Each round contains full event details with results and the current user's predictions.
+
+#### Parameters
+
+##### props
+
+[`GamePickRequestParams`](../interfaces/GamePickRequestParams.md)
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)[]\>\>
+
+***
+
+### gamePickGetBoard()
+
+> **gamePickGetBoard**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRoundBoard`](../interfaces/GamePickRoundBoard.md)\>\>
+
+Returns the leaderboard for a specific round within a MatchX or Quiz game.
+Use `round_id = -1` (AllRoundsGameBoardID) to get the season/overall leaderboard across all rounds.
+
+#### Parameters
+
+##### props
+
+[`GamePickRoundRequestParams`](../interfaces/GamePickRoundRequestParams.md)
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRoundBoard`](../interfaces/GamePickRoundBoard.md)\>\>
+
+***
+
+### gamePickSubmitSelection()
+
+> **gamePickSubmitSelection**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+Submits score predictions for a round in a MatchX game.
+Sends the round object with user selections for all events at once.
+Each event must include `team1_user_selection` and `team2_user_selection` representing predicted scores.
+If the user hasn't placed bets before, one game attempt (spin) will be consumed.
+Predictions can be edited until each match starts (if `allow_edit_answers` is enabled on the round).
+
+#### Parameters
+
+##### props
+
+[`GamePickRequestParams`](../interfaces/GamePickRequestParams.md) & `object`
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+***
+
+### gamePickSubmitSelectionQuiz()
+
+> **gamePickSubmitSelectionQuiz**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+Submits answers for a round in a Quiz game.
+Sends the round object with user answers for all events at once.
+Each event must include `user_selection` with the answer value (e.g. '1', '2', 'x', 'yes', 'no' — depending on the market type).
+If the user hasn't placed bets before, one game attempt (spin) will be consumed.
+Answers can be edited until each match starts (if `allow_edit_answers` is enabled on the round).
+
+#### Parameters
+
+##### props
+
+[`GamePickRequestParams`](../interfaces/GamePickRequestParams.md) & `object`
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+***
+
+### gamePickGetUserInfo()
+
+> **gamePickGetUserInfo**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickUserInfo`](../interfaces/GamePickUserInfo.md)\>\>
+
+Returns the current user's profile information within the specified MatchX or Quiz game.
+The user record is synced from the Smartico platform into the games DB (synced every 1 minute).
+If the user doesn't exist in the games DB yet, it will be created automatically on first call.
+
+#### Parameters
+
+##### props
+
+[`GamePickRequestParams`](../interfaces/GamePickRequestParams.md)
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickUserInfo`](../interfaces/GamePickUserInfo.md)\>\>
+
+***
+
+### gamePickGetGameInfo()
+
+> **gamePickGetGameInfo**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickGameInfo`](../interfaces/GamePickGameInfo.md)\>\>
+
+Returns the game configuration and the list of all rounds for the specified MatchX or Quiz game.
+Includes the SAW template definition, label settings, and round metadata (without events).
+
+#### Parameters
+
+##### props
+
+[`GamePickRequestParams`](../interfaces/GamePickRequestParams.md)
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickGameInfo`](../interfaces/GamePickGameInfo.md)\>\>
+
+***
+
+### gamePickGetRoundInfoForUser()
+
+> **gamePickGetRoundInfoForUser**(`props`): `Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+Returns round data with events and picks for a specific user (identified by their internal user ID).
+Useful for viewing another user's predictions from the leaderboard.
+The `int_user_id` can be obtained from the `gamePickGetBoard` response (`users[].int_user_id`).
+
+#### Parameters
+
+##### props
+
+[`GamePickRoundRequestParams`](../interfaces/GamePickRoundRequestParams.md) & `object`
+
+#### Returns
+
+`Promise`\<[`GamesApiResponse`](../interfaces/GamesApiResponse.md)\<[`GamePickRound`](../interfaces/GamePickRound.md)\>\>
+
+***

package/docs/api/classes/WSAPIGeneral.md

@@ -0,0 +1,63 @@
+# Class: WSAPIGeneral
+## Methods
+
+### getCustomSections()
+
+> **getCustomSections**(): `Promise`\<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
+
+#### Returns
+
+`Promise`\<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
+
+***
+
+### getTranslations()
+
+> **getTranslations**(`lang_code`): `Promise`\<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
+
+Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office.
+
+#### Parameters
+
+##### lang\_code
+
+`string`
+
+#### Returns
+
+`Promise`\<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
+
+***
+
+### getRelatedItemsForGame()
+
+> **getRelatedItemsForGame**(`related_game_id`): `Promise`\<[`GetRelatedAchTourResponse`](../interfaces/GetRelatedAchTourResponse.md)\>
+
+Returns all the related tournaments and missions for the provided game id for the current user
+The provided Game ID should correspond to the ID from the Games Catalog - https://help.smartico.ai/welcome/technical-guides/games-catalog-api
+
+**Example**:
+```
+_smartico.api.getRelatedItemsForGame('gold-slot2').then((result) => {
+     console.log(result);
+});
+```
+
+**Example in the Visitor mode**:
+```
+_smartico.vapi('EN').getRelatedItemsForGame('gold-slot2').then((result) => {
+     console.log(result);
+});
+```
+
+#### Parameters
+
+##### related\_game\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<[`GetRelatedAchTourResponse`](../interfaces/GetRelatedAchTourResponse.md)\>
+
+***