@smartico/public-api 0.0.341 → 0.0.343

package/docs/api/interfaces/GetTournamentInfoResponse.md

@@ -0,0 +1,95 @@
+# Interface: GetTournamentInfoResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`GetTournamentInfoResponse`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolResponse.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolResponse.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolResponse.uuid
+
+___
+
+### errCode
+
+• `Optional` **errCode**: `number`
+
+#### Inherited from
+
+ProtocolResponse.errCode
+
+___
+
+### errMsg
+
+• `Optional` **errMsg**: `string`
+
+#### Inherited from
+
+ProtocolResponse.errMsg
+
+___
+
+### tournamentInfo
+
+• **tournamentInfo**: `Object`
+
+tournament info
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `labelId` | `number` | id of label, not in use |
+| `tournamentLobbyInfo` | [`Tournament`](Tournament.md) | - |
+| `players` | [`TournamentPlayer`](TournamentPlayer.md)[] | list of registered users |
+
+___
+
+### userPosition
+
+• **userPosition**: [`TournamentPlayer`](TournamentPlayer.md)
+
+information about current user position
+
+___
+
+### prizeStructure
+
+• `Optional` **prizeStructure**: `Object`
+
+prizes structure
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `prizes` | [`TournamentPrize`](TournamentPrize.md)[] |

package/docs/api/interfaces/InboxMessage.md

@@ -0,0 +1,49 @@
+# Interface: InboxMessage
+
+## Properties
+
+### createDate
+
+• **createDate**: `string`
+
+___
+
+### body
+
+• **body**: [`InboxMessageBody`](InboxMessageBody.md)
+
+___
+
+### engagement\_uid
+
+• **engagement\_uid**: `string`
+
+___
+
+### is\_read
+
+• **is\_read**: `boolean`
+
+___
+
+### is\_starred
+
+• **is\_starred**: `boolean`
+
+___
+
+### is\_deleted
+
+• `Optional` **is\_deleted**: `boolean`
+
+___
+
+### category\_id
+
+• `Optional` **category\_id**: [`InboxCategories`](../enums/InboxCategories.md)
+
+___
+
+### expire\_on\_dt
+
+• `Optional` **expire\_on\_dt**: `number`

package/docs/api/interfaces/InboxMessageBody.md

@@ -0,0 +1,73 @@
+# Interface: InboxMessageBody
+
+## Properties
+
+### action
+
+• **action**: `string`
+
+___
+
+### body
+
+• **body**: `string`
+
+___
+
+### type
+
+• **type**: `InboxMessageType`
+
+___
+
+### image
+
+• **image**: `string`
+
+___
+
+### title
+
+• **title**: `string`
+
+___
+
+### html\_body
+
+• **html\_body**: `string`
+
+___
+
+### additional\_buttons
+
+• `Optional` **additional\_buttons**: \{ `inbox_cta_text`: `string` ; `action`: `string`  }[]
+
+___
+
+### show\_preview
+
+• `Optional` **show\_preview**: `boolean`
+
+___
+
+### show\_duration\_sec
+
+• `Optional` **show\_duration\_sec**: `number`
+
+___
+
+### enable\_zoom\_mode
+
+• `Optional` **enable\_zoom\_mode**: `boolean`
+
+___
+
+### open\_links
+
+• `Optional` **open\_links**: `OpenLinksType`
+
+___
+
+### custom\_data
+
+• `Optional` **custom\_data**: `string`

package/docs/{interfaces → api/interfaces}/Level.md

@@ -1,46 +1,36 @@
 # Interface: Level
 
-Level object returned by getLevels API (raw, non-transformed).
-
 ## Properties
 
 ### level\_id
 
 • **level\_id**: `number`
 
-Level ID
-
 ___
 
 ### level\_public\_meta
 
 • **level\_public\_meta**: [`LevelPublicMeta`](LevelPublicMeta.md)
 
-Public metadata for UI display
-
 ___
 
 ### required\_points
 
 • **required\_points**: `number`
 
-Points required to reach this level
-
 ___
 
 ### is\_first\_level
 
 • **is\_first\_level**: `boolean`
 
-Whether this is the starting level
-
 ___
 
 ### level\_status\_id
 
 • **level\_status\_id**: `number`
 
-Internal status (not used on front-end)
+Internal status of level. Not in use right now on the front-end
 
 ___
 
@@ -48,20 +38,14 @@ ___
 
 • **required\_level\_counter\_1**: `number`
 
-Counter 1 for advanced leveling
-
 ___
 
 ### required\_level\_counter\_2
 
 • **required\_level\_counter\_2**: `number`
 
-Counter 2 for advanced leveling
-
 ___
 
 ### general\_level\_progress
 
 • **general\_level\_progress**: `number`
-
-General progress value

package/docs/api/interfaces/LevelPublicMeta.md

@@ -0,0 +1,60 @@
+# Interface: LevelPublicMeta
+
+## Properties
+
+### description
+
+• `Optional` **description**: `string`
+
+Description of level, HTML capabable
+
+___
+
+### image\_url
+
+• `Optional` **image\_url**: `string`
+
+URL to the image of level
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+Name of level
+
+___
+
+### visibility\_points
+
+• `Optional` **visibility\_points**: `number`
+
+Number of points that user should have collected in order to see this level
+
+___
+
+### position
+
+• `Optional` **position**: `Object`
+
+X & Y coordinates of level on the visual mission map, for desktop and mobile
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `mx` | `number` |
+| `my` | `number` |
+| `dx` | `number` |
+| `dy` | `number` |
+
+___
+
+### custom\_data
+
+• `Optional` **custom\_data**: `string`
+
+Custom data as string or JSON string that can be used in API to build custom UI
+You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
+Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes

package/docs/api/interfaces/PointsLog.md

@@ -0,0 +1,43 @@
+# Interface: PointsLog
+
+## Properties
+
+### create\_date
+
+• **create\_date**: `number`
+
+___
+
+### user\_ext\_id
+
+• **user\_ext\_id**: `string`
+
+___
+
+### crm\_brand\_id
+
+• **crm\_brand\_id**: `number`
+
+___
+
+### points\_collected
+
+• **points\_collected**: `number`
+
+___
+
+### user\_points\_ever
+
+• **user\_points\_ever**: `number`
+
+___
+
+### user\_points\_balance
+
+• **user\_points\_balance**: `number`
+
+___
+
+### source\_type\_id
+
+• **source\_type\_id**: [`PointChangeSourceType`](../enums/PointChangeSourceType.md)

package/docs/{interfaces → api/interfaces}/SAWPrizesHistory.md

@@ -1,67 +1,49 @@
 # Interface: SAWPrizesHistory
 
-Mini-game (SAW) prize history entry (raw, non-transformed).
-
 ## Properties
 
 ### template
 
 • **template**: [`SAWTemplate`](SAWTemplate.md)
 
-The mini-game template information
-
 ___
 
 ### saw\_template\_id
 
 • **saw\_template\_id**: `number`
 
-ID of the mini-game template
-
 ___
 
 ### saw\_prize\_id
 
 • **saw\_prize\_id**: `number`
 
-ID of the prize that user won
-
 ___
 
 ### prize\_amount
 
 • **prize\_amount**: `number`
 
-Amount of the prize
-
 ___
 
 ### client\_request\_id
 
 • **client\_request\_id**: `string`
 
-Client request ID for the spin
-
 ___
 
 ### is\_claimed
 
 • **is\_claimed**: `boolean`
 
-Whether the prize has been claimed/acknowledged
-
 ___
 
 ### create\_date\_ts
 
 • **create\_date\_ts**: `number`
 
-Timestamp when the prize was won
-
 ___
 
 ### acknowledge\_date\_ts
 
 • **acknowledge\_date\_ts**: `number`
-
-Timestamp when the prize was acknowledged

package/docs/api/interfaces/StoreCategory.md

@@ -0,0 +1,13 @@
+# Interface: StoreCategory
+
+## Properties
+
+### id
+
+• `Optional` **id**: `number`
+
+___
+
+### publicMeta
+
+• `Optional` **publicMeta**: [`StoreCategoryPublicMeta`](StoreCategoryPublicMeta.md)

package/docs/api/interfaces/StoreCategoryPublicMeta.md

@@ -0,0 +1,13 @@
+# Interface: StoreCategoryPublicMeta
+
+## Properties
+
+### name
+
+• `Optional` **name**: `string`
+
+___
+
+### order
+
+• `Optional` **order**: `number`

package/docs/api/interfaces/StoreItem.md

@@ -0,0 +1,43 @@
+# Interface: StoreItem
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+___
+
+### itemTypeId
+
+• **itemTypeId**: `StoreItemType`
+
+___
+
+### itemPublicMeta
+
+• **itemPublicMeta**: `StoreItemPublicMeta`
+
+___
+
+### categoryIds
+
+• `Optional` **categoryIds**: `number`[]
+
+___
+
+### canBuy
+
+• `Optional` **canBuy**: `boolean`
+
+___
+
+### shopPool
+
+• **shopPool**: `number`
+
+___
+
+### activeTillDate
+
+• `Optional` **activeTillDate**: `number`

package/docs/{interfaces → api/interfaces}/TTournamentRegistrationResult.md

@@ -4,7 +4,7 @@
 
 ### err\_code
 
-• **err\_code**: [`TournamentRegistrationError`](../enums/TournamentRegistrationError.md)
+• **err\_code**: `TournamentRegistrationError`
 
 Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0
 

package/docs/{interfaces → api/interfaces}/TUICustomSection.md

@@ -135,3 +135,11 @@ ___
 • `Optional` **shop\_category\_ids**: `number`[]
 
 List of IDs of the categories where the store item is assigned, information about categories can be retrieved with getShopCategories method
+
+___
+
+### raffle\_id
+
+• `Optional` **raffle\_id**: `number`
+
+ID of the raffle to be used for Liquid templates