@wix/auto_sdk_email-marketing_campaigns 1.0.16 → 1.0.18

package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js

@@ -1,765 +0,0 @@
-import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
-import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
-import * as ambassadorWixEmailMarketingV1Campaign from './email-marketing-v1-campaign-campaigns.http.js';
-export var CampaignEditorTypeEnum;
-(function (CampaignEditorTypeEnum) {
-    /** Unknown editor. This value isn't used. */
-    CampaignEditorTypeEnum["UNKNOWN"] = "UNKNOWN";
-    /** Classic web editor. */
-    CampaignEditorTypeEnum["WEB"] = "WEB";
-    /** Classic mobile editor. */
-    CampaignEditorTypeEnum["MOBILE"] = "MOBILE";
-    /** Chat (AI) based web editor. */
-    CampaignEditorTypeEnum["MJML"] = "MJML";
-})(CampaignEditorTypeEnum || (CampaignEditorTypeEnum = {}));
-export var CampaignStatusEnum;
-(function (CampaignStatusEnum) {
-    /** Unknown campaign. This value isn't used. */
-    CampaignStatusEnum["UNKNOWN"] = "UNKNOWN";
-    /** Campaign is active. */
-    CampaignStatusEnum["ACTIVE"] = "ACTIVE";
-    /** Campaign is archived. */
-    CampaignStatusEnum["ARCHIVED"] = "ARCHIVED";
-    /** Campaign is deleted. */
-    CampaignStatusEnum["DELETED"] = "DELETED";
-})(CampaignStatusEnum || (CampaignStatusEnum = {}));
-export var CampaignVisibilityStatusEnum;
-(function (CampaignVisibilityStatusEnum) {
-    /** Unknown status. This value isn't used. */
-    CampaignVisibilityStatusEnum["UNKNOWN"] = "UNKNOWN";
-    /** Campaign isn't published yet. */
-    CampaignVisibilityStatusEnum["DRAFT"] = "DRAFT";
-    /** Campaign is published. */
-    CampaignVisibilityStatusEnum["PUBLISHED"] = "PUBLISHED";
-    /** Campaign is a template. */
-    CampaignVisibilityStatusEnum["TEMPLATE"] = "TEMPLATE";
-})(CampaignVisibilityStatusEnum || (CampaignVisibilityStatusEnum = {}));
-export var Enum;
-(function (Enum) {
-    /** Unknown distribution status. */
-    Enum["UNKNOWN"] = "UNKNOWN";
-    /** Campaign isn't distributed to recipients yet. */
-    Enum["NOT_STARTED"] = "NOT_STARTED";
-    /** Campaign is scheduled for distribution. */
-    Enum["SCHEDULED"] = "SCHEDULED";
-    /** Campaign is in screening for malicious content. */
-    Enum["IN_DETECTION"] = "IN_DETECTION";
-    /** Campaign is in review by the site moderators. */
-    Enum["IN_MODERATION"] = "IN_MODERATION";
-    /** Several recipients are selected for campaign testing, and campaign is sent out to them. */
-    Enum["SAMPLING"] = "SAMPLING";
-    /** Campaign is being sent out to all recipients. */
-    Enum["SENDING"] = "SENDING";
-    /** Campaign is rejected. */
-    Enum["REJECTED"] = "REJECTED";
-    /** Campaign is terminated after a failed sampling test. */
-    Enum["TERMINATED"] = "TERMINATED";
-    /** Campaign is fully distributed to all recipients. */
-    Enum["DISTRIBUTED"] = "DISTRIBUTED";
-    /** Scheduled campaign is paused. */
-    Enum["PAUSED"] = "PAUSED";
-})(Enum || (Enum = {}));
-export var RejectionReasonEnum;
-(function (RejectionReasonEnum) {
-    RejectionReasonEnum["UNKNOWN"] = "UNKNOWN";
-    RejectionReasonEnum["LOW_ENGAGEMENT"] = "LOW_ENGAGEMENT";
-    RejectionReasonEnum["SENDER_DETAILS"] = "SENDER_DETAILS";
-    RejectionReasonEnum["SPAM_TRAPS"] = "SPAM_TRAPS";
-    RejectionReasonEnum["OTHER"] = "OTHER";
-    RejectionReasonEnum["ADULT_SEXUAL_CONTENT"] = "ADULT_SEXUAL_CONTENT";
-    RejectionReasonEnum["AFFILIATE_MARKETING"] = "AFFILIATE_MARKETING";
-    RejectionReasonEnum["BETTING_OR_GAMBLING"] = "BETTING_OR_GAMBLING";
-    RejectionReasonEnum["CREDIT_REPAIR_OR_DEBT_RELIEF"] = "CREDIT_REPAIR_OR_DEBT_RELIEF";
-    RejectionReasonEnum["GET_RICH_QUICK_SCHEME"] = "GET_RICH_QUICK_SCHEME";
-    RejectionReasonEnum["ILLEGAL_SUBSTANCES_OR_WEAPONS"] = "ILLEGAL_SUBSTANCES_OR_WEAPONS";
-    RejectionReasonEnum["MISLEADING_SUBJECT_LINE"] = "MISLEADING_SUBJECT_LINE";
-    RejectionReasonEnum["TRADING_OR_CRYPTOCURRENCIES"] = "TRADING_OR_CRYPTOCURRENCIES";
-    RejectionReasonEnum["UNSOLICITED_CONTENT"] = "UNSOLICITED_CONTENT";
-})(RejectionReasonEnum || (RejectionReasonEnum = {}));
-export var CampaignSendingStateEnum;
-(function (CampaignSendingStateEnum) {
-    /** Campaign not yet published. */
-    CampaignSendingStateEnum["DRAFT"] = "DRAFT";
-    /** Campaign is being reviewed. */
-    CampaignSendingStateEnum["REVIEW"] = "REVIEW";
-    /** Campaign was rejected. */
-    CampaignSendingStateEnum["REJECTED"] = "REJECTED";
-    /** Campaign is scheduled. */
-    CampaignSendingStateEnum["SCHEDULED"] = "SCHEDULED";
-    /** Scheduled campaign was paused. */
-    CampaignSendingStateEnum["PAUSED"] = "PAUSED";
-    /** Campaign is published. */
-    CampaignSendingStateEnum["PUBLISHED"] = "PUBLISHED";
-    /** Campaign is being send. */
-    CampaignSendingStateEnum["SENDING"] = "SENDING";
-    /**
-     * Campaign was partially sent.
-     * Happens when too many recipients bounce.
-     */
-    CampaignSendingStateEnum["PARTIALLY_SENT"] = "PARTIALLY_SENT";
-    /** Campaign was sent. */
-    CampaignSendingStateEnum["SENT"] = "SENT";
-})(CampaignSendingStateEnum || (CampaignSendingStateEnum = {}));
-export var CampaignTypeEnum;
-(function (CampaignTypeEnum) {
-    CampaignTypeEnum["UNKNOWN"] = "UNKNOWN";
-    /** Email marketing campaign. */
-    CampaignTypeEnum["EMAIL_MARKETING"] = "EMAIL_MARKETING";
-    /** Mobile place invitation email. */
-    CampaignTypeEnum["INVITATION"] = "INVITATION";
-    /** Automation campaign. */
-    CampaignTypeEnum["AUTOMATION"] = "AUTOMATION";
-    /** Triggered email. */
-    CampaignTypeEnum["TRIGGERED"] = "TRIGGERED";
-})(CampaignTypeEnum || (CampaignTypeEnum = {}));
-export var RecipientsActivityEnum;
-(function (RecipientsActivityEnum) {
-    RecipientsActivityEnum["UNKNOWN"] = "UNKNOWN";
-    RecipientsActivityEnum["DELIVERED"] = "DELIVERED";
-    RecipientsActivityEnum["OPENED"] = "OPENED";
-    RecipientsActivityEnum["CLICKED"] = "CLICKED";
-    RecipientsActivityEnum["BOUNCED"] = "BOUNCED";
-    RecipientsActivityEnum["NOT_SENT"] = "NOT_SENT";
-    RecipientsActivityEnum["SENT"] = "SENT";
-    RecipientsActivityEnum["NOT_OPENED"] = "NOT_OPENED";
-})(RecipientsActivityEnum || (RecipientsActivityEnum = {}));
-/** The type of email activity that triggered the webhook. */
-export var ActivityType;
-(function (ActivityType) {
-    /** Triggered when an email is delivered to the recipient. */
-    ActivityType["DELIVERY"] = "DELIVERY";
-    /** Triggered when the recipient clicks on a URL inside of the email. */
-    ActivityType["CLICK"] = "CLICK";
-    /** Triggered when the email is opened by the recipient. */
-    ActivityType["OPEN"] = "OPEN";
-    /** Triggered when the email is bounced softly. */
-    ActivityType["SOFT_BOUNCE"] = "SOFT_BOUNCE";
-    /** Triggered when the email bounces. */
-    ActivityType["HARD_BOUNCED"] = "HARD_BOUNCED";
-})(ActivityType || (ActivityType = {}));
-export var WebhookIdentityType;
-(function (WebhookIdentityType) {
-    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
-    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
-    WebhookIdentityType["MEMBER"] = "MEMBER";
-    WebhookIdentityType["WIX_USER"] = "WIX_USER";
-    WebhookIdentityType["APP"] = "APP";
-})(WebhookIdentityType || (WebhookIdentityType = {}));
-/**
- * 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 campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
- * @public
- * @requiredField campaignIds
- * @permissionId Shoutout.Read
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Read Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
- */
-export async function listStatistics(campaignIds) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignIds: campaignIds,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.listStatistics(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { campaignIds: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['campaignIds']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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 campaignId - Campaign ID.
- * @param activity - Email activity to filter.
- * @public
- * @requiredField activity
- * @requiredField campaignId
- * @param options - Options to use when getting the list of recipients.
- * @permissionId Shoutout.Read
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Read Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
- */
-export async function listRecipients(campaignId, activity, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[3];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-        activity: activity,
-        paging: options?.paging,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.listRecipients(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                campaignId: '$[0]',
-                activity: '$[1]',
-                paging: '$[2].paging',
-            },
-            singleArgumentUnchanged: false,
-        }, ['campaignId', 'activity', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Retrieves information about an email campaign.
- * @param campaignId - Campaign ID.
- * @public
- * @requiredField campaignId
- * @param options - Options to use when getting a campaign.
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @returns Campaign information.
- * @fqn wix.emailmarketing.api.v1.CampaignService.Get
- */
-export async function getCampaign(campaignId, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-        optionIncludeStatistics: options?.optionIncludeStatistics,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.get(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data)?.campaign;
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                campaignId: '$[0]',
-                optionIncludeStatistics: '$[1].optionIncludeStatistics',
-            },
-            singleArgumentUnchanged: false,
-        }, ['campaignId', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Retrieves a list of email campaigns.
- *
- * Default sorts by `dateUpdated` in `DESC` order.
- * @public
- * @param options - Options to use when getting the list of campaigns.
- * @permissionId Shoutout.Read
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Read Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.List
- */
-export async function listCampaigns(options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        paging: options?.paging,
-        optionIncludeStatistics: options?.optionIncludeStatistics,
-        statuses: options?.statuses,
-        visibilityStatuses: options?.visibilityStatuses,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.list(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                paging: '$[0].paging',
-                optionIncludeStatistics: '$[0].optionIncludeStatistics',
-                statuses: '$[0].statuses',
-                visibilityStatuses: '$[0].visibilityStatuses',
-            },
-            singleArgumentUnchanged: false,
-        }, ['options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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 campaignId - Campaign ID
- * @public
- * @requiredField campaignId
- * @param options - Options to use when publishing a campaign.
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.Publish
- */
-export async function publishCampaign(campaignId, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-        emailDistributionOptions: options?.emailDistributionOptions,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.publish(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                campaignId: '$[0]',
-                emailDistributionOptions: '$[1].emailDistributionOptions',
-            },
-            singleArgumentUnchanged: false,
-        }, ['campaignId', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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 campaignId - Campaign ID.
- * @public
- * @requiredField campaignId
- * @requiredField options.toEmailAddress
- * @param options - Options for sending a test email.
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
- */
-export async function sendTest(campaignId, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-        emailSubject: options?.emailSubject,
-        toEmailAddress: options?.toEmailAddress,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.sendTest(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                campaignId: '$[0]',
-                emailSubject: '$[1].emailSubject',
-                toEmailAddress: '$[1].toEmailAddress',
-            },
-            singleArgumentUnchanged: false,
-        }, ['campaignId', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Pauses a scheduled campaign.
- * @param campaignId - Campaign ID.
- * @public
- * @requiredField campaignId
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.PauseScheduling
- */
-export async function pauseScheduling(campaignId) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.pauseScheduling(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { campaignId: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['campaignId']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Changes the sending time for an already scheduled campaign.
- * @param campaignId - ID of the campaign to reschedule.
- * @param sendAt - New time for sending out the campaign.
- * @public
- * @requiredField campaignId
- * @requiredField sendAt
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.Reschedule
- */
-export async function reschedule(campaignId, sendAt) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-        sendAt: sendAt,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.reschedule(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { campaignId: '$[0]', sendAt: '$[1]' },
-            singleArgumentUnchanged: false,
-        }, ['campaignId', 'sendAt']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Permanently deletes a campaign.
- * @param campaignId - Campaign ID.
- * @public
- * @requiredField campaignId
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService._delete
- */
-export async function deleteCampaign(campaignId) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign._delete(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { campaignId: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['campaignId']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Creates a copy of an existing campaign.
- * @param campaignId - ID of the message to be duplicated.
- * @public
- * @requiredField campaignId
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
- */
-export async function reuseCampaign(campaignId) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.reuse(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { campaignId: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['campaignId']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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.
- * @public
- * @requiredField campaignId
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
- */
-export async function getAudience(campaignId) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        campaignId: campaignId,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.getAudience(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { campaignId: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['campaignId']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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.
- * @public
- * @requiredField emailAddress
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
- */
-export async function identifySenderAddress(emailAddress) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        emailAddress: emailAddress,
-    });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.identifySenderAddress(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { emailAddress: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['emailAddress']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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.
- *
- * If you provide a link as a placeholder, it's returned in a response as valid.
- * @param url - URL to validate.
- * @public
- * @requiredField url
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
- */
-export async function validateLink(url) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({ url: url });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.validateLink(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { url: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['url']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * 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.
- * @public
- * @requiredField html
- * @permissionId Shoutout.Manage
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Access Verticals by Automations
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionScope Manage Email Marketing
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
- * @applicableIdentity APP
- * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
- */
-export async function validateHtmlLinks(html) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({ html: html });
-    const reqOpts = ambassadorWixEmailMarketingV1Campaign.validateHtmlLinks(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { html: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['html']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-//# sourceMappingURL=email-marketing-v1-campaign-campaigns.universal.js.map