@wix/auto_sdk_email-marketing_campaigns 1.0.4 → 1.0.6

package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.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.
@@ -33,6 +40,7 @@ export interface Campaign {
     /**
      * Email subject of the campaign (initially copied from the template).
      * TODO: Deprecated (moved to "GetComposerResponse").
+     * @maxLength 1000
      * @deprecated
      */
     emailSubject?: string;
@@ -92,7 +100,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;
@@ -198,116 +209,11 @@ export declare enum CampaignTypeEnum {
     /** triggered email */
     TRIGGERED = "TRIGGERED"
 }
-export interface EstimateFilterSizeRequest {
-    /** Contacts filter expression. */
-    filter?: Record<string, any> | null;
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-    /** Contacts plain text search expression (searches in name, phone and email fields). */
-    search?: string | null;
-}
-export interface EstimateFilterSizeResponse {
-    /** Mailing list size estimation. */
-    estimation?: number;
-}
-export interface EstimateAudienceSizeRequest {
-    /** Contact IDs of a campaign audience. */
-    contactIds?: string[];
-    /** Label IDs of a campaign audience. */
-    labelIds?: string[];
-    /** Contacts filter expression (json). */
-    contactsFilter?: Record<string, any> | null;
-    /** Contacts plain text search expression (searches in name, phone and email fields). */
-    search?: string | null;
-    /** Segment ids of a campaign audience. */
-    segmentIds?: string[];
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-    /** Id of a campaign that is to be resent. */
-    resendCampaignId?: string | null;
-    /** Should total number of contacts in provided audience be returned or not (default value "false"). */
-    withTotal?: boolean;
-}
-export interface EstimateAudienceSizeResponse {
-    /** Audience size (estimated number of emails to be sent). */
-    estimation?: number;
-    /** Total number of contacts in provided audience (optional). */
-    total?: number | null;
-}
-export interface ReconcileContactRequest {
-    /** Email address of the contact. */
-    emailAddress?: string;
-}
-export interface ReconcileContactResponse {
-    /** Created or retrieved contact. */
-    contact?: Contact;
-}
-export interface Contact {
-    /** Unique ID of the contact entity. */
-    id?: string;
-    /** Primary email address of the contact. */
-    emailAddress?: string;
-    /** Full name of the contact (optional). */
-    fullName?: string | null;
-    /** Profile picture of the contact (optional). */
-    pictureUrl?: string | null;
-}
-export interface SearchContactsRequest {
-    /** Text to search contacts by - can search by name or email address. */
-    searchTerm?: string;
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-    /** Page size (default 50, max 1000). */
-    pageSize?: number | null;
-}
-export interface SearchContactsResponse {
-    /** Search results. */
-    contacts?: Contact[];
-}
-export interface GetLabelsRequest {
-    /** Should "inactive" contacts be excluded or not (default value "false"). */
-    activeContactsOnly?: boolean;
-}
-export interface GetLabelsResponse {
-    /** Returned labels with contact counts. */
-    labels?: Label[];
-}
-export interface Label {
-    /** Unique ID of the label entity. */
-    id?: string;
-    /** Name of the label. */
-    name?: string;
-    /** Amount of contacts assigned to the label. */
-    contactsCount?: number;
-}
-export interface SubscribeFromLandingPageRequest {
-    /** Campaign ID that the subscription is happening from. */
-    campaignId?: string;
-    /** Email address that is entered into subscription field. */
-    emailAddress?: string;
-    /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
-    consent?: boolean;
-}
-export interface SubscribeFromLandingPageResponse {
-    contactId?: string;
-}
-export interface GetPlaceholderKeysRequest {
-    /** Campaign ID. */
-    campaignId?: string;
-}
-export interface GetPlaceholderKeysResponse {
-    /** Keys of placeholders used in the campaign. */
-    placeholderKeys?: string[];
-}
-export interface GetDefaultComponentsRequest {
-}
-export interface GetDefaultComponentsResponse {
-    footer?: Record<string, any> | null;
-    logo?: Record<string, any> | null;
-    follow?: Record<string, any> | null;
-}
 export interface ValidateLinkRequest {
-    /** URL to validate. */
+    /**
+     * URL to validate.
+     * @minLength 1
+     */
     url: string;
 }
 export interface ValidateLinkResponse {
@@ -315,204 +221,315 @@ export interface ValidateLinkResponse {
     valid?: boolean;
 }
 export interface ValidateHtmlLinksRequest {
-    /** HTML string with links. */
+    /**
+     * HTML string with links.
+     * @maxLength 1000000
+     */
     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;
-    /** 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. */
-    limit?: number | null;
+export interface GetCampaignMappingRequest {
     /**
-     * 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.
+     * rule ID in automations
+     * @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 */
+    /**
+     * template ID configured for the automation
+     * @format GUID
+     */
     templateId?: string;
 }
 export interface GetCampaignMappingResponse {
+    /** @format GUID */
     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. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId?: string;
     /** Composer data. */
     composer?: Composer;
-    /** Translation language (optional, default value "EN"). */
+    /**
+     * Translation language (optional, default value "EN").
+     * @format LANGUAGE
+     */
     language?: string | null;
-    /** For BI event [36:1031] only (optional, default value "n/a"). */
+    /**
+     * 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). */
+    /**
+     * Campaign subject (optional).
+     * @maxLength 1000
+     */
     emailSubject?: string | null;
-    /** Campaign preheader (optional). */
+    /**
+     * Campaign preheader (optional).
+     * @maxLength 1000
+     */
     emailPreheader?: string | null;
 }
 export interface Composer {
-    /** Internal data structure for editor/viewer to render the campaign. */
+    /**
+     * 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. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId?: string;
 }
 export interface GetUsedPlaceholderKeysResponse {
-    /** Keys of placeholders used in the automation. */
+    /**
+     * Keys of placeholders used in the automation.
+     * @maxLength 200
+     * @maxSize 300
+     */
     placeholderKeys?: string[];
 }
 export interface LookupCampaignMappingRequest {
-    /** rule ID in automations */
+    /**
+     * rule ID in automations
+     * @format GUID
+     */
     automationRuleId?: string;
-    /** template ID configured for the automation */
+    /**
+     * 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 */
+    /**
+     * Campaign ID that the content belongs to
+     * @format GUID
+     */
     campaignId?: string;
     /** Automation translator content */
     automationTranslatorContent?: AutomationTranslatorContent;
 }
 /** Automation Translator Content */
 export interface AutomationTranslatorContent {
-    /** AutomationTranslatorContent ID */
+    /**
+     * 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 */
+    /**
+     * 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 */
+    /**
+     * 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).
+     * @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. */
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
     campaignId: string;
     /**
      * Whether a returned campaign object should include `publishingData.statistics`.
@@ -568,7 +585,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>;
@@ -580,9 +600,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 {
@@ -590,7 +616,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 {
@@ -598,20 +627,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
@@ -625,23 +664,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 {
@@ -662,16 +717,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 */
@@ -726,7 +793,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;
@@ -734,11 +804,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 {
@@ -777,9 +856,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;
@@ -811,23 +896,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;
@@ -835,43 +930,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 {
@@ -879,9 +998,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>;
@@ -893,29 +1018,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 */
@@ -929,9 +1075,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 {
@@ -939,17 +1091,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 {
@@ -957,25 +1121,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 {
@@ -1051,9 +1241,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** 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;
@@ -1061,26 +1257,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -1090,6 +1310,117 @@ export declare enum WebhookIdentityType {
     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;
+    /** 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 ValidateLinkResponseNonNullableFields {
     valid: boolean;
 }
@@ -1108,22 +1439,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;
@@ -1178,4 +1493,20 @@ 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 {};