@smartico/public-api 0.0.217 → 0.0.218

package/docs/classes/WSAPI.md

@@ -726,6 +726,7 @@ The "onUpdate" callback will be triggered when the user receives a new message.
 | `params.from?` | `number` |
 | `params.to?` | `number` |
 | `params.onlyFavorite?` | `boolean` |
+| `params.category_id?` | `InboxCategories` |
 | `params.onUpdate?` | (`data`: [`TInboxMessage`](../interfaces/TInboxMessage.md)[]) => `void` |
 
 #### Returns

package/docs/interfaces/TInboxMessage.md

@@ -31,3 +31,11 @@ ___
 • **favorite**: `boolean`
 
 Indicator if a message is added to favorites
+
+___
+
+### category_id
+
+• **category_id**: `InboxCategories`
+
+Category id per inbox message, can be part of System inboxes, Personal inboxes or General inbox messages

package/package.json

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

package/src/Inbox/GetInboxMessagesRequest.ts

@@ -1,7 +1,9 @@
+import { InboxCategories } from './InboxCategories';
 import { ProtocolMessage } from '../Base/ProtocolMessage';
 
 export interface GetInboxMessagesRequest extends ProtocolMessage {
 	limit?: number;
 	offset?: number;
 	starred_only?: boolean;
+	category_id?: InboxCategories;
 }

package/src/Inbox/GetInboxMessagesResponse.ts

@@ -13,6 +13,7 @@ export const InboxMessagesTransform = (items: InboxMessage[]): TInboxMessage[] =
 			message_guid: item.engagement_uid,
 			read: item.is_read,
 			favorite: item.is_starred,
+			category_id: item.category_id
 		};
 		return x;
 	});

package/src/Inbox/InboxCategories.ts

@@ -0,0 +1,5 @@
+export enum InboxCategories {
+    General = 0,
+	Platform = 1,
+	Personal = 2,
+}

package/src/Inbox/InboxMessage.ts

@@ -1,4 +1,5 @@
 import { TInboxMessageBody } from '../WSAPI/WSAPITypes';
+import { InboxCategories } from './InboxCategories';
 import { InboxMessageType } from './InboxMessageType';
 import { OpenLinksType } from './OpenLinksType';
 
@@ -42,6 +43,8 @@ export interface InboxMessage {
 	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;
+	// category id of the inbox message, could be categorized as System/Personal/General messages in mentioned tabs
+	category_id?: InboxCategories;
 }
 
 export const InboxMessageBodyTransform = (item: InboxMessageBody): TInboxMessageBody => {

package/src/Inbox/index.ts

@@ -9,3 +9,4 @@ export * from './MarkInboxMessageStarredResponse';
 export * from './MarkInboxMessageDeletedRequest';
 export * from './MarkInboxMessageDeletedResponse';
 export * from './OpenLinksType';
+export * from './InboxCategories';

package/src/SmarticoAPI.ts

@@ -123,6 +123,7 @@ import { GetRelatedAchTourRequest } from './Missions/GetRelatedAchTourRequest';
 import { GetRelatedAchTourResponse } from './Missions/GetRelatedAchTourResponse';
 import { GetRafflesResponse } from './Raffle/GetRafflesResponse';
 import { GetRafflesRequest } from './Raffle/GetRafflesRequest';
+import { InboxCategories } from './Inbox/InboxCategories';
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -971,6 +972,7 @@ class SmarticoAPI {
 		limit: number = 20,
 		offset: number = 0,
 		starred_only: boolean,
+		category_id?: InboxCategories,
 	): Promise<GetInboxMessagesResponse> {
 		const message = this.buildMessage<GetInboxMessagesRequest, GetInboxMessagesResponse>(
 			user_ext_id,
@@ -979,6 +981,7 @@ class SmarticoAPI {
 				limit,
 				offset,
 				starred_only,
+				category_id,
 			},
 		);
 		return await this.send<GetInboxMessagesResponse>(message, ClassId.GET_INBOX_MESSAGES_RESPONSE);
@@ -989,11 +992,12 @@ class SmarticoAPI {
 		from: number = 0,
 		to: number = 20,
 		favoriteOnly: boolean = false,
+		categoryId?: InboxCategories,
 	): Promise<TInboxMessage[]> {
 		const limit = to - from > 20 ? 20 : to - from;
 		const offset = from;
 
-		return InboxMessagesTransform((await this.getInboxMessages(user_ext_id, limit, offset, favoriteOnly)).log);
+		return InboxMessagesTransform((await this.getInboxMessages(user_ext_id, limit, offset, favoriteOnly, categoryId)).log);
 	}
 
 	public async getInboxMessageBody(messageGuid: string): Promise<InboxMessageBody> {

package/src/WSAPI/WSAPI.ts

@@ -52,6 +52,7 @@ import { GetTournamentsResponse } from '../Tournaments';
 import { GetAchievementMapResponse } from '../Missions';
 import { GetRelatedAchTourResponse } from 'src/Missions/GetRelatedAchTourResponse';
 import { GetRafflesResponse } from '../Raffle/GetRafflesResponse';
+import { InboxCategories } from '../Inbox/InboxCategories';
 
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -758,15 +759,15 @@ export class WSAPI {
 		from,
 		to,
 		onlyFavorite,
+		categoryId,
 		onUpdate,
-	}: { from?: number; to?: number; onlyFavorite?: boolean; onUpdate?: (data: TInboxMessage[]) => void } = {}): Promise<
+	}: { from?: number; to?: number; onlyFavorite?: boolean; categoryId?: InboxCategories, onUpdate?: (data: TInboxMessage[]) => void } = {}): Promise<
 		TInboxMessage[]
 	> {
 		if (onUpdate) {
 			this.onUpdateCallback.set(onUpdateContextKey.InboxMessages, onUpdate);
 		}
-
-		return await this.api.getInboxMessagesT(null, from, to, onlyFavorite);
+		return await this.api.getInboxMessagesT(null, from, to, onlyFavorite, categoryId);
 	}
 
 	/**

package/src/WSAPI/WSAPITypes.ts

@@ -6,6 +6,7 @@ import { LeaderBoardPeriodType } from '../Leaderboard';
 import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections';
 import { BonusStatus , BonusTemplateMetaMap, BonusMetaMap} from '../Bonuses';
 import { PrizeModifiers } from '../MiniGames/PrizeModifiers';
+import { InboxCategories } from '../Inbox/InboxCategories';
 
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
@@ -686,6 +687,8 @@ export interface TInboxMessage {
 	read: boolean;
 	/** Indicator if a message is added to favorites */
 	favorite: boolean;
+	/** Category id per inbox message, can be part of System inboxes, Personal inboxes or General inbox messages */
+	category_id?: InboxCategories;
 }
 
 export interface TInboxMessageBody {