@wix/auto_sdk_email-marketing_campaigns 1.0.4 → 1.0.6

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

@@ -1,14 +1,21 @@
 export interface Campaign {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     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. */
+    /**
+     * URL of the first image after the logo.
+     * @format WEB_URL
+     */
     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.
+     * @format WEB_URL
      * @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.
@@ -59,6 +66,7 @@ export interface Campaign {
     /**
      * Email subject of the campaign (initially copied from the template).
      * TODO: Deprecated (moved to "GetComposerResponse").
+     * @maxLength 1000
      * @deprecated
      */
     emailSubject?: string;
@@ -118,7 +126,10 @@ export declare enum Enum {
     PAUSED = "PAUSED"
 }
 export interface PublishingData {
-    /** Landing page URL. */
+    /**
+     * Landing page URL.
+     * @format WEB_URL
+     */
     landingPageUrl?: string;
     /** Marketing campaign statistics. */
     statistics?: CampaignStatistics;
@@ -224,12 +235,187 @@ export declare enum CampaignTypeEnum {
     /** triggered email */
     TRIGGERED = "TRIGGERED"
 }
+export interface ValidateLinkRequest {
+    /**
+     * URL to validate.
+     * @minLength 1
+     */
+    url: string;
+}
+export interface ValidateLinkResponse {
+    /** Whether the link is valid. */
+    valid?: boolean;
+}
+export interface ValidateHtmlLinksRequest {
+    /**
+     * HTML string with links.
+     * @maxLength 1000000
+     */
+    html: string;
+}
+export interface ValidateHtmlLinksResponse {
+    /** Non-valid links. */
+    blacklistedLinks?: string[];
+}
+export interface GetCampaignMappingRequest {
+    /**
+     * rule ID in automations
+     * @format GUID
+     */
+    automationRuleId?: string;
+    /**
+     * template ID configured for the automation
+     * @format GUID
+     */
+    templateId?: string;
+}
+export interface GetCampaignMappingResponse {
+    /** @format GUID */
+    campaignId?: string;
+}
+export 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;
+}
+export interface Composer {
+    /**
+     * Internal data structure for editor/viewer to render the campaign.
+     * @maxLength 10000000
+     */
+    composerDataJson?: string;
+    /** Default values of existing placeholders. */
+    defaultValues?: DefaultValues;
+}
+export interface DefaultValues {
+    /** @maxSize 500 */
+    map?: Record<string, string>;
+}
+export interface UpsertTranslationResponse {
+}
+export interface GetUsedPlaceholderKeysRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+}
+export interface GetUsedPlaceholderKeysResponse {
+    /**
+     * Keys of placeholders used in the automation.
+     * @maxLength 200
+     * @maxSize 300
+     */
+    placeholderKeys?: string[];
+}
+export interface LookupCampaignMappingRequest {
+    /**
+     * rule ID in automations
+     * @format GUID
+     */
+    automationRuleId?: string;
+    /**
+     * template ID configured for the automation
+     * @format GUID
+     */
+    templateId?: string;
+}
+export interface LookupCampaignMappingResponse {
+    /** @format GUID */
+    campaignId?: string | null;
+}
+export interface UpsertAutomationTranslatorContentRequest {
+    /**
+     * Campaign ID that the content belongs to
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Automation translator content */
+    automationTranslatorContent?: AutomationTranslatorContent;
+}
+/** Automation Translator Content */
+export 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;
+}
+export interface UpsertAutomationTranslatorContentResponse {
+}
+export interface GetAutomationTranslatorContentRequest {
+    /**
+     * Campaign ID
+     * @format GUID
+     */
+    campaignId?: string;
+}
+export interface GetAutomationTranslatorContentResponse {
+    /** Automation translator content */
+    automationTranslatorContent?: AutomationTranslatorContent;
+}
+export interface GetPlaceholderKeysRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    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 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). */
+    /**
+     * Contacts plain text search expression (searches in name, phone and email fields).
+     * @minLength 1
+     * @maxLength 100
+     */
     search?: string | null;
 }
 export interface EstimateFilterSizeResponse {
@@ -237,19 +423,32 @@ export interface EstimateFilterSizeResponse {
     estimation?: number;
 }
 export interface EstimateAudienceSizeRequest {
-    /** Contact IDs of a campaign audience. */
+    /**
+     * 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). */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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;
@@ -261,7 +460,10 @@ export interface EstimateAudienceSizeResponse {
     total?: number | null;
 }
 export interface ReconcileContactRequest {
-    /** Email address of the contact. */
+    /**
+     * Email address of the contact.
+     * @format EMAIL
+     */
     emailAddress?: string;
 }
 export interface ReconcileContactResponse {
@@ -269,21 +471,40 @@ export interface ReconcileContactResponse {
     contact?: Contact;
 }
 export interface Contact {
-    /** Unique ID of the contact entity. */
+    /**
+     * Unique ID of the contact entity.
+     * @format GUID
+     */
     _id?: string;
-    /** Primary email address of the contact. */
+    /**
+     * Primary email address of the contact.
+     * @format EMAIL
+     */
     emailAddress?: string;
-    /** Full name of the contact (optional). */
+    /**
+     * Full name of the contact (optional).
+     * @maxLength 100
+     */
     fullName?: string | null;
-    /** Profile picture of the contact (optional). */
+    /**
+     * Profile picture of the contact (optional).
+     * @format WEB_URL
+     * @maxLength 2048
+     */
     pictureUrl?: string | null;
 }
 export interface SearchContactsRequest {
-    /** Text to search contacts by - can search by name or email address. */
+    /**
+     * 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). */
+    /**
+     * Page size (default 50, max 1000).
+     * @max 1000
+     */
     pageSize?: number | null;
 }
 export interface SearchContactsResponse {
@@ -299,253 +520,42 @@ export interface GetLabelsResponse {
     labels?: Label[];
 }
 export interface Label {
-    /** Unique ID of the label entity. */
+    /**
+     * Unique ID of the label entity.
+     * @maxLength 100
+     */
     _id?: string;
-    /** Name of the label. */
+    /**
+     * Name of the label.
+     * @maxLength 100
+     */
     name?: string;
     /** Amount of contacts assigned to the label. */
     contactsCount?: number;
 }
 export interface SubscribeFromLandingPageRequest {
-    /** Campaign ID that the subscription is happening from. */
+    /**
+     * Campaign ID that the subscription is happening from.
+     * @format GUID
+     */
     campaignId?: string;
-    /** Email address that is entered into subscription field. */
+    /**
+     * 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;
 }
 export interface SubscribeFromLandingPageResponse {
+    /** @format GUID */
     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;
+export interface GetCampaignRequest {
     /**
-     * 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.
+     * Campaign ID.
+     * @format GUID
      */
-    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 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`.
@@ -611,7 +621,10 @@ export interface CountCampaignsResponse {
     archived?: number;
 }
 export interface CreateFromTemplateRequest {
-    /** ID of the template to fork. */
+    /**
+     * ID of the template to fork.
+     * @format GUID
+     */
     templateId?: string;
     /** Values to replace template placeholders with (unique for each template). */
     variables?: Record<string, string>;
@@ -623,9 +636,15 @@ export interface CreateFromTemplateResponse {
     campaign?: Campaign;
 }
 export interface CreateUserTemplateRequest {
-    /** ID of campaign to create template from. */
+    /**
+     * ID of campaign to create template from.
+     * @format GUID
+     */
     campaignId?: string;
-    /** Title of template. */
+    /**
+     * Title of template.
+     * @maxLength 1000
+     */
     title?: string | null;
 }
 export interface CreateUserTemplateResponse {
@@ -633,7 +652,10 @@ export interface CreateUserTemplateResponse {
     campaign?: Campaign;
 }
 export interface CreateFromUserTemplateRequest {
-    /** ID of the user template campaign to use. */
+    /**
+     * ID of the user template campaign to use.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface CreateFromUserTemplateResponse {
@@ -641,20 +663,30 @@ export interface CreateFromUserTemplateResponse {
     campaign?: Campaign;
 }
 export interface PublishCampaignRequest {
-    /** Campaign ID */
+    /**
+     * Campaign ID
+     * @format GUID
+     */
     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. */
+    /**
+     * The subject line for the email campaign, which appears in recipients’ inboxes.
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
     /** Contact label IDs. */
     labelIds?: string[];
-    /** IDs of contacts to whom to send out the campaign. */
+    /**
+     * IDs of contacts to whom to send out the campaign.
+     * @format GUID
+     */
     contactIds?: string[];
     /**
      * Filter ids to send campaign to (unsupported).
+     * @format GUID
      * @deprecated Filter ids to send campaign to (unsupported).
      * @replacedBy contacts_filter
      * @targetRemovalDate 2023-10-10
@@ -668,23 +700,39 @@ export interface PublishCampaignResponse {
     publishingData?: PublishingData;
 }
 export interface Rejected {
-    /** ID of the campaign that was rejected. */
+    /**
+     * ID of the campaign that was rejected.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface Published {
-    /** ID of the campaign that was published. */
+    /**
+     * ID of the campaign that was published.
+     * @format GUID
+     */
     campaignId?: string;
-    /** Campaign landing page URL. */
+    /**
+     * Campaign landing page URL.
+     * @format WEB_URL
+     * @maxLength 2048
+     */
     landingPageUrl?: string;
     /** Estimation of recipient list size (optional). */
     mailingListSizeEstimate?: number | null;
 }
 export interface Terminated {
-    /** ID of the campaign that was terminated. */
+    /**
+     * ID of the campaign that was terminated.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface Distributed {
-    /** ID of the campaign that was distributed. */
+    /**
+     * ID of the campaign that was distributed.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf {
@@ -705,16 +753,28 @@ export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf
      * Indicates a permanent error sending your email. For example, the email address does not exist.
      */
     hardBounce?: HardBounce;
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId?: string;
-    /** [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient. */
+    /**
+     * [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. */
+    /**
+     * Email address of a recipient.
+     * @format EMAIL
+     */
     recipientEmailAddress?: string;
     /** Date and time of the event. */
     timestamp?: Date | null;
     activityType?: ActivityType;
-    /** email metadata */
+    /**
+     * email metadata
+     * @maxSize 20
+     */
     metadata?: Record<string, string>;
 }
 /** @oneof */
@@ -769,7 +829,10 @@ export interface HardBounce {
     reason?: string;
 }
 export interface Scheduled {
-    /** ID of the campaign that was scheduled. */
+    /**
+     * ID of the campaign that was scheduled.
+     * @format GUID
+     */
     campaignId?: string;
     /** The timestamp campaign is scheduled for. */
     sendAt?: Date | null;
@@ -777,11 +840,20 @@ export interface Scheduled {
     rescheduled?: boolean;
 }
 export interface SendTestRequest {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId: string;
-    /** Email subject. */
+    /**
+     * Email subject.
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
-    /** Recipient email address. */
+    /**
+     * Recipient email address.
+     * @format EMAIL
+     */
     toEmailAddress: string;
 }
 export interface PlaceholderContent extends PlaceholderContentValueOneOf {
@@ -820,9 +892,15 @@ export interface Html {
  * 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. */
+    /**
+     * 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). */
+    /**
+     * 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;
@@ -854,23 +932,33 @@ 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)
+     * @format DECIMAL_VALUE
      */
     value?: string;
 }
 export interface SendTestResponse {
 }
 export interface PauseSchedulingRequest {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId: string;
 }
 export interface PauseSchedulingResponse {
 }
 export interface Paused {
-    /** ID of the campaign that was paused. */
+    /**
+     * ID of the campaign that was paused.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface RescheduleRequest {
-    /** ID of the campaign to reschedule. */
+    /**
+     * ID of the campaign to reschedule.
+     * @format GUID
+     */
     campaignId: string;
     /** New time for sending out the campaign. */
     sendAt: Date | null;
@@ -878,43 +966,67 @@ export interface RescheduleRequest {
 export interface RescheduleResponse {
 }
 export interface ArchiveCampaignRequest {
-    /** ID of the campaign to archive. */
+    /**
+     * ID of the campaign to archive.
+     * @format GUID
+     */
     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. */
+    /**
+     * ID of the campaign that was archived.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface UnarchiveCampaignRequest {
-    /** ID of the campaign to unarchive. */
+    /**
+     * ID of the campaign to unarchive.
+     * @format GUID
+     */
     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. */
+    /**
+     * ID of the campaign whose status was changed to active.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface UpdateTitleRequest {
-    /** ID of the campaign to change title of. */
+    /**
+     * ID of the campaign to change title of.
+     * @format GUID
+     */
     campaignId?: string;
-    /** New title to set. */
+    /**
+     * New title to set.
+     * @maxLength 1000
+     */
     title?: string;
 }
 export interface UpdateTitleResponse {
 }
 export interface DeleteCampaignRequest {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId: string;
 }
 export interface DeleteCampaignResponse {
 }
 export interface ReuseCampaignRequest {
-    /** ID of the message to be duplicated. */
+    /**
+     * ID of the message to be duplicated.
+     * @format GUID
+     */
     campaignId: string;
 }
 export interface ReuseCampaignResponse {
@@ -922,9 +1034,15 @@ export interface ReuseCampaignResponse {
     campaign?: Campaign;
 }
 export interface PreviewCampaignRequest {
-    /** ID of the campaign to preview. */
+    /**
+     * ID of the campaign to preview.
+     * @format GUID
+     */
     campaignId?: string;
-    /** Preferred language for campaign content (optional). */
+    /**
+     * 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>;
@@ -936,29 +1054,50 @@ export interface PreviewCampaignResponse {
     html?: string;
 }
 export interface GetComposerRequest {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId?: string;
-    /** Preferred language for campaign content (optional). */
+    /**
+     * Preferred language for campaign content (optional).
+     * @format LANGUAGE
+     */
     language?: string | null;
 }
 export interface GetComposerResponse {
     /** Composer. */
     composer?: Composer;
-    /** Campaign subject. */
+    /**
+     * Campaign subject.
+     * @maxLength 1000
+     */
     emailSubject?: string;
-    /** Campaign preheader (optional). */
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
     emailPreheader?: string | null;
 }
 export interface UpdateComposerRequest {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId?: string;
     /** Campaign composer. */
     composer?: Composer;
     /** Campaign editor type (optional, default "WEB"). */
     campaignEditorType?: CampaignEditorType;
-    /** Campaign subject (optional). */
+    /**
+     * Campaign subject (optional).
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
-    /** Campaign preheader (optional). */
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
     emailPreheader?: string | null;
 }
 /** specifies if campaign is being created and edited in web or mobile app */
@@ -972,9 +1111,15 @@ export interface CreateCampaignRequest {
     composer?: Composer;
     /** Campaign editor type (optional, default "WEB"). */
     campaignEditorType?: CampaignEditorType;
-    /** Campaign subject (optional). */
+    /**
+     * Campaign subject (optional).
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
-    /** Campaign preheader (optional). */
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
     emailPreheader?: string | null;
 }
 export interface CreateCampaignResponse {
@@ -982,17 +1127,29 @@ export interface CreateCampaignResponse {
     campaign?: Campaign;
 }
 export interface ResendToNonOpenersRequest {
-    /** ID of the campaign to resend. */
+    /**
+     * ID of the campaign to resend.
+     * @format GUID
+     */
     campaignId?: string;
-    /** Subject line to use with the resent copy of campaign. */
+    /**
+     * Subject line to use with the resent copy of campaign.
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
 }
 export interface ResendToNonOpenersResponse {
-    /** ID of the newly created and resent campaign. */
+    /**
+     * ID of the newly created and resent campaign.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface GetAudienceRequest {
-    /** Campaign ID. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId: string;
 }
 export interface GetAudienceResponse {
@@ -1000,25 +1157,51 @@ export interface GetAudienceResponse {
     audience?: CampaignAudience;
 }
 export interface CampaignAudience {
-    /** IDs of contacts to whom to send the campaign. */
+    /**
+     * IDs of contacts to whom to send the campaign.
+     * @format GUID
+     * @maxSize 100
+     */
     contactIds?: string[];
-    /** Labels IDs. */
+    /**
+     * Labels IDs.
+     * @maxLength 100
+     * @maxSize 20
+     */
     labelIds?: string[];
-    /** Segment IDs. */
+    /**
+     * Segment IDs.
+     * @format GUID
+     * @maxSize 20
+     */
     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). */
+    /**
+     * Contacts plain text search expression (searches in name, phone and email fields).
+     * @minLength 1
+     * @maxLength 100
+     */
     contactsSearchTerm?: string | null;
     /** Should "inactive" contacts be excluded or not. */
     activeContactsOnly?: boolean;
 }
 export interface IdentifySenderAddressRequest {
-    /** Email address to verify. */
+    /**
+     * Email address to verify.
+     * @format EMAIL
+     * @minLength 6
+     * @maxLength 254
+     */
     emailAddress: string;
 }
 export interface IdentifySenderAddressResponse {
-    /** Actual "from" address that will be used for sending emails. */
+    /**
+     * Actual "from" address that will be used for sending emails.
+     * @format EMAIL
+     * @minLength 6
+     * @maxLength 254
+     */
     senderAddress?: string;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -1037,99 +1220,247 @@ export interface DomainEvent extends DomainEventBodyOneOf {
      */
     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
+     * 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.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    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.
+     * @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?: WebhookIdentityType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface ListStatisticsRequest {
+    /**
+     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    campaignIds: string[];
+}
+export interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
+}
+export interface CampaignStatisticsContainer {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
+}
+export interface ListRecipientsRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    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.
+     * @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.
+     */
+    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.
+     * @format GUID
      */
-    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;
+    contactId?: string;
+    /** Date and time of the last activity. */
+    lastActivityDate?: Date | null;
     /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
+     * Primary email address of the contact.
+     * @format EMAIL
      */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
+    emailAddress?: string;
     /**
-     * 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.
+     * Full name of the contact (optional).
+     * @maxLength 100
      */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entity?: string;
+    fullName?: string | null;
+    /** Is this contact currently deleted from the site or not. */
+    contactDeleted?: boolean;
 }
-export interface RestoreInfo {
-    deletedDate?: Date | null;
+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 EntityUpdatedEvent {
+export interface Cursors {
     /**
-     * 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.
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
      */
-    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"
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
 }
 export interface ValidateLinkResponseNonNullableFields {
     valid: boolean;
@@ -1149,22 +1480,6 @@ interface DistributionStatisticsNonNullableFields {
     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;
@@ -1219,10 +1534,32 @@ export interface GetAudienceResponseNonNullableFields {
 export interface IdentifySenderAddressResponseNonNullableFields {
     senderAddress: string;
 }
+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[];
+}
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1273,6 +1610,8 @@ export interface CampaignDistributedEnvelope {
  * Triggered when a campaign is successfully distributed to all recipients.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1292,6 +1631,8 @@ export interface CampaignPausedEnvelope {
  * Triggered when a scheduled campaign is paused.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1311,6 +1652,8 @@ export interface CampaignPublishedEnvelope {
  * Triggered when a draft campaign is published.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1330,6 +1673,8 @@ export interface CampaignRejectedEnvelope {
  * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1349,6 +1694,8 @@ export interface CampaignScheduledEnvelope {
  * Triggered when a campaign is scheduled to be sent out at the specific time.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1368,6 +1715,8 @@ export interface CampaignTerminatedEnvelope {
  * Triggered when the mailing list isn't clean and campaign was terminated.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1387,6 +1736,8 @@ export interface CampaignCreatedEnvelope {
  * Triggered when a campaign is created.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1405,6 +1756,8 @@ export interface CampaignDeletedEnvelope {
  * Triggered when a campaign is deleted.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1424,6 +1777,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
  * Triggered when an email campaign has a new recipient activity.
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1441,11 +1796,12 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: 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 Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1456,75 +1812,18 @@ export declare function validateLink(url: string): Promise<ValidateLinkResponse
  * 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 Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @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 Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @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 Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @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.
@@ -1534,6 +1833,8 @@ export interface ListRecipientsOptions {
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1558,6 +1859,8 @@ export interface GetCampaignOptions {
  * @permissionId Shoutout.Read
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Read Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
  * @permissionScope Manage Email Marketing
@@ -1601,6 +1904,8 @@ export interface ListCampaignsOptions {
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1623,6 +1928,8 @@ export interface PublishCampaignOptions {
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1630,9 +1937,15 @@ export interface PublishCampaignOptions {
  */
 export declare function sendTest(campaignId: string, options?: SendTestOptions): Promise<void>;
 export interface SendTestOptions {
-    /** Email subject. */
+    /**
+     * Email subject.
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
-    /** Recipient email address. */
+    /**
+     * Recipient email address.
+     * @format EMAIL
+     */
     toEmailAddress: string;
 }
 /**
@@ -1643,6 +1956,8 @@ export interface SendTestOptions {
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1659,6 +1974,8 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1673,6 +1990,8 @@ export declare function reschedule(campaignId: string, sendAt: Date | null): Pro
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1687,6 +2006,8 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1701,6 +2022,8 @@ export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaign
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Email Marketing
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
  * @applicableIdentity APP
@@ -1715,10 +2038,74 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
  * @permissionId Shoutout.Manage
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @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>;
+/**
+ * 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 Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @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 Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @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;
+}
 export {};