@wix/auto_sdk_email-marketing_campaigns 1.0.0

package/build/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts

@@ -0,0 +1,1912 @@
+export interface Campaign {
+    /** Campaign ID. */
+    campaignId?: string;
+    /** Marketing campaign title. If you don't provide the value, the title automatically gets the value of an email subject. */
+    title?: string | null;
+    /** URL of the first image after the logo. */
+    firstImageUrl?: string | null;
+    /**
+     * Landing page snapshot URL. <br>
+     * This field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.
+     * The value of this field will soon become the same as the value of the `firstImageUrl` field.
+     * @deprecated Landing page snapshot URL. <br>
+     * This field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.
+     * The value of this field will soon become the same as the value of the `firstImageUrl` field.
+     * @replacedBy firstImageUrl
+     * @targetRemovalDate 2024-12-01
+     */
+    snapshotImageUrl?: string | null;
+    /**
+     * Editor type. Either web app, or mobile app. One of:
+     * + `'WEB'`
+     * + `'MOBILE'`
+     */
+    editorType?: CampaignEditorTypeEnum;
+    /**
+     * Campaign status. One of:
+     * + `'ACTIVE'`
+     * + `'ARCHIVED'`
+     * + `'DELETED'`
+     */
+    status?: CampaignStatusEnum;
+    /**
+     * Campaign visibility status. One of:
+     * + `'DRAFT'`
+     * + `'PUBLISHED'`
+     * + `'TEMPLATE'`
+     */
+    visibilityStatus?: CampaignVisibilityStatusEnum;
+    /**
+     * Campaign distribution status. One of:
+     * + `'NOT_STARTED'`
+     * + `'SCHEDULED'`
+     * + `'IN_DETECTION'`
+     * + `'IN_MODERATION'`
+     * + `'SAMPLING'`
+     * + `'SENDING'`
+     * + `'REJECTED'`
+     * + `'TERMINATED'`
+     * + `'DISTRIBUTED'`
+     * + `'PAUSED'`
+     */
+    distributionStatus?: Enum;
+    /** Publishing data. The field is returned empty if the campaign isn't published. */
+    publishingData?: PublishingData;
+    /** Date and time when the campaign was created. */
+    dateCreated?: Date | null;
+    /** Date and time when the campaign was updated. */
+    dateUpdated?: Date | null;
+    /**
+     * Email subject of the campaign (initially copied from the template).
+     * TODO: Deprecated (moved to "GetComposerResponse").
+     * @deprecated
+     */
+    emailSubject?: string;
+}
+export declare enum CampaignEditorTypeEnum {
+    /** Unknown editor. This value isn't used. */
+    UNKNOWN = "UNKNOWN",
+    /** Classic web editor. */
+    WEB = "WEB",
+    /** Classic mobile editor. */
+    MOBILE = "MOBILE",
+    /** Chat (AI) based web editor. */
+    MJML = "MJML"
+}
+export declare enum CampaignStatusEnum {
+    /** Unknown campaign. This value isn't used. */
+    UNKNOWN = "UNKNOWN",
+    /** Campaign is active. */
+    ACTIVE = "ACTIVE",
+    /** Campaign is archived. */
+    ARCHIVED = "ARCHIVED",
+    /** Campaign is deleted. */
+    DELETED = "DELETED"
+}
+export declare enum CampaignVisibilityStatusEnum {
+    /** Unknown status. This value isn't used. */
+    UNKNOWN = "UNKNOWN",
+    /** Campaign isn't published yet. */
+    DRAFT = "DRAFT",
+    /** Campaign is published. */
+    PUBLISHED = "PUBLISHED",
+    /** Campaign is a template. */
+    TEMPLATE = "TEMPLATE"
+}
+export declare enum Enum {
+    /** Unknown distribution status. */
+    UNKNOWN = "UNKNOWN",
+    /** Campaign isn't distributed to recipients yet. */
+    NOT_STARTED = "NOT_STARTED",
+    /** Campaign is scheduled for distribution. */
+    SCHEDULED = "SCHEDULED",
+    /** Campaign is in screening for malicious content. */
+    IN_DETECTION = "IN_DETECTION",
+    /** Campaign is in review by the site moderators. */
+    IN_MODERATION = "IN_MODERATION",
+    /** Several recipients are selected for campaign testing, and campaign is sent out to them. */
+    SAMPLING = "SAMPLING",
+    /** Campaign is being sent out to all recipients. */
+    SENDING = "SENDING",
+    /** Campaign is rejected. */
+    REJECTED = "REJECTED",
+    /** Campaign is terminated after a failed sampling test. */
+    TERMINATED = "TERMINATED",
+    /** Campaign is fully distributed to all recipients. */
+    DISTRIBUTED = "DISTRIBUTED",
+    /** Scheduled campaign is paused. */
+    PAUSED = "PAUSED"
+}
+export interface PublishingData {
+    /** Landing page URL. */
+    landingPageUrl?: string;
+    /** Marketing campaign statistics. */
+    statistics?: CampaignStatistics;
+    /** Marketing campaign publish date. */
+    datePublished?: Date | null;
+}
+export interface CampaignStatistics {
+    /** Landing page statistics of a marketing campaign. */
+    landingPage?: LandingPageStatistics;
+    /** Email distribution statistics of a marketing campaign. */
+    emailCampaign?: DistributionStatistics;
+    /** Combined statistics of landing page and email distribution. */
+    total?: TotalStatistics;
+}
+export interface LandingPageStatistics {
+    /** Number of times when a landing page was loaded or viewed. */
+    opened?: number;
+    /** Number of times a link was clicked in a landing page. */
+    clicked?: number;
+}
+export interface DistributionStatistics {
+    /** Number of delivered emails. */
+    delivered?: number;
+    /**
+     * Number of recipients who opened an email.
+     *
+     * If the same recipient opened the same email twice, it is counted as a one unique open.
+     */
+    opened?: number;
+    /**
+     * Number of recipients who clicked a link in the email.
+     *
+     * If the same recipient clicked the same link twice, it is counted as a one unique click.
+     *
+     * If the same recipient clicked different links, it is counted as a one unique click.
+     */
+    clicked?: number;
+    /** Number of emails that didn't reach the recipient. */
+    bounced?: number;
+    /** Number of recipients who reported the email as a spam. */
+    complained?: number;
+    /** Number of emails that weren't sent due to the campaign termination. */
+    notSent?: number;
+}
+export interface TotalStatistics {
+    /** Total number of emails sent. */
+    mailsSent?: number;
+    /** Number of landing page views and opened emails. */
+    opened?: number;
+    /** Number of landing page and email link clicks. */
+    clicked?: number;
+}
+export interface RejectionData {
+    rejectionReasons?: RejectionReasonEnum[];
+}
+export declare enum RejectionReasonEnum {
+    UNKNOWN = "UNKNOWN",
+    LOW_ENGAGEMENT = "LOW_ENGAGEMENT",
+    SENDER_DETAILS = "SENDER_DETAILS",
+    SPAM_TRAPS = "SPAM_TRAPS",
+    OTHER = "OTHER",
+    ADULT_SEXUAL_CONTENT = "ADULT_SEXUAL_CONTENT",
+    AFFILIATE_MARKETING = "AFFILIATE_MARKETING",
+    BETTING_OR_GAMBLING = "BETTING_OR_GAMBLING",
+    CREDIT_REPAIR_OR_DEBT_RELIEF = "CREDIT_REPAIR_OR_DEBT_RELIEF",
+    GET_RICH_QUICK_SCHEME = "GET_RICH_QUICK_SCHEME",
+    ILLEGAL_SUBSTANCES_OR_WEAPONS = "ILLEGAL_SUBSTANCES_OR_WEAPONS",
+    MISLEADING_SUBJECT_LINE = "MISLEADING_SUBJECT_LINE",
+    TRADING_OR_CRYPTOCURRENCIES = "TRADING_OR_CRYPTOCURRENCIES",
+    UNSOLICITED_CONTENT = "UNSOLICITED_CONTENT"
+}
+export declare enum CampaignSendingStateEnum {
+    /** Campaign not yet published. */
+    DRAFT = "DRAFT",
+    /** Campaign is being reviewed. */
+    REVIEW = "REVIEW",
+    /** Campaign was rejected. */
+    REJECTED = "REJECTED",
+    /** Campaign is scheduled. */
+    SCHEDULED = "SCHEDULED",
+    /** Scheduled campaign was paused. */
+    PAUSED = "PAUSED",
+    /** Campaign is published. */
+    PUBLISHED = "PUBLISHED",
+    /** Campaign is being send. */
+    SENDING = "SENDING",
+    /**
+     * Campaign was partially sent.
+     * Happens when too many recipients bounce.
+     */
+    PARTIALLY_SENT = "PARTIALLY_SENT",
+    /** Campaign was sent. */
+    SENT = "SENT"
+}
+export declare enum CampaignTypeEnum {
+    UNKNOWN = "UNKNOWN",
+    /** Regular email marketing campaign. */
+    EMAIL_MARKETING = "EMAIL_MARKETING",
+    /** mobile place invitation email */
+    INVITATION = "INVITATION",
+    /** automation */
+    AUTOMATION = "AUTOMATION",
+    /** triggered email */
+    TRIGGERED = "TRIGGERED"
+}
+export interface EstimateFilterSizeRequest {
+    /** Contacts filter expression. */
+    filter?: Record<string, any> | null;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /** Contacts plain text search expression (searches in name, phone and email fields). */
+    search?: string | null;
+}
+export interface EstimateFilterSizeResponse {
+    /** Mailing list size estimation. */
+    estimation?: number;
+}
+export interface EstimateAudienceSizeRequest {
+    /** Contact IDs of a campaign audience. */
+    contactIds?: string[];
+    /** Label IDs of a campaign audience. */
+    labelIds?: string[];
+    /** Contacts filter expression (json). */
+    contactsFilter?: Record<string, any> | null;
+    /** Contacts plain text search expression (searches in name, phone and email fields). */
+    search?: string | null;
+    /** Segment ids of a campaign audience. */
+    segmentIds?: string[];
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /** Id of a campaign that is to be resent. */
+    resendCampaignId?: string | null;
+    /** Should total number of contacts in provided audience be returned or not (default value "false"). */
+    withTotal?: boolean;
+}
+export interface EstimateAudienceSizeResponse {
+    /** Audience size (estimated number of emails to be sent). */
+    estimation?: number;
+    /** Total number of contacts in provided audience (optional). */
+    total?: number | null;
+}
+export interface ReconcileContactRequest {
+    /** Email address of the contact. */
+    emailAddress?: string;
+}
+export interface ReconcileContactResponse {
+    /** Created or retrieved contact. */
+    contact?: Contact;
+}
+export interface Contact {
+    /** Unique ID of the contact entity. */
+    _id?: string;
+    /** Primary email address of the contact. */
+    emailAddress?: string;
+    /** Full name of the contact (optional). */
+    fullName?: string | null;
+    /** Profile picture of the contact (optional). */
+    pictureUrl?: string | null;
+}
+export interface SearchContactsRequest {
+    /** Text to search contacts by - can search by name or email address. */
+    searchTerm?: string;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /** Page size (default 50, max 1000). */
+    pageSize?: number | null;
+}
+export interface SearchContactsResponse {
+    /** Search results. */
+    contacts?: Contact[];
+}
+export interface GetLabelsRequest {
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+}
+export interface GetLabelsResponse {
+    /** Returned labels with contact counts. */
+    labels?: Label[];
+}
+export interface Label {
+    /** Unique ID of the label entity. */
+    _id?: string;
+    /** Name of the label. */
+    name?: string;
+    /** Amount of contacts assigned to the label. */
+    contactsCount?: number;
+}
+export interface SubscribeFromLandingPageRequest {
+    /** Campaign ID that the subscription is happening from. */
+    campaignId?: string;
+    /** Email address that is entered into subscription field. */
+    emailAddress?: string;
+    /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
+    consent?: boolean;
+}
+export interface SubscribeFromLandingPageResponse {
+    contactId?: string;
+}
+export interface GetPlaceholderKeysRequest {
+    /** Campaign ID. */
+    campaignId?: string;
+}
+export interface GetPlaceholderKeysResponse {
+    /** Keys of placeholders used in the campaign. */
+    placeholderKeys?: string[];
+}
+export interface GetDefaultComponentsRequest {
+}
+export interface GetDefaultComponentsResponse {
+    footer?: Record<string, any> | null;
+    logo?: Record<string, any> | null;
+    follow?: Record<string, any> | null;
+}
+export interface ValidateLinkRequest {
+    /** URL to validate. */
+    url: string;
+}
+export interface ValidateLinkResponse {
+    /** Whether the link is valid. */
+    valid?: boolean;
+}
+export interface ValidateHtmlLinksRequest {
+    /** HTML string with links. */
+    html: string;
+}
+export interface ValidateHtmlLinksResponse {
+    /** Non-valid links. */
+    blacklistedLinks?: string[];
+}
+export interface ListStatisticsRequest {
+    /** IDs of the campaigns to retrieve (max 100 campaigns). */
+    campaignIds: string[];
+}
+export interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
+}
+export interface CampaignStatisticsContainer {
+    /** Campaign ID. */
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
+}
+export interface ListRecipientsRequest {
+    /** Campaign ID. */
+    campaignId: string;
+    /**
+     * __Required.__ Email activity to filter for. One of:
+     * + `'DELIVERED'`
+     * + `'OPENED'`
+     * + `'CLICKED'`
+     * + `'BOUNCED'`
+     * + `'NOT_SENT'`
+     */
+    activity: RecipientsActivityEnum;
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+export declare enum RecipientsActivityEnum {
+    UNKNOWN = "UNKNOWN",
+    DELIVERED = "DELIVERED",
+    OPENED = "OPENED",
+    CLICKED = "CLICKED",
+    BOUNCED = "BOUNCED",
+    NOT_SENT = "NOT_SENT",
+    SENT = "SENT",
+    NOT_OPENED = "NOT_OPENED"
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface ListRecipientsResponse {
+    /** List of recipients. */
+    recipients?: CampaignRecipientDetails[];
+    /** Details on the paged set of returned results. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface CampaignRecipientDetails {
+    /** Contact ID. */
+    contactId?: string;
+    /** Date and time of the last activity. */
+    lastActivityDate?: Date | null;
+    /** Primary email address of the contact. */
+    emailAddress?: string;
+    /** Full name of the contact (optional). */
+    fullName?: string | null;
+    /** Is this contact currently deleted from the site or not. */
+    contactDeleted?: boolean;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface GetCampaignMappingRequest {
+    /** rule ID in automations */
+    automationRuleId?: string;
+    /** template ID configured for the automation */
+    templateId?: string;
+}
+export interface GetCampaignMappingResponse {
+    campaignId?: string;
+}
+export interface GetPingCampaignMappingRequest {
+    /** ping stream ID. */
+    streamId?: string;
+    /** template ID configured for the ping automation. */
+    templateId?: string;
+    /** ID of the initiating vertical. */
+    appDefId?: string;
+    /** Ping template ID. */
+    pingTemplateId?: string | null;
+    /** Preferred language. */
+    language?: string;
+    /** rule ID in automations */
+    automationRuleId?: string;
+}
+export interface GetPingCampaignMappingResponse {
+    campaignId?: string;
+}
+export interface QueryAutomationTemplatesRequest {
+    /** https://github.com/wix-private/p13n/blob/master/protos/query/src/main/proto/wix/common/query.proto */
+    query?: Query;
+}
+export interface Query {
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: any;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryAutomationTemplatesResponse {
+    entries?: AutomationTemplateContainer[];
+    metaData?: QueryMetadata;
+    total?: number;
+}
+export interface AutomationTemplateContainer {
+    automationTemplate?: AutomationTemplate;
+    enrichmentData?: AutomationTemplateEnrichmentData;
+}
+export interface AutomationTemplate {
+    /**
+     * Automation template ID (unique)
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Automation template current revision
+     * @readonly
+     */
+    revision?: number | null;
+    /** Automation template name */
+    name?: string | null;
+    /** Automation template description */
+    description?: string | null;
+    /** Automation template rule configuration */
+    rule?: RuleConfiguration;
+    /** Automation template correlation id - TODO: rename */
+    correlationId?: string | null;
+    /** Automation template type */
+    templateType?: TemplateType;
+    /** Automation template preconditions */
+    preconditions?: Precondition[];
+    /** used to determine which users will see the Automation template while in internal state */
+    groupIds?: string[];
+    /**
+     * Automation template state
+     * @readonly
+     */
+    templateState?: TemplateState;
+    /**
+     * Automation template created date
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Automation template updated date
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** @readonly */
+    translation?: Translation;
+    /**
+     * key -> english value, we will include those keys in the translator json and send them for translations.
+     * in the "search rules" api they will be resolved with their translation
+     */
+    additionalTranslations?: Record<string, string>;
+}
+export interface RuleConfiguration {
+    /** Rule configuration name */
+    name?: string;
+    /** Rule configuration description */
+    description?: string;
+    /** Trigger configuration */
+    trigger?: TriggerConfiguration;
+    /** Actions configuration */
+    actions?: ActionConfiguration[];
+    /** Rule status */
+    ruleStatus?: RuleStatus;
+    /** Activation cycle */
+    activationCycle?: ActivationCycle;
+    metadata?: RuleMetadata;
+}
+export interface ConditionConfiguration {
+    /** Condition schema key */
+    schemaKey?: string;
+    /** Condition operator */
+    operator?: Operator;
+    /** Condition values */
+    values?: string[];
+}
+export declare enum Operator {
+    UNDEFINED = "UNDEFINED",
+    IN = "IN"
+}
+export interface TriggerConfiguration {
+    /** Trigger source app def id */
+    appDefId?: string;
+    /** Trigger name */
+    triggerName?: string;
+    /** Trigger schema */
+    triggerSchema?: string;
+    /** Condition configuration */
+    conditions?: ConditionConfiguration[];
+    /** TODO - might need to replace the entire object */
+    triggerConfigurationId?: string | null;
+    /** Trigger Reengagement delay internal in sec */
+    reengagementDelaySec?: number | null;
+}
+export interface ActionConfiguration {
+    _id?: string | null;
+    /** Action source app def id */
+    appDefId?: string;
+    /** Action name */
+    actionName?: string;
+    /** Action configuration */
+    configuration?: string;
+    /** Delay interval in seconds */
+    delayIntervalSec?: number;
+}
+export declare enum RuleStatus {
+    UnknownStatus = "UnknownStatus",
+    Active = "Active",
+    Suspended = "Suspended"
+}
+export interface ActivationCycle {
+    /** set a time frame in minutes for the once_per_user attribute, use 0 for infinite */
+    timeFrame?: number;
+    /** number of activations allowed in the given time_frame */
+    activations?: number;
+    rateLimitingJsonata?: string | null;
+}
+export interface RuleMetadata {
+    /** default value is 'true', when this is set to 'false' user wont be able to toggle off the rule */
+    canBeSuspended?: boolean | null;
+    /** additional notes to describe the rule */
+    notes?: string | null;
+    /** will be used to indicate to user how urgent is this change during "version" changes */
+    versionType?: VersionType;
+}
+export declare enum VersionType {
+    UNKNOWN_VERSION_TYPE = "UNKNOWN_VERSION_TYPE",
+    MINOR = "MINOR",
+    MAJOR = "MAJOR"
+}
+/** Type */
+export declare enum TemplateType {
+    UNKNOWN_TEMPLATE_TYPE = "UNKNOWN_TEMPLATE_TYPE",
+    PREINSTALLED = "PREINSTALLED",
+    RECIPE = "RECIPE"
+}
+/**
+ * {
+ * State message examples:
+ * precondition_type: PreconditionType.Petri,
+ * key: ‘specs.crm.InvoicesSendViaAutomationsABC’,
+ * value: ‘C’
+ * },
+ * {
+ * precondition_type: PreconditionType.STATE,
+ * key: ‘<froms_app_def_id>:double_opt_in’,
+ * value: ‘true’
+ * },
+ * {
+ * precondition_type: PreconditionType.APP_DEPENDENCY,
+ * key: ‘<paid_plans_app_def_id>’,
+ * value: ‘true’
+ * }
+ */
+export interface Precondition {
+    /** Precondition type */
+    preconditionType?: PreconditionType;
+    /** Precondition unique key */
+    key?: string;
+    /** Precondition value */
+    value?: string;
+    /** Precondition fallback */
+    fallback?: boolean | null;
+}
+export declare enum PreconditionType {
+    UNKNOWN_PRECONDITION_TYPE = "UNKNOWN_PRECONDITION_TYPE",
+    PETRI = "PETRI",
+    STATE = "STATE",
+    APP_DEPENDENCY = "APP_DEPENDENCY",
+    DEALER_OFFERING = "DEALER_OFFERING"
+}
+export declare enum TemplateState {
+    UNKNOWN_TEMPLATE_STATUS = "UNKNOWN_TEMPLATE_STATUS",
+    INTERNAL = "INTERNAL",
+    PUBLIC = "PUBLIC",
+    ARCHIVED = "ARCHIVED",
+    LIVE = "LIVE"
+}
+export interface Translation {
+    state?: TranslationState;
+}
+export declare enum TranslationState {
+    UNKNOWN_TRANSLATION_STATE = "UNKNOWN_TRANSLATION_STATE",
+    NOT_REQUESTED = "NOT_REQUESTED",
+    PENDING = "PENDING",
+    PARTIAL = "PARTIAL",
+    TRANSLATED = "TRANSLATED"
+}
+export interface AutomationTemplateEnrichmentData {
+    campaignId?: string;
+    metaSiteId?: string;
+}
+export interface QueryMetadata {
+    /** Number of returned items */
+    items?: number;
+    /** Offset that was applied to the request */
+    offset?: number;
+}
+export interface QueryAppTemplatesRequest {
+    queryType?: TemplateQueryType;
+}
+export declare enum TemplateQueryType {
+    TRIGGERED_EMAILS = "TRIGGERED_EMAILS",
+    PING = "PING"
+}
+export interface QueryAppTemplatesResponse {
+    template?: TemplateData[];
+}
+export interface TemplateData {
+    templateName?: string;
+    templateId?: string;
+}
+export interface CampaignLookupRequest {
+    campaignId?: string;
+}
+export interface CampaignLookupResponse {
+    campaignId?: string;
+    instanceId?: string;
+    metasiteId?: string;
+}
+export interface CampaignLookupBatchRequest {
+    campaignIds?: string[];
+}
+export interface CampaignLookupBatchResponse {
+    responses?: CampaignLookupResponse[];
+}
+export interface UpsertTranslationRequest {
+    /** Campaign ID. */
+    campaignId?: string;
+    /** Composer data. */
+    composer?: Composer;
+    /** Translation language (optional, default value "EN"). */
+    language?: string | null;
+    /** For BI event [36:1031] only (optional, default value "n/a"). */
+    automationRuleId?: string | null;
+    /** Should campaign also be published or not (default value "false"). */
+    publish?: boolean;
+    /** Campaign subject (optional). */
+    emailSubject?: string | null;
+    /** Campaign preheader (optional). */
+    emailPreheader?: string | null;
+}
+export interface Composer {
+    /** Internal data structure for editor/viewer to render the campaign. */
+    composerDataJson?: string;
+    /** Default values of existing placeholders. */
+    defaultValues?: DefaultValues;
+}
+export interface DefaultValues {
+    map?: Record<string, string>;
+}
+export interface UpsertTranslationResponse {
+}
+export interface GetUsedPlaceholderKeysRequest {
+    /** Campaign ID. */
+    campaignId?: string;
+}
+export interface GetUsedPlaceholderKeysResponse {
+    /** Keys of placeholders used in the automation. */
+    placeholderKeys?: string[];
+}
+export interface LookupCampaignMappingRequest {
+    /** rule ID in automations */
+    automationRuleId?: string;
+    /** template ID configured for the automation */
+    templateId?: string;
+}
+export interface LookupCampaignMappingResponse {
+    campaignId?: string | null;
+}
+export interface UpsertAutomationTranslatorContentRequest {
+    /** Campaign ID that the content belongs to */
+    campaignId?: string;
+    /** Automation translator content */
+    automationTranslatorContent?: AutomationTranslatorContent;
+}
+/** Automation Translator Content */
+export interface AutomationTranslatorContent {
+    /** AutomationTranslatorContent ID */
+    _id?: string;
+    /** Content that can contain multiple strings. It represents a json file, that is stored on Smartling */
+    json?: string;
+}
+export interface UpsertAutomationTranslatorContentResponse {
+}
+export interface GetAutomationTranslatorContentRequest {
+    /** Campaign ID */
+    campaignId?: string;
+}
+export interface GetAutomationTranslatorContentResponse {
+    /** Automation translator content */
+    automationTranslatorContent?: AutomationTranslatorContent;
+}
+export interface GetCampaignRequest {
+    /** Campaign ID. */
+    campaignId: string;
+    /**
+     * Whether a returned campaign object should include `publishingData.statistics`.
+     *
+     * Default: `false`.
+     */
+    optionIncludeStatistics?: boolean;
+}
+export interface GetCampaignResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+export interface ListCampaignsRequest {
+    /** Paging parameters. */
+    paging?: Paging;
+    /**
+     * Whether to include `publishingData.statistics` in the returned campaign object.
+     *
+     * Default: `false`.
+     */
+    optionIncludeStatistics?: boolean;
+    /**
+     * Include campaigns with the following statuses (no filtering by default). One of:
+     * + `'ACTIVE'`
+     * + `'ARCHIVED'`
+     * + `'DELETED'`
+     */
+    statuses?: CampaignStatusEnum[];
+    /**
+     * Include campaigns with the following visibility statuses (no filtering by default). One of:
+     * + `'DRAFT'`
+     * + `'PUBLISHED'`
+     * + `'TEMPLATE'`
+     */
+    visibilityStatuses?: CampaignVisibilityStatusEnum[];
+}
+export interface ListCampaignsResponse {
+    /** Paging parameters. */
+    paging?: Paging;
+    /** List of campaigns. */
+    campaigns?: Campaign[];
+}
+export interface CountCampaignsRequest {
+    /** Since when should we start counting (optional, default value "1970-01-01T00:00:00.000Z") */
+    dateFrom?: Date | null;
+}
+export interface CountCampaignsResponse {
+    /** "drafts" + "scheduled" + "published" (excluding "archived"). */
+    total?: number;
+    /** Non published (draft) campaigns. */
+    drafts?: number;
+    /** Campaigns scheduled for publishing in the future. */
+    scheduled?: number;
+    /** Campaigns published or sent. */
+    published?: number;
+    /** Campaigns moved to archive (regardless of the status). */
+    archived?: number;
+}
+export interface CreateFromTemplateRequest {
+    /** ID of the template to fork. */
+    templateId?: string;
+    /** Values to replace template placeholders with (unique for each template). */
+    variables?: Record<string, string>;
+    /** Campaign editor type. */
+    campaignEditorType?: CampaignEditorTypeEnum;
+}
+export interface CreateFromTemplateResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+export interface CreateUserTemplateRequest {
+    /** ID of campaign to create template from. */
+    campaignId?: string;
+    /** Title of template. */
+    title?: string | null;
+}
+export interface CreateUserTemplateResponse {
+    /** Created user template information. */
+    campaign?: Campaign;
+}
+export interface CreateFromUserTemplateRequest {
+    /** ID of the user template campaign to use. */
+    campaignId?: string;
+}
+export interface CreateFromUserTemplateResponse {
+    /** Campaign created from user template. */
+    campaign?: Campaign;
+}
+export interface PublishCampaignRequest {
+    /** Campaign ID */
+    campaignId: string;
+    /** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
+    emailDistributionOptions?: EmailDistributionOptions;
+}
+export interface EmailDistributionOptions {
+    /** The subject line for the email campaign, which appears in recipients’ inboxes. */
+    emailSubject?: string | null;
+    /** Contact label IDs. */
+    labelIds?: string[];
+    /** IDs of contacts to whom to send out the campaign. */
+    contactIds?: string[];
+    /**
+     * Filter ids to send campaign to (unsupported).
+     * @deprecated Filter ids to send campaign to (unsupported).
+     * @replacedBy contacts_filter
+     * @targetRemovalDate 2023-10-10
+     */
+    filterIds?: string[];
+    /** Campaign scheduling. You can schedule the campaign no less than 30 minutes until the sending time. [Upgrade your plan](https://support.wix.com/en/article/email-marketing-upgrading-your-email-marketing-plan) to schedule the campaign. */
+    sendAt?: Date | null;
+}
+export interface PublishCampaignResponse {
+    /** Publishing info. */
+    publishingData?: PublishingData;
+}
+export interface Rejected {
+    /** ID of the campaign that was rejected. */
+    campaignId?: string;
+}
+export interface Published {
+    /** ID of the campaign that was published. */
+    campaignId?: string;
+    /** Campaign landing page URL. */
+    landingPageUrl?: string;
+    /** Estimation of recipient list size (optional). */
+    mailingListSizeEstimate?: number | null;
+}
+export interface Terminated {
+    /** ID of the campaign that was terminated. */
+    campaignId?: string;
+}
+export interface Distributed {
+    /** ID of the campaign that was distributed. */
+    campaignId?: string;
+}
+export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf {
+    /** Recipient clicked on an email. */
+    click?: Click;
+    /** Recipient opened an email. */
+    open?: Open;
+    /**
+     * Email soft bounced when sent to a recipient.
+     *
+     * Indicates a temporary issue sending your email. For example, the email server receiving the email is under a heavy load.
+     * For soft bounces, you should wait and try again at a later time.
+     */
+    softBounce?: SoftBounce;
+    /**
+     * Email hard bounced when sent to a recipient.
+     *
+     * Indicates a permanent error sending your email. For example, the email address does not exist.
+     */
+    hardBounce?: HardBounce;
+    /** Campaign ID. */
+    campaignId?: string;
+    /** [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient. */
+    contactId?: string;
+    /** Email address of a recipient. */
+    recipientEmailAddress?: string;
+    /** Date and time of the event. */
+    timestamp?: Date | null;
+    activityType?: ActivityType;
+    /** email metadata */
+    metadata?: Record<string, string>;
+}
+/** @oneof */
+export interface EmailActivityUpdatedEventTypeOneOf {
+    /** Recipient clicked on an email. */
+    click?: Click;
+    /** Recipient opened an email. */
+    open?: Open;
+    /**
+     * Email soft bounced when sent to a recipient.
+     *
+     * Indicates a temporary issue sending your email. For example, the email server receiving the email is under a heavy load.
+     * For soft bounces, you should wait and try again at a later time.
+     */
+    softBounce?: SoftBounce;
+    /**
+     * Email hard bounced when sent to a recipient.
+     *
+     * Indicates a permanent error sending your email. For example, the email address does not exist.
+     */
+    hardBounce?: HardBounce;
+}
+/** The type of email activity that triggered the webhook. */
+export declare enum ActivityType {
+    /** Triggered when an email is delivered to the recipient. */
+    DELIVERY = "DELIVERY",
+    /** Triggered when the recipient clicks on a URL inside of the email. */
+    CLICK = "CLICK",
+    /** Triggered when the email is opened by the recipient. */
+    OPEN = "OPEN",
+    /** Triggered when the email is bounced softly. */
+    SOFT_BOUNCE = "SOFT_BOUNCE",
+    /** Triggered when the email bounces. */
+    HARD_BOUNCED = "HARD_BOUNCED"
+}
+export interface Click {
+    /** URL that was clicked. */
+    url?: string;
+    /** Browser user agent of the recipient. */
+    userAgent?: string;
+}
+export interface Open {
+    /** Browser user agent of the recipient. */
+    userAgent?: string;
+}
+export interface SoftBounce {
+    /** Reason the email soft bounced. */
+    reason?: string;
+}
+export interface HardBounce {
+    /** Reason the email hard bounced. */
+    reason?: string;
+}
+export interface Scheduled {
+    /** ID of the campaign that was scheduled. */
+    campaignId?: string;
+    /** The timestamp campaign is scheduled for. */
+    sendAt?: Date | null;
+    /** Shows if this is a rescheduling of previously scheduled campaign. */
+    rescheduled?: boolean;
+}
+export interface SendTestRequest {
+    /** Campaign ID. */
+    campaignId: string;
+    /** Email subject. */
+    emailSubject?: string | null;
+    /** Recipient email address. */
+    toEmailAddress: string;
+}
+export interface PlaceholderContent extends PlaceholderContentValueOneOf {
+    text?: PlainText;
+    html?: Html;
+    money?: Money;
+    dateTime?: DateTime;
+    map?: Map;
+    array?: _Array;
+    enum?: PlaceholderContentEnum;
+    attachment?: Attachment;
+    integer?: Integer;
+    decimal?: Decimal;
+}
+/** @oneof */
+export interface PlaceholderContentValueOneOf {
+    text?: PlainText;
+    html?: Html;
+    money?: Money;
+    dateTime?: DateTime;
+    map?: Map;
+    array?: _Array;
+    enum?: PlaceholderContentEnum;
+    attachment?: Attachment;
+    integer?: Integer;
+    decimal?: Decimal;
+}
+export interface PlainText {
+    text?: string;
+}
+export interface Html {
+    html?: string;
+}
+/**
+ * Money.
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+ */
+export interface Money {
+    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
+    value?: string;
+    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
+    currency?: string;
+    /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
+    formattedValue?: string | null;
+}
+export interface DateTime {
+    timestamp?: Date | null;
+    /** optional time zone is the full name. example: "Asia/Jerusalem" */
+    timeZone?: string | null;
+}
+export interface Map {
+    variables?: Record<string, PlaceholderContent>;
+}
+export interface _Array {
+    items?: PlaceholderContent[];
+}
+export interface PlaceholderContentEnum {
+    value?: string;
+    translation?: string;
+}
+export interface Attachment {
+    fileName?: string;
+    downloadUrl?: string;
+}
+export interface Integer {
+    /** min value: -2147483648, max value: 2147483647 */
+    value?: number;
+}
+export interface Decimal {
+    /**
+     * when converted from Double, has a limitation of max 16 digits (including fractional part)
+     * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
+     */
+    value?: string;
+}
+export interface SendTestResponse {
+}
+export interface PauseSchedulingRequest {
+    /** Campaign ID. */
+    campaignId: string;
+}
+export interface PauseSchedulingResponse {
+}
+export interface Paused {
+    /** ID of the campaign that was paused. */
+    campaignId?: string;
+}
+export interface RescheduleRequest {
+    /** ID of the campaign to reschedule. */
+    campaignId: string;
+    /** New time for sending out the campaign. */
+    sendAt: Date | null;
+}
+export interface RescheduleResponse {
+}
+export interface ArchiveCampaignRequest {
+    /** ID of the campaign to archive. */
+    campaignId?: string;
+}
+export interface ArchiveCampaignResponse {
+}
+/** Sent when status of the campaign is changed from "Active" to "Archived" */
+export interface Archived {
+    /** ID of the campaign that was archived. */
+    campaignId?: string;
+}
+export interface UnarchiveCampaignRequest {
+    /** ID of the campaign to unarchive. */
+    campaignId?: string;
+}
+export interface UnarchiveCampaignResponse {
+}
+/** Sent when status of the campaign is changed from "Archived" to "Active" */
+export interface Unarchived {
+    /** ID of the campaign whose status was changed to active. */
+    campaignId?: string;
+}
+export interface UpdateTitleRequest {
+    /** ID of the campaign to change title of. */
+    campaignId?: string;
+    /** New title to set. */
+    title?: string;
+}
+export interface UpdateTitleResponse {
+}
+export interface DeleteCampaignRequest {
+    /** Campaign ID. */
+    campaignId: string;
+}
+export interface DeleteCampaignResponse {
+}
+export interface ReuseCampaignRequest {
+    /** ID of the message to be duplicated. */
+    campaignId: string;
+}
+export interface ReuseCampaignResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+export interface PreviewCampaignRequest {
+    /** ID of the campaign to preview. */
+    campaignId?: string;
+    /** Preferred language for campaign content (optional). */
+    language?: string | null;
+    /** Values to replace campaign placeholders with (unique for each campaign). */
+    placeholders?: Record<string, PlaceholderContent>;
+    /** Whether to hide the ad (default value "false"). */
+    forceHideAd?: boolean;
+}
+export interface PreviewCampaignResponse {
+    /** Preview HTML. */
+    html?: string;
+}
+export interface GetComposerRequest {
+    /** Campaign ID. */
+    campaignId?: string;
+    /** Preferred language for campaign content (optional). */
+    language?: string | null;
+}
+export interface GetComposerResponse {
+    /** Composer. */
+    composer?: Composer;
+    /** Campaign subject. */
+    emailSubject?: string;
+    /** Campaign preheader (optional). */
+    emailPreheader?: string | null;
+}
+export interface UpdateComposerRequest {
+    /** Campaign ID. */
+    campaignId?: string;
+    /** Campaign composer. */
+    composer?: Composer;
+    /** Campaign editor type (optional, default "WEB"). */
+    campaignEditorType?: CampaignEditorType;
+    /** Campaign subject (optional). */
+    emailSubject?: string | null;
+    /** Campaign preheader (optional). */
+    emailPreheader?: string | null;
+}
+/** specifies if campaign is being created and edited in web or mobile app */
+export interface CampaignEditorType {
+    value?: CampaignEditorTypeEnum;
+}
+export interface UpdateComposerResponse {
+}
+export interface CreateCampaignRequest {
+    /** Campaign composer. */
+    composer?: Composer;
+    /** Campaign editor type (optional, default "WEB"). */
+    campaignEditorType?: CampaignEditorType;
+    /** Campaign subject (optional). */
+    emailSubject?: string | null;
+    /** Campaign preheader (optional). */
+    emailPreheader?: string | null;
+}
+export interface CreateCampaignResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+export interface ResendToNonOpenersRequest {
+    /** ID of the campaign to resend. */
+    campaignId?: string;
+    /** Subject line to use with the resent copy of campaign. */
+    emailSubject?: string | null;
+}
+export interface ResendToNonOpenersResponse {
+    /** ID of the newly created and resent campaign. */
+    campaignId?: string;
+}
+export interface GetAudienceRequest {
+    /** Campaign ID. */
+    campaignId: string;
+}
+export interface GetAudienceResponse {
+    /** Campaign audience. */
+    audience?: CampaignAudience;
+}
+export interface CampaignAudience {
+    /** IDs of contacts to whom to send the campaign. */
+    contactIds?: string[];
+    /** Labels IDs. */
+    labelIds?: string[];
+    /** Segment IDs. */
+    segmentIds?: string[];
+    /** Filter for contacts in JSON format. */
+    contactsFilter?: Record<string, any> | null;
+    /** Contacts plain text search expression (searches in name, phone and email fields). */
+    contactsSearchTerm?: string | null;
+    /** Should "inactive" contacts be excluded or not. */
+    activeContactsOnly?: boolean;
+}
+export interface IdentifySenderAddressRequest {
+    /** Email address to verify. */
+    emailAddress: string;
+}
+export interface IdentifySenderAddressResponse {
+    /** Actual "from" address that will be used for sending emails. */
+    senderAddress?: string;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface ValidateLinkResponseNonNullableFields {
+    valid: boolean;
+}
+export interface ValidateHtmlLinksResponseNonNullableFields {
+    blacklistedLinks: string[];
+}
+interface LandingPageStatisticsNonNullableFields {
+    opened: number;
+    clicked: number;
+}
+interface DistributionStatisticsNonNullableFields {
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    complained: number;
+    notSent: number;
+}
+interface CampaignStatisticsContainerNonNullableFields {
+    campaignId: string;
+    landingPage?: LandingPageStatisticsNonNullableFields;
+    email?: DistributionStatisticsNonNullableFields;
+}
+export interface ListStatisticsResponseNonNullableFields {
+    statistics: CampaignStatisticsContainerNonNullableFields[];
+}
+interface CampaignRecipientDetailsNonNullableFields {
+    contactId: string;
+    emailAddress: string;
+    contactDeleted: boolean;
+}
+export interface ListRecipientsResponseNonNullableFields {
+    recipients: CampaignRecipientDetailsNonNullableFields[];
+}
+interface TotalStatisticsNonNullableFields {
+    mailsSent: number;
+    opened: number;
+    clicked: number;
+}
+interface CampaignStatisticsNonNullableFields {
+    landingPage?: LandingPageStatisticsNonNullableFields;
+    emailCampaign?: DistributionStatisticsNonNullableFields;
+    total?: TotalStatisticsNonNullableFields;
+}
+interface PublishingDataNonNullableFields {
+    landingPageUrl: string;
+    statistics?: CampaignStatisticsNonNullableFields;
+    wasResentToNonOpeners: boolean;
+}
+interface RejectionDataNonNullableFields {
+    rejectionReasons: RejectionReasonEnum[];
+}
+export interface CampaignNonNullableFields {
+    campaignId: string;
+    editorType: CampaignEditorTypeEnum;
+    status: CampaignStatusEnum;
+    visibilityStatus: CampaignVisibilityStatusEnum;
+    distributionStatus: Enum;
+    publishingData?: PublishingDataNonNullableFields;
+    rejectionData?: RejectionDataNonNullableFields;
+    sendingState: CampaignSendingStateEnum;
+    campaignType: CampaignTypeEnum;
+    emailSubject: string;
+}
+export interface GetCampaignResponseNonNullableFields {
+    campaign?: CampaignNonNullableFields;
+}
+export interface ListCampaignsResponseNonNullableFields {
+    campaigns: CampaignNonNullableFields[];
+}
+export interface PublishCampaignResponseNonNullableFields {
+    publishingData?: PublishingDataNonNullableFields;
+}
+export interface ReuseCampaignResponseNonNullableFields {
+    campaign?: CampaignNonNullableFields;
+}
+interface CampaignAudienceNonNullableFields {
+    contactIds: string[];
+    labelIds: string[];
+    segmentIds: string[];
+    activeContactsOnly: boolean;
+}
+export interface GetAudienceResponseNonNullableFields {
+    audience?: CampaignAudienceNonNullableFields;
+}
+export interface IdentifySenderAddressResponseNonNullableFields {
+    senderAddress: string;
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface CampaignDistributedEnvelope {
+    data: Distributed;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a campaign is successfully distributed to all recipients.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_campaign_distributed_event
+ */
+export declare function onCampaignDistributedEvent(handler: (event: CampaignDistributedEnvelope) => void | Promise<void>): void;
+export interface CampaignPausedEnvelope {
+    data: Paused;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a scheduled campaign is paused.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_campaign_paused_event
+ */
+export declare function onCampaignPausedEvent(handler: (event: CampaignPausedEnvelope) => void | Promise<void>): void;
+export interface CampaignPublishedEnvelope {
+    data: Published;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a draft campaign is published.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_campaign_published_event
+ */
+export declare function onCampaignPublishedEvent(handler: (event: CampaignPublishedEnvelope) => void | Promise<void>): void;
+export interface CampaignRejectedEnvelope {
+    data: Rejected;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_campaign_rejected_event
+ */
+export declare function onCampaignRejectedEvent(handler: (event: CampaignRejectedEnvelope) => void | Promise<void>): void;
+export interface CampaignScheduledEnvelope {
+    data: Scheduled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a campaign is scheduled to be sent out at the specific time.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_campaign_scheduled_event
+ */
+export declare function onCampaignScheduledEvent(handler: (event: CampaignScheduledEnvelope) => void | Promise<void>): void;
+export interface CampaignTerminatedEnvelope {
+    data: Terminated;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when the mailing list isn't clean and campaign was terminated.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_campaign_terminated_event
+ */
+export declare function onCampaignTerminatedEvent(handler: (event: CampaignTerminatedEnvelope) => void | Promise<void>): void;
+export interface CampaignCreatedEnvelope {
+    entity: Campaign;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a campaign is created.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_created
+ */
+export declare function onCampaignCreated(handler: (event: CampaignCreatedEnvelope) => void | Promise<void>): void;
+export interface CampaignDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a campaign is deleted.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_deleted
+ */
+export declare function onCampaignDeleted(handler: (event: CampaignDeletedEnvelope) => void | Promise<void>): void;
+export interface CampaignEmailActivityUpdatedEnvelope {
+    data: EmailActivityUpdated;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an email campaign has a new recipient activity.
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @permissionId Shoutout.Read
+ * @webhook
+ * @eventType wix.email_marketing.v1.campaign_email_activity_updated
+ */
+export declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Validates any provided link. Use this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
+ *
+ * If you provide a link as a placeholder, it's returned in a response as valid.
+ * @param url - URL to validate.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField url
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
+ */
+export declare function validateLink(url: string): Promise<ValidateLinkResponse & ValidateLinkResponseNonNullableFields>;
+/**
+ * Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Use this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
+ * @param html - HTML string with links.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField html
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
+ */
+export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
+/**
+ * Retrieves a list of statistics for up to 100 selected campaigns.
+ *
+ * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
+ * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
+ *
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
+ * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
+ * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
+ * @public
+ * @requiredField campaignIds
+ * @permissionId Shoutout.Read
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
+ */
+export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
+/**
+ * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
+ *
+ * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
+ *
+ * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
+ *
+ * If no `activity` is included, this endpoint returns an error.
+ *
+ * @param campaignId - Campaign ID.
+ * @param activity - __Required.__ Email activity to filter for. One of:
+ * + `'DELIVERED'`
+ * + `'OPENED'`
+ * + `'CLICKED'`
+ * + `'BOUNCED'`
+ * + `'NOT_SENT'`
+ * @public
+ * @requiredField activity
+ * @requiredField campaignId
+ * @param options - Options to use when getting the list of recipients.
+ * @permissionId Shoutout.Read
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
+ */
+export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
+export interface ListRecipientsOptions {
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+/**
+ * Retrieves information about an email campaign.
+ * @param campaignId - Campaign ID.
+ * @public
+ * @requiredField campaignId
+ * @param options - Options to use when getting a campaign.
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @returns Campaign information.
+ * @fqn wix.emailmarketing.api.v1.CampaignService.Get
+ */
+export declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<Campaign & CampaignNonNullableFields>;
+export interface GetCampaignOptions {
+    /**
+     * Whether a returned campaign object should include `publishingData.statistics`.
+     *
+     * Default: `false`.
+     */
+    optionIncludeStatistics?: boolean;
+}
+/**
+ * Returns a list of email campaigns.
+ *
+ * By default sorts by the `dateUpdated` field in the `DESC` order.
+ * @public
+ * @param options - Options to use when getting the list of campaigns.
+ * @permissionId Shoutout.Read
+ * @permissionScope Read Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.List
+ */
+export declare function listCampaigns(options?: ListCampaignsOptions): Promise<ListCampaignsResponse & ListCampaignsResponseNonNullableFields>;
+export interface ListCampaignsOptions {
+    /** Paging parameters. */
+    paging?: Paging;
+    /**
+     * Whether to include `publishingData.statistics` in the returned campaign object.
+     *
+     * Default: `false`.
+     */
+    optionIncludeStatistics?: boolean;
+    /**
+     * Include campaigns with the following statuses (no filtering by default). One of:
+     * + `'ACTIVE'`
+     * + `'ARCHIVED'`
+     * + `'DELETED'`
+     */
+    statuses?: CampaignStatusEnum[];
+    /**
+     * Include campaigns with the following visibility statuses (no filtering by default). One of:
+     * + `'ACTIVE'`
+     * + `'ARCHIVED'`
+     * + `'DELETED'`
+     */
+    visibilityStatuses?: CampaignVisibilityStatusEnum[];
+}
+/**
+ * Publishes and sends a specified campaign.
+ *
+ * If the `email_distribution_options` object isn't passed in the request, the campaign is only published as a landing page.
+ * @param campaignId - Campaign ID
+ * @public
+ * @requiredField campaignId
+ * @param options - Options to use when publishing a campaign.
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.Publish
+ */
+export declare function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise<PublishCampaignResponse & PublishCampaignResponseNonNullableFields>;
+export interface PublishCampaignOptions {
+    /** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
+    emailDistributionOptions?: EmailDistributionOptions;
+}
+/**
+ * Sends a test email. Use this method to preview your email campaign.
+ *
+ * We strongly recommend you calling this method only a few times in a row, as it has a rate limit.
+ * @param campaignId - Campaign ID.
+ * @public
+ * @requiredField campaignId
+ * @requiredField options.toEmailAddress
+ * @param options - Options for sending a test email.
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
+ */
+export declare function sendTest(campaignId: string, options?: SendTestOptions): Promise<void>;
+export interface SendTestOptions {
+    /** Email subject. */
+    emailSubject?: string | null;
+    /** Recipient email address. */
+    toEmailAddress: string;
+}
+/**
+ * Pauses a scheduled campaign.
+ * @param campaignId - Campaign ID.
+ * @public
+ * @requiredField campaignId
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.PauseScheduling
+ */
+export declare function pauseScheduling(campaignId: string): Promise<void>;
+/**
+ * Changes the sending time for an already scheduled campaign.
+ * @param campaignId - ID of the campaign to reschedule.
+ * @param sendAt - New time for sending out the campaign.
+ * @public
+ * @requiredField campaignId
+ * @requiredField sendAt
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.Reschedule
+ */
+export declare function reschedule(campaignId: string, sendAt: Date | null): Promise<void>;
+/**
+ * Permanently deletes a campaign.
+ * @param campaignId - Campaign ID.
+ * @public
+ * @requiredField campaignId
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService._delete
+ */
+export declare function deleteCampaign(campaignId: string): Promise<void>;
+/**
+ * Creates a copy of an existing campaign.
+ * @param campaignId - ID of the message to be duplicated.
+ * @public
+ * @requiredField campaignId
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
+ */
+export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaignResponse & ReuseCampaignResponseNonNullableFields>;
+/**
+ * Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.
+ * @param campaignId - Campaign ID.
+ * @public
+ * @requiredField campaignId
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
+ */
+export declare function getAudience(campaignId: string): Promise<GetAudienceResponse & GetAudienceResponseNonNullableFields>;
+/**
+ * Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
+ * @param emailAddress - Email address to verify.
+ * @public
+ * @requiredField emailAddress
+ * @permissionId Shoutout.Manage
+ * @permissionScope Manage Email Marketing
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
+ */
+export declare function identifySenderAddress(emailAddress: string): Promise<IdentifySenderAddressResponse & IdentifySenderAddressResponseNonNullableFields>;
+export {};