@smartico/public-api 0.0.274 → 0.0.276

package/docs/interfaces/SAWTemplateUI.md

@@ -0,0 +1,284 @@
+# Interface: SAWTemplateUI
+
+## Properties
+
+### skin
+
+• **skin**: `string`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+___
+
+### over\_limit\_message
+
+• `Optional` **over\_limit\_message**: `string`
+
+___
+
+### hide\_prize\_names
+
+• `Optional` **hide\_prize\_names**: `string`
+
+___
+
+### no\_attempts\_message
+
+• `Optional` **no\_attempts\_message**: `string`
+
+___
+
+### thumbnail
+
+• `Optional` **thumbnail**: `string`
+
+___
+
+### sectors\_count
+
+• **sectors\_count**: `number`
+
+___
+
+### priority
+
+• **priority**: `number`
+
+___
+
+### flow\_builder\_only
+
+• **flow\_builder\_only**: `boolean`
+
+___
+
+### background\_image
+
+• `Optional` **background\_image**: `string`
+
+___
+
+### background\_image\_mobile
+
+• `Optional` **background\_image\_mobile**: `string`
+
+___
+
+### background\_sound
+
+• `Optional` **background\_sound**: `string`
+
+___
+
+### spin\_animation\_duration
+
+• `Optional` **spin\_animation\_duration**: `number`
+
+___
+
+### wheel\_pointer\_rotation
+
+• `Optional` **wheel\_pointer\_rotation**: `number`
+
+___
+
+### scratch\_logo
+
+• `Optional` **scratch\_logo**: `string`
+
+___
+
+### scratch\_cover
+
+• `Optional` **scratch\_cover**: `string`
+
+___
+
+### scratch\_bg\_desktop
+
+• `Optional` **scratch\_bg\_desktop**: `string`
+
+___
+
+### scratch\_bg\_mobile
+
+• `Optional` **scratch\_bg\_mobile**: `string`
+
+___
+
+### scratch\_cursor
+
+• `Optional` **scratch\_cursor**: `string`
+
+___
+
+### custom\_css
+
+• `Optional` **custom\_css**: `string`
+
+___
+
+### custom\_skin\_folder
+
+• `Optional` **custom\_skin\_folder**: `string`
+
+___
+
+### jackpot\_symbol
+
+• `Optional` **jackpot\_symbol**: `string`
+
+___
+
+### promo\_image
+
+• `Optional` **promo\_image**: `string`
+
+___
+
+### promo\_text
+
+• `Optional` **promo\_text**: `string`
+
+___
+
+### matchx\_banner
+
+• `Optional` **matchx\_banner**: `string`
+
+___
+
+### matchx\_banner\_mobile
+
+• `Optional` **matchx\_banner\_mobile**: `string`
+
+___
+
+### matchx\_seasonal\_ranking
+
+• `Optional` **matchx\_seasonal\_ranking**: `boolean`
+
+___
+
+### matchx\_is\_completed
+
+• `Optional` **matchx\_is\_completed**: `boolean`
+
+___
+
+### matchx\_general\_board\_users\_count
+
+• `Optional` **matchx\_general\_board\_users\_count**: `number`
+
+___
+
+### matchx\_hide\_ranking
+
+• `Optional` **matchx\_hide\_ranking**: `boolean`
+
+___
+
+### ask\_for\_username
+
+• `Optional` **ask\_for\_username**: [`SAWAskForUsername`](../enums/SAWAskForUsername.md)
+
+___
+
+### show\_prize\_board
+
+• `Optional` **show\_prize\_board**: `boolean`
+
+___
+
+### max\_spins\_period\_ms
+
+• `Optional` **max\_spins\_period\_ms**: `number`
+
+___
+
+### show\_countdown\_for\_next\_availability
+
+• `Optional` **show\_countdown\_for\_next\_availability**: `boolean`
+
+___
+
+### disable\_background\_music
+
+• `Optional` **disable\_background\_music**: `boolean`
+
+___
+
+### custom\_section\_id
+
+• `Optional` **custom\_section\_id**: `number`
+
+___
+
+### only\_in\_custom\_section
+
+• `Optional` **only\_in\_custom\_section**: `boolean`
+
+___
+
+### custom\_data
+
+• **custom\_data**: `any`
+
+___
+
+### placeholder1
+
+• `Optional` **placeholder1**: `string`
+
+___
+
+### placeholder2
+
+• `Optional` **placeholder2**: `string`
+
+___
+
+### prize\_drop\_template
+
+• `Optional` **prize\_drop\_template**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+| `content` | `string` |
+
+___
+
+### game\_layout
+
+• `Optional` **game\_layout**: [`SAWGameLayout`](../enums/SAWGameLayout.md)
+
+___
+
+### steps\_to\_finish\_game
+
+• `Optional` **steps\_to\_finish\_game**: `number`
+
+___
+
+### wheel\_layout
+
+• `Optional` **wheel\_layout**: `SAWWheelLayout`
+
+___
+
+### background\_music\_volume
+
+• `Optional` **background\_music\_volume**: `number`

package/docs/interfaces/TInboxMessage.md

@@ -36,6 +36,6 @@ ___
 
 ### category\_id
 
-• `Optional` **category\_id**: `InboxCategories`
+• `Optional` **category\_id**: [`InboxCategories`](../enums/InboxCategories.md)
 
 Category id per inbox message, can be part of System inboxes, Personal inboxes or General inbox messages

package/docs/interfaces/TMiniGamePrize.md

@@ -79,7 +79,7 @@ ___
 
 ### acknowledge\_type
 
-• **acknowledge\_type**: `SAWAcknowledgeTypeName`
+• **acknowledge\_type**: [`SAWAcknowledgeTypeName`](../enums/SAWAcknowledgeTypeName.md)
 
 Type of acknowledge message for users
 
@@ -215,7 +215,7 @@ ___
 
 ### prize\_modifiers
 
-• `Optional` **prize\_modifiers**: `PrizeModifiers`[]
+• `Optional` **prize\_modifiers**: [`PrizeModifiers`](../enums/PrizeModifiers.md)[]
 
 Prize modifiers that will multiply by 2x, 5x or 10x the current total. This will not affect the final Prize Amount that will be awarded.
 

package/docs/interfaces/TMiniGameTemplate.md

@@ -214,7 +214,7 @@ ___
 
 ### saw\_template\_ui\_definition
 
-• **saw\_template\_ui\_definition**: `SAWTemplateUI`
+• **saw\_template\_ui\_definition**: [`SAWTemplateUI`](SAWTemplateUI.md)
 
 The UI definition of the mini-game
 

package/docs/interfaces/TUICustomSection.md

@@ -44,7 +44,7 @@ ___
 
 ### section\_type\_id
 
-• `Optional` **section\_type\_id**: `AchCustomSectionType`
+• `Optional` **section\_type\_id**: [`AchCustomSectionType`](../enums/AchCustomSectionType.md)
 
 The particular type of custom section, can be Missions, Tournaments, Lootbox and etc
 

package/package.json

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

package/src/Jackpots/JackpotPot.ts

@@ -1,10 +1,12 @@
 enum JackPotTemparature {
-	/** cold */
+	/** cold, seed amount < current pot < (min amount - seed amount)/2 */
 	COLD = 0,
-	/** warm */
+	/** warm, (min amount - seed amount)/2 < current pot < min amount */
 	WARM = 1,
-	/** hot */
-	HOT = 2
+	/** hot, current pot > min amount, entered explosion range */
+	HOT = 2,
+	/** burning, current pot > min amount + 0.5 * (max amount - min amount). E.g. mid of allowed explosion range */
+	BURNING = 3,
 }
 
 interface JackpotPot {
@@ -18,12 +20,8 @@ interface JackpotPot {
 	current_pot_amount_user_currency: number;
 	/** the date/time when this pot exploded */
 	explode_date_ts: number;
-	/** current pot temperature
-	 * 0 - cold. seed amount < current pot < (min amount - seed amount)/2
-	 * 1 - warm. (min amount - seed amount)/2 < current pot < min amount
-	 * 2 - hot.  current pot > min amount
-	 */
+	/** current pot temperature */
 	current_pot_temperature: JackPotTemparature;
 }
 
-export { JackpotPot };
+export { JackpotPot, JackPotTemparature };

package/src/MiniGames/SAWSpinErrorCode.ts

@@ -18,4 +18,8 @@ export enum SAWSpinErrorCode {
 	SAW_VISITOR_STOP_SPIN_REQUEST = -40001,
 	/** User is not in the segment */
 	SAW_NOT_IN_SEGMENT = 40009,
+	/** User doesn't have enough gems to play. In case buy in type for the game is 'gems' based */
+	SAW_NO_BALANCE_GEMS = 40011,
+	/** User doesn't have enough diamonds to play. In case buy in type for the game is 'diamonds' based */
+	SAW_NO_BALANCE_DIAMONDS = 40012,
 }

package/src/Raffle/GetDrawRunResponse.ts

@@ -7,7 +7,7 @@ export interface GetDrawRunResponse extends ProtocolResponse {
 	draw: RaffleDraw;
 }
 
-
+/** @hidden */
 export const drawRunTransform = (res: GetDrawRunResponse): TRaffleDraw => {
 	return {
 		id: res.draw.draw_id,

package/src/Raffle/GetRaffleDrawRunsHistoryResponse.ts

@@ -6,6 +6,7 @@ export interface GetRaffleDrawRunsHistoryResponse extends ProtocolResponse {
 	draw_runs: RaffleDrawRun[];
 }
 
+/** @hidden */
 export const drawRunHistoryTransform = (res: GetRaffleDrawRunsHistoryResponse): TRaffleDrawRun[] => {
 	return res.draw_runs.map((item) => {
 		return {

package/src/Raffle/GetRafflesResponse.ts

@@ -10,6 +10,7 @@ export interface GetRafflesResponse extends ProtocolResponse {
 	items: Raffle[];
 }
 
+/** @hidden */
 export const ticketsTransform = (items: RaffleTicket[]): TRaffleTicket[] => {
 	return items.map((item) => {
 		return {
@@ -19,6 +20,7 @@ export const ticketsTransform = (items: RaffleTicket[]): TRaffleTicket[] => {
 	});
 };
 
+/** @hidden */
 export const winnersTransform = (items: RafflePrizeWinner[]): TRafflePrizeWinner[] => {
 	return items.map((item) => {
 		return {
@@ -32,6 +34,7 @@ export const winnersTransform = (items: RafflePrizeWinner[]): TRafflePrizeWinner
 	});
 };
 
+/** @hidden */
 export const prizeTransform = (items: RafflePrize[]): TRafflePrize[] => {
 	return items.map((item) => {
 		return {
@@ -54,6 +57,7 @@ export const prizeTransform = (items: RafflePrize[]): TRafflePrize[] => {
 	});
 };
 
+/** @hidden */
 export const drawTransform = (items: RaffleDraw[]): TRaffleDraw[] => {
 	return items.map((item) => {
 		return {
@@ -82,6 +86,7 @@ export const drawTransform = (items: RaffleDraw[]): TRaffleDraw[] => {
 	});
 };
 
+/** @hidden */
 export const raffleTransform = (items: Raffle[]): TRaffle[] => {
 	return items.map((item) => {
 		return {

package/src/Raffle/Raffle.ts

@@ -48,4 +48,4 @@ interface Raffle {
 
 }
 
-export { Raffle };
+export { Raffle, RafflePublicMeta };

package/src/Raffle/RaffleClaimPrizeResponse.ts

@@ -6,7 +6,7 @@ export interface RaffleClaimPrizeResponse extends ProtocolResponse {
     errMsg?: string
 }
 
-
+/** @hidden */
 export const raffleClaimPrizeResponseTransform = (info: RaffleClaimPrizeResponse): TransformedRaffleClaimPrizeResponse => {
     return {
         errorCode: info.errCode,

package/src/Raffle/RafflePrize.ts

@@ -119,4 +119,4 @@ interface RafflePrize {
 	winners: RafflePrizeWinner[];
 }
 
-export { RafflePrize }
+export { RafflePrize, RafflePrizePublicMeta, RafflePrizeWinner }

package/src/Raffle/index.ts

@@ -12,3 +12,4 @@ export * from './GetRaffleDrawRunsHistoryRequest';
 export * from './GetRaffleDrawRunsHistoryResponse';
 export * from './RaffleClaimPrizeRequest';
 export * from './RaffleClaimPrizeResponse';
+export * from './RaffleDrawPublicMeta';

package/src/SmarticoAPI.ts

@@ -377,7 +377,7 @@ class SmarticoAPI {
 					ClassId.GET_TRANSLATIONS_REQUEST,
 					{
 						lang_code: DEFAULT_LANG_EN,
-						hash_code: 0,
+						hash_code: null,
 						areas,
 					},
 				);
@@ -390,7 +390,7 @@ class SmarticoAPI {
 						ClassId.GET_TRANSLATIONS_REQUEST,
 						{
 							lang_code,
-							hash_code: 0,
+							hash_code: null,
 							areas,
 						},
 					);

package/src/Store/BuyStoreItemErrorCode.ts

@@ -15,4 +15,8 @@ export enum BuyStoreItemErrorCode {
 	SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006,
 	/** Failed to buy item because no more items are available */
 	SHOP_FAILED_POOL_EMPTY = 11009,
+	/** User doesn't have enough gems on balance */
+	SHOP_NO_BALANCE_GEMS = 11011,
+	/** User doesn't have enough diamonds on balance */
+	SHOP_NO_BALANCE_DIAMONDS = 11012,
 }

package/src/WSAPI/WSAPITypes.ts

@@ -1,7 +1,7 @@
 import { BuyStoreItemErrorCode } from '../Store';
-import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
-import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
-import { AchCategory, AchievementAvailabilityStatus } from '../Missions';
+import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWDoAknowledgeResponse, SAWGameLayout, SAWGameType, SAWGameTypeName, SAWPrize, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI, SAWWheelLayout } from '../MiniGames';
+import { Tournament, TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
+import { AchCategory, AchievementAvailabilityStatus, UserAchievement } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections';
 import { BonusStatus , BonusTemplateMetaMap, BonusMetaMap} from '../Bonuses';
@@ -9,6 +9,7 @@ import { PrizeModifiers } from '../MiniGames/PrizeModifiers';
 import { InboxCategories } from '../Inbox/InboxCategories';
 import { RaffleDrawInstanceState, RaffleDrawTypeExecution } from '../Raffle';
 import { JackPotWinner } from '../Jackpots/JackPotWinner';
+import { GetRelatedAchTourResponse } from '../Missions/GetRelatedAchTourResponse';
 
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
@@ -1189,3 +1190,4 @@ export interface TransformedRaffleClaimPrizeResponse {
 }
 
 
+export { SAWAcknowledgeTypeName, PrizeModifiers, SAWTemplateUI, InboxCategories, AchCustomSectionType, SAWAskForUsername, SAWGameLayout }

package/dist/Quiz/MarketsAnswersType.d.ts

@@ -1,22 +0,0 @@
-export declare enum MarketsValueType {
-    HomeTeam = "1",
-    AwayTeam = "2",
-    Draw = "x",
-    HomeTeamHomeTeam = "1/1",
-    HomeTeamDraw = "1/x",
-    HomeTeamAwayTeam = "1/2",
-    DrawHomeTeam = "x/1",
-    DrawDraw = "x/x",
-    DrawAwayTeam = "x/2",
-    AwayTeamHomeTeam = "2/1",
-    AwayTeamDraw = "2/x",
-    AwayTeamAwayTeam = "2/2",
-    Yes = "yes",
-    No = "no",
-    Odd = "odd",
-    Even = "even",
-    HomeOdd = "1/odd",
-    HomeEven = "1/even",
-    AwayOdd = "2/odd",
-    AwayEven = "2/even"
-}

package/dist/Raffle/GetDrawResponse.d.ts

@@ -1,5 +0,0 @@
-import { ProtocolResponse } from '../Base/ProtocolResponse';
-import { RaffleDraw } from './RaffleDraw';
-export interface GetDrawResponse extends ProtocolResponse {
-    draw: RaffleDraw;
-}

package/dist/SmarticoPublicAPI.d.ts

@@ -1,23 +0,0 @@
-import { ClassId } from "./Base/ClassId";
-import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
-import { SAWTemplate } from './MiniGames/SAWTemplate';
-import { ILogger } from './ILogger';
-interface IOptions {
-    logger?: ILogger;
-    logCIDs?: ClassId[];
-    logHTTPTiming?: boolean;
-}
-declare class SmarticoPublicApi {
-    private label_api_key;
-    private brand_api_key;
-    private publicUrl;
-    private logger;
-    private logCIDs;
-    private logHTTPTiming;
-    constructor(label_api_key: string, brand_api_key: string, options?: IOptions);
-    private send;
-    private buildMessage;
-    miniGamesGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
-    miniGamesFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): any[];
-}
-export { SmarticoPublicApi };

package/dist/Store/BuyShopItemErrorCode.d.ts

@@ -1,10 +0,0 @@
-export declare enum BuyShopItemErrorCode {
-    FAILED_TO_BUY_SHOP_ITEM = 121,
-    SHOP_NO_BALANCE = 11000,
-    SHOP_WRONG_LABEL = 11001,
-    SHOP_FAILED_TO_BUY_BONUS = 11002,
-    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003,
-    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004,
-    SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
-    SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006
-}

package/dist/Store/BuyShopItemRequest.d.ts

@@ -1,4 +0,0 @@
-import { ProtocolMessage } from "../Base/ProtocolMessage";
-export interface BuyShopItemRequest extends ProtocolMessage {
-    itemId: number;
-}

package/dist/Store/BuyShopItemResponse.d.ts

@@ -1,4 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-export interface BuyShopItemResponse extends ProtocolResponse {
-    success?: boolean;
-}

package/dist/Store/GetCategoriesShopResponse.d.ts

@@ -1,5 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-import { ShopCategory } from "./ShopCategory";
-export interface GetCategoriesShopResponse extends ProtocolResponse {
-    categories: ShopCategory[];
-}

package/dist/Store/GetShopItemsResponse.d.ts

@@ -1,5 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-import { ShopItem } from "./ShopItem";
-export interface GetShopItemsResponse extends ProtocolResponse {
-    items: ShopItem[];
-}

package/dist/Store/ShopCategory.d.ts

@@ -1,5 +0,0 @@
-import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
-export interface ShopCategory {
-    id?: number;
-    publicMeta?: ShopCategoryPublicMeta;
-}

package/dist/Store/ShopCategoryPublicMeta.d.ts

@@ -1,4 +0,0 @@
-export interface ShopCategoryPublicMeta {
-    name?: string;
-    order?: number;
-}

package/dist/Store/ShopItem.d.ts

@@ -1,9 +0,0 @@
-import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
-import { ShopItemType } from "./ShopItemType";
-export interface ShopItem {
-    id: number;
-    itemTypeId: ShopItemType;
-    itemPublicMeta: ShopItemPublicMeta;
-    categoryIds?: number[];
-    canBuy?: boolean;
-}

package/dist/Store/ShopItemPublicMeta.d.ts

@@ -1,10 +0,0 @@
-export interface ShopItemPublicMeta {
-    price: string;
-    image_url: string;
-    name: string;
-    description: string;
-    label_tag: string;
-    limit_message: string;
-    priority: number;
-    related_items: number[];
-}

package/dist/Store/ShopItemType.d.ts

@@ -1,4 +0,0 @@
-export declare enum ShopItemType {
-    Bonus = 1,
-    Manual = 2
-}

package/dist/Store/StorItemPruchased.d.ts

@@ -1,6 +0,0 @@
-import { StoreItem } from "./StoreItem";
-interface StorItemPruchased extends StoreItem {
-    purchase_ts: number;
-    purchase_points_amount: number;
-}
-export { StorItemPruchased };

package/dist/service/index.d.ts

@@ -1,5 +0,0 @@
-import { ErrorCodes, ErrorCodesGame } from './types/ErrorCodes';
-import { GBaseRequest } from './types/GRequest';
-import { GResponseBase, GResponse } from './types/GResponse';
-import { SAWSpinErrorCode } from './types/SmarticoProto/SAW/SAWDoSpinResponse';
-export { ErrorCodes, ErrorCodesGame, SAWSpinErrorCode, GBaseRequest, GResponseBase, GResponse, };