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