@wix/auto_sdk_email-marketing_campaigns 1.0.69 → 1.0.70

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +34 -34
  2. package/build/cjs/index.js +170 -170
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +557 -539
  5. package/build/cjs/index.typings.js +154 -154
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +479 -479
  8. package/build/cjs/meta.js +134 -134
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +34 -34
  11. package/build/es/index.mjs +170 -170
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +557 -539
  14. package/build/es/index.typings.mjs +154 -154
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +479 -479
  17. package/build/es/meta.mjs +134 -134
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +34 -34
  20. package/build/internal/cjs/index.js +170 -170
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +557 -539
  23. package/build/internal/cjs/index.typings.js +154 -154
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +479 -479
  26. package/build/internal/cjs/meta.js +134 -134
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +34 -34
  29. package/build/internal/es/index.mjs +170 -170
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +557 -539
  32. package/build/internal/es/index.typings.mjs +154 -154
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +479 -479
  35. package/build/internal/es/meta.mjs +134 -134
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -213,23 +213,361 @@ declare enum CampaignTypeEnum {
213
213
  }
214
214
  /** @enumType */
215
215
  type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
216
- interface GetPlaceholderKeysRequest {
216
+ interface GetCampaignMappingRequest {
217
+ /**
218
+ * rule ID in automations
219
+ * @format GUID
220
+ */
221
+ automationRuleId?: string;
222
+ /**
223
+ * template ID configured for the automation
224
+ * @format GUID
225
+ */
226
+ templateId?: string;
227
+ }
228
+ interface GetCampaignMappingResponse {
229
+ /** @format GUID */
230
+ campaignId?: string;
231
+ }
232
+ interface UpsertTranslationRequest {
233
+ /**
234
+ * Campaign ID.
235
+ * @format GUID
236
+ */
237
+ campaignId?: string;
238
+ /** Composer data. */
239
+ composer?: Composer;
240
+ /**
241
+ * Translation language (optional, default value "EN").
242
+ * @format LANGUAGE
243
+ */
244
+ language?: string | null;
245
+ /**
246
+ * For BI event [36:1031] only (optional, default value "n/a").
247
+ * @format GUID
248
+ */
249
+ automationRuleId?: string | null;
250
+ /** Should campaign also be published or not (default value "false"). */
251
+ publish?: boolean;
252
+ /**
253
+ * Campaign subject (optional).
254
+ * @maxLength 1000
255
+ */
256
+ emailSubject?: string | null;
257
+ /**
258
+ * Campaign preheader (optional).
259
+ * @maxLength 1000
260
+ */
261
+ emailPreheader?: string | null;
262
+ }
263
+ interface Composer {
264
+ /**
265
+ * Internal data structure for editor/viewer to render the campaign.
266
+ * @maxLength 10000000
267
+ */
268
+ composerDataJson?: string;
269
+ /** Default values of existing placeholders. */
270
+ defaultValues?: DefaultValues;
271
+ }
272
+ interface DefaultValues {
273
+ /** @maxSize 500 */
274
+ map?: Record<string, string>;
275
+ }
276
+ interface UpsertTranslationResponse {
277
+ }
278
+ interface GetUsedPlaceholderKeysRequest {
279
+ /**
280
+ * Campaign ID.
281
+ * @format GUID
282
+ */
283
+ campaignId?: string;
284
+ }
285
+ interface GetUsedPlaceholderKeysResponse {
286
+ /**
287
+ * Keys of placeholders used in the automation.
288
+ * @maxLength 200
289
+ * @maxSize 300
290
+ */
291
+ placeholderKeys?: string[];
292
+ }
293
+ interface LookupCampaignMappingRequest {
294
+ /**
295
+ * rule ID in automations
296
+ * @format GUID
297
+ */
298
+ automationRuleId?: string;
299
+ /**
300
+ * template ID configured for the automation
301
+ * @format GUID
302
+ */
303
+ templateId?: string;
304
+ }
305
+ interface LookupCampaignMappingResponse {
306
+ /** @format GUID */
307
+ campaignId?: string | null;
308
+ }
309
+ interface UpsertAutomationTranslatorContentRequest {
310
+ /**
311
+ * Campaign ID that the content belongs to
312
+ * @format GUID
313
+ */
314
+ campaignId?: string;
315
+ /** Automation translator content */
316
+ automationTranslatorContent?: AutomationTranslatorContent;
317
+ }
318
+ /** Automation Translator Content */
319
+ interface AutomationTranslatorContent {
320
+ /**
321
+ * AutomationTranslatorContent ID
322
+ * @minLength 1
323
+ * @maxLength 256
324
+ * @immutable
325
+ */
326
+ _id?: string;
327
+ /**
328
+ * Content that can contain multiple strings. It represents a json file, that is stored on Smartling
329
+ * @minLength 1
330
+ * @maxLength 800000
331
+ */
332
+ json?: string;
333
+ }
334
+ interface UpsertAutomationTranslatorContentResponse {
335
+ }
336
+ interface GetAutomationTranslatorContentRequest {
337
+ /**
338
+ * Campaign ID
339
+ * @format GUID
340
+ */
341
+ campaignId?: string;
342
+ }
343
+ interface GetAutomationTranslatorContentResponse {
344
+ /** Automation translator content */
345
+ automationTranslatorContent?: AutomationTranslatorContent;
346
+ }
347
+ interface SendTestBulkRequest {
348
+ /**
349
+ * Campaign ID
350
+ * @format GUID
351
+ */
352
+ campaignId?: string;
353
+ /**
354
+ * Recipient email address
355
+ * @format EMAIL
356
+ */
357
+ toEmailAddress?: string;
358
+ /** Values to replace campaign placeholders with (unique for each campaign) */
359
+ placeholders?: Record<string, PlaceholderContent>;
360
+ /**
361
+ * Sender from name
362
+ * @maxLength 100
363
+ */
364
+ fromName?: string | null;
365
+ /**
366
+ * Reply-to email address
367
+ * @format EMAIL
368
+ */
369
+ replyToEmailAddress?: string | null;
370
+ /**
371
+ * Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
372
+ * @format LANGUAGE
373
+ */
374
+ language?: string | null;
375
+ }
376
+ interface PlaceholderContent extends PlaceholderContentValueOneOf {
377
+ text?: PlainText;
378
+ html?: Html;
379
+ money?: Money;
380
+ dateTime?: DateTime;
381
+ map?: Map;
382
+ array?: _Array;
383
+ enum?: PlaceholderContentEnum;
384
+ attachment?: Attachment;
385
+ integer?: Integer;
386
+ decimal?: Decimal;
387
+ }
388
+ /** @oneof */
389
+ interface PlaceholderContentValueOneOf {
390
+ text?: PlainText;
391
+ html?: Html;
392
+ money?: Money;
393
+ dateTime?: DateTime;
394
+ map?: Map;
395
+ array?: _Array;
396
+ enum?: PlaceholderContentEnum;
397
+ attachment?: Attachment;
398
+ integer?: Integer;
399
+ decimal?: Decimal;
400
+ }
401
+ interface PlainText {
402
+ text?: string;
403
+ }
404
+ interface Html {
405
+ html?: string;
406
+ }
407
+ /**
408
+ * Money.
409
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
410
+ */
411
+ interface Money {
412
+ /**
413
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
414
+ * @format DECIMAL_VALUE
415
+ */
416
+ value?: string;
417
+ /**
418
+ * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
419
+ * @format CURRENCY
420
+ */
421
+ currency?: string;
422
+ /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
423
+ formattedValue?: string | null;
424
+ }
425
+ interface DateTime {
426
+ timestamp?: Date | null;
427
+ /** optional time zone is the full name. example: "Asia/Jerusalem" */
428
+ timeZone?: string | null;
429
+ }
430
+ interface Map {
431
+ variables?: Record<string, PlaceholderContent>;
432
+ }
433
+ interface _Array {
434
+ items?: PlaceholderContent[];
435
+ }
436
+ interface PlaceholderContentEnum {
437
+ value?: string;
438
+ translation?: string;
439
+ }
440
+ interface Attachment {
441
+ fileName?: string;
442
+ downloadUrl?: string;
443
+ }
444
+ interface Integer {
445
+ /** min value: -2147483648, max value: 2147483647 */
446
+ value?: number;
447
+ }
448
+ interface Decimal {
449
+ /**
450
+ * when converted from Double, has a limitation of max 16 digits (including fractional part)
451
+ * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
452
+ * @format DECIMAL_VALUE
453
+ */
454
+ value?: string;
455
+ }
456
+ interface SendTestBulkResponse {
457
+ }
458
+ interface ListStatisticsRequest {
459
+ /**
460
+ * IDs of the campaigns to retrieve (max 100 campaigns).
461
+ * @format GUID
462
+ * @minSize 1
463
+ * @maxSize 100
464
+ */
465
+ campaignIds: string[];
466
+ }
467
+ interface ListStatisticsResponse {
468
+ /** List of statistics. */
469
+ statistics?: CampaignStatisticsContainer[];
470
+ }
471
+ interface CampaignStatisticsContainer {
472
+ /**
473
+ * Campaign ID.
474
+ * @format GUID
475
+ */
476
+ campaignId?: string;
477
+ /** Landing page statistics. */
478
+ landingPage?: LandingPageStatistics;
479
+ /** Email campaign statistics. */
480
+ email?: DistributionStatistics;
481
+ }
482
+ interface ListRecipientsRequest {
483
+ /**
484
+ * Campaign ID.
485
+ * @format GUID
486
+ */
487
+ campaignId: string;
488
+ /** Email activity to filter. */
489
+ activity: RecipientsActivityEnumWithLiterals;
490
+ /** Pagination options. */
491
+ paging?: CursorPaging;
492
+ }
493
+ declare enum RecipientsActivityEnum {
494
+ UNKNOWN = "UNKNOWN",
495
+ DELIVERED = "DELIVERED",
496
+ OPENED = "OPENED",
497
+ CLICKED = "CLICKED",
498
+ BOUNCED = "BOUNCED",
499
+ NOT_SENT = "NOT_SENT",
500
+ SENT = "SENT",
501
+ NOT_OPENED = "NOT_OPENED"
502
+ }
503
+ /** @enumType */
504
+ type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
505
+ interface CursorPaging {
506
+ /**
507
+ * Number of items to load.
508
+ * @max 1000
509
+ */
510
+ limit?: number | null;
511
+ /**
512
+ * Pointer to the next or previous page in the list of results.
513
+ *
514
+ * You can get the relevant cursor token
515
+ * from the `pagingMetadata` object in the previous call's response.
516
+ * Not relevant for the first request.
517
+ * @maxLength 1000
518
+ */
519
+ cursor?: string | null;
520
+ }
521
+ interface ListRecipientsResponse {
522
+ /** List of recipients. */
523
+ recipients?: CampaignRecipientDetails[];
524
+ /** Details on the paged set of returned results. */
525
+ pagingMetadata?: PagingMetadataV2;
526
+ }
527
+ interface CampaignRecipientDetails {
217
528
  /**
218
- * Campaign ID.
529
+ * Contact ID.
219
530
  * @format GUID
220
531
  */
221
- campaignId?: string;
222
- }
223
- interface GetPlaceholderKeysResponse {
224
- /** Keys of placeholders used in the campaign. */
225
- placeholderKeys?: string[];
532
+ contactId?: string;
533
+ /** Date and time of the last activity. */
534
+ lastActivityDate?: Date | null;
535
+ /**
536
+ * Primary email address of the contact.
537
+ * @format EMAIL
538
+ */
539
+ emailAddress?: string;
540
+ /**
541
+ * Full name of the contact (optional).
542
+ * @maxLength 100
543
+ */
544
+ fullName?: string | null;
545
+ /** Is this contact currently deleted from the site or not. */
546
+ contactDeleted?: boolean;
226
547
  }
227
- interface GetDefaultComponentsRequest {
548
+ interface PagingMetadataV2 {
549
+ /** Number of items returned in the response. */
550
+ count?: number | null;
551
+ /** Offset that was requested. */
552
+ offset?: number | null;
553
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
554
+ total?: number | null;
555
+ /** Flag that indicates the server failed to calculate the `total` field. */
556
+ tooManyToCount?: boolean | null;
557
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
558
+ cursors?: Cursors;
228
559
  }
229
- interface GetDefaultComponentsResponse {
230
- footer?: Record<string, any> | null;
231
- logo?: Record<string, any> | null;
232
- follow?: Record<string, any> | null;
560
+ interface Cursors {
561
+ /**
562
+ * Cursor string pointing to the next page in the list of results.
563
+ * @maxLength 16000
564
+ */
565
+ next?: string | null;
566
+ /**
567
+ * Cursor pointing to the previous page in the list of results.
568
+ * @maxLength 16000
569
+ */
570
+ prev?: string | null;
233
571
  }
234
572
  interface GetCampaignRequest {
235
573
  /**
@@ -532,86 +870,6 @@ interface SendTestRequest {
532
870
  */
533
871
  toEmailAddress: string;
534
872
  }
535
- interface PlaceholderContent extends PlaceholderContentValueOneOf {
536
- text?: PlainText;
537
- html?: Html;
538
- money?: Money;
539
- dateTime?: DateTime;
540
- map?: Map;
541
- array?: _Array;
542
- enum?: PlaceholderContentEnum;
543
- attachment?: Attachment;
544
- integer?: Integer;
545
- decimal?: Decimal;
546
- }
547
- /** @oneof */
548
- interface PlaceholderContentValueOneOf {
549
- text?: PlainText;
550
- html?: Html;
551
- money?: Money;
552
- dateTime?: DateTime;
553
- map?: Map;
554
- array?: _Array;
555
- enum?: PlaceholderContentEnum;
556
- attachment?: Attachment;
557
- integer?: Integer;
558
- decimal?: Decimal;
559
- }
560
- interface PlainText {
561
- text?: string;
562
- }
563
- interface Html {
564
- html?: string;
565
- }
566
- /**
567
- * Money.
568
- * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
569
- */
570
- interface Money {
571
- /**
572
- * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
573
- * @format DECIMAL_VALUE
574
- */
575
- value?: string;
576
- /**
577
- * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
578
- * @format CURRENCY
579
- */
580
- currency?: string;
581
- /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
582
- formattedValue?: string | null;
583
- }
584
- interface DateTime {
585
- timestamp?: Date | null;
586
- /** optional time zone is the full name. example: "Asia/Jerusalem" */
587
- timeZone?: string | null;
588
- }
589
- interface Map {
590
- variables?: Record<string, PlaceholderContent>;
591
- }
592
- interface _Array {
593
- items?: PlaceholderContent[];
594
- }
595
- interface PlaceholderContentEnum {
596
- value?: string;
597
- translation?: string;
598
- }
599
- interface Attachment {
600
- fileName?: string;
601
- downloadUrl?: string;
602
- }
603
- interface Integer {
604
- /** min value: -2147483648, max value: 2147483647 */
605
- value?: number;
606
- }
607
- interface Decimal {
608
- /**
609
- * when converted from Double, has a limitation of max 16 digits (including fractional part)
610
- * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
611
- * @format DECIMAL_VALUE
612
- */
613
- value?: string;
614
- }
615
873
  interface SendTestResponse {
616
874
  }
617
875
  interface PauseSchedulingRequest {
@@ -755,19 +1013,6 @@ interface GetComposerResponse {
755
1013
  */
756
1014
  emailPreheader?: string | null;
757
1015
  }
758
- interface Composer {
759
- /**
760
- * Internal data structure for editor/viewer to render the campaign.
761
- * @maxLength 10000000
762
- */
763
- composerDataJson?: string;
764
- /** Default values of existing placeholders. */
765
- defaultValues?: DefaultValues;
766
- }
767
- interface DefaultValues {
768
- /** @maxSize 500 */
769
- map?: Record<string, string>;
770
- }
771
1016
  interface UpdateComposerRequest {
772
1017
  /**
773
1018
  * Campaign ID.
@@ -953,220 +1198,93 @@ interface ActionEvent {
953
1198
  }
954
1199
  interface MessageEnvelope {
955
1200
  /**
956
- * App instance ID.
957
- * @format GUID
958
- */
959
- instanceId?: string | null;
960
- /**
961
- * Event type.
962
- * @maxLength 150
963
- */
964
- eventType?: string;
965
- /** The identification type and identity data. */
966
- identity?: IdentificationData;
967
- /** Stringify payload. */
968
- data?: string;
969
- }
970
- interface IdentificationData extends IdentificationDataIdOneOf {
971
- /**
972
- * ID of a site visitor that has not logged in to the site.
973
- * @format GUID
974
- */
975
- anonymousVisitorId?: string;
976
- /**
977
- * ID of a site visitor that has logged in to the site.
978
- * @format GUID
979
- */
980
- memberId?: string;
981
- /**
982
- * ID of a Wix user (site owner, contributor, etc.).
983
- * @format GUID
984
- */
985
- wixUserId?: string;
986
- /**
987
- * ID of an app.
988
- * @format GUID
989
- */
990
- appId?: string;
991
- /** @readonly */
992
- identityType?: WebhookIdentityTypeWithLiterals;
993
- }
994
- /** @oneof */
995
- interface IdentificationDataIdOneOf {
996
- /**
997
- * ID of a site visitor that has not logged in to the site.
998
- * @format GUID
999
- */
1000
- anonymousVisitorId?: string;
1001
- /**
1002
- * ID of a site visitor that has logged in to the site.
1003
- * @format GUID
1004
- */
1005
- memberId?: string;
1006
- /**
1007
- * ID of a Wix user (site owner, contributor, etc.).
1008
- * @format GUID
1009
- */
1010
- wixUserId?: string;
1011
- /**
1012
- * ID of an app.
1013
- * @format GUID
1014
- */
1015
- appId?: string;
1016
- }
1017
- declare enum WebhookIdentityType {
1018
- UNKNOWN = "UNKNOWN",
1019
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1020
- MEMBER = "MEMBER",
1021
- WIX_USER = "WIX_USER",
1022
- APP = "APP"
1023
- }
1024
- /** @enumType */
1025
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1026
- interface EstimateFilterSizeRequest {
1027
- /** Contacts filter expression. */
1028
- filter?: Record<string, any> | null;
1029
- /** Should "inactive" contacts be excluded or not (default value "false"). */
1030
- activeContactsOnly?: boolean;
1031
- /**
1032
- * Contacts plain text search expression (searches in name, phone and email fields).
1033
- * @minLength 1
1034
- * @maxLength 100
1035
- */
1036
- search?: string | null;
1037
- }
1038
- interface EstimateFilterSizeResponse {
1039
- /** Mailing list size estimation. */
1040
- estimation?: number;
1041
- }
1042
- interface EstimateAudienceSizeRequest {
1043
- /**
1044
- * Contact IDs of a campaign audience.
1045
- * @format GUID
1046
- */
1047
- contactIds?: string[];
1048
- /** Label IDs of a campaign audience. */
1049
- labelIds?: string[];
1050
- /** Contacts filter expression (json). */
1051
- contactsFilter?: Record<string, any> | null;
1052
- /**
1053
- * Contacts plain text search expression (searches in name, phone and email fields).
1054
- * @minLength 1
1055
- * @maxLength 100
1056
- */
1057
- search?: string | null;
1058
- /**
1059
- * Segment ids of a campaign audience.
1060
- * @format GUID
1061
- */
1062
- segmentIds?: string[];
1063
- /** Should "inactive" contacts be excluded or not (default value "false"). */
1064
- activeContactsOnly?: boolean;
1065
- /**
1066
- * Id of a campaign that is to be resent.
1201
+ * App instance ID.
1067
1202
  * @format GUID
1068
1203
  */
1069
- resendCampaignId?: string | null;
1070
- /** Should total number of contacts in provided audience be returned or not (default value "false"). */
1071
- withTotal?: boolean;
1072
- }
1073
- interface EstimateAudienceSizeResponse {
1074
- /** Audience size (estimated number of emails to be sent). */
1075
- estimation?: number;
1076
- /** Total number of contacts in provided audience (optional). */
1077
- total?: number | null;
1078
- }
1079
- interface ReconcileContactRequest {
1204
+ instanceId?: string | null;
1080
1205
  /**
1081
- * Email address of the contact.
1082
- * @format EMAIL
1206
+ * Event type.
1207
+ * @maxLength 150
1083
1208
  */
1084
- emailAddress?: string;
1085
- }
1086
- interface ReconcileContactResponse {
1087
- /** Created or retrieved contact. */
1088
- contact?: Contact;
1209
+ eventType?: string;
1210
+ /** The identification type and identity data. */
1211
+ identity?: IdentificationData;
1212
+ /** Stringify payload. */
1213
+ data?: string;
1089
1214
  }
1090
- interface Contact {
1215
+ interface IdentificationData extends IdentificationDataIdOneOf {
1091
1216
  /**
1092
- * Unique ID of the contact entity.
1217
+ * ID of a site visitor that has not logged in to the site.
1093
1218
  * @format GUID
1094
1219
  */
1095
- _id?: string;
1220
+ anonymousVisitorId?: string;
1096
1221
  /**
1097
- * Primary email address of the contact.
1098
- * @format EMAIL
1222
+ * ID of a site visitor that has logged in to the site.
1223
+ * @format GUID
1099
1224
  */
1100
- emailAddress?: string;
1225
+ memberId?: string;
1101
1226
  /**
1102
- * Full name of the contact (optional).
1103
- * @maxLength 100
1227
+ * ID of a Wix user (site owner, contributor, etc.).
1228
+ * @format GUID
1104
1229
  */
1105
- fullName?: string | null;
1230
+ wixUserId?: string;
1106
1231
  /**
1107
- * Profile picture of the contact (optional).
1108
- * @format WEB_URL
1109
- * @maxLength 2048
1232
+ * ID of an app.
1233
+ * @format GUID
1110
1234
  */
1111
- pictureUrl?: string | null;
1235
+ appId?: string;
1236
+ /** @readonly */
1237
+ identityType?: WebhookIdentityTypeWithLiterals;
1112
1238
  }
1113
- interface SearchContactsRequest {
1239
+ /** @oneof */
1240
+ interface IdentificationDataIdOneOf {
1114
1241
  /**
1115
- * Text to search contacts by - can search by name or email address.
1116
- * @maxLength 100
1242
+ * ID of a site visitor that has not logged in to the site.
1243
+ * @format GUID
1117
1244
  */
1118
- searchTerm?: string;
1119
- /** Should "inactive" contacts be excluded or not (default value "false"). */
1120
- activeContactsOnly?: boolean;
1245
+ anonymousVisitorId?: string;
1121
1246
  /**
1122
- * Page size (default 50, max 1000).
1123
- * @max 1000
1247
+ * ID of a site visitor that has logged in to the site.
1248
+ * @format GUID
1124
1249
  */
1125
- pageSize?: number | null;
1126
- }
1127
- interface SearchContactsResponse {
1128
- /** Search results. */
1129
- contacts?: Contact[];
1130
- }
1131
- interface GetLabelsRequest {
1132
- /** Should "inactive" contacts be excluded or not (default value "false"). */
1133
- activeContactsOnly?: boolean;
1134
- }
1135
- interface GetLabelsResponse {
1136
- /** Returned labels with contact counts. */
1137
- labels?: Label[];
1138
- }
1139
- interface Label {
1250
+ memberId?: string;
1140
1251
  /**
1141
- * Unique ID of the label entity.
1142
- * @maxLength 100
1252
+ * ID of a Wix user (site owner, contributor, etc.).
1253
+ * @format GUID
1143
1254
  */
1144
- _id?: string;
1255
+ wixUserId?: string;
1145
1256
  /**
1146
- * Name of the label.
1147
- * @maxLength 100
1257
+ * ID of an app.
1258
+ * @format GUID
1148
1259
  */
1149
- name?: string;
1150
- /** Amount of contacts assigned to the label. */
1151
- contactsCount?: number;
1260
+ appId?: string;
1152
1261
  }
1153
- interface SubscribeFromLandingPageRequest {
1262
+ declare enum WebhookIdentityType {
1263
+ UNKNOWN = "UNKNOWN",
1264
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1265
+ MEMBER = "MEMBER",
1266
+ WIX_USER = "WIX_USER",
1267
+ APP = "APP"
1268
+ }
1269
+ /** @enumType */
1270
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1271
+ interface GetPlaceholderKeysRequest {
1154
1272
  /**
1155
- * Campaign ID that the subscription is happening from.
1273
+ * Campaign ID.
1156
1274
  * @format GUID
1157
1275
  */
1158
1276
  campaignId?: string;
1159
- /**
1160
- * Email address that is entered into subscription field.
1161
- * @format EMAIL
1162
- */
1163
- emailAddress?: string;
1164
- /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
1165
- consent?: boolean;
1166
1277
  }
1167
- interface SubscribeFromLandingPageResponse {
1168
- /** @format GUID */
1169
- contactId?: string;
1278
+ interface GetPlaceholderKeysResponse {
1279
+ /** Keys of placeholders used in the campaign. */
1280
+ placeholderKeys?: string[];
1281
+ }
1282
+ interface GetDefaultComponentsRequest {
1283
+ }
1284
+ interface GetDefaultComponentsResponse {
1285
+ footer?: Record<string, any> | null;
1286
+ logo?: Record<string, any> | null;
1287
+ follow?: Record<string, any> | null;
1170
1288
  }
1171
1289
  interface ValidateLinkRequest {
1172
1290
  /**
@@ -1190,268 +1308,150 @@ interface ValidateHtmlLinksResponse {
1190
1308
  /** Non-valid links. */
1191
1309
  blacklistedLinks?: string[];
1192
1310
  }
1193
- interface GetCampaignMappingRequest {
1194
- /**
1195
- * rule ID in automations
1196
- * @format GUID
1197
- */
1198
- automationRuleId?: string;
1199
- /**
1200
- * template ID configured for the automation
1201
- * @format GUID
1202
- */
1203
- templateId?: string;
1204
- }
1205
- interface GetCampaignMappingResponse {
1206
- /** @format GUID */
1207
- campaignId?: string;
1208
- }
1209
- interface UpsertTranslationRequest {
1210
- /**
1211
- * Campaign ID.
1212
- * @format GUID
1213
- */
1214
- campaignId?: string;
1215
- /** Composer data. */
1216
- composer?: Composer;
1217
- /**
1218
- * Translation language (optional, default value "EN").
1219
- * @format LANGUAGE
1220
- */
1221
- language?: string | null;
1222
- /**
1223
- * For BI event [36:1031] only (optional, default value "n/a").
1224
- * @format GUID
1225
- */
1226
- automationRuleId?: string | null;
1227
- /** Should campaign also be published or not (default value "false"). */
1228
- publish?: boolean;
1229
- /**
1230
- * Campaign subject (optional).
1231
- * @maxLength 1000
1232
- */
1233
- emailSubject?: string | null;
1311
+ interface EstimateFilterSizeRequest {
1312
+ /** Contacts filter expression. */
1313
+ filter?: Record<string, any> | null;
1314
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1315
+ activeContactsOnly?: boolean;
1234
1316
  /**
1235
- * Campaign preheader (optional).
1236
- * @maxLength 1000
1317
+ * Contacts plain text search expression (searches in name, phone and email fields).
1318
+ * @minLength 1
1319
+ * @maxLength 100
1237
1320
  */
1238
- emailPreheader?: string | null;
1321
+ search?: string | null;
1239
1322
  }
1240
- interface UpsertTranslationResponse {
1323
+ interface EstimateFilterSizeResponse {
1324
+ /** Mailing list size estimation. */
1325
+ estimation?: number;
1241
1326
  }
1242
- interface GetUsedPlaceholderKeysRequest {
1327
+ interface EstimateAudienceSizeRequest {
1243
1328
  /**
1244
- * Campaign ID.
1329
+ * Contact IDs of a campaign audience.
1245
1330
  * @format GUID
1246
1331
  */
1247
- campaignId?: string;
1248
- }
1249
- interface GetUsedPlaceholderKeysResponse {
1250
- /**
1251
- * Keys of placeholders used in the automation.
1252
- * @maxLength 200
1253
- * @maxSize 300
1254
- */
1255
- placeholderKeys?: string[];
1256
- }
1257
- interface LookupCampaignMappingRequest {
1332
+ contactIds?: string[];
1333
+ /** Label IDs of a campaign audience. */
1334
+ labelIds?: string[];
1335
+ /** Contacts filter expression (json). */
1336
+ contactsFilter?: Record<string, any> | null;
1258
1337
  /**
1259
- * rule ID in automations
1260
- * @format GUID
1338
+ * Contacts plain text search expression (searches in name, phone and email fields).
1339
+ * @minLength 1
1340
+ * @maxLength 100
1261
1341
  */
1262
- automationRuleId?: string;
1342
+ search?: string | null;
1263
1343
  /**
1264
- * template ID configured for the automation
1344
+ * Segment ids of a campaign audience.
1265
1345
  * @format GUID
1266
1346
  */
1267
- templateId?: string;
1268
- }
1269
- interface LookupCampaignMappingResponse {
1270
- /** @format GUID */
1271
- campaignId?: string | null;
1272
- }
1273
- interface UpsertAutomationTranslatorContentRequest {
1347
+ segmentIds?: string[];
1348
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1349
+ activeContactsOnly?: boolean;
1274
1350
  /**
1275
- * Campaign ID that the content belongs to
1351
+ * Id of a campaign that is to be resent.
1276
1352
  * @format GUID
1277
1353
  */
1278
- campaignId?: string;
1279
- /** Automation translator content */
1280
- automationTranslatorContent?: AutomationTranslatorContent;
1281
- }
1282
- /** Automation Translator Content */
1283
- interface AutomationTranslatorContent {
1284
- /**
1285
- * AutomationTranslatorContent ID
1286
- * @minLength 1
1287
- * @maxLength 256
1288
- * @immutable
1289
- */
1290
- _id?: string;
1291
- /**
1292
- * Content that can contain multiple strings. It represents a json file, that is stored on Smartling
1293
- * @minLength 1
1294
- * @maxLength 800000
1295
- */
1296
- json?: string;
1354
+ resendCampaignId?: string | null;
1355
+ /** Should total number of contacts in provided audience be returned or not (default value "false"). */
1356
+ withTotal?: boolean;
1297
1357
  }
1298
- interface UpsertAutomationTranslatorContentResponse {
1358
+ interface EstimateAudienceSizeResponse {
1359
+ /** Audience size (estimated number of emails to be sent). */
1360
+ estimation?: number;
1361
+ /** Total number of contacts in provided audience (optional). */
1362
+ total?: number | null;
1299
1363
  }
1300
- interface GetAutomationTranslatorContentRequest {
1364
+ interface ReconcileContactRequest {
1301
1365
  /**
1302
- * Campaign ID
1303
- * @format GUID
1366
+ * Email address of the contact.
1367
+ * @format EMAIL
1304
1368
  */
1305
- campaignId?: string;
1369
+ emailAddress?: string;
1306
1370
  }
1307
- interface GetAutomationTranslatorContentResponse {
1308
- /** Automation translator content */
1309
- automationTranslatorContent?: AutomationTranslatorContent;
1371
+ interface ReconcileContactResponse {
1372
+ /** Created or retrieved contact. */
1373
+ contact?: Contact;
1310
1374
  }
1311
- interface SendTestBulkRequest {
1375
+ interface Contact {
1312
1376
  /**
1313
- * Campaign ID
1377
+ * Unique ID of the contact entity.
1314
1378
  * @format GUID
1315
1379
  */
1316
- campaignId?: string;
1380
+ _id?: string;
1317
1381
  /**
1318
- * Recipient email address
1382
+ * Primary email address of the contact.
1319
1383
  * @format EMAIL
1320
1384
  */
1321
- toEmailAddress?: string;
1322
- /** Values to replace campaign placeholders with (unique for each campaign) */
1323
- placeholders?: Record<string, PlaceholderContent>;
1385
+ emailAddress?: string;
1324
1386
  /**
1325
- * Sender from name
1387
+ * Full name of the contact (optional).
1326
1388
  * @maxLength 100
1327
1389
  */
1328
- fromName?: string | null;
1329
- /**
1330
- * Reply-to email address
1331
- * @format EMAIL
1332
- */
1333
- replyToEmailAddress?: string | null;
1390
+ fullName?: string | null;
1334
1391
  /**
1335
- * Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
1336
- * @format LANGUAGE
1392
+ * Profile picture of the contact (optional).
1393
+ * @format WEB_URL
1394
+ * @maxLength 2048
1337
1395
  */
1338
- language?: string | null;
1339
- }
1340
- interface SendTestBulkResponse {
1396
+ pictureUrl?: string | null;
1341
1397
  }
1342
- interface ListStatisticsRequest {
1398
+ interface SearchContactsRequest {
1343
1399
  /**
1344
- * IDs of the campaigns to retrieve (max 100 campaigns).
1345
- * @format GUID
1346
- * @minSize 1
1347
- * @maxSize 100
1400
+ * Text to search contacts by - can search by name or email address.
1401
+ * @maxLength 100
1348
1402
  */
1349
- campaignIds: string[];
1350
- }
1351
- interface ListStatisticsResponse {
1352
- /** List of statistics. */
1353
- statistics?: CampaignStatisticsContainer[];
1354
- }
1355
- interface CampaignStatisticsContainer {
1403
+ searchTerm?: string;
1404
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1405
+ activeContactsOnly?: boolean;
1356
1406
  /**
1357
- * Campaign ID.
1358
- * @format GUID
1407
+ * Page size (default 50, max 1000).
1408
+ * @max 1000
1359
1409
  */
1360
- campaignId?: string;
1361
- /** Landing page statistics. */
1362
- landingPage?: LandingPageStatistics;
1363
- /** Email campaign statistics. */
1364
- email?: DistributionStatistics;
1410
+ pageSize?: number | null;
1365
1411
  }
1366
- interface ListRecipientsRequest {
1367
- /**
1368
- * Campaign ID.
1369
- * @format GUID
1370
- */
1371
- campaignId: string;
1372
- /** Email activity to filter. */
1373
- activity: RecipientsActivityEnumWithLiterals;
1374
- /** Pagination options. */
1375
- paging?: CursorPaging;
1412
+ interface SearchContactsResponse {
1413
+ /** Search results. */
1414
+ contacts?: Contact[];
1376
1415
  }
1377
- declare enum RecipientsActivityEnum {
1378
- UNKNOWN = "UNKNOWN",
1379
- DELIVERED = "DELIVERED",
1380
- OPENED = "OPENED",
1381
- CLICKED = "CLICKED",
1382
- BOUNCED = "BOUNCED",
1383
- NOT_SENT = "NOT_SENT",
1384
- SENT = "SENT",
1385
- NOT_OPENED = "NOT_OPENED"
1416
+ interface GetLabelsRequest {
1417
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1418
+ activeContactsOnly?: boolean;
1386
1419
  }
1387
- /** @enumType */
1388
- type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
1389
- interface CursorPaging {
1420
+ interface GetLabelsResponse {
1421
+ /** Returned labels with contact counts. */
1422
+ labels?: Label[];
1423
+ }
1424
+ interface Label {
1390
1425
  /**
1391
- * Number of items to load.
1392
- * @max 1000
1426
+ * Unique ID of the label entity.
1427
+ * @maxLength 100
1393
1428
  */
1394
- limit?: number | null;
1429
+ _id?: string;
1395
1430
  /**
1396
- * Pointer to the next or previous page in the list of results.
1397
- *
1398
- * You can get the relevant cursor token
1399
- * from the `pagingMetadata` object in the previous call's response.
1400
- * Not relevant for the first request.
1401
- * @maxLength 1000
1431
+ * Name of the label.
1432
+ * @maxLength 100
1402
1433
  */
1403
- cursor?: string | null;
1404
- }
1405
- interface ListRecipientsResponse {
1406
- /** List of recipients. */
1407
- recipients?: CampaignRecipientDetails[];
1408
- /** Details on the paged set of returned results. */
1409
- pagingMetadata?: PagingMetadataV2;
1434
+ name?: string;
1435
+ /** Amount of contacts assigned to the label. */
1436
+ contactsCount?: number;
1410
1437
  }
1411
- interface CampaignRecipientDetails {
1438
+ interface SubscribeFromLandingPageRequest {
1412
1439
  /**
1413
- * Contact ID.
1440
+ * Campaign ID that the subscription is happening from.
1414
1441
  * @format GUID
1415
1442
  */
1416
- contactId?: string;
1417
- /** Date and time of the last activity. */
1418
- lastActivityDate?: Date | null;
1443
+ campaignId?: string;
1419
1444
  /**
1420
- * Primary email address of the contact.
1445
+ * Email address that is entered into subscription field.
1421
1446
  * @format EMAIL
1422
1447
  */
1423
1448
  emailAddress?: string;
1424
- /**
1425
- * Full name of the contact (optional).
1426
- * @maxLength 100
1427
- */
1428
- fullName?: string | null;
1429
- /** Is this contact currently deleted from the site or not. */
1430
- contactDeleted?: boolean;
1431
- }
1432
- interface PagingMetadataV2 {
1433
- /** Number of items returned in the response. */
1434
- count?: number | null;
1435
- /** Offset that was requested. */
1436
- offset?: number | null;
1437
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1438
- total?: number | null;
1439
- /** Flag that indicates the server failed to calculate the `total` field. */
1440
- tooManyToCount?: boolean | null;
1441
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1442
- cursors?: Cursors;
1449
+ /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
1450
+ consent?: boolean;
1443
1451
  }
1444
- interface Cursors {
1445
- /**
1446
- * Cursor string pointing to the next page in the list of results.
1447
- * @maxLength 16000
1448
- */
1449
- next?: string | null;
1450
- /**
1451
- * Cursor pointing to the previous page in the list of results.
1452
- * @maxLength 16000
1453
- */
1454
- prev?: string | null;
1452
+ interface SubscribeFromLandingPageResponse {
1453
+ /** @format GUID */
1454
+ contactId?: string;
1455
1455
  }
1456
1456
  /** @docsIgnore */
1457
1457
  type PublishCampaignApplicationErrors = {
@@ -1521,6 +1521,8 @@ interface CampaignDistributedEnvelope {
1521
1521
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1522
1522
  * @permissionScope Access Verticals by Automations
1523
1523
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1524
+ * @permissionScope Manage Restaurants - all permissions
1525
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1524
1526
  * @permissionScope Set Up Automations
1525
1527
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1526
1528
  * @permissionScope Read Email Marketing
@@ -1544,6 +1546,8 @@ interface CampaignPausedEnvelope {
1544
1546
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1545
1547
  * @permissionScope Access Verticals by Automations
1546
1548
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1549
+ * @permissionScope Manage Restaurants - all permissions
1550
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1547
1551
  * @permissionScope Set Up Automations
1548
1552
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1549
1553
  * @permissionScope Read Email Marketing
@@ -1567,6 +1571,8 @@ interface CampaignPublishedEnvelope {
1567
1571
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1568
1572
  * @permissionScope Access Verticals by Automations
1569
1573
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1574
+ * @permissionScope Manage Restaurants - all permissions
1575
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1570
1576
  * @permissionScope Set Up Automations
1571
1577
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1572
1578
  * @permissionScope Read Email Marketing
@@ -1590,6 +1596,8 @@ interface CampaignRejectedEnvelope {
1590
1596
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1591
1597
  * @permissionScope Access Verticals by Automations
1592
1598
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1599
+ * @permissionScope Manage Restaurants - all permissions
1600
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1593
1601
  * @permissionScope Set Up Automations
1594
1602
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1595
1603
  * @permissionScope Read Email Marketing
@@ -1613,6 +1621,8 @@ interface CampaignScheduledEnvelope {
1613
1621
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1614
1622
  * @permissionScope Access Verticals by Automations
1615
1623
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1624
+ * @permissionScope Manage Restaurants - all permissions
1625
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1616
1626
  * @permissionScope Set Up Automations
1617
1627
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1618
1628
  * @permissionScope Read Email Marketing
@@ -1636,6 +1646,8 @@ interface CampaignTerminatedEnvelope {
1636
1646
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1637
1647
  * @permissionScope Access Verticals by Automations
1638
1648
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1649
+ * @permissionScope Manage Restaurants - all permissions
1650
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1639
1651
  * @permissionScope Set Up Automations
1640
1652
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1641
1653
  * @permissionScope Read Email Marketing
@@ -1659,6 +1671,8 @@ interface CampaignCreatedEnvelope {
1659
1671
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1660
1672
  * @permissionScope Access Verticals by Automations
1661
1673
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1674
+ * @permissionScope Manage Restaurants - all permissions
1675
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1662
1676
  * @permissionScope Set Up Automations
1663
1677
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1664
1678
  * @permissionScope Read Email Marketing
@@ -1681,6 +1695,8 @@ interface CampaignDeletedEnvelope {
1681
1695
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1682
1696
  * @permissionScope Access Verticals by Automations
1683
1697
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1698
+ * @permissionScope Manage Restaurants - all permissions
1699
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1684
1700
  * @permissionScope Set Up Automations
1685
1701
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1686
1702
  * @permissionScope Read Email Marketing
@@ -1704,6 +1720,8 @@ interface CampaignEmailActivityUpdatedEnvelope {
1704
1720
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1705
1721
  * @permissionScope Access Verticals by Automations
1706
1722
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1723
+ * @permissionScope Manage Restaurants - all permissions
1724
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1707
1725
  * @permissionScope Set Up Automations
1708
1726
  * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1709
1727
  * @permissionScope Read Email Marketing
@@ -1717,6 +1735,46 @@ interface CampaignEmailActivityUpdatedEnvelope {
1717
1735
  * @slug email_activity_updated
1718
1736
  */
1719
1737
  declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
1738
+ /**
1739
+ * Retrieves a list of statistics for up to 100 selected campaigns.
1740
+ *
1741
+ * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
1742
+ * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
1743
+ *
1744
+ * Call List Campaigns to retrieve additional information for a site's campaigns.
1745
+ * Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
1746
+ * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
1747
+ * @public
1748
+ * @requiredField campaignIds
1749
+ * @permissionId Shoutout.Read
1750
+ * @applicableIdentity APP
1751
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
1752
+ */
1753
+ declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
1754
+ /**
1755
+ * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
1756
+ *
1757
+ * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
1758
+ *
1759
+ * Call List Statistics to retrieve a list of activity for selected campaigns.
1760
+ * Call List Campaigns to retrieve additional information for your campaigns.
1761
+ *
1762
+ * If no `activity` is included, this method returns an error.
1763
+ * @param campaignId - Campaign ID.
1764
+ * @param activity - Email activity to filter.
1765
+ * @public
1766
+ * @requiredField activity
1767
+ * @requiredField campaignId
1768
+ * @param options - Options to use when getting the list of recipients.
1769
+ * @permissionId Shoutout.Read
1770
+ * @applicableIdentity APP
1771
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
1772
+ */
1773
+ declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
1774
+ interface ListRecipientsOptions {
1775
+ /** Pagination options. */
1776
+ paging?: CursorPaging;
1777
+ }
1720
1778
  /**
1721
1779
  * Retrieves information about an email campaign.
1722
1780
  * @param campaignId - Campaign ID.
@@ -1891,45 +1949,5 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
1891
1949
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
1892
1950
  */
1893
1951
  declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
1894
- /**
1895
- * Retrieves a list of statistics for up to 100 selected campaigns.
1896
- *
1897
- * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
1898
- * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
1899
- *
1900
- * Call List Campaigns to retrieve additional information for a site's campaigns.
1901
- * Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
1902
- * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
1903
- * @public
1904
- * @requiredField campaignIds
1905
- * @permissionId Shoutout.Read
1906
- * @applicableIdentity APP
1907
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
1908
- */
1909
- declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
1910
- /**
1911
- * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
1912
- *
1913
- * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
1914
- *
1915
- * Call List Statistics to retrieve a list of activity for selected campaigns.
1916
- * Call List Campaigns to retrieve additional information for your campaigns.
1917
- *
1918
- * If no `activity` is included, this method returns an error.
1919
- * @param campaignId - Campaign ID.
1920
- * @param activity - Email activity to filter.
1921
- * @public
1922
- * @requiredField activity
1923
- * @requiredField campaignId
1924
- * @param options - Options to use when getting the list of recipients.
1925
- * @permissionId Shoutout.Read
1926
- * @applicableIdentity APP
1927
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
1928
- */
1929
- declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
1930
- interface ListRecipientsOptions {
1931
- /** Pagination options. */
1932
- paging?: CursorPaging;
1933
- }
1934
1952
 
1935
1953
  export { type ActionEvent, ActivityType, type ActivityTypeWithLiterals, type ArchiveCampaignRequest, type ArchiveCampaignResponse, type Archived, type Attachment, type AutomationTranslatorContent, type BaseEventMetadata, type Campaign, type CampaignAudience, type CampaignCreatedEnvelope, type CampaignDeletedEnvelope, type CampaignDistributedEnvelope, type CampaignEditorType, CampaignEditorTypeEnum, type CampaignEditorTypeEnumWithLiterals, type CampaignEmailActivityUpdatedEnvelope, type CampaignPausedEnvelope, type CampaignPublishedEnvelope, type CampaignRecipientDetails, type CampaignRejectedEnvelope, type CampaignScheduledEnvelope, CampaignSendingStateEnum, type CampaignSendingStateEnumWithLiterals, type CampaignStatistics, type CampaignStatisticsContainer, CampaignStatusEnum, type CampaignStatusEnumWithLiterals, type CampaignTerminatedEnvelope, CampaignTypeEnum, type CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, type CampaignVisibilityStatusEnumWithLiterals, type Click, type Composer, type Contact, type CountCampaignsRequest, type CountCampaignsResponse, type CreateCampaignRequest, type CreateCampaignResponse, type CreateFromTemplateRequest, type CreateFromTemplateResponse, type CreateFromUserTemplateRequest, type CreateFromUserTemplateResponse, type CreateUserTemplateRequest, type CreateUserTemplateResponse, type CursorPaging, type Cursors, type DateTime, type Decimal, type DefaultValues, type DeleteCampaignRequest, type DeleteCampaignResponse, type Distributed, type DistributionStatistics, type DomainEvent, type DomainEventBodyOneOf, type EmailActivityUpdated, type EmailActivityUpdatedEventTypeOneOf, type EmailDistributionOptions, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EstimateAudienceSizeRequest, type EstimateAudienceSizeResponse, type EstimateFilterSizeRequest, type EstimateFilterSizeResponse, type EventMetadata, type GetAudienceRequest, type GetAudienceResponse, type GetAutomationTranslatorContentRequest, type GetAutomationTranslatorContentResponse, type GetCampaignMappingRequest, type GetCampaignMappingResponse, type GetCampaignOptions, type GetCampaignRequest, type GetCampaignResponse, type GetComposerRequest, type GetComposerResponse, type GetDefaultComponentsRequest, type GetDefaultComponentsResponse, type GetLabelsRequest, type GetLabelsResponse, type GetPlaceholderKeysRequest, type GetPlaceholderKeysResponse, type GetUsedPlaceholderKeysRequest, type GetUsedPlaceholderKeysResponse, type HardBounce, type Html, type IdentificationData, type IdentificationDataIdOneOf, type IdentifySenderAddressRequest, type IdentifySenderAddressResponse, type Integer, type Label, type LandingPageStatistics, type ListCampaignsOptions, type ListCampaignsRequest, type ListCampaignsResponse, type ListRecipientsOptions, type ListRecipientsRequest, type ListRecipientsResponse, type ListStatisticsRequest, type ListStatisticsResponse, type LookupCampaignMappingRequest, type LookupCampaignMappingResponse, type Map, type MessageEnvelope, type Money, type Open, type Paging, type PagingMetadataV2, type PauseSchedulingRequest, type PauseSchedulingResponse, type Paused, type PlaceholderContent, type PlaceholderContentEnum, type PlaceholderContentValueOneOf, type PlainText, type PreviewCampaignRequest, type PreviewCampaignResponse, type PublishCampaignApplicationErrors, type PublishCampaignOptions, type PublishCampaignRequest, type PublishCampaignResponse, type Published, type PublishingData, RecipientsActivityEnum, type RecipientsActivityEnumWithLiterals, type ReconcileContactRequest, type ReconcileContactResponse, type Rejected, type RejectionData, RejectionReasonEnum, type RejectionReasonEnumWithLiterals, type RescheduleRequest, type RescheduleResponse, type ResendToNonOpenersRequest, type ResendToNonOpenersResponse, type RestoreInfo, type ReuseCampaignRequest, type ReuseCampaignResponse, type Scheduled, type SearchContactsRequest, type SearchContactsResponse, type SendTestBulkRequest, type SendTestBulkResponse, type SendTestOptions, type SendTestRequest, type SendTestResponse, type SoftBounce, type SubscribeFromLandingPageRequest, type SubscribeFromLandingPageResponse, type Terminated, type TotalStatistics, type UnarchiveCampaignRequest, type UnarchiveCampaignResponse, type Unarchived, type UpdateComposerRequest, type UpdateComposerResponse, type UpdateTitleRequest, type UpdateTitleResponse, type UpsertAutomationTranslatorContentRequest, type UpsertAutomationTranslatorContentResponse, type UpsertTranslationRequest, type UpsertTranslationResponse, type ValidateHtmlLinksRequest, type ValidateHtmlLinksResponse, type ValidateLinkRequest, type ValidateLinkResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };