@wix/auto_sdk_email-marketing_campaigns 1.0.16 → 1.0.18

package/build/index.d.mts

@@ -0,0 +1,186 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetCampaignOptions, C as Campaign, L as ListCampaignsOptions, a as ListCampaignsResponse, P as PublishCampaignOptions, b as PublishCampaignResponse, S as SendTestOptions, R as ReuseCampaignResponse, c as GetAudienceResponse, I as IdentifySenderAddressResponse, d as ListStatisticsResponse, e as RecipientsActivityEnumWithLiterals, f as ListRecipientsOptions, g as ListRecipientsResponse, h as CampaignDistributedEnvelope, i as CampaignPausedEnvelope, j as CampaignPublishedEnvelope, k as CampaignRejectedEnvelope, l as CampaignScheduledEnvelope, m as CampaignTerminatedEnvelope, n as CampaignCreatedEnvelope, o as CampaignDeletedEnvelope, p as CampaignEmailActivityUpdatedEnvelope } from './email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.mjs';
+export { a_ as ActionEvent, A as ActivityType, at as ArchiveCampaignRequest, au as ArchiveCampaignResponse, av as Archived, ak as Attachment, bn as BaseEventMetadata, aS as CampaignAudience, aL as CampaignEditorType, q as CampaignEditorTypeEnum, bk as CampaignRecipientDetails, u as CampaignSendingStateEnum, y as CampaignStatistics, bh as CampaignStatisticsContainer, r as CampaignStatusEnum, v as CampaignTypeEnum, s as CampaignVisibilityStatusEnum, a5 as Click, aI as Composer, b8 as Contact, M as CountCampaignsRequest, N as CountCampaignsResponse, aN as CreateCampaignRequest, aO as CreateCampaignResponse, O as CreateFromTemplateRequest, Q as CreateFromTemplateResponse, X as CreateFromUserTemplateRequest, Y as CreateFromUserTemplateResponse, U as CreateUserTemplateRequest, V as CreateUserTemplateResponse, bj as CursorPaging, bm as Cursors, ag as DateTime, am as Decimal, aJ as DefaultValues, aB as DeleteCampaignRequest, aC as DeleteCampaignResponse, a2 as Distributed, D as DistributionStatistics, aU as DomainEvent, aV as DomainEventBodyOneOf, a3 as EmailActivityUpdated, a4 as EmailActivityUpdatedEventTypeOneOf, _ as EmailDistributionOptions, aW as EntityCreatedEvent, aZ as EntityDeletedEvent, aY as EntityUpdatedEvent, E as Enum, b4 as EstimateAudienceSizeRequest, b5 as EstimateAudienceSizeResponse, b2 as EstimateFilterSizeRequest, b3 as EstimateFilterSizeResponse, bo as EventMetadata, aR as GetAudienceRequest, F as GetCampaignRequest, H as GetCampaignResponse, aG as GetComposerRequest, aH as GetComposerResponse, bb as GetLabelsRequest, bc as GetLabelsResponse, a8 as HardBounce, ae as Html, b0 as IdentificationData, b1 as IdentificationDataIdOneOf, aT as IdentifySenderAddressRequest, al as Integer, bd as Label, z as LandingPageStatistics, J as ListCampaignsRequest, bi as ListRecipientsRequest, bg as ListStatisticsRequest, ah as Map, a$ as MessageEnvelope, af as Money, a6 as Open, K as Paging, bl as PagingMetadataV2, ao as PauseSchedulingRequest, ap as PauseSchedulingResponse, aq as Paused, ab as PlaceholderContent, aj as PlaceholderContentEnum, ac as PlaceholderContentValueOneOf, ad as PlainText, aE as PreviewCampaignRequest, aF as PreviewCampaignResponse, Z as PublishCampaignRequest, a0 as Published, x as PublishingData, w as RecipientsActivityEnum, b6 as ReconcileContactRequest, b7 as ReconcileContactResponse, $ as Rejected, B as RejectionData, t as RejectionReasonEnum, ar as RescheduleRequest, as as RescheduleResponse, aP as ResendToNonOpenersRequest, aQ as ResendToNonOpenersResponse, aX as RestoreInfo, aD as ReuseCampaignRequest, a9 as Scheduled, b9 as SearchContactsRequest, ba as SearchContactsResponse, aa as SendTestRequest, an as SendTestResponse, a7 as SoftBounce, be as SubscribeFromLandingPageRequest, bf as SubscribeFromLandingPageResponse, a1 as Terminated, T as TotalStatistics, aw as UnarchiveCampaignRequest, ax as UnarchiveCampaignResponse, ay as Unarchived, aK as UpdateComposerRequest, aM as UpdateComposerResponse, az as UpdateTitleRequest, aA as UpdateTitleResponse, W as WebhookIdentityType, ai as _Array } from './email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.mjs';
+
+declare function getCampaign$1(httpClient: HttpClient): GetCampaignSignature;
+interface GetCampaignSignature {
+    /**
+     * Retrieves information about an email campaign.
+     * @param - Campaign ID.
+     * @param - Options to use when getting a campaign.
+     * @returns Campaign information.
+     */
+    (campaignId: string, options?: GetCampaignOptions | undefined): Promise<Campaign>;
+}
+declare function listCampaigns$1(httpClient: HttpClient): ListCampaignsSignature;
+interface ListCampaignsSignature {
+    /**
+     * Retrieves a list of email campaigns.
+     *
+     * Default sorts by `dateUpdated` in `DESC` order.
+     * @param - Options to use when getting the list of campaigns.
+     */
+    (options?: ListCampaignsOptions | undefined): Promise<ListCampaignsResponse>;
+}
+declare function publishCampaign$1(httpClient: HttpClient): PublishCampaignSignature;
+interface PublishCampaignSignature {
+    /**
+     * Publishes and sends a specified campaign.
+     *
+     * If the `email_distribution_options` object isn't passed in the request, the campaign is only published as a landing page.
+     * @param - Campaign ID
+     * @param - Options to use when publishing a campaign.
+     */
+    (campaignId: string, options?: PublishCampaignOptions | undefined): Promise<PublishCampaignResponse>;
+}
+declare function sendTest$1(httpClient: HttpClient): SendTestSignature;
+interface SendTestSignature {
+    /**
+     * Sends a test email. Call this method to preview your email campaign.
+     *
+     * We strongly recommend calling this method only a few times in a row, as there is a rate limit to prevent abuse of the Send Test method.
+     * @param - Campaign ID.
+     * @param - Options for sending a test email.
+     */
+    (campaignId: string, options?: SendTestOptions | undefined): Promise<void>;
+}
+declare function pauseScheduling$1(httpClient: HttpClient): PauseSchedulingSignature;
+interface PauseSchedulingSignature {
+    /**
+     * Pauses a scheduled campaign.
+     * @param - Campaign ID.
+     */
+    (campaignId: string): Promise<void>;
+}
+declare function reschedule$1(httpClient: HttpClient): RescheduleSignature;
+interface RescheduleSignature {
+    /**
+     * Changes the sending time for an already scheduled campaign.
+     * @param - ID of the campaign to reschedule.
+     * @param - New time for sending out the campaign.
+     */
+    (campaignId: string, sendAt: Date): Promise<void>;
+}
+declare function deleteCampaign$1(httpClient: HttpClient): DeleteCampaignSignature;
+interface DeleteCampaignSignature {
+    /**
+     * Permanently deletes a campaign.
+     * @param - Campaign ID.
+     */
+    (campaignId: string): Promise<void>;
+}
+declare function reuseCampaign$1(httpClient: HttpClient): ReuseCampaignSignature;
+interface ReuseCampaignSignature {
+    /**
+     * Creates a copy of an existing campaign.
+     * @param - ID of the message to be duplicated.
+     */
+    (campaignId: string): Promise<ReuseCampaignResponse>;
+}
+declare function getAudience$1(httpClient: HttpClient): GetAudienceSignature;
+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<GetAudienceResponse>;
+}
+declare function identifySenderAddress$1(httpClient: HttpClient): IdentifySenderAddressSignature;
+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<IdentifySenderAddressResponse>;
+}
+declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
+interface ListStatisticsSignature {
+    /**
+     * 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.
+     *
+     * 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 - IDs of the campaigns to retrieve (max 100 campaigns).
+     */
+    (campaignIds: string[]): Promise<ListStatisticsResponse>;
+}
+declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
+interface ListRecipientsSignature {
+    /**
+     * 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 - Campaign ID.
+     * @param - Email activity to filter.
+     * @param - Options to use when getting the list of recipients.
+     */
+    (campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions | undefined): Promise<ListRecipientsResponse>;
+}
+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">;
+declare const onCampaignPublishedEvent$1: EventDefinition<CampaignPublishedEnvelope, "wix.email_marketing.v1.campaign_campaign_published_event">;
+declare const onCampaignRejectedEvent$1: EventDefinition<CampaignRejectedEnvelope, "wix.email_marketing.v1.campaign_campaign_rejected_event">;
+declare const onCampaignScheduledEvent$1: EventDefinition<CampaignScheduledEnvelope, "wix.email_marketing.v1.campaign_campaign_scheduled_event">;
+declare const onCampaignTerminatedEvent$1: EventDefinition<CampaignTerminatedEnvelope, "wix.email_marketing.v1.campaign_campaign_terminated_event">;
+declare const onCampaignCreated$1: EventDefinition<CampaignCreatedEnvelope, "wix.email_marketing.v1.campaign_created">;
+declare const onCampaignDeleted$1: EventDefinition<CampaignDeletedEnvelope, "wix.email_marketing.v1.campaign_deleted">;
+declare const onCampaignEmailActivityUpdated$1: EventDefinition<CampaignEmailActivityUpdatedEnvelope, "wix.email_marketing.v1.campaign_email_activity_updated">;
+
+declare const getCampaign: MaybeContext<BuildRESTFunction<typeof getCampaign$1> & typeof getCampaign$1>;
+declare const listCampaigns: MaybeContext<BuildRESTFunction<typeof listCampaigns$1> & typeof listCampaigns$1>;
+declare const publishCampaign: MaybeContext<BuildRESTFunction<typeof publishCampaign$1> & typeof publishCampaign$1>;
+declare const sendTest: MaybeContext<BuildRESTFunction<typeof sendTest$1> & typeof sendTest$1>;
+declare const pauseScheduling: MaybeContext<BuildRESTFunction<typeof pauseScheduling$1> & typeof pauseScheduling$1>;
+declare const reschedule: MaybeContext<BuildRESTFunction<typeof reschedule$1> & typeof reschedule$1>;
+declare const deleteCampaign: MaybeContext<BuildRESTFunction<typeof deleteCampaign$1> & typeof deleteCampaign$1>;
+declare const reuseCampaign: MaybeContext<BuildRESTFunction<typeof reuseCampaign$1> & typeof reuseCampaign$1>;
+declare const getAudience: MaybeContext<BuildRESTFunction<typeof getAudience$1> & typeof getAudience$1>;
+declare const identifySenderAddress: MaybeContext<BuildRESTFunction<typeof identifySenderAddress$1> & typeof identifySenderAddress$1>;
+declare const listStatistics: MaybeContext<BuildRESTFunction<typeof listStatistics$1> & typeof listStatistics$1>;
+declare const listRecipients: MaybeContext<BuildRESTFunction<typeof listRecipients$1> & typeof listRecipients$1>;
+/**
+ * Triggered when a campaign is successfully distributed to all recipients.
+ */
+declare const onCampaignDistributedEvent: BuildEventDefinition<typeof onCampaignDistributedEvent$1>;
+/**
+ * Triggered when a scheduled campaign is paused.
+ */
+declare const onCampaignPausedEvent: BuildEventDefinition<typeof onCampaignPausedEvent$1>;
+/**
+ * Triggered when a draft campaign is published.
+ */
+declare const onCampaignPublishedEvent: BuildEventDefinition<typeof onCampaignPublishedEvent$1>;
+/**
+ * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
+ */
+declare const onCampaignRejectedEvent: BuildEventDefinition<typeof onCampaignRejectedEvent$1>;
+/**
+ * Triggered when a campaign is scheduled to be sent out at the specific time.
+ */
+declare const onCampaignScheduledEvent: BuildEventDefinition<typeof onCampaignScheduledEvent$1>;
+/**
+ * Triggered when the mailing list isn't clean and campaign was terminated.
+ */
+declare const onCampaignTerminatedEvent: BuildEventDefinition<typeof onCampaignTerminatedEvent$1>;
+/**
+ * Triggered when a campaign is created.
+ */
+declare const onCampaignCreated: BuildEventDefinition<typeof onCampaignCreated$1>;
+/**
+ * Triggered when a campaign is deleted.
+ */
+declare const onCampaignDeleted: BuildEventDefinition<typeof onCampaignDeleted$1>;
+/**
+ * Triggered when an email campaign has a new recipient activity.
+ */
+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, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest };

package/build/index.d.ts

@@ -0,0 +1,186 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetCampaignOptions, C as Campaign, L as ListCampaignsOptions, a as ListCampaignsResponse, P as PublishCampaignOptions, b as PublishCampaignResponse, S as SendTestOptions, R as ReuseCampaignResponse, c as GetAudienceResponse, I as IdentifySenderAddressResponse, d as ListStatisticsResponse, e as RecipientsActivityEnumWithLiterals, f as ListRecipientsOptions, g as ListRecipientsResponse, h as CampaignDistributedEnvelope, i as CampaignPausedEnvelope, j as CampaignPublishedEnvelope, k as CampaignRejectedEnvelope, l as CampaignScheduledEnvelope, m as CampaignTerminatedEnvelope, n as CampaignCreatedEnvelope, o as CampaignDeletedEnvelope, p as CampaignEmailActivityUpdatedEnvelope } from './email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.js';
+export { a_ as ActionEvent, A as ActivityType, at as ArchiveCampaignRequest, au as ArchiveCampaignResponse, av as Archived, ak as Attachment, bn as BaseEventMetadata, aS as CampaignAudience, aL as CampaignEditorType, q as CampaignEditorTypeEnum, bk as CampaignRecipientDetails, u as CampaignSendingStateEnum, y as CampaignStatistics, bh as CampaignStatisticsContainer, r as CampaignStatusEnum, v as CampaignTypeEnum, s as CampaignVisibilityStatusEnum, a5 as Click, aI as Composer, b8 as Contact, M as CountCampaignsRequest, N as CountCampaignsResponse, aN as CreateCampaignRequest, aO as CreateCampaignResponse, O as CreateFromTemplateRequest, Q as CreateFromTemplateResponse, X as CreateFromUserTemplateRequest, Y as CreateFromUserTemplateResponse, U as CreateUserTemplateRequest, V as CreateUserTemplateResponse, bj as CursorPaging, bm as Cursors, ag as DateTime, am as Decimal, aJ as DefaultValues, aB as DeleteCampaignRequest, aC as DeleteCampaignResponse, a2 as Distributed, D as DistributionStatistics, aU as DomainEvent, aV as DomainEventBodyOneOf, a3 as EmailActivityUpdated, a4 as EmailActivityUpdatedEventTypeOneOf, _ as EmailDistributionOptions, aW as EntityCreatedEvent, aZ as EntityDeletedEvent, aY as EntityUpdatedEvent, E as Enum, b4 as EstimateAudienceSizeRequest, b5 as EstimateAudienceSizeResponse, b2 as EstimateFilterSizeRequest, b3 as EstimateFilterSizeResponse, bo as EventMetadata, aR as GetAudienceRequest, F as GetCampaignRequest, H as GetCampaignResponse, aG as GetComposerRequest, aH as GetComposerResponse, bb as GetLabelsRequest, bc as GetLabelsResponse, a8 as HardBounce, ae as Html, b0 as IdentificationData, b1 as IdentificationDataIdOneOf, aT as IdentifySenderAddressRequest, al as Integer, bd as Label, z as LandingPageStatistics, J as ListCampaignsRequest, bi as ListRecipientsRequest, bg as ListStatisticsRequest, ah as Map, a$ as MessageEnvelope, af as Money, a6 as Open, K as Paging, bl as PagingMetadataV2, ao as PauseSchedulingRequest, ap as PauseSchedulingResponse, aq as Paused, ab as PlaceholderContent, aj as PlaceholderContentEnum, ac as PlaceholderContentValueOneOf, ad as PlainText, aE as PreviewCampaignRequest, aF as PreviewCampaignResponse, Z as PublishCampaignRequest, a0 as Published, x as PublishingData, w as RecipientsActivityEnum, b6 as ReconcileContactRequest, b7 as ReconcileContactResponse, $ as Rejected, B as RejectionData, t as RejectionReasonEnum, ar as RescheduleRequest, as as RescheduleResponse, aP as ResendToNonOpenersRequest, aQ as ResendToNonOpenersResponse, aX as RestoreInfo, aD as ReuseCampaignRequest, a9 as Scheduled, b9 as SearchContactsRequest, ba as SearchContactsResponse, aa as SendTestRequest, an as SendTestResponse, a7 as SoftBounce, be as SubscribeFromLandingPageRequest, bf as SubscribeFromLandingPageResponse, a1 as Terminated, T as TotalStatistics, aw as UnarchiveCampaignRequest, ax as UnarchiveCampaignResponse, ay as Unarchived, aK as UpdateComposerRequest, aM as UpdateComposerResponse, az as UpdateTitleRequest, aA as UpdateTitleResponse, W as WebhookIdentityType, ai as _Array } from './email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.js';
+
+declare function getCampaign$1(httpClient: HttpClient): GetCampaignSignature;
+interface GetCampaignSignature {
+    /**
+     * Retrieves information about an email campaign.
+     * @param - Campaign ID.
+     * @param - Options to use when getting a campaign.
+     * @returns Campaign information.
+     */
+    (campaignId: string, options?: GetCampaignOptions | undefined): Promise<Campaign>;
+}
+declare function listCampaigns$1(httpClient: HttpClient): ListCampaignsSignature;
+interface ListCampaignsSignature {
+    /**
+     * Retrieves a list of email campaigns.
+     *
+     * Default sorts by `dateUpdated` in `DESC` order.
+     * @param - Options to use when getting the list of campaigns.
+     */
+    (options?: ListCampaignsOptions | undefined): Promise<ListCampaignsResponse>;
+}
+declare function publishCampaign$1(httpClient: HttpClient): PublishCampaignSignature;
+interface PublishCampaignSignature {
+    /**
+     * Publishes and sends a specified campaign.
+     *
+     * If the `email_distribution_options` object isn't passed in the request, the campaign is only published as a landing page.
+     * @param - Campaign ID
+     * @param - Options to use when publishing a campaign.
+     */
+    (campaignId: string, options?: PublishCampaignOptions | undefined): Promise<PublishCampaignResponse>;
+}
+declare function sendTest$1(httpClient: HttpClient): SendTestSignature;
+interface SendTestSignature {
+    /**
+     * Sends a test email. Call this method to preview your email campaign.
+     *
+     * We strongly recommend calling this method only a few times in a row, as there is a rate limit to prevent abuse of the Send Test method.
+     * @param - Campaign ID.
+     * @param - Options for sending a test email.
+     */
+    (campaignId: string, options?: SendTestOptions | undefined): Promise<void>;
+}
+declare function pauseScheduling$1(httpClient: HttpClient): PauseSchedulingSignature;
+interface PauseSchedulingSignature {
+    /**
+     * Pauses a scheduled campaign.
+     * @param - Campaign ID.
+     */
+    (campaignId: string): Promise<void>;
+}
+declare function reschedule$1(httpClient: HttpClient): RescheduleSignature;
+interface RescheduleSignature {
+    /**
+     * Changes the sending time for an already scheduled campaign.
+     * @param - ID of the campaign to reschedule.
+     * @param - New time for sending out the campaign.
+     */
+    (campaignId: string, sendAt: Date): Promise<void>;
+}
+declare function deleteCampaign$1(httpClient: HttpClient): DeleteCampaignSignature;
+interface DeleteCampaignSignature {
+    /**
+     * Permanently deletes a campaign.
+     * @param - Campaign ID.
+     */
+    (campaignId: string): Promise<void>;
+}
+declare function reuseCampaign$1(httpClient: HttpClient): ReuseCampaignSignature;
+interface ReuseCampaignSignature {
+    /**
+     * Creates a copy of an existing campaign.
+     * @param - ID of the message to be duplicated.
+     */
+    (campaignId: string): Promise<ReuseCampaignResponse>;
+}
+declare function getAudience$1(httpClient: HttpClient): GetAudienceSignature;
+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<GetAudienceResponse>;
+}
+declare function identifySenderAddress$1(httpClient: HttpClient): IdentifySenderAddressSignature;
+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<IdentifySenderAddressResponse>;
+}
+declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
+interface ListStatisticsSignature {
+    /**
+     * 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.
+     *
+     * 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 - IDs of the campaigns to retrieve (max 100 campaigns).
+     */
+    (campaignIds: string[]): Promise<ListStatisticsResponse>;
+}
+declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
+interface ListRecipientsSignature {
+    /**
+     * 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 - Campaign ID.
+     * @param - Email activity to filter.
+     * @param - Options to use when getting the list of recipients.
+     */
+    (campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions | undefined): Promise<ListRecipientsResponse>;
+}
+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">;
+declare const onCampaignPublishedEvent$1: EventDefinition<CampaignPublishedEnvelope, "wix.email_marketing.v1.campaign_campaign_published_event">;
+declare const onCampaignRejectedEvent$1: EventDefinition<CampaignRejectedEnvelope, "wix.email_marketing.v1.campaign_campaign_rejected_event">;
+declare const onCampaignScheduledEvent$1: EventDefinition<CampaignScheduledEnvelope, "wix.email_marketing.v1.campaign_campaign_scheduled_event">;
+declare const onCampaignTerminatedEvent$1: EventDefinition<CampaignTerminatedEnvelope, "wix.email_marketing.v1.campaign_campaign_terminated_event">;
+declare const onCampaignCreated$1: EventDefinition<CampaignCreatedEnvelope, "wix.email_marketing.v1.campaign_created">;
+declare const onCampaignDeleted$1: EventDefinition<CampaignDeletedEnvelope, "wix.email_marketing.v1.campaign_deleted">;
+declare const onCampaignEmailActivityUpdated$1: EventDefinition<CampaignEmailActivityUpdatedEnvelope, "wix.email_marketing.v1.campaign_email_activity_updated">;
+
+declare const getCampaign: MaybeContext<BuildRESTFunction<typeof getCampaign$1> & typeof getCampaign$1>;
+declare const listCampaigns: MaybeContext<BuildRESTFunction<typeof listCampaigns$1> & typeof listCampaigns$1>;
+declare const publishCampaign: MaybeContext<BuildRESTFunction<typeof publishCampaign$1> & typeof publishCampaign$1>;
+declare const sendTest: MaybeContext<BuildRESTFunction<typeof sendTest$1> & typeof sendTest$1>;
+declare const pauseScheduling: MaybeContext<BuildRESTFunction<typeof pauseScheduling$1> & typeof pauseScheduling$1>;
+declare const reschedule: MaybeContext<BuildRESTFunction<typeof reschedule$1> & typeof reschedule$1>;
+declare const deleteCampaign: MaybeContext<BuildRESTFunction<typeof deleteCampaign$1> & typeof deleteCampaign$1>;
+declare const reuseCampaign: MaybeContext<BuildRESTFunction<typeof reuseCampaign$1> & typeof reuseCampaign$1>;
+declare const getAudience: MaybeContext<BuildRESTFunction<typeof getAudience$1> & typeof getAudience$1>;
+declare const identifySenderAddress: MaybeContext<BuildRESTFunction<typeof identifySenderAddress$1> & typeof identifySenderAddress$1>;
+declare const listStatistics: MaybeContext<BuildRESTFunction<typeof listStatistics$1> & typeof listStatistics$1>;
+declare const listRecipients: MaybeContext<BuildRESTFunction<typeof listRecipients$1> & typeof listRecipients$1>;
+/**
+ * Triggered when a campaign is successfully distributed to all recipients.
+ */
+declare const onCampaignDistributedEvent: BuildEventDefinition<typeof onCampaignDistributedEvent$1>;
+/**
+ * Triggered when a scheduled campaign is paused.
+ */
+declare const onCampaignPausedEvent: BuildEventDefinition<typeof onCampaignPausedEvent$1>;
+/**
+ * Triggered when a draft campaign is published.
+ */
+declare const onCampaignPublishedEvent: BuildEventDefinition<typeof onCampaignPublishedEvent$1>;
+/**
+ * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
+ */
+declare const onCampaignRejectedEvent: BuildEventDefinition<typeof onCampaignRejectedEvent$1>;
+/**
+ * Triggered when a campaign is scheduled to be sent out at the specific time.
+ */
+declare const onCampaignScheduledEvent: BuildEventDefinition<typeof onCampaignScheduledEvent$1>;
+/**
+ * Triggered when the mailing list isn't clean and campaign was terminated.
+ */
+declare const onCampaignTerminatedEvent: BuildEventDefinition<typeof onCampaignTerminatedEvent$1>;
+/**
+ * Triggered when a campaign is created.
+ */
+declare const onCampaignCreated: BuildEventDefinition<typeof onCampaignCreated$1>;
+/**
+ * Triggered when a campaign is deleted.
+ */
+declare const onCampaignDeleted: BuildEventDefinition<typeof onCampaignDeleted$1>;
+/**
+ * Triggered when an email campaign has a new recipient activity.
+ */
+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, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest };