@smartico/public-api 0.0.185 → 0.0.187

package/docs/interfaces/TMissionOrBadge.md

@@ -109,6 +109,14 @@ Holds time from which mission will become available, for the missions that are t
 
 ___
 
+### active\_till\_ts
+
+• **active\_till\_ts**: `number`
+
+Holds time till mission will become unavailable, for the missions that are targeted to be available from specific date/time
+
+___
+
 ### dt\_start
 
 • **dt\_start**: `number`

package/docs/interfaces/TSawHistory.md

@@ -47,3 +47,19 @@ ___
 • **is\_claimed**: `boolean`
 
 Flag indicating to show whether prize in the mini-game claimed or not
+
+___
+
+### create\_date\_ts
+
+• **create\_date\_ts**: `number`
+
+Win prize date in milliseconds
+
+___
+
+### acknowledge\_date\_ts
+
+• **acknowledge\_date\_ts**: `number`
+
+Claim prize date in milliseconds

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@smartico/public-api",
-	"version": "0.0.185",
+	"version": "0.0.187",
 	"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/SAWWinningHistoryResponse.ts

@@ -13,6 +13,8 @@ export interface SAWPrizesHistory {
 	prize_amount: number,
 	client_request_id: string,
 	is_claimed: boolean,
+	create_date_ts: number;
+	acknowledge_date_ts: number;
 }
 
 export const SAWHistoryTransform = (items: SAWPrizesHistory[]): TSawHistory[] => {
@@ -23,7 +25,9 @@ export const SAWHistoryTransform = (items: SAWPrizesHistory[]): TSawHistory[] =>
 			saw_prize_id: r.saw_prize_id,
 			prize_amount: r.prize_amount,
 			client_request_id: r.client_request_id,
-			is_claimed: r.is_claimed
+			is_claimed: r.is_claimed,
+			create_date_ts: r.create_date_ts,
+			acknowledge_date_ts: r.acknowledge_date_ts,
 		}
 		return x;
 	})

package/src/Missions/UserAchievement.ts

@@ -30,6 +30,7 @@ export interface UserAchievement {
 	scheduledMissionType?: ScheduledMissionType;
 	related_games?: AchRelatedGame[];
 	active_from_ts?: number; // indicates when 'scheduled' mission is active from,
+	active_till_ts?: number; // indicates when 'scheduled' mission is active till,
 	ach_categories?: number[];
 
 	ach_completed_id?: number; // ID of the completion fact from ach_completed or ach_completed_recurring tables
@@ -63,6 +64,7 @@ export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBa
 				is_opted_in: r.isOptedIn,
 				time_limit_ms: r.time_limit_ms,
 				active_from_ts: r.active_from_ts,
+				active_till_ts: r.active_from_ts,
 				dt_start: r.start_date_ts,
 				reward: r.ach_public_meta.reward,
 				progress: r.progress,

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

@@ -412,6 +412,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 */
@@ -471,6 +473,9 @@ export interface TMissionOrBadge {
 
 	/** Holds time from which mission will become available, for the missions that are targeted to be available from specific date/time */
 	active_from_ts: number;
+	
+	/** Holds time till mission will become unavailable, for the missions that are targeted to be available from specific date/time */
+	active_till_ts: number;
 
 	/** The date when the mission was started, relevant for the time limited missions */
 	dt_start: number;
@@ -491,6 +496,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;
 
@@ -775,4 +781,8 @@ export interface TSawHistory {
 	client_request_id: string,
 	/** Flag indicating to show whether prize in the mini-game claimed or not */
 	is_claimed: boolean,
+	/** Win prize date in milliseconds */
+	create_date_ts: number;
+	/** Claimed prize date in milliseconds */
+	acknowledge_date_ts: number;
 }