@smartico/public-api 0.0.240 → 0.0.242

package/src/Jackpots/JackpotPublicMeta.ts

@@ -14,6 +14,8 @@ interface JackpotPublicMeta {
 	placeholder1: string;
 	/** custom value of placeholder2 defined by operator and can be used in the HTML templates */
 	placeholder2: string;
+	/** custom data as string or JSON string that can be used in UIWidget */
+	custom_data: string;
 }
 
 export { JackpotPublicMeta };

package/src/Raffle/Raffle.ts

@@ -10,6 +10,8 @@ interface RafflePublicMeta {
     custom_section_id: number;
     /** URL of the image that represents the raffle */
     image_url: string;
+    /** Custom data as string or JSON string that can be used in UIWidget */
+	custom_data: string;
 }
 
 

package/src/Store/BuyStoreItemErrorCode.ts

@@ -1,11 +1,18 @@
 export enum BuyStoreItemErrorCode {
-	FAILED_TO_BUY_SHOP_ITEM = 121,
+	/** User don't have enough points on balance */
 	SHOP_NO_BALANCE = 11000,
+	/** Wrong shop item id */
 	SHOP_WRONG_LABEL = 11001,
+	/** Failed to buy bonus item, probably something wrong with the bonus configuration. */
 	SHOP_FAILED_TO_BUY_BONUS = 11002, // remote product restriction
-	SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003, // when not visible but trying to buy. Shoudnt happen
+	/** Failed to buy store item because segment conditions are set by operator for specific CRM item */
+	SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003, // when not visible but trying to buy. shouldn't happen
+	/**  Segment conditions are set by operator for specific CRM item and user not matching to this conditions */
 	SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004, // when visible but not matching to purchase segment
+	/** Failed to buy matching bonus item */
 	SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
+	/** Failed to buy item because of limit of max items is reached */
 	SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006,
+	/** Failed to buy item because no more items are available */
 	SHOP_FAILED_POOL_EMPTY = 11009,
 }

package/src/WSAPI/WSAPITypes.ts

@@ -670,7 +670,17 @@ export interface TTournamentRegistrationResult {
 }
 
 export interface TBuyStoreItemResult {
-	/** Error code representing the result of the purchase of the shop item. Successful purchase if err_code is 0 */
+	/** Error code representing the result of the purchase of the shop item. Successful purchase if err_code is 0 
+	 *
+	 * Example for error handling:
+	 * ```javascript
+	 * SmarticoAPI.buyStoreItem(item_id).then(res => {
+	 *   if (res.err_code !== 0) {
+	 *     // YOUR LOGIC HERE, you can use res.err_message, but it's optional and not always present
+	 *   }
+	 * });
+	 * ```
+	*/
 	err_code: BuyStoreItemErrorCode;
 	/** Optional error message */
 	err_message: string;