@smartico/public-api 0.0.370 → 0.0.374

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 (68) hide show
  1. package/dist/Clans/JoinClanErrorCode.d.ts +20 -0
  2. package/dist/Clans/JoinClanResponse.d.ts +2 -1
  3. package/dist/Clans/index.d.ts +1 -0
  4. package/dist/CustomSections/UICustomSection.d.ts +1 -0
  5. package/dist/MiniGames/SAWTemplateUI.d.ts +9 -0
  6. package/dist/Quiz/MarketsAnswersType.d.ts +22 -0
  7. package/dist/Raffle/GetDrawResponse.d.ts +5 -0
  8. package/dist/SmarticoPublicAPI.d.ts +23 -0
  9. package/dist/Store/BuyShopItemErrorCode.d.ts +10 -0
  10. package/dist/Store/BuyShopItemRequest.d.ts +4 -0
  11. package/dist/Store/BuyShopItemResponse.d.ts +4 -0
  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 +2 -0
  21. package/dist/index.js +544 -510
  22. package/dist/index.js.map +1 -1
  23. package/dist/index.modern.mjs +45 -13
  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/api/interfaces/SAWTemplateUI.md +13 -0
  60. package/docs/api/interfaces/TUICustomSection.md +8 -0
  61. package/docs/api/interfaces/UICustomSection.md +6 -0
  62. package/package.json +1 -1
  63. package/src/Clans/JoinClanErrorCode.ts +24 -0
  64. package/src/Clans/JoinClanResponse.ts +2 -1
  65. package/src/Clans/index.ts +1 -0
  66. package/src/CustomSections/UICustomSection.ts +2 -0
  67. package/src/MiniGames/SAWTemplateUI.ts +10 -0
  68. package/src/WSAPI/WSAPITypes.ts +2 -0
@@ -0,0 +1,20 @@
1
+ export declare enum JoinClanErrorCode {
2
+ /** No error, join completed */
3
+ JOIN_CLAN_OK = 0,
4
+ /** clan_id doesn't exist for this label */
5
+ JOIN_CLAN_NOT_FOUND = 1001,
6
+ /** members_count >= capacity_limit */
7
+ JOIN_CLAN_FULL = 1002,
8
+ /** User is within the CLAN_COOLDOWN_DAYS window */
9
+ JOIN_CLAN_COOLDOWN_ACTIVE = 1003,
10
+ /** User doesn't satisfy entry_conditions / entry_segment_id */
11
+ JOIN_CLAN_SEGMENT_MISMATCH = 1004,
12
+ /** Not enough Points / Gems / Diamonds for entry fee */
13
+ JOIN_CLAN_INSUFFICIENT_FUNDS = 1005,
14
+ /** User is already a member of this clan */
15
+ JOIN_CLAN_ALREADY_MEMBER = 1006,
16
+ /** clan_status_id != 1 (clan is archived) */
17
+ JOIN_CLAN_ARCHIVED = 1007,
18
+ /** Clan joined after tournament start */
19
+ JOIN_CLAN_JOINED_AFTER_TOURNAMENT_START = 1011
20
+ }
@@ -1,5 +1,6 @@
1
1
  import { ProtocolResponse } from '../Base/ProtocolResponse';
2
+ import { JoinClanErrorCode } from './JoinClanErrorCode';
2
3
  export interface JoinClanResponse extends ProtocolResponse {
3
- errCode?: number;
4
+ errCode?: JoinClanErrorCode;
4
5
  errMsg?: string;
5
6
  }
@@ -5,3 +5,4 @@ export * from './GetClanInfoRequest';
5
5
  export * from './GetClanInfoResponse';
6
6
  export * from './JoinClanRequest';
7
7
  export * from './JoinClanResponse';
8
+ export * from './JoinClanErrorCode';
@@ -12,6 +12,7 @@ export interface UICustomSection {
12
12
  mission_tabs_options?: AchMissionsTabsOptions;
13
13
  overview_missions_filter?: AchOverviewMissionsFilter;
14
14
  overview_missions_count?: number;
15
+ url_or_dp?: string;
15
16
  liquid_entity_data?: LiquidEntityData[];
16
17
  ach_tournament_id?: number;
17
18
  raffle_id?: number;
@@ -343,6 +343,15 @@ export interface SAWTemplateUI {
343
343
  * Back-Office label: _"Steps to finish game"_.
344
344
  */
345
345
  steps_to_finish_game?: number;
346
+ /**
347
+ * Minimum number of path steps / collectible prizes a Voyager session
348
+ * must include before the game can finish. Acts as a floor for the
349
+ * randomly-chosen path length so that sessions cannot terminate after
350
+ * only one or two prizes. When omitted, no minimum is enforced.
351
+ * Must be `>= 1` and `<= steps_to_finish_game`.
352
+ * Back-Office label: _"Min. number of prizes"_.
353
+ */
354
+ min_steps_to_finish_game?: number;
346
355
  /**
347
356
  * Difficulty level of the Voyager (space-exploration) mini-game,
348
357
  * controlling obstacle frequency and game speed.
@@ -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
+ }
@@ -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
+ }
@@ -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 };
@@ -998,6 +998,8 @@ export interface TUICustomSection {
998
998
  overview_missions_filter?: AchOverviewMissionsFilter;
999
999
  /** Quantity of missions to be shown in overview */
1000
1000
  overview_missions_count?: number;
1001
+ /** URL or DP to be used for custom section */
1002
+ url_or_dp?: string;
1001
1003
  /** Data to be used for Liquid templates */
1002
1004
  liquid_entity_data?: LiquidEntityData[];
1003
1005
  /** Tournament ID to be used for Liquid templates */