@smartico/public-api 0.0.379 → 0.0.380

package/docs/api/classes/WSAPIInbox.md

@@ -0,0 +1,277 @@
+# Class: WSAPIInbox
+## Methods
+
+### reportImpressionEvent()
+
+> **reportImpressionEvent**(`params`): `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
+
+##### params
+
+Event parameters
+
+###### engagement_uid
+
+`string`
+
+Unique identifier for the engagement
+
+###### activityType
+
+`number`
+
+Type of engagement activity (Popup=30, Inbox=31)
+
+#### Returns
+
+`void`
+
+***
+
+### reportClickEvent()
+
+> **reportClickEvent**(`params`): `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
+
+##### params
+
+Event parameters
+
+###### engagement_uid
+
+`string`
+
+Unique identifier for the engagement
+
+###### activityType
+
+`number`
+
+Type of engagement activity (Popup=30, Inbox=31)
+
+###### action?
+
+`string`
+
+Optional action/deeplink that was triggered by the user interaction
+
+#### Returns
+
+`void`
+
+***
+
+### getInboxMessages()
+
+> **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.
+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 function returns a list of messages without the body of each 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.
+All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
+The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### params?
+
+###### from?
+
+`number`
+
+###### to?
+
+`number`
+
+###### onlyFavorite?
+
+`boolean`
+
+###### categoryId?
+
+[`InboxCategories`](../enumerations/InboxCategories.md)
+
+###### read_status?
+
+[`InboxReadStatus`](../enumerations/InboxReadStatus.md)
+
+###### onUpdate?
+
+(`data`) => `void`
+
+#### Returns
+
+`Promise`\<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>
+
+***
+
+### getInboxUnreadCount()
+
+> **getInboxUnreadCount**(`params?`): `Promise`\<`number`\>
+
+Returns inbox unread count.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### params?
+
+###### onUpdate?
+
+(`unread_count`) => `void`
+
+#### Returns
+
+`Promise`\<`number`\>
+
+***
+
+### getInboxMessageBody()
+
+> **getInboxMessageBody**(`messageGuid`): `Promise`\<[`TInboxMessageBody`](../interfaces/TInboxMessageBody.md)\>
+
+Returns the message body of the specified message guid.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### 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
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### messageGuid
+
+`string`
+
+#### Returns
+
+`Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+***
+
+### markAllInboxMessagesAsRead()
+
+> **markAllInboxMessagesAsRead**(): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to mark all inbox messages as read
+
+**Visitor mode: not supported**
+
+#### 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.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### messageGuid
+
+`string`
+
+##### mark
+
+`boolean`
+
+#### Returns
+
+`Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+***
+
+### deleteInboxMessage()
+
+> **deleteInboxMessage**(`messageGuid`): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to delete inbox message
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### messageGuid
+
+`string`
+
+#### Returns
+
+`Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+***
+
+### deleteAllInboxMessages()
+
+> **deleteAllInboxMessages**(): `Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+Requests to delete all inbox messages
+
+**Visitor mode: not supported**
+
+#### Returns
+
+`Promise`\<[`InboxMarkMessageAction`](../interfaces/InboxMarkMessageAction.md)\>
+
+***

package/docs/api/classes/WSAPIJackpots.md

@@ -0,0 +1,185 @@
+# Class: WSAPIJackpots
+## Methods
+
+### jackpotGet()
+
+> **jackpotGet**(`filter?`): `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
+
+Returns list of Jackpots that are active in the system and matching to the filter definition.
+If filter is not provided, all active jackpots will be returned.
+Filter can be used to get jackpots related to specific game or specific jackpot template.
+You can call this method every second in order to get up to date information about current value of the jackpot(s) and present them to the end-users
+
+**Example**:
+```
+_smartico.api.jackpotGet({ related_game_id: 'wooko-slot' }).then((result) => {
+     console.log(result);
+});
+```
+
+**Example in the Visitor mode**:
+```
+_smartico.vapi('EN').jackpotGet({ related_game_id: 'wooko-slot' }).then((result) => {
+     console.log(result);
+});
+```
+
+#### Parameters
+
+##### filter?
+
+###### related_game_id?
+
+`string`
+
+###### jp_template_id?
+
+`number`
+
+#### Returns
+
+`Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
+
+***
+
+### jackpotOptIn()
+
+> **jackpotOptIn**(`filter`): `Promise`\<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
+
+Opt-in currently logged in user to the jackpot with the specified jp_template_id.
+You may call jackpotGet method after doing optin to see that user is opted in to the jackpot.
+
+**Example**:
+```
+_smartico.api.jackpotOptIn({ jp_template_id: 123 }).then((result) => {
+     console.log('Opted in to the jackpot');
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### filter
+
+###### jp_template_id
+
+`number`
+
+#### Returns
+
+`Promise`\<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
+
+***
+
+### jackpotOptOut()
+
+> **jackpotOptOut**(`filter`): `Promise`\<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
+
+Opt-out currently logged in user from the jackpot with the specified jp_template_id.
+You may call jackpotGet method after doing optout to see that user is not opted in to the jackpot.
+
+**Example**:
+```
+_smartico.api.jackpotOptOut({ jp_template_id: 123 }).then((result) => {
+     console.log('Opted out from the jackpot');
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### filter
+
+###### jp_template_id
+
+`number`
+
+#### Returns
+
+`Promise`\<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
+
+***
+
+### getJackpotWinners()
+
+> **getJackpotWinners**(`params`): `Promise`\<[`JackpotWinnerHistory`](../interfaces/JackpotWinnerHistory.md)[]\>
+
+Returns jackpot winners for the given `jp_template_id` (paginated on the server).
+Default page size on the wire is 20; use `limit`, `offset`, and repeated calls to load more.
+The full protocol response also includes `has_more`; this method returns only the `winners` array.
+
+**Example**:
+```
+_smartico.api.getJackpotWinners({
+     jp_template_id: 123,
+}).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### params
+
+Jackpot winners parameters
+
+###### limit?
+
+`number`
+
+Page size (server default 20 when omitted)
+
+###### offset?
+
+`number`
+
+Offset into the winner list
+
+###### jp_template_id?
+
+`number`
+
+Jackpot template id (required; throws if missing)
+
+#### Returns
+
+`Promise`\<[`JackpotWinnerHistory`](../interfaces/JackpotWinnerHistory.md)[]\>
+
+***
+
+### getJackpotEligibleGames()
+
+> **getJackpotEligibleGames**(`__namedParameters`): `Promise`\<[`TGetJackpotEligibleGamesResponse`](../interfaces/TGetJackpotEligibleGamesResponse.md)\>
+
+Returns the eligible games for the jackpot with the specified jp_template_id.
+
+**Example**:
+```
+_smartico.api.getJackpotEligibleGames({ jp_template_id: 123 }).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### jp_template_id
+
+`number`
+
+###### onUpdate?
+
+() => `void`
+
+#### Returns
+
+`Promise`\<[`TGetJackpotEligibleGamesResponse`](../interfaces/TGetJackpotEligibleGamesResponse.md)\>
+
+***

package/docs/api/classes/WSAPILeaderBoard.md

@@ -0,0 +1,39 @@
+# Class: WSAPILeaderBoard
+## Methods
+
+### getLeaderBoard()
+
+> **getLeaderBoard**(`periodType`, `getPreviousPeriod?`): `Promise`\<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
+
+Returns the leaderboard for the current type (default is Daily). If getPreviousPeriod is passed as true, a leaderboard for the previous period for the current type will be returned.
+For example, if the type is Weekly and getPreviousPeriod is true, a leaderboard for the previous week will be returned.
+
+**Example**:
+```
+_smartico.api.getLeaderBoard(1).then((result) => {
+    console.log(result);
+});
+```
+
+**Example in the Visitor mode**:
+```
+_smartico.vapi('EN').getLeaderBoard(1).then((result) => {
+   console.log(result);
+});
+```
+
+#### Parameters
+
+##### periodType
+
+[`LeaderBoardPeriodType`](../enumerations/LeaderBoardPeriodType.md)
+
+##### getPreviousPeriod?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
+
+***

package/docs/api/classes/WSAPIMiniGames.md

@@ -0,0 +1,175 @@
+# Class: WSAPIMiniGames
+## Methods
+
+### getMiniGames()
+
+> **getMiniGames**(`__namedParameters?`): `Promise`\<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+
+Returns the list of mini-games configured for the current user (not filtered by spin availability or Widget visibility).
+The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one.
+The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
+
+**Example**:
+```
+_smartico.api.getMiniGames().then((result) => {
+     console.log(result);
+});
+```
+
+**Example in the Visitor mode**:
+```
+_smartico.vapi('EN').getMiniGames().then((result) => {
+     console.log(result);
+});
+```
+
+#### Parameters
+
+##### \_\_namedParameters?
+
+###### onUpdate?
+
+(`data`) => `void`
+
+#### Returns
+
+`Promise`\<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+
+***
+
+### getMiniGamesHistory()
+
+> **getMiniGamesHistory**(`__namedParameters`): `Promise`\<[`TSawHistory`](../interfaces/TSawHistory.md)[]\>
+
+Returns the list of mini-games based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
+The maximum number of items per request is limited to 20.
+You can leave this params empty and by default it will return list of mini-games ranging from 0 to 20.
+The returned list of mini-games history is cached for 30 seconds.
+
+**Example**:
+```
+_smartico.api.getMiniGamesHistory().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### limit?
+
+`number`
+
+###### offset?
+
+`number`
+
+###### saw_template_id?
+
+`number`
+
+#### Returns
+
+`Promise`\<[`TSawHistory`](../interfaces/TSawHistory.md)[]\>
+
+***
+
+### playMiniGame()
+
+> **playMiniGame**(`template_id`, `__namedParameters?`): `Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
+
+Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
+After playMiniGame is called, you can call getMiniGames to get the list of mini-games.The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call playMiniGame with a new onUpdate callback, the old one will be overwritten by the new one.
+The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
+
+**Example**:
+```
+_smartico.api.playMiniGame(55).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### template\_id
+
+`number`
+
+##### \_\_namedParameters?
+
+###### onUpdate?
+
+(`data`) => `void`
+
+#### Returns
+
+`Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
+
+***
+
+### miniGameWinAcknowledgeRequest()
+
+> **miniGameWinAcknowledgeRequest**(`request_id`): `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
+
+Sends the acknowledge request with specific client_request_id from minigame history in order to claim prize
+**Example**:
+```
+_smartico.api.miniGameWinAcknowledgeRequest('2a189322-31bb-4119-b943-bx7868ff8dc3').then((result) => {
+     console.log(result);
+});
+```
+
+#### Parameters
+
+##### request\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
+
+***
+
+### playMiniGameBatch()
+
+> **playMiniGameBatch**(`template_id`, `spin_count`, `__namedParameters?`): `Promise`\<[`TMiniGamePlayBatchResult`](../interfaces/TMiniGamePlayBatchResult.md)[]\>
+
+Plays the specified by template_id mini-game on behalf of user spin_count times and returns array of the prizes
+After playMiniGameBatch is called, you can call getMiniGames to get the list of mini-games. The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call playMiniGameBatch with a new onUpdate callback, the old one will be overwritten by the new one.
+The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
+
+**Example**:
+```
+_smartico.api.playMiniGameBatch(55, 10).then((result) => {
+     console.log(result);
+});
+```
+**Visitor mode: not supported**
+
+#### Parameters
+
+##### template\_id
+
+`number`
+
+##### spin\_count
+
+`number`
+
+##### \_\_namedParameters?
+
+###### onUpdate?
+
+(`data`) => `void`
+
+#### Returns
+
+`Promise`\<[`TMiniGamePlayBatchResult`](../interfaces/TMiniGamePlayBatchResult.md)[]\>
+
+***