@wix/auto_sdk_email-marketing_campaigns 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +2 -2
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js +1 -10
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js +1 -10
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts +6 -258
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js +1 -59
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +70 -258
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +29 -59
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +2 -2
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.js +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.js +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.d.ts +6 -258
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.js +0 -58
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +70 -258
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js +28 -58
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +2 -2
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js +1 -10
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js +1 -10
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts +6 -258
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js +1 -59
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +70 -258
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +29 -59
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +2 -2
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.d.ts +6 -258
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js +0 -58
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +70 -258
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js +28 -58
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -463,264 +463,6 @@ export interface GetPingCampaignMappingRequest {
|
|
|
463
463
|
export interface GetPingCampaignMappingResponse {
|
|
464
464
|
campaignId?: string;
|
|
465
465
|
}
|
|
466
|
-
export interface QueryAutomationTemplatesRequest {
|
|
467
|
-
/** https://github.com/wix-private/p13n/blob/master/protos/query/src/main/proto/wix/common/query.proto */
|
|
468
|
-
query?: Query;
|
|
469
|
-
}
|
|
470
|
-
export interface Query {
|
|
471
|
-
/**
|
|
472
|
-
* Filter object in the following format:
|
|
473
|
-
* `"filter" : {
|
|
474
|
-
* "fieldName1": "value1",
|
|
475
|
-
* "fieldName2":{"$operator":"value2"}
|
|
476
|
-
* }`
|
|
477
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
478
|
-
*/
|
|
479
|
-
filter?: any;
|
|
480
|
-
/**
|
|
481
|
-
* Sort object in the following format:
|
|
482
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
483
|
-
*/
|
|
484
|
-
sort?: Sorting[];
|
|
485
|
-
/** Paging options to limit and skip the number of items. */
|
|
486
|
-
paging?: Paging;
|
|
487
|
-
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
488
|
-
fields?: string[];
|
|
489
|
-
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
490
|
-
fieldsets?: string[];
|
|
491
|
-
}
|
|
492
|
-
export interface Sorting {
|
|
493
|
-
/** Name of the field to sort by. */
|
|
494
|
-
fieldName?: string;
|
|
495
|
-
/** Sort order. */
|
|
496
|
-
order?: SortOrder;
|
|
497
|
-
}
|
|
498
|
-
export declare enum SortOrder {
|
|
499
|
-
ASC = "ASC",
|
|
500
|
-
DESC = "DESC"
|
|
501
|
-
}
|
|
502
|
-
export interface Paging {
|
|
503
|
-
/** Number of items to load. */
|
|
504
|
-
limit?: number | null;
|
|
505
|
-
/** Number of items to skip in the current sort order. */
|
|
506
|
-
offset?: number | null;
|
|
507
|
-
}
|
|
508
|
-
export interface QueryAutomationTemplatesResponse {
|
|
509
|
-
entries?: AutomationTemplateContainer[];
|
|
510
|
-
metaData?: QueryMetadata;
|
|
511
|
-
total?: number;
|
|
512
|
-
}
|
|
513
|
-
export interface AutomationTemplateContainer {
|
|
514
|
-
automationTemplate?: AutomationTemplate;
|
|
515
|
-
enrichmentData?: AutomationTemplateEnrichmentData;
|
|
516
|
-
}
|
|
517
|
-
export interface AutomationTemplate {
|
|
518
|
-
/**
|
|
519
|
-
* Automation template ID (unique)
|
|
520
|
-
* @readonly
|
|
521
|
-
*/
|
|
522
|
-
_id?: string | null;
|
|
523
|
-
/**
|
|
524
|
-
* Automation template current revision
|
|
525
|
-
* @readonly
|
|
526
|
-
*/
|
|
527
|
-
revision?: number | null;
|
|
528
|
-
/** Automation template name */
|
|
529
|
-
name?: string | null;
|
|
530
|
-
/** Automation template description */
|
|
531
|
-
description?: string | null;
|
|
532
|
-
/** Automation template rule configuration */
|
|
533
|
-
rule?: RuleConfiguration;
|
|
534
|
-
/** Automation template correlation id - TODO: rename */
|
|
535
|
-
correlationId?: string | null;
|
|
536
|
-
/** Automation template type */
|
|
537
|
-
templateType?: TemplateType;
|
|
538
|
-
/** Automation template preconditions */
|
|
539
|
-
preconditions?: Precondition[];
|
|
540
|
-
/** used to determine which users will see the Automation template while in internal state */
|
|
541
|
-
groupIds?: string[];
|
|
542
|
-
/**
|
|
543
|
-
* Automation template state
|
|
544
|
-
* @readonly
|
|
545
|
-
*/
|
|
546
|
-
templateState?: TemplateState;
|
|
547
|
-
/**
|
|
548
|
-
* Automation template created date
|
|
549
|
-
* @readonly
|
|
550
|
-
*/
|
|
551
|
-
_createdDate?: Date | null;
|
|
552
|
-
/**
|
|
553
|
-
* Automation template updated date
|
|
554
|
-
* @readonly
|
|
555
|
-
*/
|
|
556
|
-
_updatedDate?: Date | null;
|
|
557
|
-
/** @readonly */
|
|
558
|
-
translation?: Translation;
|
|
559
|
-
/**
|
|
560
|
-
* key -> english value, we will include those keys in the translator json and send them for translations.
|
|
561
|
-
* in the "search rules" api they will be resolved with their translation
|
|
562
|
-
*/
|
|
563
|
-
additionalTranslations?: Record<string, string>;
|
|
564
|
-
}
|
|
565
|
-
export interface RuleConfiguration {
|
|
566
|
-
/** Rule configuration name */
|
|
567
|
-
name?: string;
|
|
568
|
-
/** Rule configuration description */
|
|
569
|
-
description?: string;
|
|
570
|
-
/** Trigger configuration */
|
|
571
|
-
trigger?: TriggerConfiguration;
|
|
572
|
-
/** Actions configuration */
|
|
573
|
-
actions?: ActionConfiguration[];
|
|
574
|
-
/** Rule status */
|
|
575
|
-
ruleStatus?: RuleStatus;
|
|
576
|
-
/** Activation cycle */
|
|
577
|
-
activationCycle?: ActivationCycle;
|
|
578
|
-
metadata?: RuleMetadata;
|
|
579
|
-
}
|
|
580
|
-
export interface ConditionConfiguration {
|
|
581
|
-
/** Condition schema key */
|
|
582
|
-
schemaKey?: string;
|
|
583
|
-
/** Condition operator */
|
|
584
|
-
operator?: Operator;
|
|
585
|
-
/** Condition values */
|
|
586
|
-
values?: string[];
|
|
587
|
-
}
|
|
588
|
-
export declare enum Operator {
|
|
589
|
-
UNDEFINED = "UNDEFINED",
|
|
590
|
-
IN = "IN"
|
|
591
|
-
}
|
|
592
|
-
export interface TriggerConfiguration {
|
|
593
|
-
/** Trigger source app def id */
|
|
594
|
-
appDefId?: string;
|
|
595
|
-
/** Trigger name */
|
|
596
|
-
triggerName?: string;
|
|
597
|
-
/** Trigger schema */
|
|
598
|
-
triggerSchema?: string;
|
|
599
|
-
/** Condition configuration */
|
|
600
|
-
conditions?: ConditionConfiguration[];
|
|
601
|
-
/** TODO - might need to replace the entire object */
|
|
602
|
-
triggerConfigurationId?: string | null;
|
|
603
|
-
/** Trigger Reengagement delay internal in sec */
|
|
604
|
-
reengagementDelaySec?: number | null;
|
|
605
|
-
}
|
|
606
|
-
export interface ActionConfiguration {
|
|
607
|
-
_id?: string | null;
|
|
608
|
-
/** Action source app def id */
|
|
609
|
-
appDefId?: string;
|
|
610
|
-
/** Action name */
|
|
611
|
-
actionName?: string;
|
|
612
|
-
/** Action configuration */
|
|
613
|
-
configuration?: string;
|
|
614
|
-
/** Delay interval in seconds */
|
|
615
|
-
delayIntervalSec?: number;
|
|
616
|
-
}
|
|
617
|
-
export declare enum RuleStatus {
|
|
618
|
-
UnknownStatus = "UnknownStatus",
|
|
619
|
-
Active = "Active",
|
|
620
|
-
Suspended = "Suspended"
|
|
621
|
-
}
|
|
622
|
-
export interface ActivationCycle {
|
|
623
|
-
/** set a time frame in minutes for the once_per_user attribute, use 0 for infinite */
|
|
624
|
-
timeFrame?: number;
|
|
625
|
-
/** number of activations allowed in the given time_frame */
|
|
626
|
-
activations?: number;
|
|
627
|
-
rateLimitingJsonata?: string | null;
|
|
628
|
-
}
|
|
629
|
-
export interface RuleMetadata {
|
|
630
|
-
/** default value is 'true', when this is set to 'false' user wont be able to toggle off the rule */
|
|
631
|
-
canBeSuspended?: boolean | null;
|
|
632
|
-
/** additional notes to describe the rule */
|
|
633
|
-
notes?: string | null;
|
|
634
|
-
/** will be used to indicate to user how urgent is this change during "version" changes */
|
|
635
|
-
versionType?: VersionType;
|
|
636
|
-
}
|
|
637
|
-
export declare enum VersionType {
|
|
638
|
-
UNKNOWN_VERSION_TYPE = "UNKNOWN_VERSION_TYPE",
|
|
639
|
-
MINOR = "MINOR",
|
|
640
|
-
MAJOR = "MAJOR"
|
|
641
|
-
}
|
|
642
|
-
/** Type */
|
|
643
|
-
export declare enum TemplateType {
|
|
644
|
-
UNKNOWN_TEMPLATE_TYPE = "UNKNOWN_TEMPLATE_TYPE",
|
|
645
|
-
PREINSTALLED = "PREINSTALLED",
|
|
646
|
-
RECIPE = "RECIPE"
|
|
647
|
-
}
|
|
648
|
-
/**
|
|
649
|
-
* {
|
|
650
|
-
* State message examples:
|
|
651
|
-
* precondition_type: PreconditionType.Petri,
|
|
652
|
-
* key: ‘specs.crm.InvoicesSendViaAutomationsABC’,
|
|
653
|
-
* value: ‘C’
|
|
654
|
-
* },
|
|
655
|
-
* {
|
|
656
|
-
* precondition_type: PreconditionType.STATE,
|
|
657
|
-
* key: ‘<froms_app_def_id>:double_opt_in’,
|
|
658
|
-
* value: ‘true’
|
|
659
|
-
* },
|
|
660
|
-
* {
|
|
661
|
-
* precondition_type: PreconditionType.APP_DEPENDENCY,
|
|
662
|
-
* key: ‘<paid_plans_app_def_id>’,
|
|
663
|
-
* value: ‘true’
|
|
664
|
-
* }
|
|
665
|
-
*/
|
|
666
|
-
export interface Precondition {
|
|
667
|
-
/** Precondition type */
|
|
668
|
-
preconditionType?: PreconditionType;
|
|
669
|
-
/** Precondition unique key */
|
|
670
|
-
key?: string;
|
|
671
|
-
/** Precondition value */
|
|
672
|
-
value?: string;
|
|
673
|
-
/** Precondition fallback */
|
|
674
|
-
fallback?: boolean | null;
|
|
675
|
-
}
|
|
676
|
-
export declare enum PreconditionType {
|
|
677
|
-
UNKNOWN_PRECONDITION_TYPE = "UNKNOWN_PRECONDITION_TYPE",
|
|
678
|
-
PETRI = "PETRI",
|
|
679
|
-
STATE = "STATE",
|
|
680
|
-
APP_DEPENDENCY = "APP_DEPENDENCY",
|
|
681
|
-
DEALER_OFFERING = "DEALER_OFFERING"
|
|
682
|
-
}
|
|
683
|
-
export declare enum TemplateState {
|
|
684
|
-
UNKNOWN_TEMPLATE_STATUS = "UNKNOWN_TEMPLATE_STATUS",
|
|
685
|
-
INTERNAL = "INTERNAL",
|
|
686
|
-
PUBLIC = "PUBLIC",
|
|
687
|
-
ARCHIVED = "ARCHIVED",
|
|
688
|
-
LIVE = "LIVE"
|
|
689
|
-
}
|
|
690
|
-
export interface Translation {
|
|
691
|
-
state?: TranslationState;
|
|
692
|
-
}
|
|
693
|
-
export declare enum TranslationState {
|
|
694
|
-
UNKNOWN_TRANSLATION_STATE = "UNKNOWN_TRANSLATION_STATE",
|
|
695
|
-
NOT_REQUESTED = "NOT_REQUESTED",
|
|
696
|
-
PENDING = "PENDING",
|
|
697
|
-
PARTIAL = "PARTIAL",
|
|
698
|
-
TRANSLATED = "TRANSLATED"
|
|
699
|
-
}
|
|
700
|
-
export interface AutomationTemplateEnrichmentData {
|
|
701
|
-
campaignId?: string;
|
|
702
|
-
metaSiteId?: string;
|
|
703
|
-
}
|
|
704
|
-
export interface QueryMetadata {
|
|
705
|
-
/** Number of returned items */
|
|
706
|
-
items?: number;
|
|
707
|
-
/** Offset that was applied to the request */
|
|
708
|
-
offset?: number;
|
|
709
|
-
}
|
|
710
|
-
export interface QueryAppTemplatesRequest {
|
|
711
|
-
queryType?: TemplateQueryType;
|
|
712
|
-
}
|
|
713
|
-
export declare enum TemplateQueryType {
|
|
714
|
-
TRIGGERED_EMAILS = "TRIGGERED_EMAILS",
|
|
715
|
-
PING = "PING"
|
|
716
|
-
}
|
|
717
|
-
export interface QueryAppTemplatesResponse {
|
|
718
|
-
template?: TemplateData[];
|
|
719
|
-
}
|
|
720
|
-
export interface TemplateData {
|
|
721
|
-
templateName?: string;
|
|
722
|
-
templateId?: string;
|
|
723
|
-
}
|
|
724
466
|
export interface CampaignLookupRequest {
|
|
725
467
|
campaignId?: string;
|
|
726
468
|
}
|
|
@@ -840,6 +582,12 @@ export interface ListCampaignsRequest {
|
|
|
840
582
|
*/
|
|
841
583
|
visibilityStatuses?: CampaignVisibilityStatusEnum[];
|
|
842
584
|
}
|
|
585
|
+
export interface Paging {
|
|
586
|
+
/** Number of items to load. */
|
|
587
|
+
limit?: number | null;
|
|
588
|
+
/** Number of items to skip in the current sort order. */
|
|
589
|
+
offset?: number | null;
|
|
590
|
+
}
|
|
843
591
|
export interface ListCampaignsResponse {
|
|
844
592
|
/** Paging parameters. */
|
|
845
593
|
paging?: Paging;
|
|
@@ -1523,6 +1271,8 @@ export interface CampaignDistributedEnvelope {
|
|
|
1523
1271
|
}
|
|
1524
1272
|
/**
|
|
1525
1273
|
* Triggered when a campaign is successfully distributed to all recipients.
|
|
1274
|
+
* @permissionScope Access Verticals by Automations
|
|
1275
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1526
1276
|
* @permissionScope Read Email Marketing
|
|
1527
1277
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1528
1278
|
* @permissionScope Manage Email Marketing
|
|
@@ -1530,6 +1280,8 @@ export interface CampaignDistributedEnvelope {
|
|
|
1530
1280
|
* @permissionId Shoutout.Read
|
|
1531
1281
|
* @webhook
|
|
1532
1282
|
* @eventType wix.email_marketing.v1.campaign_campaign_distributed_event
|
|
1283
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1284
|
+
* @slug campaign_distributed_event
|
|
1533
1285
|
*/
|
|
1534
1286
|
export declare function onCampaignDistributedEvent(handler: (event: CampaignDistributedEnvelope) => void | Promise<void>): void;
|
|
1535
1287
|
export interface CampaignPausedEnvelope {
|
|
@@ -1538,6 +1290,8 @@ export interface CampaignPausedEnvelope {
|
|
|
1538
1290
|
}
|
|
1539
1291
|
/**
|
|
1540
1292
|
* Triggered when a scheduled campaign is paused.
|
|
1293
|
+
* @permissionScope Access Verticals by Automations
|
|
1294
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1541
1295
|
* @permissionScope Read Email Marketing
|
|
1542
1296
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1543
1297
|
* @permissionScope Manage Email Marketing
|
|
@@ -1545,6 +1299,8 @@ export interface CampaignPausedEnvelope {
|
|
|
1545
1299
|
* @permissionId Shoutout.Read
|
|
1546
1300
|
* @webhook
|
|
1547
1301
|
* @eventType wix.email_marketing.v1.campaign_campaign_paused_event
|
|
1302
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1303
|
+
* @slug campaign_paused_event
|
|
1548
1304
|
*/
|
|
1549
1305
|
export declare function onCampaignPausedEvent(handler: (event: CampaignPausedEnvelope) => void | Promise<void>): void;
|
|
1550
1306
|
export interface CampaignPublishedEnvelope {
|
|
@@ -1553,6 +1309,8 @@ export interface CampaignPublishedEnvelope {
|
|
|
1553
1309
|
}
|
|
1554
1310
|
/**
|
|
1555
1311
|
* Triggered when a draft campaign is published.
|
|
1312
|
+
* @permissionScope Access Verticals by Automations
|
|
1313
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1556
1314
|
* @permissionScope Read Email Marketing
|
|
1557
1315
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1558
1316
|
* @permissionScope Manage Email Marketing
|
|
@@ -1560,6 +1318,8 @@ export interface CampaignPublishedEnvelope {
|
|
|
1560
1318
|
* @permissionId Shoutout.Read
|
|
1561
1319
|
* @webhook
|
|
1562
1320
|
* @eventType wix.email_marketing.v1.campaign_campaign_published_event
|
|
1321
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1322
|
+
* @slug campaign_published_event
|
|
1563
1323
|
*/
|
|
1564
1324
|
export declare function onCampaignPublishedEvent(handler: (event: CampaignPublishedEnvelope) => void | Promise<void>): void;
|
|
1565
1325
|
export interface CampaignRejectedEnvelope {
|
|
@@ -1568,6 +1328,8 @@ export interface CampaignRejectedEnvelope {
|
|
|
1568
1328
|
}
|
|
1569
1329
|
/**
|
|
1570
1330
|
* Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
|
|
1331
|
+
* @permissionScope Access Verticals by Automations
|
|
1332
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1571
1333
|
* @permissionScope Read Email Marketing
|
|
1572
1334
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1573
1335
|
* @permissionScope Manage Email Marketing
|
|
@@ -1575,6 +1337,8 @@ export interface CampaignRejectedEnvelope {
|
|
|
1575
1337
|
* @permissionId Shoutout.Read
|
|
1576
1338
|
* @webhook
|
|
1577
1339
|
* @eventType wix.email_marketing.v1.campaign_campaign_rejected_event
|
|
1340
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1341
|
+
* @slug campaign_rejected_event
|
|
1578
1342
|
*/
|
|
1579
1343
|
export declare function onCampaignRejectedEvent(handler: (event: CampaignRejectedEnvelope) => void | Promise<void>): void;
|
|
1580
1344
|
export interface CampaignScheduledEnvelope {
|
|
@@ -1583,6 +1347,8 @@ export interface CampaignScheduledEnvelope {
|
|
|
1583
1347
|
}
|
|
1584
1348
|
/**
|
|
1585
1349
|
* Triggered when a campaign is scheduled to be sent out at the specific time.
|
|
1350
|
+
* @permissionScope Access Verticals by Automations
|
|
1351
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1586
1352
|
* @permissionScope Read Email Marketing
|
|
1587
1353
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1588
1354
|
* @permissionScope Manage Email Marketing
|
|
@@ -1590,6 +1356,8 @@ export interface CampaignScheduledEnvelope {
|
|
|
1590
1356
|
* @permissionId Shoutout.Read
|
|
1591
1357
|
* @webhook
|
|
1592
1358
|
* @eventType wix.email_marketing.v1.campaign_campaign_scheduled_event
|
|
1359
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1360
|
+
* @slug campaign_scheduled_event
|
|
1593
1361
|
*/
|
|
1594
1362
|
export declare function onCampaignScheduledEvent(handler: (event: CampaignScheduledEnvelope) => void | Promise<void>): void;
|
|
1595
1363
|
export interface CampaignTerminatedEnvelope {
|
|
@@ -1598,6 +1366,8 @@ export interface CampaignTerminatedEnvelope {
|
|
|
1598
1366
|
}
|
|
1599
1367
|
/**
|
|
1600
1368
|
* Triggered when the mailing list isn't clean and campaign was terminated.
|
|
1369
|
+
* @permissionScope Access Verticals by Automations
|
|
1370
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1601
1371
|
* @permissionScope Read Email Marketing
|
|
1602
1372
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1603
1373
|
* @permissionScope Manage Email Marketing
|
|
@@ -1605,6 +1375,8 @@ export interface CampaignTerminatedEnvelope {
|
|
|
1605
1375
|
* @permissionId Shoutout.Read
|
|
1606
1376
|
* @webhook
|
|
1607
1377
|
* @eventType wix.email_marketing.v1.campaign_campaign_terminated_event
|
|
1378
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1379
|
+
* @slug campaign_terminated_event
|
|
1608
1380
|
*/
|
|
1609
1381
|
export declare function onCampaignTerminatedEvent(handler: (event: CampaignTerminatedEnvelope) => void | Promise<void>): void;
|
|
1610
1382
|
export interface CampaignCreatedEnvelope {
|
|
@@ -1613,6 +1385,8 @@ export interface CampaignCreatedEnvelope {
|
|
|
1613
1385
|
}
|
|
1614
1386
|
/**
|
|
1615
1387
|
* Triggered when a campaign is created.
|
|
1388
|
+
* @permissionScope Access Verticals by Automations
|
|
1389
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1616
1390
|
* @permissionScope Read Email Marketing
|
|
1617
1391
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1618
1392
|
* @permissionScope Manage Email Marketing
|
|
@@ -1620,6 +1394,8 @@ export interface CampaignCreatedEnvelope {
|
|
|
1620
1394
|
* @permissionId Shoutout.Read
|
|
1621
1395
|
* @webhook
|
|
1622
1396
|
* @eventType wix.email_marketing.v1.campaign_created
|
|
1397
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1398
|
+
* @slug created
|
|
1623
1399
|
*/
|
|
1624
1400
|
export declare function onCampaignCreated(handler: (event: CampaignCreatedEnvelope) => void | Promise<void>): void;
|
|
1625
1401
|
export interface CampaignDeletedEnvelope {
|
|
@@ -1627,6 +1403,8 @@ export interface CampaignDeletedEnvelope {
|
|
|
1627
1403
|
}
|
|
1628
1404
|
/**
|
|
1629
1405
|
* Triggered when a campaign is deleted.
|
|
1406
|
+
* @permissionScope Access Verticals by Automations
|
|
1407
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1630
1408
|
* @permissionScope Read Email Marketing
|
|
1631
1409
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1632
1410
|
* @permissionScope Manage Email Marketing
|
|
@@ -1634,6 +1412,8 @@ export interface CampaignDeletedEnvelope {
|
|
|
1634
1412
|
* @permissionId Shoutout.Read
|
|
1635
1413
|
* @webhook
|
|
1636
1414
|
* @eventType wix.email_marketing.v1.campaign_deleted
|
|
1415
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1416
|
+
* @slug deleted
|
|
1637
1417
|
*/
|
|
1638
1418
|
export declare function onCampaignDeleted(handler: (event: CampaignDeletedEnvelope) => void | Promise<void>): void;
|
|
1639
1419
|
export interface CampaignEmailActivityUpdatedEnvelope {
|
|
@@ -1642,6 +1422,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1642
1422
|
}
|
|
1643
1423
|
/**
|
|
1644
1424
|
* Triggered when an email campaign has a new recipient activity.
|
|
1425
|
+
* @permissionScope Access Verticals by Automations
|
|
1426
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1645
1427
|
* @permissionScope Read Email Marketing
|
|
1646
1428
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1647
1429
|
* @permissionScope Manage Email Marketing
|
|
@@ -1649,6 +1431,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1649
1431
|
* @permissionId Shoutout.Read
|
|
1650
1432
|
* @webhook
|
|
1651
1433
|
* @eventType wix.email_marketing.v1.campaign_email_activity_updated
|
|
1434
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1435
|
+
* @slug email_activity_updated
|
|
1652
1436
|
*/
|
|
1653
1437
|
export declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
|
|
1654
1438
|
/**
|
|
@@ -1660,6 +1444,8 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
|
|
|
1660
1444
|
* @documentationMaturity preview
|
|
1661
1445
|
* @requiredField url
|
|
1662
1446
|
* @permissionId Shoutout.Manage
|
|
1447
|
+
* @permissionScope Access Verticals by Automations
|
|
1448
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1663
1449
|
* @permissionScope Manage Email Marketing
|
|
1664
1450
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1665
1451
|
* @applicableIdentity APP
|
|
@@ -1673,6 +1459,8 @@ export declare function validateLink(url: string): Promise<ValidateLinkResponse
|
|
|
1673
1459
|
* @documentationMaturity preview
|
|
1674
1460
|
* @requiredField html
|
|
1675
1461
|
* @permissionId Shoutout.Manage
|
|
1462
|
+
* @permissionScope Access Verticals by Automations
|
|
1463
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1676
1464
|
* @permissionScope Manage Email Marketing
|
|
1677
1465
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1678
1466
|
* @applicableIdentity APP
|
|
@@ -1691,6 +1479,8 @@ export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLin
|
|
|
1691
1479
|
* @public
|
|
1692
1480
|
* @requiredField campaignIds
|
|
1693
1481
|
* @permissionId Shoutout.Read
|
|
1482
|
+
* @permissionScope Access Verticals by Automations
|
|
1483
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1694
1484
|
* @permissionScope Read Email Marketing
|
|
1695
1485
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1696
1486
|
* @permissionScope Manage Email Marketing
|
|
@@ -1721,6 +1511,8 @@ export declare function listStatistics(campaignIds: string[]): Promise<ListStati
|
|
|
1721
1511
|
* @requiredField campaignId
|
|
1722
1512
|
* @param options - Options to use when getting the list of recipients.
|
|
1723
1513
|
* @permissionId Shoutout.Read
|
|
1514
|
+
* @permissionScope Access Verticals by Automations
|
|
1515
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1724
1516
|
* @permissionScope Read Email Marketing
|
|
1725
1517
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1726
1518
|
* @permissionScope Manage Email Marketing
|
|
@@ -1740,6 +1532,8 @@ export interface ListRecipientsOptions {
|
|
|
1740
1532
|
* @requiredField campaignId
|
|
1741
1533
|
* @param options - Options to use when getting a campaign.
|
|
1742
1534
|
* @permissionId Shoutout.Manage
|
|
1535
|
+
* @permissionScope Access Verticals by Automations
|
|
1536
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1743
1537
|
* @permissionScope Manage Email Marketing
|
|
1744
1538
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1745
1539
|
* @applicableIdentity APP
|
|
@@ -1762,6 +1556,8 @@ export interface GetCampaignOptions {
|
|
|
1762
1556
|
* @public
|
|
1763
1557
|
* @param options - Options to use when getting the list of campaigns.
|
|
1764
1558
|
* @permissionId Shoutout.Read
|
|
1559
|
+
* @permissionScope Access Verticals by Automations
|
|
1560
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1765
1561
|
* @permissionScope Read Email Marketing
|
|
1766
1562
|
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1767
1563
|
* @permissionScope Manage Email Marketing
|
|
@@ -1803,6 +1599,8 @@ export interface ListCampaignsOptions {
|
|
|
1803
1599
|
* @requiredField campaignId
|
|
1804
1600
|
* @param options - Options to use when publishing a campaign.
|
|
1805
1601
|
* @permissionId Shoutout.Manage
|
|
1602
|
+
* @permissionScope Access Verticals by Automations
|
|
1603
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1806
1604
|
* @permissionScope Manage Email Marketing
|
|
1807
1605
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1808
1606
|
* @applicableIdentity APP
|
|
@@ -1823,6 +1621,8 @@ export interface PublishCampaignOptions {
|
|
|
1823
1621
|
* @requiredField options.toEmailAddress
|
|
1824
1622
|
* @param options - Options for sending a test email.
|
|
1825
1623
|
* @permissionId Shoutout.Manage
|
|
1624
|
+
* @permissionScope Access Verticals by Automations
|
|
1625
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1826
1626
|
* @permissionScope Manage Email Marketing
|
|
1827
1627
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1828
1628
|
* @applicableIdentity APP
|
|
@@ -1841,6 +1641,8 @@ export interface SendTestOptions {
|
|
|
1841
1641
|
* @public
|
|
1842
1642
|
* @requiredField campaignId
|
|
1843
1643
|
* @permissionId Shoutout.Manage
|
|
1644
|
+
* @permissionScope Access Verticals by Automations
|
|
1645
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1844
1646
|
* @permissionScope Manage Email Marketing
|
|
1845
1647
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1846
1648
|
* @applicableIdentity APP
|
|
@@ -1855,6 +1657,8 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
|
|
|
1855
1657
|
* @requiredField campaignId
|
|
1856
1658
|
* @requiredField sendAt
|
|
1857
1659
|
* @permissionId Shoutout.Manage
|
|
1660
|
+
* @permissionScope Access Verticals by Automations
|
|
1661
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1858
1662
|
* @permissionScope Manage Email Marketing
|
|
1859
1663
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1860
1664
|
* @applicableIdentity APP
|
|
@@ -1867,6 +1671,8 @@ export declare function reschedule(campaignId: string, sendAt: Date | null): Pro
|
|
|
1867
1671
|
* @public
|
|
1868
1672
|
* @requiredField campaignId
|
|
1869
1673
|
* @permissionId Shoutout.Manage
|
|
1674
|
+
* @permissionScope Access Verticals by Automations
|
|
1675
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1870
1676
|
* @permissionScope Manage Email Marketing
|
|
1871
1677
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1872
1678
|
* @applicableIdentity APP
|
|
@@ -1879,6 +1685,8 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
|
|
|
1879
1685
|
* @public
|
|
1880
1686
|
* @requiredField campaignId
|
|
1881
1687
|
* @permissionId Shoutout.Manage
|
|
1688
|
+
* @permissionScope Access Verticals by Automations
|
|
1689
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1882
1690
|
* @permissionScope Manage Email Marketing
|
|
1883
1691
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1884
1692
|
* @applicableIdentity APP
|
|
@@ -1891,6 +1699,8 @@ export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaign
|
|
|
1891
1699
|
* @public
|
|
1892
1700
|
* @requiredField campaignId
|
|
1893
1701
|
* @permissionId Shoutout.Manage
|
|
1702
|
+
* @permissionScope Access Verticals by Automations
|
|
1703
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1894
1704
|
* @permissionScope Manage Email Marketing
|
|
1895
1705
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1896
1706
|
* @applicableIdentity APP
|
|
@@ -1903,6 +1713,8 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
|
|
|
1903
1713
|
* @public
|
|
1904
1714
|
* @requiredField emailAddress
|
|
1905
1715
|
* @permissionId Shoutout.Manage
|
|
1716
|
+
* @permissionScope Access Verticals by Automations
|
|
1717
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1906
1718
|
* @permissionScope Manage Email Marketing
|
|
1907
1719
|
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1908
1720
|
* @applicableIdentity APP
|