@smartico/public-api 0.0.186 → 0.0.188

package/docs/interfaces/TMiniGamePrize.md

@@ -141,3 +141,19 @@ ___
 ### relative\_period\_timezone
 
 • `Optional` **relative\_period\_timezone**: `number`
+
+___
+
+### out\_of\_stock\_message
+
+• `Optional` **out\_of\_stock\_message**: `string`
+
+Message when the prize pool is empty for that specific prize
+
+___
+
+### is\_surcharge
+
+• `Optional` **is\_surcharge**: `boolean`
+
+Flag indicating that the prize is surcharged (available all the time, despite pool numbers)

package/package.json

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

package/src/Inbox/InboxMessage.ts

@@ -2,21 +2,39 @@ import { TInboxMessageBody } from '../WSAPI/WSAPITypes';
 import { InboxMessageType } from './InboxMessageType';
 
 export interface InboxMessageBody {
+	// URL or deep-link that neeed to be executed when user clicks on the message
 	action: string;
+	// the body of the message in case it's 'simple' inbox message
 	body: string;
+	// type of message, deprecated
 	type: InboxMessageType;
+	// image of the icon
 	image: string;
+	// title of the message
 	title: string;
+	// HTML body of the message in case it's 'rich' inbox message
 	html_body: string;
+	// set of the buttons with text on the button and action that could be URL or deep-link
 	additional_buttons?: { inbox_cta_text: string; action: string }[];
+	// indicator if the message need to be shown when sent and overlay or it should be shown only in the inbox, when user open 'inbox' interface explicitly
+	// default is 'true'
+	show_preview?: boolean;
+	// duration in seconds for how long to show preview, default is 7 seconds
+	show_duration_sec?: number;
 }
 
 export interface InboxMessage {
+	// date when the message was created
 	createDate: string;
+	// body of the message according to the interface
 	body: InboxMessageBody;
+	// unique identifier of the message that connects it to the campaign from which it was sent
 	engagement_uid: string;
+	// flag that indicates if the message was read by the user
 	is_read: boolean;
+	// flag that indicates if the message was marked as favorite by the user
 	is_starred: boolean;
+	// flag that indicates if the message was deleted by the user. Such messages are not returned in the response and property is used only internaly in Smartico
 	is_deleted?: boolean;
 }
 

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -54,6 +54,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					acknowledge_action_title: p.saw_prize_ui_definition.acknowledge_action_title,
 					acknowledge_dp_additional: p.saw_prize_ui_definition.acknowledge_dp_additional,
 					acknowledge_action_title_additional: p.saw_prize_ui_definition.acknowledge_action_title_additional,
+					out_of_stock_message: p.saw_prize_ui_definition.out_of_stock_message,
 					pool: p.pool,
 					pool_initial: p.pool_initial,
 					wins_count: p.wins_count,
@@ -61,6 +62,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					active_from_ts: p.active_from_ts,
 					active_till_ts: p.active_till_ts,
 					relative_period_timezone: p.relative_period_timezone,
+					is_surcharge: p.is_surcharge,
 				};
 				return y;
 			}),

package/src/MiniGames/SAWPrize.ts

@@ -16,4 +16,5 @@ export interface SAWPrize {
 	active_from_ts?: number;
 	active_till_ts?: number;
 	relative_period_timezone?: number;
+	is_surcharge?: boolean;
 }

package/src/MiniGames/SAWPrizeUI.ts

@@ -18,4 +18,5 @@ export interface SAWPrizeUI {
 	replace_name_with_image?: boolean;
 	acknowledge_action_title?: string;
 	custom_win_sound?: string;
+	out_of_stock_message?: string;
 }

package/src/Store/StoreItem.ts

@@ -1,3 +1,4 @@
+import { IntUtils } from '../IntUtils';
 import { TStoreItem } from '../WSAPI/WSAPITypes';
 import { StoreItemPublicMeta } from './StoreItemPublicMeta';
 import { StoreItemType, StoreItemTypeNamed } from './StoreItemType';
@@ -30,6 +31,7 @@ export const StoreItemTransform = (items: StoreItem[]): TStoreItem[] => {
 				can_buy: r.canBuy,
 				category_ids: r.categoryIds ?? [],
 				pool: r.shopPool,
+				custom_data: IntUtils.JsonOrText(r.itemPublicMeta.custom_data),
 			};
 			return x;
 		});

package/src/Store/StoreItemPublicMeta.ts

@@ -9,4 +9,5 @@ export interface StoreItemPublicMeta {
 	priority: number;
 	related_items: number[];
 	hint_text: string;
+	custom_data: string;
 }

package/src/WSAPI/WSAPI.ts

@@ -510,7 +510,7 @@ export class WSAPI {
 	 *
 	 * **Visitor mode: not supported**
 	 */
-	public async playMiniGame(template_id: number, { onUpdate }: { onUpdate?: (data: TMissionOrBadge[]) => void } = {}): Promise<TMiniGamePlayResult> {
+	public async playMiniGame(template_id: number, { onUpdate }: { onUpdate?: (data: TMiniGameTemplate[]) => void } = {}): Promise<TMiniGamePlayResult> {
 
 		if (onUpdate) {
 			this.onUpdateCallback.set(onUpdateContextKey.Saw, onUpdate);

package/src/WSAPI/WSAPITypes.ts

@@ -41,6 +41,8 @@ export interface TMiniGamePrize {
 	acknowledge_dp_additional?: string;
 	/* The name of the action button in modal pop-up (additional) */
 	acknowledge_action_title_additional?: string;
+	/* Message when the prize pool is empty for that specific prize */
+	out_of_stock_message?: string;
 	/* Number of items in stock */
 	pool?: number;
 	/* Initial number of items in stock */
@@ -55,6 +57,8 @@ export interface TMiniGamePrize {
 	active_till_ts?: number;
 	/* Time zone to ensure each day aligns with your local midnight. */
 	relative_period_timezone?: number;
+	/* Flag indicating that the prize is surcharged (available all the time, despite pool numbers) */
+	is_surcharge?: boolean;
 }
 
 /**
@@ -412,6 +416,8 @@ export interface TStoreItem {
 	category_ids: number[];
 	/** Number of items in the pool avaliable for the purchase.*/
 	pool?: number;
+	/** The custom data of the store item defined by operator. Can be a JSON object, string or number */
+	custom_data: any;
 	/** The T&C text for the store item */
 	hint_text?: string;
 	/** Purchase time to show in purchase history screen */
@@ -494,6 +500,7 @@ export interface TMissionOrBadge {
 	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;
+
 	/** The custom data of the mission or badge defined by operator. Can be a JSON object, string or number */
 	custom_data: any;