@smartico/public-api 0.0.107 → 0.0.108

package/docs/README.md

@@ -28,6 +28,9 @@
 - [TTournamentRegistrationResult](interfaces/TTournamentRegistrationResult.md)
 - [TBuyStoreItemResult](interfaces/TBuyStoreItemResult.md)
 - [TGetTranslations](interfaces/TGetTranslations.md)
+- [TInboxMessage](interfaces/TInboxMessage.md)
+- [TInboxMessageBody](interfaces/TInboxMessageBody.md)
+- [InboxMarkMessageAction](interfaces/InboxMarkMessageAction.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -16,19 +16,19 @@ ___
 
 ### getLevels
 
-▸ **getLevels**(): `Promise`\<[`TLevel`](../interfaces/TLevel.md)[]\>
+▸ **getLevels**(): `Promise`<[`TLevel`](../interfaces/TLevel.md)[]\>
 
 Returns all the levels available the current user
 
 #### Returns
 
-`Promise`\<[`TLevel`](../interfaces/TLevel.md)[]\>
+`Promise`<[`TLevel`](../interfaces/TLevel.md)[]\>
 
 ___
 
 ### getMissions
 
-▸ **getMissions**(`params?`): `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+▸ **getMissions**(`params?`): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
 #### Parameters
 
@@ -39,37 +39,37 @@ ___
 
 #### Returns
 
-`Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+`Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
 ___
 
 ### getBadges
 
-▸ **getBadges**(): `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+▸ **getBadges**(): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
 Returns all the badges available the current user
 
 #### Returns
 
-`Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+`Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
 ___
 
 ### getStoreItems
 
-▸ **getStoreItems**(): `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+▸ **getStoreItems**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
 
 Returns all the store items available the current user
 
 #### Returns
 
-`Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+`Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
 
 ___
 
 ### buyStoreItem
 
-▸ **buyStoreItem**(`item_id`): `Promise`\<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
+▸ **buyStoreItem**(`item_id`): `Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
 
 Buy the specific shop item by item_id. Returns the err_code.
 
@@ -81,25 +81,25 @@ Buy the specific shop item by item_id. Returns the err_code.
 
 #### Returns
 
-`Promise`\<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
+`Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
 
 ___
 
 ### getStoreCategories
 
-▸ **getStoreCategories**(): `Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+▸ **getStoreCategories**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
 
 Returns store categories
 
 #### Returns
 
-`Promise`\<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+`Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
 
 ___
 
 ### getMiniGames
 
-▸ **getMiniGames**(`params?`): `Promise`\<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+▸ **getMiniGames**(`params?`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
 
 /**
  *
@@ -113,13 +113,13 @@ ___
 
 #### Returns
 
-`Promise`\<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+`Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
 
 ___
 
 ### playMiniGame
 
-▸ **playMiniGame**(`template_id`): `Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
+▸ **playMiniGame**(`template_id`): `Promise`<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
 
 Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
 
@@ -131,13 +131,13 @@ Plays the specified by template_id mini-game on behalf of user and returns prize
 
 #### Returns
 
-`Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
+`Promise`<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
 
 ___
 
 ### requestMissionOptIn
 
-▸ **requestMissionOptIn**(`mission_id`): `Promise`\<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
+▸ **requestMissionOptIn**(`mission_id`): `Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
 
 Requests an opt-in for the specified mission_id. Returns the err_code.
 
@@ -149,13 +149,13 @@ Requests an opt-in for the specified mission_id. Returns the err_code.
 
 #### Returns
 
-`Promise`\<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
+`Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
 
 ___
 
 ### getTournamentsList
 
-▸ **getTournamentsList**(`params?`): `Promise`\<[`TTournament`](../interfaces/TTournament.md)[]\>
+▸ **getTournamentsList**(`params?`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
 
 #### Parameters
 
@@ -166,15 +166,15 @@ ___
 
 #### Returns
 
-`Promise`\<[`TTournament`](../interfaces/TTournament.md)[]\>
+`Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
 
 ___
 
 ### getTournamentInstanceInfo
 
-▸ **getTournamentInstanceInfo**(`tournamentInstanceId`): `Promise`\<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
+▸ **getTournamentInstanceInfo**(`tournamentInstanceId`): `Promise`<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
 
-Returns details information of specific tournament instance, the response will includ tournamnet info and the leaderboard of players
+Returns details information of specific tournament instance, the response will include tournament info and the leaderboard of players
 
 #### Parameters
 
@@ -184,13 +184,13 @@ Returns details information of specific tournament instance, the response will i
 
 #### Returns
 
-`Promise`\<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
+`Promise`<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
 
 ___
 
 ### registerInTournament
 
-▸ **registerInTournament**(`tournamentInstanceId`): `Promise`\<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
+▸ **registerInTournament**(`tournamentInstanceId`): `Promise`<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
 
 Requests registration for the specified tournament instance. Returns the err_code.
 
@@ -202,13 +202,130 @@ Requests registration for the specified tournament instance. Returns the err_cod
 
 #### Returns
 
-`Promise`\<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
+`Promise`<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
+
+___
+
+### getInboxMessages
+
+▸ **getInboxMessages**(`params?`): `Promise`<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.from?` | `number` |
+| `params.to?` | `number` |
+| `params.onlyFavorite?` | `boolean` |
+| `params.onUpdate?` | (`data`: [`TInboxMessage`](../interfaces/TInboxMessage.md)[]) => `void` |
+
+#### Returns
+
+`Promise`<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
+
+___
+
+### getInboxMessageBody
+
+▸ **getInboxMessageBody**(`messageGuid`): `Promise`<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
+
+Returns the message body of the specified message guid.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageGuid` | `string` |
+
+#### Returns
+
+`Promise`<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
+
+___
+
+### markInboxMessageAsRead
+
+▸ **markInboxMessageAsRead**(`messageGuid`): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to mark inbox message with specified guid as read
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageGuid` | `string` |
+
+#### Returns
+
+`Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+___
+
+### markAllInboxMessagesAsRead
+
+▸ **markAllInboxMessagesAsRead**(): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to mark all inbox messages as read
+
+#### Returns
+
+`Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+___
+
+### markUnmarkInboxMessageAsFavorite
+
+▸ **markUnmarkInboxMessageAsFavorite**(`messageGuid`, `mark`): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to mark inbox message with specified guid as favorite. Pass mark true to add message to favorite and false to remove.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageGuid` | `string` |
+| `mark` | `boolean` |
+
+#### Returns
+
+`Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+___
+
+### deleteInboxMessage
+
+▸ **deleteInboxMessage**(`messageGuid`): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to delete inbox message
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageGuid` | `string` |
+
+#### Returns
+
+`Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+___
+
+### deleteAllInboxMessages
+
+▸ **deleteAllInboxMessages**(): `Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to delete all inbox messages
+
+#### Returns
+
+`Promise`<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
 
 ___
 
 ### getTranslations
 
-▸ **getTranslations**(`lang_code`): `Promise`\<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
+▸ **getTranslations**(`lang_code`): `Promise`<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
 
 Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office.
 
@@ -220,4 +337,4 @@ Requests translations for the given language. Returns the object including trans
 
 #### Returns
 
-`Promise`\<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
+`Promise`<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>

package/docs/interfaces/InboxMarkMessageAction.md

@@ -0,0 +1,17 @@
+# Interface: InboxMarkMessageAction
+
+## Properties
+
+### err\_code
+
+• **err\_code**: `number`
+
+An error code representing the result of marking a message as deleted, favorite or read. Successful marking action if err_code is 0
+
+___
+
+### err\_message
+
+• **err\_message**: `string`
+
+Optional error message

package/docs/interfaces/TInboxMessage.md

@@ -0,0 +1,33 @@
+# Interface: TInboxMessage
+
+## Properties
+
+### message\_guid
+
+• **message\_guid**: `string`
+
+Uniq identifier of the message. It is needed to request the message body, mark the message as read/deleted/favorite.
+
+___
+
+### sent\_date
+
+• **sent\_date**: `string`
+
+Date when the message was sent
+
+___
+
+### read
+
+• **read**: `boolean`
+
+Indicator if a message is read
+
+___
+
+### favorite
+
+• **favorite**: `boolean`
+
+Indicator if a message is added to favorites

package/docs/interfaces/TInboxMessageBody.md

@@ -0,0 +1,52 @@
+# Interface: TInboxMessageBody
+
+## Properties
+
+### title
+
+• **title**: `string`
+
+Message title
+
+___
+
+### preview\_body
+
+• **preview\_body**: `string`
+
+Short preview body of the message
+
+___
+
+### icon
+
+• **icon**: `string`
+
+Message icon
+
+___
+
+### action
+
+• **action**: `string`
+
+The action that should be performed when user clicks on the message.
+Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
+The 'dp' function will handle the CTA and will execute it in the most safe way. 
+If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered.
+
+___
+
+### html\_body
+
+• `Optional` **html\_body**: `string`
+
+Rich HTML body of the message.
+
+___
+
+### buttons
+
+• `Optional` **buttons**: { `action`: `string` ; `text`: `string`  }[]
+
+Optional additional buttons to show in the message, available only if message has rich HTML body. Max count - 2.

package/docs/interfaces/TMissionOrBadge.md

@@ -122,7 +122,7 @@ ___
 • **cta\_action**: `string`
 
 The action that should be performed when user clicks on the mission or badge
-Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.do(cta_action);
+Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
 The 'dp' function will handle the CTA and will execute it in the most safe way
 
 ___

package/docs/interfaces/TTournament.md

@@ -134,7 +134,7 @@ ___
 
 ### prizes
 
-• `Optional` **prizes**: \{ `name`: `string` ; `description`: `string` ; `image_url`: `string` ; `place_from`: `number` ; `place_to`: `number` ; `type`: `string` ; `points?`: `number`  }[]
+• `Optional` **prizes**: { `name`: `string` ; `description`: `string` ; `image_url`: `string` ; `place_from`: `number` ; `place_to`: `number` ; `type`: `string` ; `points?`: `number`  }[]
 
 Prize structure
 

package/docs/interfaces/TTournamentDetailed.md

@@ -373,7 +373,7 @@ ___
 
 ### players
 
-• `Optional` **players**: \{ `public_username`: `string` ; `avatar_url`: `string` ; `position`: `number` ; `scores`: `number` ; `is_me`: `boolean`  }[]
+• `Optional` **players**: { `public_username`: `string` ; `avatar_url`: `string` ; `position`: `number` ; `scores`: `number` ; `is_me`: `boolean`  }[]
 
 The list of the tournament participants
 
@@ -402,7 +402,7 @@ ___
 
 ### prizes
 
-• `Optional` **prizes**: \{ `name`: `string` ; `description`: `string` ; `image_url`: `string` ; `place_from`: `number` ; `place_to`: `number` ; `type`: `string` ; `points?`: `number`  }[]
+• `Optional` **prizes**: { `name`: `string` ; `description`: `string` ; `image_url`: `string` ; `place_from`: `number` ; `place_to`: `number` ; `type`: `string` ; `points?`: `number`  }[]
 
 Prize structure
 

package/package.json

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

package/src/Inbox/GetInboxMessagesResponse.ts

@@ -1,3 +1,4 @@
+import { TInboxMessage } from "src/WSAPI/WSAPITypes";
 import { ProtocolResponse } from "../Base/ProtocolResponse";
 import { InboxMessage } from "./InboxMessage";
 
@@ -5,3 +6,16 @@ export interface GetInboxMessagesResponse extends ProtocolResponse {
 
     log: InboxMessage[];
 }
+
+export const InboxMessagesTransform = ((items: InboxMessage[]): TInboxMessage[] => {
+
+    return items.map(item => {
+        const x: TInboxMessage = {
+            sent_date: item.createDate,
+            message_guid: item.engagement_uid,
+            read: item.is_read,
+            favorite: item.is_starred,
+        }
+        return x;
+    });
+})

package/src/Inbox/InboxMessage.ts

@@ -1,19 +1,45 @@
+import { TInboxMessageBody } from "src/WSAPI/WSAPITypes";
 import { InboxMessageType } from "./InboxMessageType";
 
+export interface InboxMessageBody {
+    action: string;
+    body: string;
+    type: InboxMessageType;
+    image: string;
+    title: string;
+    html_body: string;  
+    additional_buttons?: { inbox_cta_text: string, action: string }[];
+}
+
 export interface InboxMessage {
 
     createDate: string;
-    body: {
-        action: string;
-        body: string;
-        type: InboxMessageType;
-        image: string;
-        title: string;
-        html_body: string;  
-        additional_buttons?: { inbox_cta_text: string, action: string }[];
-    }; 
+    body: InboxMessageBody;
     engagement_uid: string;
     is_read: boolean;
     is_starred: boolean;
     is_deleted: boolean;
 }
+
+export const InboxMessageBodyTransform = (item: InboxMessageBody): TInboxMessageBody => {
+    
+    const x: TInboxMessageBody = {
+        action: item.action,
+        icon: item.image,
+        title: item.title,
+        preview_body: item.body,
+    }
+
+    if (item.action === 'dp:inbox') {
+        if (item.additional_buttons && item.additional_buttons.length) {
+            x.buttons = item.additional_buttons.map(b => ({
+                action: b.action,
+                text: b.inbox_cta_text
+            }))
+        }
+
+        x.html_body = item?.html_body || null;
+    }
+
+    return x;
+}

package/src/Inbox/MarkInboxMessageDeletedResponse.ts

@@ -2,4 +2,5 @@ import { ProtocolMessage } from "../Base/ProtocolMessage";
 
 export interface MarkInboxMessageDeletedResponse extends ProtocolMessage {
   errCode: number;
+  errMsg?: string;
 }

package/src/Inbox/MarkInboxMessageReadResponse.ts

@@ -3,4 +3,5 @@ import { ProtocolMessage } from "../Base/ProtocolMessage";
 
 export interface MarkInboxMessageReadResponse extends ProtocolMessage {
     errCode: number;
+    errMsg?: string;
 }

package/src/Inbox/MarkInboxMessageStarredResponse.ts

@@ -3,4 +3,5 @@ import { ProtocolMessage } from "../Base/ProtocolMessage";
 
 export interface MarkInboxMessageStarredResponse extends ProtocolMessage {
     errCode: number;
+    errMsg?: string;
 }