@wix/auto_sdk_email-marketing_campaigns 1.0.5 → 1.0.7

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 +73 -193
  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 +38 -38
  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 +810 -417
  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 +1007 -558
  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 +70 -190
  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 +38 -38
  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 +810 -417
  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 +1007 -558
  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 +73 -193
  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 +38 -38
  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 +810 -417
  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 +1007 -558
  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 +70 -190
  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 +38 -38
  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 +810 -417
  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 +1007 -558
  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,116 +235,11 @@ export declare enum CampaignTypeEnum {
224
235
  /** triggered email */
225
236
  TRIGGERED = "TRIGGERED"
226
237
  }
227
- export interface EstimateFilterSizeRequest {
228
- /** Contacts filter expression. */
229
- filter?: Record<string, any> | null;
230
- /** Should "inactive" contacts be excluded or not (default value "false"). */
231
- activeContactsOnly?: boolean;
232
- /** Contacts plain text search expression (searches in name, phone and email fields). */
233
- search?: string | null;
234
- }
235
- export interface EstimateFilterSizeResponse {
236
- /** Mailing list size estimation. */
237
- estimation?: number;
238
- }
239
- export interface EstimateAudienceSizeRequest {
240
- /** Contact IDs of a campaign audience. */
241
- contactIds?: string[];
242
- /** Label IDs of a campaign audience. */
243
- labelIds?: string[];
244
- /** Contacts filter expression (json). */
245
- contactsFilter?: Record<string, any> | null;
246
- /** Contacts plain text search expression (searches in name, phone and email fields). */
247
- search?: string | null;
248
- /** Segment ids of a campaign audience. */
249
- segmentIds?: string[];
250
- /** Should "inactive" contacts be excluded or not (default value "false"). */
251
- activeContactsOnly?: boolean;
252
- /** Id of a campaign that is to be resent. */
253
- resendCampaignId?: string | null;
254
- /** Should total number of contacts in provided audience be returned or not (default value "false"). */
255
- withTotal?: boolean;
256
- }
257
- export interface EstimateAudienceSizeResponse {
258
- /** Audience size (estimated number of emails to be sent). */
259
- estimation?: number;
260
- /** Total number of contacts in provided audience (optional). */
261
- total?: number | null;
262
- }
263
- export interface ReconcileContactRequest {
264
- /** Email address of the contact. */
265
- emailAddress?: string;
266
- }
267
- export interface ReconcileContactResponse {
268
- /** Created or retrieved contact. */
269
- contact?: Contact;
270
- }
271
- export interface Contact {
272
- /** Unique ID of the contact entity. */
273
- _id?: string;
274
- /** Primary email address of the contact. */
275
- emailAddress?: string;
276
- /** Full name of the contact (optional). */
277
- fullName?: string | null;
278
- /** Profile picture of the contact (optional). */
279
- pictureUrl?: string | null;
280
- }
281
- export interface SearchContactsRequest {
282
- /** Text to search contacts by - can search by name or email address. */
283
- searchTerm?: string;
284
- /** Should "inactive" contacts be excluded or not (default value "false"). */
285
- activeContactsOnly?: boolean;
286
- /** Page size (default 50, max 1000). */
287
- pageSize?: number | null;
288
- }
289
- export interface SearchContactsResponse {
290
- /** Search results. */
291
- contacts?: Contact[];
292
- }
293
- export interface GetLabelsRequest {
294
- /** Should "inactive" contacts be excluded or not (default value "false"). */
295
- activeContactsOnly?: boolean;
296
- }
297
- export interface GetLabelsResponse {
298
- /** Returned labels with contact counts. */
299
- labels?: Label[];
300
- }
301
- export interface Label {
302
- /** Unique ID of the label entity. */
303
- _id?: string;
304
- /** Name of the label. */
305
- name?: string;
306
- /** Amount of contacts assigned to the label. */
307
- contactsCount?: number;
308
- }
309
- export interface SubscribeFromLandingPageRequest {
310
- /** Campaign ID that the subscription is happening from. */
311
- campaignId?: string;
312
- /** Email address that is entered into subscription field. */
313
- emailAddress?: string;
314
- /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
315
- consent?: boolean;
316
- }
317
- export interface SubscribeFromLandingPageResponse {
318
- contactId?: string;
319
- }
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
238
  export interface ValidateLinkRequest {
336
- /** URL to validate. */
239
+ /**
240
+ * URL to validate.
241
+ * @minLength 1
242
+ */
337
243
  url: string;
338
244
  }
339
245
  export interface ValidateLinkResponse {
@@ -341,229 +247,475 @@ export interface ValidateLinkResponse {
341
247
  valid?: boolean;
342
248
  }
343
249
  export interface ValidateHtmlLinksRequest {
344
- /** HTML string with links. */
250
+ /**
251
+ * HTML string with links.
252
+ * @maxLength 1000000
253
+ */
345
254
  html: string;
346
255
  }
347
256
  export interface ValidateHtmlLinksResponse {
348
257
  /** Non-valid links. */
349
258
  blacklistedLinks?: string[];
350
259
  }
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;
260
+ export interface GetCampaignMappingRequest {
370
261
  /**
371
- * __Required.__ Email activity to filter for. One of:
372
- * + `'DELIVERED'`
373
- * + `'OPENED'`
374
- * + `'CLICKED'`
375
- * + `'BOUNCED'`
376
- * + `'NOT_SENT'`
262
+ * rule ID in automations
263
+ * @format GUID
377
264
  */
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;
265
+ automationRuleId?: string;
395
266
  /**
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.
267
+ * template ID configured for the automation
268
+ * @format GUID
401
269
  */
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
270
  templateId?: string;
445
271
  }
446
272
  export interface GetCampaignMappingResponse {
273
+ /** @format GUID */
447
274
  campaignId?: string;
448
275
  }
449
276
  export interface UpsertTranslationRequest {
450
- /** Campaign ID. */
277
+ /**
278
+ * Campaign ID.
279
+ * @format GUID
280
+ */
451
281
  campaignId?: string;
452
282
  /** Composer data. */
453
283
  composer?: Composer;
454
- /** Translation language (optional, default value "EN"). */
284
+ /**
285
+ * Translation language (optional, default value "EN").
286
+ * @format LANGUAGE
287
+ */
455
288
  language?: string | null;
456
- /** For BI event [36:1031] only (optional, default value "n/a"). */
289
+ /**
290
+ * For BI event [36:1031] only (optional, default value "n/a").
291
+ * @format GUID
292
+ */
457
293
  automationRuleId?: string | null;
458
294
  /** Should campaign also be published or not (default value "false"). */
459
295
  publish?: boolean;
460
- /** Campaign subject (optional). */
296
+ /**
297
+ * Campaign subject (optional).
298
+ * @maxLength 1000
299
+ */
461
300
  emailSubject?: string | null;
462
- /** Campaign preheader (optional). */
301
+ /**
302
+ * Campaign preheader (optional).
303
+ * @maxLength 1000
304
+ */
463
305
  emailPreheader?: string | null;
464
306
  }
465
307
  export interface Composer {
466
- /** Internal data structure for editor/viewer to render the campaign. */
308
+ /**
309
+ * Internal data structure for editor/viewer to render the campaign.
310
+ * @maxLength 10000000
311
+ */
467
312
  composerDataJson?: string;
468
313
  /** Default values of existing placeholders. */
469
314
  defaultValues?: DefaultValues;
470
315
  }
471
316
  export interface DefaultValues {
317
+ /** @maxSize 500 */
472
318
  map?: Record<string, string>;
473
319
  }
474
320
  export interface UpsertTranslationResponse {
475
321
  }
476
322
  export interface GetUsedPlaceholderKeysRequest {
477
- /** Campaign ID. */
323
+ /**
324
+ * Campaign ID.
325
+ * @format GUID
326
+ */
478
327
  campaignId?: string;
479
328
  }
480
329
  export interface GetUsedPlaceholderKeysResponse {
481
- /** Keys of placeholders used in the automation. */
330
+ /**
331
+ * Keys of placeholders used in the automation.
332
+ * @maxLength 200
333
+ * @maxSize 300
334
+ */
482
335
  placeholderKeys?: string[];
483
336
  }
484
337
  export interface LookupCampaignMappingRequest {
485
- /** rule ID in automations */
338
+ /**
339
+ * rule ID in automations
340
+ * @format GUID
341
+ */
486
342
  automationRuleId?: string;
487
- /** template ID configured for the automation */
343
+ /**
344
+ * template ID configured for the automation
345
+ * @format GUID
346
+ */
488
347
  templateId?: string;
489
348
  }
490
349
  export interface LookupCampaignMappingResponse {
350
+ /** @format GUID */
491
351
  campaignId?: string | null;
492
352
  }
493
353
  export interface UpsertAutomationTranslatorContentRequest {
494
- /** Campaign ID that the content belongs to */
354
+ /**
355
+ * Campaign ID that the content belongs to
356
+ * @format GUID
357
+ */
495
358
  campaignId?: string;
496
359
  /** Automation translator content */
497
360
  automationTranslatorContent?: AutomationTranslatorContent;
498
361
  }
499
362
  /** Automation Translator Content */
500
363
  export interface AutomationTranslatorContent {
501
- /** AutomationTranslatorContent ID */
364
+ /**
365
+ * AutomationTranslatorContent ID
366
+ * @minLength 1
367
+ * @maxLength 256
368
+ * @immutable
369
+ */
502
370
  _id?: string;
503
- /** Content that can contain multiple strings. It represents a json file, that is stored on Smartling */
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
+ */
504
376
  json?: string;
505
377
  }
506
378
  export interface UpsertAutomationTranslatorContentResponse {
507
379
  }
508
380
  export interface GetAutomationTranslatorContentRequest {
509
- /** Campaign ID */
381
+ /**
382
+ * Campaign ID
383
+ * @format GUID
384
+ */
510
385
  campaignId?: string;
511
386
  }
512
387
  export interface GetAutomationTranslatorContentResponse {
513
388
  /** Automation translator content */
514
389
  automationTranslatorContent?: AutomationTranslatorContent;
515
390
  }
516
- export interface GetCampaignRequest {
517
- /** Campaign ID. */
518
- campaignId: string;
391
+ export interface SendTestBulkRequest {
519
392
  /**
520
- * Whether a returned campaign object should include `publishingData.statistics`.
521
- *
522
- * Default: `false`.
393
+ * Campaign ID
394
+ * @format GUID
523
395
  */
524
- optionIncludeStatistics?: boolean;
525
- }
526
- export interface GetCampaignResponse {
527
- /** Campaign information. */
528
- campaign?: Campaign;
529
- }
530
- export interface ListCampaignsRequest {
531
- /** Paging parameters. */
532
- paging?: Paging;
396
+ campaignId?: string;
533
397
  /**
534
- * Whether to include `publishingData.statistics` in the returned campaign object.
535
- *
536
- * Default: `false`.
398
+ * Recipient email address
399
+ * @format EMAIL
537
400
  */
538
- optionIncludeStatistics?: boolean;
401
+ toEmailAddress?: string;
402
+ /** Values to replace campaign placeholders with (unique for each campaign) */
403
+ placeholders?: Record<string, PlaceholderContent>;
539
404
  /**
540
- * Include campaigns with the following statuses (no filtering by default). One of:
541
- * + `'ACTIVE'`
542
- * + `'ARCHIVED'`
543
- * + `'DELETED'`
405
+ * Sender from name
406
+ * @maxLength 100
544
407
  */
545
- statuses?: CampaignStatusEnum[];
408
+ fromName?: string | null;
546
409
  /**
547
- * Include campaigns with the following visibility statuses (no filtering by default). One of:
548
- * + `'DRAFT'`
549
- * + `'PUBLISHED'`
550
- * + `'TEMPLATE'`
410
+ * Reply-to email address
411
+ * @format EMAIL
551
412
  */
552
- visibilityStatuses?: CampaignVisibilityStatusEnum[];
553
- }
554
- export interface Paging {
555
- /** Number of items to load. */
556
- limit?: number | null;
557
- /** Number of items to skip in the current sort order. */
558
- offset?: number | null;
559
- }
560
- export interface ListCampaignsResponse {
561
- /** Paging parameters. */
562
- paging?: Paging;
563
- /** List of campaigns. */
564
- campaigns?: Campaign[];
413
+ replyToEmailAddress?: string | null;
414
+ /**
415
+ * Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
416
+ * @format LANGUAGE
417
+ */
418
+ language?: string | null;
565
419
  }
566
- export interface CountCampaignsRequest {
420
+ export interface PlaceholderContent extends PlaceholderContentValueOneOf {
421
+ text?: PlainText;
422
+ html?: Html;
423
+ money?: Money;
424
+ dateTime?: DateTime;
425
+ map?: Map;
426
+ array?: _Array;
427
+ enum?: PlaceholderContentEnum;
428
+ attachment?: Attachment;
429
+ integer?: Integer;
430
+ decimal?: Decimal;
431
+ }
432
+ /** @oneof */
433
+ export interface PlaceholderContentValueOneOf {
434
+ text?: PlainText;
435
+ html?: Html;
436
+ money?: Money;
437
+ dateTime?: DateTime;
438
+ map?: Map;
439
+ array?: _Array;
440
+ enum?: PlaceholderContentEnum;
441
+ attachment?: Attachment;
442
+ integer?: Integer;
443
+ decimal?: Decimal;
444
+ }
445
+ export interface PlainText {
446
+ text?: string;
447
+ }
448
+ export interface Html {
449
+ html?: string;
450
+ }
451
+ /**
452
+ * Money.
453
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
454
+ */
455
+ export interface Money {
456
+ /**
457
+ * 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.
458
+ * @format DECIMAL_VALUE
459
+ */
460
+ value?: string;
461
+ /**
462
+ * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
463
+ * @format CURRENCY
464
+ */
465
+ currency?: string;
466
+ /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
467
+ formattedValue?: string | null;
468
+ }
469
+ export interface DateTime {
470
+ timestamp?: Date | null;
471
+ /** optional time zone is the full name. example: "Asia/Jerusalem" */
472
+ timeZone?: string | null;
473
+ }
474
+ export interface Map {
475
+ variables?: Record<string, PlaceholderContent>;
476
+ }
477
+ export interface _Array {
478
+ items?: PlaceholderContent[];
479
+ }
480
+ export interface PlaceholderContentEnum {
481
+ value?: string;
482
+ translation?: string;
483
+ }
484
+ export interface Attachment {
485
+ fileName?: string;
486
+ downloadUrl?: string;
487
+ }
488
+ export interface Integer {
489
+ /** min value: -2147483648, max value: 2147483647 */
490
+ value?: number;
491
+ }
492
+ export interface Decimal {
493
+ /**
494
+ * when converted from Double, has a limitation of max 16 digits (including fractional part)
495
+ * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
496
+ * @format DECIMAL_VALUE
497
+ */
498
+ value?: string;
499
+ }
500
+ export interface SendTestBulkResponse {
501
+ }
502
+ export interface GetPlaceholderKeysRequest {
503
+ /**
504
+ * Campaign ID.
505
+ * @format GUID
506
+ */
507
+ campaignId?: string;
508
+ }
509
+ export interface GetPlaceholderKeysResponse {
510
+ /** Keys of placeholders used in the campaign. */
511
+ placeholderKeys?: string[];
512
+ }
513
+ export interface GetDefaultComponentsRequest {
514
+ }
515
+ export interface GetDefaultComponentsResponse {
516
+ footer?: Record<string, any> | null;
517
+ logo?: Record<string, any> | null;
518
+ follow?: Record<string, any> | null;
519
+ }
520
+ export interface EstimateFilterSizeRequest {
521
+ /** Contacts filter expression. */
522
+ filter?: Record<string, any> | null;
523
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
524
+ activeContactsOnly?: boolean;
525
+ /**
526
+ * Contacts plain text search expression (searches in name, phone and email fields).
527
+ * @minLength 1
528
+ * @maxLength 100
529
+ */
530
+ search?: string | null;
531
+ }
532
+ export interface EstimateFilterSizeResponse {
533
+ /** Mailing list size estimation. */
534
+ estimation?: number;
535
+ }
536
+ export interface EstimateAudienceSizeRequest {
537
+ /**
538
+ * Contact IDs of a campaign audience.
539
+ * @format GUID
540
+ */
541
+ contactIds?: string[];
542
+ /** Label IDs of a campaign audience. */
543
+ labelIds?: string[];
544
+ /** Contacts filter expression (json). */
545
+ contactsFilter?: Record<string, any> | null;
546
+ /**
547
+ * Contacts plain text search expression (searches in name, phone and email fields).
548
+ * @minLength 1
549
+ * @maxLength 100
550
+ */
551
+ search?: string | null;
552
+ /**
553
+ * Segment ids of a campaign audience.
554
+ * @format GUID
555
+ */
556
+ segmentIds?: string[];
557
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
558
+ activeContactsOnly?: boolean;
559
+ /**
560
+ * Id of a campaign that is to be resent.
561
+ * @format GUID
562
+ */
563
+ resendCampaignId?: string | null;
564
+ /** Should total number of contacts in provided audience be returned or not (default value "false"). */
565
+ withTotal?: boolean;
566
+ }
567
+ export interface EstimateAudienceSizeResponse {
568
+ /** Audience size (estimated number of emails to be sent). */
569
+ estimation?: number;
570
+ /** Total number of contacts in provided audience (optional). */
571
+ total?: number | null;
572
+ }
573
+ export interface ReconcileContactRequest {
574
+ /**
575
+ * Email address of the contact.
576
+ * @format EMAIL
577
+ */
578
+ emailAddress?: string;
579
+ }
580
+ export interface ReconcileContactResponse {
581
+ /** Created or retrieved contact. */
582
+ contact?: Contact;
583
+ }
584
+ export interface Contact {
585
+ /**
586
+ * Unique ID of the contact entity.
587
+ * @format GUID
588
+ */
589
+ _id?: string;
590
+ /**
591
+ * Primary email address of the contact.
592
+ * @format EMAIL
593
+ */
594
+ emailAddress?: string;
595
+ /**
596
+ * Full name of the contact (optional).
597
+ * @maxLength 100
598
+ */
599
+ fullName?: string | null;
600
+ /**
601
+ * Profile picture of the contact (optional).
602
+ * @format WEB_URL
603
+ * @maxLength 2048
604
+ */
605
+ pictureUrl?: string | null;
606
+ }
607
+ export interface SearchContactsRequest {
608
+ /**
609
+ * Text to search contacts by - can search by name or email address.
610
+ * @maxLength 100
611
+ */
612
+ searchTerm?: string;
613
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
614
+ activeContactsOnly?: boolean;
615
+ /**
616
+ * Page size (default 50, max 1000).
617
+ * @max 1000
618
+ */
619
+ pageSize?: number | null;
620
+ }
621
+ export interface SearchContactsResponse {
622
+ /** Search results. */
623
+ contacts?: Contact[];
624
+ }
625
+ export interface GetLabelsRequest {
626
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
627
+ activeContactsOnly?: boolean;
628
+ }
629
+ export interface GetLabelsResponse {
630
+ /** Returned labels with contact counts. */
631
+ labels?: Label[];
632
+ }
633
+ export interface Label {
634
+ /**
635
+ * Unique ID of the label entity.
636
+ * @maxLength 100
637
+ */
638
+ _id?: string;
639
+ /**
640
+ * Name of the label.
641
+ * @maxLength 100
642
+ */
643
+ name?: string;
644
+ /** Amount of contacts assigned to the label. */
645
+ contactsCount?: number;
646
+ }
647
+ export interface SubscribeFromLandingPageRequest {
648
+ /**
649
+ * Campaign ID that the subscription is happening from.
650
+ * @format GUID
651
+ */
652
+ campaignId?: string;
653
+ /**
654
+ * Email address that is entered into subscription field.
655
+ * @format EMAIL
656
+ */
657
+ emailAddress?: string;
658
+ /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
659
+ consent?: boolean;
660
+ }
661
+ export interface SubscribeFromLandingPageResponse {
662
+ /** @format GUID */
663
+ contactId?: string;
664
+ }
665
+ export interface GetCampaignRequest {
666
+ /**
667
+ * Campaign ID.
668
+ * @format GUID
669
+ */
670
+ campaignId: string;
671
+ /**
672
+ * Whether a returned campaign object should include `publishingData.statistics`.
673
+ *
674
+ * Default: `false`.
675
+ */
676
+ optionIncludeStatistics?: boolean;
677
+ }
678
+ export interface GetCampaignResponse {
679
+ /** Campaign information. */
680
+ campaign?: Campaign;
681
+ }
682
+ export interface ListCampaignsRequest {
683
+ /** Paging parameters. */
684
+ paging?: Paging;
685
+ /**
686
+ * Whether to include `publishingData.statistics` in the returned campaign object.
687
+ *
688
+ * Default: `false`.
689
+ */
690
+ optionIncludeStatistics?: boolean;
691
+ /**
692
+ * Include campaigns with the following statuses (no filtering by default). One of:
693
+ * + `'ACTIVE'`
694
+ * + `'ARCHIVED'`
695
+ * + `'DELETED'`
696
+ */
697
+ statuses?: CampaignStatusEnum[];
698
+ /**
699
+ * Include campaigns with the following visibility statuses (no filtering by default). One of:
700
+ * + `'DRAFT'`
701
+ * + `'PUBLISHED'`
702
+ * + `'TEMPLATE'`
703
+ */
704
+ visibilityStatuses?: CampaignVisibilityStatusEnum[];
705
+ }
706
+ export interface Paging {
707
+ /** Number of items to load. */
708
+ limit?: number | null;
709
+ /** Number of items to skip in the current sort order. */
710
+ offset?: number | null;
711
+ }
712
+ export interface ListCampaignsResponse {
713
+ /** Paging parameters. */
714
+ paging?: Paging;
715
+ /** List of campaigns. */
716
+ campaigns?: Campaign[];
717
+ }
718
+ export interface CountCampaignsRequest {
567
719
  /** Since when should we start counting (optional, default value "1970-01-01T00:00:00.000Z") */
568
720
  dateFrom?: Date | null;
569
721
  }
@@ -580,7 +732,10 @@ export interface CountCampaignsResponse {
580
732
  archived?: number;
581
733
  }
582
734
  export interface CreateFromTemplateRequest {
583
- /** ID of the template to fork. */
735
+ /**
736
+ * ID of the template to fork.
737
+ * @format GUID
738
+ */
584
739
  templateId?: string;
585
740
  /** Values to replace template placeholders with (unique for each template). */
586
741
  variables?: Record<string, string>;
@@ -592,9 +747,15 @@ export interface CreateFromTemplateResponse {
592
747
  campaign?: Campaign;
593
748
  }
594
749
  export interface CreateUserTemplateRequest {
595
- /** ID of campaign to create template from. */
750
+ /**
751
+ * ID of campaign to create template from.
752
+ * @format GUID
753
+ */
596
754
  campaignId?: string;
597
- /** Title of template. */
755
+ /**
756
+ * Title of template.
757
+ * @maxLength 1000
758
+ */
598
759
  title?: string | null;
599
760
  }
600
761
  export interface CreateUserTemplateResponse {
@@ -602,7 +763,10 @@ export interface CreateUserTemplateResponse {
602
763
  campaign?: Campaign;
603
764
  }
604
765
  export interface CreateFromUserTemplateRequest {
605
- /** ID of the user template campaign to use. */
766
+ /**
767
+ * ID of the user template campaign to use.
768
+ * @format GUID
769
+ */
606
770
  campaignId?: string;
607
771
  }
608
772
  export interface CreateFromUserTemplateResponse {
@@ -610,20 +774,30 @@ export interface CreateFromUserTemplateResponse {
610
774
  campaign?: Campaign;
611
775
  }
612
776
  export interface PublishCampaignRequest {
613
- /** Campaign ID */
777
+ /**
778
+ * Campaign ID
779
+ * @format GUID
780
+ */
614
781
  campaignId: string;
615
782
  /** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
616
783
  emailDistributionOptions?: EmailDistributionOptions;
617
784
  }
618
785
  export interface EmailDistributionOptions {
619
- /** The subject line for the email campaign, which appears in recipients’ inboxes. */
786
+ /**
787
+ * The subject line for the email campaign, which appears in recipients’ inboxes.
788
+ * @maxLength 1000
789
+ */
620
790
  emailSubject?: string | null;
621
791
  /** Contact label IDs. */
622
792
  labelIds?: string[];
623
- /** IDs of contacts to whom to send out the campaign. */
793
+ /**
794
+ * IDs of contacts to whom to send out the campaign.
795
+ * @format GUID
796
+ */
624
797
  contactIds?: string[];
625
798
  /**
626
799
  * Filter ids to send campaign to (unsupported).
800
+ * @format GUID
627
801
  * @deprecated Filter ids to send campaign to (unsupported).
628
802
  * @replacedBy contacts_filter
629
803
  * @targetRemovalDate 2023-10-10
@@ -637,23 +811,39 @@ export interface PublishCampaignResponse {
637
811
  publishingData?: PublishingData;
638
812
  }
639
813
  export interface Rejected {
640
- /** ID of the campaign that was rejected. */
814
+ /**
815
+ * ID of the campaign that was rejected.
816
+ * @format GUID
817
+ */
641
818
  campaignId?: string;
642
819
  }
643
820
  export interface Published {
644
- /** ID of the campaign that was published. */
821
+ /**
822
+ * ID of the campaign that was published.
823
+ * @format GUID
824
+ */
645
825
  campaignId?: string;
646
- /** Campaign landing page URL. */
826
+ /**
827
+ * Campaign landing page URL.
828
+ * @format WEB_URL
829
+ * @maxLength 2048
830
+ */
647
831
  landingPageUrl?: string;
648
832
  /** Estimation of recipient list size (optional). */
649
833
  mailingListSizeEstimate?: number | null;
650
834
  }
651
835
  export interface Terminated {
652
- /** ID of the campaign that was terminated. */
836
+ /**
837
+ * ID of the campaign that was terminated.
838
+ * @format GUID
839
+ */
653
840
  campaignId?: string;
654
841
  }
655
842
  export interface Distributed {
656
- /** ID of the campaign that was distributed. */
843
+ /**
844
+ * ID of the campaign that was distributed.
845
+ * @format GUID
846
+ */
657
847
  campaignId?: string;
658
848
  }
659
849
  export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf {
@@ -674,16 +864,28 @@ export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf
674
864
  * Indicates a permanent error sending your email. For example, the email address does not exist.
675
865
  */
676
866
  hardBounce?: HardBounce;
677
- /** Campaign ID. */
867
+ /**
868
+ * Campaign ID.
869
+ * @format GUID
870
+ */
678
871
  campaignId?: string;
679
- /** [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient. */
872
+ /**
873
+ * [Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of a recipient.
874
+ * @format GUID
875
+ */
680
876
  contactId?: string;
681
- /** Email address of a recipient. */
877
+ /**
878
+ * Email address of a recipient.
879
+ * @format EMAIL
880
+ */
682
881
  recipientEmailAddress?: string;
683
882
  /** Date and time of the event. */
684
883
  timestamp?: Date | null;
685
884
  activityType?: ActivityType;
686
- /** email metadata */
885
+ /**
886
+ * email metadata
887
+ * @maxSize 20
888
+ */
687
889
  metadata?: Record<string, string>;
688
890
  }
689
891
  /** @oneof */
@@ -733,113 +935,61 @@ export interface SoftBounce {
733
935
  /** Reason the email soft bounced. */
734
936
  reason?: string;
735
937
  }
736
- export interface HardBounce {
737
- /** Reason the email hard bounced. */
738
- reason?: string;
739
- }
740
- export interface Scheduled {
741
- /** ID of the campaign that was scheduled. */
742
- campaignId?: string;
743
- /** The timestamp campaign is scheduled for. */
744
- sendAt?: Date | null;
745
- /** Shows if this is a rescheduling of previously scheduled campaign. */
746
- rescheduled?: boolean;
747
- }
748
- export interface SendTestRequest {
749
- /** Campaign ID. */
750
- campaignId: string;
751
- /** Email subject. */
752
- emailSubject?: string | null;
753
- /** Recipient email address. */
754
- toEmailAddress: string;
755
- }
756
- export interface PlaceholderContent extends PlaceholderContentValueOneOf {
757
- text?: PlainText;
758
- html?: Html;
759
- money?: Money;
760
- dateTime?: DateTime;
761
- map?: Map;
762
- array?: _Array;
763
- enum?: PlaceholderContentEnum;
764
- attachment?: Attachment;
765
- integer?: Integer;
766
- decimal?: Decimal;
767
- }
768
- /** @oneof */
769
- export interface PlaceholderContentValueOneOf {
770
- text?: PlainText;
771
- html?: Html;
772
- money?: Money;
773
- dateTime?: DateTime;
774
- map?: Map;
775
- array?: _Array;
776
- enum?: PlaceholderContentEnum;
777
- attachment?: Attachment;
778
- integer?: Integer;
779
- decimal?: Decimal;
780
- }
781
- export interface PlainText {
782
- text?: string;
783
- }
784
- export interface Html {
785
- html?: string;
786
- }
787
- /**
788
- * Money.
789
- * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
790
- */
791
- 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. */
793
- value?: string;
794
- /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
795
- currency?: string;
796
- /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
797
- formattedValue?: string | null;
798
- }
799
- export interface DateTime {
800
- timestamp?: Date | null;
801
- /** optional time zone is the full name. example: "Asia/Jerusalem" */
802
- timeZone?: string | null;
803
- }
804
- export interface Map {
805
- variables?: Record<string, PlaceholderContent>;
806
- }
807
- export interface _Array {
808
- items?: PlaceholderContent[];
809
- }
810
- export interface PlaceholderContentEnum {
811
- value?: string;
812
- translation?: string;
813
- }
814
- export interface Attachment {
815
- fileName?: string;
816
- downloadUrl?: string;
938
+ export interface HardBounce {
939
+ /** Reason the email hard bounced. */
940
+ reason?: string;
817
941
  }
818
- export interface Integer {
819
- /** min value: -2147483648, max value: 2147483647 */
820
- value?: number;
942
+ export interface Scheduled {
943
+ /**
944
+ * ID of the campaign that was scheduled.
945
+ * @format GUID
946
+ */
947
+ campaignId?: string;
948
+ /** The timestamp campaign is scheduled for. */
949
+ sendAt?: Date | null;
950
+ /** Shows if this is a rescheduling of previously scheduled campaign. */
951
+ rescheduled?: boolean;
821
952
  }
822
- export interface Decimal {
953
+ export interface SendTestRequest {
823
954
  /**
824
- * when converted from Double, has a limitation of max 16 digits (including fractional part)
825
- * highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
955
+ * Campaign ID.
956
+ * @format GUID
826
957
  */
827
- value?: string;
958
+ campaignId: string;
959
+ /**
960
+ * Email subject.
961
+ * @maxLength 1000
962
+ */
963
+ emailSubject?: string | null;
964
+ /**
965
+ * Recipient email address.
966
+ * @format EMAIL
967
+ */
968
+ toEmailAddress: string;
828
969
  }
829
970
  export interface SendTestResponse {
830
971
  }
831
972
  export interface PauseSchedulingRequest {
832
- /** Campaign ID. */
973
+ /**
974
+ * Campaign ID.
975
+ * @format GUID
976
+ */
833
977
  campaignId: string;
834
978
  }
835
979
  export interface PauseSchedulingResponse {
836
980
  }
837
981
  export interface Paused {
838
- /** ID of the campaign that was paused. */
982
+ /**
983
+ * ID of the campaign that was paused.
984
+ * @format GUID
985
+ */
839
986
  campaignId?: string;
840
987
  }
841
988
  export interface RescheduleRequest {
842
- /** ID of the campaign to reschedule. */
989
+ /**
990
+ * ID of the campaign to reschedule.
991
+ * @format GUID
992
+ */
843
993
  campaignId: string;
844
994
  /** New time for sending out the campaign. */
845
995
  sendAt: Date | null;
@@ -847,43 +997,67 @@ export interface RescheduleRequest {
847
997
  export interface RescheduleResponse {
848
998
  }
849
999
  export interface ArchiveCampaignRequest {
850
- /** ID of the campaign to archive. */
1000
+ /**
1001
+ * ID of the campaign to archive.
1002
+ * @format GUID
1003
+ */
851
1004
  campaignId?: string;
852
1005
  }
853
1006
  export interface ArchiveCampaignResponse {
854
1007
  }
855
1008
  /** Sent when status of the campaign is changed from "Active" to "Archived" */
856
1009
  export interface Archived {
857
- /** ID of the campaign that was archived. */
1010
+ /**
1011
+ * ID of the campaign that was archived.
1012
+ * @format GUID
1013
+ */
858
1014
  campaignId?: string;
859
1015
  }
860
1016
  export interface UnarchiveCampaignRequest {
861
- /** ID of the campaign to unarchive. */
1017
+ /**
1018
+ * ID of the campaign to unarchive.
1019
+ * @format GUID
1020
+ */
862
1021
  campaignId?: string;
863
1022
  }
864
1023
  export interface UnarchiveCampaignResponse {
865
1024
  }
866
1025
  /** Sent when status of the campaign is changed from "Archived" to "Active" */
867
1026
  export interface Unarchived {
868
- /** ID of the campaign whose status was changed to active. */
1027
+ /**
1028
+ * ID of the campaign whose status was changed to active.
1029
+ * @format GUID
1030
+ */
869
1031
  campaignId?: string;
870
1032
  }
871
1033
  export interface UpdateTitleRequest {
872
- /** ID of the campaign to change title of. */
1034
+ /**
1035
+ * ID of the campaign to change title of.
1036
+ * @format GUID
1037
+ */
873
1038
  campaignId?: string;
874
- /** New title to set. */
1039
+ /**
1040
+ * New title to set.
1041
+ * @maxLength 1000
1042
+ */
875
1043
  title?: string;
876
1044
  }
877
1045
  export interface UpdateTitleResponse {
878
1046
  }
879
1047
  export interface DeleteCampaignRequest {
880
- /** Campaign ID. */
1048
+ /**
1049
+ * Campaign ID.
1050
+ * @format GUID
1051
+ */
881
1052
  campaignId: string;
882
1053
  }
883
1054
  export interface DeleteCampaignResponse {
884
1055
  }
885
1056
  export interface ReuseCampaignRequest {
886
- /** ID of the message to be duplicated. */
1057
+ /**
1058
+ * ID of the message to be duplicated.
1059
+ * @format GUID
1060
+ */
887
1061
  campaignId: string;
888
1062
  }
889
1063
  export interface ReuseCampaignResponse {
@@ -891,9 +1065,15 @@ export interface ReuseCampaignResponse {
891
1065
  campaign?: Campaign;
892
1066
  }
893
1067
  export interface PreviewCampaignRequest {
894
- /** ID of the campaign to preview. */
1068
+ /**
1069
+ * ID of the campaign to preview.
1070
+ * @format GUID
1071
+ */
895
1072
  campaignId?: string;
896
- /** Preferred language for campaign content (optional). */
1073
+ /**
1074
+ * Preferred language for campaign content (optional).
1075
+ * @format LANGUAGE
1076
+ */
897
1077
  language?: string | null;
898
1078
  /** Values to replace campaign placeholders with (unique for each campaign). */
899
1079
  placeholders?: Record<string, PlaceholderContent>;
@@ -905,29 +1085,50 @@ export interface PreviewCampaignResponse {
905
1085
  html?: string;
906
1086
  }
907
1087
  export interface GetComposerRequest {
908
- /** Campaign ID. */
1088
+ /**
1089
+ * Campaign ID.
1090
+ * @format GUID
1091
+ */
909
1092
  campaignId?: string;
910
- /** Preferred language for campaign content (optional). */
1093
+ /**
1094
+ * Preferred language for campaign content (optional).
1095
+ * @format LANGUAGE
1096
+ */
911
1097
  language?: string | null;
912
1098
  }
913
1099
  export interface GetComposerResponse {
914
1100
  /** Composer. */
915
1101
  composer?: Composer;
916
- /** Campaign subject. */
1102
+ /**
1103
+ * Campaign subject.
1104
+ * @maxLength 1000
1105
+ */
917
1106
  emailSubject?: string;
918
- /** Campaign preheader (optional). */
1107
+ /**
1108
+ * Campaign preheader (optional).
1109
+ * @maxLength 1000
1110
+ */
919
1111
  emailPreheader?: string | null;
920
1112
  }
921
1113
  export interface UpdateComposerRequest {
922
- /** Campaign ID. */
1114
+ /**
1115
+ * Campaign ID.
1116
+ * @format GUID
1117
+ */
923
1118
  campaignId?: string;
924
1119
  /** Campaign composer. */
925
1120
  composer?: Composer;
926
1121
  /** Campaign editor type (optional, default "WEB"). */
927
1122
  campaignEditorType?: CampaignEditorType;
928
- /** Campaign subject (optional). */
1123
+ /**
1124
+ * Campaign subject (optional).
1125
+ * @maxLength 1000
1126
+ */
929
1127
  emailSubject?: string | null;
930
- /** Campaign preheader (optional). */
1128
+ /**
1129
+ * Campaign preheader (optional).
1130
+ * @maxLength 1000
1131
+ */
931
1132
  emailPreheader?: string | null;
932
1133
  }
933
1134
  /** specifies if campaign is being created and edited in web or mobile app */
@@ -941,9 +1142,15 @@ export interface CreateCampaignRequest {
941
1142
  composer?: Composer;
942
1143
  /** Campaign editor type (optional, default "WEB"). */
943
1144
  campaignEditorType?: CampaignEditorType;
944
- /** Campaign subject (optional). */
1145
+ /**
1146
+ * Campaign subject (optional).
1147
+ * @maxLength 1000
1148
+ */
945
1149
  emailSubject?: string | null;
946
- /** Campaign preheader (optional). */
1150
+ /**
1151
+ * Campaign preheader (optional).
1152
+ * @maxLength 1000
1153
+ */
947
1154
  emailPreheader?: string | null;
948
1155
  }
949
1156
  export interface CreateCampaignResponse {
@@ -951,17 +1158,29 @@ export interface CreateCampaignResponse {
951
1158
  campaign?: Campaign;
952
1159
  }
953
1160
  export interface ResendToNonOpenersRequest {
954
- /** ID of the campaign to resend. */
1161
+ /**
1162
+ * ID of the campaign to resend.
1163
+ * @format GUID
1164
+ */
955
1165
  campaignId?: string;
956
- /** Subject line to use with the resent copy of campaign. */
1166
+ /**
1167
+ * Subject line to use with the resent copy of campaign.
1168
+ * @maxLength 1000
1169
+ */
957
1170
  emailSubject?: string | null;
958
1171
  }
959
1172
  export interface ResendToNonOpenersResponse {
960
- /** ID of the newly created and resent campaign. */
1173
+ /**
1174
+ * ID of the newly created and resent campaign.
1175
+ * @format GUID
1176
+ */
961
1177
  campaignId?: string;
962
1178
  }
963
1179
  export interface GetAudienceRequest {
964
- /** Campaign ID. */
1180
+ /**
1181
+ * Campaign ID.
1182
+ * @format GUID
1183
+ */
965
1184
  campaignId: string;
966
1185
  }
967
1186
  export interface GetAudienceResponse {
@@ -969,25 +1188,51 @@ export interface GetAudienceResponse {
969
1188
  audience?: CampaignAudience;
970
1189
  }
971
1190
  export interface CampaignAudience {
972
- /** IDs of contacts to whom to send the campaign. */
1191
+ /**
1192
+ * IDs of contacts to whom to send the campaign.
1193
+ * @format GUID
1194
+ * @maxSize 100
1195
+ */
973
1196
  contactIds?: string[];
974
- /** Labels IDs. */
1197
+ /**
1198
+ * Labels IDs.
1199
+ * @maxLength 100
1200
+ * @maxSize 20
1201
+ */
975
1202
  labelIds?: string[];
976
- /** Segment IDs. */
1203
+ /**
1204
+ * Segment IDs.
1205
+ * @format GUID
1206
+ * @maxSize 20
1207
+ */
977
1208
  segmentIds?: string[];
978
1209
  /** Filter for contacts in JSON format. */
979
1210
  contactsFilter?: Record<string, any> | null;
980
- /** Contacts plain text search expression (searches in name, phone and email fields). */
1211
+ /**
1212
+ * Contacts plain text search expression (searches in name, phone and email fields).
1213
+ * @minLength 1
1214
+ * @maxLength 100
1215
+ */
981
1216
  contactsSearchTerm?: string | null;
982
1217
  /** Should "inactive" contacts be excluded or not. */
983
1218
  activeContactsOnly?: boolean;
984
1219
  }
985
1220
  export interface IdentifySenderAddressRequest {
986
- /** Email address to verify. */
1221
+ /**
1222
+ * Email address to verify.
1223
+ * @format EMAIL
1224
+ * @minLength 6
1225
+ * @maxLength 254
1226
+ */
987
1227
  emailAddress: string;
988
1228
  }
989
1229
  export interface IdentifySenderAddressResponse {
990
- /** Actual "from" address that will be used for sending emails. */
1230
+ /**
1231
+ * Actual "from" address that will be used for sending emails.
1232
+ * @format EMAIL
1233
+ * @minLength 6
1234
+ * @maxLength 254
1235
+ */
991
1236
  senderAddress?: string;
992
1237
  }
993
1238
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -1006,99 +1251,247 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1006
1251
  */
1007
1252
  entityFqdn?: string;
1008
1253
  /**
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
1254
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1255
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1256
+ * Example: created/updated/deleted/started/completed/email_opened
1257
+ */
1258
+ slug?: string;
1259
+ /** ID of the entity associated with the event. */
1260
+ entityId?: string;
1261
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1262
+ eventTime?: Date | null;
1263
+ /**
1264
+ * Whether the event was triggered as a result of a privacy regulation application
1265
+ * (for example, GDPR).
1266
+ */
1267
+ triggeredByAnonymizeRequest?: boolean | null;
1268
+ /** If present, indicates the action that triggered the event. */
1269
+ originatedFrom?: string | null;
1270
+ /**
1271
+ * A sequence number defining the order of updates to the underlying entity.
1272
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1273
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1274
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1275
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1276
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1277
+ */
1278
+ entityEventSequence?: string | null;
1279
+ }
1280
+ /** @oneof */
1281
+ export interface DomainEventBodyOneOf {
1282
+ createdEvent?: EntityCreatedEvent;
1283
+ updatedEvent?: EntityUpdatedEvent;
1284
+ deletedEvent?: EntityDeletedEvent;
1285
+ actionEvent?: ActionEvent;
1286
+ }
1287
+ export interface EntityCreatedEvent {
1288
+ entity?: string;
1289
+ }
1290
+ export interface RestoreInfo {
1291
+ deletedDate?: Date | null;
1292
+ }
1293
+ export interface EntityUpdatedEvent {
1294
+ /**
1295
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1296
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1297
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1298
+ */
1299
+ currentEntity?: string;
1300
+ }
1301
+ export interface EntityDeletedEvent {
1302
+ /** Entity that was deleted */
1303
+ deletedEntity?: string | null;
1304
+ }
1305
+ export interface ActionEvent {
1306
+ body?: string;
1307
+ }
1308
+ export interface MessageEnvelope {
1309
+ /**
1310
+ * App instance ID.
1311
+ * @format GUID
1312
+ */
1313
+ instanceId?: string | null;
1314
+ /**
1315
+ * Event type.
1316
+ * @maxLength 150
1317
+ */
1318
+ eventType?: string;
1319
+ /** The identification type and identity data. */
1320
+ identity?: IdentificationData;
1321
+ /** Stringify payload. */
1322
+ data?: string;
1323
+ }
1324
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1325
+ /**
1326
+ * ID of a site visitor that has not logged in to the site.
1327
+ * @format GUID
1328
+ */
1329
+ anonymousVisitorId?: string;
1330
+ /**
1331
+ * ID of a site visitor that has logged in to the site.
1332
+ * @format GUID
1333
+ */
1334
+ memberId?: string;
1335
+ /**
1336
+ * ID of a Wix user (site owner, contributor, etc.).
1337
+ * @format GUID
1338
+ */
1339
+ wixUserId?: string;
1340
+ /**
1341
+ * ID of an app.
1342
+ * @format GUID
1343
+ */
1344
+ appId?: string;
1345
+ /** @readonly */
1346
+ identityType?: WebhookIdentityType;
1347
+ }
1348
+ /** @oneof */
1349
+ export interface IdentificationDataIdOneOf {
1350
+ /**
1351
+ * ID of a site visitor that has not logged in to the site.
1352
+ * @format GUID
1353
+ */
1354
+ anonymousVisitorId?: string;
1355
+ /**
1356
+ * ID of a site visitor that has logged in to the site.
1357
+ * @format GUID
1358
+ */
1359
+ memberId?: string;
1360
+ /**
1361
+ * ID of a Wix user (site owner, contributor, etc.).
1362
+ * @format GUID
1363
+ */
1364
+ wixUserId?: string;
1365
+ /**
1366
+ * ID of an app.
1367
+ * @format GUID
1368
+ */
1369
+ appId?: string;
1370
+ }
1371
+ export declare enum WebhookIdentityType {
1372
+ UNKNOWN = "UNKNOWN",
1373
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1374
+ MEMBER = "MEMBER",
1375
+ WIX_USER = "WIX_USER",
1376
+ APP = "APP"
1377
+ }
1378
+ export interface ListStatisticsRequest {
1379
+ /**
1380
+ * IDs of the campaigns to retrieve (max 100 campaigns).
1381
+ * @format GUID
1382
+ * @minSize 1
1383
+ * @maxSize 100
1384
+ */
1385
+ campaignIds: string[];
1386
+ }
1387
+ export interface ListStatisticsResponse {
1388
+ /** List of statistics. */
1389
+ statistics?: CampaignStatisticsContainer[];
1390
+ }
1391
+ export interface CampaignStatisticsContainer {
1392
+ /**
1393
+ * Campaign ID.
1394
+ * @format GUID
1395
+ */
1396
+ campaignId?: string;
1397
+ /** Landing page statistics. */
1398
+ landingPage?: LandingPageStatistics;
1399
+ /** Email campaign statistics. */
1400
+ email?: DistributionStatistics;
1401
+ }
1402
+ export interface ListRecipientsRequest {
1403
+ /**
1404
+ * Campaign ID.
1405
+ * @format GUID
1406
+ */
1407
+ campaignId: string;
1408
+ /**
1409
+ * __Required.__ Email activity to filter for. One of:
1410
+ * + `'DELIVERED'`
1411
+ * + `'OPENED'`
1412
+ * + `'CLICKED'`
1413
+ * + `'BOUNCED'`
1414
+ * + `'NOT_SENT'`
1415
+ */
1416
+ activity: RecipientsActivityEnum;
1417
+ /** Pagination options. */
1418
+ paging?: CursorPaging;
1419
+ }
1420
+ export declare enum RecipientsActivityEnum {
1421
+ UNKNOWN = "UNKNOWN",
1422
+ DELIVERED = "DELIVERED",
1423
+ OPENED = "OPENED",
1424
+ CLICKED = "CLICKED",
1425
+ BOUNCED = "BOUNCED",
1426
+ NOT_SENT = "NOT_SENT",
1427
+ SENT = "SENT",
1428
+ NOT_OPENED = "NOT_OPENED"
1429
+ }
1430
+ export interface CursorPaging {
1431
+ /**
1432
+ * Number of items to load.
1433
+ * @max 1000
1434
+ */
1435
+ limit?: number | null;
1436
+ /**
1437
+ * Pointer to the next or previous page in the list of results.
1438
+ *
1439
+ * You can get the relevant cursor token
1440
+ * from the `pagingMetadata` object in the previous call's response.
1441
+ * Not relevant for the first request.
1442
+ */
1443
+ cursor?: string | null;
1444
+ }
1445
+ export interface ListRecipientsResponse {
1446
+ /** List of recipients. */
1447
+ recipients?: CampaignRecipientDetails[];
1448
+ /** Details on the paged set of returned results. */
1449
+ pagingMetadata?: PagingMetadataV2;
1450
+ }
1451
+ export interface CampaignRecipientDetails {
1452
+ /**
1453
+ * Contact ID.
1454
+ * @format GUID
1012
1455
  */
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;
1456
+ contactId?: string;
1457
+ /** Date and time of the last activity. */
1458
+ lastActivityDate?: Date | null;
1018
1459
  /**
1019
- * Whether the event was triggered as a result of a privacy regulation application
1020
- * (for example, GDPR).
1460
+ * Primary email address of the contact.
1461
+ * @format EMAIL
1021
1462
  */
1022
- triggeredByAnonymizeRequest?: boolean | null;
1023
- /** If present, indicates the action that triggered the event. */
1024
- originatedFrom?: string | null;
1463
+ emailAddress?: string;
1025
1464
  /**
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.
1465
+ * Full name of the contact (optional).
1466
+ * @maxLength 100
1032
1467
  */
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;
1468
+ fullName?: string | null;
1469
+ /** Is this contact currently deleted from the site or not. */
1470
+ contactDeleted?: boolean;
1044
1471
  }
1045
- export interface RestoreInfo {
1046
- deletedDate?: Date | null;
1472
+ export interface PagingMetadataV2 {
1473
+ /** Number of items returned in the response. */
1474
+ count?: number | null;
1475
+ /** Offset that was requested. */
1476
+ offset?: number | null;
1477
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1478
+ total?: number | null;
1479
+ /** Flag that indicates the server failed to calculate the `total` field. */
1480
+ tooManyToCount?: boolean | null;
1481
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1482
+ cursors?: Cursors;
1047
1483
  }
1048
- export interface EntityUpdatedEvent {
1484
+ export interface Cursors {
1049
1485
  /**
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.
1486
+ * Cursor string pointing to the next page in the list of results.
1487
+ * @maxLength 16000
1053
1488
  */
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"
1489
+ next?: string | null;
1490
+ /**
1491
+ * Cursor pointing to the previous page in the list of results.
1492
+ * @maxLength 16000
1493
+ */
1494
+ prev?: string | null;
1102
1495
  }
1103
1496
  export interface ValidateLinkResponseNonNullableFields {
1104
1497
  valid: boolean;
@@ -1118,22 +1511,6 @@ interface DistributionStatisticsNonNullableFields {
1118
1511
  complained: number;
1119
1512
  notSent: number;
1120
1513
  }
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
1514
  interface TotalStatisticsNonNullableFields {
1138
1515
  mailsSent: number;
1139
1516
  opened: number;
@@ -1188,10 +1565,32 @@ export interface GetAudienceResponseNonNullableFields {
1188
1565
  export interface IdentifySenderAddressResponseNonNullableFields {
1189
1566
  senderAddress: string;
1190
1567
  }
1568
+ interface CampaignStatisticsContainerNonNullableFields {
1569
+ campaignId: string;
1570
+ landingPage?: LandingPageStatisticsNonNullableFields;
1571
+ email?: DistributionStatisticsNonNullableFields;
1572
+ }
1573
+ export interface ListStatisticsResponseNonNullableFields {
1574
+ statistics: CampaignStatisticsContainerNonNullableFields[];
1575
+ }
1576
+ interface CampaignRecipientDetailsNonNullableFields {
1577
+ contactId: string;
1578
+ emailAddress: string;
1579
+ contactDeleted: boolean;
1580
+ }
1581
+ export interface ListRecipientsResponseNonNullableFields {
1582
+ recipients: CampaignRecipientDetailsNonNullableFields[];
1583
+ }
1191
1584
  export interface BaseEventMetadata {
1192
- /** App instance ID. */
1585
+ /**
1586
+ * App instance ID.
1587
+ * @format GUID
1588
+ */
1193
1589
  instanceId?: string | null;
1194
- /** Event type. */
1590
+ /**
1591
+ * Event type.
1592
+ * @maxLength 150
1593
+ */
1195
1594
  eventType?: string;
1196
1595
  /** The identification type and identity data. */
1197
1596
  identity?: IdentificationData;
@@ -1242,6 +1641,8 @@ export interface CampaignDistributedEnvelope {
1242
1641
  * Triggered when a campaign is successfully distributed to all recipients.
1243
1642
  * @permissionScope Access Verticals by Automations
1244
1643
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1644
+ * @permissionScope Set Up Automations
1645
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1245
1646
  * @permissionScope Read Email Marketing
1246
1647
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1247
1648
  * @permissionScope Manage Email Marketing
@@ -1261,6 +1662,8 @@ export interface CampaignPausedEnvelope {
1261
1662
  * Triggered when a scheduled campaign is paused.
1262
1663
  * @permissionScope Access Verticals by Automations
1263
1664
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1665
+ * @permissionScope Set Up Automations
1666
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1264
1667
  * @permissionScope Read Email Marketing
1265
1668
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1266
1669
  * @permissionScope Manage Email Marketing
@@ -1280,6 +1683,8 @@ export interface CampaignPublishedEnvelope {
1280
1683
  * Triggered when a draft campaign is published.
1281
1684
  * @permissionScope Access Verticals by Automations
1282
1685
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1686
+ * @permissionScope Set Up Automations
1687
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1283
1688
  * @permissionScope Read Email Marketing
1284
1689
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1285
1690
  * @permissionScope Manage Email Marketing
@@ -1299,6 +1704,8 @@ export interface CampaignRejectedEnvelope {
1299
1704
  * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
1300
1705
  * @permissionScope Access Verticals by Automations
1301
1706
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1707
+ * @permissionScope Set Up Automations
1708
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1302
1709
  * @permissionScope Read Email Marketing
1303
1710
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1304
1711
  * @permissionScope Manage Email Marketing
@@ -1318,6 +1725,8 @@ export interface CampaignScheduledEnvelope {
1318
1725
  * Triggered when a campaign is scheduled to be sent out at the specific time.
1319
1726
  * @permissionScope Access Verticals by Automations
1320
1727
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1728
+ * @permissionScope Set Up Automations
1729
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1321
1730
  * @permissionScope Read Email Marketing
1322
1731
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1323
1732
  * @permissionScope Manage Email Marketing
@@ -1337,6 +1746,8 @@ export interface CampaignTerminatedEnvelope {
1337
1746
  * Triggered when the mailing list isn't clean and campaign was terminated.
1338
1747
  * @permissionScope Access Verticals by Automations
1339
1748
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1749
+ * @permissionScope Set Up Automations
1750
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1340
1751
  * @permissionScope Read Email Marketing
1341
1752
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1342
1753
  * @permissionScope Manage Email Marketing
@@ -1356,6 +1767,8 @@ export interface CampaignCreatedEnvelope {
1356
1767
  * Triggered when a campaign is created.
1357
1768
  * @permissionScope Access Verticals by Automations
1358
1769
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1770
+ * @permissionScope Set Up Automations
1771
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1359
1772
  * @permissionScope Read Email Marketing
1360
1773
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1361
1774
  * @permissionScope Manage Email Marketing
@@ -1374,6 +1787,8 @@ export interface CampaignDeletedEnvelope {
1374
1787
  * Triggered when a campaign is deleted.
1375
1788
  * @permissionScope Access Verticals by Automations
1376
1789
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1790
+ * @permissionScope Set Up Automations
1791
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1377
1792
  * @permissionScope Read Email Marketing
1378
1793
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1379
1794
  * @permissionScope Manage Email Marketing
@@ -1393,6 +1808,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
1393
1808
  * Triggered when an email campaign has a new recipient activity.
1394
1809
  * @permissionScope Access Verticals by Automations
1395
1810
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1811
+ * @permissionScope Set Up Automations
1812
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1396
1813
  * @permissionScope Read Email Marketing
1397
1814
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1398
1815
  * @permissionScope Manage Email Marketing
@@ -1410,11 +1827,12 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
1410
1827
  * If you provide a link as a placeholder, it's returned in a response as valid.
1411
1828
  * @param url - URL to validate.
1412
1829
  * @public
1413
- * @documentationMaturity preview
1414
1830
  * @requiredField url
1415
1831
  * @permissionId Shoutout.Manage
1416
1832
  * @permissionScope Access Verticals by Automations
1417
1833
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1834
+ * @permissionScope Set Up Automations
1835
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1418
1836
  * @permissionScope Manage Email Marketing
1419
1837
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1420
1838
  * @applicableIdentity APP
@@ -1425,75 +1843,18 @@ export declare function validateLink(url: string): Promise<ValidateLinkResponse
1425
1843
  * 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
1844
  * @param html - HTML string with links.
1427
1845
  * @public
1428
- * @documentationMaturity preview
1429
1846
  * @requiredField html
1430
1847
  * @permissionId Shoutout.Manage
1431
1848
  * @permissionScope Access Verticals by Automations
1432
1849
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1850
+ * @permissionScope Set Up Automations
1851
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1433
1852
  * @permissionScope Manage Email Marketing
1434
1853
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1435
1854
  * @applicableIdentity APP
1436
1855
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
1437
1856
  */
1438
1857
  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
1858
  /**
1498
1859
  * Retrieves information about an email campaign.
1499
1860
  * @param campaignId - Campaign ID.
@@ -1503,6 +1864,8 @@ export interface ListRecipientsOptions {
1503
1864
  * @permissionId Shoutout.Manage
1504
1865
  * @permissionScope Access Verticals by Automations
1505
1866
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1867
+ * @permissionScope Set Up Automations
1868
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1506
1869
  * @permissionScope Manage Email Marketing
1507
1870
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1508
1871
  * @applicableIdentity APP
@@ -1527,6 +1890,8 @@ export interface GetCampaignOptions {
1527
1890
  * @permissionId Shoutout.Read
1528
1891
  * @permissionScope Access Verticals by Automations
1529
1892
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1893
+ * @permissionScope Set Up Automations
1894
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1530
1895
  * @permissionScope Read Email Marketing
1531
1896
  * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
1532
1897
  * @permissionScope Manage Email Marketing
@@ -1570,6 +1935,8 @@ export interface ListCampaignsOptions {
1570
1935
  * @permissionId Shoutout.Manage
1571
1936
  * @permissionScope Access Verticals by Automations
1572
1937
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1938
+ * @permissionScope Set Up Automations
1939
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1573
1940
  * @permissionScope Manage Email Marketing
1574
1941
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1575
1942
  * @applicableIdentity APP
@@ -1592,6 +1959,8 @@ export interface PublishCampaignOptions {
1592
1959
  * @permissionId Shoutout.Manage
1593
1960
  * @permissionScope Access Verticals by Automations
1594
1961
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1962
+ * @permissionScope Set Up Automations
1963
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1595
1964
  * @permissionScope Manage Email Marketing
1596
1965
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1597
1966
  * @applicableIdentity APP
@@ -1599,9 +1968,15 @@ export interface PublishCampaignOptions {
1599
1968
  */
1600
1969
  export declare function sendTest(campaignId: string, options?: SendTestOptions): Promise<void>;
1601
1970
  export interface SendTestOptions {
1602
- /** Email subject. */
1971
+ /**
1972
+ * Email subject.
1973
+ * @maxLength 1000
1974
+ */
1603
1975
  emailSubject?: string | null;
1604
- /** Recipient email address. */
1976
+ /**
1977
+ * Recipient email address.
1978
+ * @format EMAIL
1979
+ */
1605
1980
  toEmailAddress: string;
1606
1981
  }
1607
1982
  /**
@@ -1612,6 +1987,8 @@ export interface SendTestOptions {
1612
1987
  * @permissionId Shoutout.Manage
1613
1988
  * @permissionScope Access Verticals by Automations
1614
1989
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1990
+ * @permissionScope Set Up Automations
1991
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1615
1992
  * @permissionScope Manage Email Marketing
1616
1993
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1617
1994
  * @applicableIdentity APP
@@ -1628,6 +2005,8 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
1628
2005
  * @permissionId Shoutout.Manage
1629
2006
  * @permissionScope Access Verticals by Automations
1630
2007
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2008
+ * @permissionScope Set Up Automations
2009
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1631
2010
  * @permissionScope Manage Email Marketing
1632
2011
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1633
2012
  * @applicableIdentity APP
@@ -1642,6 +2021,8 @@ export declare function reschedule(campaignId: string, sendAt: Date | null): Pro
1642
2021
  * @permissionId Shoutout.Manage
1643
2022
  * @permissionScope Access Verticals by Automations
1644
2023
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2024
+ * @permissionScope Set Up Automations
2025
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1645
2026
  * @permissionScope Manage Email Marketing
1646
2027
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1647
2028
  * @applicableIdentity APP
@@ -1656,6 +2037,8 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
1656
2037
  * @permissionId Shoutout.Manage
1657
2038
  * @permissionScope Access Verticals by Automations
1658
2039
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2040
+ * @permissionScope Set Up Automations
2041
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1659
2042
  * @permissionScope Manage Email Marketing
1660
2043
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1661
2044
  * @applicableIdentity APP
@@ -1670,6 +2053,8 @@ export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaign
1670
2053
  * @permissionId Shoutout.Manage
1671
2054
  * @permissionScope Access Verticals by Automations
1672
2055
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2056
+ * @permissionScope Set Up Automations
2057
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1673
2058
  * @permissionScope Manage Email Marketing
1674
2059
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1675
2060
  * @applicableIdentity APP
@@ -1684,10 +2069,74 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
1684
2069
  * @permissionId Shoutout.Manage
1685
2070
  * @permissionScope Access Verticals by Automations
1686
2071
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2072
+ * @permissionScope Set Up Automations
2073
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1687
2074
  * @permissionScope Manage Email Marketing
1688
2075
  * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
1689
2076
  * @applicableIdentity APP
1690
2077
  * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
1691
2078
  */
1692
2079
  export declare function identifySenderAddress(emailAddress: string): Promise<IdentifySenderAddressResponse & IdentifySenderAddressResponseNonNullableFields>;
2080
+ /**
2081
+ * Retrieves a list of statistics for up to 100 selected campaigns.
2082
+ *
2083
+ * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
2084
+ * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
2085
+ *
2086
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2087
+ * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
2088
+ * @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
2089
+ * @public
2090
+ * @requiredField campaignIds
2091
+ * @permissionId Shoutout.Read
2092
+ * @permissionScope Access Verticals by Automations
2093
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2094
+ * @permissionScope Set Up Automations
2095
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2096
+ * @permissionScope Read Email Marketing
2097
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
2098
+ * @permissionScope Manage Email Marketing
2099
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
2100
+ * @applicableIdentity APP
2101
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
2102
+ */
2103
+ export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
2104
+ /**
2105
+ * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
2106
+ *
2107
+ * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
2108
+ *
2109
+ * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
2110
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2111
+ *
2112
+ * If no `activity` is included, this endpoint returns an error.
2113
+ *
2114
+ * @param campaignId - Campaign ID.
2115
+ * @param activity - __Required.__ Email activity to filter for. One of:
2116
+ * + `'DELIVERED'`
2117
+ * + `'OPENED'`
2118
+ * + `'CLICKED'`
2119
+ * + `'BOUNCED'`
2120
+ * + `'NOT_SENT'`
2121
+ * @public
2122
+ * @requiredField activity
2123
+ * @requiredField campaignId
2124
+ * @param options - Options to use when getting the list of recipients.
2125
+ * @permissionId Shoutout.Read
2126
+ * @permissionScope Access Verticals by Automations
2127
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2128
+ * @permissionScope Set Up Automations
2129
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2130
+ * @permissionScope Read Email Marketing
2131
+ * @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
2132
+ * @permissionScope Manage Email Marketing
2133
+ * @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
2134
+ * @applicableIdentity APP
2135
+ * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
2136
+ */
2137
+ export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
2138
+ export interface ListRecipientsOptions {
2139
+ /** Pagination options. */
2140
+ paging?: CursorPaging;
2141
+ }
1693
2142
  export {};