@wix/auto_sdk_email-marketing_campaigns 1.0.80 → 1.0.82

package/build/es/index.typings.d.mts

@@ -213,23 +213,361 @@ declare enum CampaignTypeEnum {
 }
 /** @enumType */
 type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
-interface GetPlaceholderKeysRequest {
+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 ListStatisticsRequest {
+    /**
+     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    campaignIds: string[];
+}
+interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
+}
+interface CampaignStatisticsContainer {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
+}
+interface ListRecipientsRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /** Email activity to filter. */
+    activity: RecipientsActivityEnumWithLiterals;
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+declare enum RecipientsActivityEnum {
+    UNKNOWN = "UNKNOWN",
+    DELIVERED = "DELIVERED",
+    OPENED = "OPENED",
+    CLICKED = "CLICKED",
+    BOUNCED = "BOUNCED",
+    NOT_SENT = "NOT_SENT",
+    SENT = "SENT",
+    NOT_OPENED = "NOT_OPENED"
+}
+/** @enumType */
+type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 1000
+     */
+    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.
+     * @maxLength 1000
+     */
+    cursor?: string | null;
+}
+interface ListRecipientsResponse {
+    /** List of recipients. */
+    recipients?: CampaignRecipientDetails[];
+    /** Details on the paged set of returned results. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface CampaignRecipientDetails {
     /**
-     * Campaign ID.
+     * Contact ID.
      * @format GUID
      */
-    campaignId?: string;
-}
-interface GetPlaceholderKeysResponse {
-    /** Keys of placeholders used in the campaign. */
-    placeholderKeys?: string[];
+    contactId?: string;
+    /** Date and time of the last activity. */
+    lastActivityDate?: Date | null;
+    /**
+     * Primary email address of the contact.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+    /**
+     * Full name of the contact (optional).
+     * @maxLength 100
+     */
+    fullName?: string | null;
+    /** Is this contact currently deleted from the site or not. */
+    contactDeleted?: boolean;
 }
-interface GetDefaultComponentsRequest {
+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;
 }
-interface GetDefaultComponentsResponse {
-    footer?: Record<string, any> | null;
-    logo?: Record<string, any> | null;
-    follow?: Record<string, any> | null;
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
 }
 interface GetCampaignRequest {
     /**
@@ -532,86 +870,6 @@ interface SendTestRequest {
      */
     toEmailAddress: string;
 }
-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 SendTestResponse {
 }
 interface PauseSchedulingRequest {
@@ -755,19 +1013,6 @@ interface GetComposerResponse {
      */
     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 UpdateComposerRequest {
     /**
      * Campaign ID.
@@ -979,213 +1224,86 @@ interface IdentificationData extends IdentificationDataIdOneOf {
      * 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 AccountInfo {
-    /**
-     * ID of the Wix account associated with the event.
-     * @format GUID
-     */
-    accountId?: string | null;
-    /**
-     * ID of the parent Wix account. Only included when accountId belongs to a child account.
-     * @format GUID
-     */
-    parentAccountId?: string | null;
-    /**
-     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
-     * @format GUID
-     */
-    siteId?: string | null;
-}
-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;
+    memberId?: string;
     /**
-     * Id of a campaign that is to be resent.
+     * ID of a Wix user (site owner, contributor, etc.).
      * @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 {
+    wixUserId?: string;
     /**
-     * Email address of the contact.
-     * @format EMAIL
+     * ID of an app.
+     * @format GUID
      */
-    emailAddress?: string;
-}
-interface ReconcileContactResponse {
-    /** Created or retrieved contact. */
-    contact?: Contact;
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
 }
-interface Contact {
+/** @oneof */
+interface IdentificationDataIdOneOf {
     /**
-     * Unique ID of the contact entity.
+     * ID of a site visitor that has not logged in to the site.
      * @format GUID
      */
-    _id?: string;
+    anonymousVisitorId?: string;
     /**
-     * Primary email address of the contact.
-     * @format EMAIL
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    emailAddress?: string;
+    memberId?: string;
     /**
-     * Full name of the contact (optional).
-     * @maxLength 100
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    fullName?: string | null;
+    wixUserId?: string;
     /**
-     * Profile picture of the contact (optional).
-     * @format WEB_URL
-     * @maxLength 2048
+     * ID of an app.
+     * @format GUID
      */
-    pictureUrl?: string | null;
+    appId?: string;
 }
-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;
+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 AccountInfo {
     /**
-     * Page size (default 50, max 1000).
-     * @max 1000
+     * ID of the Wix account associated with the event.
+     * @format GUID
      */
-    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 {
+    accountId?: string | null;
     /**
-     * Unique ID of the label entity.
-     * @maxLength 100
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
      */
-    _id?: string;
+    parentAccountId?: string | null;
     /**
-     * Name of the label.
-     * @maxLength 100
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
      */
-    name?: string;
-    /** Amount of contacts assigned to the label. */
-    contactsCount?: number;
+    siteId?: string | null;
 }
-interface SubscribeFromLandingPageRequest {
+interface GetPlaceholderKeysRequest {
     /**
-     * Campaign ID that the subscription is happening from.
+     * Campaign ID.
      * @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;
+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 {
     /**
@@ -1209,268 +1327,150 @@ interface ValidateHtmlLinksResponse {
     /** Non-valid links. */
     blacklistedLinks?: string[];
 }
-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;
+interface EstimateFilterSizeRequest {
+    /** Contacts filter expression. */
+    filter?: Record<string, any> | null;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
     /**
-     * Campaign preheader (optional).
-     * @maxLength 1000
+     * Contacts plain text search expression (searches in name, phone and email fields).
+     * @minLength 1
+     * @maxLength 100
      */
-    emailPreheader?: string | null;
+    search?: string | null;
 }
-interface UpsertTranslationResponse {
+interface EstimateFilterSizeResponse {
+    /** Mailing list size estimation. */
+    estimation?: number;
 }
-interface GetUsedPlaceholderKeysRequest {
+interface EstimateAudienceSizeRequest {
     /**
-     * Campaign ID.
+     * Contact IDs of a campaign audience.
      * @format GUID
      */
-    campaignId?: string;
-}
-interface GetUsedPlaceholderKeysResponse {
-    /**
-     * Keys of placeholders used in the automation.
-     * @maxLength 200
-     * @maxSize 300
-     */
-    placeholderKeys?: string[];
-}
-interface LookupCampaignMappingRequest {
+    contactIds?: string[];
+    /** Label IDs of a campaign audience. */
+    labelIds?: string[];
+    /** Contacts filter expression (json). */
+    contactsFilter?: Record<string, any> | null;
     /**
-     * rule ID in automations
-     * @format GUID
+     * Contacts plain text search expression (searches in name, phone and email fields).
+     * @minLength 1
+     * @maxLength 100
      */
-    automationRuleId?: string;
+    search?: string | null;
     /**
-     * template ID configured for the automation
+     * Segment ids of a campaign audience.
      * @format GUID
      */
-    templateId?: string;
-}
-interface LookupCampaignMappingResponse {
-    /** @format GUID */
-    campaignId?: string | null;
-}
-interface UpsertAutomationTranslatorContentRequest {
+    segmentIds?: string[];
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
     /**
-     * Campaign ID that the content belongs to
+     * Id of a campaign that is to be resent.
      * @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;
+    resendCampaignId?: string | null;
+    /** Should total number of contacts in provided audience be returned or not (default value "false"). */
+    withTotal?: boolean;
 }
-interface UpsertAutomationTranslatorContentResponse {
+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 GetAutomationTranslatorContentRequest {
+interface ReconcileContactRequest {
     /**
-     * Campaign ID
-     * @format GUID
+     * Email address of the contact.
+     * @format EMAIL
      */
-    campaignId?: string;
+    emailAddress?: string;
 }
-interface GetAutomationTranslatorContentResponse {
-    /** Automation translator content */
-    automationTranslatorContent?: AutomationTranslatorContent;
+interface ReconcileContactResponse {
+    /** Created or retrieved contact. */
+    contact?: Contact;
 }
-interface SendTestBulkRequest {
+interface Contact {
     /**
-     * Campaign ID
+     * Unique ID of the contact entity.
      * @format GUID
      */
-    campaignId?: string;
+    _id?: string;
     /**
-     * Recipient email address
+     * Primary email address of the contact.
      * @format EMAIL
      */
-    toEmailAddress?: string;
-    /** Values to replace campaign placeholders with (unique for each campaign) */
-    placeholders?: Record<string, PlaceholderContent>;
+    emailAddress?: string;
     /**
-     * Sender from name
+     * Full name of the contact (optional).
      * @maxLength 100
      */
-    fromName?: string | null;
-    /**
-     * Reply-to email address
-     * @format EMAIL
-     */
-    replyToEmailAddress?: string | null;
+    fullName?: string | null;
     /**
-     * Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
-     * @format LANGUAGE
+     * Profile picture of the contact (optional).
+     * @format WEB_URL
+     * @maxLength 2048
      */
-    language?: string | null;
-}
-interface SendTestBulkResponse {
+    pictureUrl?: string | null;
 }
-interface ListStatisticsRequest {
+interface SearchContactsRequest {
     /**
-     * IDs of the campaigns to retrieve (max 100 campaigns).
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
+     * Text to search contacts by - can search by name or email address.
+     * @maxLength 100
      */
-    campaignIds: string[];
-}
-interface ListStatisticsResponse {
-    /** List of statistics. */
-    statistics?: CampaignStatisticsContainer[];
-}
-interface CampaignStatisticsContainer {
+    searchTerm?: string;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
     /**
-     * Campaign ID.
-     * @format GUID
+     * Page size (default 50, max 1000).
+     * @max 1000
      */
-    campaignId?: string;
-    /** Landing page statistics. */
-    landingPage?: LandingPageStatistics;
-    /** Email campaign statistics. */
-    email?: DistributionStatistics;
+    pageSize?: number | null;
 }
-interface ListRecipientsRequest {
-    /**
-     * Campaign ID.
-     * @format GUID
-     */
-    campaignId: string;
-    /** Email activity to filter. */
-    activity: RecipientsActivityEnumWithLiterals;
-    /** Pagination options. */
-    paging?: CursorPaging;
+interface SearchContactsResponse {
+    /** Search results. */
+    contacts?: Contact[];
 }
-declare enum RecipientsActivityEnum {
-    UNKNOWN = "UNKNOWN",
-    DELIVERED = "DELIVERED",
-    OPENED = "OPENED",
-    CLICKED = "CLICKED",
-    BOUNCED = "BOUNCED",
-    NOT_SENT = "NOT_SENT",
-    SENT = "SENT",
-    NOT_OPENED = "NOT_OPENED"
+interface GetLabelsRequest {
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
 }
-/** @enumType */
-type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
-interface CursorPaging {
+interface GetLabelsResponse {
+    /** Returned labels with contact counts. */
+    labels?: Label[];
+}
+interface Label {
     /**
-     * Number of items to load.
-     * @max 1000
+     * Unique ID of the label entity.
+     * @maxLength 100
      */
-    limit?: number | null;
+    _id?: string;
     /**
-     * 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.
-     * @maxLength 1000
+     * Name of the label.
+     * @maxLength 100
      */
-    cursor?: string | null;
-}
-interface ListRecipientsResponse {
-    /** List of recipients. */
-    recipients?: CampaignRecipientDetails[];
-    /** Details on the paged set of returned results. */
-    pagingMetadata?: PagingMetadataV2;
+    name?: string;
+    /** Amount of contacts assigned to the label. */
+    contactsCount?: number;
 }
-interface CampaignRecipientDetails {
+interface SubscribeFromLandingPageRequest {
     /**
-     * Contact ID.
+     * Campaign ID that the subscription is happening from.
      * @format GUID
      */
-    contactId?: string;
-    /** Date and time of the last activity. */
-    lastActivityDate?: Date | null;
+    campaignId?: string;
     /**
-     * Primary email address of the contact.
+     * Email address that is entered into subscription field.
      * @format EMAIL
      */
     emailAddress?: string;
-    /**
-     * Full name of the contact (optional).
-     * @maxLength 100
-     */
-    fullName?: string | null;
-    /** Is this contact currently deleted from the site or not. */
-    contactDeleted?: boolean;
-}
-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;
+    /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
+    consent?: boolean;
 }
-interface Cursors {
-    /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
-     */
-    next?: string | null;
-    /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
-     */
-    prev?: string | null;
+interface SubscribeFromLandingPageResponse {
+    /** @format GUID */
+    contactId?: string;
 }
 /** @docsIgnore */
 type PublishCampaignApplicationErrors = {
@@ -1747,6 +1747,46 @@ interface CampaignEmailActivityUpdatedEnvelope {
  * @slug email_activity_updated
  */
 declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * 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.
+ *
+ * Call List Campaigns to retrieve additional information for a site's campaigns.
+ * Call List Recipients 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
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
+ */
+declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
+/**
+ * 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.
+ *
+ * Call List Statistics to retrieve a list of activity for selected campaigns.
+ * Call List Campaigns to retrieve additional information for your campaigns.
+ *
+ * If no `activity` is included, this method returns an error.
+ * @param campaignId - Campaign ID.
+ * @param activity - Email activity to filter.
+ * @public
+ * @requiredField activity
+ * @requiredField campaignId
+ * @param options - Options to use when getting the list of recipients.
+ * @permissionId Shoutout.Read
+ * @applicableIdentity APP
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
+ */
+declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
+interface ListRecipientsOptions {
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
 /**
  * Retrieves information about an email campaign.
  * @param campaignId - Campaign ID.
@@ -1921,45 +1961,5 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
  */
 declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
-/**
- * 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.
- *
- * Call List Campaigns to retrieve additional information for a site's campaigns.
- * Call List Recipients 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
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
- */
-declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
-/**
- * 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.
- *
- * Call List Statistics to retrieve a list of activity for selected campaigns.
- * Call List Campaigns to retrieve additional information for your campaigns.
- *
- * If no `activity` is included, this method returns an error.
- * @param campaignId - Campaign ID.
- * @param activity - Email activity to filter.
- * @public
- * @requiredField activity
- * @requiredField campaignId
- * @param options - Options to use when getting the list of recipients.
- * @permissionId Shoutout.Read
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
- */
-declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
-interface ListRecipientsOptions {
-    /** Pagination options. */
-    paging?: CursorPaging;
-}
 
 export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActivityType, type ActivityTypeWithLiterals, type ArchiveCampaignRequest, type ArchiveCampaignResponse, type Archived, type Attachment, type AutomationTranslatorContent, type BaseEventMetadata, type Campaign, type CampaignAudience, type CampaignCreatedEnvelope, type CampaignDeletedEnvelope, type CampaignDistributedEnvelope, type CampaignEditorType, CampaignEditorTypeEnum, type CampaignEditorTypeEnumWithLiterals, type CampaignEmailActivityUpdatedEnvelope, type CampaignPausedEnvelope, type CampaignPublishedEnvelope, type CampaignRecipientDetails, type CampaignRejectedEnvelope, type CampaignScheduledEnvelope, CampaignSendingStateEnum, type CampaignSendingStateEnumWithLiterals, type CampaignStatistics, type CampaignStatisticsContainer, CampaignStatusEnum, type CampaignStatusEnumWithLiterals, type CampaignTerminatedEnvelope, CampaignTypeEnum, type CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, type CampaignVisibilityStatusEnumWithLiterals, type Click, type Composer, type Contact, type CountCampaignsRequest, type CountCampaignsResponse, type CreateCampaignRequest, type CreateCampaignResponse, type CreateFromTemplateRequest, type CreateFromTemplateResponse, type CreateFromUserTemplateRequest, type CreateFromUserTemplateResponse, type CreateUserTemplateRequest, type CreateUserTemplateResponse, type CursorPaging, type Cursors, type DateTime, type Decimal, type DefaultValues, type DeleteCampaignRequest, type DeleteCampaignResponse, type Distributed, type DistributionStatistics, type DomainEvent, type DomainEventBodyOneOf, type EmailActivityUpdated, type EmailActivityUpdatedEventTypeOneOf, type EmailDistributionOptions, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EstimateAudienceSizeRequest, type EstimateAudienceSizeResponse, type EstimateFilterSizeRequest, type EstimateFilterSizeResponse, type EventMetadata, type GetAudienceRequest, type GetAudienceResponse, type GetAutomationTranslatorContentRequest, type GetAutomationTranslatorContentResponse, type GetCampaignMappingRequest, type GetCampaignMappingResponse, type GetCampaignOptions, type GetCampaignRequest, type GetCampaignResponse, type GetComposerRequest, type GetComposerResponse, type GetDefaultComponentsRequest, type GetDefaultComponentsResponse, type GetLabelsRequest, type GetLabelsResponse, type GetPlaceholderKeysRequest, type GetPlaceholderKeysResponse, type GetUsedPlaceholderKeysRequest, type GetUsedPlaceholderKeysResponse, type HardBounce, type Html, type IdentificationData, type IdentificationDataIdOneOf, type IdentifySenderAddressRequest, type IdentifySenderAddressResponse, type Integer, type Label, type LandingPageStatistics, type ListCampaignsOptions, type ListCampaignsRequest, type ListCampaignsResponse, type ListRecipientsOptions, type ListRecipientsRequest, type ListRecipientsResponse, type ListStatisticsRequest, type ListStatisticsResponse, type LookupCampaignMappingRequest, type LookupCampaignMappingResponse, type Map, type MessageEnvelope, type Money, type Open, type Paging, type PagingMetadataV2, type PauseSchedulingRequest, type PauseSchedulingResponse, type Paused, type PlaceholderContent, type PlaceholderContentEnum, type PlaceholderContentValueOneOf, type PlainText, type PreviewCampaignRequest, type PreviewCampaignResponse, type PublishCampaignApplicationErrors, type PublishCampaignOptions, type PublishCampaignRequest, type PublishCampaignResponse, type Published, type PublishingData, RecipientsActivityEnum, type RecipientsActivityEnumWithLiterals, type ReconcileContactRequest, type ReconcileContactResponse, type Rejected, type RejectionData, RejectionReasonEnum, type RejectionReasonEnumWithLiterals, type RescheduleRequest, type RescheduleResponse, type ResendToNonOpenersRequest, type ResendToNonOpenersResponse, type RestoreInfo, type ReuseCampaignRequest, type ReuseCampaignResponse, type Scheduled, type SearchContactsRequest, type SearchContactsResponse, type SendTestBulkRequest, type SendTestBulkResponse, type SendTestOptions, type SendTestRequest, type SendTestResponse, type SoftBounce, type SubscribeFromLandingPageRequest, type SubscribeFromLandingPageResponse, type Terminated, type TotalStatistics, type UnarchiveCampaignRequest, type UnarchiveCampaignResponse, type Unarchived, type UpdateComposerRequest, type UpdateComposerResponse, type UpdateTitleRequest, type UpdateTitleResponse, type UpsertAutomationTranslatorContentRequest, type UpsertAutomationTranslatorContentResponse, type UpsertTranslationRequest, type UpsertTranslationResponse, type ValidateHtmlLinksRequest, type ValidateHtmlLinksResponse, type ValidateLinkRequest, type ValidateLinkResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };