import { AbstractRestfulClient, Parameters } from '../abstractRestfulClient'; import { GetResult } from '../getResult'; import { Campaign } from './entities/campaign/campaign'; import { CampaignV2 } from './entities/v2/campaign/campaign'; import { CampaignAssets } from './entities/campaignAssets/campaignAssets'; import { CampaignList } from './entities/v2/campaignList'; import { CampaignAggragations } from './entities/campaign/campaignAggregation'; import { CampaignAssetsUpload } from './entities/campaignAssets/campaignAssetsUpload'; import { CampaignPopupType } from './entities/v2/campaign/popup/popup'; import { CampaignBannerType } from './entities/v2/campaign/banner/bannerV3'; export declare enum PostEmailCampaignFields { COLUMN_APPLICATION = "application", COLUMN_METADATA = "metadata" } export declare type PostEmailCampaignType = { [PostEmailCampaignFields.COLUMN_APPLICATION]: string; [PostEmailCampaignFields.COLUMN_METADATA]: PostEmailCampaignMetadataType; }; export declare enum CampaignInputFields { COLUMN_BANNER = "banner", COLUMN_CAMPAIGN_BANNER = "campaignBanner", COLUMN_CATEGORY = "category", COLUMN_END_DATE = "endDate", COLUMN_IS_ACTIVATED = "isActivated", COLUMN_LANDING_PAGE = "landingPage", COLUMN_NAME = "name", COLUMN_POPUP = "campaignPopup", COLUMN_RULES = "rules", COLUMN_START_DATE = "startDate", COLUMN_STATUS = "status" } export declare enum RulesInputFields { COLUMN_END_CUSTOMERS = "endCustomers", COLUMN_LOCATIONS = "locations", COLUMN_MARKETPLACES = "marketplaces", COLUMN_RESELLERS = "resellers", COLUMN_ROLES = "roles", COLUMN_SUBSCRIPTIONS = "subscriptions" } export declare type RulesInputType = { [RulesInputFields.COLUMN_END_CUSTOMERS]?: string[]; [RulesInputFields.COLUMN_LOCATIONS]?: string[]; [RulesInputFields.COLUMN_MARKETPLACES]?: string[]; [RulesInputFields.COLUMN_RESELLERS]?: string[]; [RulesInputFields.COLUMN_ROLES]?: string[]; [RulesInputFields.COLUMN_SUBSCRIPTIONS]?: string[]; }; export declare enum BannerInputFields { CONFIGURATION = "configuration", COLUMN_BUTTON_PLACEMENT = "buttonPlacement", COLUMN_BUTTON_TEXT = "buttonText", COLUMN_TEXT = "text", COLUMN_TEXT_COLOR = "textColor", COLUMN_TYPE = "type" } export declare type BannerInputType = { [BannerInputFields.COLUMN_BUTTON_PLACEMENT]?: string; [BannerInputFields.COLUMN_BUTTON_TEXT]?: string; [BannerInputFields.COLUMN_TEXT]?: string; [BannerInputFields.COLUMN_TEXT_COLOR]?: string; [BannerInputFields.COLUMN_TYPE]?: string; }; export declare enum LandingPageHeaderInputFields { COLUMN_BACKGROUND_COLOR = "backgroundColor", COLUMN_BASELINE = "baseline", COLUMN_CIRCLE_COLOR = "circleColor", COLUMN_TEXT_COLOR = "textColor", COLUMN_TITLE = "title" } export declare type LandingPageHeaderInputType = { [LandingPageHeaderInputFields.COLUMN_BACKGROUND_COLOR]?: string; [LandingPageHeaderInputFields.COLUMN_BASELINE]?: string; [LandingPageHeaderInputFields.COLUMN_CIRCLE_COLOR]?: string; [LandingPageHeaderInputFields.COLUMN_TEXT_COLOR]?: string; [LandingPageHeaderInputFields.COLUMN_TITLE]?: string; }; export declare enum LandingPageBodyInputFields { COLUMN_BACKGROUND_COLOR = "backgroundColor", COLUMN_BUTTON_TEXT = "buttonText", COLUMN_CONTACT_EMAIL = "contactEmail", COLUMN_DESCRIPTION = "description", COLUMN_TITLE = "title", COLUMN_TYPE = "type", COLUMN_VIDEO_URL = "videoUrl" } export declare type LandingPageBodyInputType = { [LandingPageBodyInputFields.COLUMN_BACKGROUND_COLOR]?: string; [LandingPageBodyInputFields.COLUMN_BUTTON_TEXT]?: string; [LandingPageBodyInputFields.COLUMN_CONTACT_EMAIL]?: string; [LandingPageBodyInputFields.COLUMN_DESCRIPTION]?: string; [LandingPageBodyInputFields.COLUMN_TITLE]?: string; [LandingPageBodyInputFields.COLUMN_TYPE]?: string; [LandingPageBodyInputFields.COLUMN_VIDEO_URL]?: string; }; export declare enum LandingPageFooterInputFields { COLUMN_BACKGROUND_COLOR = "backgroundColor", COLUMN_BUTTON_TEXT = "buttonText", COLUMN_BUTTON_URL = "buttonUrl", COLUMN_FEATURE = "feature", COLUMN_MARKETING_FEATURE = "marketingFeature", COLUMN_TEXT_COLOR = "textColor", COLUMN_TITLE = "title" } export declare type LandingPageFooterInputType = { [LandingPageFooterInputFields.COLUMN_BACKGROUND_COLOR]?: string; [LandingPageFooterInputFields.COLUMN_BUTTON_TEXT]?: string; [LandingPageFooterInputFields.COLUMN_BUTTON_URL]?: string; [LandingPageFooterInputFields.COLUMN_FEATURE]?: LandingPageFooterFeatureInputType[]; [LandingPageFooterInputFields.COLUMN_MARKETING_FEATURE]?: LandingPageFooterMarketingFeatureInputFields[]; [LandingPageFooterInputFields.COLUMN_TEXT_COLOR]?: string; [LandingPageFooterInputFields.COLUMN_TITLE]?: string; }; export declare enum LandingPageFooterFeatureInputFields { COLUMN_DESCRIPTION = "description", COLUMN_ITEMS = "items", COLUMN_TITLE = "title" } export declare type LandingPageFooterFeatureInputType = { [LandingPageFooterFeatureInputFields.COLUMN_DESCRIPTION]?: string; [LandingPageFooterFeatureInputFields.COLUMN_ITEMS]?: LandingPageFooterFeatureItemInputType[]; [LandingPageFooterFeatureInputFields.COLUMN_TITLE]?: string; }; export declare enum LandingPageFooterMarketingFeatureInputFields { COLUMN_DESCRIPTION = "description", COLUMN_ITEMS = "items", COLUMN_TITLE = "title" } export declare type LandingPageFooterMarketingFeatureInputType = { [LandingPageFooterFeatureInputFields.COLUMN_DESCRIPTION]?: string; [LandingPageFooterFeatureInputFields.COLUMN_ITEMS]?: LandingPageFooterMarketingFeatureItemInputType[]; [LandingPageFooterFeatureInputFields.COLUMN_TITLE]?: string; }; export declare enum LandingPageFooterFeatureItemInputFields { COLUMN_BUTTON_TEXT = "buttonText", COLUMN_BUTTON_URL = "buttonUrl", COLUMN_DESCRIPTION = "description", COLUMN_ICON = "icon", COLUMN_TITLE = "title" } export declare type LandingPageFooterFeatureItemInputType = { [LandingPageFooterFeatureItemInputFields.COLUMN_BUTTON_TEXT]?: string; [LandingPageFooterFeatureItemInputFields.COLUMN_BUTTON_URL]?: string; [LandingPageFooterFeatureItemInputFields.COLUMN_DESCRIPTION]?: string; [LandingPageFooterFeatureItemInputFields.COLUMN_ICON]?: string; [LandingPageFooterFeatureItemInputFields.COLUMN_TITLE]?: string; }; export declare enum LandingPageFooterMarketingFeatureItemInputFields { COLUMN_BUTTON_TEXT = "buttonText", COLUMN_BUTTON_URL = "buttonUrl", COLUMN_DESCRIPTION = "description", COLUMN_SIZE = "size", COLUMN_TITLE = "title" } export declare type LandingPageFooterMarketingFeatureItemInputType = { [LandingPageFooterMarketingFeatureItemInputFields.COLUMN_BUTTON_TEXT]?: string; [LandingPageFooterMarketingFeatureItemInputFields.COLUMN_BUTTON_URL]?: string; [LandingPageFooterMarketingFeatureItemInputFields.COLUMN_DESCRIPTION]?: string; [LandingPageFooterMarketingFeatureItemInputFields.COLUMN_SIZE]?: string; [LandingPageFooterMarketingFeatureItemInputFields.COLUMN_TITLE]?: string; }; export declare enum LandingPageInputFields { COLUMN_URL = "url", COLUMN_HEADER = "header", COLUMN_BODY = "body", COLUMN_FOOTER = "footer" } export declare type LandingPageInputType = { [LandingPageInputFields.COLUMN_BODY]: LandingPageBodyInputType; [LandingPageInputFields.COLUMN_FOOTER]?: LandingPageFooterInputType; [LandingPageInputFields.COLUMN_HEADER]: LandingPageHeaderInputType; [LandingPageInputFields.COLUMN_URL]?: string; }; export declare enum CampaignCategoryList { COMMUNICATION_BAR = "COMMUNICATIONBAR", BANNER = "BANNER", CAMPAIGN_BANNER = "CAMPAIGNBANNER", BUG = "BUG", LANDING_PAGE = "LANDINGPAGE", NOTIFICATION = "NOTIFICATION", POPUP = "CAMPAIGNPOPUP", RELEASE = "RELEASE" } export declare type CampaignInputType = { [CampaignInputFields.COLUMN_BANNER]?: BannerInputType; [CampaignInputFields.COLUMN_CAMPAIGN_BANNER]?: CampaignBannerType; [CampaignInputFields.COLUMN_CATEGORY]?: CampaignCategoryList; [CampaignInputFields.COLUMN_END_DATE]?: string; [CampaignInputFields.COLUMN_IS_ACTIVATED]?: boolean; [CampaignInputFields.COLUMN_LANDING_PAGE]?: LandingPageInputType; [CampaignInputFields.COLUMN_POPUP]?: CampaignPopupType; [CampaignInputFields.COLUMN_NAME]: string; [CampaignInputFields.COLUMN_RULES]?: RulesInputType; [CampaignInputFields.COLUMN_START_DATE]?: string; [CampaignInputFields.COLUMN_STATUS]?: string; }; export declare type PostEmailCampaignMetadataType = { [keys in string]: string; }; export declare class CampaignClient extends AbstractRestfulClient { /** * The base path of the API */ protected basePath: string; /** * @deprecated Use getActiveCampaignV2() instead */ getActiveCampaign(parameters?: Parameters): Promise>; getActiveCampaignV2(parameters?: Parameters): Promise>; getCampaignAssets(campaignReference: string, parameters?: Parameters): Promise>; /** * @deprecated Use getCampaignDetailsV2() instead */ getCampaignDetails(campaignReference: string, parameters?: Parameters): Promise>; getCampaignDetailsV2(campaignReference: string, parameters?: Parameters): Promise>; postCampaignEmail(campaignReference: string, postData: PostEmailCampaignType, parameters?: Parameters): Promise; getCampaignList(parameters?: Parameters): Promise>; createCampaign(postData: CampaignInputType): Promise>; updateCampaign(campaignReference: string, postData: CampaignInputType): Promise; deleteCampaign(campaignReference: string): Promise; duplicateCampaign(campaignReference: string): Promise>; getCampaignUploadAssetsForm(campaignReference: string): Promise>; deleteAssets(campaignReference: string, assetReference: string): Promise; aggregationsCampaignsCategory(categories: string[]): Promise>; }