@wix/auto_sdk_email-marketing_campaigns 1.0.39 → 1.0.41

package/build/internal/cjs/meta.d.ts

@@ -154,6 +154,66 @@ interface TotalStatistics {
     /** Number of landing page and email link clicks. */
     clicked?: number;
 }
+interface RejectionData {
+    rejectionReasons?: RejectionReasonEnumWithLiterals[];
+}
+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",
+    MAX_AUDIENCE_SIZE_EXCEEDED = "MAX_AUDIENCE_SIZE_EXCEEDED"
+}
+/** @enumType */
+type RejectionReasonEnumWithLiterals = RejectionReasonEnum | 'UNKNOWN' | 'LOW_ENGAGEMENT' | 'SENDER_DETAILS' | 'SPAM_TRAPS' | 'OTHER' | 'ADULT_SEXUAL_CONTENT' | 'AFFILIATE_MARKETING' | 'BETTING_OR_GAMBLING' | 'CREDIT_REPAIR_OR_DEBT_RELIEF' | 'GET_RICH_QUICK_SCHEME' | 'ILLEGAL_SUBSTANCES_OR_WEAPONS' | 'MISLEADING_SUBJECT_LINE' | 'TRADING_OR_CRYPTOCURRENCIES' | 'UNSOLICITED_CONTENT' | 'MAX_AUDIENCE_SIZE_EXCEEDED';
+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"
+}
+/** @enumType */
+type CampaignSendingStateEnumWithLiterals = CampaignSendingStateEnum | 'DRAFT' | 'REVIEW' | 'REJECTED' | 'SCHEDULED' | 'PAUSED' | 'PUBLISHED' | 'SENDING' | 'PARTIALLY_SENT' | 'SENT';
+declare enum CampaignTypeEnum {
+    UNKNOWN = "UNKNOWN",
+    /** Email marketing campaign. */
+    EMAIL_MARKETING = "EMAIL_MARKETING",
+    /** Mobile place invitation email. */
+    INVITATION = "INVITATION",
+    /** Automation campaign. */
+    AUTOMATION = "AUTOMATION",
+    /** Triggered email. */
+    TRIGGERED = "TRIGGERED"
+}
+/** @enumType */
+type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
 interface ListStatisticsRequest {
     /**
      * IDs of the campaigns to retrieve (max 100 campaigns).
@@ -268,6 +328,248 @@ interface Cursors {
      */
     prev?: string | null;
 }
+interface GetCampaignMappingRequest {
+    /**
+     * rule ID in automations
+     * @format GUID
+     */
+    automationRuleId?: string;
+    /**
+     * template ID configured for the automation
+     * @format GUID
+     */
+    templateId?: string;
+}
+interface GetCampaignMappingResponse {
+    /** @format GUID */
+    campaignId?: string;
+}
+interface UpsertTranslationRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Composer data. */
+    composer?: Composer;
+    /**
+     * Translation language (optional, default value "EN").
+     * @format LANGUAGE
+     */
+    language?: string | null;
+    /**
+     * For BI event [36:1031] only (optional, default value "n/a").
+     * @format GUID
+     */
+    automationRuleId?: string | null;
+    /** Should campaign also be published or not (default value "false"). */
+    publish?: boolean;
+    /**
+     * Campaign subject (optional).
+     * @maxLength 1000
+     */
+    emailSubject?: string | null;
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
+    emailPreheader?: string | null;
+}
+interface Composer {
+    /**
+     * Internal data structure for editor/viewer to render the campaign.
+     * @maxLength 10000000
+     */
+    composerDataJson?: string;
+    /** Default values of existing placeholders. */
+    defaultValues?: DefaultValues;
+}
+interface DefaultValues {
+    /** @maxSize 500 */
+    map?: Record<string, string>;
+}
+interface UpsertTranslationResponse {
+}
+interface GetUsedPlaceholderKeysRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface GetUsedPlaceholderKeysResponse {
+    /**
+     * Keys of placeholders used in the automation.
+     * @maxLength 200
+     * @maxSize 300
+     */
+    placeholderKeys?: string[];
+}
+interface LookupCampaignMappingRequest {
+    /**
+     * rule ID in automations
+     * @format GUID
+     */
+    automationRuleId?: string;
+    /**
+     * template ID configured for the automation
+     * @format GUID
+     */
+    templateId?: string;
+}
+interface LookupCampaignMappingResponse {
+    /** @format GUID */
+    campaignId?: string | null;
+}
+interface UpsertAutomationTranslatorContentRequest {
+    /**
+     * Campaign ID that the content belongs to
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Automation translator content */
+    automationTranslatorContent?: AutomationTranslatorContent;
+}
+/** Automation Translator Content */
+interface AutomationTranslatorContent {
+    /**
+     * AutomationTranslatorContent ID
+     * @minLength 1
+     * @maxLength 256
+     * @immutable
+     */
+    id?: string;
+    /**
+     * Content that can contain multiple strings. It represents a json file, that is stored on Smartling
+     * @minLength 1
+     * @maxLength 800000
+     */
+    json?: string;
+}
+interface UpsertAutomationTranslatorContentResponse {
+}
+interface GetAutomationTranslatorContentRequest {
+    /**
+     * Campaign ID
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface GetAutomationTranslatorContentResponse {
+    /** Automation translator content */
+    automationTranslatorContent?: AutomationTranslatorContent;
+}
+interface SendTestBulkRequest {
+    /**
+     * Campaign ID
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Recipient email address
+     * @format EMAIL
+     */
+    toEmailAddress?: string;
+    /** Values to replace campaign placeholders with (unique for each campaign) */
+    placeholders?: Record<string, PlaceholderContent>;
+    /**
+     * Sender from name
+     * @maxLength 100
+     */
+    fromName?: string | null;
+    /**
+     * Reply-to email address
+     * @format EMAIL
+     */
+    replyToEmailAddress?: string | null;
+    /**
+     * Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
+     * @format LANGUAGE
+     */
+    language?: string | null;
+}
+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 */
+interface PlaceholderContentValueOneOf {
+    text?: PlainText;
+    html?: Html;
+    money?: Money;
+    dateTime?: DateTime;
+    map?: Map;
+    array?: _Array;
+    enum?: PlaceholderContentEnum;
+    attachment?: Attachment;
+    integer?: Integer;
+    decimal?: Decimal;
+}
+interface PlainText {
+    text?: string;
+}
+interface Html {
+    html?: string;
+}
+/**
+ * Money.
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+ */
+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.
+     * @format DECIMAL_VALUE
+     */
+    value?: string;
+    /**
+     * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+     * @format CURRENCY
+     */
+    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;
+}
+interface DateTime {
+    timestamp?: Date | null;
+    /** optional time zone is the full name. example: "Asia/Jerusalem" */
+    timeZone?: string | null;
+}
+interface Map {
+    variables?: Record<string, PlaceholderContent>;
+}
+interface _Array {
+    items?: PlaceholderContent[];
+}
+interface PlaceholderContentEnum {
+    value?: string;
+    translation?: string;
+}
+interface Attachment {
+    fileName?: string;
+    downloadUrl?: string;
+}
+interface Integer {
+    /** min value: -2147483648, max value: 2147483647 */
+    value?: number;
+}
+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)
+     * @format DECIMAL_VALUE
+     */
+    value?: string;
+}
+interface SendTestBulkResponse {
+}
 interface GetCampaignRequest {
     /**
      * Campaign ID.
@@ -305,12 +607,74 @@ interface Paging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
+/** Editor type. */
+interface CampaignEditorType {
+    value?: CampaignEditorTypeEnumWithLiterals;
+}
 interface ListCampaignsResponse {
     /** Paging parameters. */
     paging?: Paging;
     /** List of campaigns. */
     campaigns?: Campaign[];
 }
+interface CountCampaignsRequest {
+    /** Since when should we start counting (optional, default value "1970-01-01T00:00:00.000Z") */
+    dateFrom?: Date | null;
+}
+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;
+}
+interface CreateFromTemplateRequest {
+    /**
+     * ID of the template to fork.
+     * @format GUID
+     */
+    templateId?: string;
+    /** Values to replace template placeholders with (unique for each template). */
+    variables?: Record<string, string>;
+    /** Campaign editor type. */
+    campaignEditorType?: CampaignEditorTypeEnumWithLiterals;
+}
+interface CreateFromTemplateResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+interface CreateUserTemplateRequest {
+    /**
+     * ID of campaign to create template from.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Title of template.
+     * @maxLength 1000
+     */
+    title?: string | null;
+}
+interface CreateUserTemplateResponse {
+    /** Created user template information. */
+    campaign?: Campaign;
+}
+interface CreateFromUserTemplateRequest {
+    /**
+     * ID of the user template campaign to use.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface CreateFromUserTemplateResponse {
+    /** Campaign created from user template. */
+    campaign?: Campaign;
+}
 interface PublishCampaignRequest {
     /**
      * Campaign ID
@@ -348,6 +712,148 @@ interface PublishCampaignResponse {
     /** Publishing info. */
     publishingData?: PublishingData;
 }
+interface Rejected {
+    /**
+     * ID of the campaign that was rejected.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface Published {
+    /**
+     * ID of the campaign that was published.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Campaign landing page URL.
+     * @format WEB_URL
+     * @maxLength 2048
+     */
+    landingPageUrl?: string;
+    /** Estimation of recipient list size (optional). */
+    mailingListSizeEstimate?: number | null;
+}
+interface Terminated {
+    /**
+     * ID of the campaign that was terminated.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface Distributed {
+    /**
+     * ID of the campaign that was distributed.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+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.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient.
+     * @format GUID
+     */
+    contactId?: string;
+    /**
+     * Email address of a recipient.
+     * @format EMAIL
+     */
+    recipientEmailAddress?: string;
+    /** Date and time of the event. */
+    timestamp?: Date | null;
+    activityType?: ActivityTypeWithLiterals;
+    /**
+     * email metadata
+     * @maxSize 20
+     */
+    metadata?: Record<string, string>;
+}
+/** @oneof */
+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. */
+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"
+}
+/** @enumType */
+type ActivityTypeWithLiterals = ActivityType | 'DELIVERY' | 'CLICK' | 'OPEN' | 'SOFT_BOUNCE' | 'HARD_BOUNCED';
+interface Click {
+    /** URL that was clicked. */
+    url?: string;
+    /** Browser user agent of the recipient. */
+    userAgent?: string;
+}
+interface Open {
+    /** Browser user agent of the recipient. */
+    userAgent?: string;
+}
+interface SoftBounce {
+    /** Reason the email soft bounced. */
+    reason?: string;
+}
+interface HardBounce {
+    /** Reason the email hard bounced. */
+    reason?: string;
+}
+interface Scheduled {
+    /**
+     * ID of the campaign that was scheduled.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** The timestamp campaign is scheduled for. */
+    sendAt?: Date | null;
+    /** Shows if this is a rescheduling of previously scheduled campaign. */
+    rescheduled?: boolean;
+}
 interface SendTestRequest {
     /**
      * Campaign ID.
@@ -376,6 +882,13 @@ interface PauseSchedulingRequest {
 }
 interface PauseSchedulingResponse {
 }
+interface Paused {
+    /**
+     * ID of the campaign that was paused.
+     * @format GUID
+     */
+    campaignId?: string;
+}
 interface RescheduleRequest {
     /**
      * ID of the campaign to reschedule.
@@ -387,6 +900,54 @@ interface RescheduleRequest {
 }
 interface RescheduleResponse {
 }
+interface ArchiveCampaignRequest {
+    /**
+     * ID of the campaign to archive.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface ArchiveCampaignResponse {
+}
+/** Sent when status of the campaign is changed from "Active" to "Archived" */
+interface Archived {
+    /**
+     * ID of the campaign that was archived.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface UnarchiveCampaignRequest {
+    /**
+     * ID of the campaign to unarchive.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface UnarchiveCampaignResponse {
+}
+/** Sent when status of the campaign is changed from "Archived" to "Active" */
+interface Unarchived {
+    /**
+     * ID of the campaign whose status was changed to active.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface UpdateTitleRequest {
+    /**
+     * ID of the campaign to change title of.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * New title to set.
+     * @maxLength 1000
+     */
+    title?: string;
+}
+interface UpdateTitleResponse {
+}
 interface DeleteCampaignRequest {
     /**
      * Campaign ID.
@@ -407,6 +968,114 @@ interface ReuseCampaignResponse {
     /** Campaign information. */
     campaign?: Campaign;
 }
+interface PreviewCampaignRequest {
+    /**
+     * ID of the campaign to preview.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Preferred language for campaign content (optional).
+     * @format LANGUAGE
+     */
+    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;
+}
+interface PreviewCampaignResponse {
+    /** Preview HTML. */
+    html?: string;
+}
+interface GetComposerRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Preferred language for campaign content (optional).
+     * @format LANGUAGE
+     */
+    language?: string | null;
+}
+interface GetComposerResponse {
+    /** Composer. */
+    composer?: Composer;
+    /**
+     * Campaign subject.
+     * @maxLength 1000
+     */
+    emailSubject?: string;
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
+    emailPreheader?: string | null;
+}
+interface UpdateComposerRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Campaign composer. */
+    composer?: Composer;
+    /** Campaign editor type (optional, default "WEB"). */
+    campaignEditorType?: CampaignEditorType;
+    /**
+     * Campaign subject (optional).
+     * @maxLength 1000
+     */
+    emailSubject?: string | null;
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
+    emailPreheader?: string | null;
+}
+interface UpdateComposerResponse {
+}
+interface CreateCampaignRequest {
+    /** Campaign composer. */
+    composer?: Composer;
+    /** Campaign editor type (optional, default "WEB"). */
+    campaignEditorType?: CampaignEditorType;
+    /**
+     * Campaign subject (optional).
+     * @maxLength 1000
+     */
+    emailSubject?: string | null;
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
+    emailPreheader?: string | null;
+}
+interface CreateCampaignResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+interface ResendToNonOpenersRequest {
+    /**
+     * ID of the campaign to resend.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Subject line to use with the resent copy of campaign.
+     * @maxLength 1000
+     */
+    emailSubject?: string | null;
+}
+interface ResendToNonOpenersResponse {
+    /**
+     * ID of the newly created and resent campaign.
+     * @format GUID
+     */
+    campaignId?: string;
+}
 interface GetAudienceRequest {
     /**
      * Campaign ID.
@@ -466,6 +1135,160 @@ interface IdentifySenderAddressResponse {
      */
     senderAddress?: string;
 }
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface GetPlaceholderKeysRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+interface GetPlaceholderKeysResponse {
+    /** Keys of placeholders used in the campaign. */
+    placeholderKeys?: string[];
+}
+interface GetDefaultComponentsRequest {
+}
+interface GetDefaultComponentsResponse {
+    footer?: Record<string, any> | null;
+    logo?: Record<string, any> | null;
+    follow?: Record<string, any> | null;
+}
 interface ValidateLinkRequest {
     /**
      * URL to validate.
@@ -488,6 +1311,157 @@ interface ValidateHtmlLinksResponse {
     /** Non-valid links. */
     blacklistedLinks?: string[];
 }
+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).
+     * @minLength 1
+     * @maxLength 100
+     */
+    search?: string | null;
+}
+interface EstimateFilterSizeResponse {
+    /** Mailing list size estimation. */
+    estimation?: number;
+}
+interface EstimateAudienceSizeRequest {
+    /**
+     * Contact IDs of a campaign audience.
+     * @format GUID
+     */
+    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).
+     * @minLength 1
+     * @maxLength 100
+     */
+    search?: string | null;
+    /**
+     * Segment ids of a campaign audience.
+     * @format GUID
+     */
+    segmentIds?: string[];
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /**
+     * Id of a campaign that is to be resent.
+     * @format GUID
+     */
+    resendCampaignId?: string | null;
+    /** Should total number of contacts in provided audience be returned or not (default value "false"). */
+    withTotal?: boolean;
+}
+interface EstimateAudienceSizeResponse {
+    /** Audience size (estimated number of emails to be sent). */
+    estimation?: number;
+    /** Total number of contacts in provided audience (optional). */
+    total?: number | null;
+}
+interface ReconcileContactRequest {
+    /**
+     * Email address of the contact.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+}
+interface ReconcileContactResponse {
+    /** Created or retrieved contact. */
+    contact?: Contact;
+}
+interface Contact {
+    /**
+     * Unique ID of the contact entity.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Primary email address of the contact.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+    /**
+     * Full name of the contact (optional).
+     * @maxLength 100
+     */
+    fullName?: string | null;
+    /**
+     * Profile picture of the contact (optional).
+     * @format WEB_URL
+     * @maxLength 2048
+     */
+    pictureUrl?: string | null;
+}
+interface SearchContactsRequest {
+    /**
+     * Text to search contacts by - can search by name or email address.
+     * @maxLength 100
+     */
+    searchTerm?: string;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /**
+     * Page size (default 50, max 1000).
+     * @max 1000
+     */
+    pageSize?: number | null;
+}
+interface SearchContactsResponse {
+    /** Search results. */
+    contacts?: Contact[];
+}
+interface GetLabelsRequest {
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+}
+interface GetLabelsResponse {
+    /** Returned labels with contact counts. */
+    labels?: Label[];
+}
+interface Label {
+    /**
+     * Unique ID of the label entity.
+     * @maxLength 100
+     */
+    id?: string;
+    /**
+     * Name of the label.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Amount of contacts assigned to the label. */
+    contactsCount?: number;
+}
+interface SubscribeFromLandingPageRequest {
+    /**
+     * Campaign ID that the subscription is happening from.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Email address that is entered into subscription field.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+    /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
+    consent?: boolean;
+}
+interface SubscribeFromLandingPageResponse {
+    /** @format GUID */
+    contactId?: string;
+}
+/** @docsIgnore */
+type PublishApplicationErrors = {
+    code?: 'ALREADY_SENT';
+    description?: string;
+    data?: Record<string, any>;
+};
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -532,4 +1506,4 @@ declare function identifySenderAddress(): __PublicMethodMetaInfo<'POST', {}, Ide
 declare function validateLink(): __PublicMethodMetaInfo<'POST', {}, ValidateLinkRequest$1, ValidateLinkRequest, ValidateLinkResponse$1, ValidateLinkResponse>;
 declare function validateHtmlLinks(): __PublicMethodMetaInfo<'POST', {}, ValidateHtmlLinksRequest$1, ValidateHtmlLinksRequest, ValidateHtmlLinksResponse$1, ValidateHtmlLinksResponse>;
 
-export { type __PublicMethodMetaInfo, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };
+export { type ActionEvent as ActionEventOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type ArchiveCampaignRequest as ArchiveCampaignRequestOriginal, type ArchiveCampaignResponse as ArchiveCampaignResponseOriginal, type Archived as ArchivedOriginal, type Attachment as AttachmentOriginal, type AutomationTranslatorContent as AutomationTranslatorContentOriginal, type CampaignAudience as CampaignAudienceOriginal, CampaignEditorTypeEnum as CampaignEditorTypeEnumOriginal, type CampaignEditorTypeEnumWithLiterals as CampaignEditorTypeEnumWithLiteralsOriginal, type CampaignEditorType as CampaignEditorTypeOriginal, type Campaign as CampaignOriginal, type CampaignRecipientDetails as CampaignRecipientDetailsOriginal, CampaignSendingStateEnum as CampaignSendingStateEnumOriginal, type CampaignSendingStateEnumWithLiterals as CampaignSendingStateEnumWithLiteralsOriginal, type CampaignStatisticsContainer as CampaignStatisticsContainerOriginal, type CampaignStatistics as CampaignStatisticsOriginal, CampaignStatusEnum as CampaignStatusEnumOriginal, type CampaignStatusEnumWithLiterals as CampaignStatusEnumWithLiteralsOriginal, CampaignTypeEnum as CampaignTypeEnumOriginal, type CampaignTypeEnumWithLiterals as CampaignTypeEnumWithLiteralsOriginal, CampaignVisibilityStatusEnum as CampaignVisibilityStatusEnumOriginal, type CampaignVisibilityStatusEnumWithLiterals as CampaignVisibilityStatusEnumWithLiteralsOriginal, type Click as ClickOriginal, type Composer as ComposerOriginal, type Contact as ContactOriginal, type CountCampaignsRequest as CountCampaignsRequestOriginal, type CountCampaignsResponse as CountCampaignsResponseOriginal, type CreateCampaignRequest as CreateCampaignRequestOriginal, type CreateCampaignResponse as CreateCampaignResponseOriginal, type CreateFromTemplateRequest as CreateFromTemplateRequestOriginal, type CreateFromTemplateResponse as CreateFromTemplateResponseOriginal, type CreateFromUserTemplateRequest as CreateFromUserTemplateRequestOriginal, type CreateFromUserTemplateResponse as CreateFromUserTemplateResponseOriginal, type CreateUserTemplateRequest as CreateUserTemplateRequestOriginal, type CreateUserTemplateResponse as CreateUserTemplateResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DateTime as DateTimeOriginal, type Decimal as DecimalOriginal, type DefaultValues as DefaultValuesOriginal, type DeleteCampaignRequest as DeleteCampaignRequestOriginal, type DeleteCampaignResponse as DeleteCampaignResponseOriginal, type Distributed as DistributedOriginal, type DistributionStatistics as DistributionStatisticsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EmailActivityUpdatedEventTypeOneOf as EmailActivityUpdatedEventTypeOneOfOriginal, type EmailActivityUpdated as EmailActivityUpdatedOriginal, type EmailDistributionOptions as EmailDistributionOptionsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type EstimateAudienceSizeRequest as EstimateAudienceSizeRequestOriginal, type EstimateAudienceSizeResponse as EstimateAudienceSizeResponseOriginal, type EstimateFilterSizeRequest as EstimateFilterSizeRequestOriginal, type EstimateFilterSizeResponse as EstimateFilterSizeResponseOriginal, type GetAudienceRequest as GetAudienceRequestOriginal, type GetAudienceResponse as GetAudienceResponseOriginal, type GetAutomationTranslatorContentRequest as GetAutomationTranslatorContentRequestOriginal, type GetAutomationTranslatorContentResponse as GetAutomationTranslatorContentResponseOriginal, type GetCampaignMappingRequest as GetCampaignMappingRequestOriginal, type GetCampaignMappingResponse as GetCampaignMappingResponseOriginal, type GetCampaignRequest as GetCampaignRequestOriginal, type GetCampaignResponse as GetCampaignResponseOriginal, type GetComposerRequest as GetComposerRequestOriginal, type GetComposerResponse as GetComposerResponseOriginal, type GetDefaultComponentsRequest as GetDefaultComponentsRequestOriginal, type GetDefaultComponentsResponse as GetDefaultComponentsResponseOriginal, type GetLabelsRequest as GetLabelsRequestOriginal, type GetLabelsResponse as GetLabelsResponseOriginal, type GetPlaceholderKeysRequest as GetPlaceholderKeysRequestOriginal, type GetPlaceholderKeysResponse as GetPlaceholderKeysResponseOriginal, type GetUsedPlaceholderKeysRequest as GetUsedPlaceholderKeysRequestOriginal, type GetUsedPlaceholderKeysResponse as GetUsedPlaceholderKeysResponseOriginal, type HardBounce as HardBounceOriginal, type Html as HtmlOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IdentifySenderAddressRequest as IdentifySenderAddressRequestOriginal, type IdentifySenderAddressResponse as IdentifySenderAddressResponseOriginal, type Integer as IntegerOriginal, type Label as LabelOriginal, type LandingPageStatistics as LandingPageStatisticsOriginal, type ListCampaignsRequest as ListCampaignsRequestOriginal, type ListCampaignsResponse as ListCampaignsResponseOriginal, type ListRecipientsRequest as ListRecipientsRequestOriginal, type ListRecipientsResponse as ListRecipientsResponseOriginal, type ListStatisticsRequest as ListStatisticsRequestOriginal, type ListStatisticsResponse as ListStatisticsResponseOriginal, type LookupCampaignMappingRequest as LookupCampaignMappingRequestOriginal, type LookupCampaignMappingResponse as LookupCampaignMappingResponseOriginal, type Map as MapOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, type Open as OpenOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PauseSchedulingRequest as PauseSchedulingRequestOriginal, type PauseSchedulingResponse as PauseSchedulingResponseOriginal, type Paused as PausedOriginal, type PlaceholderContentEnum as PlaceholderContentEnumOriginal, type PlaceholderContent as PlaceholderContentOriginal, type PlaceholderContentValueOneOf as PlaceholderContentValueOneOfOriginal, type PlainText as PlainTextOriginal, type PreviewCampaignRequest as PreviewCampaignRequestOriginal, type PreviewCampaignResponse as PreviewCampaignResponseOriginal, type PublishApplicationErrors as PublishApplicationErrorsOriginal, type PublishCampaignRequest as PublishCampaignRequestOriginal, type PublishCampaignResponse as PublishCampaignResponseOriginal, type Published as PublishedOriginal, type PublishingData as PublishingDataOriginal, RecipientsActivityEnum as RecipientsActivityEnumOriginal, type RecipientsActivityEnumWithLiterals as RecipientsActivityEnumWithLiteralsOriginal, type ReconcileContactRequest as ReconcileContactRequestOriginal, type ReconcileContactResponse as ReconcileContactResponseOriginal, type Rejected as RejectedOriginal, type RejectionData as RejectionDataOriginal, RejectionReasonEnum as RejectionReasonEnumOriginal, type RejectionReasonEnumWithLiterals as RejectionReasonEnumWithLiteralsOriginal, type RescheduleRequest as RescheduleRequestOriginal, type RescheduleResponse as RescheduleResponseOriginal, type ResendToNonOpenersRequest as ResendToNonOpenersRequestOriginal, type ResendToNonOpenersResponse as ResendToNonOpenersResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ReuseCampaignRequest as ReuseCampaignRequestOriginal, type ReuseCampaignResponse as ReuseCampaignResponseOriginal, type Scheduled as ScheduledOriginal, type SearchContactsRequest as SearchContactsRequestOriginal, type SearchContactsResponse as SearchContactsResponseOriginal, type SendTestBulkRequest as SendTestBulkRequestOriginal, type SendTestBulkResponse as SendTestBulkResponseOriginal, type SendTestRequest as SendTestRequestOriginal, type SendTestResponse as SendTestResponseOriginal, type SoftBounce as SoftBounceOriginal, type SubscribeFromLandingPageRequest as SubscribeFromLandingPageRequestOriginal, type SubscribeFromLandingPageResponse as SubscribeFromLandingPageResponseOriginal, type Terminated as TerminatedOriginal, type TotalStatistics as TotalStatisticsOriginal, type UnarchiveCampaignRequest as UnarchiveCampaignRequestOriginal, type UnarchiveCampaignResponse as UnarchiveCampaignResponseOriginal, type Unarchived as UnarchivedOriginal, type UpdateComposerRequest as UpdateComposerRequestOriginal, type UpdateComposerResponse as UpdateComposerResponseOriginal, type UpdateTitleRequest as UpdateTitleRequestOriginal, type UpdateTitleResponse as UpdateTitleResponseOriginal, type UpsertAutomationTranslatorContentRequest as UpsertAutomationTranslatorContentRequestOriginal, type UpsertAutomationTranslatorContentResponse as UpsertAutomationTranslatorContentResponseOriginal, type UpsertTranslationRequest as UpsertTranslationRequestOriginal, type UpsertTranslationResponse as UpsertTranslationResponseOriginal, type ValidateHtmlLinksRequest as ValidateHtmlLinksRequestOriginal, type ValidateHtmlLinksResponse as ValidateHtmlLinksResponseOriginal, type ValidateLinkRequest as ValidateLinkRequestOriginal, type ValidateLinkResponse as ValidateLinkResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type _Array as _ArrayOriginal, type __PublicMethodMetaInfo, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };