@wix/auto_sdk_email-marketing_campaigns 1.0.47 → 1.0.49

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.
@@ -214,120 +214,6 @@ declare enum CampaignTypeEnum {
214
214
  }
215
215
  /** @enumType */
216
216
  type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
217
- interface ListStatisticsRequest {
218
- /**
219
- * IDs of the campaigns to retrieve (max 100 campaigns).
220
- * @format GUID
221
- * @minSize 1
222
- * @maxSize 100
223
- */
224
- campaignIds: string[];
225
- }
226
- interface ListStatisticsResponse {
227
- /** List of statistics. */
228
- statistics?: CampaignStatisticsContainer[];
229
- }
230
- interface CampaignStatisticsContainer {
231
- /**
232
- * Campaign ID.
233
- * @format GUID
234
- */
235
- campaignId?: string;
236
- /** Landing page statistics. */
237
- landingPage?: LandingPageStatistics;
238
- /** Email campaign statistics. */
239
- email?: DistributionStatistics;
240
- }
241
- interface ListRecipientsRequest {
242
- /**
243
- * Campaign ID.
244
- * @format GUID
245
- */
246
- campaignId: string;
247
- /** Email activity to filter. */
248
- activity: RecipientsActivityEnumWithLiterals;
249
- /** Pagination options. */
250
- paging?: CursorPaging;
251
- }
252
- declare enum RecipientsActivityEnum {
253
- UNKNOWN = "UNKNOWN",
254
- DELIVERED = "DELIVERED",
255
- OPENED = "OPENED",
256
- CLICKED = "CLICKED",
257
- BOUNCED = "BOUNCED",
258
- NOT_SENT = "NOT_SENT",
259
- SENT = "SENT",
260
- NOT_OPENED = "NOT_OPENED"
261
- }
262
- /** @enumType */
263
- type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
264
- interface CursorPaging {
265
- /**
266
- * Number of items to load.
267
- * @max 1000
268
- */
269
- limit?: number | null;
270
- /**
271
- * Pointer to the next or previous page in the list of results.
272
- *
273
- * You can get the relevant cursor token
274
- * from the `pagingMetadata` object in the previous call's response.
275
- * Not relevant for the first request.
276
- * @maxLength 1000
277
- */
278
- cursor?: string | null;
279
- }
280
- interface ListRecipientsResponse {
281
- /** List of recipients. */
282
- recipients?: CampaignRecipientDetails[];
283
- /** Details on the paged set of returned results. */
284
- pagingMetadata?: PagingMetadataV2;
285
- }
286
- interface CampaignRecipientDetails {
287
- /**
288
- * Contact ID.
289
- * @format GUID
290
- */
291
- contactId?: string;
292
- /** Date and time of the last activity. */
293
- lastActivityDate?: Date | null;
294
- /**
295
- * Primary email address of the contact.
296
- * @format EMAIL
297
- */
298
- emailAddress?: string;
299
- /**
300
- * Full name of the contact (optional).
301
- * @maxLength 100
302
- */
303
- fullName?: string | null;
304
- /** Is this contact currently deleted from the site or not. */
305
- contactDeleted?: boolean;
306
- }
307
- interface PagingMetadataV2 {
308
- /** Number of items returned in the response. */
309
- count?: number | null;
310
- /** Offset that was requested. */
311
- offset?: number | null;
312
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
313
- total?: number | null;
314
- /** Flag that indicates the server failed to calculate the `total` field. */
315
- tooManyToCount?: boolean | null;
316
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
317
- cursors?: Cursors;
318
- }
319
- interface Cursors {
320
- /**
321
- * Cursor string pointing to the next page in the list of results.
322
- * @maxLength 16000
323
- */
324
- next?: string | null;
325
- /**
326
- * Cursor pointing to the previous page in the list of results.
327
- * @maxLength 16000
328
- */
329
- prev?: string | null;
330
- }
331
217
  interface GetCampaignMappingRequest {
332
218
  /**
333
219
  * rule ID in automations
@@ -570,6 +456,120 @@ interface Decimal {
570
456
  }
571
457
  interface SendTestBulkResponse {
572
458
  }
459
+ interface ListStatisticsRequest {
460
+ /**
461
+ * IDs of the campaigns to retrieve (max 100 campaigns).
462
+ * @format GUID
463
+ * @minSize 1
464
+ * @maxSize 100
465
+ */
466
+ campaignIds: string[];
467
+ }
468
+ interface ListStatisticsResponse {
469
+ /** List of statistics. */
470
+ statistics?: CampaignStatisticsContainer[];
471
+ }
472
+ interface CampaignStatisticsContainer {
473
+ /**
474
+ * Campaign ID.
475
+ * @format GUID
476
+ */
477
+ campaignId?: string;
478
+ /** Landing page statistics. */
479
+ landingPage?: LandingPageStatistics;
480
+ /** Email campaign statistics. */
481
+ email?: DistributionStatistics;
482
+ }
483
+ interface ListRecipientsRequest {
484
+ /**
485
+ * Campaign ID.
486
+ * @format GUID
487
+ */
488
+ campaignId: string;
489
+ /** Email activity to filter. */
490
+ activity: RecipientsActivityEnumWithLiterals;
491
+ /** Pagination options. */
492
+ paging?: CursorPaging;
493
+ }
494
+ declare enum RecipientsActivityEnum {
495
+ UNKNOWN = "UNKNOWN",
496
+ DELIVERED = "DELIVERED",
497
+ OPENED = "OPENED",
498
+ CLICKED = "CLICKED",
499
+ BOUNCED = "BOUNCED",
500
+ NOT_SENT = "NOT_SENT",
501
+ SENT = "SENT",
502
+ NOT_OPENED = "NOT_OPENED"
503
+ }
504
+ /** @enumType */
505
+ type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
506
+ interface CursorPaging {
507
+ /**
508
+ * Number of items to load.
509
+ * @max 1000
510
+ */
511
+ limit?: number | null;
512
+ /**
513
+ * Pointer to the next or previous page in the list of results.
514
+ *
515
+ * You can get the relevant cursor token
516
+ * from the `pagingMetadata` object in the previous call's response.
517
+ * Not relevant for the first request.
518
+ * @maxLength 1000
519
+ */
520
+ cursor?: string | null;
521
+ }
522
+ interface ListRecipientsResponse {
523
+ /** List of recipients. */
524
+ recipients?: CampaignRecipientDetails[];
525
+ /** Details on the paged set of returned results. */
526
+ pagingMetadata?: PagingMetadataV2;
527
+ }
528
+ interface CampaignRecipientDetails {
529
+ /**
530
+ * Contact ID.
531
+ * @format GUID
532
+ */
533
+ contactId?: string;
534
+ /** Date and time of the last activity. */
535
+ lastActivityDate?: Date | null;
536
+ /**
537
+ * Primary email address of the contact.
538
+ * @format EMAIL
539
+ */
540
+ emailAddress?: string;
541
+ /**
542
+ * Full name of the contact (optional).
543
+ * @maxLength 100
544
+ */
545
+ fullName?: string | null;
546
+ /** Is this contact currently deleted from the site or not. */
547
+ contactDeleted?: boolean;
548
+ }
549
+ interface PagingMetadataV2 {
550
+ /** Number of items returned in the response. */
551
+ count?: number | null;
552
+ /** Offset that was requested. */
553
+ offset?: number | null;
554
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
555
+ total?: number | null;
556
+ /** Flag that indicates the server failed to calculate the `total` field. */
557
+ tooManyToCount?: boolean | null;
558
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
559
+ cursors?: Cursors;
560
+ }
561
+ interface Cursors {
562
+ /**
563
+ * Cursor string pointing to the next page in the list of results.
564
+ * @maxLength 16000
565
+ */
566
+ next?: string | null;
567
+ /**
568
+ * Cursor pointing to the previous page in the list of results.
569
+ * @maxLength 16000
570
+ */
571
+ prev?: string | null;
572
+ }
573
573
  interface GetCampaignRequest {
574
574
  /**
575
575
  * Campaign ID.