@wix/auto_sdk_email-marketing_campaigns 1.0.10 → 1.0.11

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 +7 -7
  2. package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js +6 -6
  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 +23 -23
  5. package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js +81 -81
  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 +6 -6
  8. package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +25 -25
  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 +35 -35
  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 +268 -268
  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 +316 -316
  17. package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +88 -88
  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 +7 -7
  20. package/build/es/src/email-marketing-v1-campaign-campaigns.context.js +6 -6
  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 +23 -23
  23. package/build/es/src/email-marketing-v1-campaign-campaigns.http.js +76 -76
  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 +6 -6
  26. package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js +20 -20
  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 +35 -35
  29. package/build/es/src/email-marketing-v1-campaign-campaigns.public.js +8 -8
  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 +268 -268
  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 +316 -316
  35. package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js +83 -83
  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 +7 -7
  38. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js +6 -6
  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 +23 -23
  41. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js +81 -81
  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 +6 -6
  44. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +25 -25
  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 +35 -35
  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 +268 -268
  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 +316 -316
  53. package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +88 -88
  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 +7 -7
  56. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js +6 -6
  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 +23 -23
  59. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js +76 -76
  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 +6 -6
  62. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js +20 -20
  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 +35 -35
  65. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js +8 -8
  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 +268 -268
  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 +316 -316
  71. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js +83 -83
  72. package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
  73. package/package.json +2 -2
@@ -196,27 +196,116 @@ export declare enum CampaignTypeEnum {
196
196
  /** Triggered email. */
197
197
  TRIGGERED = "TRIGGERED"
198
198
  }
199
- export interface ValidateLinkRequest {
199
+ export interface ListStatisticsRequest {
200
200
  /**
201
- * URL to validate.
202
- * @minLength 1
201
+ * IDs of the campaigns to retrieve (max 100 campaigns).
202
+ * @format GUID
203
+ * @minSize 1
204
+ * @maxSize 100
203
205
  */
204
- url: string;
206
+ campaignIds: string[];
205
207
  }
206
- export interface ValidateLinkResponse {
207
- /** Whether the link is valid. */
208
- valid?: boolean;
208
+ export interface ListStatisticsResponse {
209
+ /** List of statistics. */
210
+ statistics?: CampaignStatisticsContainer[];
209
211
  }
210
- export interface ValidateHtmlLinksRequest {
212
+ export interface CampaignStatisticsContainer {
211
213
  /**
212
- * HTML string with links.
213
- * @maxLength 1000000
214
+ * Campaign ID.
215
+ * @format GUID
214
216
  */
215
- html: string;
217
+ campaignId?: string;
218
+ /** Landing page statistics. */
219
+ landingPage?: LandingPageStatistics;
220
+ /** Email campaign statistics. */
221
+ email?: DistributionStatistics;
216
222
  }
217
- export interface ValidateHtmlLinksResponse {
218
- /** Non-valid links. */
219
- blacklistedLinks?: string[];
223
+ export interface ListRecipientsRequest {
224
+ /**
225
+ * Campaign ID.
226
+ * @format GUID
227
+ */
228
+ campaignId: string;
229
+ /** Email activity to filter. */
230
+ activity: RecipientsActivityEnum;
231
+ /** Pagination options. */
232
+ paging?: CursorPaging;
233
+ }
234
+ export declare enum RecipientsActivityEnum {
235
+ UNKNOWN = "UNKNOWN",
236
+ DELIVERED = "DELIVERED",
237
+ OPENED = "OPENED",
238
+ CLICKED = "CLICKED",
239
+ BOUNCED = "BOUNCED",
240
+ NOT_SENT = "NOT_SENT",
241
+ SENT = "SENT",
242
+ NOT_OPENED = "NOT_OPENED"
243
+ }
244
+ export interface CursorPaging {
245
+ /**
246
+ * Number of items to load.
247
+ * @max 1000
248
+ */
249
+ limit?: number | null;
250
+ /**
251
+ * Pointer to the next or previous page in the list of results.
252
+ *
253
+ * You can get the relevant cursor token
254
+ * from the `pagingMetadata` object in the previous call's response.
255
+ * Not relevant for the first request.
256
+ */
257
+ cursor?: string | null;
258
+ }
259
+ export interface ListRecipientsResponse {
260
+ /** List of recipients. */
261
+ recipients?: CampaignRecipientDetails[];
262
+ /** Details on the paged set of returned results. */
263
+ pagingMetadata?: PagingMetadataV2;
264
+ }
265
+ export interface CampaignRecipientDetails {
266
+ /**
267
+ * Contact ID.
268
+ * @format GUID
269
+ */
270
+ contactId?: string;
271
+ /** Date and time of the last activity. */
272
+ lastActivityDate?: Date | null;
273
+ /**
274
+ * Primary email address of the contact.
275
+ * @format EMAIL
276
+ */
277
+ emailAddress?: string;
278
+ /**
279
+ * Full name of the contact (optional).
280
+ * @maxLength 100
281
+ */
282
+ fullName?: string | null;
283
+ /** Is this contact currently deleted from the site or not. */
284
+ contactDeleted?: boolean;
285
+ }
286
+ export interface PagingMetadataV2 {
287
+ /** Number of items returned in the response. */
288
+ count?: number | null;
289
+ /** Offset that was requested. */
290
+ offset?: number | null;
291
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
292
+ total?: number | null;
293
+ /** Flag that indicates the server failed to calculate the `total` field. */
294
+ tooManyToCount?: boolean | null;
295
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
296
+ cursors?: Cursors;
297
+ }
298
+ export interface Cursors {
299
+ /**
300
+ * Cursor string pointing to the next page in the list of results.
301
+ * @maxLength 16000
302
+ */
303
+ next?: string | null;
304
+ /**
305
+ * Cursor pointing to the previous page in the list of results.
306
+ * @maxLength 16000
307
+ */
308
+ prev?: string | null;
220
309
  }
221
310
  export interface GetCampaignMappingRequest {
222
311
  /**
@@ -460,169 +549,6 @@ export interface Decimal {
460
549
  }
461
550
  export interface SendTestBulkResponse {
462
551
  }
463
- export interface GetPlaceholderKeysRequest {
464
- /**
465
- * Campaign ID.
466
- * @format GUID
467
- */
468
- campaignId?: string;
469
- }
470
- export interface GetPlaceholderKeysResponse {
471
- /** Keys of placeholders used in the campaign. */
472
- placeholderKeys?: string[];
473
- }
474
- export interface GetDefaultComponentsRequest {
475
- }
476
- export interface GetDefaultComponentsResponse {
477
- footer?: Record<string, any> | null;
478
- logo?: Record<string, any> | null;
479
- follow?: Record<string, any> | null;
480
- }
481
- export interface EstimateFilterSizeRequest {
482
- /** Contacts filter expression. */
483
- filter?: Record<string, any> | null;
484
- /** Should "inactive" contacts be excluded or not (default value "false"). */
485
- activeContactsOnly?: boolean;
486
- /**
487
- * Contacts plain text search expression (searches in name, phone and email fields).
488
- * @minLength 1
489
- * @maxLength 100
490
- */
491
- search?: string | null;
492
- }
493
- export interface EstimateFilterSizeResponse {
494
- /** Mailing list size estimation. */
495
- estimation?: number;
496
- }
497
- export interface EstimateAudienceSizeRequest {
498
- /**
499
- * Contact IDs of a campaign audience.
500
- * @format GUID
501
- */
502
- contactIds?: string[];
503
- /** Label IDs of a campaign audience. */
504
- labelIds?: string[];
505
- /** Contacts filter expression (json). */
506
- contactsFilter?: Record<string, any> | null;
507
- /**
508
- * Contacts plain text search expression (searches in name, phone and email fields).
509
- * @minLength 1
510
- * @maxLength 100
511
- */
512
- search?: string | null;
513
- /**
514
- * Segment ids of a campaign audience.
515
- * @format GUID
516
- */
517
- segmentIds?: string[];
518
- /** Should "inactive" contacts be excluded or not (default value "false"). */
519
- activeContactsOnly?: boolean;
520
- /**
521
- * Id of a campaign that is to be resent.
522
- * @format GUID
523
- */
524
- resendCampaignId?: string | null;
525
- /** Should total number of contacts in provided audience be returned or not (default value "false"). */
526
- withTotal?: boolean;
527
- }
528
- export interface EstimateAudienceSizeResponse {
529
- /** Audience size (estimated number of emails to be sent). */
530
- estimation?: number;
531
- /** Total number of contacts in provided audience (optional). */
532
- total?: number | null;
533
- }
534
- export interface ReconcileContactRequest {
535
- /**
536
- * Email address of the contact.
537
- * @format EMAIL
538
- */
539
- emailAddress?: string;
540
- }
541
- export interface ReconcileContactResponse {
542
- /** Created or retrieved contact. */
543
- contact?: Contact;
544
- }
545
- export interface Contact {
546
- /**
547
- * Unique ID of the contact entity.
548
- * @format GUID
549
- */
550
- id?: string;
551
- /**
552
- * Primary email address of the contact.
553
- * @format EMAIL
554
- */
555
- emailAddress?: string;
556
- /**
557
- * Full name of the contact (optional).
558
- * @maxLength 100
559
- */
560
- fullName?: string | null;
561
- /**
562
- * Profile picture of the contact (optional).
563
- * @format WEB_URL
564
- * @maxLength 2048
565
- */
566
- pictureUrl?: string | null;
567
- }
568
- export interface SearchContactsRequest {
569
- /**
570
- * Text to search contacts by - can search by name or email address.
571
- * @maxLength 100
572
- */
573
- searchTerm?: string;
574
- /** Should "inactive" contacts be excluded or not (default value "false"). */
575
- activeContactsOnly?: boolean;
576
- /**
577
- * Page size (default 50, max 1000).
578
- * @max 1000
579
- */
580
- pageSize?: number | null;
581
- }
582
- export interface SearchContactsResponse {
583
- /** Search results. */
584
- contacts?: Contact[];
585
- }
586
- export interface GetLabelsRequest {
587
- /** Should "inactive" contacts be excluded or not (default value "false"). */
588
- activeContactsOnly?: boolean;
589
- }
590
- export interface GetLabelsResponse {
591
- /** Returned labels with contact counts. */
592
- labels?: Label[];
593
- }
594
- export interface Label {
595
- /**
596
- * Unique ID of the label entity.
597
- * @maxLength 100
598
- */
599
- id?: string;
600
- /**
601
- * Name of the label.
602
- * @maxLength 100
603
- */
604
- name?: string;
605
- /** Amount of contacts assigned to the label. */
606
- contactsCount?: number;
607
- }
608
- export interface SubscribeFromLandingPageRequest {
609
- /**
610
- * Campaign ID that the subscription is happening from.
611
- * @format GUID
612
- */
613
- campaignId?: string;
614
- /**
615
- * Email address that is entered into subscription field.
616
- * @format EMAIL
617
- */
618
- emailAddress?: string;
619
- /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
620
- consent?: boolean;
621
- }
622
- export interface SubscribeFromLandingPageResponse {
623
- /** @format GUID */
624
- contactId?: string;
625
- }
626
552
  export interface GetCampaignRequest {
627
553
  /**
628
554
  * Campaign ID.
@@ -1328,80 +1254,116 @@ export declare enum WebhookIdentityType {
1328
1254
  WIX_USER = "WIX_USER",
1329
1255
  APP = "APP"
1330
1256
  }
1331
- export interface ListStatisticsRequest {
1257
+ export interface GetPlaceholderKeysRequest {
1332
1258
  /**
1333
- * IDs of the campaigns to retrieve (max 100 campaigns).
1259
+ * Campaign ID.
1334
1260
  * @format GUID
1335
- * @minSize 1
1336
- * @maxSize 100
1337
1261
  */
1338
- campaignIds: string[];
1262
+ campaignId?: string;
1339
1263
  }
1340
- export interface ListStatisticsResponse {
1341
- /** List of statistics. */
1342
- statistics?: CampaignStatisticsContainer[];
1264
+ export interface GetPlaceholderKeysResponse {
1265
+ /** Keys of placeholders used in the campaign. */
1266
+ placeholderKeys?: string[];
1343
1267
  }
1344
- export interface CampaignStatisticsContainer {
1268
+ export interface GetDefaultComponentsRequest {
1269
+ }
1270
+ export interface GetDefaultComponentsResponse {
1271
+ footer?: Record<string, any> | null;
1272
+ logo?: Record<string, any> | null;
1273
+ follow?: Record<string, any> | null;
1274
+ }
1275
+ export interface ValidateLinkRequest {
1345
1276
  /**
1346
- * Campaign ID.
1347
- * @format GUID
1277
+ * URL to validate.
1278
+ * @minLength 1
1348
1279
  */
1349
- campaignId?: string;
1350
- /** Landing page statistics. */
1351
- landingPage?: LandingPageStatistics;
1352
- /** Email campaign statistics. */
1353
- email?: DistributionStatistics;
1280
+ url: string;
1354
1281
  }
1355
- export interface ListRecipientsRequest {
1282
+ export interface ValidateLinkResponse {
1283
+ /** Whether the link is valid. */
1284
+ valid?: boolean;
1285
+ }
1286
+ export interface ValidateHtmlLinksRequest {
1356
1287
  /**
1357
- * Campaign ID.
1358
- * @format GUID
1288
+ * HTML string with links.
1289
+ * @maxLength 1000000
1359
1290
  */
1360
- campaignId: string;
1361
- /** Email activity to filter. */
1362
- activity: RecipientsActivityEnum;
1363
- /** Pagination options. */
1364
- paging?: CursorPaging;
1291
+ html: string;
1365
1292
  }
1366
- export declare enum RecipientsActivityEnum {
1367
- UNKNOWN = "UNKNOWN",
1368
- DELIVERED = "DELIVERED",
1369
- OPENED = "OPENED",
1370
- CLICKED = "CLICKED",
1371
- BOUNCED = "BOUNCED",
1372
- NOT_SENT = "NOT_SENT",
1373
- SENT = "SENT",
1374
- NOT_OPENED = "NOT_OPENED"
1293
+ export interface ValidateHtmlLinksResponse {
1294
+ /** Non-valid links. */
1295
+ blacklistedLinks?: string[];
1375
1296
  }
1376
- export interface CursorPaging {
1297
+ export interface EstimateFilterSizeRequest {
1298
+ /** Contacts filter expression. */
1299
+ filter?: Record<string, any> | null;
1300
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1301
+ activeContactsOnly?: boolean;
1377
1302
  /**
1378
- * Number of items to load.
1379
- * @max 1000
1303
+ * Contacts plain text search expression (searches in name, phone and email fields).
1304
+ * @minLength 1
1305
+ * @maxLength 100
1380
1306
  */
1381
- limit?: number | null;
1307
+ search?: string | null;
1308
+ }
1309
+ export interface EstimateFilterSizeResponse {
1310
+ /** Mailing list size estimation. */
1311
+ estimation?: number;
1312
+ }
1313
+ export interface EstimateAudienceSizeRequest {
1382
1314
  /**
1383
- * Pointer to the next or previous page in the list of results.
1384
- *
1385
- * You can get the relevant cursor token
1386
- * from the `pagingMetadata` object in the previous call's response.
1387
- * Not relevant for the first request.
1315
+ * Contact IDs of a campaign audience.
1316
+ * @format GUID
1388
1317
  */
1389
- cursor?: string | null;
1318
+ contactIds?: string[];
1319
+ /** Label IDs of a campaign audience. */
1320
+ labelIds?: string[];
1321
+ /** Contacts filter expression (json). */
1322
+ contactsFilter?: Record<string, any> | null;
1323
+ /**
1324
+ * Contacts plain text search expression (searches in name, phone and email fields).
1325
+ * @minLength 1
1326
+ * @maxLength 100
1327
+ */
1328
+ search?: string | null;
1329
+ /**
1330
+ * Segment ids of a campaign audience.
1331
+ * @format GUID
1332
+ */
1333
+ segmentIds?: string[];
1334
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1335
+ activeContactsOnly?: boolean;
1336
+ /**
1337
+ * Id of a campaign that is to be resent.
1338
+ * @format GUID
1339
+ */
1340
+ resendCampaignId?: string | null;
1341
+ /** Should total number of contacts in provided audience be returned or not (default value "false"). */
1342
+ withTotal?: boolean;
1390
1343
  }
1391
- export interface ListRecipientsResponse {
1392
- /** List of recipients. */
1393
- recipients?: CampaignRecipientDetails[];
1394
- /** Details on the paged set of returned results. */
1395
- pagingMetadata?: PagingMetadataV2;
1344
+ export interface EstimateAudienceSizeResponse {
1345
+ /** Audience size (estimated number of emails to be sent). */
1346
+ estimation?: number;
1347
+ /** Total number of contacts in provided audience (optional). */
1348
+ total?: number | null;
1396
1349
  }
1397
- export interface CampaignRecipientDetails {
1350
+ export interface ReconcileContactRequest {
1398
1351
  /**
1399
- * Contact ID.
1352
+ * Email address of the contact.
1353
+ * @format EMAIL
1354
+ */
1355
+ emailAddress?: string;
1356
+ }
1357
+ export interface ReconcileContactResponse {
1358
+ /** Created or retrieved contact. */
1359
+ contact?: Contact;
1360
+ }
1361
+ export interface Contact {
1362
+ /**
1363
+ * Unique ID of the contact entity.
1400
1364
  * @format GUID
1401
1365
  */
1402
- contactId?: string;
1403
- /** Date and time of the last activity. */
1404
- lastActivityDate?: Date | null;
1366
+ id?: string;
1405
1367
  /**
1406
1368
  * Primary email address of the contact.
1407
1369
  * @format EMAIL
@@ -1412,38 +1374,70 @@ export interface CampaignRecipientDetails {
1412
1374
  * @maxLength 100
1413
1375
  */
1414
1376
  fullName?: string | null;
1415
- /** Is this contact currently deleted from the site or not. */
1416
- contactDeleted?: boolean;
1377
+ /**
1378
+ * Profile picture of the contact (optional).
1379
+ * @format WEB_URL
1380
+ * @maxLength 2048
1381
+ */
1382
+ pictureUrl?: string | null;
1417
1383
  }
1418
- export interface PagingMetadataV2 {
1419
- /** Number of items returned in the response. */
1420
- count?: number | null;
1421
- /** Offset that was requested. */
1422
- offset?: number | null;
1423
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1424
- total?: number | null;
1425
- /** Flag that indicates the server failed to calculate the `total` field. */
1426
- tooManyToCount?: boolean | null;
1427
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1428
- cursors?: Cursors;
1384
+ export interface SearchContactsRequest {
1385
+ /**
1386
+ * Text to search contacts by - can search by name or email address.
1387
+ * @maxLength 100
1388
+ */
1389
+ searchTerm?: string;
1390
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1391
+ activeContactsOnly?: boolean;
1392
+ /**
1393
+ * Page size (default 50, max 1000).
1394
+ * @max 1000
1395
+ */
1396
+ pageSize?: number | null;
1429
1397
  }
1430
- export interface Cursors {
1398
+ export interface SearchContactsResponse {
1399
+ /** Search results. */
1400
+ contacts?: Contact[];
1401
+ }
1402
+ export interface GetLabelsRequest {
1403
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1404
+ activeContactsOnly?: boolean;
1405
+ }
1406
+ export interface GetLabelsResponse {
1407
+ /** Returned labels with contact counts. */
1408
+ labels?: Label[];
1409
+ }
1410
+ export interface Label {
1431
1411
  /**
1432
- * Cursor string pointing to the next page in the list of results.
1433
- * @maxLength 16000
1412
+ * Unique ID of the label entity.
1413
+ * @maxLength 100
1434
1414
  */
1435
- next?: string | null;
1415
+ id?: string;
1436
1416
  /**
1437
- * Cursor pointing to the previous page in the list of results.
1438
- * @maxLength 16000
1417
+ * Name of the label.
1418
+ * @maxLength 100
1439
1419
  */
1440
- prev?: string | null;
1420
+ name?: string;
1421
+ /** Amount of contacts assigned to the label. */
1422
+ contactsCount?: number;
1441
1423
  }
1442
- export interface ValidateLinkResponseNonNullableFields {
1443
- valid: boolean;
1424
+ export interface SubscribeFromLandingPageRequest {
1425
+ /**
1426
+ * Campaign ID that the subscription is happening from.
1427
+ * @format GUID
1428
+ */
1429
+ campaignId?: string;
1430
+ /**
1431
+ * Email address that is entered into subscription field.
1432
+ * @format EMAIL
1433
+ */
1434
+ emailAddress?: string;
1435
+ /** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
1436
+ consent?: boolean;
1444
1437
  }
1445
- export interface ValidateHtmlLinksResponseNonNullableFields {
1446
- blacklistedLinks: string[];
1438
+ export interface SubscribeFromLandingPageResponse {
1439
+ /** @format GUID */
1440
+ contactId?: string;
1447
1441
  }
1448
1442
  interface LandingPageStatisticsNonNullableFields {
1449
1443
  opened: number;
@@ -1457,6 +1451,22 @@ interface DistributionStatisticsNonNullableFields {
1457
1451
  complained: number;
1458
1452
  notSent: number;
1459
1453
  }
1454
+ interface CampaignStatisticsContainerNonNullableFields {
1455
+ campaignId: string;
1456
+ landingPage?: LandingPageStatisticsNonNullableFields;
1457
+ email?: DistributionStatisticsNonNullableFields;
1458
+ }
1459
+ export interface ListStatisticsResponseNonNullableFields {
1460
+ statistics: CampaignStatisticsContainerNonNullableFields[];
1461
+ }
1462
+ interface CampaignRecipientDetailsNonNullableFields {
1463
+ contactId: string;
1464
+ emailAddress: string;
1465
+ contactDeleted: boolean;
1466
+ }
1467
+ export interface ListRecipientsResponseNonNullableFields {
1468
+ recipients: CampaignRecipientDetailsNonNullableFields[];
1469
+ }
1460
1470
  interface TotalStatisticsNonNullableFields {
1461
1471
  mailsSent: number;
1462
1472
  opened: number;
@@ -1511,20 +1521,10 @@ export interface GetAudienceResponseNonNullableFields {
1511
1521
  export interface IdentifySenderAddressResponseNonNullableFields {
1512
1522
  senderAddress: string;
1513
1523
  }
1514
- interface CampaignStatisticsContainerNonNullableFields {
1515
- campaignId: string;
1516
- landingPage?: LandingPageStatisticsNonNullableFields;
1517
- email?: DistributionStatisticsNonNullableFields;
1518
- }
1519
- export interface ListStatisticsResponseNonNullableFields {
1520
- statistics: CampaignStatisticsContainerNonNullableFields[];
1521
- }
1522
- interface CampaignRecipientDetailsNonNullableFields {
1523
- contactId: string;
1524
- emailAddress: string;
1525
- contactDeleted: boolean;
1524
+ export interface ValidateLinkResponseNonNullableFields {
1525
+ valid: boolean;
1526
1526
  }
1527
- export interface ListRecipientsResponseNonNullableFields {
1528
- recipients: CampaignRecipientDetailsNonNullableFields[];
1527
+ export interface ValidateHtmlLinksResponseNonNullableFields {
1528
+ blacklistedLinks: string[];
1529
1529
  }
1530
1530
  export {};
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RecipientsActivityEnum = exports.WebhookIdentityType = exports.ActivityType = exports.CampaignTypeEnum = exports.CampaignSendingStateEnum = exports.RejectionReasonEnum = exports.Enum = exports.CampaignVisibilityStatusEnum = exports.CampaignStatusEnum = exports.CampaignEditorTypeEnum = void 0;
3
+ exports.WebhookIdentityType = exports.ActivityType = exports.RecipientsActivityEnum = exports.CampaignTypeEnum = exports.CampaignSendingStateEnum = exports.RejectionReasonEnum = exports.Enum = exports.CampaignVisibilityStatusEnum = exports.CampaignStatusEnum = exports.CampaignEditorTypeEnum = void 0;
4
4
  var CampaignEditorTypeEnum;
5
5
  (function (CampaignEditorTypeEnum) {
6
6
  /** Unknown editor. This value isn't used. */
@@ -112,6 +112,17 @@ var CampaignTypeEnum;
112
112
  /** Triggered email. */
113
113
  CampaignTypeEnum["TRIGGERED"] = "TRIGGERED";
114
114
  })(CampaignTypeEnum || (exports.CampaignTypeEnum = CampaignTypeEnum = {}));
115
+ var RecipientsActivityEnum;
116
+ (function (RecipientsActivityEnum) {
117
+ RecipientsActivityEnum["UNKNOWN"] = "UNKNOWN";
118
+ RecipientsActivityEnum["DELIVERED"] = "DELIVERED";
119
+ RecipientsActivityEnum["OPENED"] = "OPENED";
120
+ RecipientsActivityEnum["CLICKED"] = "CLICKED";
121
+ RecipientsActivityEnum["BOUNCED"] = "BOUNCED";
122
+ RecipientsActivityEnum["NOT_SENT"] = "NOT_SENT";
123
+ RecipientsActivityEnum["SENT"] = "SENT";
124
+ RecipientsActivityEnum["NOT_OPENED"] = "NOT_OPENED";
125
+ })(RecipientsActivityEnum || (exports.RecipientsActivityEnum = RecipientsActivityEnum = {}));
115
126
  /** The type of email activity that triggered the webhook. */
116
127
  var ActivityType;
117
128
  (function (ActivityType) {
@@ -134,15 +145,4 @@ var WebhookIdentityType;
134
145
  WebhookIdentityType["WIX_USER"] = "WIX_USER";
135
146
  WebhookIdentityType["APP"] = "APP";
136
147
  })(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
137
- var RecipientsActivityEnum;
138
- (function (RecipientsActivityEnum) {
139
- RecipientsActivityEnum["UNKNOWN"] = "UNKNOWN";
140
- RecipientsActivityEnum["DELIVERED"] = "DELIVERED";
141
- RecipientsActivityEnum["OPENED"] = "OPENED";
142
- RecipientsActivityEnum["CLICKED"] = "CLICKED";
143
- RecipientsActivityEnum["BOUNCED"] = "BOUNCED";
144
- RecipientsActivityEnum["NOT_SENT"] = "NOT_SENT";
145
- RecipientsActivityEnum["SENT"] = "SENT";
146
- RecipientsActivityEnum["NOT_OPENED"] = "NOT_OPENED";
147
- })(RecipientsActivityEnum || (exports.RecipientsActivityEnum = RecipientsActivityEnum = {}));
148
148
  //# sourceMappingURL=email-marketing-v1-campaign-campaigns.types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"email-marketing-v1-campaign-campaigns.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-campaign-campaigns.types.ts"],"names":[],"mappings":";;;AAmCA,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,6CAA6C;IAC7C,6CAAmB,CAAA;IACnB,0BAA0B;IAC1B,qCAAW,CAAA;IACX,6BAA6B;IAC7B,2CAAiB,CAAA;IACjB,kCAAkC;IAClC,uCAAa,CAAA;AACf,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAED,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,+CAA+C;IAC/C,yCAAmB,CAAA;IACnB,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,4BAA4B;IAC5B,2CAAqB,CAAA;IACrB,2BAA2B;IAC3B,yCAAmB,CAAA;AACrB,CAAC,EATW,kBAAkB,kCAAlB,kBAAkB,QAS7B;AAED,IAAY,4BASX;AATD,WAAY,4BAA4B;IACtC,6CAA6C;IAC7C,mDAAmB,CAAA;IACnB,oCAAoC;IACpC,+CAAe,CAAA;IACf,6BAA6B;IAC7B,uDAAuB,CAAA;IACvB,8BAA8B;IAC9B,qDAAqB,CAAA;AACvB,CAAC,EATW,4BAA4B,4CAA5B,4BAA4B,QASvC;AAED,IAAY,IAuBX;AAvBD,WAAY,IAAI;IACd,mCAAmC;IACnC,2BAAmB,CAAA;IACnB,oDAAoD;IACpD,mCAA2B,CAAA;IAC3B,8CAA8C;IAC9C,+BAAuB,CAAA;IACvB,sDAAsD;IACtD,qCAA6B,CAAA;IAC7B,oDAAoD;IACpD,uCAA+B,CAAA;IAC/B,8FAA8F;IAC9F,6BAAqB,CAAA;IACrB,oDAAoD;IACpD,2BAAmB,CAAA;IACnB,4BAA4B;IAC5B,6BAAqB,CAAA;IACrB,2DAA2D;IAC3D,iCAAyB,CAAA;IACzB,uDAAuD;IACvD,mCAA2B,CAAA;IAC3B,oCAAoC;IACpC,yBAAiB,CAAA;AACnB,CAAC,EAvBW,IAAI,oBAAJ,IAAI,QAuBf;AAoED,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,wDAAiC,CAAA;IACjC,wDAAiC,CAAA;IACjC,gDAAyB,CAAA;IACzB,sCAAe,CAAA;IACf,oEAA6C,CAAA;IAC7C,kEAA2C,CAAA;IAC3C,kEAA2C,CAAA;IAC3C,oFAA6D,CAAA;IAC7D,sEAA+C,CAAA;IAC/C,sFAA+D,CAAA;IAC/D,0EAAmD,CAAA;IACnD,kFAA2D,CAAA;IAC3D,kEAA2C,CAAA;AAC7C,CAAC,EAfW,mBAAmB,mCAAnB,mBAAmB,QAe9B;AAED,IAAY,wBAsBX;AAtBD,WAAY,wBAAwB;IAClC,kCAAkC;IAClC,2CAAe,CAAA;IACf,kCAAkC;IAClC,6CAAiB,CAAA;IACjB,6BAA6B;IAC7B,iDAAqB,CAAA;IACrB,6BAA6B;IAC7B,mDAAuB,CAAA;IACvB,qCAAqC;IACrC,6CAAiB,CAAA;IACjB,6BAA6B;IAC7B,mDAAuB,CAAA;IACvB,8BAA8B;IAC9B,+CAAmB,CAAA;IACnB;;;OAGG;IACH,6DAAiC,CAAA;IACjC,yBAAyB;IACzB,yCAAa,CAAA;AACf,CAAC,EAtBW,wBAAwB,wCAAxB,wBAAwB,QAsBnC;AAED,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,gCAAgC;IAChC,uDAAmC,CAAA;IACnC,qCAAqC;IACrC,6CAAyB,CAAA;IACzB,2BAA2B;IAC3B,6CAAyB,CAAA;IACzB,uBAAuB;IACvB,2CAAuB,CAAA;AACzB,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AA+tBD,6DAA6D;AAC7D,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,6DAA6D;IAC7D,qCAAqB,CAAA;IACrB,wEAAwE;IACxE,+BAAe,CAAA;IACf,2DAA2D;IAC3D,6BAAa,CAAA;IACb,kDAAkD;IAClD,2CAA2B,CAAA;IAC3B,wCAAwC;IACxC,6CAA6B,CAAA;AAC/B,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB;AA6eD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAyCD,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,iDAAuB,CAAA;IACvB,2CAAiB,CAAA;IACjB,6CAAmB,CAAA;IACnB,6CAAmB,CAAA;IACnB,+CAAqB,CAAA;IACrB,uCAAa,CAAA;IACb,mDAAyB,CAAA;AAC3B,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC"}
1
+ {"version":3,"file":"email-marketing-v1-campaign-campaigns.types.js","sourceRoot":"","sources":["../../../src/email-marketing-v1-campaign-campaigns.types.ts"],"names":[],"mappings":";;;AAmCA,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,6CAA6C;IAC7C,6CAAmB,CAAA;IACnB,0BAA0B;IAC1B,qCAAW,CAAA;IACX,6BAA6B;IAC7B,2CAAiB,CAAA;IACjB,kCAAkC;IAClC,uCAAa,CAAA;AACf,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAED,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,+CAA+C;IAC/C,yCAAmB,CAAA;IACnB,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,4BAA4B;IAC5B,2CAAqB,CAAA;IACrB,2BAA2B;IAC3B,yCAAmB,CAAA;AACrB,CAAC,EATW,kBAAkB,kCAAlB,kBAAkB,QAS7B;AAED,IAAY,4BASX;AATD,WAAY,4BAA4B;IACtC,6CAA6C;IAC7C,mDAAmB,CAAA;IACnB,oCAAoC;IACpC,+CAAe,CAAA;IACf,6BAA6B;IAC7B,uDAAuB,CAAA;IACvB,8BAA8B;IAC9B,qDAAqB,CAAA;AACvB,CAAC,EATW,4BAA4B,4CAA5B,4BAA4B,QASvC;AAED,IAAY,IAuBX;AAvBD,WAAY,IAAI;IACd,mCAAmC;IACnC,2BAAmB,CAAA;IACnB,oDAAoD;IACpD,mCAA2B,CAAA;IAC3B,8CAA8C;IAC9C,+BAAuB,CAAA;IACvB,sDAAsD;IACtD,qCAA6B,CAAA;IAC7B,oDAAoD;IACpD,uCAA+B,CAAA;IAC/B,8FAA8F;IAC9F,6BAAqB,CAAA;IACrB,oDAAoD;IACpD,2BAAmB,CAAA;IACnB,4BAA4B;IAC5B,6BAAqB,CAAA;IACrB,2DAA2D;IAC3D,iCAAyB,CAAA;IACzB,uDAAuD;IACvD,mCAA2B,CAAA;IAC3B,oCAAoC;IACpC,yBAAiB,CAAA;AACnB,CAAC,EAvBW,IAAI,oBAAJ,IAAI,QAuBf;AAoED,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,wDAAiC,CAAA;IACjC,wDAAiC,CAAA;IACjC,gDAAyB,CAAA;IACzB,sCAAe,CAAA;IACf,oEAA6C,CAAA;IAC7C,kEAA2C,CAAA;IAC3C,kEAA2C,CAAA;IAC3C,oFAA6D,CAAA;IAC7D,sEAA+C,CAAA;IAC/C,sFAA+D,CAAA;IAC/D,0EAAmD,CAAA;IACnD,kFAA2D,CAAA;IAC3D,kEAA2C,CAAA;AAC7C,CAAC,EAfW,mBAAmB,mCAAnB,mBAAmB,QAe9B;AAED,IAAY,wBAsBX;AAtBD,WAAY,wBAAwB;IAClC,kCAAkC;IAClC,2CAAe,CAAA;IACf,kCAAkC;IAClC,6CAAiB,CAAA;IACjB,6BAA6B;IAC7B,iDAAqB,CAAA;IACrB,6BAA6B;IAC7B,mDAAuB,CAAA;IACvB,qCAAqC;IACrC,6CAAiB,CAAA;IACjB,6BAA6B;IAC7B,mDAAuB,CAAA;IACvB,8BAA8B;IAC9B,+CAAmB,CAAA;IACnB;;;OAGG;IACH,6DAAiC,CAAA;IACjC,yBAAyB;IACzB,yCAAa,CAAA;AACf,CAAC,EAtBW,wBAAwB,wCAAxB,wBAAwB,QAsBnC;AAED,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,gCAAgC;IAChC,uDAAmC,CAAA;IACnC,qCAAqC;IACrC,6CAAyB,CAAA;IACzB,2BAA2B;IAC3B,6CAAyB,CAAA;IACzB,uBAAuB;IACvB,2CAAuB,CAAA;AACzB,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AAyCD,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,iDAAuB,CAAA;IACvB,2CAAiB,CAAA;IACjB,6CAAmB,CAAA;IACnB,6CAAmB,CAAA;IACnB,+CAAqB,CAAA;IACrB,uCAAa,CAAA;IACb,mDAAyB,CAAA;AAC3B,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAwlBD,6DAA6D;AAC7D,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,6DAA6D;IAC7D,qCAAqB,CAAA;IACrB,wEAAwE;IACxE,+BAAe,CAAA;IACf,2DAA2D;IAC3D,6BAAa,CAAA;IACb,kDAAkD;IAClD,2CAA2B,CAAA;IAC3B,wCAAwC;IACxC,6CAA6B,CAAA;AAC/B,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB;AA6eD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}