@wix/auto_sdk_email-marketing_campaigns 1.0.17 → 1.0.19

package/build/internal/meta.d.ts

@@ -0,0 +1,510 @@
+import { F as GetCampaignRequest$1, H as GetCampaignResponse$1, J as ListCampaignsRequest$1, a as ListCampaignsResponse$1, Z as PublishCampaignRequest$1, b as PublishCampaignResponse$1, aa as SendTestRequest$1, an as SendTestResponse$1, ao as PauseSchedulingRequest$1, ap as PauseSchedulingResponse$1, ar as RescheduleRequest$1, as as RescheduleResponse$1, aB as DeleteCampaignRequest$1, aC as DeleteCampaignResponse$1, aD as ReuseCampaignRequest$1, R as ReuseCampaignResponse$1, aR as GetAudienceRequest$1, c as GetAudienceResponse$1, aT as IdentifySenderAddressRequest$1, I as IdentifySenderAddressResponse$1, bg as ListStatisticsRequest$1, d as ListStatisticsResponse$1, bi as ListRecipientsRequest$1, g as ListRecipientsResponse$1 } from './email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.js';
+
+interface Campaign {
+    /**
+     * 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.
+     * @format WEB_URL
+     */
+    firstImageUrl?: string | null;
+    /** Editor type. */
+    editorType?: CampaignEditorTypeEnumWithLiterals;
+    /** Campaign status. */
+    status?: CampaignStatusEnumWithLiterals;
+    /** Campaign visibility status. */
+    visibilityStatus?: CampaignVisibilityStatusEnumWithLiterals;
+    /** Campaign distribution status. */
+    distributionStatus?: EnumWithLiterals;
+    /** Publishing data. The field is returned empty if the campaign isn't published. */
+    publishingData?: PublishingData;
+    /** Date and time when the campaign was created. */
+    dateCreated?: Date | null;
+    /** Date and time when the campaign was updated. */
+    dateUpdated?: Date | null;
+    /**
+     * Email subject of the campaign (initially copied from the template).
+     * @maxLength 1000
+     * @deprecated
+     */
+    emailSubject?: string;
+}
+declare enum CampaignEditorTypeEnum {
+    /** Unknown editor. This value isn't used. */
+    UNKNOWN = "UNKNOWN",
+    /** Classic web editor. */
+    WEB = "WEB",
+    /** Classic mobile editor. */
+    MOBILE = "MOBILE",
+    /** Chat (AI) based web editor. */
+    MJML = "MJML"
+}
+/** @enumType */
+type CampaignEditorTypeEnumWithLiterals = CampaignEditorTypeEnum | 'UNKNOWN' | 'WEB' | 'MOBILE' | 'MJML';
+declare enum CampaignStatusEnum {
+    /** Unknown campaign. This value isn't used. */
+    UNKNOWN = "UNKNOWN",
+    /** Campaign is active. */
+    ACTIVE = "ACTIVE",
+    /** Campaign is archived. */
+    ARCHIVED = "ARCHIVED",
+    /** Campaign is deleted. */
+    DELETED = "DELETED"
+}
+/** @enumType */
+type CampaignStatusEnumWithLiterals = CampaignStatusEnum | 'UNKNOWN' | 'ACTIVE' | 'ARCHIVED' | 'DELETED';
+declare enum CampaignVisibilityStatusEnum {
+    /** Unknown status. This value isn't used. */
+    UNKNOWN = "UNKNOWN",
+    /** Campaign isn't published yet. */
+    DRAFT = "DRAFT",
+    /** Campaign is published. */
+    PUBLISHED = "PUBLISHED",
+    /** Campaign is a template. */
+    TEMPLATE = "TEMPLATE"
+}
+/** @enumType */
+type CampaignVisibilityStatusEnumWithLiterals = CampaignVisibilityStatusEnum | 'UNKNOWN' | 'DRAFT' | 'PUBLISHED' | 'TEMPLATE';
+declare enum Enum {
+    /** Unknown distribution status. */
+    UNKNOWN = "UNKNOWN",
+    /** Campaign isn't distributed to recipients yet. */
+    NOT_STARTED = "NOT_STARTED",
+    /** Campaign is scheduled for distribution. */
+    SCHEDULED = "SCHEDULED",
+    /** Campaign is in screening for malicious content. */
+    IN_DETECTION = "IN_DETECTION",
+    /** Campaign is in review by the site moderators. */
+    IN_MODERATION = "IN_MODERATION",
+    /** Several recipients are selected for campaign testing, and campaign is sent out to them. */
+    SAMPLING = "SAMPLING",
+    /** Campaign is being sent out to all recipients. */
+    SENDING = "SENDING",
+    /** Campaign is rejected. */
+    REJECTED = "REJECTED",
+    /** Campaign is terminated after a failed sampling test. */
+    TERMINATED = "TERMINATED",
+    /** Campaign is fully distributed to all recipients. */
+    DISTRIBUTED = "DISTRIBUTED",
+    /** Scheduled campaign is paused. */
+    PAUSED = "PAUSED"
+}
+/** @enumType */
+type EnumWithLiterals = Enum | 'UNKNOWN' | 'NOT_STARTED' | 'SCHEDULED' | 'IN_DETECTION' | 'IN_MODERATION' | 'SAMPLING' | 'SENDING' | 'REJECTED' | 'TERMINATED' | 'DISTRIBUTED' | 'PAUSED';
+interface PublishingData {
+    /**
+     * Landing page URL.
+     * @format WEB_URL
+     */
+    landingPageUrl?: string;
+    /** Marketing campaign statistics. */
+    statistics?: CampaignStatistics;
+    /** Marketing campaign publish date. */
+    datePublished?: Date | null;
+}
+interface CampaignStatistics {
+    /** Landing page statistics of a marketing campaign. */
+    landingPage?: LandingPageStatistics;
+    /** Email distribution statistics of a marketing campaign. */
+    emailCampaign?: DistributionStatistics;
+    /** Combined statistics of landing page and email distribution. */
+    total?: TotalStatistics;
+}
+interface LandingPageStatistics {
+    /** Number of times when a landing page was loaded or viewed. */
+    opened?: number;
+    /** Number of times a link was clicked in a landing page. */
+    clicked?: number;
+}
+interface DistributionStatistics {
+    /** Number of delivered emails. */
+    delivered?: number;
+    /**
+     * Number of recipients who opened an email.
+     *
+     * If the same recipient opened the same email twice, it is counted as a one unique open.
+     */
+    opened?: number;
+    /**
+     * Number of recipients who clicked a link in the email.
+     *
+     * If the same recipient clicked the same link twice, it is counted as a one unique click.
+     *
+     * If the same recipient clicked different links, it is counted as a one unique click.
+     */
+    clicked?: number;
+    /** Number of emails that didn't reach the recipient. */
+    bounced?: number;
+    /** Number of recipients who reported the email as a spam. */
+    complained?: number;
+    /** Number of emails that weren't sent due to the campaign termination. */
+    notSent?: number;
+}
+interface TotalStatistics {
+    /** Total number of emails sent. */
+    mailsSent?: number;
+    /** Number of landing page views and opened emails. */
+    opened?: number;
+    /** Number of landing page and email link clicks. */
+    clicked?: number;
+}
+interface GetCampaignRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /**
+     * Whether a returned campaign should include `publishingData.statistics`.
+     *
+     * Default: `false`.
+     */
+    optionIncludeStatistics?: boolean;
+}
+interface GetCampaignResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+interface ListCampaignsRequest {
+    /** Paging parameters. */
+    paging?: Paging;
+    /**
+     * Whether to include `publishingData.statistics` in the returned campaign object.
+     *
+     * Default: `false`.
+     */
+    optionIncludeStatistics?: boolean;
+    /** Campaign status. */
+    statuses?: CampaignStatusEnumWithLiterals[];
+    /** Visibility status. */
+    visibilityStatuses?: CampaignVisibilityStatusEnumWithLiterals[];
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface ListCampaignsResponse {
+    /** Paging parameters. */
+    paging?: Paging;
+    /** List of campaigns. */
+    campaigns?: Campaign[];
+}
+interface PublishCampaignRequest {
+    /**
+     * 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;
+}
+interface EmailDistributionOptions {
+    /**
+     * 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.
+     * @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
+     */
+    filterIds?: string[];
+    /** Campaign scheduling. You can schedule the campaign no less than 30 minutes until the sending time. [Upgrade your plan](https://support.wix.com/en/article/email-marketing-upgrading-your-email-marketing-plan) to schedule the campaign. */
+    sendAt?: Date | null;
+}
+interface PublishCampaignResponse {
+    /** Publishing info. */
+    publishingData?: PublishingData;
+}
+interface SendTestRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /**
+     * Email subject.
+     * @maxLength 1000
+     */
+    emailSubject?: string | null;
+    /**
+     * Recipient email address.
+     * @format EMAIL
+     */
+    toEmailAddress: string;
+}
+interface SendTestResponse {
+}
+interface PauseSchedulingRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+}
+interface PauseSchedulingResponse {
+}
+interface RescheduleRequest {
+    /**
+     * ID of the campaign to reschedule.
+     * @format GUID
+     */
+    campaignId: string;
+    /** New time for sending out the campaign. */
+    sendAt: Date | null;
+}
+interface RescheduleResponse {
+}
+interface DeleteCampaignRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+}
+interface DeleteCampaignResponse {
+}
+interface ReuseCampaignRequest {
+    /**
+     * ID of the message to be duplicated.
+     * @format GUID
+     */
+    campaignId: string;
+}
+interface ReuseCampaignResponse {
+    /** Campaign information. */
+    campaign?: Campaign;
+}
+interface GetAudienceRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+}
+interface GetAudienceResponse {
+    /** Campaign audience. */
+    audience?: CampaignAudience;
+}
+interface CampaignAudience {
+    /**
+     * IDs of contacts to whom to send the campaign.
+     * @format GUID
+     * @maxSize 100
+     */
+    contactIds?: string[];
+    /**
+     * Labels IDs.
+     * @maxLength 100
+     * @maxSize 20
+     */
+    labelIds?: string[];
+    /**
+     * 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).
+     * @minLength 1
+     * @maxLength 100
+     */
+    contactsSearchTerm?: string | null;
+    /** Should "inactive" contacts be excluded or not. */
+    activeContactsOnly?: boolean;
+}
+interface IdentifySenderAddressRequest {
+    /**
+     * Email address to verify.
+     * @format EMAIL
+     * @minLength 6
+     * @maxLength 254
+     */
+    emailAddress: string;
+}
+interface IdentifySenderAddressResponse {
+    /**
+     * Actual "from" address that will be used for sending emails.
+     * @format EMAIL
+     * @minLength 6
+     * @maxLength 254
+     */
+    senderAddress?: string;
+}
+interface ListStatisticsRequest {
+    /**
+     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    campaignIds: string[];
+}
+interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
+}
+interface CampaignStatisticsContainer {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
+}
+interface ListRecipientsRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /** Email activity to filter. */
+    activity: RecipientsActivityEnumWithLiterals;
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+declare enum RecipientsActivityEnum {
+    UNKNOWN = "UNKNOWN",
+    DELIVERED = "DELIVERED",
+    OPENED = "OPENED",
+    CLICKED = "CLICKED",
+    BOUNCED = "BOUNCED",
+    NOT_SENT = "NOT_SENT",
+    SENT = "SENT",
+    NOT_OPENED = "NOT_OPENED"
+}
+/** @enumType */
+type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
+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.
+     * @maxLength 1000
+     */
+    cursor?: string | null;
+}
+interface ListRecipientsResponse {
+    /** List of recipients. */
+    recipients?: CampaignRecipientDetails[];
+    /** Details on the paged set of returned results. */
+    pagingMetadata?: PagingMetadataV2;
+}
+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;
+}
+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;
+}
+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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getCampaign(): __PublicMethodMetaInfo<'GET', {
+    campaignId: string;
+}, GetCampaignRequest$1, GetCampaignRequest, GetCampaignResponse$1, GetCampaignResponse>;
+declare function listCampaigns(): __PublicMethodMetaInfo<'GET', {}, ListCampaignsRequest$1, ListCampaignsRequest, ListCampaignsResponse$1, ListCampaignsResponse>;
+declare function publishCampaign(): __PublicMethodMetaInfo<'POST', {
+    campaignId: string;
+}, PublishCampaignRequest$1, PublishCampaignRequest, PublishCampaignResponse$1, PublishCampaignResponse>;
+declare function sendTest(): __PublicMethodMetaInfo<'POST', {
+    campaignId: string;
+}, SendTestRequest$1, SendTestRequest, SendTestResponse$1, SendTestResponse>;
+declare function pauseScheduling(): __PublicMethodMetaInfo<'POST', {
+    campaignId: string;
+}, PauseSchedulingRequest$1, PauseSchedulingRequest, PauseSchedulingResponse$1, PauseSchedulingResponse>;
+declare function reschedule(): __PublicMethodMetaInfo<'POST', {
+    campaignId: string;
+}, RescheduleRequest$1, RescheduleRequest, RescheduleResponse$1, RescheduleResponse>;
+declare function deleteCampaign(): __PublicMethodMetaInfo<'DELETE', {
+    campaignId: string;
+}, DeleteCampaignRequest$1, DeleteCampaignRequest, DeleteCampaignResponse$1, DeleteCampaignResponse>;
+declare function reuseCampaign(): __PublicMethodMetaInfo<'POST', {
+    campaignId: string;
+}, ReuseCampaignRequest$1, ReuseCampaignRequest, ReuseCampaignResponse$1, ReuseCampaignResponse>;
+declare function getAudience(): __PublicMethodMetaInfo<'POST', {
+    campaignId: string;
+}, GetAudienceRequest$1, GetAudienceRequest, GetAudienceResponse$1, GetAudienceResponse>;
+declare function identifySenderAddress(): __PublicMethodMetaInfo<'POST', {}, IdentifySenderAddressRequest$1, IdentifySenderAddressRequest, IdentifySenderAddressResponse$1, IdentifySenderAddressResponse>;
+declare function listStatistics(): __PublicMethodMetaInfo<'GET', {}, ListStatisticsRequest$1, ListStatisticsRequest, ListStatisticsResponse$1, ListStatisticsResponse>;
+declare function listRecipients(): __PublicMethodMetaInfo<'GET', {
+    campaignId: string;
+}, ListRecipientsRequest$1, ListRecipientsRequest, ListRecipientsResponse$1, ListRecipientsResponse>;
+
+export { type __PublicMethodMetaInfo, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest };