@smartico/public-api 0.0.158 → 0.0.159

package/src/WSAPI/WSAPITypes.ts

@@ -1,42 +1,44 @@
-import { BuyStoreItemErrorCode } from '../Store'
-import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from '../MiniGames'
-import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments'
-import { AchCategory } from '../Missions'
-import { LeaderBoardPeriodType } from '../Leaderboard'
-import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections'
+import { BuyStoreItemErrorCode } from '../Store';
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from '../MiniGames';
+import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
+import { AchCategory } from '../Missions';
+import { LeaderBoardPeriodType } from '../Leaderboard';
+import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections';
+import { BonusStatus , BonusTemplateMetaMap, BonusMetaMap} from '../Bonuses';
 
-type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string
+
+type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
 
 /**
  * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
  */
 export interface TMiniGamePrize {
 	/** ID of the prize */
-	id: number
+	id: number;
 	/** The visual name of the prize */
-	name: string
+	name: string;
 	/** The type of the prize,  no-prize, points, bonus, manual, spin, jackpot */
-	prize_type: MiniGamePrizeTypeName
+	prize_type: MiniGamePrizeTypeName;
 	/** Numeric value of the prize in case it's pints or spin type */
-	prize_value?: number
+	prize_value?: number;
 	/** Custom font size for the prize (desktop) */
-	font_size?: number
+	font_size?: number;
 	/** Custom font size for the prize (mobile) */
-	font_size_mobile?: number
+	font_size_mobile?: number;
 	/** The URL of the icon of the prize */
-	icon?: string
+	icon?: string;
 	/* for scratch card defines position of prize in the list */
-	position: number
+	position: number;
 	/* Message that will be shown to user in modal pop-up */
-	aknowledge_message: string
+	aknowledge_message: string;
 	/* Deep link that will trigger some action in modal pop-up */
-	acknowledge_dp: string
+	acknowledge_dp: string;
 	/* The name of the action button in modal pop-up */
-	acknowledge_action_title: string
+	acknowledge_action_title: string;
 	/* Number of items in stock */
-	pool?: number
+	pool?: number;
 	/* Number of wins in game */
-	wins_count?: number
+	wins_count?: number;
 }
 
 /**
@@ -44,11 +46,11 @@ export interface TMiniGamePrize {
  */
 export interface TMiniGamePlayResult {
 	/** Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0 */
-	err_code: SAWSpinErrorCode
+	err_code: SAWSpinErrorCode;
 	/** Optional error message */
-	err_message: string
+	err_message: string;
 	/** The prize_id that user won, details of the prize can be found in the mini-game definition */
-	prize_id: number
+	prize_id: number;
 }
 
 /**
@@ -56,52 +58,52 @@ export interface TMiniGamePlayResult {
  */
 export interface TMiniGameTemplate {
 	/** ID of the mini-game template */
-	id: number
+	id: number;
 	/** Name of the mini-game template, translated to the user language */
-	name: string
+	name: string;
 	/** Description of the mini-game template, translated to the user language */
-	description: string
+	description: string;
 	/** URL of the icon of the mini-game template */
-	thumbnail: string
+	thumbnail: string;
 
 	/** The type of the game, e.g. Spin the Wheel, Gift Box, Scratch card, MatchX etc */
-	saw_game_type: SAWGameTypeName
+	saw_game_type: SAWGameTypeName;
 	/** How the user is charged for each game attempt e.g. Free, Points or Spin attempts */
-	saw_buyin_type: SAWBuyInTypeName
+	saw_buyin_type: SAWBuyInTypeName;
 
 	/** in case of charging type 'Points', what is the points amount will be deducted from user balance */
-	buyin_cost_points: number
+	buyin_cost_points: number;
 	/** in case of charging type 'Spin attempts', shows the current number of spin attempts that user has */
-	spin_count?: number
+	spin_count?: number;
 
 	/** if the game is limit to the number of spins that user can do during period of time, this property shows the epoch time in UTC when the next attempt will be available */
-	next_available_spin_ts: number
+	next_available_spin_ts: number;
 
 	/** The message that should be shown to the user when he cannot play the game, server rejected attempt with error code SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED */
-	over_limit_message: string
+	over_limit_message: string;
 	/** The message that should be shown to the user when he cannot play the game because he doesn't have spin attempts or points. */
-	no_attempts_message: string
+	no_attempts_message: string;
 
 	/** Current jackpont amount, if jackpot is enabled. */
-	jackpot_current: number
+	jackpot_current: number;
 	/** The amount that will be added to the jackpot every time when somebody plays the game. Note that the contribution amount is abstract, means that no money or points are deducted from the user balance. */
-	jackpot_add_on_attempt: number
+	jackpot_add_on_attempt: number;
 	/** The symbol of jackpot that is giving the sense to the 'amount' E.g. the symbol could be EUR and connected to the amount it can indicate that amount is monetary, e.g. '100 EUR'. Or the symbol can be 'Free spins' and connected to the amount it can indicate that amount is number of free spins, e.g. '100 Free spins'.
 	 */
-	jackpot_symbol: string
+	jackpot_symbol: string;
 
 	/** The promo image  */
-	promo_image: string
+	promo_image: string;
 	/** The promo text  */
-	promo_text: string
+	promo_text: string;
 	/** The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number */
-	custom_data: any
+	custom_data: any;
 
 	/** List of prizes for mini-games */
-	prizes: TMiniGamePrize[]
+	prizes: TMiniGamePrize[];
 
 	/* When enabled, the number of items in the pool and number of won items will be exposed in the Retention API and in the UI Widgets */
-	expose_game_stat_on_api?: boolean
+	expose_game_stat_on_api?: boolean;
 }
 
 /**
@@ -113,28 +115,28 @@ export interface TMiniGameTemplate {
 
 export interface TUserProfile {
 	/** The language of the user */
-	core_user_language: string
+	core_user_language: string;
 	/** The current points balance that user can use in the Store, Mini-games, Tournaments, etc.. */
-	ach_points_balance: number
+	ach_points_balance: number;
 	/** The amount of points that user collected in total */
-	ach_points_ever: number
+	ach_points_ever: number;
 	/**
 	 * The array of the public tags set on the user object.
 	 * They can be treated as server-based cookies.
 	 * You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
 	 * And then you can check for the tags
 	 */
-	core_public_tags: string[]
+	core_public_tags: string[];
 	/** The ID of the current level of the user */
-	ach_level_current_id?: number
+	ach_level_current_id?: number;
 	/** The indicator if user is marked as test user */
-	core_is_test_account?: boolean
+	core_is_test_account?: boolean;
 	/** The URL to the user avatar */
-	avatar_url?: string
+	avatar_url?: string;
 	/** The username of current user */
-	public_username?: string
+	public_username?: string;
 	/** THe number of unread inbox messages */
-	core_inbox_unread_count?: number
+	core_inbox_unread_count?: number;
 }
 
 /**
@@ -145,34 +147,34 @@ export interface TUserProfile {
  */
 export interface TLevel {
 	/** The ID of the Level */
-	id: number
+	id: number;
 	/** The name of the Level, translated to the user language */
-	name: string
+	name: string;
 	/** The description of the Level, translated to the user language */
-	description: string
+	description: string;
 	/** The URL of the image of the Level */
-	image: string
+	image: string;
 	/** The amount of points required to reach the Level */
-	required_points: number
+	required_points: number;
 	/** Number of points that user should collect in order to see this level */
-	visibility_points: number
+	visibility_points: number;
 	/**
 	 * The counter of 1st metric used to reach the Level.
 	 * Relevant in case of using advanced leveling logic
 	 * https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
 	 *
 	 */
-	required_level_counter_1: number
+	required_level_counter_1: number;
 	/**
 	 * The counter of 2nd metric used to reach the Level.
 	 * Relevant in case of using advanced leveling logic
 	 * https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
 	 *
 	 */
-	required_level_counter_2: number
+	required_level_counter_2: number;
 
 	/** The custom data of the Level defined by operator in the BackOffice. Can be a JSON object, string or number */
-	custom_data: string
+	custom_data: string;
 }
 
 /**
@@ -181,105 +183,105 @@ export interface TLevel {
 
 export interface TTournament {
 	/** ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run */
-	instance_id: number
+	instance_id: number;
 	/** ID of tournament template */
-	tournament_id: number
+	tournament_id: number;
 	/** Name of the tournament, translated to the user language */
-	name: string
+	name: string;
 	/** Description of the tournament, translated to the user language */
-	description: string
+	description: string;
 	/* 1st image URL representing the tournament */
-	image1: string
+	image1: string;
 	/* 2nd image URL representing the tournament */
-	image2: string
+	image2: string;
 	/* 2nd image URL representing the tournament for mobile */
-	image2_mobile: string
+	image2_mobile: string;
 	/* The message indicating the prize pool of the tournament */
-	prize_pool_short: string
+	prize_pool_short: string;
 	/* The message indicating the price to register in the tournament */
-	custom_price_text: string
+	custom_price_text: string;
 
 	/** The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS  */
-	segment_dont_match_message: string
+	segment_dont_match_message: string;
 	/**
 	 * The ID of the custom section where the tournament is assigned
 	 * The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
 	 */
-	custom_section_id: number
+	custom_section_id: number;
 	/** The custom data of the tournament defined by operator. Can be a JSON object, string or number */
-	custom_data: any
+	custom_data: any;
 
 	/** The indicator if the tournament is 'Featured' */
-	is_featured: boolean
+	is_featured: boolean;
 
 	/** The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
-	ribbon: TRibbon
+	ribbon: TRibbon;
 
 	/** A number is used to order the tournaments, representing their priority in the list  */
-	priority: number
+	priority: number;
 	/** Info about current player in tournament */
 	me?: {
 		/** The username of the participant */
-		public_username: string
+		public_username: string;
 		/** The URL to the avatar of the participant */
-		avatar_url: string
+		avatar_url: string;
 		/** The position of the participant in the tournament */
-		position: number
+		position: number;
 		/** The scores of the participant in the tournament */
-		scores: number
-	}
+		scores: number;
+	};
 	/** Prize structure */
 	prizes?: {
 		/** The name of the prize */
-		name: string
+		name: string;
 		/** The description of the prize */
-		description: string
+		description: string;
 		/** The image of the prize */
-		image_url: string
+		image_url: string;
 		/** from-to range of the places to which this prize */
-		place_from: number
-		place_to: number
+		place_from: number;
+		place_to: number;
 		/** type of the prize: TANGIBLE, POINTS_ADD, POINTS_DEDUCT, POINTS_RESET, MINI_GAME_ATTEMPT, BONUS */
-		type: string
+		type: string;
 		/** if the prize is points related, indicates amount of points */
-		points?: number
-	}[]
+		points?: number;
+	}[];
 
 	/** The time when tournament is going to start, epoch with milliseconds */
-	start_time: number
+	start_time: number;
 	/** The time when tournament is going to finish, epoch with milliseconds */
-	end_time: number
+	end_time: number;
 	/** Type of registration in the tournament */
-	registration_type: TournamentRegistrationTypeName
+	registration_type: TournamentRegistrationTypeName;
 	/** Number of users registered in the tournament */
-	registration_count: number
+	registration_count: number;
 	/** flag indicating if current user is registered in the tournament */
-	is_user_registered: boolean
+	is_user_registered: boolean;
 	/** Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start */
-	players_min_count: number
+	players_min_count: number;
 	/** Maximum number of participant for this tournament. When reached, new users won't be able to register */
-	players_max_count: number
+	players_max_count: number;
 	/** Status of registration in the tournament for current user */
-	registration_status: TournamentRegistrationStatusName
+	registration_status: TournamentRegistrationStatusName;
 	/** Tournament duration in millisecnnds */
-	duration_ms: number
+	duration_ms: number;
 
 	/** Cost of registration in the tournament in gamification points */
-	registration_cost_points: number
+	registration_cost_points: number;
 
 	/** Indicator if tournament instance is active, means in one of the statues -  PUBLISHED, REGISTED, STARTED */
-	is_active: boolean
+	is_active: boolean;
 
 	/** Indicator if user can register in this tournament instance, e.g tournament is active, max users is not reached, user is not registered yet */
-	is_can_register: boolean
+	is_can_register: boolean;
 	/** Indicator if tournament instance is cancelled (status CANCELLED) */
-	is_cancelled: boolean
+	is_cancelled: boolean;
 	/** Indicator if tournament instance is finished (status FINISHED, CANCELLED OR FINIALIZING) */
-	is_finished: boolean
+	is_finished: boolean;
 	/** Indicator if tournament instance is running (status STARTED) */
-	is_in_progress: boolean
+	is_in_progress: boolean;
 	/** Indicator if tournament instance is upcoming (status PUBLISHED or REGISTER) */
-	is_upcoming: boolean
+	is_upcoming: boolean;
 }
 
 /**
@@ -287,47 +289,47 @@ export interface TTournament {
  */
 export interface TTournamentDetailed extends TTournament {
 	/** List of casino games (or other types of entities) related to the tournament */
-	related_games?: AchRelatedGame[]
+	related_games?: AchRelatedGame[];
 	/** The list of the tournament participants */
 	players?: {
 		/** The username of the participant */
-		public_username: string
+		public_username: string;
 		/** The URL to the avatar of the participant */
-		avatar_url: string
+		avatar_url: string;
 		/** The position of the participant in the tournament */
-		position: number
+		position: number;
 		/** The scores of the participant in the tournament */
-		scores: number
+		scores: number;
 		/** The indicator if the participant is current user */
-		is_me: boolean
-	}[]
+		is_me: boolean;
+	}[];
 	/** The information about current user in the tournament if he is registered in the tournamnet */
 	me?: {
 		/** The username of the current user */
-		public_username: string
+		public_username: string;
 		/** The URL to the avatar of the current user */
-		avatar_url: string
+		avatar_url: string;
 		/** The position of the current user in the tournament */
-		position: number
+		position: number;
 		/** The scores of the current user in the tournament */
-		scores: number
-	}
+		scores: number;
+	};
 
 	prizes?: {
 		/** The name of the prize */
-		name: string
+		name: string;
 		/** The description of the prize */
-		description: string
+		description: string;
 		/** The image of the prize */
-		image_url: string
+		image_url: string;
 		/** from-to range of the places to which this prize */
-		place_from: number
-		place_to: number
+		place_from: number;
+		place_to: number;
 		/** type of the prize: TANGIBLE, POINTS_ADD, POINTS_DEDUCT, POINTS_RESET, MINI_GAME_ATTEMPT, BONUS */
-		type: string
+		type: string;
 		/** if the prize is points related, indicates amount of points */
-		points?: number
-	}[]
+		points?: number;
+	}[];
 }
 
 /**
@@ -335,11 +337,11 @@ export interface TTournamentDetailed extends TTournament {
  */
 export interface TStoreCategory {
 	/**ID of the store category */
-	id: number
+	id: number;
 	/**Name of the store category */
-	name: string
+	name: string;
 	/**Order of the store category among other categories. Default value is 1 */
-	order: number
+	order: number;
 }
 
 /**
@@ -347,49 +349,49 @@ export interface TStoreCategory {
  */
 export interface TStoreItem {
 	/** ID of the store item  */
-	id: number
+	id: number;
 	/** Name of the store item, translated to the user language */
-	name: string
+	name: string;
 	/** Description of the store item, translated to the user language */
-	description: string
+	description: string;
 	/** URL of the image of the store item */
-	image: string
+	image: string;
 	/** Type of the store item. Can be 'bonus' or 'tangible' or different others. */
-	type: 'bonus' | 'tangible' | 'minigamespin' | 'changelevel' | 'prizedrop' | 'unknown'
+	type: 'bonus' | 'tangible' | 'minigamespin' | 'changelevel' | 'prizedrop' | 'unknown';
 	/** The price of the store item in the gamification points */
-	price: number
+	price: number;
 	/** The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
-	ribbon: TRibbon
+	ribbon: TRibbon;
 	/** 
      *  The message that should be shown to the user if he is not eligible to buy it. this message can be used to explain the reason why user cannot buy the item, e.g. 'You should be VIP to buy this item' and can be used in case can_buy property is false.
         The message is translated to the user language.
         **Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
     */
-	limit_message: string
+	limit_message: string;
 	/** The priority of the store item. Can be used to sort the items in the store */
-	priority: number
+	priority: number;
 	/** The list of IDs of the related items. Can be used to show the related items in the store */
-	related_item_ids: number[]
+	related_item_ids: number[];
 	/** The indicator if the user can buy the item
 	 *  This indicator is taking into account the segment conditions for the store item, the price of item towards users balance,
 	 */
-	can_buy: boolean
+	can_buy: boolean;
 	/** The list of IDs of the categories where the store item is assigned, information about categories can be retrieved with getStoreCategories method */
-	category_ids: number[]
+	category_ids: number[];
 	/** Number of items in the pool avaliable for the purchase.*/
-	pool?: number
+	pool?: number;
 	/** The T&C text for the store item */
-	hint_text?: string
+	hint_text?: string;
 	/** Purchase time to show in purchase history screen */
-	purchase_ts?: number
+	purchase_ts?: number;
 	/** The amount of points you can purchase an item */
-	purchase_points_amount?: number
+	purchase_points_amount?: number;
 	/** Flag for store item indicating that it was purchased today */
-	purchased_today?: boolean
+	purchased_today?: boolean;
 	/** Flag for store item indicating that it was purchased this week  */
-	purchased_this_week?: boolean
+	purchased_this_week?: boolean;
 	/** Flag for store item indicating that it was purchased this month  */
-	purchased_this_month?: boolean
+	purchased_this_month?: boolean;
 }
 
 /**
@@ -397,11 +399,11 @@ export interface TStoreItem {
  */
 export interface TAchCategory {
 	/**ID of the badge category */
-	id: number
+	id: number;
 	/**Name of the badge category */
-	name: string
+	name: string;
 	/**Order of the badge category among other categories. Default value is 1 */
-	order: number
+	order: number;
 }
 
 /**
@@ -409,117 +411,117 @@ export interface TAchCategory {
  */
 export interface TMissionOrBadge {
 	/** ID of the mission or badge  */
-	id: number
+	id: number;
 	/** Type of entity. Can be 'mission' or 'badge' */
-	type: 'mission' | 'badge'
+	type: 'mission' | 'badge';
 	/** Name of the mission or badge, translated to the user language */
-	name: string
+	name: string;
 	/** Description of the mission or badge, translated to the user language */
-	description: string
+	description: string;
 	/** Description of the mission reward if defined */
-	reward: string
+	reward: string;
 	/** URL of the image of the mission or badge */
-	image: string
+	image: string;
 	/** Indicator if the mission is completed or badge is granted */
-	is_completed: boolean
+	is_completed: boolean;
 	/** Indicator if the mission is locked. Means that it's visible to the user, but he cannot progress in it until it's unlocked.
 	 * Mission may optionally contain the explanation of what should be done to unlock it in the unlock_mission_description property
 	 */
-	is_locked: boolean
+	is_locked: boolean;
 	/** Optional explaination of what should be done to unlock the mission */
-	unlock_mission_description: string
+	unlock_mission_description: string;
 	/** Indicator if the mission requires opt-in. Means that user should explicitly opt-in to the mission in order to start progressing in it */
-	is_requires_optin: boolean
+	is_requires_optin: boolean;
 	/** Indicator if the user opted-in to the mission */
-	is_opted_in: boolean
+	is_opted_in: boolean;
 	/** The amount of time in milliseconds that user has to complete the mission */
-	time_limit_ms: number
+	time_limit_ms: number;
 	/** The date when the mission was started, relevant for the time limited missions */
-	dt_start: number
+	dt_start: number;
 	/** The progress of the mission in percents calculated as the aggregated relative percentage of all tasks */
-	progress: number
+	progress: number;
 	/**
 	 * The action that should be performed when user clicks on the mission or badge
 	 * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
 	 * The 'dp' function will handle the CTA and will execute it in the most safe way
 	 */
-	cta_action: string
+	cta_action: string;
 	/** The text of the CTA button, e.g. 'Make a deposit' */
-	cta_text: string
+	cta_text: string;
 	/**
 	 * The ID of the custom section where the mission or badge is assigned
 	 * The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
 	 */
-	custom_section_id: number
+	custom_section_id: number;
 	/** The indicator if the mission or badge is visible only in the custom section and should be hidden from the main overview of missions/badges */
-	only_in_custom_section: boolean
+	only_in_custom_section: boolean;
 	/** The custom data of the mission or badge defined by operator. Can be a JSON object, string or number */
-	custom_data: any
+	custom_data: any;
 
 	/** The list of tasks of the mission or badge */
-	tasks: TMissionOrBadgeTask[]
+	tasks: TMissionOrBadgeTask[];
 
 	/** List of casino games (or other types of entities) related to the mission or badge */
-	related_games?: AchRelatedGame[]
+	related_games?: AchRelatedGame[];
 
 	/** The list of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method */
-	category_ids: number[]
+	category_ids: number[];
 
 	/** The T&C text for the missions */
-	hint_text?: string
+	hint_text?: string;
 
 	/** Priority (or position) of the mission in the UI. Low value indicates higher position in the UI */
-	position?: number
+	position?: number;
 
 	/** The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
-	ribbon?: TRibbon
+	ribbon?: TRibbon;
 
 	/** ID of the completion fact from ach_completed or ach_completed_recurring tables */
-	ach_completed_id?: number
+	ach_completed_id?: number;
 
 	/** Flag from achievement if the mission prize will be given only after user claims it */
-	requires_prize_claim?: boolean
+	requires_prize_claim?: boolean;
 
 	/** The date/timestamp indicating when the prize was claimed by the user */
-	prize_claimed_date_ts?: number
+	prize_claimed_date_ts?: number;
 
 	/** Time in hours that took this player to complete mission */
-	complete_date?: string
+	complete_date?: string;
 
 	/** Time of mission/badge being completed, this property shows the epoch time in UTC */
-	complete_date_ts?: number
+	complete_date_ts?: number;
 
 	/** Flag for mission/badge indicating that mission/badge completed today */
-	completed_today?: boolean
+	completed_today?: boolean;
 
 	/** Flag for mission/badge indicating that mission/badge completed this week */
-	completed_this_week?: boolean
+	completed_this_week?: boolean;
 
 	/** Flag for mission/badge indicating that mission/badge completed this month */
-	completed_this_month?: boolean
+	completed_this_month?: boolean;
 
 	/** ID of specific Custom Section type */
-	custom_section_type_id?: number
+	custom_section_type_id?: number;
 }
 
 export interface AchRelatedGame {
 	/** The ID of the related game */
-	ext_game_id: string
+	ext_game_id: string;
 	/** Game public meta information */
 	game_public_meta: {
 		/** The name of the game */
-		name: string
+		name: string;
 		/** The URL to the game */
-		link: string
+		link: string;
 		/** The URL to the image of the game */
-		image: string
+		image: string;
 		/** The indicator if the game is enabled */
-		enabled: boolean
+		enabled: boolean;
 		/** The list of categories of the game */
-		game_categories: string[]
+		game_categories: string[];
 		/** The name of the game provider */
-		game_provider: string
-	}
+		game_provider: string;
+	};
 }
 
 /**
@@ -527,19 +529,19 @@ export interface AchRelatedGame {
  */
 export interface TMissionOrBadgeTask {
 	/** ID of the task */
-	id: number
+	id: number;
 	/** Name of the task, translated to the user language */
-	name: string
+	name: string;
 	/** Indicator if the task is completed */
-	is_completed: boolean
+	is_completed: boolean;
 	/** The progress of the task in percents */
-	progress: number
+	progress: number;
 	/** Reward for completing the task in points */
-	points_reward: number
+	points_reward: number;
 	/** This is the total number of times the user needs to execute to complete task. e.g. he needs to bet 100 times. Here will be 100 */
-	execution_count_expected?: number
+	execution_count_expected?: number;
 	/** This is the number of times the user has executed 'activity' of the task. e.g. he bet 5 times out of 100. Here will be 5 */
-	execution_count_actual?: number
+	execution_count_actual?: number;
 }
 
 /**
@@ -547,9 +549,9 @@ export interface TMissionOrBadgeTask {
  */
 export interface TMissionOptInResult {
 	/** Error code that represents outcome of the opt-in request. Successful opt-in in case err_code is 0 */
-	err_code: number
+	err_code: number;
 	/** Optional error message */
-	err_message: string
+	err_message: string;
 }
 
 /**
@@ -557,138 +559,169 @@ export interface TMissionOptInResult {
  */
 export interface TMissionClaimRewardResult {
 	/** Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0 */
-	err_code: number
+	err_code: number;
 	/** Optional error message */
-	err_message: string
+	err_message: string;
 }
 
 export interface TTournamentRegistrationResult {
 	/** Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0 */
-	err_code: TournamentRegistrationError
+	err_code: TournamentRegistrationError;
 	/** Optional error message */
-	err_message: string
+	err_message: string;
 }
 
 export interface TBuyStoreItemResult {
 	/** Error code representing the result of the purchase of the shop item. Successful purchase if err_code is 0 */
-	err_code: BuyStoreItemErrorCode
+	err_code: BuyStoreItemErrorCode;
 	/** Optional error message */
-	err_message: string
+	err_message: string;
 }
 
 export interface TGetTranslations {
-	translations: { [key: string]: string }
+	translations: { [key: string]: string };
 }
 
 export interface TInboxMessage {
 	/** Uniq identifier of the message. It is needed to request the message body, mark the message as read/deleted/favorite. */
-	message_guid: string
+	message_guid: string;
 	/** Date when the message was sent */
-	sent_date: string
+	sent_date: string;
 	/** Indicator if a message is read */
-	read: boolean
+	read: boolean;
 	/** Indicator if a message is added to favorites */
-	favorite: boolean
+	favorite: boolean;
 }
 
 export interface TInboxMessageBody {
 	/** Message title */
-	title: string
+	title: string;
 	/** Short preview body of the message */
-	preview_body: string
+	preview_body: string;
 	/** Message icon */
-	icon: string
+	icon: string;
 	/** The action that should be performed when user clicks on the message.
 	 * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
 	 * The 'dp' function will handle the CTA and will execute it in the most safe way.
 	 * If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered. */
-	action: string
+	action: string;
 	/** Rich HTML body of the message. */
-	html_body?: string
+	html_body?: string;
 	/** Optional additional buttons to show in the message, available only if message has rich HTML body. Max count - 2. */
 	buttons?: {
 		/** The action that should be performed when user clicks on the button. The logic is the same as for message actions */
-		action: string
+		action: string;
 		/** Button text */
-		text: string
-	}[]
+		text: string;
+	}[];
 }
 
 export interface InboxMarkMessageAction {
 	/** An error code representing the result of marking a message as deleted, favorite or read. Successful marking action if err_code is 0 */
-	err_code: number
+	err_code: number;
 	/** Optional error message */
-	err_message: string
+	err_message: string;
 }
 
 export interface LeaderBoardDetailsT {
 	/** ID of the leaderboard */
-	board_id: number
+	board_id: number;
 	/** Name of the leaderboard */
-	name: string
+	name: string;
 	/** Description of the leaderboard */
-	description: string
+	description: string;
 	/** Rules of the leaderboard */
-	rules: string
+	rules: string;
 	/** Leaderboard period type ID */
-	period_type_id: LeaderBoardPeriodType
+	period_type_id: LeaderBoardPeriodType;
 	/** Leaderboard points rewards */
-	rewards: LeaderBoardsRewardsT[]
+	rewards: LeaderBoardsRewardsT[];
 	/** Leaderboard users */
-	users: LeaderBoardUserT[]
+	users: LeaderBoardUserT[];
 	/** Info about current user in leaderboard */
-	me?: LeaderBoardUserT
+	me?: LeaderBoardUserT;
 }
 
 export interface LeaderBoardsRewardsT {
-	place: number
-	points: number
+	place: number;
+	points: number;
 }
 
 export interface LeaderBoardUserT {
 	/** The username of the participant */
-	public_username: string
+	public_username: string;
 	/** The URL to the avatar of the participant */
-	avatar_url: string
+	avatar_url: string;
 	/** The position of the participant in the leaderboard */
-	position: number
+	position: number;
 	/** The points of the participant in the leaderboard */
-	points: number
+	points: number;
 	/** The indicator if the participant is current user */
-	is_me: boolean
+	is_me: boolean;
 }
 
 export interface UserLevelExtraCountersT {
 	/** The counter of 1st metric used to reach the level. */
-	level_counter_1?: number
+	level_counter_1?: number;
 	/** The counter of 2nd metric used to reach the level. */
-	level_counter_2?: number
+	level_counter_2?: number;
 }
 
 export interface TSegmentCheckResult {
-	segment_id: number
-	is_matching: boolean
+	segment_id: number;
+	is_matching: boolean;
 }
 
 export interface TUICustomSection {
 	/** The body of the custom section */
-	body?: string
+	body?: string;
 	/** The image of the custom section */
-	menu_img?: string
+	menu_img?: string;
 	/** The name of the custom section */
-	menu_name?: string
+	menu_name?: string;
 	/** Custom images for custom section */
-	custom_skin_images?: string
+	custom_skin_images?: string;
 	/** The particular type of custom section, can be Missions, Tournaments, Lootbox and etc */
-	section_type_id?: AchCustomSectionType
+	section_type_id?: AchCustomSectionType;
 	/** Theme of the custom section */
-	theme?: AchCustomLayoutTheme
+	theme?: AchCustomLayoutTheme;
 	/** Custom css for the custom section */
-	generic_custom_css?: string
+	generic_custom_css?: string;
 	/** Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs */
-	mission_tabs_options?: AchMissionsTabsOptions
+	mission_tabs_options?: AchMissionsTabsOptions;
 	/** Filter that allow to show missions by criteria */
-	overview_missions_filter?: AchOverviewMissionsFilter
+	overview_missions_filter?: AchOverviewMissionsFilter;
 	/** Quantity of missions to be shown in overview */
-	overview_missions_count?: number
+	overview_missions_count?: number;
+}
+
+export interface TBonus {
+	/** ID of the bonus */
+	bonus_id: number;
+	/** Can the bonus be redeemed (if bonus is redeemable the user needs to claim it) */
+	is_redeemable?: boolean;
+	/** Date of creation */
+	create_date?: string;
+	/** Date of redemption */
+	redeem_date?: string;
+	/** ID of template used */
+	label_bonus_template_id?: number;
+	/** ID of the bonus status */
+	bonus_status_id?: BonusStatus;
+	/** Additional information about the bonus(edscription, image,name, acknowledge) */
+	label_bonus_template_meta_map?: BonusTemplateMetaMap;
+	/** Additional information presented to the player when the bonus is redeemed */
+	bonus_meta_map?: BonusMetaMap;
+}
+
+/**
+ * TClaimBonusResult describes the response of call to _smartico.api.claimBonus(bonus_id) method
+ */
+export interface TClaimBonusResult {
+	/** Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0 */
+	err_code: SAWSpinErrorCode;
+	/** Optional error message */
+	err_message: string;
+	/** If the bonus was claimed successfully, then success is true */
+	success?: boolean;
 }