@smartico/public-api 0.0.324 → 0.0.325

package/docs/classes/WSAPI.md

@@ -920,6 +920,72 @@ Requests translations for the given language. Returns the object including trans
 
 ___
 
+### reportImpressionEvent
+
+▸ **reportImpressionEvent**(`«destructured»`): `void`
+
+Reports an impression event for an engagement (when engagement content is displayed to the user).
+Use this method to track when users view engagement content such as inbox messages, popups.
+When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType.
+
+**Example**:
+```
+_smartico.api.reportImpressionEvent({
+     engagement_uid: 'abc123-def456',
+     activityType: 31 // Inbox
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `engagement_uid` | `string` |
+| › `activityType` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### reportClickEvent
+
+▸ **reportClickEvent**(`«destructured»`): `void`
+
+Reports a click/action event for an engagement (when user interacts with engagement content).
+Use this method to track when users click on or interact with engagement content such as inbox messages, popups.
+When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType, and pass the action/deeplink that was triggered by the user interaction as action.
+
+**Example**:
+```
+_smartico.api.reportClickEvent({
+     engagement_uid: 'abc123-def456',
+     activityType: 31 // Inbox,
+     action: 'dp:gf_missions'
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `engagement_uid` | `string` |
+| › `activityType` | `number` |
+| › `action?` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
 ### jackpotGet
 
 ▸ **jackpotGet**(`filter?`): `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>

package/package.json

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

package/src/SmarticoAPI.ts

@@ -19,6 +19,7 @@ import {
 } from './MiniGames';
 import { ECacheContext, OCache } from './OCache';
 import {
+	ActivityTypeLimited,
 	CoreUtils,
 	GetTranslationsRequest,
 	GetTranslationsResponse,
@@ -460,6 +461,40 @@ class SmarticoAPI {
 		return results.segments || [];
 	}
 
+	/**
+	 * Reports an engagement impression event (when engagement content is displayed to the user).
+	 */
+	public reportEngagementImpression(
+		user_ext_id: string,
+		engagement_uid: string,
+		activityType: ActivityTypeLimited | number,
+	): void {
+		const message = this.buildMessage<any, any>(user_ext_id, ClassId.CLIENT_ENGAGEMENT_IMPRESSION_REQUEST, {
+			engagement_uid,
+			activityType,
+		});
+
+		this.send(message).catch(() => {});
+	}
+
+	/**
+	 * Reports an engagement action event (when user clicks/interacts with engagement content).
+	 */
+	public reportEngagementAction(
+		user_ext_id: string,
+		engagement_uid: string,
+		activityType: ActivityTypeLimited | number,
+		action?: string,
+	): void {
+		const message = this.buildMessage<any, any>(user_ext_id, ClassId.CLIENT_ENGAGEMENT_ACTION_REQUEST, {
+			engagement_uid,
+			activityType,
+			...(action && { action }),
+		});
+
+		this.send(message).catch(() => {});
+	}
+
 	public async jackpotGet(
 		user_ext_id: string,
 		filter?: { related_game_id?: string; jp_template_id?: number },

package/src/WSAPI/WSAPI.ts

@@ -1,5 +1,5 @@
 import { ClassId } from '../Base/ClassId';
-import { CoreUtils } from '../Core';
+import { ActivityTypeLimited, CoreUtils } from '../Core';
 import {
 	SAWSpinsCountPush,
 } from '../MiniGames';
@@ -945,6 +945,67 @@ export class WSAPI {
 		};
 	}
 
+	/**
+	 * Reports an impression event for an engagement (when engagement content is displayed to the user).
+	 * Use this method to track when users view engagement content such as inbox messages, popups.
+	 * When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType.
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.reportImpressionEvent({
+	 *      engagement_uid: 'abc123-def456',
+	 *      activityType: 31 // Inbox
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 *
+	 * @param params.engagement_uid - Unique identifier for the engagement
+	 * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
+	 */
+	public reportImpressionEvent({
+		engagement_uid,
+		activityType,
+	}: {
+		engagement_uid: string;
+		activityType: ActivityTypeLimited | number;
+	}): void {
+		this.api.reportEngagementImpression(null, engagement_uid, activityType);
+	}
+
+	/**
+	 * Reports a click/action event for an engagement (when user interacts with engagement content).
+	 * Use this method to track when users click on or interact with engagement content such as inbox messages, popups.
+	 * When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType, and pass the action/deeplink that was triggered by the user interaction as action.
+	 * 
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.reportClickEvent({
+	 *      engagement_uid: 'abc123-def456',
+	 *      activityType: 31 // Inbox,
+	 *      action: 'dp:gf_missions'
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 *
+	 * @param params.engagement_uid - Unique identifier for the engagement
+	 * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
+	 * @param params.action - Optional action/deeplink that was triggered by the user interaction
+	 */
+	public reportClickEvent({
+		engagement_uid,
+		activityType,
+		action,
+	}: {
+		engagement_uid: string;
+		activityType: ActivityTypeLimited | number;
+		action?: string;
+	}): void {
+		this.api.reportEngagementAction(null, engagement_uid, activityType, action);
+	}
+
 	private async updateOnSpin(data: SAWSpinsCountPush) {
 		const templates: TMiniGameTemplate[] = await OCache.use(
 			onUpdateContextKey.Saw,