@wix/auto_sdk_email-marketing_campaigns 1.0.31 → 1.0.33

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

@@ -1452,6 +1452,7 @@ interface SubscribeFromLandingPageResponse {
     /** @format GUID */
     contactId?: string;
 }
+/** @docsIgnore */
 type PublishCampaignApplicationErrors = {
     code?: 'ALREADY_SENT';
     description?: string;
@@ -1707,7 +1708,6 @@ interface CampaignEmailActivityUpdatedEnvelope {
  * @slug email_activity_updated
  */
 declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
-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`;
 /**
  * Retrieves a list of statistics for up to 100 selected campaigns.
  *
@@ -1723,7 +1723,7 @@ type CampaignNonNullablePaths = `campaignId` | `editorType` | `status` | `visibi
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
  */
-declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`>>;
+declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
 /**
  * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
  *
@@ -1743,7 +1743,7 @@ declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
  */
-declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`>>;
+declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
 interface ListRecipientsOptions {
     /** Pagination options. */
     paging?: CursorPaging;
@@ -1759,7 +1759,7 @@ interface ListRecipientsOptions {
  * @returns Campaign information.
  * @fqn wix.emailmarketing.api.v1.CampaignService.Get
  */
-declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<NonNullablePaths<Campaign, CampaignNonNullablePaths>>;
+declare function getCampaign(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>>;
 interface GetCampaignOptions {
     /**
      * Whether a returned campaign should include `publishingData.statistics`.
@@ -1778,9 +1778,7 @@ interface GetCampaignOptions {
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.List
  */
-declare function listCampaigns(options?: ListCampaignsOptions): Promise<NonNullablePaths<ListCampaignsResponse, {
-    [P in CampaignNonNullablePaths]: `campaigns.${number}.${P}`;
-}[CampaignNonNullablePaths]>>;
+declare function listCampaigns(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>>;
 interface ListCampaignsOptions {
     /** Paging parameters. */
     paging?: Paging;
@@ -1807,7 +1805,7 @@ interface ListCampaignsOptions {
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.Publish
  */
-declare function publishCampaign(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`> & {
+declare function publishCampaign(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;
 }>;
 interface PublishCampaignOptions {
@@ -1827,7 +1825,7 @@ interface PublishCampaignOptions {
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
  */
-declare function sendTest(campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`>): Promise<void>;
+declare function sendTest(campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`, 2>): Promise<void>;
 interface SendTestOptions {
     /**
      * Email subject.
@@ -1881,9 +1879,7 @@ declare function deleteCampaign(campaignId: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
  */
-declare function reuseCampaign(campaignId: string): Promise<NonNullablePaths<ReuseCampaignResponse, {
-    [P in CampaignNonNullablePaths]: `campaign.${P}`;
-}[CampaignNonNullablePaths]>>;
+declare function reuseCampaign(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>>;
 /**
  * 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 campaignId - Campaign ID.
@@ -1893,7 +1889,7 @@ declare function reuseCampaign(campaignId: string): Promise<NonNullablePaths<Reu
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
  */
-declare function getAudience(campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`>>;
+declare function getAudience(campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`, 3>>;
 /**
  * Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
  * @param emailAddress - Email address to verify.
@@ -1903,7 +1899,7 @@ declare function getAudience(campaignId: string): Promise<NonNullablePaths<GetAu
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
  */
-declare function identifySenderAddress(emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`>>;
+declare function identifySenderAddress(emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`, 2>>;
 /**
  * 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.
  *
@@ -1915,7 +1911,7 @@ declare function identifySenderAddress(emailAddress: string): Promise<NonNullabl
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
  */
-declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`>>;
+declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`, 2>>;
 /**
  * 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.
@@ -1925,6 +1921,6 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
  */
-declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`>>;
+declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
 
 export { type ActionEvent, ActivityType, type ActivityTypeWithLiterals, type ArchiveCampaignRequest, type ArchiveCampaignResponse, type Archived, type Attachment, type AutomationTranslatorContent, type BaseEventMetadata, type Campaign, type CampaignAudience, type CampaignCreatedEnvelope, type CampaignDeletedEnvelope, type CampaignDistributedEnvelope, type CampaignEditorType, CampaignEditorTypeEnum, type CampaignEditorTypeEnumWithLiterals, type CampaignEmailActivityUpdatedEnvelope, type CampaignPausedEnvelope, type CampaignPublishedEnvelope, type CampaignRecipientDetails, type CampaignRejectedEnvelope, type CampaignScheduledEnvelope, CampaignSendingStateEnum, type CampaignSendingStateEnumWithLiterals, type CampaignStatistics, type CampaignStatisticsContainer, CampaignStatusEnum, type CampaignStatusEnumWithLiterals, type CampaignTerminatedEnvelope, CampaignTypeEnum, type CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, type CampaignVisibilityStatusEnumWithLiterals, type Click, type Composer, type Contact, type CountCampaignsRequest, type CountCampaignsResponse, type CreateCampaignRequest, type CreateCampaignResponse, type CreateFromTemplateRequest, type CreateFromTemplateResponse, type CreateFromUserTemplateRequest, type CreateFromUserTemplateResponse, type CreateUserTemplateRequest, type CreateUserTemplateResponse, type CursorPaging, type Cursors, type DateTime, type Decimal, type DefaultValues, type DeleteCampaignRequest, type DeleteCampaignResponse, type Distributed, type DistributionStatistics, type DomainEvent, type DomainEventBodyOneOf, type EmailActivityUpdated, type EmailActivityUpdatedEventTypeOneOf, type EmailDistributionOptions, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EstimateAudienceSizeRequest, type EstimateAudienceSizeResponse, type EstimateFilterSizeRequest, type EstimateFilterSizeResponse, type EventMetadata, type GetAudienceRequest, type GetAudienceResponse, type GetAutomationTranslatorContentRequest, type GetAutomationTranslatorContentResponse, type GetCampaignMappingRequest, type GetCampaignMappingResponse, type GetCampaignOptions, type GetCampaignRequest, type GetCampaignResponse, type GetComposerRequest, type GetComposerResponse, type GetDefaultComponentsRequest, type GetDefaultComponentsResponse, type GetLabelsRequest, type GetLabelsResponse, type GetPlaceholderKeysRequest, type GetPlaceholderKeysResponse, type GetUsedPlaceholderKeysRequest, type GetUsedPlaceholderKeysResponse, type HardBounce, type Html, type IdentificationData, type IdentificationDataIdOneOf, type IdentifySenderAddressRequest, type IdentifySenderAddressResponse, type Integer, type Label, type LandingPageStatistics, type ListCampaignsOptions, type ListCampaignsRequest, type ListCampaignsResponse, type ListRecipientsOptions, type ListRecipientsRequest, type ListRecipientsResponse, type ListStatisticsRequest, type ListStatisticsResponse, type LookupCampaignMappingRequest, type LookupCampaignMappingResponse, type Map, type MessageEnvelope, type Money, type Open, type Paging, type PagingMetadataV2, type PauseSchedulingRequest, type PauseSchedulingResponse, type Paused, type PlaceholderContent, type PlaceholderContentEnum, type PlaceholderContentValueOneOf, type PlainText, type PreviewCampaignRequest, type PreviewCampaignResponse, type PublishCampaignApplicationErrors, type PublishCampaignOptions, type PublishCampaignRequest, type PublishCampaignResponse, type Published, type PublishingData, RecipientsActivityEnum, type RecipientsActivityEnumWithLiterals, type ReconcileContactRequest, type ReconcileContactResponse, type Rejected, type RejectionData, RejectionReasonEnum, type RejectionReasonEnumWithLiterals, type RescheduleRequest, type RescheduleResponse, type ResendToNonOpenersRequest, type ResendToNonOpenersResponse, type RestoreInfo, type ReuseCampaignRequest, type ReuseCampaignResponse, type Scheduled, type SearchContactsRequest, type SearchContactsResponse, type SendTestBulkRequest, type SendTestBulkResponse, type SendTestOptions, type SendTestRequest, type SendTestResponse, type SoftBounce, type SubscribeFromLandingPageRequest, type SubscribeFromLandingPageResponse, type Terminated, type TotalStatistics, type UnarchiveCampaignRequest, type UnarchiveCampaignResponse, type Unarchived, type UpdateComposerRequest, type UpdateComposerResponse, type UpdateTitleRequest, type UpdateTitleResponse, type UpsertAutomationTranslatorContentRequest, type UpsertAutomationTranslatorContentResponse, type UpsertTranslationRequest, type UpsertTranslationResponse, type ValidateHtmlLinksRequest, type ValidateHtmlLinksResponse, type ValidateLinkRequest, type ValidateLinkResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };