@smartico/public-api 0.0.216 → 0.0.217

package/dist/Base/ClassId.d.ts

@@ -99,6 +99,10 @@ export declare enum ClassId {
     JP_OPTOUT_REQUEST = 806,
     JP_OPTOUT_RESPONSE = 807,
     JP_WIN_PUSH = 808,
+    RAF_GET_RAFFLES_REQUEST = 900,
+    RAF_GET_RAFFLES_RESPONSE = 901,
+    RAF_GET_DRAW_REQUEST = 904,
+    RAF_GET_DRAW_RESPONSE = 905,
     REGISTER_PUSH_NOTIFICATIONS_TOKEN_REQ = 1003,
     REGISTER_PUSH_NOTIFICATIONS_TOKEN_RESP = 2003,
     CLIENT_DEBUG_REQUEST = 77777,

package/dist/Raffle/GetDrawResponse.d.ts

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

package/dist/Raffle/GetDrawRunRequest.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+export interface GetDrawRunRequest extends ProtocolMessage {
+    raffle_id: number;
+    run_id: number;
+}

package/dist/Raffle/GetDrawRunResponse.d.ts

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

package/dist/Raffle/GetRafflesRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+export interface GetRafflesRequest extends ProtocolMessage {
+    skip_public_meta?: boolean;
+}

package/dist/Raffle/GetRafflesResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { Raffle } from './Raffle';
+export interface GetRafflesResponse extends ProtocolResponse {
+    items: Raffle[];
+}

package/dist/Raffle/Raffle.d.ts

@@ -0,0 +1,34 @@
+import { RaffleDraw } from "./RaffleDraw";
+interface RafflePublicMeta {
+    /** Name of the raffle */
+    name: string;
+    /** Description of the raffle */
+    description: string;
+    /** ID of the custom section that is linked to the raffle in the Gamification widget */
+    custom_section_id: number;
+    /** URL of the image that represents the raffle */
+    image_url: string;
+}
+interface Raffle {
+    /** ID of the Raffle template */
+    raffle_id: number;
+    /** Meta information about raffle for the presentation on UI */
+    public_meta: RafflePublicMeta;
+    /** Date of start */
+    start_date_ts: number;
+    /** Date of end */
+    end_date_ts: number;
+    /** Maximum numer of tickets that can be given to all users for the whole period of raffle */
+    max_tickets_count: number;
+    /**
+     * Number of tickets that are already given to all users for this raffle
+     */
+    current_tickets_count: number;
+    /**
+     * List of draws that are available for this raffle.
+     * For example, if the raffle is containg one hourly draw, one daily draw and one draw on fixed date like 01/01/2022,
+     * Then the list will always return 3 draws, no matter if the draws are already executed or they are in the future.
+     */
+    draws: RaffleDraw[];
+}
+export { Raffle };

package/dist/Raffle/RaffleDraw.d.ts

@@ -0,0 +1,70 @@
+import { RafflePrize } from "./RafflePrize";
+import { RaffleTicket } from "./RaffleTicket";
+interface RaffleDrawPublicMeta {
+    /** Name of the draw, e.g. 'Daily draw' */
+    name: string;
+    /** Description of the draw */
+    description: string;
+    /** URL of the image that represents the draw */
+    image_url: string;
+}
+declare enum RaffleDrawInstanceState {
+    /** Draw is open for the tickets collection */
+    Open = 1,
+    /** Winner selection is in progress */
+    WinnerSelection = 2,
+    /** Draw is executed and the winners are selected */
+    Executed = 3
+}
+interface RaffleDraw {
+    /**
+     * Id of the Draw definition, for the repetative draws (e.g. daily), this number will be the same for all draws that are repeating daily
+     * (internal name: schedule_id)
+     */
+    draw_id: number;
+    /** Meta information of the Draw for the presentaiton in UI */
+    public_meta: RaffleDrawPublicMeta;
+    /** Information about prizes in the draw */
+    prizes: RafflePrize[];
+    /**
+     * State of current instance of Draw
+     */
+    current_state: RaffleDrawInstanceState;
+    /**
+     * Field indicates the ID of the latest instance/run of draw
+    */
+    run_id: number;
+    /** Date/time of the draw execution */
+    execution_ts: number;
+    /** Date of the previously executed draw (if there is such) */
+    previous_run_ts?: number;
+    /** Unique ID of the previusly executed draw (if there is such) */
+    previous_run_id?: number;
+    /**
+     *  Date/time starting from which the tickets will participate in the upcoming draw
+     *  This value need to be taken into account with next_execute_ts field value, for example
+     *  Next draw is at 10:00, tickets_time_back_ts is 9:00, so all tickets that are collected after 9:00 will participate in the draw at 10:00
+     *  (internally this value is calculated as next_execute_ts - time_back_period_ms)
+     */
+    tickets_time_back_ts: number;
+    /** Field is indicating if same ticket can win multiple prizes in the same draw
+     *  For example there are 3 types of prizes in the draw - iPhone, iPad, MacBook
+     *  If this field is true, then one ticket can win all 3 prizes (depending on the chances of course),
+     *  if false, then one ticket can win only one prize.
+     *  The distribution of the prizes is start from top (assuming on top are the most valuable prizes) to bottom (less valuable prizes)
+     *  If specific prize has multiple values, e.g. we have 3 iPhones,
+     *  then the same ticket can win only one prize of a kind, but can win multiple prizes of different kind (if allow_multi_prize_per_ticket is true)
+    */
+    allow_multi_prize_per_ticket: boolean;
+    /**
+     * The number of tickets that are already given to all users for this instance of draw.
+     * In other words tickets that are collected between tickets_time_back_ts and current time (or till current_execution_ts is the instance is executed).
+     */
+    total_tickets_count: number;
+    /**
+     * The number of tickets collected by current user for this instance of draw.
+     */
+    my_tickets_count: number;
+    my_last_tickets: RaffleTicket[];
+}
+export { RaffleDraw };

package/dist/Raffle/RafflePrize.d.ts

@@ -0,0 +1,97 @@
+import { RafflePrizeWinner } from "./RafflePrizeWinner";
+interface RafflePrizePublicMeta {
+    /** Name of the prize */
+    name: string;
+    /** Description of the prize */
+    description: string;
+    /** URL of the image that represents the prize */
+    image_url: string;
+}
+/**
+ * Represents a prize in a draw.
+ */
+interface RafflePrize {
+    /**
+     * The unique identifier for the prize definition
+     */
+    prize_id: string;
+    /**
+     * Meta information about the prize for presentation in the UI.
+     */
+    public_meta: RafflePrizePublicMeta;
+    /**
+     * The number of prizes available per run of the draw.
+     * E.g. if the draw is run daily, this is the number of prizes available each day, for example 3 iPhones.
+     */
+    prizes_per_run: number;
+    /**
+     * The actual number of prizes for the current instance.
+     * This value is taking into account follwing values:
+     *  - min_required_total_tickets,
+     *  - add_one_prize_per_each_x_tickets
+     *  - stock_items_per_draw
+     *  - total_tickets_count (from Draw instance)
+     *  - cap_prizes_per_run
+     * For example:
+     *  - prizes_per_run = 1
+     *  - min_required_total_tickets = 1000
+     *  - add_one_prize_per_each_x_tickets = 1000
+     *  - stock_items_per_draw = 5
+     *  - total_tickets_count = 7000
+     *  - cap_prizes_per_run = 6
+     *  prizes_per_run_actual will be 5, because
+     *  7000 tickets are collected, so 7 iPhones are available, but the cap is 6 and the stock is 5.
+    */
+    prizes_per_run_actual: number;
+    /**
+     *
+     * The chances to win the prize by current player.
+     * Calculated as the ratio of the number of tickets collected by the current player to the
+     * total number of tickets collected by all players and multiplied by number of actual prizes of this kind.
+     */
+    chances_to_win_perc: number;
+    /**
+     * The minimum number of total tickets collected during draw period required to unlock the prize.
+     * If the number of tickets collected is less than this value, the prize is not available.
+     * Under total tickets we understand the number of tickets collected by all users.
+     * The 'draw period' is the time between the tickets_time_back_ts value of the draw and the current time.
+     */
+    min_required_total_tickets?: number;
+    /**
+     * One additional prize will be awarded for each X tickets.
+     * E.g. if the prize is 1 iPhone and the value is set to 1000, then for every 1000 tickets collected, an additional iPhone is awarded.
+     * If min_required_total_tickets is set to 1000, then next iPhone is awarded when 2000 tickets are collected, and so on.
+     * If min_required_total_tickets is not set, then the next iPhone will be awarded when 1000 tickets are collected.
+     */
+    add_one_prize_per_each_x_tickets?: number;
+    /**
+     * Indicates whether the prize requires a claim action from the user.
+     */
+    requires_claim: boolean;
+    /**
+     * The minimum number of tickets a user must have to be eligible for the prize.
+     * For example iPhone prize may require 10 tickets to be collected, only users with 10 or more tickets will be eligible for the prize.
+     * More tickets are better, as they increase the chances of winning.
+     */
+    min_required_tickets_for_user: number;
+    /**
+     * The maximum number of prizes that can be given withing one instance/run of draw.
+     * For example the prize is iPhone and add_one_prize_per_each_x_tickets is set to 1000,
+     * cap_prizes_per_run is set to 3, and the total number of tickets collected is 7000.
+     * In this case, the prizes_per_run_actual will be limitted by 3
+     */
+    cap_prizes_per_run?: number;
+    /**
+     * The priority of the prize. The low number means higher priority (e.g. 1 is higher priority than 2).
+     * If there are multiple prizes available, the prize with the highest priority (lowest number) will be awarded first.
+     */
+    priority: number;
+    /**
+     * Optional field that indicates total remaining number of the prize for all draws of the type.
+     * For example, the Daily draw has 1 iPhone daily, and the total number of iPhones is 10.
+     * the stock_items_per_draw will be decreasing by 1 each day (assuming there is enough tickets and it is won every day), and when it reaches 0, the prize is not available anymore.
+     */
+    stock_items_per_draw?: number;
+    winners: RafflePrizeWinner[];
+}
+export { RafflePrize };

package/dist/Raffle/RafflePrizeWinner.d.ts

@@ -0,0 +1,9 @@
+import { RaffleTicket } from "./RaffleTicket";
+interface RafflePrizeWinner {
+    user_id: number;
+    public_username?: string;
+    avatar_id: string;
+    avatar_url?: string;
+    ticket: RaffleTicket;
+}
+export { RafflePrizeWinner };

package/dist/Raffle/RaffleTicket.d.ts

@@ -0,0 +1,5 @@
+interface RaffleTicket {
+    id: number;
+    s: string;
+}
+export { RaffleTicket };

package/dist/Raffle/index.d.ts

@@ -0,0 +1,9 @@
+export * from './GetDrawRunRequest';
+export * from './GetDrawRunResponse';
+export * from './GetRafflesRequest';
+export * from './GetRafflesResponse';
+export * from './Raffle';
+export * from './RaffleDraw';
+export * from './RafflePrize';
+export * from './RafflePrizeWinner';
+export * from './RaffleTicket';

package/dist/SmarticoAPI.d.ts

@@ -19,6 +19,7 @@ import { ClaimBonusResponse, GetBonusesResponse } from './Bonuses';
 import { SAWDoSpinBatchResponse } from './MiniGames/SAWDoSpinBatchResponse';
 import { SAWDoAcknowledgeBatchResponse } from './MiniGames/SAWDoAcknowledgeBatchResponse';
 import { GetRelatedAchTourResponse } from './Missions/GetRelatedAchTourResponse';
+import { GetRafflesResponse } from './Raffle/GetRafflesResponse';
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
@@ -127,5 +128,6 @@ declare class SmarticoAPI {
     deleteAllInboxMessages(user_ext_id: string): Promise<MarkInboxMessageDeletedResponse>;
     getWSCalls(): WSAPI;
     getRelatedItemsForGame(user_ext_id: string, related_game_id: string): Promise<GetRelatedAchTourResponse>;
+    getRaffles(user_ext_id: string): Promise<GetRafflesResponse>;
 }
 export { SmarticoAPI, MessageSender };

package/dist/WSAPI/WSAPI.d.ts

@@ -3,6 +3,7 @@ import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreIte
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { JackpotDetails, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 import { GetRelatedAchTourResponse } from 'src/Missions/GetRelatedAchTourResponse';
+import { GetRafflesResponse } from '../Raffle/GetRafflesResponse';
 /** @group General API */
 export declare class WSAPI {
     private api;
@@ -541,4 +542,5 @@ export declare class WSAPI {
      * ```
      */
     getRelatedItemsForGame(related_game_id: string): Promise<GetRelatedAchTourResponse>;
+    getRaffles(): Promise<GetRafflesResponse>;
 }

package/dist/index.js

@@ -123,6 +123,15 @@ exports.ClassId = void 0;
   ClassId[ClassId["JP_OPTOUT_REQUEST"] = 806] = "JP_OPTOUT_REQUEST";
   ClassId[ClassId["JP_OPTOUT_RESPONSE"] = 807] = "JP_OPTOUT_RESPONSE";
   ClassId[ClassId["JP_WIN_PUSH"] = 808] = "JP_WIN_PUSH";
+  ClassId[ClassId["RAF_GET_RAFFLES_REQUEST"] = 900] = "RAF_GET_RAFFLES_REQUEST";
+  ClassId[ClassId["RAF_GET_RAFFLES_RESPONSE"] = 901] = "RAF_GET_RAFFLES_RESPONSE";
+  ClassId[ClassId["RAF_GET_DRAW_REQUEST"] = 904] = "RAF_GET_DRAW_REQUEST";
+  ClassId[ClassId["RAF_GET_DRAW_RESPONSE"] = 905] = "RAF_GET_DRAW_RESPONSE";
+  /*
+  RAF_GET_TICKETS_REQUEST = 902,
+  RAF_GET_TICKETS_RESPONSE = 903,
+   RAF_CLAIM_PRIZE_REQUEST = 906,
+  */
   /*
       !Important, if adding new messages that are 'acting' on behalf of the client,
       you need to include them in the CLASS_ID_IGNORE_FOR_SIMULATION
@@ -413,6 +422,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
       saw_template_ui_definition: r.saw_template_ui_definition,
       show_prize_history: r.show_prize_history,
       prizes: r.prizes.map(function (p) {
+        var _p$saw_prize_ui_defin;
         var y = {
           id: p.saw_prize_id,
           name: p.saw_prize_ui_definition.name,
@@ -439,7 +449,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
           relative_period_timezone: p.relative_period_timezone,
           is_surcharge: p.is_surcharge,
           is_deleted: p.is_deleted,
-          custom_data: IntUtils.JsonOrText(r.saw_template_ui_definition.custom_data),
+          custom_data: IntUtils.JsonOrText((_p$saw_prize_ui_defin = p.saw_prize_ui_definition) == null ? void 0 : _p$saw_prize_ui_defin.custom_data),
           prize_modifiers: p.saw_prize_ui_definition.prize_modifiers,
           allow_split_decimal: p.saw_prize_ui_definition.allow_split_decimal,
           hide_prize_from_history: p.saw_prize_ui_definition.hide_prize_from_history
@@ -2703,6 +2713,14 @@ var WSAPI = /*#__PURE__*/function () {
       return Promise.reject(e);
     }
   };
+  _proto.getRaffles = function getRaffles() {
+    try {
+      var _this46 = this;
+      return Promise.resolve(_this46.api.getRaffles(null));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
   return WSAPI;
 }();
 
@@ -3875,6 +3893,15 @@ var SmarticoAPI = /*#__PURE__*/function () {
       return Promise.reject(e);
     }
   };
+  _proto.getRaffles = function getRaffles(user_ext_id) {
+    try {
+      var _this63 = this;
+      var message = _this63.buildMessage(user_ext_id, exports.ClassId.RAF_GET_RAFFLES_REQUEST);
+      return Promise.resolve(_this63.send(message, exports.ClassId.RAF_GET_DRAW_RESPONSE));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
   return SmarticoAPI;
 }();