@smartico/public-api 0.0.316 → 0.0.317

package/docs/classes/WSAPI.md

@@ -743,7 +743,9 @@ ___
 ▸ **getInboxMessages**(`params?`): `Promise`\<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
 
 Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched.
-The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
+The maximum number of messages per request is limited to 20.
+An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
+An indicator "read_status" can be passed to get only messages marked as read or unread.
 You can leave this params empty and by default it will return list of messages ranging from 0 to 20.
 This functions return list of messages without the body of the message.
 To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
@@ -761,6 +763,7 @@ The "onUpdate" callback will be triggered when the user receives a new message.
 | `params.to?` | `number` |
 | `params.onlyFavorite?` | `boolean` |
 | `params.categoryId?` | [`InboxCategories`](../enums/InboxCategories.md) |
+| `params.read_status?` | `InboxReadStatus` |
 | `params.onUpdate?` | (`data`: [`TInboxMessage`](../interfaces/TInboxMessage.md)[]) => `void` |
 
 #### Returns

package/package.json

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

package/src/Inbox/GetInboxMessagesRequest.ts

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

package/src/Inbox/InboxReadStatus.ts

@@ -0,0 +1,4 @@
+export enum InboxReadStatus {
+	UnreadOnly = 1,
+	ReadOnly = 2,
+}

package/src/Inbox/index.ts

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

package/src/SmarticoAPI.ts

@@ -34,6 +34,7 @@ import {
 	InboxMessageBody,
 	InboxMessageBodyTransform,
 	InboxMessagesTransform,
+	InboxReadStatus,
 	MarkInboxMessageDeletedRequest,
 	MarkInboxMessageDeletedResponse,
 	MarkInboxMessageReadRequest,
@@ -1091,6 +1092,7 @@ class SmarticoAPI {
 		offset: number = 0,
 		starred_only: boolean,
 		category_id?: InboxCategories,
+		read_status?: InboxReadStatus,
 	): Promise<GetInboxMessagesResponse> {
 		const message = this.buildMessage<GetInboxMessagesRequest, GetInboxMessagesResponse>(
 			user_ext_id,
@@ -1100,6 +1102,7 @@ class SmarticoAPI {
 				offset,
 				starred_only,
 				category_id,
+				read_status,
 			},
 		);
 		return await this.send<GetInboxMessagesResponse>(message, ClassId.GET_INBOX_MESSAGES_RESPONSE);
@@ -1111,11 +1114,12 @@ class SmarticoAPI {
 		to: number = 20,
 		favoriteOnly: boolean = false,
 		categoryId?: InboxCategories,
+		read_status?: InboxReadStatus,
 	): Promise<TInboxMessage[]> {
 		const limit = to - from > 20 ? 20 : to - from;
 		const offset = from;
 
-		return InboxMessagesTransform((await this.getInboxMessages(user_ext_id, limit, offset, favoriteOnly, categoryId)).log);
+		return InboxMessagesTransform((await this.getInboxMessages(user_ext_id, limit, offset, favoriteOnly, categoryId, read_status)).log);
 	}
 
 	public async getInboxUnreadCountT(

package/src/WSAPI/WSAPI.ts

@@ -57,6 +57,7 @@ import {
 } from '../Raffle';
 import { IntUtils } from '../IntUtils';
 import { TGetJackpotEligibleGamesResponse } from '../Jackpots/GetJackpotEligibleGamesResponse';
+import { InboxReadStatus } from '../Inbox/InboxReadStatus';
 
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -800,7 +801,9 @@ export class WSAPI {
 	}
 
 	/** Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched.
-	 * The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
+	 * The maximum number of messages per request is limited to 20. 
+	 * An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
+	 * An indicator "read_status" can be passed to get only messages marked as read or unread.
 	 * You can leave this params empty and by default it will return list of messages ranging from 0 to 20.
 	 * This functions return list of messages without the body of the message.
 	 * To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
@@ -816,18 +819,20 @@ export class WSAPI {
 		to,
 		onlyFavorite,
 		categoryId,
+		read_status,
 		onUpdate,
 	}: {
 		from?: number;
 		to?: number;
 		onlyFavorite?: boolean;
 		categoryId?: InboxCategories;
+		read_status?: InboxReadStatus;
 		onUpdate?: (data: TInboxMessage[]) => void;
 	} = {}): Promise<TInboxMessage[]> {
 		if (onUpdate) {
 			this.onUpdateCallback.set(onUpdateContextKey.InboxMessages, onUpdate);
 		}
-		return await this.api.getInboxMessagesT(null, from, to, onlyFavorite, categoryId);
+		return await this.api.getInboxMessagesT(null, from, to, onlyFavorite, categoryId, read_status);
 	}
 
 	/**