@smartico/public-api 0.0.380 → 0.0.382

package/docs/api/interfaces/ClanTournamentPlayerRaw.md

@@ -0,0 +1,67 @@
+# Interface: ClanTournamentPlayerRaw
+
+## Properties
+
+### userId
+
+> **userId**: `number`
+
+***
+
+### cleanExtUserId
+
+> **cleanExtUserId**: `string`
+
+***
+
+### userAltName
+
+> **userAltName**: `string`
+
+***
+
+### avatar\_id
+
+> **avatar\_id**: `string`
+
+***
+
+### avatar\_real\_id
+
+> **avatar\_real\_id**: `number`
+
+***
+
+### position
+
+> **position**: `number`
+
+***
+
+### scores
+
+> **scores**: `number`
+
+***
+
+### isMe
+
+> **isMe**: `boolean`
+
+***
+
+### registration\_status?
+
+> `optional` **registration\_status?**: `number`
+
+***
+
+### crmBrandId?
+
+> `optional` **crmBrandId?**: `number`
+
+***
+
+### avatar\_url?
+
+> `optional` **avatar\_url?**: `string`

package/docs/api/interfaces/GemsDiamondsLog.md

@@ -0,0 +1,43 @@
+# Interface: GemsDiamondsLog
+
+## Properties
+
+### create\_date
+
+> **create\_date**: `number`
+
+***
+
+### user\_ext\_id
+
+> **user\_ext\_id**: `string`
+
+***
+
+### crm\_brand\_id
+
+> **crm\_brand\_id**: `number`
+
+***
+
+### type
+
+> **type**: [`UserBalanceType`](../enumerations/UserBalanceType.md)
+
+***
+
+### amount
+
+> **amount**: `number`
+
+***
+
+### balance
+
+> **balance**: `number`
+
+***
+
+### source\_type\_id
+
+> **source\_type\_id**: [`PointChangeSourceType`](../enumerations/PointChangeSourceType.md)

package/docs/api/interfaces/GetClanInfoResponse.md

@@ -0,0 +1,61 @@
+# Interface: GetClanInfoResponse
+
+## Extends
+
+- `ProtocolResponse`
+
+## 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`
+
+***
+
+### clanInfo
+
+> **clanInfo**: [`ClanInfo`](ClanInfo.md)

package/docs/api/interfaces/GetClanTournamentPlayersResponse.md

@@ -0,0 +1,81 @@
+# Interface: GetClanTournamentPlayersResponse
+
+## Extends
+
+- `ProtocolResponse`
+
+## 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`
+
+***
+
+### clan\_id
+
+> **clan\_id**: `number`
+
+***
+
+### clan\_public\_meta
+
+> **clan\_public\_meta**: `object`
+
+#### name
+
+> **name**: `string`
+
+#### image\_url
+
+> **image\_url**: `string`
+
+***
+
+### players
+
+> **players**: [`ClanTournamentPlayerRaw`](ClanTournamentPlayerRaw.md)[]

package/docs/api/interfaces/GetRaffleWonPrizesRequest.md

@@ -0,0 +1,59 @@
+# Interface: GetRaffleWonPrizesRequest
+
+## Extends
+
+- `ProtocolMessage`
+
+## Properties
+
+### cid
+
+> **cid**: `number`
+
+#### Inherited from
+
+`ProtocolMessage.cid`
+
+***
+
+### ts?
+
+> `optional` **ts?**: `number`
+
+#### Inherited from
+
+`ProtocolMessage.ts`
+
+***
+
+### uuid?
+
+> `optional` **uuid?**: `string`
+
+#### Inherited from
+
+`ProtocolMessage.uuid`
+
+***
+
+### raffle\_id
+
+> **raffle\_id**: `number`
+
+ID of the raffle to fetch the current user's won prizes for.
+
+***
+
+### offset
+
+> **offset**: `number`
+
+Zero-based index of the first won-prize row to return (pagination).
+
+***
+
+### limit
+
+> **limit**: `number`
+
+Maximum number of won-prize rows to return (pagination).

package/docs/api/interfaces/GetRaffleWonPrizesResponse.md

@@ -0,0 +1,95 @@
+# Interface: GetRaffleWonPrizesResponse
+
+## Extends
+
+- `ProtocolResponse`
+
+## 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`
+
+***
+
+### user
+
+> **user**: [`RaffleWonPrizeUser`](RaffleWonPrizeUser.md)
+
+The user the won prizes belong to; `null` when `won_prizes` is empty.
+
+***
+
+### won\_prizes
+
+> **won\_prizes**: [`RaffleWonPrize`](RaffleWonPrize.md)[]
+
+Page of won prizes for the requested raffle, newest-first.
+
+***
+
+### total
+
+> **total**: `number`
+
+Total number of won prizes for this user/raffle across all draws (for pagination).
+
+***
+
+### offset
+
+> **offset**: `number`
+
+Zero-based offset of this page (echoes the resolved request).
+
+***
+
+### limit
+
+> **limit**: `number`
+
+Page size (echoes the resolved request).

package/docs/api/interfaces/InboxMarkMessageAction.md

@@ -1,12 +1,19 @@
 # Interface: InboxMarkMessageAction
 
+InboxMarkMessageAction is the response of the five inbox mutation
+methods (`markInboxMessageAsRead`, `markAllInboxMessagesAsRead`,
+`markUnmarkInboxMessageAsFavorite`, `deleteInboxMessage`,
+`deleteAllInboxMessages`).
+
 ## 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
+Error code. `0` = success. See the calling method's TSDoc for
+the full error semantics (server returns generic codes; the
+five inbox mutations share the same shape).
 
 ***
 
@@ -14,4 +21,5 @@ An error code representing the result of marking a message as deleted, favorite
 
 > **err\_message**: `string`
 
-Optional error message
+Optional server-side error message. Present only on non-zero
+`err_code`; may be empty even then.

package/docs/api/interfaces/JackpotDetails.md

@@ -1,8 +1,7 @@
 # Interface: JackpotDetails
 
-JackpotDetails the information about Jackpot template
-It also includes JackpotPot object that holds the current value of the jackpot
-Flag is_opted_in indicates if the current user is opted in to the jackpot
+One jackpot template the user is eligible for, with its live pot snapshot.
+Returned by `jackpotGet()`.
 
 ## Properties
 
@@ -10,7 +9,7 @@ Flag is_opted_in indicates if the current user is opted in to the jackpot
 
 > **jp\_template\_id**: `number`
 
-ID of the jackpot template
+Stable numeric ID of the template; pass to opt-in / opt-out / winners / eligible-games methods.
 
 ***
 
@@ -18,7 +17,7 @@ ID of the jackpot template
 
 > **jp\_type\_id**: [`JackpotType`](../enumerations/JackpotType.md)
 
-Type of jackpot logic
+Whether the jackpot has a shared pot or one independent per user; see [JackpotType](../enumerations/JackpotType.md).
 
 ***
 
@@ -26,7 +25,7 @@ Type of jackpot logic
 
 > **jp\_public\_meta**: [`JackpotPublicMeta`](JackpotPublicMeta.md)
 
-UI information of jackpot, like name, description, etc.
+Display data: name, description, image_url, winner / not-winner HTML templates, custom_data (JSON-parsed).
 
 ***
 
@@ -34,7 +33,7 @@ UI information of jackpot, like name, description, etc.
 
 > **jp\_currency**: `string`
 
-Base currency of the jackpot
+Native jackpot currency (ISO 4217). Used for winner-history amounts.
 
 ***
 
@@ -42,7 +41,7 @@ Base currency of the jackpot
 
 > **user\_currency**: `string`
 
-Wallet currency of currently logged in user
+Current user's wallet currency. Used to display the pot via `pot.current_pot_amount_user_currency`.
 
 ***
 
@@ -50,7 +49,7 @@ Wallet currency of currently logged in user
 
 > **contribution\_type**: [`JackpotContributionType`](../enumerations/JackpotContributionType.md)
 
-Type of the user contribution to the jackpot
+Whether the contribution is a fixed amount or a percentage of the bet; see [JackpotContributionType](../enumerations/JackpotContributionType.md).
 
 ***
 
@@ -58,7 +57,7 @@ Type of the user contribution to the jackpot
 
 > **contribution\_value**: `number`
 
-Value of the user contribution. Fixed amount or percentage of bet depending on the contribution type
+Amount of contribution per qualifying bet — fixed value or percentage depending on `contribution_type`.
 
 ***
 
@@ -66,7 +65,7 @@ Value of the user contribution. Fixed amount or percentage of bet depending on t
 
 > **pot**: [`JackpotPot`](JackpotPot.md)
 
-Information of current value of the jackpot
+Live pot snapshot (amount, temperature, last explosion timestamp).
 
 ***
 
@@ -74,7 +73,7 @@ Information of current value of the jackpot
 
 > **is\_opted\_in**: `boolean`
 
-Indication if the current user is opted in to the jackpot
+`true` when the current user is currently opted in.
 
 ***
 
@@ -82,7 +81,7 @@ Indication if the current user is opted in to the jackpot
 
 > **ach\_related\_game\_allow\_all**: `boolean`
 
-Indicates whether all games are eligible for the jackpot
+`true` when every game in the operator catalog contributes; if `true`, skip `getJackpotEligibleGames`.
 
 ***
 
@@ -90,7 +89,7 @@ Indicates whether all games are eligible for the jackpot
 
 > **registration\_count**: `number`
 
-The number of users who have opted in to participate in the jackpot
+Number of users currently opted in; always `1` for `JackpotType.Personal`.
 
 ***
 
@@ -98,4 +97,4 @@ The number of users who have opted in to participate in the jackpot
 
 > **expose\_winners\_over\_api**: `boolean`
 
-Show winners in widget and over API
+Operator flag: whether the winners list should be displayed. Enforced client-side only — gate `getJackpotWinners` calls on this.

package/docs/api/interfaces/JackpotPot.md

@@ -1,12 +1,15 @@
 # Interface: JackpotPot
 
+Live snapshot of one jackpot pot's value and temperature.
+Embedded on `JackpotDetails.pot`; refreshed at the 1 s SDK cache TTL.
+
 ## Properties
 
 ### jp\_template\_id
 
 > **jp\_template\_id**: `number`
 
-ID of the jackpot template
+Template ID this pot belongs to.
 
 ***
 
@@ -14,7 +17,7 @@ ID of the jackpot template
 
 > **jp\_pot\_id**: `number`
 
-ID of the jackpot pot
+Stable numeric ID of the current pot instance (rotates when the pot explodes).
 
 ***
 
@@ -22,7 +25,7 @@ ID of the jackpot pot
 
 > **current\_pot\_amount**: `number`
 
-currency of the jackpot pot in the Jackput base currency
+Current pot amount in the jackpot's native currency (`jp_currency`).
 
 ***
 
@@ -30,7 +33,7 @@ currency of the jackpot pot in the Jackput base currency
 
 > **current\_pot\_amount\_user\_currency**: `number`
 
-currency of the jackpot pot in the user wallet currency
+Current pot amount converted to the user's wallet currency (`user_currency`).
 
 ***
 
@@ -38,7 +41,7 @@ currency of the jackpot pot in the user wallet currency
 
 > **explode\_date\_ts**: `number`
 
-the date/time when this pot exploded
+Unix ms timestamp of when this pot last exploded; `0` if it has never exploded.
 
 ***
 
@@ -46,4 +49,4 @@ the date/time when this pot exploded
 
 > **current\_pot\_temperature**: [`JackPotTemparature`](../enumerations/JackPotTemparature.md)
 
-current pot temperature
+Heat band of the pot relative to its explosion range; see [JackPotTemparature](../enumerations/JackPotTemparature.md).

package/docs/api/interfaces/LeaderBoardDetailsT.md

@@ -1,12 +1,16 @@
 # Interface: LeaderBoardDetailsT
 
+LeaderBoardDetailsT describes one period's leaderboard.
+Returned by `_smartico.api.getLeaderBoard(periodType, getPreviousPeriod?)`.
+May be `undefined` at runtime when no board is configured for the requested period.
+
 ## Properties
 
 ### board\_id
 
 > **board\_id**: `number`
 
-ID of the leaderboard
+Stable ID of the leaderboard.
 
 ***
 
@@ -14,7 +18,7 @@ ID of the leaderboard
 
 > **name**: `string`
 
-Name of the leaderboard
+Operator-defined display name.
 
 ***
 
@@ -22,7 +26,7 @@ Name of the leaderboard
 
 > **description**: `string`
 
-Description of the leaderboard
+Operator-defined description (HTML allowed).
 
 ***
 
@@ -30,7 +34,7 @@ Description of the leaderboard
 
 > **rules**: `string`
 
-Rules of the leaderboard
+Operator-defined rules / terms (HTML allowed).
 
 ***
 
@@ -38,7 +42,7 @@ Rules of the leaderboard
 
 > **period\_type\_id**: [`LeaderBoardPeriodType`](../enumerations/LeaderBoardPeriodType.md)
 
-Leaderboard period type ID
+Period type this board is bound to ([LeaderBoardPeriodType](../enumerations/LeaderBoardPeriodType.md)).
 
 ***
 
@@ -46,7 +50,7 @@ Leaderboard period type ID
 
 > **rewards**: [`LeaderBoardsRewardsT`](LeaderBoardsRewardsT.md)[]
 
-Leaderboard points rewards
+Per-place prize table; the array length is the number of paid places.
 
 ***
 
@@ -54,7 +58,7 @@ Leaderboard points rewards
 
 > **users**: [`LeaderBoardUserT`](LeaderBoardUserT.md)[]
 
-Leaderboard users
+Top-20 ranked entries (server-capped), sorted by `position` ASC.
 
 ***
 
@@ -62,4 +66,6 @@ Leaderboard users
 
 > `optional` **me?**: [`LeaderBoardUserT`](LeaderBoardUserT.md)
 
-Info about current user in leaderboard
+Current user's own entry. `undefined` for visitor sessions.
+For authenticated users, `position === -1` means the user is
+unranked / outside the ranked window.