@wix/auto_sdk_email-marketing_campaigns 1.0.9 → 1.0.11

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

@@ -196,27 +196,116 @@ export declare enum CampaignTypeEnum {
     /** Triggered email. */
     TRIGGERED = "TRIGGERED"
 }
-export interface ValidateLinkRequest {
+export interface ListStatisticsRequest {
     /**
-     * URL to validate.
-     * @minLength 1
+     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
      */
-    url: string;
+    campaignIds: string[];
 }
-export interface ValidateLinkResponse {
-    /** Whether the link is valid. */
-    valid?: boolean;
+export interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
 }
-export interface ValidateHtmlLinksRequest {
+export interface CampaignStatisticsContainer {
     /**
-     * HTML string with links.
-     * @maxLength 1000000
+     * Campaign ID.
+     * @format GUID
      */
-    html: string;
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
 }
-export interface ValidateHtmlLinksResponse {
-    /** Non-valid links. */
-    blacklistedLinks?: string[];
+export interface ListRecipientsRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /** Email activity to filter. */
+    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
+     */
+    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;
+}
+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.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
 }
 export interface GetCampaignMappingRequest {
     /**
@@ -460,169 +549,6 @@ export interface Decimal {
 }
 export interface SendTestBulkResponse {
 }
-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).
-     * @minLength 1
-     * @maxLength 100
-     */
-    search?: string | null;
-}
-export interface EstimateFilterSizeResponse {
-    /** Mailing list size estimation. */
-    estimation?: number;
-}
-export interface EstimateAudienceSizeRequest {
-    /**
-     * Contact IDs of a campaign audience.
-     * @format GUID
-     */
-    contactIds?: string[];
-    /** Label IDs of a campaign audience. */
-    labelIds?: string[];
-    /** Contacts filter expression (json). */
-    contactsFilter?: Record<string, any> | null;
-    /**
-     * Contacts plain text search expression (searches in name, phone and email fields).
-     * @minLength 1
-     * @maxLength 100
-     */
-    search?: string | null;
-    /**
-     * Segment ids of a campaign audience.
-     * @format GUID
-     */
-    segmentIds?: string[];
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-    /**
-     * Id of a campaign that is to be resent.
-     * @format GUID
-     */
-    resendCampaignId?: string | null;
-    /** Should total number of contacts in provided audience be returned or not (default value "false"). */
-    withTotal?: boolean;
-}
-export interface EstimateAudienceSizeResponse {
-    /** Audience size (estimated number of emails to be sent). */
-    estimation?: number;
-    /** Total number of contacts in provided audience (optional). */
-    total?: number | null;
-}
-export interface ReconcileContactRequest {
-    /**
-     * Email address of the contact.
-     * @format EMAIL
-     */
-    emailAddress?: string;
-}
-export interface ReconcileContactResponse {
-    /** Created or retrieved contact. */
-    contact?: Contact;
-}
-export interface Contact {
-    /**
-     * Unique ID of the contact entity.
-     * @format GUID
-     */
-    _id?: string;
-    /**
-     * Primary email address of the contact.
-     * @format EMAIL
-     */
-    emailAddress?: string;
-    /**
-     * Full name of the contact (optional).
-     * @maxLength 100
-     */
-    fullName?: string | null;
-    /**
-     * Profile picture of the contact (optional).
-     * @format WEB_URL
-     * @maxLength 2048
-     */
-    pictureUrl?: string | null;
-}
-export interface SearchContactsRequest {
-    /**
-     * Text to search contacts by - can search by name or email address.
-     * @maxLength 100
-     */
-    searchTerm?: string;
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-    /**
-     * Page size (default 50, max 1000).
-     * @max 1000
-     */
-    pageSize?: number | null;
-}
-export interface SearchContactsResponse {
-    /** Search results. */
-    contacts?: Contact[];
-}
-export interface GetLabelsRequest {
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-}
-export interface GetLabelsResponse {
-    /** Returned labels with contact counts. */
-    labels?: Label[];
-}
-export interface Label {
-    /**
-     * Unique ID of the label entity.
-     * @maxLength 100
-     */
-    _id?: string;
-    /**
-     * 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.
-     * @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;
-}
-export interface SubscribeFromLandingPageResponse {
-    /** @format GUID */
-    contactId?: string;
-}
 export interface GetCampaignRequest {
     /**
      * Campaign ID.
@@ -1326,80 +1252,116 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface ListStatisticsRequest {
+export interface GetPlaceholderKeysRequest {
     /**
-     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * Campaign ID.
      * @format GUID
-     * @minSize 1
-     * @maxSize 100
      */
-    campaignIds: string[];
+    campaignId?: string;
 }
-export interface ListStatisticsResponse {
-    /** List of statistics. */
-    statistics?: CampaignStatisticsContainer[];
+export interface GetPlaceholderKeysResponse {
+    /** Keys of placeholders used in the campaign. */
+    placeholderKeys?: string[];
 }
-export interface CampaignStatisticsContainer {
+export interface GetDefaultComponentsRequest {
+}
+export interface GetDefaultComponentsResponse {
+    footer?: Record<string, any> | null;
+    logo?: Record<string, any> | null;
+    follow?: Record<string, any> | null;
+}
+export interface ValidateLinkRequest {
     /**
-     * Campaign ID.
-     * @format GUID
+     * URL to validate.
+     * @minLength 1
      */
-    campaignId?: string;
-    /** Landing page statistics. */
-    landingPage?: LandingPageStatistics;
-    /** Email campaign statistics. */
-    email?: DistributionStatistics;
+    url: string;
 }
-export interface ListRecipientsRequest {
+export interface ValidateLinkResponse {
+    /** Whether the link is valid. */
+    valid?: boolean;
+}
+export interface ValidateHtmlLinksRequest {
     /**
-     * Campaign ID.
-     * @format GUID
+     * HTML string with links.
+     * @maxLength 1000000
      */
-    campaignId: string;
-    /** Email activity to filter. */
-    activity: RecipientsActivityEnum;
-    /** Pagination options. */
-    paging?: CursorPaging;
+    html: string;
 }
-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 ValidateHtmlLinksResponse {
+    /** Non-valid links. */
+    blacklistedLinks?: string[];
 }
-export interface CursorPaging {
+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).
+     * @minLength 1
+     * @maxLength 100
+     */
+    search?: string | null;
+}
+export interface EstimateFilterSizeResponse {
+    /** Mailing list size estimation. */
+    estimation?: number;
+}
+export 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;
     /**
-     * Number of items to load.
-     * @max 1000
+     * Id of a campaign that is to be resent.
+     * @format GUID
      */
-    limit?: number | null;
+    resendCampaignId?: string | null;
+    /** Should total number of contacts in provided audience be returned or not (default value "false"). */
+    withTotal?: boolean;
+}
+export interface EstimateAudienceSizeResponse {
+    /** Audience size (estimated number of emails to be sent). */
+    estimation?: number;
+    /** Total number of contacts in provided audience (optional). */
+    total?: number | null;
+}
+export interface ReconcileContactRequest {
     /**
-     * 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.
+     * Email address of the contact.
+     * @format EMAIL
      */
-    cursor?: string | null;
+    emailAddress?: string;
 }
-export interface ListRecipientsResponse {
-    /** List of recipients. */
-    recipients?: CampaignRecipientDetails[];
-    /** Details on the paged set of returned results. */
-    pagingMetadata?: PagingMetadataV2;
+export interface ReconcileContactResponse {
+    /** Created or retrieved contact. */
+    contact?: Contact;
 }
-export interface CampaignRecipientDetails {
+export interface Contact {
     /**
-     * Contact ID.
+     * Unique ID of the contact entity.
      * @format GUID
      */
-    contactId?: string;
-    /** Date and time of the last activity. */
-    lastActivityDate?: Date | null;
+    _id?: string;
     /**
      * Primary email address of the contact.
      * @format EMAIL
@@ -1410,38 +1372,70 @@ export interface CampaignRecipientDetails {
      * @maxLength 100
      */
     fullName?: string | null;
-    /** Is this contact currently deleted from the site or not. */
-    contactDeleted?: boolean;
+    /**
+     * Profile picture of the contact (optional).
+     * @format WEB_URL
+     * @maxLength 2048
+     */
+    pictureUrl?: string | 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 SearchContactsRequest {
+    /**
+     * Text to search contacts by - can search by name or email address.
+     * @maxLength 100
+     */
+    searchTerm?: string;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /**
+     * Page size (default 50, max 1000).
+     * @max 1000
+     */
+    pageSize?: number | null;
 }
-export interface Cursors {
+export interface SearchContactsResponse {
+    /** Search results. */
+    contacts?: Contact[];
+}
+export interface GetLabelsRequest {
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+}
+export interface GetLabelsResponse {
+    /** Returned labels with contact counts. */
+    labels?: Label[];
+}
+export interface Label {
     /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
+     * Unique ID of the label entity.
+     * @maxLength 100
      */
-    next?: string | null;
+    _id?: string;
     /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
+     * Name of the label.
+     * @maxLength 100
      */
-    prev?: string | null;
+    name?: string;
+    /** Amount of contacts assigned to the label. */
+    contactsCount?: number;
 }
-export interface ValidateLinkResponseNonNullableFields {
-    valid: boolean;
+export interface SubscribeFromLandingPageRequest {
+    /**
+     * Campaign ID that the subscription is happening from.
+     * @format GUID
+     */
+    campaignId?: string;
+    /**
+     * Email address that is entered into subscription field.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+    /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
+    consent?: boolean;
 }
-export interface ValidateHtmlLinksResponseNonNullableFields {
-    blacklistedLinks: string[];
+export interface SubscribeFromLandingPageResponse {
+    /** @format GUID */
+    contactId?: string;
 }
 interface LandingPageStatisticsNonNullableFields {
     opened: number;
@@ -1455,6 +1449,22 @@ 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;
@@ -1509,21 +1519,11 @@ 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 ValidateLinkResponseNonNullableFields {
+    valid: boolean;
 }
-export interface ListRecipientsResponseNonNullableFields {
-    recipients: CampaignRecipientDetailsNonNullableFields[];
+export interface ValidateHtmlLinksResponseNonNullableFields {
+    blacklistedLinks: string[];
 }
 export interface BaseEventMetadata {
     /**
@@ -1766,39 +1766,61 @@ export interface CampaignEmailActivityUpdatedEnvelope {
  */
 export declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Validates any provided link. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
+ * Retrieves a list of statistics for up to 100 selected campaigns.
  *
- * If you provide a link as a placeholder, it's returned in a response as valid.
- * @param url - URL to validate.
+ * 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 url
- * @permissionId Shoutout.Manage
+ * @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.CampaignValidationService.ValidateLink
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
  */
-export declare function validateLink(url: string): Promise<ValidateLinkResponse & ValidateLinkResponseNonNullableFields>;
+export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
 /**
- * Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Call 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.
+ * 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 html
- * @permissionId Shoutout.Manage
+ * @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.CampaignValidationService.ValidateHtmlLinks
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
  */
-export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
+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.
@@ -2012,59 +2034,37 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
  */
 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.
+ * Validates any provided link. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
  *
- * 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).
+ * If you provide a link as a placeholder, it's returned in a response as valid.
+ * @param url - URL to validate.
  * @public
- * @requiredField campaignIds
- * @permissionId Shoutout.Read
+ * @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 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
+ * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
  */
-export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
+export declare function validateLink(url: string): Promise<ValidateLinkResponse & ValidateLinkResponseNonNullableFields>;
 /**
- * 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.
+ * Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Call 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
- * @requiredField activity
- * @requiredField campaignId
- * @param options - Options to use when getting the list of recipients.
- * @permissionId Shoutout.Read
+ * @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 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
+ * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
  */
-export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
-export interface ListRecipientsOptions {
-    /** Pagination options. */
-    paging?: CursorPaging;
-}
+export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
 export {};