@smartico/public-api 0.0.241 → 0.0.243

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/dist/Jackpots/JackpotPublicMeta.d.ts +6 -0
  2. package/dist/Level/LevelPublicMeta.d.ts +5 -1
  3. package/dist/Quiz/MarketsAnswersType.d.ts +22 -0
  4. package/dist/Raffle/GetDrawResponse.d.ts +5 -0
  5. package/dist/Raffle/Raffle.d.ts +6 -0
  6. package/dist/SmarticoLib/index.d.ts +5 -1
  7. package/dist/SmarticoPublicAPI.d.ts +23 -0
  8. package/dist/Store/BuyShopItemErrorCode.d.ts +10 -0
  9. package/dist/Store/BuyShopItemRequest.d.ts +4 -0
  10. package/dist/Store/BuyShopItemResponse.d.ts +4 -0
  11. package/dist/Store/BuyStoreItemErrorCode.d.ts +8 -1
  12. package/dist/Store/GetCategoriesShopResponse.d.ts +5 -0
  13. package/dist/Store/GetShopItemsResponse.d.ts +5 -0
  14. package/dist/Store/ShopCategory.d.ts +5 -0
  15. package/dist/Store/ShopCategoryPublicMeta.d.ts +4 -0
  16. package/dist/Store/ShopItem.d.ts +9 -0
  17. package/dist/Store/ShopItemPublicMeta.d.ts +10 -0
  18. package/dist/Store/ShopItemType.d.ts +4 -0
  19. package/dist/Store/StorItemPruchased.d.ts +6 -0
  20. package/dist/WSAPI/WSAPITypes.d.ts +5 -1
  21. package/dist/index.js +12 -2
  22. package/dist/index.js.map +1 -1
  23. package/dist/index.modern.mjs +12 -2
  24. package/dist/index.modern.mjs.map +1 -1
  25. package/dist/service/index.d.ts +5 -0
  26. package/dist/service/types/ErrorCodes.d.ts +13 -0
  27. package/dist/service/types/GRequest.d.ts +16 -0
  28. package/dist/service/types/GResponse.d.ts +10 -0
  29. package/dist/service/types/Game/GameAttemptType.d.ts +6 -0
  30. package/dist/service/types/Game/GameCanPlayType.d.ts +10 -0
  31. package/dist/service/types/Game/GameExternalStatus.d.ts +6 -0
  32. package/dist/service/types/Game/GameInfo.d.ts +9 -0
  33. package/dist/service/types/Game/GamePick.d.ts +90 -0
  34. package/dist/service/types/Game/GameUtil.d.ts +7 -0
  35. package/dist/service/types/SmarticoProto/GetTranslationsRequest.d.ts +7 -0
  36. package/dist/service/types/SmarticoProto/GetTranslationsResponse.d.ts +7 -0
  37. package/dist/service/types/SmarticoProto/ProtocolMessage.d.ts +5 -0
  38. package/dist/service/types/SmarticoProto/ProtocolRequest.d.ts +6 -0
  39. package/dist/service/types/SmarticoProto/ProtocolResponse.d.ts +5 -0
  40. package/dist/service/types/SmarticoProto/PublicLabelInfo.d.ts +34 -0
  41. package/dist/service/types/SmarticoProto/PublicProperties.d.ts +11 -0
  42. package/dist/service/types/SmarticoProto/ResponseIdentify.d.ts +12 -0
  43. package/dist/service/types/SmarticoProto/SAW/SAWAcknowledgeType.d.ts +5 -0
  44. package/dist/service/types/SmarticoProto/SAW/SAWBuyInType.d.ts +5 -0
  45. package/dist/service/types/SmarticoProto/SAW/SAWDoSpinRequest.d.ts +5 -0
  46. package/dist/service/types/SmarticoProto/SAW/SAWDoSpinResponse.d.ts +15 -0
  47. package/dist/service/types/SmarticoProto/SAW/SAWGameType.d.ts +10 -0
  48. package/dist/service/types/SmarticoProto/SAW/SAWGetTemplatesRequest.d.ts +3 -0
  49. package/dist/service/types/SmarticoProto/SAW/SAWGetTemplatesResponse.d.ts +5 -0
  50. package/dist/service/types/SmarticoProto/SAW/SAWPrize.d.ts +11 -0
  51. package/dist/service/types/SmarticoProto/SAW/SAWPrizeType.d.ts +8 -0
  52. package/dist/service/types/SmarticoProto/SAW/SAWPrizeUI.d.ts +13 -0
  53. package/dist/service/types/SmarticoProto/SAW/SAWTemplate.d.ts +21 -0
  54. package/dist/service/types/SmarticoProto/SAW/SAWTemplateUI.d.ts +31 -0
  55. package/dist/service/types/SmarticoProto/SAW/SAWWinSoundType.d.ts +12 -0
  56. package/dist/service/types/SmarticoProto/TranslationArea.d.ts +9 -0
  57. package/dist/service/types/User/UserInfo.d.ts +10 -0
  58. package/dist/util/Util.d.ts +51 -0
  59. package/docs/enums/BuyStoreItemErrorCode.md +16 -6
  60. package/docs/interfaces/JackpotPublicMeta.md +8 -0
  61. package/package.json +1 -1
  62. package/src/IntUtils.ts +1 -1
  63. package/src/Jackpots/JackpotPublicMeta.ts +6 -0
  64. package/src/Level/LevelPublicMeta.ts +5 -1
  65. package/src/Raffle/Raffle.ts +6 -0
  66. package/src/SmarticoLib/index.ts +5 -1
  67. package/src/Store/BuyStoreItemErrorCode.ts +9 -2
  68. package/src/WSAPI/WSAPI.ts +5 -0
  69. package/src/WSAPI/WSAPITypes.ts +5 -1
@@ -14,5 +14,11 @@ interface JackpotPublicMeta {
14
14
  placeholder1: string;
15
15
  /** custom value of placeholder2 defined by operator and can be used in the HTML templates */
16
16
  placeholder2: string;
17
+ /**
18
+ * Custom data as string or JSON string that can be used in API to build custom UI
19
+ * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
20
+ * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
21
+ */
22
+ custom_data: string;
17
23
  }
18
24
  export { JackpotPublicMeta };
@@ -14,6 +14,10 @@ export interface LevelPublicMeta {
14
14
  dx: number;
15
15
  dy: number;
16
16
  };
17
- /**custom data as string or JSON string that can be used in UIWidget */
17
+ /**
18
+ * Custom data as string or JSON string that can be used in API to build custom UI
19
+ * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
20
+ * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
21
+ */
18
22
  custom_data: string;
19
23
  }
@@ -0,0 +1,22 @@
1
+ export declare enum MarketsValueType {
2
+ HomeTeam = "1",
3
+ AwayTeam = "2",
4
+ Draw = "x",
5
+ HomeTeamHomeTeam = "1/1",
6
+ HomeTeamDraw = "1/x",
7
+ HomeTeamAwayTeam = "1/2",
8
+ DrawHomeTeam = "x/1",
9
+ DrawDraw = "x/x",
10
+ DrawAwayTeam = "x/2",
11
+ AwayTeamHomeTeam = "2/1",
12
+ AwayTeamDraw = "2/x",
13
+ AwayTeamAwayTeam = "2/2",
14
+ Yes = "yes",
15
+ No = "no",
16
+ Odd = "odd",
17
+ Even = "even",
18
+ HomeOdd = "1/odd",
19
+ HomeEven = "1/even",
20
+ AwayOdd = "2/odd",
21
+ AwayEven = "2/even"
22
+ }
@@ -0,0 +1,5 @@
1
+ import { ProtocolResponse } from '../Base/ProtocolResponse';
2
+ import { RaffleDraw } from './RaffleDraw';
3
+ export interface GetDrawResponse extends ProtocolResponse {
4
+ draw: RaffleDraw;
5
+ }
@@ -8,6 +8,12 @@ interface RafflePublicMeta {
8
8
  custom_section_id: number;
9
9
  /** URL of the image that represents the raffle */
10
10
  image_url: string;
11
+ /**
12
+ * Custom data as string or JSON string that can be used in API to build custom UI
13
+ * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
14
+ * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
15
+ */
16
+ custom_data: string;
11
17
  }
12
18
  interface Raffle {
13
19
  /** ID of the Raffle template */
@@ -836,7 +836,11 @@ export interface TLevel {
836
836
  *
837
837
  */
838
838
  required_level_counter_2: number;
839
- /** The custom data of the Level defined by operator in the BackOffice. Can be a JSON object, string or number */
839
+ /**
840
+ * Custom data as string or JSON string that can be used in API to build custom UI
841
+ * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
842
+ * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
843
+ */
840
844
  custom_data: string;
841
845
  }
842
846
  /**
@@ -0,0 +1,23 @@
1
+ import { ClassId } from "./Base/ClassId";
2
+ import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
3
+ import { SAWTemplate } from './MiniGames/SAWTemplate';
4
+ import { ILogger } from './ILogger';
5
+ interface IOptions {
6
+ logger?: ILogger;
7
+ logCIDs?: ClassId[];
8
+ logHTTPTiming?: boolean;
9
+ }
10
+ declare class SmarticoPublicApi {
11
+ private label_api_key;
12
+ private brand_api_key;
13
+ private publicUrl;
14
+ private logger;
15
+ private logCIDs;
16
+ private logHTTPTiming;
17
+ constructor(label_api_key: string, brand_api_key: string, options?: IOptions);
18
+ private send;
19
+ private buildMessage;
20
+ miniGamesGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
21
+ miniGamesFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): any[];
22
+ }
23
+ export { SmarticoPublicApi };
@@ -0,0 +1,10 @@
1
+ export declare enum BuyShopItemErrorCode {
2
+ FAILED_TO_BUY_SHOP_ITEM = 121,
3
+ SHOP_NO_BALANCE = 11000,
4
+ SHOP_WRONG_LABEL = 11001,
5
+ SHOP_FAILED_TO_BUY_BONUS = 11002,
6
+ SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003,
7
+ SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004,
8
+ SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
9
+ SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006
10
+ }
@@ -0,0 +1,4 @@
1
+ import { ProtocolMessage } from "../Base/ProtocolMessage";
2
+ export interface BuyShopItemRequest extends ProtocolMessage {
3
+ itemId: number;
4
+ }
@@ -0,0 +1,4 @@
1
+ import { ProtocolResponse } from "../Base/ProtocolResponse";
2
+ export interface BuyShopItemResponse extends ProtocolResponse {
3
+ success?: boolean;
4
+ }
@@ -1,11 +1,18 @@
1
1
  export declare enum BuyStoreItemErrorCode {
2
- FAILED_TO_BUY_SHOP_ITEM = 121,
2
+ /** User don't have enough points on balance */
3
3
  SHOP_NO_BALANCE = 11000,
4
+ /** Wrong shop item id */
4
5
  SHOP_WRONG_LABEL = 11001,
6
+ /** Failed to buy bonus item, probably something wrong with the bonus configuration. */
5
7
  SHOP_FAILED_TO_BUY_BONUS = 11002,
8
+ /** Failed to buy store item because segment conditions are set by operator for specific CRM item */
6
9
  SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003,
10
+ /** Segment conditions are set by operator for specific CRM item and user not matching to this conditions */
7
11
  SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004,
12
+ /** Failed to buy matching bonus item */
8
13
  SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
14
+ /** Failed to buy item because of limit of max items is reached */
9
15
  SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006,
16
+ /** Failed to buy item because no more items are available */
10
17
  SHOP_FAILED_POOL_EMPTY = 11009
11
18
  }
@@ -0,0 +1,5 @@
1
+ import { ProtocolResponse } from "../Base/ProtocolResponse";
2
+ import { ShopCategory } from "./ShopCategory";
3
+ export interface GetCategoriesShopResponse extends ProtocolResponse {
4
+ categories: ShopCategory[];
5
+ }
@@ -0,0 +1,5 @@
1
+ import { ProtocolResponse } from "../Base/ProtocolResponse";
2
+ import { ShopItem } from "./ShopItem";
3
+ export interface GetShopItemsResponse extends ProtocolResponse {
4
+ items: ShopItem[];
5
+ }
@@ -0,0 +1,5 @@
1
+ import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
2
+ export interface ShopCategory {
3
+ id?: number;
4
+ publicMeta?: ShopCategoryPublicMeta;
5
+ }
@@ -0,0 +1,4 @@
1
+ export interface ShopCategoryPublicMeta {
2
+ name?: string;
3
+ order?: number;
4
+ }
@@ -0,0 +1,9 @@
1
+ import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
2
+ import { ShopItemType } from "./ShopItemType";
3
+ export interface ShopItem {
4
+ id: number;
5
+ itemTypeId: ShopItemType;
6
+ itemPublicMeta: ShopItemPublicMeta;
7
+ categoryIds?: number[];
8
+ canBuy?: boolean;
9
+ }
@@ -0,0 +1,10 @@
1
+ export interface ShopItemPublicMeta {
2
+ price: string;
3
+ image_url: string;
4
+ name: string;
5
+ description: string;
6
+ label_tag: string;
7
+ limit_message: string;
8
+ priority: number;
9
+ related_items: number[];
10
+ }
@@ -0,0 +1,4 @@
1
+ export declare enum ShopItemType {
2
+ Bonus = 1,
3
+ Manual = 2
4
+ }
@@ -0,0 +1,6 @@
1
+ import { StoreItem } from "./StoreItem";
2
+ interface StorItemPruchased extends StoreItem {
3
+ purchase_ts: number;
4
+ purchase_points_amount: number;
5
+ }
6
+ export { StorItemPruchased };
@@ -220,7 +220,11 @@ export interface TLevel {
220
220
  *
221
221
  */
222
222
  required_level_counter_2: number;
223
- /** The custom data of the Level defined by operator in the BackOffice. Can be a JSON object, string or number */
223
+ /**
224
+ * Custom data as string or JSON string that can be used in API to build custom UI
225
+ * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
226
+ * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
227
+ */
224
228
  custom_data: string;
225
229
  }
226
230
  /**
package/dist/index.js CHANGED
@@ -232,7 +232,7 @@ IntUtils.JsonOrText = function (str) {
232
232
  return str;
233
233
  }
234
234
  }
235
- return str;
235
+ return str || {};
236
236
  };
237
237
  // public static wsTimeToEpoch = (time: string): number => {
238
238
  // if (time) {
@@ -834,14 +834,21 @@ exports.InboxCategories = void 0;
834
834
 
835
835
  exports.BuyStoreItemErrorCode = void 0;
836
836
  (function (BuyStoreItemErrorCode) {
837
- BuyStoreItemErrorCode[BuyStoreItemErrorCode["FAILED_TO_BUY_SHOP_ITEM"] = 121] = "FAILED_TO_BUY_SHOP_ITEM";
837
+ /** User don't have enough points on balance */
838
838
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_NO_BALANCE"] = 11000] = "SHOP_NO_BALANCE";
839
+ /** Wrong shop item id */
839
840
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_WRONG_LABEL"] = 11001] = "SHOP_WRONG_LABEL";
841
+ /** Failed to buy bonus item, probably something wrong with the bonus configuration. */
840
842
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_FAILED_TO_BUY_BONUS"] = 11002] = "SHOP_FAILED_TO_BUY_BONUS";
843
+ /** Failed to buy store item because segment conditions are set by operator for specific CRM item */
841
844
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION"] = 11003] = "SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION";
845
+ /** Segment conditions are set by operator for specific CRM item and user not matching to this conditions */
842
846
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE"] = 11004] = "SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE";
847
+ /** Failed to buy matching bonus item */
843
848
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_FAILED_TO_BUY_MATCHING_BONUS"] = 11005] = "SHOP_FAILED_TO_BUY_MATCHING_BONUS";
849
+ /** Failed to buy item because of limit of max items is reached */
844
850
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED"] = 11006] = "SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED";
851
+ /** Failed to buy item because no more items are available */
845
852
  BuyStoreItemErrorCode[BuyStoreItemErrorCode["SHOP_FAILED_POOL_EMPTY"] = 11009] = "SHOP_FAILED_POOL_EMPTY";
846
853
  })(exports.BuyStoreItemErrorCode || (exports.BuyStoreItemErrorCode = {}));
847
854
 
@@ -2615,6 +2622,9 @@ var WSAPI = /*#__PURE__*/function () {
2615
2622
  var _pots = _jackpots.items.map(function (jp) {
2616
2623
  return jp.pot;
2617
2624
  });
2625
+ _jackpots.items.forEach(function (jp) {
2626
+ jp.jp_public_meta.custom_data = IntUtils.JsonOrText(jp.jp_public_meta.custom_data);
2627
+ });
2618
2628
  OCache.set(onUpdateContextKey.Pots, _pots, exports.ECacheContext.WSAPI, JACKPOT_POT_CACHE_SEC);
2619
2629
  return _jackpots.items;
2620
2630
  });