@wix/auto_sdk_email-marketing_campaigns 1.0.34 → 1.0.36

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