@smartico/public-api 0.0.158 → 0.0.159

package/.prettierrc

@@ -1,12 +1,12 @@
 {
-    "arrowParens": "always",
-    "bracketSpacing": true,
-    "endOfLine": "lf",
-    "quoteProps": "consistent",
-    "semi": false,
-    "singleQuote": true,
-    "tabWidth": 4,
-    "printWidth": 200,
-    "useTabs": true,
-    "trailingComma": "all"
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"endOfLine": "lf",
+	"quoteProps": "consistent",
+	"semi": true,
+	"singleQuote": true,
+	"tabWidth": 4,
+	"printWidth": 130,
+	"useTabs": true,
+	"trailingComma": "all"
 }

package/dist/Bonuses/Bonus.d.ts

@@ -0,0 +1,20 @@
+import { BonusStatus } from './BonusStatus';
+import { BonusTemplateMetaMap } from './BonusTemplateMetaMap';
+import { BonusMetaMap } from './BonusMetaMap';
+import { TBonus } from '../WSAPI/WSAPITypes';
+export interface Bonus {
+    id: number;
+    redeemable?: boolean;
+    createDate?: string;
+    updateDate?: string;
+    redeemDate?: string;
+    engagementUid?: string;
+    labelBonusTemplateId?: number;
+    sourceProductRefId?: number;
+    sourceProductId?: number;
+    userId?: number;
+    bonusStatusId?: BonusStatus;
+    labelBonusTemplateMetaMap?: BonusTemplateMetaMap;
+    bonusMetaMap?: BonusMetaMap;
+}
+export declare const BonusItemsTransform: (items: Bonus[]) => TBonus[];

package/dist/Bonuses/BonusMetaMap.d.ts

@@ -0,0 +1,3 @@
+export interface BonusMetaMap {
+    uiAmount?: string;
+}

package/dist/Bonuses/BonusStatus.d.ts

@@ -0,0 +1,8 @@
+export declare enum BonusStatus {
+    New = 1,
+    COUPON_ISSUED = 2,
+    REDEEMED = 3,
+    REDEEM_FAILED = 4,
+    COUPON_ISSUE_FAILED = 5,
+    EXPIRED = 6
+}

package/dist/Bonuses/BonusTemplateMetaMap.d.ts

@@ -0,0 +1,5 @@
+export interface BonusTemplateMetaMap {
+    description: string;
+    acknowledge: string;
+    image_url: string;
+}

package/dist/Bonuses/ClaimBonusRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolRequest } from '../Base/ProtocolRequest';
+export interface ClaimBonusRequest extends ProtocolRequest {
+    bonusId: number;
+}

package/dist/Bonuses/ClaimBonusResponse.d.ts

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

package/dist/Bonuses/GetBonusesRequest.d.ts

@@ -0,0 +1,3 @@
+import { ProtocolRequest } from '../Base/ProtocolRequest';
+export interface GetBonusesRequest extends ProtocolRequest {
+}

package/dist/Bonuses/GetBonusesResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { Bonus } from './Bonus';
+export interface GetBonusesResponse extends ProtocolResponse {
+    bonuses: Bonus[];
+}

package/dist/Bonuses/index.d.ts

@@ -0,0 +1,7 @@
+export * from './Bonus';
+export * from './BonusMetaMap';
+export * from './BonusStatus';
+export * from './BonusTemplateMetaMap';
+export * from './ClaimBonusRequest';
+export * from './ClaimBonusResponse';
+export * from './GetBonusesResponse';

package/dist/SmarticoAPI.d.ts

@@ -11,10 +11,11 @@ import { GetTournamentInfoResponse, GetTournamentsResponse, TournamentRegisterRe
 import { LeaderBoardDetails, LeaderBoardPeriodType } from './Leaderboard';
 import { GetLevelMapResponse } from './Level';
 import { WSAPI } from './WSAPI/WSAPI';
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult, TUICustomSection } from './WSAPI/WSAPITypes';
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult, TUICustomSection, TBonus } from './WSAPI/WSAPITypes';
 import { GetAchievementsUserInfoResponse } from './Core/GetAchievementsUserInfoResponse';
 import { GetJackpotsPotsResponse, GetJackpotsResponse, JackpotsOptinResponse, JackpotsOptoutResponse } from './Jackpots';
 import { GetCustomSectionsResponse } from './CustomSections';
+import { ClaimBonusResponse, GetBonusesResponse } from './Bonuses';
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
@@ -93,6 +94,9 @@ declare class SmarticoAPI {
     achGetCategories(user_ext_id: string, force_language?: string): Promise<GetAchCategoriesResponse>;
     achGetCategoriesT(user_ext_id: string): Promise<TAchCategory[]>;
     badgetsGetItems(user_ext_id: string, force_language?: string): Promise<GetAchievementMapResponse>;
+    bonusesGetItems(user_ext_id: string, force_language?: string): Promise<GetBonusesResponse>;
+    bonusClaimItem(user_ext_id: string, bonus_id: number): Promise<ClaimBonusResponse>;
+    bonusesGetItemsT(user_ext_id: string): Promise<TBonus[]>;
     badgetsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
     tournamentsGetLobby(user_ext_id: string, force_language?: string): Promise<GetTournamentsResponse>;
     tournamentsGetLobbyT(user_ext_id: string): Promise<TTournament[]>;

package/dist/SmarticoLib/index.d.ts

@@ -1103,6 +1103,60 @@ export interface TMissionOrBadge {
     /** The date/timestamp indicating when the prize was claimed by the user */
     prize_claimed_date_ts?: number;
 }
+export declare enum BonusStatus {
+    /** The bonus is newly created (shouldn't be shown to the client) */
+    New = 1,
+    /** The bonus is issued and available for redemption but has not been redeemed yet */
+    COUPON_ISSUED = 2,
+    /** The bonus has been successfully redeemed */
+    REDEEMED = 3,
+    /** The bonus is still valid, but a previous redemption attempt failed */
+    REDEEM_FAILED = 4,
+    /** Failed to issue the bonus (shouldn't be shown to the client) */
+    COUPON_ISSUE_FAILED = 5,
+    /** The bonus was issued but has expired and can no longer be redeemed (shouldn't be shown to the client) */
+    EXPIRED = 6
+}
+export interface BonusTemplateMetaMap {
+    /** Description of the bonus template*/
+    description: string;
+    /** Acknowledge message setup in the bonus template*/
+    acknowledge: string;
+    /** Image URL of the bonus template*/
+    image_url: string;
+}
+export interface BonusMetaMap {
+    /** Label and description of the bonus sent to the player*/
+    uiAmount?: string;
+}
+export interface TBonus {
+    /** ID of the bonus */
+    bonus_id: number;
+    /** Can the bonus be redeemed (if bonus is redeemable the user needs to claim it) */
+    is_redeemable?: boolean;
+    /** Date of creation */
+    create_date?: string;
+    /** Date of last update */
+    update_date?: string;
+    /** Date of redemption */
+    redeem_date?: string;
+    /** Uniq identifier of the bonus sent to the player */
+    engagement_uid?: string;
+    /** ID of template used */
+    label_bonus_template_id?: number;
+    /** Reference ID of product */
+    source_product_ref_id?: number;
+    /** ID of product  */
+    source_product_id?: number;
+    /** ID of the user who created the bonus */
+    user_id?: number;
+    /** ID of the bonus status */
+    bonus_status_id?: BonusStatus;
+    /** Additional information about the bonus(edscription, image,name, acknowledge) */
+    label_bonus_template_meta_map?: BonusTemplateMetaMap;
+    /** Additional information presented to the player when the bonus is redeemed */
+    bonus_meta_map?: BonusMetaMap;
+}
 interface AchRelatedGame$1 {
     /** The ID of the related game */
     ext_game_id: string;
@@ -1561,6 +1615,8 @@ declare class WSAPI {
     }): Promise<TMissionOrBadge[]>;
     /** Returns all the badges available the current user */
     getBadges(): Promise<TMissionOrBadge[]>;
+    /** Returns all the badges available the current user */
+    getBonuses(): Promise<TBonus[]>;
     /**
      * Returns the extra counters for the current user level.
      * These are counters that are configured for each Smartico client separatly by request.
@@ -1599,7 +1655,7 @@ declare class WSAPI {
     /**
      * @param params
      */
-    storeGetPurchasedItems({ from, to, onUpdate }?: {
+    storeGetPurchasedItems({ from, to, onUpdate, }?: {
         from?: number;
         to?: number;
         onUpdate?: (data: TStoreItem[]) => void;
@@ -1649,7 +1705,7 @@ declare class WSAPI {
     /**
      * @param params
      */
-    getInboxMessages({ from, to, onlyFavorite, onUpdate }?: {
+    getInboxMessages({ from, to, onlyFavorite, onUpdate, }?: {
         from?: number;
         to?: number;
         onlyFavorite?: boolean;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,5 @@
 import { SmarticoAPI } from '../SmarticoAPI';
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT } from './WSAPITypes';
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT, TBonus, TClaimBonusResult } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { JackpotDetails, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 /** @group General API */
@@ -85,6 +85,21 @@ export declare class WSAPI {
      * **Visitor mode: not supported**
      */
     getBadges(): Promise<TMissionOrBadge[]>;
+    /**
+     * Returns all the bonuses for the current user
+     *
+     * **Visitor mode: not supported**
+     */
+    getBonuses(): Promise<TBonus[]>;
+    /**
+         * Claim the bonus by bonus_id. Returns the err_code in case of success or error.
+         * Note that this method can be used only on integrations where originally failed bonus can be claimed again.
+         * For example, user won a bonus in the mini-game, but Operator rejected this bonus.
+         * This bonus will be available for the user to claim again.
+         *
+         * **Visitor mode: not supported**
+         */
+    claimBonus(bonus_id: number): Promise<TClaimBonusResult>;
     /**
      * Returns the extra counters for the current user level.
      * These are counters that are configured for each Smartico client separatly by request.
@@ -163,7 +178,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getStorePurchasedItems({ limit, offset, onUpdate }?: {
+    getStorePurchasedItems({ limit, offset, onUpdate, }?: {
         limit?: number;
         offset?: number;
         onUpdate?: (data: TStoreItem[]) => void;
@@ -331,7 +346,7 @@ export declare class WSAPI {
      *
      * @param params
      */
-    getInboxMessages({ from, to, onlyFavorite, onUpdate }?: {
+    getInboxMessages({ from, to, onlyFavorite, onUpdate, }?: {
         from?: number;
         to?: number;
         onlyFavorite?: boolean;

package/dist/WSAPI/WSAPITypes.d.ts

@@ -3,6 +3,7 @@ import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorC
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections';
+import { BonusStatus, BonusTemplateMetaMap, BonusMetaMap } from '../Bonuses';
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
 /**
  * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
@@ -618,4 +619,33 @@ export interface TUICustomSection {
     /** Quantity of missions to be shown in overview */
     overview_missions_count?: number;
 }
+export interface TBonus {
+    /** ID of the bonus */
+    bonus_id: number;
+    /** Can the bonus be redeemed (if bonus is redeemable the user needs to claim it) */
+    is_redeemable?: boolean;
+    /** Date of creation */
+    create_date?: string;
+    /** Date of redemption */
+    redeem_date?: string;
+    /** ID of template used */
+    label_bonus_template_id?: number;
+    /** ID of the bonus status */
+    bonus_status_id?: BonusStatus;
+    /** Additional information about the bonus(edscription, image,name, acknowledge) */
+    label_bonus_template_meta_map?: BonusTemplateMetaMap;
+    /** Additional information presented to the player when the bonus is redeemed */
+    bonus_meta_map?: BonusMetaMap;
+}
+/**
+ * TClaimBonusResult describes the response of call to _smartico.api.claimBonus(bonus_id) method
+ */
+export interface TClaimBonusResult {
+    /** Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0 */
+    err_code: SAWSpinErrorCode;
+    /** Optional error message */
+    err_message: string;
+    /** If the bonus was claimed successfully, then success is true */
+    success?: boolean;
+}
 export {};

package/dist/index.d.ts

@@ -13,3 +13,4 @@ export * from './Level';
 export * from './Quiz';
 export * from './Jackpots';
 export * from './OCache';
+export * from './Bonuses';