@smartico/public-api 0.0.326 → 0.0.328

package/docs/README.md

@@ -103,6 +103,8 @@
 - [RaffleDraw](interfaces/RaffleDraw.md)
 - [RaffleDrawPublicMeta](interfaces/RaffleDrawPublicMeta.md)
 - [RaffleDrawRun](interfaces/RaffleDrawRun.md)
+- [RaffleOptinRequest](interfaces/RaffleOptinRequest.md)
+- [RaffleOptinResponse](interfaces/RaffleOptinResponse.md)
 - [RafflePrizePublicMeta](interfaces/RafflePrizePublicMeta.md)
 - [RafflePrize](interfaces/RafflePrize.md)
 - [RafflePrizeWinner](interfaces/RafflePrizeWinner.md)
@@ -149,6 +151,7 @@
 - [TRaffleDrawRun](interfaces/TRaffleDrawRun.md)
 - [TransformedRaffleClaimPrizeResponse](interfaces/TransformedRaffleClaimPrizeResponse.md)
 - [TPointsHistoryLog](interfaces/TPointsHistoryLog.md)
+- [TRaffleOptinResponse](interfaces/TRaffleOptinResponse.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -1357,3 +1357,26 @@ _smartico.vapi('EN').claimRafflePrize({ won_id: 251 }).then((result) => {
 #### Returns
 
 `Promise`\<[`TransformedRaffleClaimPrizeResponse`](../interfaces/TransformedRaffleClaimPrizeResponse.md)\>
+
+___
+
+### requestRaffleOptin
+
+▸ **requestRaffleOptin**(`props`): `Promise`\<[`TRaffleOptinResponse`](../interfaces/TRaffleOptinResponse.md)\>
+
+Requests an opt-in for the specified raffle. Returns the err_code.
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | `Object` |
+| `props.raffle_id` | `number` |
+| `props.draw_id` | `number` |
+| `props.raffle_run_id` | `number` |
+
+#### Returns
+
+`Promise`\<[`TRaffleOptinResponse`](../interfaces/TRaffleOptinResponse.md)\>

package/docs/enums/AchCustomSectionType.md

@@ -71,3 +71,9 @@ ___
 ### RAFFLE
 
 • **RAFFLE** = ``13``
+
+___
+
+### BADGES
+
+• **BADGES** = ``14``

package/docs/interfaces/RaffleOptinRequest.md

@@ -0,0 +1,55 @@
+# Interface: RaffleOptinRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`RaffleOptinRequest`**
+
+## 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`
+
+___
+
+### draw\_id
+
+• **draw\_id**: `number`
+
+___
+
+### raffle\_run\_id
+
+• **raffle\_run\_id**: `number`

package/docs/interfaces/RaffleOptinResponse.md

@@ -0,0 +1,57 @@
+# Interface: RaffleOptinResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`RaffleOptinResponse`**
+
+## 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

package/docs/interfaces/TRaffleOptinResponse.md

@@ -0,0 +1,17 @@
+# Interface: TRaffleOptinResponse
+
+## Properties
+
+### err\_code
+
+• **err\_code**: `number`
+
+Error code that represents outcome of the opt-in attempt. Opt-in succeed in case err_code is 0
+
+___
+
+### err\_message
+
+• `Optional` **err\_message**: `string`
+
+Optional error message

package/docs/interfaces/TStoreItem.md

@@ -65,8 +65,8 @@ ___
 • **limit\_message**: `string`
 
 The message that should be shown to the user if he is not eligible to buy it. this message can be used to explain the reason why user cannot buy the item, e.g. 'You should be VIP to buy this item' and can be used in case can_buy property is false.
-   The message is translated to the user language.
-   **Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
+The message is translated to the user language.
+*Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
 
 ___
 

package/docs/interfaces/TUICustomSection.md

@@ -119,3 +119,11 @@ ___
 • `Optional` **liquid\_template**: `number`
 
 Liquid template id to be used for Liquid templates
+
+___
+
+### ach\_category\_ids
+
+• `Optional` **ach\_category\_ids**: `number`[]
+
+List of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method

package/package.json

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

package/src/Base/ClassId.ts

@@ -164,6 +164,8 @@ export enum ClassId {
 	RAF_GET_DRAW_HISTORY_RESPONSE = 907,
 	RAF_CLAIM_PRIZE_REQUEST = 908,
 	RAF_CLAIM_PRIZE_RESPONSE = 909,
+	RAF_OPTIN_REQUEST = 910,
+	RAF_OPTIN_RESPONSE = 911,
 	/*
 	RAF_GET_TICKETS_REQUEST = 902,
 	RAF_GET_TICKETS_RESPONSE = 903,

package/src/CustomSections/AchCustomSection.ts

@@ -11,6 +11,7 @@ export enum AchCustomSectionType {
 	LOOTBOX_CALENDAR_DAYS = 11,
 	TREASURE_HUNT = 12,
 	RAFFLE = 13,
+	BADGES = 14,
 }
 
 export enum AchCustomLayoutTheme {

package/src/CustomSections/UICustomSection.ts

@@ -23,6 +23,7 @@ export interface UICustomSection {
 	ach_tournament_id?: number;
 	show_raw_data?: boolean;
 	liquid_template?: number;
+	ach_category_ids?: number[];
 }
 
 export const UICustomSectionTransform = (response: GetCustomSectionsResponse): TUICustomSection[] => {
@@ -54,6 +55,12 @@ export const UICustomSectionTransform = (response: GetCustomSectionsResponse): T
 					}
 					: {}
 				),
+				...(r.section_type_id === AchCustomSectionType.BADGES
+					? {
+						ach_category_ids: r.ach_category_ids,
+					}
+					: {}
+				),
 			};
 
 			items.push(x);

package/src/Raffle/RaffleOptinRequest.ts

@@ -0,0 +1,7 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface RaffleOptinRequest extends ProtocolMessage {
+    raffle_id: number;
+    draw_id: number;
+    raffle_run_id: number;
+}

package/src/Raffle/RaffleOptinResponse.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface RaffleOptinResponse extends ProtocolResponse {
+	
+}

package/src/Raffle/index.ts

@@ -13,3 +13,5 @@ export * from './GetRaffleDrawRunsHistoryResponse';
 export * from './RaffleClaimPrizeRequest';
 export * from './RaffleClaimPrizeResponse';
 export * from './RaffleDrawPublicMeta';
+export * from './RaffleOptinRequest';
+export * from './RaffleOptinResponse';

package/src/SmarticoAPI.ts

@@ -127,7 +127,7 @@ import { GetRafflesResponse, raffleTransform } from './Raffle/GetRafflesResponse
 import { GetRafflesRequest } from './Raffle/GetRafflesRequest';
 import { GetPointsHistoryRequest, GetPointsHistoryResponse, PointsHistoryTransform } from './PointsHistory';
 import { InboxCategories } from './Inbox/InboxCategories';
-import { GetDrawRunRequest, GetDrawRunResponse, GetRaffleDrawRunsHistoryRequest, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeRequest, RaffleClaimPrizeResponse } from './Raffle';
+import { GetDrawRunRequest, GetDrawRunResponse, GetRaffleDrawRunsHistoryRequest, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeRequest, RaffleClaimPrizeResponse, RaffleOptinRequest, RaffleOptinResponse } from './Raffle';
 import { GetJackpotWinnersResponse, GetJackpotWinnersResponseTransform, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotWinnersRequest } from './Jackpots/GetJackpotWinnersRequest';
 import { GetJackpotEligibleGamesRequest } from './Jackpots/GetJackpotEligibleGamesRequest';
@@ -1326,6 +1326,17 @@ class SmarticoAPI {
 
 	}
 
+	public async raffleOptin(user_ext_id: string, props: { raffle_id: number; draw_id: number; raffle_run_id: number }): Promise<RaffleOptinResponse> {
+		const message = this.buildMessage<RaffleOptinRequest, RaffleOptinResponse>(
+			user_ext_id,
+			ClassId.RAF_OPTIN_REQUEST,
+			props,
+		);
+
+		return await this.send<RaffleOptinResponse>(message, ClassId.RAF_OPTIN_RESPONSE);
+
+	}
+
 	public async getPointsHistory(
 		user_ext_id: string,
 		startTimeSeconds: number,

package/src/WSAPI/WSAPI.ts

@@ -38,6 +38,7 @@ import {
 	TransformedRaffleClaimPrizeResponse,
 	TLevelCurrent,
 	TPointsHistoryLog,
+	TRaffleOptinResponse,
 } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
@@ -55,6 +56,8 @@ import {
 	drawRunHistoryTransform,
 	drawRunTransform,
 	raffleClaimPrizeResponseTransform,
+	RaffleOptinRequest,
+	RaffleOptinResponse,
 } from '../Raffle';
 import { IntUtils } from '../IntUtils';
 import { TGetJackpotEligibleGamesResponse } from '../Jackpots/GetJackpotEligibleGamesResponse';
@@ -136,10 +139,7 @@ export class WSAPI {
 				this.reloadMiniGameTemplate();
 				OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.SAWHistory);
 			});
-			on(ClassId.RAF_CLAIM_PRIZE_RESPONSE, () => {
-				this.updateRaffles();
-				OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Raffles);
-			});
+			on(ClassId.RAF_CLAIM_PRIZE_RESPONSE, () => this.updateRaffles());
 			on(ClassId.GET_INBOX_MESSAGES_RESPONSE, (res) => {
 				if (res.unread_count !== undefined && res.unread_count !== null) {
 					this.updateInboxUnreadCount(res.unread_count);
@@ -153,6 +153,7 @@ export class WSAPI {
 					this.notifyPointsHistoryUpdate();
 				}
 			});
+			on(ClassId.RAF_OPTIN_RESPONSE, () => this.updateRaffles());
 		}
 	}
 
@@ -1463,4 +1464,28 @@ export class WSAPI {
 		const res = await this.api.claimRafflePrize(null, { won_id: props.won_id });
 		return raffleClaimPrizeResponseTransform(res);
 	}
+
+	/**
+	 * Requests an opt-in for the specified raffle. Returns the err_code.
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async requestRaffleOptin(props: { raffle_id: number; draw_id: number; raffle_run_id: number }): Promise<TRaffleOptinResponse> {
+		if (!props.raffle_id) {
+			throw new Error('raffle_id is required');
+		}
+		if (!props.draw_id) {
+			throw new Error('draw_id is required');
+		}
+		if (!props.raffle_run_id) {
+			throw new Error('raffle_run_id is required');
+		}
+
+		const r = await this.api.raffleOptin(null, props);
+
+		return {
+			err_code: r.errCode,
+			err_message: r.errMsg,
+		};;
+	}
 }

package/src/WSAPI/WSAPITypes.ts

@@ -171,7 +171,7 @@ export interface TMiniGameTemplate {
 
 	/** When enabled, the number of items in the pool and number of won items will be exposed in the Retention API and in the UI Widgets */
 	expose_game_stat_on_api?: boolean;
-	
+
 	/** Time zone to ensure each day aligns with your local midnight. */
 	relative_period_timezone?: number;
 	/** Holds time from which template will become available, for the template that are targeted to be available from specific time (UNIX timestamp) */
@@ -186,7 +186,7 @@ export interface TMiniGameTemplate {
 	/** The UI definition of the mini-game */
 	saw_template_ui_definition: SAWTemplateUI;
 	/** When enabled the prize history icon is visible on a certain template */
-	show_prize_history?:boolean;
+	show_prize_history?: boolean;
 	/** The maximum number of attempts that user can do during period of time */
 	max_number_of_attempts?: number;
 	/** The period of time in milliseconds during which the user can do the maximum number of attempts */
@@ -495,10 +495,10 @@ export interface TStoreItem {
 	/** The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
 	ribbon: TRibbon;
 	/** 
-     *  The message that should be shown to the user if he is not eligible to buy it. this message can be used to explain the reason why user cannot buy the item, e.g. 'You should be VIP to buy this item' and can be used in case can_buy property is false.
-        The message is translated to the user language.
-        **Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
-    */
+	 *  The message that should be shown to the user if he is not eligible to buy it. this message can be used to explain the reason why user cannot buy the item, e.g. 'You should be VIP to buy this item' and can be used in case can_buy property is false.
+		The message is translated to the user language.
+		**Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
+	*/
 	limit_message: string;
 	/** The message that should be shown to the user if they are not eligible to buy it because of purchase limitation. This message can be used to explain the reason why user cannot buy the item, e.g. 'Item is no more available today. Come back Friday'.
 		The message is translated to the user language.
@@ -590,7 +590,7 @@ export interface TMissionOrBadge {
 
 	/** Holds time from which mission will become available, for the missions that are targeted to be available from specific date/time */
 	active_from_ts: number;
-	
+
 	/** Holds time till mission will become unavailable, for the missions that are targeted to be available from specific date/time */
 	active_till_ts: number;
 
@@ -907,6 +907,8 @@ export interface TUICustomSection {
 	show_raw_data?: boolean;
 	/** Liquid template id to be used for Liquid templates */
 	liquid_template?: number;
+	/** List of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method */
+	ach_category_ids?: number[];
 }
 
 export interface TBonus {
@@ -929,18 +931,18 @@ export interface TBonus {
 }
 
 export 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, 
+	/** 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*/
@@ -1243,14 +1245,14 @@ export interface TRaffleDraw {
 
 export interface TRaffleDrawRun {
 	/**
-     * 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)
-     */
+	 * 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)
+	 */
 	id: number;
-	 /**
-     * Field indicates the ID of the latest instance/run of draw
-     */
-	run_id:number;
+	/**
+	* Field indicates the ID of the latest instance/run of draw
+	*/
+	run_id: number;
 	/** Name of the draw, e.g. 'Daily draw' */
 	name: string;
 	/** Description of the draw */
@@ -1270,32 +1272,31 @@ export interface TRaffleDrawRun {
 	/** Date/time of the draw execution */
 	execution_ts: number;
 	/** Actual Date/time of the draw execution */
-    actual_execution_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)
-     */
+	actual_execution_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)
+   */
 	ticket_start_ts: number;
-    /**
-     * Shows if user has won a prize in a current run
-     */
-    is_winner: boolean;
 	/**
-     * Shows if user has unclaimed prize
-     */
-    has_unclaimed_prize: boolean;
+	 * Shows if user has won a prize in a current run
+	 */
+	is_winner: boolean;
+	/**
+	 * Shows if user has unclaimed prize
+	 */
+	has_unclaimed_prize: boolean;
 
 }
 
 export interface TransformedRaffleClaimPrizeResponse {
 	/** Error code, 0 means no error */
-    errorCode: number
+	errorCode: number
 	/** Error message, will be exposed only if ErrorCode is not 0 */
-    errorMessage?: string
+	errorMessage?: string
 }
-
 /**
  * TPointsHistoryLog describes a unified history log entry for points, gems, or diamonds changes.
  * The structure is the same regardless of balance type, making it easy to iterate and display.
@@ -1319,4 +1320,11 @@ export interface TPointsHistoryLog {
 	source_type_id: PointChangeSourceType;
 }
 
+export interface TRaffleOptinResponse {
+	/** Error code that represents outcome of the opt-in attempt. Opt-in succeed in case err_code is 0 */
+	err_code: number;
+	/** Optional error message */
+	err_message?: string;
+}
+
 export { SAWAcknowledgeTypeName, PrizeModifiers, SAWTemplateUI, InboxCategories, AchCustomSectionType, SAWAskForUsername, SAWGameLayout, PointChangeSourceType, UserBalanceType }