@smartico/public-api 0.0.343 → 0.0.345

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@smartico/public-api",
-	"version": "0.0.343",
+	"version": "0.0.345",
 	"description": "Smartico public API",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/MiniGames/SAWExposeUserSpinId.ts

@@ -1,4 +1,19 @@
 export enum SAWExposeUserSpinId {
     UserId = 1,
     SpinId = 2,
-}
+}
+
+export enum SAWExposeUserSpinIdName {
+    UserId = 'userId',
+    SpinId = 'spinId',
+}
+
+/** @hidden */
+export const SAWExposeUserSpinIdNamed = (id: SAWExposeUserSpinId): SAWExposeUserSpinIdName => {
+    return (
+        {
+            [SAWExposeUserSpinId.UserId]: SAWExposeUserSpinIdName.UserId,
+            [SAWExposeUserSpinId.SpinId]: SAWExposeUserSpinIdName.SpinId,
+        }[id]
+    );
+};

package/src/MiniGames/SAWGameLayout.ts

@@ -1,4 +1,19 @@
 export enum SAWGameLayout {
     Horizontal = 1,
     VerticalMap = 2,
-}
+}
+
+export enum SAWGameLayoutName {
+    Horizontal = 'horizontal',
+    VerticalMap = 'vertical-map',
+}
+
+/** @hidden */
+export const SAWGameLayoutNamed = (layout: SAWGameLayout): SAWGameLayoutName => {
+    return (
+        {
+            [SAWGameLayout.Horizontal]: SAWGameLayoutName.Horizontal,
+            [SAWGameLayout.VerticalMap]: SAWGameLayoutName.VerticalMap,
+        }[layout]
+    );
+};

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -3,7 +3,9 @@ import { TMiniGamePrize, TMiniGameTemplate } from '../WSAPI/WSAPITypes';
 import { ProtocolResponse } from './../Base/ProtocolResponse';
 import { SAWAcknowledgeTypeNamed } from './SAWAcknowledgeType';
 import { SAWBuyInType, SAWBuyInTypeNamed } from './SAWBuyInType';
-import { SAWGameTypeNamed } from './SAWGameType';
+import { SAWExposeUserSpinIdNamed } from './SAWExposeUserSpinId';
+import { SAWGameLayoutNamed } from './SAWGameLayout';
+import { SAWGameType, SAWGameTypeNamed } from './SAWGameType';
 import { MiniGamePrizeTypeNamed } from './SAWPrizeType';
 import { SAWTemplate } from './SAWTemplate';
 
@@ -45,9 +47,16 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 			steps_to_finish_game: r.saw_template_ui_definition.steps_to_finish_game,
 			custom_section_id: r.saw_template_ui_definition.custom_section_id,
 			saw_template_ui_definition: r.saw_template_ui_definition,
+			...(r.saw_game_type_id === SAWGameType.LootboxCalendarDays || r.saw_game_type_id === SAWGameType.LootboxWeekdays
+				? { game_layout: SAWGameLayoutNamed(r.saw_template_ui_definition.game_layout) }
+				: {}
+			),
 			show_prize_history: r.show_prize_history,
 			max_number_of_attempts: r.maxSpinsCount,
 			max_spins_period_ms: r.maxSpinsPediodMs,
+			...(r.saw_template_ui_definition.expose_user_spin_id
+				? { expose_user_spin_id: SAWExposeUserSpinIdNamed(r.saw_template_ui_definition.expose_user_spin_id) } 
+				: {}),
 
 			prizes: r.prizes.map((p) => {
 				const y: TMiniGamePrize = {

package/src/WSAPI/WSAPITypes.ts

@@ -1,5 +1,5 @@
 import { BuyStoreItemErrorCode } from '../Store';
-import { AttemptPeriodType, MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWAskForUsername, SAWBuyInTypeName, SAWGameLayout, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
+import { AttemptPeriodType, MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWAskForUsername, SAWBuyInTypeName, SAWExposeUserSpinIdName, SAWGameLayout, SAWGameLayoutName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
 import { AchievementAvailabilityStatus, BadgesTimeLimitStates } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -188,12 +188,16 @@ export interface TMiniGameTemplate {
 
 	/** The UI definition of the mini-game */
 	saw_template_ui_definition: SAWTemplateUI;
+	/** The layout of the game */
+	game_layout?: SAWGameLayoutName;
 	/** When enabled the prize history icon is visible on a certain template */
 	show_prize_history?: boolean;
 	/** The maximum number of attempts that user can do during period of time */
 	max_number_of_attempts?: number;
 	/** The period of time in milliseconds during which the user can do the maximum number of attempts */
 	max_spins_period_ms?: number;
+	/** The ID of the user spin id to expose on the game */
+	expose_user_spin_id?: SAWExposeUserSpinIdName;
 }
 
 /**

package/docs/README.md

@@ -1,230 +0,0 @@
-# Smartico API documentation
-
-## Enumerations
-
-- [PointChangeSourceType](enums/PointChangeSourceType.md)
-- [UserBalanceType](enums/UserBalanceType.md)
-- [BonusStatus](enums/BonusStatus.md)
-- [AchCustomSectionType](enums/AchCustomSectionType.md)
-- [AchCustomLayoutTheme](enums/AchCustomLayoutTheme.md)
-- [AchMissionsTabsOptions](enums/AchMissionsTabsOptions.md)
-- [AchOverviewMissionsFilter](enums/AchOverviewMissionsFilter.md)
-- [LiquidEntityData](enums/LiquidEntityData.md)
-- [InboxCategories](enums/InboxCategories.md)
-- [JackpotContributionType](enums/JackpotContributionType.md)
-- [JackPotTemparature](enums/JackPotTemparature.md)
-- [JackpotType](enums/JackpotType.md)
-- [LeaderBoardPeriodType](enums/LeaderBoardPeriodType.md)
-- [AttemptPeriodType](enums/AttemptPeriodType.md)
-- [PrizeModifiers](enums/PrizeModifiers.md)
-- [SAWAcknowledgeType](enums/SAWAcknowledgeType.md)
-- [SAWAcknowledgeTypeName](enums/SAWAcknowledgeTypeName.md)
-- [SAWAskForUsername](enums/SAWAskForUsername.md)
-- [SAWBuyInType](enums/SAWBuyInType.md)
-- [SAWBuyInTypeName](enums/SAWBuyInTypeName.md)
-- [SAWExposeUserSpinId](enums/SAWExposeUserSpinId.md)
-- [SAWGameDifficultyType](enums/SAWGameDifficultyType.md)
-- [SAWGameDifficultyTypeName](enums/SAWGameDifficultyTypeName.md)
-- [SAWGameLayout](enums/SAWGameLayout.md)
-- [SAWGameType](enums/SAWGameType.md)
-- [SAWGameTypeName](enums/SAWGameTypeName.md)
-- [SAWPrizeType](enums/SAWPrizeType.md)
-- [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
-- [SAWSpinErrorCode](enums/SAWSpinErrorCode.md)
-- [SAWWheelLayout](enums/SAWWheelLayout.md)
-- [SAWWinSoundType](enums/SAWWinSoundType.md)
-- [AchievementAvailabilityStatus](enums/AchievementAvailabilityStatus.md)
-- [RaffleDrawInstanceState](enums/RaffleDrawInstanceState.md)
-- [RaffleDrawTypeExecution](enums/RaffleDrawTypeExecution.md)
-- [BuyStoreItemErrorCode](enums/BuyStoreItemErrorCode.md)
-- [TournamentRegistrationError](enums/TournamentRegistrationError.md)
-- [TournamentRegistrationStatus](enums/TournamentRegistrationStatus.md)
-- [TournamentRegistrationStatusName](enums/TournamentRegistrationStatusName.md)
-- [TournamentRegistrationType](enums/TournamentRegistrationType.md)
-- [BonusStatus](enums/BonusStatus-1.md)
-
-## Classes
-
-- [SAWUtils](classes/SAWUtils.md)
-
-## Interfaces
-
-- [AchRelatedGame](interfaces/AchRelatedGame.md)
-- [GetJackpotEligibleGamesRequest](interfaces/GetJackpotEligibleGamesRequest.md)
-- [GetJackpotEligibleGamesResponse](interfaces/GetJackpotEligibleGamesResponse.md)
-- [TGetJackpotEligibleGamesResponse](interfaces/TGetJackpotEligibleGamesResponse.md)
-- [JackpotEligibleGame](interfaces/JackpotEligibleGame.md)
-- [GetJackpotWinnersRequest](interfaces/GetJackpotWinnersRequest.md)
-- [GetJackpotWinnersResponse](interfaces/GetJackpotWinnersResponse.md)
-- [JackpotWinnerHistory](interfaces/JackpotWinnerHistory.md)
-- [GetJackpotsPotsRequest](interfaces/GetJackpotsPotsRequest.md)
-- [GetJackpotsPotsResponse](interfaces/GetJackpotsPotsResponse.md)
-- [GetJackpotsRequest](interfaces/GetJackpotsRequest.md)
-- [GetJackpotsResponse](interfaces/GetJackpotsResponse.md)
-- [JackPotWinner](interfaces/JackPotWinner.md)
-- [JackpotDetails](interfaces/JackpotDetails.md)
-- [JackpotHtmlTemplate](interfaces/JackpotHtmlTemplate.md)
-- [JackpotPot](interfaces/JackpotPot.md)
-- [JackpotPublicMeta](interfaces/JackpotPublicMeta.md)
-- [JackpotWinPush](interfaces/JackpotWinPush.md)
-- [JackpotsOptinRequest](interfaces/JackpotsOptinRequest.md)
-- [JackpotsOptinResponse](interfaces/JackpotsOptinResponse.md)
-- [JackpotsOptoutRequest](interfaces/JackpotsOptoutRequest.md)
-- [JackpotsOptoutResponse](interfaces/JackpotsOptoutResponse.md)
-- [SAWAcknowledgeSpinPushRequest](interfaces/SAWAcknowledgeSpinPushRequest.md)
-- [SAWDoAknowledgeRequest](interfaces/SAWDoAknowledgeRequest.md)
-- [SAWDoAknowledgeResponse](interfaces/SAWDoAknowledgeResponse.md)
-- [SAWDoSpinRequest](interfaces/SAWDoSpinRequest.md)
-- [SAWDoSpinResponse](interfaces/SAWDoSpinResponse.md)
-- [SAWEventSawPush](interfaces/SAWEventSawPush.md)
-- [SAWGetTemplatesRequest](interfaces/SAWGetTemplatesRequest.md)
-- [SAWGetTemplatesResponse](interfaces/SAWGetTemplatesResponse.md)
-- [SAWPrize](interfaces/SAWPrize.md)
-- [SAWPrizeDropAknowledgeRequest](interfaces/SAWPrizeDropAknowledgeRequest.md)
-- [SAWPrizeDropAknowledgeResponse](interfaces/SAWPrizeDropAknowledgeResponse.md)
-- [SAWPrizeDropWinPush](interfaces/SAWPrizeDropWinPush.md)
-- [SAWPrizeUI](interfaces/SAWPrizeUI.md)
-- [SAWSpinsCountPush](interfaces/SAWSpinsCountPush.md)
-- [SAWTemplate](interfaces/SAWTemplate.md)
-- [SAWTemplateUI](interfaces/SAWTemplateUI.md)
-- [SAWWinningHistoryRequest](interfaces/SAWWinningHistoryRequest.md)
-- [SAWWinningHistoryResponse](interfaces/SAWWinningHistoryResponse.md)
-- [SAWPrizesHistory](interfaces/SAWPrizesHistory.md)
-- [GetDrawRunRequest](interfaces/GetDrawRunRequest.md)
-- [GetDrawRunResponse](interfaces/GetDrawRunResponse.md)
-- [GetRaffleDrawRunsHistoryRequest](interfaces/GetRaffleDrawRunsHistoryRequest.md)
-- [GetRaffleDrawRunsHistoryResponse](interfaces/GetRaffleDrawRunsHistoryResponse.md)
-- [GetRafflesRequest](interfaces/GetRafflesRequest.md)
-- [GetRafflesResponse](interfaces/GetRafflesResponse.md)
-- [RafflePublicMeta](interfaces/RafflePublicMeta.md)
-- [Raffle](interfaces/Raffle.md)
-- [RaffleClaimPrizeRequest](interfaces/RaffleClaimPrizeRequest.md)
-- [RaffleClaimPrizeResponse](interfaces/RaffleClaimPrizeResponse.md)
-- [RaffleDraw](interfaces/RaffleDraw.md)
-- [RaffleDrawPublicMeta](interfaces/RaffleDrawPublicMeta.md)
-- [RaffleDrawRun](interfaces/RaffleDrawRun.md)
-- [RaffleOptinRequest](interfaces/RaffleOptinRequest.md)
-- [RaffleOptinResponse](interfaces/RaffleOptinResponse.md)
-- [RafflePrizePublicMeta](interfaces/RafflePrizePublicMeta.md)
-- [RafflePrize](interfaces/RafflePrize.md)
-- [RafflePrizeWinner](interfaces/RafflePrizeWinner.md)
-- [RaffleTicket](interfaces/RaffleTicket.md)
-- [TMiniGamePrize](interfaces/TMiniGamePrize.md)
-- [TMiniGamePlayResult](interfaces/TMiniGamePlayResult.md)
-- [TMiniGamePlayBatchResult](interfaces/TMiniGamePlayBatchResult.md)
-- [TMiniGameTemplate](interfaces/TMiniGameTemplate.md)
-- [TUserProfile](interfaces/TUserProfile.md)
-- [TLevel](interfaces/TLevel.md)
-- [TLevelCurrent](interfaces/TLevelCurrent.md)
-- [TTournament](interfaces/TTournament.md)
-- [TTournamentDetailed](interfaces/TTournamentDetailed.md)
-- [TStoreCategory](interfaces/TStoreCategory.md)
-- [TStoreItem](interfaces/TStoreItem.md)
-- [TAchCategory](interfaces/TAchCategory.md)
-- [TMissionOrBadge](interfaces/TMissionOrBadge.md)
-- [AchRelatedGame](interfaces/AchRelatedGame-1.md)
-- [TMissionOrBadgeTask](interfaces/TMissionOrBadgeTask.md)
-- [TMissionOptInResult](interfaces/TMissionOptInResult.md)
-- [TMissionClaimRewardResult](interfaces/TMissionClaimRewardResult.md)
-- [TTournamentRegistrationResult](interfaces/TTournamentRegistrationResult.md)
-- [TBuyStoreItemResult](interfaces/TBuyStoreItemResult.md)
-- [TGetTranslations](interfaces/TGetTranslations.md)
-- [TInboxMessage](interfaces/TInboxMessage.md)
-- [TInboxMessageBody](interfaces/TInboxMessageBody.md)
-- [InboxMarkMessageAction](interfaces/InboxMarkMessageAction.md)
-- [LeaderBoardDetailsT](interfaces/LeaderBoardDetailsT.md)
-- [LeaderBoardsRewardsT](interfaces/LeaderBoardsRewardsT.md)
-- [LeaderBoardUserT](interfaces/LeaderBoardUserT.md)
-- [UserLevelExtraCountersT](interfaces/UserLevelExtraCountersT.md)
-- [TSegmentCheckResult](interfaces/TSegmentCheckResult.md)
-- [TUICustomSection](interfaces/TUICustomSection.md)
-- [TBonus](interfaces/TBonus.md)
-- [BonusTemplateMetaMap](interfaces/BonusTemplateMetaMap.md)
-- [BonusMetaMap](interfaces/BonusMetaMap.md)
-- [TClaimBonusResult](interfaces/TClaimBonusResult.md)
-- [TSawHistory](interfaces/TSawHistory.md)
-- [TRaffle](interfaces/TRaffle.md)
-- [TRaffleTicket](interfaces/TRaffleTicket.md)
-- [TRafflePrize](interfaces/TRafflePrize.md)
-- [TRafflePrizeWinner](interfaces/TRafflePrizeWinner.md)
-- [TRaffleDraw](interfaces/TRaffleDraw.md)
-- [TRaffleDrawRun](interfaces/TRaffleDrawRun.md)
-- [TransformedRaffleClaimPrizeResponse](interfaces/TransformedRaffleClaimPrizeResponse.md)
-- [TActivityLog](interfaces/TActivityLog.md)
-- [TRaffleOptinResponse](interfaces/TRaffleOptinResponse.md)
-
-## General API
-
-- [WSAPI](classes/WSAPI.md)
-
-## Type Aliases
-
-### TournamentRegistrationTypeName
-
-Ƭ **TournamentRegistrationTypeName**: ``"AUTO"`` \| ``"OPT_IN"`` \| ``"BUY_IN_POINTS"`` \| ``"MANUAL_APPROVAL"`` \| ``"REQUIRES_QUALIFICATION"`` \| ``"BUY_IN_GEMS"`` \| ``"BUY_IN_DIAMONDS"`` \| ``"UNKNOWN"``
-
-## Variables
-
-### PrizeModifiersKeysNames
-
-• `Const` **PrizeModifiersKeysNames**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `1` | `string` |
-| `2` | `string` |
-| `3` | `string` |
-| `4` | `string` |
-| `5` | `string` |
-| `6` | `string` |
-| `7` | `string` |
-| `8` | `string` |
-
-___
-
-### SAWWinSoundFiles
-
-• `Const` **SAWWinSoundFiles**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `4` | `any` |
-| `1` | `string` |
-| `2` | `string` |
-| `3` | `string` |
-
-## Functions
-
-### SAWTemplatesTransform
-
-▸ **SAWTemplatesTransform**(`items`): [`TMiniGameTemplate`](interfaces/TMiniGameTemplate.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`SAWTemplate`](interfaces/SAWTemplate.md)[] |
-
-#### Returns
-
-[`TMiniGameTemplate`](interfaces/TMiniGameTemplate.md)[]
-
-___
-
-### SAWHistoryTransform
-
-▸ **SAWHistoryTransform**(`items`): [`TSawHistory`](interfaces/TSawHistory.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`SAWPrizesHistory`](interfaces/SAWPrizesHistory.md)[] |
-
-#### Returns
-
-[`TSawHistory`](interfaces/TSawHistory.md)[]

package/docs/api/interfaces/GemsDiamondsLog.md

@@ -1,43 +0,0 @@
-# Interface: GemsDiamondsLog
-
-## Properties
-
-### create\_date
-
-• **create\_date**: `number`
-
-___
-
-### user\_ext\_id
-
-• **user\_ext\_id**: `string`
-
-___
-
-### crm\_brand\_id
-
-• **crm\_brand\_id**: `number`
-
-___
-
-### type
-
-• **type**: [`UserBalanceType`](../enums/UserBalanceType.md)
-
-___
-
-### amount
-
-• **amount**: `number`
-
-___
-
-### balance
-
-• **balance**: `number`
-
-___
-
-### source\_type\_id
-
-• **source\_type\_id**: [`PointChangeSourceType`](../enums/PointChangeSourceType.md)

package/docs/api/interfaces/PointsLog.md

@@ -1,43 +0,0 @@
-# Interface: PointsLog
-
-## Properties
-
-### create\_date
-
-• **create\_date**: `number`
-
-___
-
-### user\_ext\_id
-
-• **user\_ext\_id**: `string`
-
-___
-
-### crm\_brand\_id
-
-• **crm\_brand\_id**: `number`
-
-___
-
-### points\_collected
-
-• **points\_collected**: `number`
-
-___
-
-### user\_points\_ever
-
-• **user\_points\_ever**: `number`
-
-___
-
-### user\_points\_balance
-
-• **user\_points\_balance**: `number`
-
-___
-
-### source\_type\_id
-
-• **source\_type\_id**: [`PointChangeSourceType`](../enums/PointChangeSourceType.md)