@smartico/public-api 0.0.122 → 0.0.123

package/dist/Base/ClassId.d.ts

@@ -25,6 +25,8 @@ export declare enum ClassId {
     CLIENT_SET_AVATAR_RESPONSE = 158,
     CLIENT_SET_CUSTOM_USERNAME_REQUEST = 159,
     CLIENT_SET_CUSTOM_USERNAME_RESPONSE = 160,
+    CHECK_SEGMENT_MATCH_REQUEST = 161,
+    CHECK_SEGMENT_MATCH_RESPONSE = 162,
     GET_LEVEL_MAP_REQUEST = 500,
     GET_LEVEL_MAP_RESPONSE = 501,
     GET_ACHIEVEMENT_MAP_REQUEST = 502,

package/dist/Core/CheckSegmentMatchRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolRequest } from "../Base/ProtocolRequest";
+export interface CheckSegmentMatchRequest extends ProtocolRequest {
+    segment_id: number[];
+}

package/dist/Core/CheckSegmentMatchResponse.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface CheckSegmentMatchResponse extends ProtocolResponse {
+    segments: {
+        segment_id: number;
+        is_matching: boolean;
+    }[];
+}

package/dist/MiniGames/SAWPrizeDropWinPush.d.ts

@@ -1,7 +1,9 @@
 import { ProtocolMessage } from ".././Base/ProtocolMessage";
 import { SAWPrize } from "./SAWPrize";
+import { SAWTemplate } from "./SAWTemplate";
 export interface SAWPrizeDropWinPush extends ProtocolMessage {
     request_id: string;
     saw_template_id: number;
     saw_prize: SAWPrize;
+    saw_template: SAWTemplate;
 }

package/dist/Missions/AchClaimPrizeResponse.d.ts

@@ -1,3 +1,3 @@
-import { ProtocolMessage } from "../Base/ProtocolMessage";
-export interface AchClaimPrizeRequest extends ProtocolMessage {
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface AchClaimPrizeResponse extends ProtocolResponse {
 }

package/dist/Missions/index.d.ts

@@ -15,3 +15,5 @@ export * from './AchCategoryPublicMeta';
 export * from './AchievementCategory';
 export * from './GetAchCategoriesResponse';
 export * from './GetAchCategoriesRequest';
+export * from './AchClaimPrizeRequest';
+export * from './AchClaimPrizeResponse';

package/dist/SmarticoAPI.d.ts

@@ -6,12 +6,12 @@ import { GetTranslationsResponse, PublicLabelSettings, ResponseIdentify, Transla
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetInboxMessagesResponse, InboxMessageBody, MarkInboxMessageDeletedResponse, MarkInboxMessageReadResponse, MarkInboxMessageStarredResponse } from './Inbox';
 import { BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse } from './Store';
-import { AchievementOptinResponse, GetAchCategoriesResponse, GetAchievementMapResponse } from './Missions';
+import { AchClaimPrizeResponse, AchievementOptinResponse, GetAchCategoriesResponse, GetAchievementMapResponse } from './Missions';
 import { GetTournamentInfoResponse, GetTournamentsResponse, TournamentRegisterResponse } from './Tournaments';
 import { LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult } from "./WSAPI/WSAPITypes";
 import { GetAchievementsUserInfoResponse } from "./Core/GetAchievementsUserInfoResponse";
 interface Tracker {
     label_api_key: string;
@@ -55,11 +55,13 @@ declare class SmarticoAPI {
     coreChangeUsername(user_ext_id: string, public_username_custom: string): Promise<{
         public_username_custom: string;
     }>;
+    coreCheckSegments(user_ext_id: string, segment_id: number[]): Promise<TSegmentCheckResult[]>;
     sawGetTemplates(user_ext_id: string, lang?: string, is_visitor_mode?: boolean): Promise<SAWGetTemplatesResponse>;
     sawGetTemplatesT(user_ext_id: string): Promise<TMiniGameTemplate[]>;
     doAcknowledgeRequest(user_ext_id: string, request_id: string): Promise<SAWDoAknowledgeResponse>;
     sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id?: number): Promise<SAWDoSpinResponse>;
     missionOptIn(user_ext_id: string, mission_id: number): Promise<AchievementOptinResponse>;
+    missionClaimPrize(user_ext_id: string, mission_id: number, ach_completed_id: number): Promise<AchClaimPrizeResponse>;
     registerInTournament(user_ext_id: string, tournamentInstanceId: number): Promise<TournamentRegisterResponse>;
     buyStoreItem(user_ext_id: string, itemId: number): Promise<BuyStoreItemResponse>;
     inboxGetMessages(user_ext_id: string, limit?: number, offset?: number): Promise<GetInboxMessagesResponse>;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,5 @@
 import { SmarticoAPI } from "../SmarticoAPI";
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
 import { LeaderBoardPeriodType } from "../Leaderboard";
 /** @group General API */
 export declare class WSAPI {
@@ -9,6 +9,10 @@ export declare class WSAPI {
     constructor(api: SmarticoAPI);
     /** Returns information about current user */
     getUserProfile(): TUserProfile;
+    /** Check if user belongs to specific segments */
+    checkSegmentMatch(segment_id: number): Promise<boolean>;
+    /** Check if user belongs to specific list of segments */
+    checkSegmentListMatch(segment_ids: number[]): Promise<TSegmentCheckResult[]>;
     /** Returns all the levels available the current user */
     getLevels(): Promise<TLevel[]>;
     /** Returns all the missions available the current user.
@@ -46,6 +50,8 @@ export declare class WSAPI {
     playMiniGame(template_id: number): Promise<TMiniGamePlayResult>;
     /** Requests an opt-in for the specified mission_id. Returns the err_code. */
     requestMissionOptIn(mission_id: number): Promise<TMissionOptInResult>;
+    /** Request for claim reward for the specified mission id. Returns the err_code. */
+    requestMissionClaimReward(mission_id: number, ach_completed_id: number): Promise<TMissionClaimRewardResult>;
     /** Returns all the active instances of tournaments
      * The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one.
      * The onUpdate callback will be called when the user has registered in a tournament. Updated list will be passed to onUpdate callback.*/

package/dist/WSAPI/WSAPITypes.d.ts

@@ -400,6 +400,12 @@ export interface TMissionOrBadge {
     position?: number;
     /** The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
     ribbon?: TRibbon;
+    /** ID of the completion fact from ach_completed or ach_completed_recurring tables */
+    ach_completed_id?: number;
+    /** Flag from achievement if the mission prize will be given only after user claims it */
+    requires_prize_claim?: boolean;
+    /** The date/timestamp indicating when the prize was claimed by the user */
+    prize_claimed_date_ts?: number;
 }
 export interface AchRelatedGame {
     /** The ID of the related game */
@@ -444,6 +450,15 @@ export interface TMissionOptInResult {
     /** Optional error message */
     err_message: string;
 }
+/**
+ * TMissionClaimRewardResult describes the response of call to _smartico.api.requestMissionClaimReward(mission_id, ach_completed_id) method
+*/
+export interface TMissionClaimRewardResult {
+    /** Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0 */
+    err_code: number;
+    /** Optional error message */
+    err_message: string;
+}
 export interface TTournamentRegistrationResult {
     /** Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0 */
     err_code: TournamentRegistrationError;
@@ -539,4 +554,8 @@ export interface UserLevelExtraCountersT {
     /** The counter of 2nd metric used to reach the level. */
     level_counter_2?: number;
 }
+export interface TSegmentCheckResult {
+    segment_id: number;
+    is_matching: boolean;
+}
 export {};