@smartico/public-api 0.0.252 → 0.0.253

package/docs/interfaces/TRaffleDraw.md

@@ -0,0 +1,181 @@
+# Interface: TRaffleDraw
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+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)
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the draw, e.g. 'Daily draw'
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the draw
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+URL of the image that represents the draw
+
+___
+
+### image\_url\_mobile
+
+• **image\_url\_mobile**: `string`
+
+URL of the moible image that represents the draw
+
+___
+
+### icon\_url
+
+• **icon\_url**: `string`
+
+URL of the icon that represents the draw
+
+___
+
+### background\_image\_url
+
+• **background\_image\_url**: `string`
+
+URL of the background image that will be used in the draw list item
+
+___
+
+### background\_image\_url\_mobile
+
+• **background\_image\_url\_mobile**: `string`
+
+URL of the moible background image that will be used in the draw list item
+
+___
+
+### is\_grand
+
+• **is\_grand**: `boolean`
+
+Show if the draw is grand and is marked as special
+
+___
+
+### prizes
+
+• **prizes**: [`TRafflePrize`](TRafflePrize.md)[]
+
+Information about prizes in the draw
+
+___
+
+### current\_state
+
+• **current\_state**: [`RaffleDrawInstanceState`](../enums/RaffleDrawInstanceState.md)
+
+State of current instance of Draw
+
+___
+
+### run\_id
+
+• **run\_id**: `number`
+
+Field indicates the ID of the latest instance/run of draw
+
+___
+
+### execution\_type
+
+• **execution\_type**: [`RaffleDrawTypeExecution`](../enums/RaffleDrawTypeExecution.md)
+
+Type of the draw execution, indicating how and when the draw is executed.
+- ExecDate: Draw is executed only once at a specific date and time.
+- Recurring: Draw is executed on a recurring basis (e.g., daily, weekly).
+- Grand: Draw is executed once and is marked as grand, often with larger prizes or more importance.
+
+___
+
+### execution\_ts
+
+• **execution\_ts**: `number`
+
+Date/time of the draw execution
+
+___
+
+### previous\_run\_ts
+
+• `Optional` **previous\_run\_ts**: `number`
+
+Date of the previously executed draw (if there is such)
+
+___
+
+### previous\_run\_id
+
+• `Optional` **previous\_run\_id**: `number`
+
+Unique ID of the previusly executed draw (if there is such)
+
+___
+
+### ticket\_start\_ts
+
+• **ticket\_start\_ts**: `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, ticket_start_date 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 - ticket_start_date)
+
+___
+
+### allow\_multi\_prize\_per\_ticket
+
+• **allow\_multi\_prize\_per\_ticket**: `boolean`
+
+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)
+
+___
+
+### total\_tickets\_count
+
+• **total\_tickets\_count**: `number`
+
+The number of tickets that are already given to all users for this instance of draw.
+In other words tickets that are collected between ticket_start_date and current time (or till current_execution_ts is the instance is executed).
+
+___
+
+### my\_tickets\_count
+
+• **my\_tickets\_count**: `number`
+
+The number of tickets collected by current user for this instance of draw.
+
+___
+
+### my\_last\_tickets
+
+• **my\_last\_tickets**: [`TRaffleTicket`](TRaffleTicket.md)[]

package/docs/interfaces/TRaffleDrawRun.md

@@ -0,0 +1,125 @@
+# Interface: TRaffleDrawRun
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+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)
+
+___
+
+### run\_id
+
+• **run\_id**: `number`
+
+Field indicates the ID of the latest instance/run of draw
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the draw, e.g. 'Daily draw'
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the draw
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+URL of the image that represents the draw
+
+___
+
+### image\_url\_mobile
+
+• **image\_url\_mobile**: `string`
+
+URL of the moible image that represents the draw
+
+___
+
+### icon\_url
+
+• **icon\_url**: `string`
+
+URL of the icon that represents the draw
+
+___
+
+### background\_image\_url
+
+• **background\_image\_url**: `string`
+
+URL of the background image that will be used in the draw list item
+
+___
+
+### background\_image\_url\_mobile
+
+• **background\_image\_url\_mobile**: `string`
+
+URL of the moible background image that will be used in the draw list item
+
+___
+
+### is\_grand
+
+• **is\_grand**: `boolean`
+
+Show if the draw is grand and is marked as special
+
+___
+
+### execution\_ts
+
+• **execution\_ts**: `number`
+
+Date/time of the draw execution
+
+___
+
+### actual\_execution\_ts
+
+• **actual\_execution\_ts**: `number`
+
+Actual Date/time of the draw execution
+
+___
+
+### ticket\_start\_ts
+
+• **ticket\_start\_ts**: `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, ticket_start_date 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 - ticket_start_date)
+
+___
+
+### is\_winner
+
+• **is\_winner**: `boolean`
+
+Shows if user has won a prize in a current run
+
+___
+
+### has\_unclaimed\_prize
+
+• **has\_unclaimed\_prize**: `boolean`
+
+Shows if user has unclaimed prize

package/docs/interfaces/TRafflePrize.md

@@ -0,0 +1,159 @@
+# Interface: TRafflePrize
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+The unique identifier for the prize definition
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the prize
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the prize
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+URL of the image that represents the prize
+
+___
+
+### prizes\_per\_run
+
+• **prizes\_per\_run**: `number`
+
+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\_actual
+
+• **prizes\_per\_run\_actual**: `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.
+
+___
+
+### chances\_to\_win\_perc
+
+• **chances\_to\_win\_perc**: `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.
+
+___
+
+### min\_required\_total\_tickets
+
+• `Optional` **min\_required\_total\_tickets**: `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 ticket_start_date value of the draw and the current time.
+
+___
+
+### add\_one\_prize\_per\_each\_x\_tickets
+
+• `Optional` **add\_one\_prize\_per\_each\_x\_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.
+
+___
+
+### requires\_claim
+
+• **requires\_claim**: `boolean`
+
+Indicates whether the prize requires a claim action from the user.
+
+___
+
+### min\_required\_tickets\_for\_user
+
+• **min\_required\_tickets\_for\_user**: `number`
+
+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.
+
+___
+
+### cap\_prizes\_per\_run
+
+• `Optional` **cap\_prizes\_per\_run**: `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
+
+___
+
+### priority
+
+• **priority**: `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.
+
+___
+
+### stock\_items\_per\_draw
+
+• `Optional` **stock\_items\_per\_draw**: `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.
+
+___
+
+### should\_claim
+
+• **should\_claim**: `boolean`
+
+Shows if the prize has been claimed
+
+___
+
+### winners
+
+• **winners**: [`TRafflePrizeWinner`](TRafflePrizeWinner.md)[]

package/docs/interfaces/TRafflePrizeWinner.md

@@ -0,0 +1,50 @@
+# Interface: TRafflePrizeWinner
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+Id of the winner definition, for the repetative winners (e.g. same winner won two prizes), this number will be the same for all winner that are repeating
+(internal name: schedule_id)
+
+___
+
+### username
+
+• `Optional` **username**: `string`
+
+Winner user name
+
+___
+
+### avatar\_url
+
+• `Optional` **avatar\_url**: `string`
+
+URL of the image of user avatar
+
+___
+
+### ticket
+
+• **ticket**: [`TRaffleTicket`](TRaffleTicket.md)
+
+Ticket information (number string and integer)
+
+___
+
+### raf\_won\_id
+
+• **raf\_won\_id**: `number`
+
+Unique ID of winning
+
+___
+
+### claimed\_date
+
+• **claimed\_date**: `number`
+
+Date when the prize was claimed

package/docs/interfaces/TRaffleTicket.md

@@ -0,0 +1,13 @@
+# Interface: TRaffleTicket
+
+## Properties
+
+### ticekt\_id
+
+• **ticekt\_id**: `number`
+
+___
+
+### ticket\_id\_string
+
+• **ticket\_id\_string**: `string`

package/docs/interfaces/TransformedRaffleClaimPrizeResponse.md

@@ -0,0 +1,17 @@
+# Interface: TransformedRaffleClaimPrizeResponse
+
+## Properties
+
+### errorCode
+
+• **errorCode**: `number`
+
+Error code, 0 means no error
+
+___
+
+### errorMessage
+
+• `Optional` **errorMessage**: `string`
+
+Error message, will be exposed only if ErrorCode is not 0

package/package.json

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

package/src/Base/ClassId.ts

@@ -147,7 +147,8 @@ export enum ClassId {
 	JP_OPTOUT_RESPONSE = 807,
 
 	JP_WIN_PUSH = 808,
-
+	JP_GET_WINNERS_REQUEST = 809,
+	JP_GET_WINNERS_RESPONSE = 810,
 
 	RAF_GET_RAFFLES_REQUEST = 902,
 	RAF_GET_RAFFLES_RESPONSE = 903,

package/src/Jackpots/GetJackpotWinnersRequest.ts

@@ -0,0 +1,12 @@
+import { ProtocolRequest } from "src/Base/ProtocolRequest";
+
+interface GetJackpotWinnersRequest extends ProtocolRequest {
+	/** The ID of the jackpot template */
+	jp_template_id: number;
+	/** The number of winners to return */
+	limit: number;
+	/** The offset of the winners to return */
+	offset: number;
+}
+
+export { GetJackpotWinnersRequest };

package/src/Jackpots/GetJackpotWinnersResponse.ts

@@ -0,0 +1,33 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { JackPotWinner } from "./JackPotWinner";
+
+export interface GetJackpotWinnersResponse extends ProtocolResponse {
+	/** The list of jackpot winners */
+	winners: JackpotWinnerHistory[];
+	/** Whether there are more winners to fetch */
+	has_more: boolean;
+}
+
+export interface JackpotWinnerHistory {
+	/** Id of the jackpot pot */
+	jp_pot_id: number;
+	/** Date of winning in milliseconds */
+	win_date_ts: number;
+	/** Info about jackpot winner */
+	winner: JackPotWinner;
+}
+
+/**
+ * @ignore
+ */
+export const GetJackpotWinnersResponseTransform = (items: JackpotWinnerHistory[]): JackpotWinnerHistory[] => {
+	return items.map((item) => {
+		const winnerInfo: JackpotWinnerHistory = {
+			winner: item.winner,
+			win_date_ts: item.win_date_ts,
+			jp_pot_id: item.jp_pot_id,
+		};
+
+		return winnerInfo;
+	});
+};

package/src/Jackpots/index.ts

@@ -14,3 +14,5 @@ export * from './JackpotsOptinResponse';
 export * from './JackpotsOptoutRequest';
 export * from './JackpotsOptoutResponse';
 export * from './JackpotHtmlTemplate';
+export * from './GetJackpotWinnersRequest';
+export * from './GetJackpotWinnersResponse';

package/src/Raffle/GetDrawRunResponse.ts

@@ -1,6 +1,36 @@
+import { TRaffleDraw } from 'src/WSAPI/WSAPITypes';
 import { ProtocolResponse } from '../Base/ProtocolResponse';
 import { RaffleDraw } from './RaffleDraw';
+import { prizeTransform, ticketsTransform } from './GetRafflesResponse';
 
 export interface GetDrawRunResponse extends ProtocolResponse {
 	draw: RaffleDraw;
 }
+
+
+export const drawRunTransform = (res: GetDrawRunResponse): TRaffleDraw => {
+	return {id: res.draw.draw_id,
+		name: res.draw.public_meta.name,
+		description: res.draw.public_meta.description,
+		image_url:res.draw.public_meta.image_url,
+		image_url_mobile:res.draw.public_meta.image_url_mobile,
+		icon_url: res.draw.public_meta.icon_url,
+		background_image_url: res.draw.public_meta.background_image_url,
+		background_image_url_mobile: res.draw.public_meta.background_image_url_mobile,
+		is_grand: res.draw.public_meta.is_grand,
+		prizes: prizeTransform(res.draw.prizes),
+		current_state: res.draw.current_state,
+		run_id: res.draw.run_id,
+		execution_type: res.draw.execution_type,
+		execution_ts: res.draw.execution_ts,
+		previous_run_ts: res.draw.previous_run_ts,
+		previous_run_id: res.draw.previous_run_id,
+		ticket_start_ts: res.draw.ticket_start_ts,
+		allow_multi_prize_per_ticket: res.draw.allow_multi_prize_per_ticket,
+		total_tickets_count: res.draw.total_tickets_count,
+		my_tickets_count: res.draw.my_tickets_count,
+		my_last_tickets: ticketsTransform(res.draw.my_last_tickets)} 
+		
+			
+	
+};

package/src/Raffle/GetRaffleDrawRunsHistoryResponse.ts

@@ -1,6 +1,29 @@
+import { TRaffleDrawRun } from 'src/WSAPI/WSAPITypes';
 import { ProtocolResponse } from '../Base/ProtocolResponse';
 import { RaffleDrawRun } from './RaffleDrawRun';
 
 export interface GetRaffleDrawRunsHistoryResponse extends ProtocolResponse {
 	draw_runs: RaffleDrawRun[];
 }
+
+export const drawRunHistoryTransform = (res: GetRaffleDrawRunsHistoryResponse): TRaffleDrawRun[] => {
+	return res.draw_runs.map((item) => {
+		return {
+			id: item.draw_id,
+			run_id: item.run_id,
+			name: item.public_meta.name,
+			description:  item.public_meta.description,
+			image_url:  item.public_meta.image_url,
+			image_url_mobile:  item.public_meta.image_url_mobile,
+			icon_url:  item.public_meta.icon_url,
+			background_image_url:  item.public_meta.background_image_url,
+			background_image_url_mobile:  item.public_meta.background_image_url_mobile,
+			is_grand:  item.public_meta.is_grand,
+			execution_ts: item.execution_ts,
+			actual_execution_ts:item.actual_execution_ts,
+			ticket_start_ts:item.ticket_start_ts,
+			is_winner:item.is_winner,
+			has_unclaimed_prize:item.has_unclaimed_prize
+		};
+	});
+};