@wix/auto_sdk_email-marketing_campaigns 1.0.31 → 1.0.32

package/build/cjs/index.d.ts

@@ -1,8 +1,7 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { ListStatisticsResponse, RecipientsActivityEnumWithLiterals, ListRecipientsOptions, ListRecipientsResponse, GetCampaignOptions, Campaign, ListCampaignsOptions, ListCampaignsResponse, PublishCampaignOptions, PublishCampaignResponse, PublishCampaignApplicationErrors, SendTestOptions, ReuseCampaignResponse, GetAudienceResponse, IdentifySenderAddressResponse, ValidateLinkResponse, ValidateHtmlLinksResponse, CampaignDistributedEnvelope, CampaignPausedEnvelope, CampaignPublishedEnvelope, CampaignRejectedEnvelope, CampaignScheduledEnvelope, CampaignTerminatedEnvelope, CampaignCreatedEnvelope, CampaignDeletedEnvelope, CampaignEmailActivityUpdatedEnvelope } from './index.typings.js';
-export { ActionEvent, ActivityType, ArchiveCampaignRequest, ArchiveCampaignResponse, Archived, Attachment, AutomationTranslatorContent, BaseEventMetadata, CampaignAudience, CampaignEditorType, CampaignEditorTypeEnum, CampaignRecipientDetails, CampaignSendingStateEnum, CampaignStatistics, CampaignStatisticsContainer, CampaignStatusEnum, CampaignTypeEnum, CampaignVisibilityStatusEnum, Click, Composer, Contact, CountCampaignsRequest, CountCampaignsResponse, CreateCampaignRequest, CreateCampaignResponse, CreateFromTemplateRequest, CreateFromTemplateResponse, CreateFromUserTemplateRequest, CreateFromUserTemplateResponse, CreateUserTemplateRequest, CreateUserTemplateResponse, CursorPaging, Cursors, DateTime, Decimal, DefaultValues, DeleteCampaignRequest, DeleteCampaignResponse, Distributed, DistributionStatistics, DomainEvent, DomainEventBodyOneOf, EmailActivityUpdated, EmailActivityUpdatedEventTypeOneOf, EmailDistributionOptions, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EstimateAudienceSizeRequest, EstimateAudienceSizeResponse, EstimateFilterSizeRequest, EstimateFilterSizeResponse, EventMetadata, GetAudienceRequest, GetAutomationTranslatorContentRequest, GetAutomationTranslatorContentResponse, GetCampaignMappingRequest, GetCampaignMappingResponse, GetCampaignRequest, GetCampaignResponse, GetComposerRequest, GetComposerResponse, GetDefaultComponentsRequest, GetDefaultComponentsResponse, GetLabelsRequest, GetLabelsResponse, GetPlaceholderKeysRequest, GetPlaceholderKeysResponse, GetUsedPlaceholderKeysRequest, GetUsedPlaceholderKeysResponse, HardBounce, Html, IdentificationData, IdentificationDataIdOneOf, IdentifySenderAddressRequest, Integer, Label, LandingPageStatistics, ListCampaignsRequest, ListRecipientsRequest, ListStatisticsRequest, LookupCampaignMappingRequest, LookupCampaignMappingResponse, Map, MessageEnvelope, Money, Open, Paging, PagingMetadataV2, PauseSchedulingRequest, PauseSchedulingResponse, Paused, PlaceholderContent, PlaceholderContentEnum, PlaceholderContentValueOneOf, PlainText, PreviewCampaignRequest, PreviewCampaignResponse, PublishCampaignRequest, Published, PublishingData, RecipientsActivityEnum, ReconcileContactRequest, ReconcileContactResponse, Rejected, RejectionData, RejectionReasonEnum, RescheduleRequest, RescheduleResponse, ResendToNonOpenersRequest, ResendToNonOpenersResponse, RestoreInfo, ReuseCampaignRequest, Scheduled, SearchContactsRequest, SearchContactsResponse, SendTestBulkRequest, SendTestBulkResponse, SendTestRequest, SendTestResponse, SoftBounce, SubscribeFromLandingPageRequest, SubscribeFromLandingPageResponse, Terminated, TotalStatistics, UnarchiveCampaignRequest, UnarchiveCampaignResponse, Unarchived, UpdateComposerRequest, UpdateComposerResponse, UpdateTitleRequest, UpdateTitleResponse, UpsertAutomationTranslatorContentRequest, UpsertAutomationTranslatorContentResponse, UpsertTranslationRequest, UpsertTranslationResponse, ValidateHtmlLinksRequest, ValidateLinkRequest, WebhookIdentityType, _Array } from './index.typings.js';
+export { ActionEvent, ActivityType, ActivityTypeWithLiterals, ArchiveCampaignRequest, ArchiveCampaignResponse, Archived, Attachment, AutomationTranslatorContent, BaseEventMetadata, CampaignAudience, CampaignEditorType, CampaignEditorTypeEnum, CampaignEditorTypeEnumWithLiterals, CampaignRecipientDetails, CampaignSendingStateEnum, CampaignSendingStateEnumWithLiterals, CampaignStatistics, CampaignStatisticsContainer, CampaignStatusEnum, CampaignStatusEnumWithLiterals, CampaignTypeEnum, CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, CampaignVisibilityStatusEnumWithLiterals, Click, Composer, Contact, CountCampaignsRequest, CountCampaignsResponse, CreateCampaignRequest, CreateCampaignResponse, CreateFromTemplateRequest, CreateFromTemplateResponse, CreateFromUserTemplateRequest, CreateFromUserTemplateResponse, CreateUserTemplateRequest, CreateUserTemplateResponse, CursorPaging, Cursors, DateTime, Decimal, DefaultValues, DeleteCampaignRequest, DeleteCampaignResponse, Distributed, DistributionStatistics, DomainEvent, DomainEventBodyOneOf, EmailActivityUpdated, EmailActivityUpdatedEventTypeOneOf, EmailDistributionOptions, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, EstimateAudienceSizeRequest, EstimateAudienceSizeResponse, EstimateFilterSizeRequest, EstimateFilterSizeResponse, EventMetadata, GetAudienceRequest, GetAutomationTranslatorContentRequest, GetAutomationTranslatorContentResponse, GetCampaignMappingRequest, GetCampaignMappingResponse, GetCampaignRequest, GetCampaignResponse, GetComposerRequest, GetComposerResponse, GetDefaultComponentsRequest, GetDefaultComponentsResponse, GetLabelsRequest, GetLabelsResponse, GetPlaceholderKeysRequest, GetPlaceholderKeysResponse, GetUsedPlaceholderKeysRequest, GetUsedPlaceholderKeysResponse, HardBounce, Html, IdentificationData, IdentificationDataIdOneOf, IdentifySenderAddressRequest, Integer, Label, LandingPageStatistics, ListCampaignsRequest, ListRecipientsRequest, ListStatisticsRequest, LookupCampaignMappingRequest, LookupCampaignMappingResponse, Map, MessageEnvelope, Money, Open, Paging, PagingMetadataV2, PauseSchedulingRequest, PauseSchedulingResponse, Paused, PlaceholderContent, PlaceholderContentEnum, PlaceholderContentValueOneOf, PlainText, PreviewCampaignRequest, PreviewCampaignResponse, PublishCampaignRequest, Published, PublishingData, RecipientsActivityEnum, ReconcileContactRequest, ReconcileContactResponse, Rejected, RejectionData, RejectionReasonEnum, RejectionReasonEnumWithLiterals, RescheduleRequest, RescheduleResponse, ResendToNonOpenersRequest, ResendToNonOpenersResponse, RestoreInfo, ReuseCampaignRequest, Scheduled, SearchContactsRequest, SearchContactsResponse, SendTestBulkRequest, SendTestBulkResponse, SendTestRequest, SendTestResponse, SoftBounce, SubscribeFromLandingPageRequest, SubscribeFromLandingPageResponse, Terminated, TotalStatistics, UnarchiveCampaignRequest, UnarchiveCampaignResponse, Unarchived, UpdateComposerRequest, UpdateComposerResponse, UpdateTitleRequest, UpdateTitleResponse, UpsertAutomationTranslatorContentRequest, UpsertAutomationTranslatorContentResponse, UpsertTranslationRequest, UpsertTranslationResponse, ValidateHtmlLinksRequest, ValidateLinkRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, _Array } from './index.typings.js';
 
-type CampaignNonNullablePaths = `campaignId` | `editorType` | `status` | `visibilityStatus` | `distributionStatus` | `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked` | `emailSubject`;
 declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
 interface ListStatisticsSignature {
     /**
@@ -15,7 +14,7 @@ interface ListStatisticsSignature {
      * Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
      * @param - IDs of the campaigns to retrieve (max 100 campaigns).
      */
-    (campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`>>;
+    (campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
 }
 declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
 interface ListRecipientsSignature {
@@ -32,7 +31,7 @@ interface ListRecipientsSignature {
      * @param - Email activity to filter.
      * @param - Options to use when getting the list of recipients.
      */
-    (campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`>>;
+    (campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
 }
 declare function getCampaign$1(httpClient: HttpClient): GetCampaignSignature;
 interface GetCampaignSignature {
@@ -42,7 +41,7 @@ interface GetCampaignSignature {
      * @param - Options to use when getting a campaign.
      * @returns Campaign information.
      */
-    (campaignId: string, options?: GetCampaignOptions): Promise<NonNullablePaths<Campaign, CampaignNonNullablePaths>>;
+    (campaignId: string, options?: GetCampaignOptions): Promise<NonNullablePaths<Campaign, `campaignId` | `editorType` | `status` | `visibilityStatus` | `distributionStatus` | `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked` | `emailSubject`, 5>>;
 }
 declare function listCampaigns$1(httpClient: HttpClient): ListCampaignsSignature;
 interface ListCampaignsSignature {
@@ -52,9 +51,7 @@ interface ListCampaignsSignature {
      * Default sorts by `dateUpdated` in `DESC` order.
      * @param - Options to use when getting the list of campaigns.
      */
-    (options?: ListCampaignsOptions): Promise<NonNullablePaths<ListCampaignsResponse, {
-        [P in CampaignNonNullablePaths]: `campaigns.${number}.${P}`;
-    }[CampaignNonNullablePaths]>>;
+    (options?: ListCampaignsOptions): Promise<NonNullablePaths<ListCampaignsResponse, `campaigns` | `campaigns.${number}.campaignId` | `campaigns.${number}.editorType` | `campaigns.${number}.status` | `campaigns.${number}.visibilityStatus` | `campaigns.${number}.distributionStatus` | `campaigns.${number}.publishingData.landingPageUrl` | `campaigns.${number}.emailSubject`, 5>>;
 }
 declare function publishCampaign$1(httpClient: HttpClient): PublishCampaignSignature;
 interface PublishCampaignSignature {
@@ -65,7 +62,7 @@ interface PublishCampaignSignature {
      * @param - Campaign ID
      * @param - Options to use when publishing a campaign.
      */
-    (campaignId: string, options?: PublishCampaignOptions): Promise<NonNullablePaths<PublishCampaignResponse, `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked`> & {
+    (campaignId: string, options?: PublishCampaignOptions): Promise<NonNullablePaths<PublishCampaignResponse, `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked`, 5> & {
         __applicationErrorsType?: PublishCampaignApplicationErrors;
     }>;
 }
@@ -78,7 +75,7 @@ interface SendTestSignature {
      * @param - Campaign ID.
      * @param - Options for sending a test email.
      */
-    (campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`>): Promise<void>;
+    (campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`, 2>): Promise<void>;
 }
 declare function pauseScheduling$1(httpClient: HttpClient): PauseSchedulingSignature;
 interface PauseSchedulingSignature {
@@ -111,9 +108,7 @@ interface ReuseCampaignSignature {
      * Creates a copy of an existing campaign.
      * @param - ID of the message to be duplicated.
      */
-    (campaignId: string): Promise<NonNullablePaths<ReuseCampaignResponse, {
-        [P in CampaignNonNullablePaths]: `campaign.${P}`;
-    }[CampaignNonNullablePaths]>>;
+    (campaignId: string): Promise<NonNullablePaths<ReuseCampaignResponse, `campaign.campaignId` | `campaign.editorType` | `campaign.status` | `campaign.visibilityStatus` | `campaign.distributionStatus` | `campaign.publishingData.landingPageUrl` | `campaign.publishingData.statistics.landingPage.opened` | `campaign.publishingData.statistics.landingPage.clicked` | `campaign.publishingData.statistics.emailCampaign.delivered` | `campaign.publishingData.statistics.emailCampaign.opened` | `campaign.publishingData.statistics.emailCampaign.clicked` | `campaign.publishingData.statistics.emailCampaign.bounced` | `campaign.publishingData.statistics.emailCampaign.complained` | `campaign.publishingData.statistics.emailCampaign.notSent` | `campaign.publishingData.statistics.total.mailsSent` | `campaign.publishingData.statistics.total.opened` | `campaign.publishingData.statistics.total.clicked` | `campaign.emailSubject`, 6>>;
 }
 declare function getAudience$1(httpClient: HttpClient): GetAudienceSignature;
 interface GetAudienceSignature {
@@ -121,7 +116,7 @@ interface GetAudienceSignature {
      * Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.
      * @param - Campaign ID.
      */
-    (campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`>>;
+    (campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`, 3>>;
 }
 declare function identifySenderAddress$1(httpClient: HttpClient): IdentifySenderAddressSignature;
 interface IdentifySenderAddressSignature {
@@ -129,7 +124,7 @@ interface IdentifySenderAddressSignature {
      * Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
      * @param - Email address to verify.
      */
-    (emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`>>;
+    (emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`, 2>>;
 }
 declare function validateLink$1(httpClient: HttpClient): ValidateLinkSignature;
 interface ValidateLinkSignature {
@@ -139,7 +134,7 @@ interface ValidateLinkSignature {
      * If you provide a link as a placeholder, it's returned in a response as valid.
      * @param - URL to validate.
      */
-    (url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`>>;
+    (url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`, 2>>;
 }
 declare function validateHtmlLinks$1(httpClient: HttpClient): ValidateHtmlLinksSignature;
 interface ValidateHtmlLinksSignature {
@@ -147,7 +142,7 @@ interface ValidateHtmlLinksSignature {
      * 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 string with links.
      */
-    (html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`>>;
+    (html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
 }
 declare const onCampaignDistributedEvent$1: EventDefinition<CampaignDistributedEnvelope, "wix.email_marketing.v1.campaign_campaign_distributed_event">;
 declare const onCampaignPausedEvent$1: EventDefinition<CampaignPausedEnvelope, "wix.email_marketing.v1.campaign_campaign_paused_event">;
@@ -210,4 +205,4 @@ declare const onCampaignDeleted: BuildEventDefinition<typeof onCampaignDeleted$1
  */
 declare const onCampaignEmailActivityUpdated: BuildEventDefinition<typeof onCampaignEmailActivityUpdated$1>;
 
-export { Campaign, CampaignCreatedEnvelope, CampaignDeletedEnvelope, CampaignDistributedEnvelope, CampaignEmailActivityUpdatedEnvelope, CampaignPausedEnvelope, CampaignPublishedEnvelope, CampaignRejectedEnvelope, CampaignScheduledEnvelope, CampaignTerminatedEnvelope, GetAudienceResponse, GetCampaignOptions, IdentifySenderAddressResponse, ListCampaignsOptions, ListCampaignsResponse, ListRecipientsOptions, ListRecipientsResponse, ListStatisticsResponse, PublishCampaignOptions, PublishCampaignResponse, ReuseCampaignResponse, SendTestOptions, ValidateHtmlLinksResponse, ValidateLinkResponse, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };
+export { Campaign, CampaignCreatedEnvelope, CampaignDeletedEnvelope, CampaignDistributedEnvelope, CampaignEmailActivityUpdatedEnvelope, CampaignPausedEnvelope, CampaignPublishedEnvelope, CampaignRejectedEnvelope, CampaignScheduledEnvelope, CampaignTerminatedEnvelope, GetAudienceResponse, GetCampaignOptions, IdentifySenderAddressResponse, ListCampaignsOptions, ListCampaignsResponse, ListRecipientsOptions, ListRecipientsResponse, ListStatisticsResponse, PublishCampaignApplicationErrors, PublishCampaignOptions, PublishCampaignResponse, RecipientsActivityEnumWithLiterals, ReuseCampaignResponse, SendTestOptions, ValidateHtmlLinksResponse, ValidateLinkResponse, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };