@wix/auto_sdk_email-marketing_campaigns 1.0.5 → 1.0.6

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 (73) hide show
  1. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +5 -5
  2. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js +4 -4
  3. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
  4. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.d.ts +22 -22
  5. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js +72 -192
  6. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js.map +1 -1
  7. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +4 -4
  8. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +39 -39
  9. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
  10. package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +37 -37
  11. package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js +13 -13
  12. package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
  13. package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts +653 -291
  14. package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js +12 -12
  15. package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
  16. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +851 -433
  17. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +146 -120
  18. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
  19. package/build/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +5 -5
  20. package/build/es/src/email-marketing-v1-campaign-campaigns.context.js +4 -4
  21. package/build/es/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
  22. package/build/es/src/email-marketing-v1-campaign-campaigns.http.d.ts +22 -22
  23. package/build/es/src/email-marketing-v1-campaign-campaigns.http.js +69 -189
  24. package/build/es/src/email-marketing-v1-campaign-campaigns.http.js.map +1 -1
  25. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +4 -4
  26. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js +36 -36
  27. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
  28. package/build/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +37 -37
  29. package/build/es/src/email-marketing-v1-campaign-campaigns.public.js +10 -10
  30. package/build/es/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
  31. package/build/es/src/email-marketing-v1-campaign-campaigns.types.d.ts +653 -291
  32. package/build/es/src/email-marketing-v1-campaign-campaigns.types.js +11 -11
  33. package/build/es/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
  34. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +851 -433
  35. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js +143 -117
  36. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
  37. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +5 -5
  38. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js +4 -4
  39. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
  40. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.d.ts +22 -22
  41. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js +72 -192
  42. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js.map +1 -1
  43. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +4 -4
  44. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +39 -39
  45. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
  46. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +37 -37
  47. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js +13 -13
  48. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
  49. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts +653 -291
  50. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js +12 -12
  51. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
  52. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +851 -433
  53. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +146 -120
  54. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
  55. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +5 -5
  56. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js +4 -4
  57. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js.map +1 -1
  58. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.d.ts +22 -22
  59. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js +69 -189
  60. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js.map +1 -1
  61. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +4 -4
  62. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js +36 -36
  63. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
  64. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +37 -37
  65. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js +10 -10
  66. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
  67. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.d.ts +653 -291
  68. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js +11 -11
  69. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
  70. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +851 -433
  71. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js +143 -117
  72. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
  73. package/package.json +2 -2
@@ -1,14 +1,21 @@
1
1
  export interface Campaign {
2
- /** Campaign ID. */
2
+ /**
3
+ * Campaign ID.
4
+ * @format GUID
5
+ */
3
6
  campaignId?: string;
4
7
  /** Marketing campaign title. If you don't provide the value, the title automatically gets the value of an email subject. */
5
8
  title?: string | null;
6
- /** URL of the first image after the logo. */
9
+ /**
10
+ * URL of the first image after the logo.
11
+ * @format WEB_URL
12
+ */
7
13
  firstImageUrl?: string | null;
8
14
  /**
9
15
  * Landing page snapshot URL. <br>
10
16
  * This field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.
11
17
  * The value of this field will soon become the same as the value of the `firstImageUrl` field.
18
+ * @format WEB_URL
12
19
  * @deprecated Landing page snapshot URL. <br>
13
20
  * This field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.
14
21
  * The value of this field will soon become the same as the value of the `firstImageUrl` field.
@@ -59,6 +66,7 @@ export interface Campaign {
59
66
  /**
60
67
  * Email subject of the campaign (initially copied from the template).
61
68
  * TODO: Deprecated (moved to "GetComposerResponse").
69
+ * @maxLength 1000
62
70
  * @deprecated
63
71
  */
64
72
  emailSubject?: string;
@@ -118,7 +126,10 @@ export declare enum Enum {
118
126
  PAUSED = "PAUSED"
119
127
  }
120
128
  export interface PublishingData {
121
- /** Landing page URL. */
129
+ /**
130
+ * Landing page URL.
131
+ * @format WEB_URL
132
+ */
122
133
  landingPageUrl?: string;
123
134
  /** Marketing campaign statistics. */
124
135
  statistics?: CampaignStatistics;
@@ -224,12 +235,187 @@ export declare enum CampaignTypeEnum {
224
235
  /** triggered email */
225
236
  TRIGGERED = "TRIGGERED"
226
237
  }
238
+ export interface ValidateLinkRequest {
239
+ /**
240
+ * URL to validate.
241
+ * @minLength 1
242
+ */
243
+ url: string;
244
+ }
245
+ export interface ValidateLinkResponse {
246
+ /** Whether the link is valid. */
247
+ valid?: boolean;
248
+ }
249
+ export interface ValidateHtmlLinksRequest {
250
+ /**
251
+ * HTML string with links.
252
+ * @maxLength 1000000
253
+ */
254
+ html: string;
255
+ }
256
+ export interface ValidateHtmlLinksResponse {
257
+ /** Non-valid links. */
258
+ blacklistedLinks?: string[];
259
+ }
260
+ export interface GetCampaignMappingRequest {
261
+ /**
262
+ * rule ID in automations
263
+ * @format GUID
264
+ */
265
+ automationRuleId?: string;
266
+ /**
267
+ * template ID configured for the automation
268
+ * @format GUID
269
+ */
270
+ templateId?: string;
271
+ }
272
+ export interface GetCampaignMappingResponse {
273
+ /** @format GUID */
274
+ campaignId?: string;
275
+ }
276
+ export interface UpsertTranslationRequest {
277
+ /**
278
+ * Campaign ID.
279
+ * @format GUID
280
+ */
281
+ campaignId?: string;
282
+ /** Composer data. */
283
+ composer?: Composer;
284
+ /**
285
+ * Translation language (optional, default value "EN").
286
+ * @format LANGUAGE
287
+ */
288
+ language?: string | null;
289
+ /**
290
+ * For BI event [36:1031] only (optional, default value "n/a").
291
+ * @format GUID
292
+ */
293
+ automationRuleId?: string | null;
294
+ /** Should campaign also be published or not (default value "false"). */
295
+ publish?: boolean;
296
+ /**
297
+ * Campaign subject (optional).
298
+ * @maxLength 1000
299
+ */
300
+ emailSubject?: string | null;
301
+ /**
302
+ * Campaign preheader (optional).
303
+ * @maxLength 1000
304
+ */
305
+ emailPreheader?: string | null;
306
+ }
307
+ export interface Composer {
308
+ /**
309
+ * Internal data structure for editor/viewer to render the campaign.
310
+ * @maxLength 10000000
311
+ */
312
+ composerDataJson?: string;
313
+ /** Default values of existing placeholders. */
314
+ defaultValues?: DefaultValues;
315
+ }
316
+ export interface DefaultValues {
317
+ /** @maxSize 500 */
318
+ map?: Record<string, string>;
319
+ }
320
+ export interface UpsertTranslationResponse {
321
+ }
322
+ export interface GetUsedPlaceholderKeysRequest {
323
+ /**
324
+ * Campaign ID.
325
+ * @format GUID
326
+ */
327
+ campaignId?: string;
328
+ }
329
+ export interface GetUsedPlaceholderKeysResponse {
330
+ /**
331
+ * Keys of placeholders used in the automation.
332
+ * @maxLength 200
333
+ * @maxSize 300
334
+ */
335
+ placeholderKeys?: string[];
336
+ }
337
+ export interface LookupCampaignMappingRequest {
338
+ /**
339
+ * rule ID in automations
340
+ * @format GUID
341
+ */
342
+ automationRuleId?: string;
343
+ /**
344
+ * template ID configured for the automation
345
+ * @format GUID
346
+ */
347
+ templateId?: string;
348
+ }
349
+ export interface LookupCampaignMappingResponse {
350
+ /** @format GUID */
351
+ campaignId?: string | null;
352
+ }
353
+ export interface UpsertAutomationTranslatorContentRequest {
354
+ /**
355
+ * Campaign ID that the content belongs to
356
+ * @format GUID
357
+ */
358
+ campaignId?: string;
359
+ /** Automation translator content */
360
+ automationTranslatorContent?: AutomationTranslatorContent;
361
+ }
362
+ /** Automation Translator Content */
363
+ export interface AutomationTranslatorContent {
364
+ /**
365
+ * AutomationTranslatorContent ID
366
+ * @minLength 1
367
+ * @maxLength 256
368
+ * @immutable
369
+ */
370
+ _id?: string;
371
+ /**
372
+ * Content that can contain multiple strings. It represents a json file, that is stored on Smartling
373
+ * @minLength 1
374
+ * @maxLength 800000
375
+ */
376
+ json?: string;
377
+ }
378
+ export interface UpsertAutomationTranslatorContentResponse {
379
+ }
380
+ export interface GetAutomationTranslatorContentRequest {
381
+ /**
382
+ * Campaign ID
383
+ * @format GUID
384
+ */
385
+ campaignId?: string;
386
+ }
387
+ export interface GetAutomationTranslatorContentResponse {
388
+ /** Automation translator content */
389
+ automationTranslatorContent?: AutomationTranslatorContent;
390
+ }
391
+ export interface GetPlaceholderKeysRequest {
392
+ /**
393
+ * Campaign ID.
394
+ * @format GUID
395
+ */
396
+ campaignId?: string;
397
+ }
398
+ export interface GetPlaceholderKeysResponse {
399
+ /** Keys of placeholders used in the campaign. */
400
+ placeholderKeys?: string[];
401
+ }
402
+ export interface GetDefaultComponentsRequest {
403
+ }
404
+ export interface GetDefaultComponentsResponse {
405
+ footer?: Record<string, any> | null;
406
+ logo?: Record<string, any> | null;
407
+ follow?: Record<string, any> | null;
408
+ }
227
409
  export interface EstimateFilterSizeRequest {
228
410
  /** Contacts filter expression. */
229
411
  filter?: Record<string, any> | null;
230
412
  /** Should "inactive" contacts be excluded or not (default value "false"). */
231
413
  activeContactsOnly?: boolean;
232
- /** Contacts plain text search expression (searches in name, phone and email fields). */
414
+ /**
415
+ * Contacts plain text search expression (searches in name, phone and email fields).
416
+ * @minLength 1
417
+ * @maxLength 100
418
+ */
233
419
  search?: string | null;
234
420
  }
235
421
  export interface EstimateFilterSizeResponse {
@@ -237,19 +423,32 @@ export interface EstimateFilterSizeResponse {
237
423
  estimation?: number;
238
424
  }
239
425
  export interface EstimateAudienceSizeRequest {
240
- /** Contact IDs of a campaign audience. */
426
+ /**
427
+ * Contact IDs of a campaign audience.
428
+ * @format GUID
429
+ */
241
430
  contactIds?: string[];
242
431
  /** Label IDs of a campaign audience. */
243
432
  labelIds?: string[];
244
433
  /** Contacts filter expression (json). */
245
434
  contactsFilter?: Record<string, any> | null;
246
- /** Contacts plain text search expression (searches in name, phone and email fields). */
435
+ /**
436
+ * Contacts plain text search expression (searches in name, phone and email fields).
437
+ * @minLength 1
438
+ * @maxLength 100
439
+ */
247
440
  search?: string | null;
248
- /** Segment ids of a campaign audience. */
441
+ /**
442
+ * Segment ids of a campaign audience.
443
+ * @format GUID
444
+ */
249
445
  segmentIds?: string[];
250
446
  /** Should "inactive" contacts be excluded or not (default value "false"). */
251
447
  activeContactsOnly?: boolean;
252
- /** Id of a campaign that is to be resent. */
448
+ /**
449
+ * Id of a campaign that is to be resent.
450
+ * @format GUID
451
+ */
253
452
  resendCampaignId?: string | null;
254
453
  /** Should total number of contacts in provided audience be returned or not (default value "false"). */
255
454
  withTotal?: boolean;
@@ -261,7 +460,10 @@ export interface EstimateAudienceSizeResponse {
261
460
  total?: number | null;
262
461
  }
263
462
  export interface ReconcileContactRequest {
264
- /** Email address of the contact. */
463
+ /**
464
+ * Email address of the contact.
465
+ * @format EMAIL
466
+ */
265
467
  emailAddress?: string;
266
468
  }
267
469
  export interface ReconcileContactResponse {
@@ -269,21 +471,40 @@ export interface ReconcileContactResponse {
269
471
  contact?: Contact;
270
472
  }
271
473
  export interface Contact {
272
- /** Unique ID of the contact entity. */
474
+ /**
475
+ * Unique ID of the contact entity.
476
+ * @format GUID
477
+ */
273
478
  _id?: string;
274
- /** Primary email address of the contact. */
479
+ /**
480
+ * Primary email address of the contact.
481
+ * @format EMAIL
482
+ */
275
483
  emailAddress?: string;
276
- /** Full name of the contact (optional). */
484
+ /**
485
+ * Full name of the contact (optional).
486
+ * @maxLength 100
487
+ */
277
488
  fullName?: string | null;
278
- /** Profile picture of the contact (optional). */
489
+ /**
490
+ * Profile picture of the contact (optional).
491
+ * @format WEB_URL
492
+ * @maxLength 2048
493
+ */
279
494
  pictureUrl?: string | null;
280
495
  }
281
496
  export interface SearchContactsRequest {
282
- /** Text to search contacts by - can search by name or email address. */
497
+ /**
498
+ * Text to search contacts by - can search by name or email address.
499
+ * @maxLength 100
500
+ */
283
501
  searchTerm?: string;
284
502
  /** Should "inactive" contacts be excluded or not (default value "false"). */
285
503
  activeContactsOnly?: boolean;
286
- /** Page size (default 50, max 1000). */
504
+ /**
505
+ * Page size (default 50, max 1000).
506
+ * @max 1000
507
+ */
287
508
  pageSize?: number | null;
288
509
  }
289
510
  export interface SearchContactsResponse {
@@ -299,222 +520,42 @@ export interface GetLabelsResponse {
299
520
  labels?: Label[];
300
521
  }
301
522
  export interface Label {
302
- /** Unique ID of the label entity. */
523
+ /**
524
+ * Unique ID of the label entity.
525
+ * @maxLength 100
526
+ */
303
527
  _id?: string;
304
- /** Name of the label. */
528
+ /**
529
+ * Name of the label.
530
+ * @maxLength 100
531
+ */
305
532
  name?: string;
306
533
  /** Amount of contacts assigned to the label. */
307
534
  contactsCount?: number;
308
535
  }
309
536
  export interface SubscribeFromLandingPageRequest {
310
- /** Campaign ID that the subscription is happening from. */
537
+ /**
538
+ * Campaign ID that the subscription is happening from.
539
+ * @format GUID
540
+ */
311
541
  campaignId?: string;
312
- /** Email address that is entered into subscription field. */
542
+ /**
543
+ * Email address that is entered into subscription field.
544
+ * @format EMAIL
545
+ */
313
546
  emailAddress?: string;
314
547
  /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
315
548
  consent?: boolean;
316
549
  }
317
550
  export interface SubscribeFromLandingPageResponse {
551
+ /** @format GUID */
318
552
  contactId?: string;
319
553
  }
320
- export interface GetPlaceholderKeysRequest {
321
- /** Campaign ID. */
322
- campaignId?: string;
323
- }
324
- export interface GetPlaceholderKeysResponse {
325
- /** Keys of placeholders used in the campaign. */
326
- placeholderKeys?: string[];
327
- }
328
- export interface GetDefaultComponentsRequest {
329
- }
330
- export interface GetDefaultComponentsResponse {
331
- footer?: Record<string, any> | null;
332
- logo?: Record<string, any> | null;
333
- follow?: Record<string, any> | null;
334
- }
335
- export interface ValidateLinkRequest {
336
- /** URL to validate. */
337
- url: string;
338
- }
339
- export interface ValidateLinkResponse {
340
- /** Whether the link is valid. */
341
- valid?: boolean;
342
- }
343
- export interface ValidateHtmlLinksRequest {
344
- /** HTML string with links. */
345
- html: string;
346
- }
347
- export interface ValidateHtmlLinksResponse {
348
- /** Non-valid links. */
349
- blacklistedLinks?: string[];
350
- }
351
- export interface ListStatisticsRequest {
352
- /** IDs of the campaigns to retrieve (max 100 campaigns). */
353
- campaignIds: string[];
354
- }
355
- export interface ListStatisticsResponse {
356
- /** List of statistics. */
357
- statistics?: CampaignStatisticsContainer[];
358
- }
359
- export interface CampaignStatisticsContainer {
360
- /** Campaign ID. */
361
- campaignId?: string;
362
- /** Landing page statistics. */
363
- landingPage?: LandingPageStatistics;
364
- /** Email campaign statistics. */
365
- email?: DistributionStatistics;
366
- }
367
- export interface ListRecipientsRequest {
368
- /** Campaign ID. */
369
- campaignId: string;
370
- /**
371
- * __Required.__ Email activity to filter for. One of:
372
- * + `'DELIVERED'`
373
- * + `'OPENED'`
374
- * + `'CLICKED'`
375
- * + `'BOUNCED'`
376
- * + `'NOT_SENT'`
377
- */
378
- activity: RecipientsActivityEnum;
379
- /** Pagination options. */
380
- paging?: CursorPaging;
381
- }
382
- export declare enum RecipientsActivityEnum {
383
- UNKNOWN = "UNKNOWN",
384
- DELIVERED = "DELIVERED",
385
- OPENED = "OPENED",
386
- CLICKED = "CLICKED",
387
- BOUNCED = "BOUNCED",
388
- NOT_SENT = "NOT_SENT",
389
- SENT = "SENT",
390
- NOT_OPENED = "NOT_OPENED"
391
- }
392
- export interface CursorPaging {
393
- /** Number of items to load. */
394
- limit?: number | null;
554
+ export interface GetCampaignRequest {
395
555
  /**
396
- * Pointer to the next or previous page in the list of results.
397
- *
398
- * You can get the relevant cursor token
399
- * from the `pagingMetadata` object in the previous call's response.
400
- * Not relevant for the first request.
556
+ * Campaign ID.
557
+ * @format GUID
401
558
  */
402
- cursor?: string | null;
403
- }
404
- export interface ListRecipientsResponse {
405
- /** List of recipients. */
406
- recipients?: CampaignRecipientDetails[];
407
- /** Details on the paged set of returned results. */
408
- pagingMetadata?: PagingMetadataV2;
409
- }
410
- export interface CampaignRecipientDetails {
411
- /** Contact ID. */
412
- contactId?: string;
413
- /** Date and time of the last activity. */
414
- lastActivityDate?: Date | null;
415
- /** Primary email address of the contact. */
416
- emailAddress?: string;
417
- /** Full name of the contact (optional). */
418
- fullName?: string | null;
419
- /** Is this contact currently deleted from the site or not. */
420
- contactDeleted?: boolean;
421
- }
422
- export interface PagingMetadataV2 {
423
- /** Number of items returned in the response. */
424
- count?: number | null;
425
- /** Offset that was requested. */
426
- offset?: number | null;
427
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
428
- total?: number | null;
429
- /** Flag that indicates the server failed to calculate the `total` field. */
430
- tooManyToCount?: boolean | null;
431
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
432
- cursors?: Cursors;
433
- }
434
- export interface Cursors {
435
- /** Cursor string pointing to the next page in the list of results. */
436
- next?: string | null;
437
- /** Cursor pointing to the previous page in the list of results. */
438
- prev?: string | null;
439
- }
440
- export interface GetCampaignMappingRequest {
441
- /** rule ID in automations */
442
- automationRuleId?: string;
443
- /** template ID configured for the automation */
444
- templateId?: string;
445
- }
446
- export interface GetCampaignMappingResponse {
447
- campaignId?: string;
448
- }
449
- export interface UpsertTranslationRequest {
450
- /** Campaign ID. */
451
- campaignId?: string;
452
- /** Composer data. */
453
- composer?: Composer;
454
- /** Translation language (optional, default value "EN"). */
455
- language?: string | null;
456
- /** For BI event [36:1031] only (optional, default value "n/a"). */
457
- automationRuleId?: string | null;
458
- /** Should campaign also be published or not (default value "false"). */
459
- publish?: boolean;
460
- /** Campaign subject (optional). */
461
- emailSubject?: string | null;
462
- /** Campaign preheader (optional). */
463
- emailPreheader?: string | null;
464
- }
465
- export interface Composer {
466
- /** Internal data structure for editor/viewer to render the campaign. */
467
- composerDataJson?: string;
468
- /** Default values of existing placeholders. */
469
- defaultValues?: DefaultValues;
470
- }
471
- export interface DefaultValues {
472
- map?: Record<string, string>;
473
- }
474
- export interface UpsertTranslationResponse {
475
- }
476
- export interface GetUsedPlaceholderKeysRequest {
477
- /** Campaign ID. */
478
- campaignId?: string;
479
- }
480
- export interface GetUsedPlaceholderKeysResponse {
481
- /** Keys of placeholders used in the automation. */
482
- placeholderKeys?: string[];
483
- }
484
- export interface LookupCampaignMappingRequest {
485
- /** rule ID in automations */
486
- automationRuleId?: string;
487
- /** template ID configured for the automation */
488
- templateId?: string;
489
- }
490
- export interface LookupCampaignMappingResponse {
491
- campaignId?: string | null;
492
- }
493
- export interface UpsertAutomationTranslatorContentRequest {
494
- /** Campaign ID that the content belongs to */
495
- campaignId?: string;
496
- /** Automation translator content */
497
- automationTranslatorContent?: AutomationTranslatorContent;
498
- }
499
- /** Automation Translator Content */
500
- export interface AutomationTranslatorContent {
501
- /** AutomationTranslatorContent ID */
502
- _id?: string;
503
- /** Content that can contain multiple strings. It represents a json file, that is stored on Smartling */
504
- json?: string;
505
- }
506
- export interface UpsertAutomationTranslatorContentResponse {
507
- }
508
- export interface GetAutomationTranslatorContentRequest {
509
- /** Campaign ID */
510
- campaignId?: string;
511
- }
512
- export interface GetAutomationTranslatorContentResponse {
513
- /** Automation translator content */
514
- automationTranslatorContent?: AutomationTranslatorContent;
515
- }
516
- export interface GetCampaignRequest {
517
- /** Campaign ID. */
518
559
  campaignId: string;
519
560
  /**
520
561
  * Whether a returned campaign object should include `publishingData.statistics`.
@@ -580,7 +621,10 @@ export interface CountCampaignsResponse {
580
621
  archived?: number;
581
622
  }
582
623
  export interface CreateFromTemplateRequest {
583
- /** ID of the template to fork. */
624
+ /**
625
+ * ID of the template to fork.
626
+ * @format GUID
627
+ */
584
628
  templateId?: string;
585
629
  /** Values to replace template placeholders with (unique for each template). */
586
630
  variables?: Record<string, string>;
@@ -592,9 +636,15 @@ export interface CreateFromTemplateResponse {
592
636
  campaign?: Campaign;
593
637
  }
594
638
  export interface CreateUserTemplateRequest {
595
- /** ID of campaign to create template from. */
639
+ /**
640
+ * ID of campaign to create template from.
641
+ * @format GUID
642
+ */
596
643
  campaignId?: string;
597
- /** Title of template. */
644
+ /**
645
+ * Title of template.
646
+ * @maxLength 1000
647
+ */
598
648
  title?: string | null;
599
649
  }
600
650
  export interface CreateUserTemplateResponse {
@@ -602,7 +652,10 @@ export interface CreateUserTemplateResponse {
602
652
  campaign?: Campaign;
603
653
  }
604
654
  export interface CreateFromUserTemplateRequest {
605
- /** ID of the user template campaign to use. */
655
+ /**
656
+ * ID of the user template campaign to use.
657
+ * @format GUID
658
+ */
606
659
  campaignId?: string;
607
660
  }
608
661
  export interface CreateFromUserTemplateResponse {
@@ -610,20 +663,30 @@ export interface CreateFromUserTemplateResponse {
610
663
  campaign?: Campaign;
611
664
  }
612
665
  export interface PublishCampaignRequest {
613
- /** Campaign ID */
666
+ /**
667
+ * Campaign ID
668
+ * @format GUID
669
+ */
614
670
  campaignId: string;
615
671
  /** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
616
672
  emailDistributionOptions?: EmailDistributionOptions;
617
673
  }
618
674
  export interface EmailDistributionOptions {
619
- /** The subject line for the email campaign, which appears in recipients’ inboxes. */
675
+ /**
676
+ * The subject line for the email campaign, which appears in recipients’ inboxes.
677
+ * @maxLength 1000
678
+ */
620
679
  emailSubject?: string | null;
621
680
  /** Contact label IDs. */
622
681
  labelIds?: string[];
623
- /** IDs of contacts to whom to send out the campaign. */
682
+ /**
683
+ * IDs of contacts to whom to send out the campaign.
684
+ * @format GUID
685
+ */
624
686
  contactIds?: string[];
625
687
  /**
626
688
  * Filter ids to send campaign to (unsupported).
689
+ * @format GUID
627
690
  * @deprecated Filter ids to send campaign to (unsupported).
628
691
  * @replacedBy contacts_filter
629
692
  * @targetRemovalDate 2023-10-10
@@ -637,23 +700,39 @@ export interface PublishCampaignResponse {
637
700
  publishingData?: PublishingData;
638
701
  }
639
702
  export interface Rejected {
640
- /** ID of the campaign that was rejected. */
703
+ /**
704
+ * ID of the campaign that was rejected.
705
+ * @format GUID
706
+ */
641
707
  campaignId?: string;
642
708
  }
643
709
  export interface Published {
644
- /** ID of the campaign that was published. */
710
+ /**
711
+ * ID of the campaign that was published.
712
+ * @format GUID
713
+ */
645
714
  campaignId?: string;
646
- /** Campaign landing page URL. */
715
+ /**
716
+ * Campaign landing page URL.
717
+ * @format WEB_URL
718
+ * @maxLength 2048
719
+ */
647
720
  landingPageUrl?: string;
648
721
  /** Estimation of recipient list size (optional). */
649
722
  mailingListSizeEstimate?: number | null;
650
723
  }
651
724
  export interface Terminated {
652
- /** ID of the campaign that was terminated. */
725
+ /**
726
+ * ID of the campaign that was terminated.
727
+ * @format GUID
728
+ */
653
729
  campaignId?: string;
654
730
  }
655
731
  export interface Distributed {
656
- /** ID of the campaign that was distributed. */
732
+ /**
733
+ * ID of the campaign that was distributed.
734
+ * @format GUID
735
+ */
657
736
  campaignId?: string;
658
737
  }
659
738
  export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf {
@@ -674,16 +753,28 @@ export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf
674
753
  * Indicates a permanent error sending your email. For example, the email address does not exist.
675
754
  */
676
755
  hardBounce?: HardBounce;
677
- /** Campaign ID. */
756
+ /**
757
+ * Campaign ID.
758
+ * @format GUID
759
+ */
678
760
  campaignId?: string;
679
- /** [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient. */
761
+ /**
762
+ * [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient.
763
+ * @format GUID
764
+ */
680
765
  contactId?: string;
681
- /** Email address of a recipient. */
766
+ /**
767
+ * Email address of a recipient.
768
+ * @format EMAIL
769
+ */
682
770
  recipientEmailAddress?: string;
683
771
  /** Date and time of the event. */
684
772
  timestamp?: Date | null;
685
773
  activityType?: ActivityType;
686
- /** email metadata */
774
+ /**
775
+ * email metadata
776
+ * @maxSize 20
777
+ */
687
778
  metadata?: Record<string, string>;
688
779
  }
689
780
  /** @oneof */
@@ -738,7 +829,10 @@ export interface HardBounce {
738
829
  reason?: string;
739
830
  }
740
831
  export interface Scheduled {
741
- /** ID of the campaign that was scheduled. */
832
+ /**
833
+ * ID of the campaign that was scheduled.
834
+ * @format GUID
835
+ */
742
836
  campaignId?: string;
743
837
  /** The timestamp campaign is scheduled for. */
744
838
  sendAt?: Date | null;
@@ -746,11 +840,20 @@ export interface Scheduled {
746
840
  rescheduled?: boolean;
747
841
  }
748
842
  export interface SendTestRequest {
749
- /** Campaign ID. */
843
+ /**
844
+ * Campaign ID.
845
+ * @format GUID
846
+ */
750
847
  campaignId: string;
751
- /** Email subject. */
848
+ /**
849
+ * Email subject.
850
+ * @maxLength 1000
851
+ */
752
852
  emailSubject?: string | null;
753
- /** Recipient email address. */
853
+ /**
854
+ * Recipient email address.
855
+ * @format EMAIL
856
+ */
754
857
  toEmailAddress: string;
755
858
  }
756
859
  export interface PlaceholderContent extends PlaceholderContentValueOneOf {
@@ -789,9 +892,15 @@ export interface Html {
789
892
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
790
893
  */
791
894
  export interface Money {
792
- /** 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. */
895
+ /**
896
+ * 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.
897
+ * @format DECIMAL_VALUE
898
+ */
793
899
  value?: string;
794
- /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
900
+ /**
901
+ * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
902
+ * @format CURRENCY
903
+ */
795
904
  currency?: string;
796
905
  /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
797
906
  formattedValue?: string | null;
@@ -823,23 +932,33 @@ export interface Decimal {
823
932
  /**
824
933
  * when converted from Double, has a limitation of max 16 digits (including fractional part)
825
934
  * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
935
+ * @format DECIMAL_VALUE
826
936
  */
827
937
  value?: string;
828
938
  }
829
939
  export interface SendTestResponse {
830
940
  }
831
941
  export interface PauseSchedulingRequest {
832
- /** Campaign ID. */
942
+ /**
943
+ * Campaign ID.
944
+ * @format GUID
945
+ */
833
946
  campaignId: string;
834
947
  }
835
948
  export interface PauseSchedulingResponse {
836
949
  }
837
950
  export interface Paused {
838
- /** ID of the campaign that was paused. */
951
+ /**
952
+ * ID of the campaign that was paused.
953
+ * @format GUID
954
+ */
839
955
  campaignId?: string;
840
956
  }
841
957
  export interface RescheduleRequest {
842
- /** ID of the campaign to reschedule. */
958
+ /**
959
+ * ID of the campaign to reschedule.
960
+ * @format GUID
961
+ */
843
962
  campaignId: string;
844
963
  /** New time for sending out the campaign. */
845
964
  sendAt: Date | null;
@@ -847,43 +966,67 @@ export interface RescheduleRequest {
847
966
  export interface RescheduleResponse {
848
967
  }
849
968
  export interface ArchiveCampaignRequest {
850
- /** ID of the campaign to archive. */
969
+ /**
970
+ * ID of the campaign to archive.
971
+ * @format GUID
972
+ */
851
973
  campaignId?: string;
852
974
  }
853
975
  export interface ArchiveCampaignResponse {
854
976
  }
855
977
  /** Sent when status of the campaign is changed from "Active" to "Archived" */
856
978
  export interface Archived {
857
- /** ID of the campaign that was archived. */
979
+ /**
980
+ * ID of the campaign that was archived.
981
+ * @format GUID
982
+ */
858
983
  campaignId?: string;
859
984
  }
860
985
  export interface UnarchiveCampaignRequest {
861
- /** ID of the campaign to unarchive. */
986
+ /**
987
+ * ID of the campaign to unarchive.
988
+ * @format GUID
989
+ */
862
990
  campaignId?: string;
863
991
  }
864
992
  export interface UnarchiveCampaignResponse {
865
993
  }
866
994
  /** Sent when status of the campaign is changed from "Archived" to "Active" */
867
995
  export interface Unarchived {
868
- /** ID of the campaign whose status was changed to active. */
996
+ /**
997
+ * ID of the campaign whose status was changed to active.
998
+ * @format GUID
999
+ */
869
1000
  campaignId?: string;
870
1001
  }
871
1002
  export interface UpdateTitleRequest {
872
- /** ID of the campaign to change title of. */
1003
+ /**
1004
+ * ID of the campaign to change title of.
1005
+ * @format GUID
1006
+ */
873
1007
  campaignId?: string;
874
- /** New title to set. */
1008
+ /**
1009
+ * New title to set.
1010
+ * @maxLength 1000
1011
+ */
875
1012
  title?: string;
876
1013
  }
877
1014
  export interface UpdateTitleResponse {
878
1015
  }
879
1016
  export interface DeleteCampaignRequest {
880
- /** Campaign ID. */
1017
+ /**
1018
+ * Campaign ID.
1019
+ * @format GUID
1020
+ */
881
1021
  campaignId: string;
882
1022
  }
883
1023
  export interface DeleteCampaignResponse {
884
1024
  }
885
1025
  export interface ReuseCampaignRequest {
886
- /** ID of the message to be duplicated. */
1026
+ /**
1027
+ * ID of the message to be duplicated.
1028
+ * @format GUID
1029
+ */
887
1030
  campaignId: string;
888
1031
  }
889
1032
  export interface ReuseCampaignResponse {
@@ -891,9 +1034,15 @@ export interface ReuseCampaignResponse {
891
1034
  campaign?: Campaign;
892
1035
  }
893
1036
  export interface PreviewCampaignRequest {
894
- /** ID of the campaign to preview. */
1037
+ /**
1038
+ * ID of the campaign to preview.
1039
+ * @format GUID
1040
+ */
895
1041
  campaignId?: string;
896
- /** Preferred language for campaign content (optional). */
1042
+ /**
1043
+ * Preferred language for campaign content (optional).
1044
+ * @format LANGUAGE
1045
+ */
897
1046
  language?: string | null;
898
1047
  /** Values to replace campaign placeholders with (unique for each campaign). */
899
1048
  placeholders?: Record<string, PlaceholderContent>;
@@ -905,29 +1054,50 @@ export interface PreviewCampaignResponse {
905
1054
  html?: string;
906
1055
  }
907
1056
  export interface GetComposerRequest {
908
- /** Campaign ID. */
1057
+ /**
1058
+ * Campaign ID.
1059
+ * @format GUID
1060
+ */
909
1061
  campaignId?: string;
910
- /** Preferred language for campaign content (optional). */
1062
+ /**
1063
+ * Preferred language for campaign content (optional).
1064
+ * @format LANGUAGE
1065
+ */
911
1066
  language?: string | null;
912
1067
  }
913
1068
  export interface GetComposerResponse {
914
1069
  /** Composer. */
915
1070
  composer?: Composer;
916
- /** Campaign subject. */
1071
+ /**
1072
+ * Campaign subject.
1073
+ * @maxLength 1000
1074
+ */
917
1075
  emailSubject?: string;
918
- /** Campaign preheader (optional). */
1076
+ /**
1077
+ * Campaign preheader (optional).
1078
+ * @maxLength 1000
1079
+ */
919
1080
  emailPreheader?: string | null;
920
1081
  }
921
1082
  export interface UpdateComposerRequest {
922
- /** Campaign ID. */
1083
+ /**
1084
+ * Campaign ID.
1085
+ * @format GUID
1086
+ */
923
1087
  campaignId?: string;
924
1088
  /** Campaign composer. */
925
1089
  composer?: Composer;
926
1090
  /** Campaign editor type (optional, default "WEB"). */
927
1091
  campaignEditorType?: CampaignEditorType;
928
- /** Campaign subject (optional). */
1092
+ /**
1093
+ * Campaign subject (optional).
1094
+ * @maxLength 1000
1095
+ */
929
1096
  emailSubject?: string | null;
930
- /** Campaign preheader (optional). */
1097
+ /**
1098
+ * Campaign preheader (optional).
1099
+ * @maxLength 1000
1100
+ */
931
1101
  emailPreheader?: string | null;
932
1102
  }
933
1103
  /** specifies if campaign is being created and edited in web or mobile app */
@@ -941,9 +1111,15 @@ export interface CreateCampaignRequest {
941
1111
  composer?: Composer;
942
1112
  /** Campaign editor type (optional, default "WEB"). */
943
1113
  campaignEditorType?: CampaignEditorType;
944
- /** Campaign subject (optional). */
1114
+ /**
1115
+ * Campaign subject (optional).
1116
+ * @maxLength 1000
1117
+ */
945
1118
  emailSubject?: string | null;
946
- /** Campaign preheader (optional). */
1119
+ /**
1120
+ * Campaign preheader (optional).
1121
+ * @maxLength 1000
1122
+ */
947
1123
  emailPreheader?: string | null;
948
1124
  }
949
1125
  export interface CreateCampaignResponse {
@@ -951,17 +1127,29 @@ export interface CreateCampaignResponse {
951
1127
  campaign?: Campaign;
952
1128
  }
953
1129
  export interface ResendToNonOpenersRequest {
954
- /** ID of the campaign to resend. */
1130
+ /**
1131
+ * ID of the campaign to resend.
1132
+ * @format GUID
1133
+ */
955
1134
  campaignId?: string;
956
- /** Subject line to use with the resent copy of campaign. */
1135
+ /**
1136
+ * Subject line to use with the resent copy of campaign.
1137
+ * @maxLength 1000
1138
+ */
957
1139
  emailSubject?: string | null;
958
1140
  }
959
1141
  export interface ResendToNonOpenersResponse {
960
- /** ID of the newly created and resent campaign. */
1142
+ /**
1143
+ * ID of the newly created and resent campaign.
1144
+ * @format GUID
1145
+ */
961
1146
  campaignId?: string;
962
1147
  }
963
1148
  export interface GetAudienceRequest {
964
- /** Campaign ID. */
1149
+ /**
1150
+ * Campaign ID.
1151
+ * @format GUID
1152
+ */
965
1153
  campaignId: string;
966
1154
  }
967
1155
  export interface GetAudienceResponse {
@@ -969,25 +1157,51 @@ export interface GetAudienceResponse {
969
1157
  audience?: CampaignAudience;
970
1158
  }
971
1159
  export interface CampaignAudience {
972
- /** IDs of contacts to whom to send the campaign. */
1160
+ /**
1161
+ * IDs of contacts to whom to send the campaign.
1162
+ * @format GUID
1163
+ * @maxSize 100
1164
+ */
973
1165
  contactIds?: string[];
974
- /** Labels IDs. */
1166
+ /**
1167
+ * Labels IDs.
1168
+ * @maxLength 100
1169
+ * @maxSize 20
1170
+ */
975
1171
  labelIds?: string[];
976
- /** Segment IDs. */
1172
+ /**
1173
+ * Segment IDs.
1174
+ * @format GUID
1175
+ * @maxSize 20
1176
+ */
977
1177
  segmentIds?: string[];
978
1178
  /** Filter for contacts in JSON format. */
979
1179
  contactsFilter?: Record<string, any> | null;
980
- /** Contacts plain text search expression (searches in name, phone and email fields). */
1180
+ /**
1181
+ * Contacts plain text search expression (searches in name, phone and email fields).
1182
+ * @minLength 1
1183
+ * @maxLength 100
1184
+ */
981
1185
  contactsSearchTerm?: string | null;
982
1186
  /** Should "inactive" contacts be excluded or not. */
983
1187
  activeContactsOnly?: boolean;
984
1188
  }
985
1189
  export interface IdentifySenderAddressRequest {
986
- /** Email address to verify. */
1190
+ /**
1191
+ * Email address to verify.
1192
+ * @format EMAIL
1193
+ * @minLength 6
1194
+ * @maxLength 254
1195
+ */
987
1196
  emailAddress: string;
988
1197
  }
989
1198
  export interface IdentifySenderAddressResponse {
990
- /** Actual "from" address that will be used for sending emails. */
1199
+ /**
1200
+ * Actual "from" address that will be used for sending emails.
1201
+ * @format EMAIL
1202
+ * @minLength 6
1203
+ * @maxLength 254
1204
+ */
991
1205
  senderAddress?: string;
992
1206
  }
993
1207
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -1006,99 +1220,247 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1006
1220
  */
1007
1221
  entityFqdn?: string;
1008
1222
  /**
1009
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1010
- * This is although the created/updated/deleted notion is duplication of the oneof types
1011
- * Example: created/updated/deleted/started/completed/email_opened
1223
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1224
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1225
+ * Example: created/updated/deleted/started/completed/email_opened
1226
+ */
1227
+ slug?: string;
1228
+ /** ID of the entity associated with the event. */
1229
+ entityId?: string;
1230
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1231
+ eventTime?: Date | null;
1232
+ /**
1233
+ * Whether the event was triggered as a result of a privacy regulation application
1234
+ * (for example, GDPR).
1235
+ */
1236
+ triggeredByAnonymizeRequest?: boolean | null;
1237
+ /** If present, indicates the action that triggered the event. */
1238
+ originatedFrom?: string | null;
1239
+ /**
1240
+ * A sequence number defining the order of updates to the underlying entity.
1241
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1242
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1243
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1244
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1245
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1246
+ */
1247
+ entityEventSequence?: string | null;
1248
+ }
1249
+ /** @oneof */
1250
+ export interface DomainEventBodyOneOf {
1251
+ createdEvent?: EntityCreatedEvent;
1252
+ updatedEvent?: EntityUpdatedEvent;
1253
+ deletedEvent?: EntityDeletedEvent;
1254
+ actionEvent?: ActionEvent;
1255
+ }
1256
+ export interface EntityCreatedEvent {
1257
+ entity?: string;
1258
+ }
1259
+ export interface RestoreInfo {
1260
+ deletedDate?: Date | null;
1261
+ }
1262
+ export interface EntityUpdatedEvent {
1263
+ /**
1264
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1265
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1266
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1267
+ */
1268
+ currentEntity?: string;
1269
+ }
1270
+ export interface EntityDeletedEvent {
1271
+ /** Entity that was deleted */
1272
+ deletedEntity?: string | null;
1273
+ }
1274
+ export interface ActionEvent {
1275
+ body?: string;
1276
+ }
1277
+ export interface MessageEnvelope {
1278
+ /**
1279
+ * App instance ID.
1280
+ * @format GUID
1281
+ */
1282
+ instanceId?: string | null;
1283
+ /**
1284
+ * Event type.
1285
+ * @maxLength 150
1286
+ */
1287
+ eventType?: string;
1288
+ /** The identification type and identity data. */
1289
+ identity?: IdentificationData;
1290
+ /** Stringify payload. */
1291
+ data?: string;
1292
+ }
1293
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1294
+ /**
1295
+ * ID of a site visitor that has not logged in to the site.
1296
+ * @format GUID
1297
+ */
1298
+ anonymousVisitorId?: string;
1299
+ /**
1300
+ * ID of a site visitor that has logged in to the site.
1301
+ * @format GUID
1302
+ */
1303
+ memberId?: string;
1304
+ /**
1305
+ * ID of a Wix user (site owner, contributor, etc.).
1306
+ * @format GUID
1307
+ */
1308
+ wixUserId?: string;
1309
+ /**
1310
+ * ID of an app.
1311
+ * @format GUID
1312
+ */
1313
+ appId?: string;
1314
+ /** @readonly */
1315
+ identityType?: WebhookIdentityType;
1316
+ }
1317
+ /** @oneof */
1318
+ export interface IdentificationDataIdOneOf {
1319
+ /**
1320
+ * ID of a site visitor that has not logged in to the site.
1321
+ * @format GUID
1322
+ */
1323
+ anonymousVisitorId?: string;
1324
+ /**
1325
+ * ID of a site visitor that has logged in to the site.
1326
+ * @format GUID
1327
+ */
1328
+ memberId?: string;
1329
+ /**
1330
+ * ID of a Wix user (site owner, contributor, etc.).
1331
+ * @format GUID
1332
+ */
1333
+ wixUserId?: string;
1334
+ /**
1335
+ * ID of an app.
1336
+ * @format GUID
1337
+ */
1338
+ appId?: string;
1339
+ }
1340
+ export declare enum WebhookIdentityType {
1341
+ UNKNOWN = "UNKNOWN",
1342
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1343
+ MEMBER = "MEMBER",
1344
+ WIX_USER = "WIX_USER",
1345
+ APP = "APP"
1346
+ }
1347
+ export interface ListStatisticsRequest {
1348
+ /**
1349
+ * IDs of the campaigns to retrieve (max 100 campaigns).
1350
+ * @format GUID
1351
+ * @minSize 1
1352
+ * @maxSize 100
1353
+ */
1354
+ campaignIds: string[];
1355
+ }
1356
+ export interface ListStatisticsResponse {
1357
+ /** List of statistics. */
1358
+ statistics?: CampaignStatisticsContainer[];
1359
+ }
1360
+ export interface CampaignStatisticsContainer {
1361
+ /**
1362
+ * Campaign ID.
1363
+ * @format GUID
1364
+ */
1365
+ campaignId?: string;
1366
+ /** Landing page statistics. */
1367
+ landingPage?: LandingPageStatistics;
1368
+ /** Email campaign statistics. */
1369
+ email?: DistributionStatistics;
1370
+ }
1371
+ export interface ListRecipientsRequest {
1372
+ /**
1373
+ * Campaign ID.
1374
+ * @format GUID
1375
+ */
1376
+ campaignId: string;
1377
+ /**
1378
+ * __Required.__ Email activity to filter for. One of:
1379
+ * + `'DELIVERED'`
1380
+ * + `'OPENED'`
1381
+ * + `'CLICKED'`
1382
+ * + `'BOUNCED'`
1383
+ * + `'NOT_SENT'`
1384
+ */
1385
+ activity: RecipientsActivityEnum;
1386
+ /** Pagination options. */
1387
+ paging?: CursorPaging;
1388
+ }
1389
+ export declare enum RecipientsActivityEnum {
1390
+ UNKNOWN = "UNKNOWN",
1391
+ DELIVERED = "DELIVERED",
1392
+ OPENED = "OPENED",
1393
+ CLICKED = "CLICKED",
1394
+ BOUNCED = "BOUNCED",
1395
+ NOT_SENT = "NOT_SENT",
1396
+ SENT = "SENT",
1397
+ NOT_OPENED = "NOT_OPENED"
1398
+ }
1399
+ export interface CursorPaging {
1400
+ /**
1401
+ * Number of items to load.
1402
+ * @max 1000
1403
+ */
1404
+ limit?: number | null;
1405
+ /**
1406
+ * Pointer to the next or previous page in the list of results.
1407
+ *
1408
+ * You can get the relevant cursor token
1409
+ * from the `pagingMetadata` object in the previous call's response.
1410
+ * Not relevant for the first request.
1411
+ */
1412
+ cursor?: string | null;
1413
+ }
1414
+ export interface ListRecipientsResponse {
1415
+ /** List of recipients. */
1416
+ recipients?: CampaignRecipientDetails[];
1417
+ /** Details on the paged set of returned results. */
1418
+ pagingMetadata?: PagingMetadataV2;
1419
+ }
1420
+ export interface CampaignRecipientDetails {
1421
+ /**
1422
+ * Contact ID.
1423
+ * @format GUID
1012
1424
  */
1013
- slug?: string;
1014
- /** ID of the entity associated with the event. */
1015
- entityId?: string;
1016
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1017
- eventTime?: Date | null;
1425
+ contactId?: string;
1426
+ /** Date and time of the last activity. */
1427
+ lastActivityDate?: Date | null;
1018
1428
  /**
1019
- * Whether the event was triggered as a result of a privacy regulation application
1020
- * (for example, GDPR).
1429
+ * Primary email address of the contact.
1430
+ * @format EMAIL
1021
1431
  */
1022
- triggeredByAnonymizeRequest?: boolean | null;
1023
- /** If present, indicates the action that triggered the event. */
1024
- originatedFrom?: string | null;
1432
+ emailAddress?: string;
1025
1433
  /**
1026
- * A sequence number defining the order of updates to the underlying entity.
1027
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1028
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1029
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1030
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1031
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1434
+ * Full name of the contact (optional).
1435
+ * @maxLength 100
1032
1436
  */
1033
- entityEventSequence?: string | null;
1034
- }
1035
- /** @oneof */
1036
- export interface DomainEventBodyOneOf {
1037
- createdEvent?: EntityCreatedEvent;
1038
- updatedEvent?: EntityUpdatedEvent;
1039
- deletedEvent?: EntityDeletedEvent;
1040
- actionEvent?: ActionEvent;
1041
- }
1042
- export interface EntityCreatedEvent {
1043
- entity?: string;
1437
+ fullName?: string | null;
1438
+ /** Is this contact currently deleted from the site or not. */
1439
+ contactDeleted?: boolean;
1044
1440
  }
1045
- export interface RestoreInfo {
1046
- deletedDate?: Date | null;
1441
+ export interface PagingMetadataV2 {
1442
+ /** Number of items returned in the response. */
1443
+ count?: number | null;
1444
+ /** Offset that was requested. */
1445
+ offset?: number | null;
1446
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1447
+ total?: number | null;
1448
+ /** Flag that indicates the server failed to calculate the `total` field. */
1449
+ tooManyToCount?: boolean | null;
1450
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1451
+ cursors?: Cursors;
1047
1452
  }
1048
- export interface EntityUpdatedEvent {
1453
+ export interface Cursors {
1049
1454
  /**
1050
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1051
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1052
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1455
+ * Cursor string pointing to the next page in the list of results.
1456
+ * @maxLength 16000
1053
1457
  */
1054
- currentEntity?: string;
1055
- }
1056
- export interface EntityDeletedEvent {
1057
- /** Entity that was deleted */
1058
- deletedEntity?: string | null;
1059
- }
1060
- export interface ActionEvent {
1061
- body?: string;
1062
- }
1063
- export interface MessageEnvelope {
1064
- /** App instance ID. */
1065
- instanceId?: string | null;
1066
- /** Event type. */
1067
- eventType?: string;
1068
- /** The identification type and identity data. */
1069
- identity?: IdentificationData;
1070
- /** Stringify payload. */
1071
- data?: string;
1072
- }
1073
- export interface IdentificationData extends IdentificationDataIdOneOf {
1074
- /** ID of a site visitor that has not logged in to the site. */
1075
- anonymousVisitorId?: string;
1076
- /** ID of a site visitor that has logged in to the site. */
1077
- memberId?: string;
1078
- /** ID of a Wix user (site owner, contributor, etc.). */
1079
- wixUserId?: string;
1080
- /** ID of an app. */
1081
- appId?: string;
1082
- /** @readonly */
1083
- identityType?: WebhookIdentityType;
1084
- }
1085
- /** @oneof */
1086
- export interface IdentificationDataIdOneOf {
1087
- /** ID of a site visitor that has not logged in to the site. */
1088
- anonymousVisitorId?: string;
1089
- /** ID of a site visitor that has logged in to the site. */
1090
- memberId?: string;
1091
- /** ID of a Wix user (site owner, contributor, etc.). */
1092
- wixUserId?: string;
1093
- /** ID of an app. */
1094
- appId?: string;
1095
- }
1096
- export declare enum WebhookIdentityType {
1097
- UNKNOWN = "UNKNOWN",
1098
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1099
- MEMBER = "MEMBER",
1100
- WIX_USER = "WIX_USER",
1101
- APP = "APP"
1458
+ next?: string | null;
1459
+ /**
1460
+ * Cursor pointing to the previous page in the list of results.
1461
+ * @maxLength 16000
1462
+ */
1463
+ prev?: string | null;
1102
1464
  }
1103
1465
  export interface ValidateLinkResponseNonNullableFields {
1104
1466
  valid: boolean;
@@ -1118,22 +1480,6 @@ interface DistributionStatisticsNonNullableFields {
1118
1480
  complained: number;
1119
1481
  notSent: number;
1120
1482
  }
1121
- interface CampaignStatisticsContainerNonNullableFields {
1122
- campaignId: string;
1123
- landingPage?: LandingPageStatisticsNonNullableFields;
1124
- email?: DistributionStatisticsNonNullableFields;
1125
- }
1126
- export interface ListStatisticsResponseNonNullableFields {
1127
- statistics: CampaignStatisticsContainerNonNullableFields[];
1128
- }
1129
- interface CampaignRecipientDetailsNonNullableFields {
1130
- contactId: string;
1131
- emailAddress: string;
1132
- contactDeleted: boolean;
1133
- }
1134
- export interface ListRecipientsResponseNonNullableFields {
1135
- recipients: CampaignRecipientDetailsNonNullableFields[];
1136
- }
1137
1483
  interface TotalStatisticsNonNullableFields {
1138
1484
  mailsSent: number;
1139
1485
  opened: number;
@@ -1188,10 +1534,32 @@ export interface GetAudienceResponseNonNullableFields {
1188
1534
  export interface IdentifySenderAddressResponseNonNullableFields {
1189
1535
  senderAddress: string;
1190
1536
  }
1537
+ interface CampaignStatisticsContainerNonNullableFields {
1538
+ campaignId: string;
1539
+ landingPage?: LandingPageStatisticsNonNullableFields;
1540
+ email?: DistributionStatisticsNonNullableFields;
1541
+ }
1542
+ export interface ListStatisticsResponseNonNullableFields {
1543
+ statistics: CampaignStatisticsContainerNonNullableFields[];
1544
+ }
1545
+ interface CampaignRecipientDetailsNonNullableFields {
1546
+ contactId: string;
1547
+ emailAddress: string;
1548
+ contactDeleted: boolean;
1549
+ }
1550
+ export interface ListRecipientsResponseNonNullableFields {
1551
+ recipients: CampaignRecipientDetailsNonNullableFields[];
1552
+ }
1191
1553
  export interface BaseEventMetadata {
1192
- /** App instance ID. */
1554
+ /**
1555
+ * App instance ID.
1556
+ * @format GUID
1557
+ */
1193
1558
  instanceId?: string | null;
1194
- /** Event type. */
1559
+ /**
1560
+ * Event type.
1561
+ * @maxLength 150
1562
+ */
1195
1563
  eventType?: string;
1196
1564
  /** The identification type and identity data. */
1197
1565
  identity?: IdentificationData;
@@ -1242,6 +1610,8 @@ export interface CampaignDistributedEnvelope {
1242
1610
  * Triggered when a campaign is successfully distributed to all recipients.
1243
1611
  * @permissionScope Access Verticals by Automations
1244
1612
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1613
+ * @permissionScope Set Up Automations
1614
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1245
1615
  * @permissionScope Read Email Marketing
1246
1616
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1247
1617
  * @permissionScope Manage Email Marketing
@@ -1261,6 +1631,8 @@ export interface CampaignPausedEnvelope {
1261
1631
  * Triggered when a scheduled campaign is paused.
1262
1632
  * @permissionScope Access Verticals by Automations
1263
1633
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1634
+ * @permissionScope Set Up Automations
1635
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1264
1636
  * @permissionScope Read Email Marketing
1265
1637
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1266
1638
  * @permissionScope Manage Email Marketing
@@ -1280,6 +1652,8 @@ export interface CampaignPublishedEnvelope {
1280
1652
  * Triggered when a draft campaign is published.
1281
1653
  * @permissionScope Access Verticals by Automations
1282
1654
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1655
+ * @permissionScope Set Up Automations
1656
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1283
1657
  * @permissionScope Read Email Marketing
1284
1658
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1285
1659
  * @permissionScope Manage Email Marketing
@@ -1299,6 +1673,8 @@ export interface CampaignRejectedEnvelope {
1299
1673
  * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
1300
1674
  * @permissionScope Access Verticals by Automations
1301
1675
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1676
+ * @permissionScope Set Up Automations
1677
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1302
1678
  * @permissionScope Read Email Marketing
1303
1679
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1304
1680
  * @permissionScope Manage Email Marketing
@@ -1318,6 +1694,8 @@ export interface CampaignScheduledEnvelope {
1318
1694
  * Triggered when a campaign is scheduled to be sent out at the specific time.
1319
1695
  * @permissionScope Access Verticals by Automations
1320
1696
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1697
+ * @permissionScope Set Up Automations
1698
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1321
1699
  * @permissionScope Read Email Marketing
1322
1700
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1323
1701
  * @permissionScope Manage Email Marketing
@@ -1337,6 +1715,8 @@ export interface CampaignTerminatedEnvelope {
1337
1715
  * Triggered when the mailing list isn't clean and campaign was terminated.
1338
1716
  * @permissionScope Access Verticals by Automations
1339
1717
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1718
+ * @permissionScope Set Up Automations
1719
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1340
1720
  * @permissionScope Read Email Marketing
1341
1721
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1342
1722
  * @permissionScope Manage Email Marketing
@@ -1356,6 +1736,8 @@ export interface CampaignCreatedEnvelope {
1356
1736
  * Triggered when a campaign is created.
1357
1737
  * @permissionScope Access Verticals by Automations
1358
1738
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1739
+ * @permissionScope Set Up Automations
1740
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1359
1741
  * @permissionScope Read Email Marketing
1360
1742
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1361
1743
  * @permissionScope Manage Email Marketing
@@ -1374,6 +1756,8 @@ export interface CampaignDeletedEnvelope {
1374
1756
  * Triggered when a campaign is deleted.
1375
1757
  * @permissionScope Access Verticals by Automations
1376
1758
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1759
+ * @permissionScope Set Up Automations
1760
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1377
1761
  * @permissionScope Read Email Marketing
1378
1762
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1379
1763
  * @permissionScope Manage Email Marketing
@@ -1393,6 +1777,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
1393
1777
  * Triggered when an email campaign has a new recipient activity.
1394
1778
  * @permissionScope Access Verticals by Automations
1395
1779
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1780
+ * @permissionScope Set Up Automations
1781
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1396
1782
  * @permissionScope Read Email Marketing
1397
1783
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1398
1784
  * @permissionScope Manage Email Marketing
@@ -1410,11 +1796,12 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
1410
1796
  * If you provide a link as a placeholder, it's returned in a response as valid.
1411
1797
  * @param url - URL to validate.
1412
1798
  * @public
1413
- * @documentationMaturity preview
1414
1799
  * @requiredField url
1415
1800
  * @permissionId Shoutout.Manage
1416
1801
  * @permissionScope Access Verticals by Automations
1417
1802
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1803
+ * @permissionScope Set Up Automations
1804
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1418
1805
  * @permissionScope Manage Email Marketing
1419
1806
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1420
1807
  * @applicableIdentity APP
@@ -1425,75 +1812,18 @@ export declare function validateLink(url: string): Promise<ValidateLinkResponse
1425
1812
  * Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Use this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
1426
1813
  * @param html - HTML string with links.
1427
1814
  * @public
1428
- * @documentationMaturity preview
1429
1815
  * @requiredField html
1430
1816
  * @permissionId Shoutout.Manage
1431
1817
  * @permissionScope Access Verticals by Automations
1432
1818
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1819
+ * @permissionScope Set Up Automations
1820
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1433
1821
  * @permissionScope Manage Email Marketing
1434
1822
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1435
1823
  * @applicableIdentity APP
1436
1824
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
1437
1825
  */
1438
1826
  export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
1439
- /**
1440
- * Retrieves a list of statistics for up to 100 selected campaigns.
1441
- *
1442
- * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
1443
- * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
1444
- *
1445
- * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
1446
- * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
1447
- * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
1448
- * @public
1449
- * @requiredField campaignIds
1450
- * @permissionId Shoutout.Read
1451
- * @permissionScope Access Verticals by Automations
1452
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1453
- * @permissionScope Read Email Marketing
1454
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1455
- * @permissionScope Manage Email Marketing
1456
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1457
- * @applicableIdentity APP
1458
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
1459
- */
1460
- export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
1461
- /**
1462
- * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
1463
- *
1464
- * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
1465
- *
1466
- * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
1467
- * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
1468
- *
1469
- * If no `activity` is included, this endpoint returns an error.
1470
- *
1471
- * @param campaignId - Campaign ID.
1472
- * @param activity - __Required.__ Email activity to filter for. One of:
1473
- * + `'DELIVERED'`
1474
- * + `'OPENED'`
1475
- * + `'CLICKED'`
1476
- * + `'BOUNCED'`
1477
- * + `'NOT_SENT'`
1478
- * @public
1479
- * @requiredField activity
1480
- * @requiredField campaignId
1481
- * @param options - Options to use when getting the list of recipients.
1482
- * @permissionId Shoutout.Read
1483
- * @permissionScope Access Verticals by Automations
1484
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1485
- * @permissionScope Read Email Marketing
1486
- * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1487
- * @permissionScope Manage Email Marketing
1488
- * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1489
- * @applicableIdentity APP
1490
- * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
1491
- */
1492
- export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
1493
- export interface ListRecipientsOptions {
1494
- /** Pagination options. */
1495
- paging?: CursorPaging;
1496
- }
1497
1827
  /**
1498
1828
  * Retrieves information about an email campaign.
1499
1829
  * @param campaignId - Campaign ID.
@@ -1503,6 +1833,8 @@ export interface ListRecipientsOptions {
1503
1833
  * @permissionId Shoutout.Manage
1504
1834
  * @permissionScope Access Verticals by Automations
1505
1835
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1836
+ * @permissionScope Set Up Automations
1837
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1506
1838
  * @permissionScope Manage Email Marketing
1507
1839
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1508
1840
  * @applicableIdentity APP
@@ -1527,6 +1859,8 @@ export interface GetCampaignOptions {
1527
1859
  * @permissionId Shoutout.Read
1528
1860
  * @permissionScope Access Verticals by Automations
1529
1861
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1862
+ * @permissionScope Set Up Automations
1863
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1530
1864
  * @permissionScope Read Email Marketing
1531
1865
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1532
1866
  * @permissionScope Manage Email Marketing
@@ -1570,6 +1904,8 @@ export interface ListCampaignsOptions {
1570
1904
  * @permissionId Shoutout.Manage
1571
1905
  * @permissionScope Access Verticals by Automations
1572
1906
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1907
+ * @permissionScope Set Up Automations
1908
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1573
1909
  * @permissionScope Manage Email Marketing
1574
1910
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1575
1911
  * @applicableIdentity APP
@@ -1592,6 +1928,8 @@ export interface PublishCampaignOptions {
1592
1928
  * @permissionId Shoutout.Manage
1593
1929
  * @permissionScope Access Verticals by Automations
1594
1930
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1931
+ * @permissionScope Set Up Automations
1932
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1595
1933
  * @permissionScope Manage Email Marketing
1596
1934
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1597
1935
  * @applicableIdentity APP
@@ -1599,9 +1937,15 @@ export interface PublishCampaignOptions {
1599
1937
  */
1600
1938
  export declare function sendTest(campaignId: string, options?: SendTestOptions): Promise<void>;
1601
1939
  export interface SendTestOptions {
1602
- /** Email subject. */
1940
+ /**
1941
+ * Email subject.
1942
+ * @maxLength 1000
1943
+ */
1603
1944
  emailSubject?: string | null;
1604
- /** Recipient email address. */
1945
+ /**
1946
+ * Recipient email address.
1947
+ * @format EMAIL
1948
+ */
1605
1949
  toEmailAddress: string;
1606
1950
  }
1607
1951
  /**
@@ -1612,6 +1956,8 @@ export interface SendTestOptions {
1612
1956
  * @permissionId Shoutout.Manage
1613
1957
  * @permissionScope Access Verticals by Automations
1614
1958
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1959
+ * @permissionScope Set Up Automations
1960
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1615
1961
  * @permissionScope Manage Email Marketing
1616
1962
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1617
1963
  * @applicableIdentity APP
@@ -1628,6 +1974,8 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
1628
1974
  * @permissionId Shoutout.Manage
1629
1975
  * @permissionScope Access Verticals by Automations
1630
1976
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1977
+ * @permissionScope Set Up Automations
1978
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1631
1979
  * @permissionScope Manage Email Marketing
1632
1980
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1633
1981
  * @applicableIdentity APP
@@ -1642,6 +1990,8 @@ export declare function reschedule(campaignId: string, sendAt: Date | null): Pro
1642
1990
  * @permissionId Shoutout.Manage
1643
1991
  * @permissionScope Access Verticals by Automations
1644
1992
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1993
+ * @permissionScope Set Up Automations
1994
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1645
1995
  * @permissionScope Manage Email Marketing
1646
1996
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1647
1997
  * @applicableIdentity APP
@@ -1656,6 +2006,8 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
1656
2006
  * @permissionId Shoutout.Manage
1657
2007
  * @permissionScope Access Verticals by Automations
1658
2008
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2009
+ * @permissionScope Set Up Automations
2010
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1659
2011
  * @permissionScope Manage Email Marketing
1660
2012
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1661
2013
  * @applicableIdentity APP
@@ -1670,6 +2022,8 @@ export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaign
1670
2022
  * @permissionId Shoutout.Manage
1671
2023
  * @permissionScope Access Verticals by Automations
1672
2024
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2025
+ * @permissionScope Set Up Automations
2026
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1673
2027
  * @permissionScope Manage Email Marketing
1674
2028
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1675
2029
  * @applicableIdentity APP
@@ -1684,10 +2038,74 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
1684
2038
  * @permissionId Shoutout.Manage
1685
2039
  * @permissionScope Access Verticals by Automations
1686
2040
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2041
+ * @permissionScope Set Up Automations
2042
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1687
2043
  * @permissionScope Manage Email Marketing
1688
2044
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1689
2045
  * @applicableIdentity APP
1690
2046
  * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
1691
2047
  */
1692
2048
  export declare function identifySenderAddress(emailAddress: string): Promise<IdentifySenderAddressResponse & IdentifySenderAddressResponseNonNullableFields>;
2049
+ /**
2050
+ * Retrieves a list of statistics for up to 100 selected campaigns.
2051
+ *
2052
+ * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
2053
+ * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
2054
+ *
2055
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2056
+ * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
2057
+ * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
2058
+ * @public
2059
+ * @requiredField campaignIds
2060
+ * @permissionId Shoutout.Read
2061
+ * @permissionScope Access Verticals by Automations
2062
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2063
+ * @permissionScope Set Up Automations
2064
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2065
+ * @permissionScope Read Email Marketing
2066
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
2067
+ * @permissionScope Manage Email Marketing
2068
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
2069
+ * @applicableIdentity APP
2070
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
2071
+ */
2072
+ export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
2073
+ /**
2074
+ * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
2075
+ *
2076
+ * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
2077
+ *
2078
+ * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
2079
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2080
+ *
2081
+ * If no `activity` is included, this endpoint returns an error.
2082
+ *
2083
+ * @param campaignId - Campaign ID.
2084
+ * @param activity - __Required.__ Email activity to filter for. One of:
2085
+ * + `'DELIVERED'`
2086
+ * + `'OPENED'`
2087
+ * + `'CLICKED'`
2088
+ * + `'BOUNCED'`
2089
+ * + `'NOT_SENT'`
2090
+ * @public
2091
+ * @requiredField activity
2092
+ * @requiredField campaignId
2093
+ * @param options - Options to use when getting the list of recipients.
2094
+ * @permissionId Shoutout.Read
2095
+ * @permissionScope Access Verticals by Automations
2096
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2097
+ * @permissionScope Set Up Automations
2098
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2099
+ * @permissionScope Read Email Marketing
2100
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
2101
+ * @permissionScope Manage Email Marketing
2102
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
2103
+ * @applicableIdentity APP
2104
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
2105
+ */
2106
+ export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
2107
+ export interface ListRecipientsOptions {
2108
+ /** Pagination options. */
2109
+ paging?: CursorPaging;
2110
+ }
1693
2111
  export {};