@smartico/public-api 0.0.364 → 0.0.366

package/docs/api/interfaces/TAvatarPrompt.md

@@ -0,0 +1,44 @@
+# Interface: TAvatarPrompt
+
+TAvatarPrompt describes an AI style prompt available for avatar customization.
+Fields from the raw `public_meta` object are flattened to the top level.
+
+## Properties
+
+### prompt\_id
+
+> **prompt\_id**: `number`
+
+Unique identifier of the AI customization prompt
+
+***
+
+### name
+
+> **name**: `string`
+
+Display name of the prompt style, e.g. "Cartoon", "Watercolor" (from public_meta)
+
+***
+
+### icon\_url
+
+> **icon\_url**: `string`
+
+Full CDN URL of the prompt style icon image (from public_meta)
+
+***
+
+### cost\_currency\_type\_id
+
+> **cost\_currency\_type\_id**: `number`
+
+Currency type used to pay for this customization (0=points, 1=gems, 2=diamonds)
+
+***
+
+### cost\_value
+
+> **cost\_value**: `number`
+
+Cost amount in the given currency

package/docs/api/interfaces/TBonus.md

@@ -4,62 +4,62 @@
 
 ### bonus\_id
 
-• **bonus\_id**: `number`
+> **bonus\_id**: `number`
 
 ID of the bonus
 
-___
+***
 
-### is\_redeemable
+### is\_redeemable?
 
-• `Optional` **is\_redeemable**: `boolean`
+> `optional` **is\_redeemable?**: `boolean`
 
 Can the bonus be redeemed (if bonus is redeemable the user needs to claim it)
 
-___
+***
 
-### create\_date
+### create\_date?
 
-• `Optional` **create\_date**: `string`
+> `optional` **create\_date?**: `string`
 
 Date of creation
 
-___
+***
 
-### redeem\_date
+### redeem\_date?
 
-• `Optional` **redeem\_date**: `string`
+> `optional` **redeem\_date?**: `string`
 
 Date of redemption
 
-___
+***
 
-### label\_bonus\_template\_id
+### label\_bonus\_template\_id?
 
-• `Optional` **label\_bonus\_template\_id**: `number`
+> `optional` **label\_bonus\_template\_id?**: `number`
 
 ID of template used
 
-___
+***
 
-### bonus\_status\_id
+### bonus\_status\_id?
 
-• `Optional` **bonus\_status\_id**: [`BonusStatus`](../enums/BonusStatus-1.md)
+> `optional` **bonus\_status\_id?**: [`BonusStatus`](../enumerations/BonusStatus-1.md)
 
 ID of the bonus status
 
-___
+***
 
-### label\_bonus\_template\_meta\_map
+### label\_bonus\_template\_meta\_map?
 
-• `Optional` **label\_bonus\_template\_meta\_map**: [`BonusTemplateMetaMap`](BonusTemplateMetaMap-1.md)
+> `optional` **label\_bonus\_template\_meta\_map?**: [`BonusTemplateMetaMap`](BonusTemplateMetaMap-1.md)
 
 Additional information about the bonus(edscription, image,name, acknowledge)
 
-___
+***
 
-### bonus\_meta\_map
+### bonus\_meta\_map?
 
-• `Optional` **bonus\_meta\_map**: [`BonusMetaMap`](BonusMetaMap-1.md)
+> `optional` **bonus\_meta\_map?**: [`BonusMetaMap`](BonusMetaMap-1.md)
 
 Additional information presented to the player when the bonus is redeemed

package/docs/api/interfaces/TBuyStoreItemResult.md

@@ -4,7 +4,7 @@
 
 ### err\_code
 
-• **err\_code**: [`BuyStoreItemErrorCode`](../enums/BuyStoreItemErrorCode.md)
+> **err\_code**: [`BuyStoreItemErrorCode`](../enumerations/BuyStoreItemErrorCode.md)
 
 Error code representing the result of the purchase of the shop item. Successful purchase if err_code is 0 
 
@@ -17,10 +17,10 @@ SmarticoAPI.buyStoreItem(item_id).then(res => {
 });
 ```
 
-___
+***
 
 ### err\_message
 
-• **err\_message**: `string`
+> **err\_message**: `string`
 
 Optional error message

package/docs/api/interfaces/TClaimBonusResult.md

@@ -6,22 +6,22 @@ TClaimBonusResult describes the response of call to _smartico.api.claimBonus(bon
 
 ### err\_code
 
-• **err\_code**: [`SAWSpinErrorCode`](../enums/SAWSpinErrorCode.md)
+> **err\_code**: [`SAWSpinErrorCode`](../enumerations/SAWSpinErrorCode.md)
 
 Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0
 
-___
+***
 
 ### err\_message
 
-• **err\_message**: `string`
+> **err\_message**: `string`
 
 Optional error message
 
-___
+***
 
-### success
+### success?
 
-• `Optional` **success**: `boolean`
+> `optional` **success?**: `boolean`
 
 If the bonus was claimed successfully, then success is true

package/docs/api/interfaces/TClan.md

@@ -0,0 +1,79 @@
+# Interface: TClan
+
+TClan describes one clan item from the clans list.
+
+## Properties
+
+### clan\_id
+
+> **clan\_id**: `number`
+
+Clan ID
+
+***
+
+### public\_meta
+
+> **public\_meta**: `object`
+
+Translated clan metadata
+
+#### name
+
+> **name**: `string`
+
+#### description
+
+> **description**: `string`
+
+#### image\_url
+
+> **image\_url**: `string`
+
+***
+
+### member\_count
+
+> **member\_count**: `number`
+
+Current number of members in clan
+
+***
+
+### capacity\_limit
+
+> **capacity\_limit**: `number`
+
+Max number of members allowed in clan
+
+***
+
+### entry\_fee\_currency\_type\_id
+
+> **entry\_fee\_currency\_type\_id**: `number`
+
+ShopPurchaseType: 0=Points, 1=Gems, 2=Diamonds, 3=Free
+
+***
+
+### entry\_fee\_amount
+
+> **entry\_fee\_amount**: `number`
+
+Numeric value for entry fee
+
+***
+
+### rating\_position
+
+> **rating\_position**: `number`
+
+F1 rank ASC, 1=best
+
+***
+
+### rating\_score
+
+> **rating\_score**: `number`
+
+Clan rating score

package/docs/api/interfaces/TClanInfo.md

@@ -0,0 +1,111 @@
+# Interface: TClanInfo
+
+TClanInfo describes the detailed info of a single clan including its members.
+
+## Properties
+
+### clan\_id
+
+> **clan\_id**: `number`
+
+***
+
+### public\_meta
+
+> **public\_meta**: `object`
+
+#### name
+
+> **name**: `string`
+
+#### description
+
+> **description**: `string`
+
+#### image\_url
+
+> **image\_url**: `string`
+
+***
+
+### member\_count
+
+> **member\_count**: `number`
+
+***
+
+### capacity\_limit
+
+> **capacity\_limit**: `number`
+
+***
+
+### entry\_fee\_currency\_type\_id
+
+> **entry\_fee\_currency\_type\_id**: `number`
+
+***
+
+### entry\_fee\_amount
+
+> **entry\_fee\_amount**: `number`
+
+***
+
+### rating\_position
+
+> **rating\_position**: `number`
+
+***
+
+### rating\_score
+
+> **rating\_score**: `number`
+
+***
+
+### cooldown\_until
+
+> **cooldown\_until**: `string`
+
+***
+
+### members
+
+> **members**: `object`[]
+
+#### user\_id
+
+> **user\_id**: `number`
+
+#### public\_username
+
+> **public\_username**: `string`
+
+#### avatar\_id
+
+> **avatar\_id**: `string`
+
+#### avatar\_real\_id
+
+> **avatar\_real\_id**: `number`
+
+#### avatar\_url?
+
+> `optional` **avatar\_url?**: `string`
+
+#### position
+
+> **position**: `number`
+
+#### contribution\_score
+
+> **contribution\_score**: `number`
+
+#### is\_me?
+
+> `optional` **is\_me?**: `boolean`
+
+#### clean\_ext\_user\_id?
+
+> `optional` **clean\_ext\_user\_id?**: `string`

package/docs/api/interfaces/TClanJoinResult.md

@@ -0,0 +1,15 @@
+# Interface: TClanJoinResult
+
+TClanJoinResult describes the result of a join clan request.
+
+## Properties
+
+### errCode
+
+> **errCode**: `number`
+
+***
+
+### errMsg
+
+> **errMsg**: `string`

package/docs/api/interfaces/TClanTournamentPlayers.md

@@ -0,0 +1,71 @@
+# Interface: TClanTournamentPlayers
+
+TClanTournamentPlayers describes the players of a specific clan in a clan-based tournament.
+
+## Properties
+
+### clan\_id
+
+> **clan\_id**: `number`
+
+Clan ID
+
+***
+
+### clan\_public\_meta
+
+> **clan\_public\_meta**: `object`
+
+Clan display metadata
+
+#### name
+
+> **name**: `string`
+
+#### image\_url
+
+> **image\_url**: `string`
+
+***
+
+### players
+
+> **players**: `object`[]
+
+Top players of this clan ranked by score DESC
+
+#### user\_id
+
+> **user\_id**: `number`
+
+#### public\_username
+
+> **public\_username**: `string`
+
+#### avatar\_id
+
+> **avatar\_id**: `string`
+
+#### avatar\_real\_id
+
+> **avatar\_real\_id**: `number`
+
+#### avatar\_url?
+
+> `optional` **avatar\_url?**: `string`
+
+#### position
+
+> **position**: `number`
+
+#### scores
+
+> **scores**: `number`
+
+#### is\_me
+
+> **is\_me**: `boolean`
+
+#### clean\_ext\_user\_id
+
+> **clean\_ext\_user\_id**: `string`

package/docs/api/interfaces/TClans.md

@@ -0,0 +1,27 @@
+# Interface: TClans
+
+TClans describes the clans payload returned by the API.
+
+## Properties
+
+### clans
+
+> **clans**: [`TClan`](TClan.md)[]
+
+List of active clans available to the user
+
+***
+
+### user\_clan\_id
+
+> **user\_clan\_id**: `number`
+
+The clan ID the current user belongs to; null if clanless
+
+***
+
+### cooldown\_until
+
+> **cooldown\_until**: `string`
+
+Cooldown-until date string; null if no cooldown

package/docs/api/interfaces/TGetJackpotEligibleGamesResponse.md

@@ -4,4 +4,4 @@
 
 ### eligible\_games
 
-• **eligible\_games**: [`JackpotEligibleGame`](JackpotEligibleGame.md)[]
+> **eligible\_games**: [`JackpotEligibleGame`](JackpotEligibleGame.md)[]

package/docs/api/interfaces/TGetTranslations.md

@@ -4,8 +4,8 @@
 
 ### translations
 
-• **translations**: `Object`
+> **translations**: `object`
 
-#### Index signature
+#### Index Signature
 
-▪ [key: `string`]: `string`
+\[`key`: `string`\]: `string`

package/docs/api/interfaces/TInboxMessage.md

@@ -4,46 +4,46 @@
 
 ### message\_guid
 
-• **message\_guid**: `string`
+> **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`
+> **sent\_date**: `string`
 
 Date when the message was sent
 
-___
+***
 
 ### read
 
-• **read**: `boolean`
+> **read**: `boolean`
 
 Indicator if a message is read
 
-___
+***
 
 ### favorite
 
-• **favorite**: `boolean`
+> **favorite**: `boolean`
 
 Indicator if a message is added to favorites
 
-___
+***
 
-### category\_id
+### category\_id?
 
-• `Optional` **category\_id**: [`InboxCategories`](../enums/InboxCategories.md)
+> `optional` **category\_id?**: [`InboxCategories`](../enumerations/InboxCategories.md)
 
 Category id per inbox message, can be part of System inboxes, Personal inboxes or General inbox messages
 
-___
+***
 
-### expire\_on\_dt
+### expire\_on\_dt?
 
-• `Optional` **expire\_on\_dt**: `number`
+> `optional` **expire\_on\_dt?**: `number`
 
 The epoch timestamp, with milliseconds, when the message is going to be expired

package/docs/api/interfaces/TInboxMessageBody.md

@@ -4,57 +4,69 @@
 
 ### title
 
-• **title**: `string`
+> **title**: `string`
 
 Message title
 
-___
+***
 
 ### preview\_body
 
-• **preview\_body**: `string`
+> **preview\_body**: `string`
 
 Short preview body of the message
 
-___
+***
 
 ### icon
 
-• **icon**: `string`
+> **icon**: `string`
 
 Message icon, 128x128px
 
-___
+***
 
 ### action
 
-• **action**: `string`
+> **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
+### html\_body?
 
-• `Optional` **html\_body**: `string`
+> `optional` **html\_body?**: `string`
 
 Rich HTML body of the message.
 
-___
+***
 
-### buttons
+### buttons?
 
-• `Optional` **buttons**: \{ `action`: `string` ; `text`: `string`  }[]
+> `optional` **buttons?**: `object`[]
 
 Optional additional buttons to show in the message, available only if message has rich HTML body. Max count - 2.
 
-___
+#### action
 
-### custom\_data
+> **action**: `string`
 
-• `Optional` **custom\_data**: `string`
+The action that should be performed when user clicks on the button. The logic is the same as for message actions
+
+#### text
+
+> **text**: `string`
+
+Button text
+
+***
+
+### custom\_data?
+
+> `optional` **custom\_data?**: `string`
 
 The custom data of the inbox message defined by operator. Can be a JSON object, string or number