@wix/auto_sdk_email-marketing_campaigns 1.0.71 → 1.0.73
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.d.ts +35 -35
- package/build/cjs/index.js +170 -170
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +539 -540
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +625 -608
- package/build/cjs/meta.js +134 -134
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +35 -35
- package/build/es/index.mjs +170 -170
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +539 -540
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +625 -608
- package/build/es/meta.mjs +134 -134
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +35 -35
- package/build/internal/cjs/index.js +170 -170
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +539 -540
- package/build/internal/cjs/index.typings.js +154 -154
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +625 -608
- package/build/internal/cjs/meta.js +134 -134
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +35 -35
- package/build/internal/es/index.mjs +170 -170
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +539 -540
- package/build/internal/es/index.typings.mjs +154 -154
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +625 -608
- package/build/internal/es/meta.mjs +134 -134
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -213,23 +213,361 @@ declare enum CampaignTypeEnum {
|
|
|
213
213
|
}
|
|
214
214
|
/** @enumType */
|
|
215
215
|
type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
|
|
216
|
-
interface
|
|
216
|
+
interface GetCampaignMappingRequest {
|
|
217
|
+
/**
|
|
218
|
+
* rule ID in automations
|
|
219
|
+
* @format GUID
|
|
220
|
+
*/
|
|
221
|
+
automationRuleId?: string;
|
|
222
|
+
/**
|
|
223
|
+
* template ID configured for the automation
|
|
224
|
+
* @format GUID
|
|
225
|
+
*/
|
|
226
|
+
templateId?: string;
|
|
227
|
+
}
|
|
228
|
+
interface GetCampaignMappingResponse {
|
|
229
|
+
/** @format GUID */
|
|
230
|
+
campaignId?: string;
|
|
231
|
+
}
|
|
232
|
+
interface UpsertTranslationRequest {
|
|
233
|
+
/**
|
|
234
|
+
* Campaign ID.
|
|
235
|
+
* @format GUID
|
|
236
|
+
*/
|
|
237
|
+
campaignId?: string;
|
|
238
|
+
/** Composer data. */
|
|
239
|
+
composer?: Composer;
|
|
240
|
+
/**
|
|
241
|
+
* Translation language (optional, default value "EN").
|
|
242
|
+
* @format LANGUAGE
|
|
243
|
+
*/
|
|
244
|
+
language?: string | null;
|
|
245
|
+
/**
|
|
246
|
+
* For BI event [36:1031] only (optional, default value "n/a").
|
|
247
|
+
* @format GUID
|
|
248
|
+
*/
|
|
249
|
+
automationRuleId?: string | null;
|
|
250
|
+
/** Should campaign also be published or not (default value "false"). */
|
|
251
|
+
publish?: boolean;
|
|
252
|
+
/**
|
|
253
|
+
* Campaign subject (optional).
|
|
254
|
+
* @maxLength 1000
|
|
255
|
+
*/
|
|
256
|
+
emailSubject?: string | null;
|
|
257
|
+
/**
|
|
258
|
+
* Campaign preheader (optional).
|
|
259
|
+
* @maxLength 1000
|
|
260
|
+
*/
|
|
261
|
+
emailPreheader?: string | null;
|
|
262
|
+
}
|
|
263
|
+
interface Composer {
|
|
264
|
+
/**
|
|
265
|
+
* Internal data structure for editor/viewer to render the campaign.
|
|
266
|
+
* @maxLength 10000000
|
|
267
|
+
*/
|
|
268
|
+
composerDataJson?: string;
|
|
269
|
+
/** Default values of existing placeholders. */
|
|
270
|
+
defaultValues?: DefaultValues;
|
|
271
|
+
}
|
|
272
|
+
interface DefaultValues {
|
|
273
|
+
/** @maxSize 500 */
|
|
274
|
+
map?: Record<string, string>;
|
|
275
|
+
}
|
|
276
|
+
interface UpsertTranslationResponse {
|
|
277
|
+
}
|
|
278
|
+
interface GetUsedPlaceholderKeysRequest {
|
|
279
|
+
/**
|
|
280
|
+
* Campaign ID.
|
|
281
|
+
* @format GUID
|
|
282
|
+
*/
|
|
283
|
+
campaignId?: string;
|
|
284
|
+
}
|
|
285
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
286
|
+
/**
|
|
287
|
+
* Keys of placeholders used in the automation.
|
|
288
|
+
* @maxLength 200
|
|
289
|
+
* @maxSize 300
|
|
290
|
+
*/
|
|
291
|
+
placeholderKeys?: string[];
|
|
292
|
+
}
|
|
293
|
+
interface LookupCampaignMappingRequest {
|
|
294
|
+
/**
|
|
295
|
+
* rule ID in automations
|
|
296
|
+
* @format GUID
|
|
297
|
+
*/
|
|
298
|
+
automationRuleId?: string;
|
|
299
|
+
/**
|
|
300
|
+
* template ID configured for the automation
|
|
301
|
+
* @format GUID
|
|
302
|
+
*/
|
|
303
|
+
templateId?: string;
|
|
304
|
+
}
|
|
305
|
+
interface LookupCampaignMappingResponse {
|
|
306
|
+
/** @format GUID */
|
|
307
|
+
campaignId?: string | null;
|
|
308
|
+
}
|
|
309
|
+
interface UpsertAutomationTranslatorContentRequest {
|
|
310
|
+
/**
|
|
311
|
+
* Campaign ID that the content belongs to
|
|
312
|
+
* @format GUID
|
|
313
|
+
*/
|
|
314
|
+
campaignId?: string;
|
|
315
|
+
/** Automation translator content */
|
|
316
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
317
|
+
}
|
|
318
|
+
/** Automation Translator Content */
|
|
319
|
+
interface AutomationTranslatorContent {
|
|
320
|
+
/**
|
|
321
|
+
* AutomationTranslatorContent ID
|
|
322
|
+
* @minLength 1
|
|
323
|
+
* @maxLength 256
|
|
324
|
+
* @immutable
|
|
325
|
+
*/
|
|
326
|
+
_id?: string;
|
|
327
|
+
/**
|
|
328
|
+
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
329
|
+
* @minLength 1
|
|
330
|
+
* @maxLength 800000
|
|
331
|
+
*/
|
|
332
|
+
json?: string;
|
|
333
|
+
}
|
|
334
|
+
interface UpsertAutomationTranslatorContentResponse {
|
|
335
|
+
}
|
|
336
|
+
interface GetAutomationTranslatorContentRequest {
|
|
337
|
+
/**
|
|
338
|
+
* Campaign ID
|
|
339
|
+
* @format GUID
|
|
340
|
+
*/
|
|
341
|
+
campaignId?: string;
|
|
342
|
+
}
|
|
343
|
+
interface GetAutomationTranslatorContentResponse {
|
|
344
|
+
/** Automation translator content */
|
|
345
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
346
|
+
}
|
|
347
|
+
interface SendTestBulkRequest {
|
|
348
|
+
/**
|
|
349
|
+
* Campaign ID
|
|
350
|
+
* @format GUID
|
|
351
|
+
*/
|
|
352
|
+
campaignId?: string;
|
|
353
|
+
/**
|
|
354
|
+
* Recipient email address
|
|
355
|
+
* @format EMAIL
|
|
356
|
+
*/
|
|
357
|
+
toEmailAddress?: string;
|
|
358
|
+
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
359
|
+
placeholders?: Record<string, PlaceholderContent>;
|
|
360
|
+
/**
|
|
361
|
+
* Sender from name
|
|
362
|
+
* @maxLength 100
|
|
363
|
+
*/
|
|
364
|
+
fromName?: string | null;
|
|
365
|
+
/**
|
|
366
|
+
* Reply-to email address
|
|
367
|
+
* @format EMAIL
|
|
368
|
+
*/
|
|
369
|
+
replyToEmailAddress?: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
372
|
+
* @format LANGUAGE
|
|
373
|
+
*/
|
|
374
|
+
language?: string | null;
|
|
375
|
+
}
|
|
376
|
+
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
377
|
+
text?: PlainText;
|
|
378
|
+
html?: Html;
|
|
379
|
+
money?: Money;
|
|
380
|
+
dateTime?: DateTime;
|
|
381
|
+
map?: Map;
|
|
382
|
+
array?: _Array;
|
|
383
|
+
enum?: PlaceholderContentEnum;
|
|
384
|
+
attachment?: Attachment;
|
|
385
|
+
integer?: Integer;
|
|
386
|
+
decimal?: Decimal;
|
|
387
|
+
}
|
|
388
|
+
/** @oneof */
|
|
389
|
+
interface PlaceholderContentValueOneOf {
|
|
390
|
+
text?: PlainText;
|
|
391
|
+
html?: Html;
|
|
392
|
+
money?: Money;
|
|
393
|
+
dateTime?: DateTime;
|
|
394
|
+
map?: Map;
|
|
395
|
+
array?: _Array;
|
|
396
|
+
enum?: PlaceholderContentEnum;
|
|
397
|
+
attachment?: Attachment;
|
|
398
|
+
integer?: Integer;
|
|
399
|
+
decimal?: Decimal;
|
|
400
|
+
}
|
|
401
|
+
interface PlainText {
|
|
402
|
+
text?: string;
|
|
403
|
+
}
|
|
404
|
+
interface Html {
|
|
405
|
+
html?: string;
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* Money.
|
|
409
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
410
|
+
*/
|
|
411
|
+
interface Money {
|
|
412
|
+
/**
|
|
413
|
+
* 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.
|
|
414
|
+
* @format DECIMAL_VALUE
|
|
415
|
+
*/
|
|
416
|
+
value?: string;
|
|
417
|
+
/**
|
|
418
|
+
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
419
|
+
* @format CURRENCY
|
|
420
|
+
*/
|
|
421
|
+
currency?: string;
|
|
422
|
+
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
423
|
+
formattedValue?: string | null;
|
|
424
|
+
}
|
|
425
|
+
interface DateTime {
|
|
426
|
+
timestamp?: Date | null;
|
|
427
|
+
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
428
|
+
timeZone?: string | null;
|
|
429
|
+
}
|
|
430
|
+
interface Map {
|
|
431
|
+
variables?: Record<string, PlaceholderContent>;
|
|
432
|
+
}
|
|
433
|
+
interface _Array {
|
|
434
|
+
items?: PlaceholderContent[];
|
|
435
|
+
}
|
|
436
|
+
interface PlaceholderContentEnum {
|
|
437
|
+
value?: string;
|
|
438
|
+
translation?: string;
|
|
439
|
+
}
|
|
440
|
+
interface Attachment {
|
|
441
|
+
fileName?: string;
|
|
442
|
+
downloadUrl?: string;
|
|
443
|
+
}
|
|
444
|
+
interface Integer {
|
|
445
|
+
/** min value: -2147483648, max value: 2147483647 */
|
|
446
|
+
value?: number;
|
|
447
|
+
}
|
|
448
|
+
interface Decimal {
|
|
449
|
+
/**
|
|
450
|
+
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
451
|
+
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
452
|
+
* @format DECIMAL_VALUE
|
|
453
|
+
*/
|
|
454
|
+
value?: string;
|
|
455
|
+
}
|
|
456
|
+
interface SendTestBulkResponse {
|
|
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 {
|
|
217
506
|
/**
|
|
218
|
-
*
|
|
219
|
-
* @
|
|
507
|
+
* Number of items to load.
|
|
508
|
+
* @max 1000
|
|
220
509
|
*/
|
|
221
|
-
|
|
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;
|
|
222
520
|
}
|
|
223
|
-
interface
|
|
224
|
-
/**
|
|
225
|
-
|
|
521
|
+
interface ListRecipientsResponse {
|
|
522
|
+
/** List of recipients. */
|
|
523
|
+
recipients?: CampaignRecipientDetails[];
|
|
524
|
+
/** Details on the paged set of returned results. */
|
|
525
|
+
pagingMetadata?: PagingMetadataV2;
|
|
226
526
|
}
|
|
227
|
-
interface
|
|
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;
|
|
228
547
|
}
|
|
229
|
-
interface
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
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;
|
|
233
571
|
}
|
|
234
572
|
interface GetCampaignRequest {
|
|
235
573
|
/**
|
|
@@ -532,86 +870,6 @@ interface SendTestRequest {
|
|
|
532
870
|
*/
|
|
533
871
|
toEmailAddress: string;
|
|
534
872
|
}
|
|
535
|
-
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
536
|
-
text?: PlainText;
|
|
537
|
-
html?: Html;
|
|
538
|
-
money?: Money;
|
|
539
|
-
dateTime?: DateTime;
|
|
540
|
-
map?: Map;
|
|
541
|
-
array?: _Array;
|
|
542
|
-
enum?: PlaceholderContentEnum;
|
|
543
|
-
attachment?: Attachment;
|
|
544
|
-
integer?: Integer;
|
|
545
|
-
decimal?: Decimal;
|
|
546
|
-
}
|
|
547
|
-
/** @oneof */
|
|
548
|
-
interface PlaceholderContentValueOneOf {
|
|
549
|
-
text?: PlainText;
|
|
550
|
-
html?: Html;
|
|
551
|
-
money?: Money;
|
|
552
|
-
dateTime?: DateTime;
|
|
553
|
-
map?: Map;
|
|
554
|
-
array?: _Array;
|
|
555
|
-
enum?: PlaceholderContentEnum;
|
|
556
|
-
attachment?: Attachment;
|
|
557
|
-
integer?: Integer;
|
|
558
|
-
decimal?: Decimal;
|
|
559
|
-
}
|
|
560
|
-
interface PlainText {
|
|
561
|
-
text?: string;
|
|
562
|
-
}
|
|
563
|
-
interface Html {
|
|
564
|
-
html?: string;
|
|
565
|
-
}
|
|
566
|
-
/**
|
|
567
|
-
* Money.
|
|
568
|
-
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
569
|
-
*/
|
|
570
|
-
interface Money {
|
|
571
|
-
/**
|
|
572
|
-
* 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.
|
|
573
|
-
* @format DECIMAL_VALUE
|
|
574
|
-
*/
|
|
575
|
-
value?: string;
|
|
576
|
-
/**
|
|
577
|
-
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
578
|
-
* @format CURRENCY
|
|
579
|
-
*/
|
|
580
|
-
currency?: string;
|
|
581
|
-
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
582
|
-
formattedValue?: string | null;
|
|
583
|
-
}
|
|
584
|
-
interface DateTime {
|
|
585
|
-
timestamp?: Date | null;
|
|
586
|
-
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
587
|
-
timeZone?: string | null;
|
|
588
|
-
}
|
|
589
|
-
interface Map {
|
|
590
|
-
variables?: Record<string, PlaceholderContent>;
|
|
591
|
-
}
|
|
592
|
-
interface _Array {
|
|
593
|
-
items?: PlaceholderContent[];
|
|
594
|
-
}
|
|
595
|
-
interface PlaceholderContentEnum {
|
|
596
|
-
value?: string;
|
|
597
|
-
translation?: string;
|
|
598
|
-
}
|
|
599
|
-
interface Attachment {
|
|
600
|
-
fileName?: string;
|
|
601
|
-
downloadUrl?: string;
|
|
602
|
-
}
|
|
603
|
-
interface Integer {
|
|
604
|
-
/** min value: -2147483648, max value: 2147483647 */
|
|
605
|
-
value?: number;
|
|
606
|
-
}
|
|
607
|
-
interface Decimal {
|
|
608
|
-
/**
|
|
609
|
-
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
610
|
-
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
611
|
-
* @format DECIMAL_VALUE
|
|
612
|
-
*/
|
|
613
|
-
value?: string;
|
|
614
|
-
}
|
|
615
873
|
interface SendTestResponse {
|
|
616
874
|
}
|
|
617
875
|
interface PauseSchedulingRequest {
|
|
@@ -755,19 +1013,6 @@ interface GetComposerResponse {
|
|
|
755
1013
|
*/
|
|
756
1014
|
emailPreheader?: string | null;
|
|
757
1015
|
}
|
|
758
|
-
interface Composer {
|
|
759
|
-
/**
|
|
760
|
-
* Internal data structure for editor/viewer to render the campaign.
|
|
761
|
-
* @maxLength 10000000
|
|
762
|
-
*/
|
|
763
|
-
composerDataJson?: string;
|
|
764
|
-
/** Default values of existing placeholders. */
|
|
765
|
-
defaultValues?: DefaultValues;
|
|
766
|
-
}
|
|
767
|
-
interface DefaultValues {
|
|
768
|
-
/** @maxSize 500 */
|
|
769
|
-
map?: Record<string, string>;
|
|
770
|
-
}
|
|
771
1016
|
interface UpdateComposerRequest {
|
|
772
1017
|
/**
|
|
773
1018
|
* Campaign ID.
|
|
@@ -968,205 +1213,95 @@ interface MessageEnvelope {
|
|
|
968
1213
|
data?: string;
|
|
969
1214
|
}
|
|
970
1215
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
971
|
-
/**
|
|
972
|
-
* ID of a site visitor that has not logged in to the site.
|
|
973
|
-
* @format GUID
|
|
974
|
-
*/
|
|
975
|
-
anonymousVisitorId?: string;
|
|
976
|
-
/**
|
|
977
|
-
* ID of a site visitor that has logged in to the site.
|
|
978
|
-
* @format GUID
|
|
979
|
-
*/
|
|
980
|
-
memberId?: string;
|
|
981
|
-
/**
|
|
982
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
983
|
-
* @format GUID
|
|
984
|
-
*/
|
|
985
|
-
wixUserId?: string;
|
|
986
|
-
/**
|
|
987
|
-
* ID of an app.
|
|
988
|
-
* @format GUID
|
|
989
|
-
*/
|
|
990
|
-
appId?: string;
|
|
991
|
-
/** @readonly */
|
|
992
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
993
|
-
}
|
|
994
|
-
/** @oneof */
|
|
995
|
-
interface IdentificationDataIdOneOf {
|
|
996
|
-
/**
|
|
997
|
-
* ID of a site visitor that has not logged in to the site.
|
|
998
|
-
* @format GUID
|
|
999
|
-
*/
|
|
1000
|
-
anonymousVisitorId?: string;
|
|
1001
|
-
/**
|
|
1002
|
-
* ID of a site visitor that has logged in to the site.
|
|
1003
|
-
* @format GUID
|
|
1004
|
-
*/
|
|
1005
|
-
memberId?: string;
|
|
1006
|
-
/**
|
|
1007
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1008
|
-
* @format GUID
|
|
1009
|
-
*/
|
|
1010
|
-
wixUserId?: string;
|
|
1011
|
-
/**
|
|
1012
|
-
* ID of an app.
|
|
1013
|
-
* @format GUID
|
|
1014
|
-
*/
|
|
1015
|
-
appId?: string;
|
|
1016
|
-
}
|
|
1017
|
-
declare enum WebhookIdentityType {
|
|
1018
|
-
UNKNOWN = "UNKNOWN",
|
|
1019
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1020
|
-
MEMBER = "MEMBER",
|
|
1021
|
-
WIX_USER = "WIX_USER",
|
|
1022
|
-
APP = "APP"
|
|
1023
|
-
}
|
|
1024
|
-
/** @enumType */
|
|
1025
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1026
|
-
interface EstimateFilterSizeRequest {
|
|
1027
|
-
/** Contacts filter expression. */
|
|
1028
|
-
filter?: Record<string, any> | null;
|
|
1029
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1030
|
-
activeContactsOnly?: boolean;
|
|
1031
|
-
/**
|
|
1032
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1033
|
-
* @minLength 1
|
|
1034
|
-
* @maxLength 100
|
|
1035
|
-
*/
|
|
1036
|
-
search?: string | null;
|
|
1037
|
-
}
|
|
1038
|
-
interface EstimateFilterSizeResponse {
|
|
1039
|
-
/** Mailing list size estimation. */
|
|
1040
|
-
estimation?: number;
|
|
1041
|
-
}
|
|
1042
|
-
interface EstimateAudienceSizeRequest {
|
|
1043
|
-
/**
|
|
1044
|
-
* Contact IDs of a campaign audience.
|
|
1045
|
-
* @format GUID
|
|
1046
|
-
*/
|
|
1047
|
-
contactIds?: string[];
|
|
1048
|
-
/** Label IDs of a campaign audience. */
|
|
1049
|
-
labelIds?: string[];
|
|
1050
|
-
/** Contacts filter expression (json). */
|
|
1051
|
-
contactsFilter?: Record<string, any> | null;
|
|
1052
|
-
/**
|
|
1053
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1054
|
-
* @minLength 1
|
|
1055
|
-
* @maxLength 100
|
|
1216
|
+
/**
|
|
1217
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1218
|
+
* @format GUID
|
|
1056
1219
|
*/
|
|
1057
|
-
|
|
1220
|
+
anonymousVisitorId?: string;
|
|
1058
1221
|
/**
|
|
1059
|
-
*
|
|
1222
|
+
* ID of a site visitor that has logged in to the site.
|
|
1060
1223
|
* @format GUID
|
|
1061
1224
|
*/
|
|
1062
|
-
|
|
1063
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1064
|
-
activeContactsOnly?: boolean;
|
|
1225
|
+
memberId?: string;
|
|
1065
1226
|
/**
|
|
1066
|
-
*
|
|
1227
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1067
1228
|
* @format GUID
|
|
1068
1229
|
*/
|
|
1069
|
-
|
|
1070
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1071
|
-
withTotal?: boolean;
|
|
1072
|
-
}
|
|
1073
|
-
interface EstimateAudienceSizeResponse {
|
|
1074
|
-
/** Audience size (estimated number of emails to be sent). */
|
|
1075
|
-
estimation?: number;
|
|
1076
|
-
/** Total number of contacts in provided audience (optional). */
|
|
1077
|
-
total?: number | null;
|
|
1078
|
-
}
|
|
1079
|
-
interface ReconcileContactRequest {
|
|
1230
|
+
wixUserId?: string;
|
|
1080
1231
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
* @format
|
|
1232
|
+
* ID of an app.
|
|
1233
|
+
* @format GUID
|
|
1083
1234
|
*/
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
/** Created or retrieved contact. */
|
|
1088
|
-
contact?: Contact;
|
|
1235
|
+
appId?: string;
|
|
1236
|
+
/** @readonly */
|
|
1237
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1089
1238
|
}
|
|
1090
|
-
|
|
1239
|
+
/** @oneof */
|
|
1240
|
+
interface IdentificationDataIdOneOf {
|
|
1091
1241
|
/**
|
|
1092
|
-
*
|
|
1242
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1093
1243
|
* @format GUID
|
|
1094
1244
|
*/
|
|
1095
|
-
|
|
1245
|
+
anonymousVisitorId?: string;
|
|
1096
1246
|
/**
|
|
1097
|
-
*
|
|
1098
|
-
* @format
|
|
1247
|
+
* ID of a site visitor that has logged in to the site.
|
|
1248
|
+
* @format GUID
|
|
1099
1249
|
*/
|
|
1100
|
-
|
|
1250
|
+
memberId?: string;
|
|
1101
1251
|
/**
|
|
1102
|
-
*
|
|
1103
|
-
* @
|
|
1252
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1253
|
+
* @format GUID
|
|
1104
1254
|
*/
|
|
1105
|
-
|
|
1255
|
+
wixUserId?: string;
|
|
1106
1256
|
/**
|
|
1107
|
-
*
|
|
1108
|
-
* @format
|
|
1109
|
-
* @maxLength 2048
|
|
1257
|
+
* ID of an app.
|
|
1258
|
+
* @format GUID
|
|
1110
1259
|
*/
|
|
1111
|
-
|
|
1260
|
+
appId?: string;
|
|
1112
1261
|
}
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1262
|
+
declare enum WebhookIdentityType {
|
|
1263
|
+
UNKNOWN = "UNKNOWN",
|
|
1264
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1265
|
+
MEMBER = "MEMBER",
|
|
1266
|
+
WIX_USER = "WIX_USER",
|
|
1267
|
+
APP = "APP"
|
|
1268
|
+
}
|
|
1269
|
+
/** @enumType */
|
|
1270
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1271
|
+
interface AccountDetails {
|
|
1121
1272
|
/**
|
|
1122
|
-
*
|
|
1123
|
-
* @
|
|
1273
|
+
* ID of the account.
|
|
1274
|
+
* @format GUID
|
|
1124
1275
|
*/
|
|
1125
|
-
|
|
1126
|
-
}
|
|
1127
|
-
interface SearchContactsResponse {
|
|
1128
|
-
/** Search results. */
|
|
1129
|
-
contacts?: Contact[];
|
|
1130
|
-
}
|
|
1131
|
-
interface GetLabelsRequest {
|
|
1132
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1133
|
-
activeContactsOnly?: boolean;
|
|
1134
|
-
}
|
|
1135
|
-
interface GetLabelsResponse {
|
|
1136
|
-
/** Returned labels with contact counts. */
|
|
1137
|
-
labels?: Label[];
|
|
1138
|
-
}
|
|
1139
|
-
interface Label {
|
|
1276
|
+
accountId?: string | null;
|
|
1140
1277
|
/**
|
|
1141
|
-
*
|
|
1142
|
-
* @
|
|
1278
|
+
* ID of the parent account.
|
|
1279
|
+
* @format GUID
|
|
1143
1280
|
*/
|
|
1144
|
-
|
|
1281
|
+
parentAccountId?: string | null;
|
|
1145
1282
|
/**
|
|
1146
|
-
*
|
|
1147
|
-
* @
|
|
1283
|
+
* ID of the site, if applicable.
|
|
1284
|
+
* @format GUID
|
|
1148
1285
|
*/
|
|
1149
|
-
|
|
1150
|
-
/** Amount of contacts assigned to the label. */
|
|
1151
|
-
contactsCount?: number;
|
|
1286
|
+
siteId?: string | null;
|
|
1152
1287
|
}
|
|
1153
|
-
interface
|
|
1288
|
+
interface GetPlaceholderKeysRequest {
|
|
1154
1289
|
/**
|
|
1155
|
-
* Campaign ID
|
|
1290
|
+
* Campaign ID.
|
|
1156
1291
|
* @format GUID
|
|
1157
1292
|
*/
|
|
1158
1293
|
campaignId?: string;
|
|
1159
|
-
/**
|
|
1160
|
-
* Email address that is entered into subscription field.
|
|
1161
|
-
* @format EMAIL
|
|
1162
|
-
*/
|
|
1163
|
-
emailAddress?: string;
|
|
1164
|
-
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1165
|
-
consent?: boolean;
|
|
1166
1294
|
}
|
|
1167
|
-
interface
|
|
1168
|
-
/**
|
|
1169
|
-
|
|
1295
|
+
interface GetPlaceholderKeysResponse {
|
|
1296
|
+
/** Keys of placeholders used in the campaign. */
|
|
1297
|
+
placeholderKeys?: string[];
|
|
1298
|
+
}
|
|
1299
|
+
interface GetDefaultComponentsRequest {
|
|
1300
|
+
}
|
|
1301
|
+
interface GetDefaultComponentsResponse {
|
|
1302
|
+
footer?: Record<string, any> | null;
|
|
1303
|
+
logo?: Record<string, any> | null;
|
|
1304
|
+
follow?: Record<string, any> | null;
|
|
1170
1305
|
}
|
|
1171
1306
|
interface ValidateLinkRequest {
|
|
1172
1307
|
/**
|
|
@@ -1190,268 +1325,150 @@ interface ValidateHtmlLinksResponse {
|
|
|
1190
1325
|
/** Non-valid links. */
|
|
1191
1326
|
blacklistedLinks?: string[];
|
|
1192
1327
|
}
|
|
1193
|
-
interface
|
|
1194
|
-
/**
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
automationRuleId?: string;
|
|
1199
|
-
/**
|
|
1200
|
-
* template ID configured for the automation
|
|
1201
|
-
* @format GUID
|
|
1202
|
-
*/
|
|
1203
|
-
templateId?: string;
|
|
1204
|
-
}
|
|
1205
|
-
interface GetCampaignMappingResponse {
|
|
1206
|
-
/** @format GUID */
|
|
1207
|
-
campaignId?: string;
|
|
1208
|
-
}
|
|
1209
|
-
interface UpsertTranslationRequest {
|
|
1210
|
-
/**
|
|
1211
|
-
* Campaign ID.
|
|
1212
|
-
* @format GUID
|
|
1213
|
-
*/
|
|
1214
|
-
campaignId?: string;
|
|
1215
|
-
/** Composer data. */
|
|
1216
|
-
composer?: Composer;
|
|
1217
|
-
/**
|
|
1218
|
-
* Translation language (optional, default value "EN").
|
|
1219
|
-
* @format LANGUAGE
|
|
1220
|
-
*/
|
|
1221
|
-
language?: string | null;
|
|
1222
|
-
/**
|
|
1223
|
-
* For BI event [36:1031] only (optional, default value "n/a").
|
|
1224
|
-
* @format GUID
|
|
1225
|
-
*/
|
|
1226
|
-
automationRuleId?: string | null;
|
|
1227
|
-
/** Should campaign also be published or not (default value "false"). */
|
|
1228
|
-
publish?: boolean;
|
|
1229
|
-
/**
|
|
1230
|
-
* Campaign subject (optional).
|
|
1231
|
-
* @maxLength 1000
|
|
1232
|
-
*/
|
|
1233
|
-
emailSubject?: string | null;
|
|
1328
|
+
interface EstimateFilterSizeRequest {
|
|
1329
|
+
/** Contacts filter expression. */
|
|
1330
|
+
filter?: Record<string, any> | null;
|
|
1331
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1332
|
+
activeContactsOnly?: boolean;
|
|
1234
1333
|
/**
|
|
1235
|
-
*
|
|
1236
|
-
* @
|
|
1334
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1335
|
+
* @minLength 1
|
|
1336
|
+
* @maxLength 100
|
|
1237
1337
|
*/
|
|
1238
|
-
|
|
1338
|
+
search?: string | null;
|
|
1239
1339
|
}
|
|
1240
|
-
interface
|
|
1340
|
+
interface EstimateFilterSizeResponse {
|
|
1341
|
+
/** Mailing list size estimation. */
|
|
1342
|
+
estimation?: number;
|
|
1241
1343
|
}
|
|
1242
|
-
interface
|
|
1344
|
+
interface EstimateAudienceSizeRequest {
|
|
1243
1345
|
/**
|
|
1244
|
-
*
|
|
1346
|
+
* Contact IDs of a campaign audience.
|
|
1245
1347
|
* @format GUID
|
|
1246
1348
|
*/
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
/**
|
|
1251
|
-
|
|
1252
|
-
* @maxLength 200
|
|
1253
|
-
* @maxSize 300
|
|
1254
|
-
*/
|
|
1255
|
-
placeholderKeys?: string[];
|
|
1256
|
-
}
|
|
1257
|
-
interface LookupCampaignMappingRequest {
|
|
1349
|
+
contactIds?: string[];
|
|
1350
|
+
/** Label IDs of a campaign audience. */
|
|
1351
|
+
labelIds?: string[];
|
|
1352
|
+
/** Contacts filter expression (json). */
|
|
1353
|
+
contactsFilter?: Record<string, any> | null;
|
|
1258
1354
|
/**
|
|
1259
|
-
*
|
|
1260
|
-
* @
|
|
1355
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1356
|
+
* @minLength 1
|
|
1357
|
+
* @maxLength 100
|
|
1261
1358
|
*/
|
|
1262
|
-
|
|
1359
|
+
search?: string | null;
|
|
1263
1360
|
/**
|
|
1264
|
-
*
|
|
1361
|
+
* Segment ids of a campaign audience.
|
|
1265
1362
|
* @format GUID
|
|
1266
1363
|
*/
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
/** @format GUID */
|
|
1271
|
-
campaignId?: string | null;
|
|
1272
|
-
}
|
|
1273
|
-
interface UpsertAutomationTranslatorContentRequest {
|
|
1364
|
+
segmentIds?: string[];
|
|
1365
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1366
|
+
activeContactsOnly?: boolean;
|
|
1274
1367
|
/**
|
|
1275
|
-
*
|
|
1368
|
+
* Id of a campaign that is to be resent.
|
|
1276
1369
|
* @format GUID
|
|
1277
1370
|
*/
|
|
1278
|
-
|
|
1279
|
-
/**
|
|
1280
|
-
|
|
1281
|
-
}
|
|
1282
|
-
/** Automation Translator Content */
|
|
1283
|
-
interface AutomationTranslatorContent {
|
|
1284
|
-
/**
|
|
1285
|
-
* AutomationTranslatorContent ID
|
|
1286
|
-
* @minLength 1
|
|
1287
|
-
* @maxLength 256
|
|
1288
|
-
* @immutable
|
|
1289
|
-
*/
|
|
1290
|
-
_id?: string;
|
|
1291
|
-
/**
|
|
1292
|
-
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
1293
|
-
* @minLength 1
|
|
1294
|
-
* @maxLength 800000
|
|
1295
|
-
*/
|
|
1296
|
-
json?: string;
|
|
1371
|
+
resendCampaignId?: string | null;
|
|
1372
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1373
|
+
withTotal?: boolean;
|
|
1297
1374
|
}
|
|
1298
|
-
interface
|
|
1375
|
+
interface EstimateAudienceSizeResponse {
|
|
1376
|
+
/** Audience size (estimated number of emails to be sent). */
|
|
1377
|
+
estimation?: number;
|
|
1378
|
+
/** Total number of contacts in provided audience (optional). */
|
|
1379
|
+
total?: number | null;
|
|
1299
1380
|
}
|
|
1300
|
-
interface
|
|
1381
|
+
interface ReconcileContactRequest {
|
|
1301
1382
|
/**
|
|
1302
|
-
*
|
|
1303
|
-
* @format
|
|
1383
|
+
* Email address of the contact.
|
|
1384
|
+
* @format EMAIL
|
|
1304
1385
|
*/
|
|
1305
|
-
|
|
1386
|
+
emailAddress?: string;
|
|
1306
1387
|
}
|
|
1307
|
-
interface
|
|
1308
|
-
/**
|
|
1309
|
-
|
|
1388
|
+
interface ReconcileContactResponse {
|
|
1389
|
+
/** Created or retrieved contact. */
|
|
1390
|
+
contact?: Contact;
|
|
1310
1391
|
}
|
|
1311
|
-
interface
|
|
1392
|
+
interface Contact {
|
|
1312
1393
|
/**
|
|
1313
|
-
*
|
|
1394
|
+
* Unique ID of the contact entity.
|
|
1314
1395
|
* @format GUID
|
|
1315
1396
|
*/
|
|
1316
|
-
|
|
1397
|
+
_id?: string;
|
|
1317
1398
|
/**
|
|
1318
|
-
*
|
|
1399
|
+
* Primary email address of the contact.
|
|
1319
1400
|
* @format EMAIL
|
|
1320
1401
|
*/
|
|
1321
|
-
|
|
1322
|
-
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
1323
|
-
placeholders?: Record<string, PlaceholderContent>;
|
|
1402
|
+
emailAddress?: string;
|
|
1324
1403
|
/**
|
|
1325
|
-
*
|
|
1404
|
+
* Full name of the contact (optional).
|
|
1326
1405
|
* @maxLength 100
|
|
1327
1406
|
*/
|
|
1328
|
-
|
|
1329
|
-
/**
|
|
1330
|
-
* Reply-to email address
|
|
1331
|
-
* @format EMAIL
|
|
1332
|
-
*/
|
|
1333
|
-
replyToEmailAddress?: string | null;
|
|
1407
|
+
fullName?: string | null;
|
|
1334
1408
|
/**
|
|
1335
|
-
*
|
|
1336
|
-
* @format
|
|
1409
|
+
* Profile picture of the contact (optional).
|
|
1410
|
+
* @format WEB_URL
|
|
1411
|
+
* @maxLength 2048
|
|
1337
1412
|
*/
|
|
1338
|
-
|
|
1339
|
-
}
|
|
1340
|
-
interface SendTestBulkResponse {
|
|
1413
|
+
pictureUrl?: string | null;
|
|
1341
1414
|
}
|
|
1342
|
-
interface
|
|
1415
|
+
interface SearchContactsRequest {
|
|
1343
1416
|
/**
|
|
1344
|
-
*
|
|
1345
|
-
* @
|
|
1346
|
-
* @minSize 1
|
|
1347
|
-
* @maxSize 100
|
|
1417
|
+
* Text to search contacts by - can search by name or email address.
|
|
1418
|
+
* @maxLength 100
|
|
1348
1419
|
*/
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
/** List of statistics. */
|
|
1353
|
-
statistics?: CampaignStatisticsContainer[];
|
|
1354
|
-
}
|
|
1355
|
-
interface CampaignStatisticsContainer {
|
|
1420
|
+
searchTerm?: string;
|
|
1421
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1422
|
+
activeContactsOnly?: boolean;
|
|
1356
1423
|
/**
|
|
1357
|
-
*
|
|
1358
|
-
* @
|
|
1424
|
+
* Page size (default 50, max 1000).
|
|
1425
|
+
* @max 1000
|
|
1359
1426
|
*/
|
|
1360
|
-
|
|
1361
|
-
/** Landing page statistics. */
|
|
1362
|
-
landingPage?: LandingPageStatistics;
|
|
1363
|
-
/** Email campaign statistics. */
|
|
1364
|
-
email?: DistributionStatistics;
|
|
1427
|
+
pageSize?: number | null;
|
|
1365
1428
|
}
|
|
1366
|
-
interface
|
|
1367
|
-
/**
|
|
1368
|
-
|
|
1369
|
-
* @format GUID
|
|
1370
|
-
*/
|
|
1371
|
-
campaignId: string;
|
|
1372
|
-
/** Email activity to filter. */
|
|
1373
|
-
activity: RecipientsActivityEnumWithLiterals;
|
|
1374
|
-
/** Pagination options. */
|
|
1375
|
-
paging?: CursorPaging;
|
|
1429
|
+
interface SearchContactsResponse {
|
|
1430
|
+
/** Search results. */
|
|
1431
|
+
contacts?: Contact[];
|
|
1376
1432
|
}
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
OPENED = "OPENED",
|
|
1381
|
-
CLICKED = "CLICKED",
|
|
1382
|
-
BOUNCED = "BOUNCED",
|
|
1383
|
-
NOT_SENT = "NOT_SENT",
|
|
1384
|
-
SENT = "SENT",
|
|
1385
|
-
NOT_OPENED = "NOT_OPENED"
|
|
1433
|
+
interface GetLabelsRequest {
|
|
1434
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1435
|
+
activeContactsOnly?: boolean;
|
|
1386
1436
|
}
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1437
|
+
interface GetLabelsResponse {
|
|
1438
|
+
/** Returned labels with contact counts. */
|
|
1439
|
+
labels?: Label[];
|
|
1440
|
+
}
|
|
1441
|
+
interface Label {
|
|
1390
1442
|
/**
|
|
1391
|
-
*
|
|
1392
|
-
* @
|
|
1443
|
+
* Unique ID of the label entity.
|
|
1444
|
+
* @maxLength 100
|
|
1393
1445
|
*/
|
|
1394
|
-
|
|
1446
|
+
_id?: string;
|
|
1395
1447
|
/**
|
|
1396
|
-
*
|
|
1397
|
-
*
|
|
1398
|
-
* You can get the relevant cursor token
|
|
1399
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1400
|
-
* Not relevant for the first request.
|
|
1401
|
-
* @maxLength 1000
|
|
1448
|
+
* Name of the label.
|
|
1449
|
+
* @maxLength 100
|
|
1402
1450
|
*/
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
/** List of recipients. */
|
|
1407
|
-
recipients?: CampaignRecipientDetails[];
|
|
1408
|
-
/** Details on the paged set of returned results. */
|
|
1409
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1451
|
+
name?: string;
|
|
1452
|
+
/** Amount of contacts assigned to the label. */
|
|
1453
|
+
contactsCount?: number;
|
|
1410
1454
|
}
|
|
1411
|
-
interface
|
|
1455
|
+
interface SubscribeFromLandingPageRequest {
|
|
1412
1456
|
/**
|
|
1413
|
-
*
|
|
1457
|
+
* Campaign ID that the subscription is happening from.
|
|
1414
1458
|
* @format GUID
|
|
1415
1459
|
*/
|
|
1416
|
-
|
|
1417
|
-
/** Date and time of the last activity. */
|
|
1418
|
-
lastActivityDate?: Date | null;
|
|
1460
|
+
campaignId?: string;
|
|
1419
1461
|
/**
|
|
1420
|
-
*
|
|
1462
|
+
* Email address that is entered into subscription field.
|
|
1421
1463
|
* @format EMAIL
|
|
1422
1464
|
*/
|
|
1423
1465
|
emailAddress?: string;
|
|
1424
|
-
/**
|
|
1425
|
-
|
|
1426
|
-
* @maxLength 100
|
|
1427
|
-
*/
|
|
1428
|
-
fullName?: string | null;
|
|
1429
|
-
/** Is this contact currently deleted from the site or not. */
|
|
1430
|
-
contactDeleted?: boolean;
|
|
1431
|
-
}
|
|
1432
|
-
interface PagingMetadataV2 {
|
|
1433
|
-
/** Number of items returned in the response. */
|
|
1434
|
-
count?: number | null;
|
|
1435
|
-
/** Offset that was requested. */
|
|
1436
|
-
offset?: number | null;
|
|
1437
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1438
|
-
total?: number | null;
|
|
1439
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1440
|
-
tooManyToCount?: boolean | null;
|
|
1441
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1442
|
-
cursors?: Cursors;
|
|
1466
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1467
|
+
consent?: boolean;
|
|
1443
1468
|
}
|
|
1444
|
-
interface
|
|
1445
|
-
/**
|
|
1446
|
-
|
|
1447
|
-
* @maxLength 16000
|
|
1448
|
-
*/
|
|
1449
|
-
next?: string | null;
|
|
1450
|
-
/**
|
|
1451
|
-
* Cursor pointing to the previous page in the list of results.
|
|
1452
|
-
* @maxLength 16000
|
|
1453
|
-
*/
|
|
1454
|
-
prev?: string | null;
|
|
1469
|
+
interface SubscribeFromLandingPageResponse {
|
|
1470
|
+
/** @format GUID */
|
|
1471
|
+
contactId?: string;
|
|
1455
1472
|
}
|
|
1456
1473
|
/** @docsIgnore */
|
|
1457
1474
|
type PublishCampaignApplicationErrors = {
|
|
@@ -1521,8 +1538,6 @@ interface CampaignDistributedEnvelope {
|
|
|
1521
1538
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1522
1539
|
* @permissionScope Access Verticals by Automations
|
|
1523
1540
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1524
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1525
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1526
1541
|
* @permissionScope Set Up Automations
|
|
1527
1542
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1528
1543
|
* @permissionScope Read Email Marketing
|
|
@@ -1546,8 +1561,6 @@ interface CampaignPausedEnvelope {
|
|
|
1546
1561
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1547
1562
|
* @permissionScope Access Verticals by Automations
|
|
1548
1563
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1549
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1550
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1551
1564
|
* @permissionScope Set Up Automations
|
|
1552
1565
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1553
1566
|
* @permissionScope Read Email Marketing
|
|
@@ -1571,8 +1584,6 @@ interface CampaignPublishedEnvelope {
|
|
|
1571
1584
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1572
1585
|
* @permissionScope Access Verticals by Automations
|
|
1573
1586
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1574
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1575
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1576
1587
|
* @permissionScope Set Up Automations
|
|
1577
1588
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1578
1589
|
* @permissionScope Read Email Marketing
|
|
@@ -1596,8 +1607,6 @@ interface CampaignRejectedEnvelope {
|
|
|
1596
1607
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1597
1608
|
* @permissionScope Access Verticals by Automations
|
|
1598
1609
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1599
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1600
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1601
1610
|
* @permissionScope Set Up Automations
|
|
1602
1611
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1603
1612
|
* @permissionScope Read Email Marketing
|
|
@@ -1621,8 +1630,6 @@ interface CampaignScheduledEnvelope {
|
|
|
1621
1630
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1622
1631
|
* @permissionScope Access Verticals by Automations
|
|
1623
1632
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1624
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1625
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1626
1633
|
* @permissionScope Set Up Automations
|
|
1627
1634
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1628
1635
|
* @permissionScope Read Email Marketing
|
|
@@ -1646,8 +1653,6 @@ interface CampaignTerminatedEnvelope {
|
|
|
1646
1653
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1647
1654
|
* @permissionScope Access Verticals by Automations
|
|
1648
1655
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1649
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1650
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1651
1656
|
* @permissionScope Set Up Automations
|
|
1652
1657
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1653
1658
|
* @permissionScope Read Email Marketing
|
|
@@ -1671,8 +1676,6 @@ interface CampaignCreatedEnvelope {
|
|
|
1671
1676
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1672
1677
|
* @permissionScope Access Verticals by Automations
|
|
1673
1678
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1674
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1675
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1676
1679
|
* @permissionScope Set Up Automations
|
|
1677
1680
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1678
1681
|
* @permissionScope Read Email Marketing
|
|
@@ -1695,8 +1698,6 @@ interface CampaignDeletedEnvelope {
|
|
|
1695
1698
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1696
1699
|
* @permissionScope Access Verticals by Automations
|
|
1697
1700
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1698
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1699
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1700
1701
|
* @permissionScope Set Up Automations
|
|
1701
1702
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1702
1703
|
* @permissionScope Read Email Marketing
|
|
@@ -1720,8 +1721,6 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1720
1721
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1721
1722
|
* @permissionScope Access Verticals by Automations
|
|
1722
1723
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1723
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1724
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1725
1724
|
* @permissionScope Set Up Automations
|
|
1726
1725
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1727
1726
|
* @permissionScope Read Email Marketing
|
|
@@ -1735,6 +1734,46 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1735
1734
|
* @slug email_activity_updated
|
|
1736
1735
|
*/
|
|
1737
1736
|
declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
|
|
1737
|
+
/**
|
|
1738
|
+
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1739
|
+
*
|
|
1740
|
+
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1741
|
+
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1742
|
+
*
|
|
1743
|
+
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1744
|
+
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1745
|
+
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1746
|
+
* @public
|
|
1747
|
+
* @requiredField campaignIds
|
|
1748
|
+
* @permissionId Shoutout.Read
|
|
1749
|
+
* @applicableIdentity APP
|
|
1750
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1751
|
+
*/
|
|
1752
|
+
declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
|
|
1753
|
+
/**
|
|
1754
|
+
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1755
|
+
*
|
|
1756
|
+
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1757
|
+
*
|
|
1758
|
+
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1759
|
+
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1760
|
+
*
|
|
1761
|
+
* If no `activity` is included, this method returns an error.
|
|
1762
|
+
* @param campaignId - Campaign ID.
|
|
1763
|
+
* @param activity - Email activity to filter.
|
|
1764
|
+
* @public
|
|
1765
|
+
* @requiredField activity
|
|
1766
|
+
* @requiredField campaignId
|
|
1767
|
+
* @param options - Options to use when getting the list of recipients.
|
|
1768
|
+
* @permissionId Shoutout.Read
|
|
1769
|
+
* @applicableIdentity APP
|
|
1770
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1771
|
+
*/
|
|
1772
|
+
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1773
|
+
interface ListRecipientsOptions {
|
|
1774
|
+
/** Pagination options. */
|
|
1775
|
+
paging?: CursorPaging;
|
|
1776
|
+
}
|
|
1738
1777
|
/**
|
|
1739
1778
|
* Retrieves information about an email campaign.
|
|
1740
1779
|
* @param campaignId - Campaign ID.
|
|
@@ -1909,45 +1948,5 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
|
|
|
1909
1948
|
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
|
|
1910
1949
|
*/
|
|
1911
1950
|
declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
|
|
1912
|
-
/**
|
|
1913
|
-
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1914
|
-
*
|
|
1915
|
-
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1916
|
-
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1917
|
-
*
|
|
1918
|
-
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1919
|
-
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1920
|
-
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1921
|
-
* @public
|
|
1922
|
-
* @requiredField campaignIds
|
|
1923
|
-
* @permissionId Shoutout.Read
|
|
1924
|
-
* @applicableIdentity APP
|
|
1925
|
-
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1926
|
-
*/
|
|
1927
|
-
declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
|
|
1928
|
-
/**
|
|
1929
|
-
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1930
|
-
*
|
|
1931
|
-
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1932
|
-
*
|
|
1933
|
-
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1934
|
-
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1935
|
-
*
|
|
1936
|
-
* If no `activity` is included, this method returns an error.
|
|
1937
|
-
* @param campaignId - Campaign ID.
|
|
1938
|
-
* @param activity - Email activity to filter.
|
|
1939
|
-
* @public
|
|
1940
|
-
* @requiredField activity
|
|
1941
|
-
* @requiredField campaignId
|
|
1942
|
-
* @param options - Options to use when getting the list of recipients.
|
|
1943
|
-
* @permissionId Shoutout.Read
|
|
1944
|
-
* @applicableIdentity APP
|
|
1945
|
-
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1946
|
-
*/
|
|
1947
|
-
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1948
|
-
interface ListRecipientsOptions {
|
|
1949
|
-
/** Pagination options. */
|
|
1950
|
-
paging?: CursorPaging;
|
|
1951
|
-
}
|
|
1952
1951
|
|
|
1953
|
-
export { type ActionEvent, ActivityType, type ActivityTypeWithLiterals, type ArchiveCampaignRequest, type ArchiveCampaignResponse, type Archived, type Attachment, type AutomationTranslatorContent, type BaseEventMetadata, type Campaign, type CampaignAudience, type CampaignCreatedEnvelope, type CampaignDeletedEnvelope, type CampaignDistributedEnvelope, type CampaignEditorType, CampaignEditorTypeEnum, type CampaignEditorTypeEnumWithLiterals, type CampaignEmailActivityUpdatedEnvelope, type CampaignPausedEnvelope, type CampaignPublishedEnvelope, type CampaignRecipientDetails, type CampaignRejectedEnvelope, type CampaignScheduledEnvelope, CampaignSendingStateEnum, type CampaignSendingStateEnumWithLiterals, type CampaignStatistics, type CampaignStatisticsContainer, CampaignStatusEnum, type CampaignStatusEnumWithLiterals, type CampaignTerminatedEnvelope, CampaignTypeEnum, type CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, type CampaignVisibilityStatusEnumWithLiterals, type Click, type Composer, type Contact, type CountCampaignsRequest, type CountCampaignsResponse, type CreateCampaignRequest, type CreateCampaignResponse, type CreateFromTemplateRequest, type CreateFromTemplateResponse, type CreateFromUserTemplateRequest, type CreateFromUserTemplateResponse, type CreateUserTemplateRequest, type CreateUserTemplateResponse, type CursorPaging, type Cursors, type DateTime, type Decimal, type DefaultValues, type DeleteCampaignRequest, type DeleteCampaignResponse, type Distributed, type DistributionStatistics, type DomainEvent, type DomainEventBodyOneOf, type EmailActivityUpdated, type EmailActivityUpdatedEventTypeOneOf, type EmailDistributionOptions, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EstimateAudienceSizeRequest, type EstimateAudienceSizeResponse, type EstimateFilterSizeRequest, type EstimateFilterSizeResponse, type EventMetadata, type GetAudienceRequest, type GetAudienceResponse, type GetAutomationTranslatorContentRequest, type GetAutomationTranslatorContentResponse, type GetCampaignMappingRequest, type GetCampaignMappingResponse, type GetCampaignOptions, type GetCampaignRequest, type GetCampaignResponse, type GetComposerRequest, type GetComposerResponse, type GetDefaultComponentsRequest, type GetDefaultComponentsResponse, type GetLabelsRequest, type GetLabelsResponse, type GetPlaceholderKeysRequest, type GetPlaceholderKeysResponse, type GetUsedPlaceholderKeysRequest, type GetUsedPlaceholderKeysResponse, type HardBounce, type Html, type IdentificationData, type IdentificationDataIdOneOf, type IdentifySenderAddressRequest, type IdentifySenderAddressResponse, type Integer, type Label, type LandingPageStatistics, type ListCampaignsOptions, type ListCampaignsRequest, type ListCampaignsResponse, type ListRecipientsOptions, type ListRecipientsRequest, type ListRecipientsResponse, type ListStatisticsRequest, type ListStatisticsResponse, type LookupCampaignMappingRequest, type LookupCampaignMappingResponse, type Map, type MessageEnvelope, type Money, type Open, type Paging, type PagingMetadataV2, type PauseSchedulingRequest, type PauseSchedulingResponse, type Paused, type PlaceholderContent, type PlaceholderContentEnum, type PlaceholderContentValueOneOf, type PlainText, type PreviewCampaignRequest, type PreviewCampaignResponse, type PublishCampaignApplicationErrors, type PublishCampaignOptions, type PublishCampaignRequest, type PublishCampaignResponse, type Published, type PublishingData, RecipientsActivityEnum, type RecipientsActivityEnumWithLiterals, type ReconcileContactRequest, type ReconcileContactResponse, type Rejected, type RejectionData, RejectionReasonEnum, type RejectionReasonEnumWithLiterals, type RescheduleRequest, type RescheduleResponse, type ResendToNonOpenersRequest, type ResendToNonOpenersResponse, type RestoreInfo, type ReuseCampaignRequest, type ReuseCampaignResponse, type Scheduled, type SearchContactsRequest, type SearchContactsResponse, type SendTestBulkRequest, type SendTestBulkResponse, type SendTestOptions, type SendTestRequest, type SendTestResponse, type SoftBounce, type SubscribeFromLandingPageRequest, type SubscribeFromLandingPageResponse, type Terminated, type TotalStatistics, type UnarchiveCampaignRequest, type UnarchiveCampaignResponse, type Unarchived, type UpdateComposerRequest, type UpdateComposerResponse, type UpdateTitleRequest, type UpdateTitleResponse, type UpsertAutomationTranslatorContentRequest, type UpsertAutomationTranslatorContentResponse, type UpsertTranslationRequest, type UpsertTranslationResponse, type ValidateHtmlLinksRequest, type ValidateHtmlLinksResponse, type ValidateLinkRequest, type ValidateLinkResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };
|
|
1952
|
+
export { type AccountDetails, type ActionEvent, ActivityType, type ActivityTypeWithLiterals, type ArchiveCampaignRequest, type ArchiveCampaignResponse, type Archived, type Attachment, type AutomationTranslatorContent, type BaseEventMetadata, type Campaign, type CampaignAudience, type CampaignCreatedEnvelope, type CampaignDeletedEnvelope, type CampaignDistributedEnvelope, type CampaignEditorType, CampaignEditorTypeEnum, type CampaignEditorTypeEnumWithLiterals, type CampaignEmailActivityUpdatedEnvelope, type CampaignPausedEnvelope, type CampaignPublishedEnvelope, type CampaignRecipientDetails, type CampaignRejectedEnvelope, type CampaignScheduledEnvelope, CampaignSendingStateEnum, type CampaignSendingStateEnumWithLiterals, type CampaignStatistics, type CampaignStatisticsContainer, CampaignStatusEnum, type CampaignStatusEnumWithLiterals, type CampaignTerminatedEnvelope, CampaignTypeEnum, type CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, type CampaignVisibilityStatusEnumWithLiterals, type Click, type Composer, type Contact, type CountCampaignsRequest, type CountCampaignsResponse, type CreateCampaignRequest, type CreateCampaignResponse, type CreateFromTemplateRequest, type CreateFromTemplateResponse, type CreateFromUserTemplateRequest, type CreateFromUserTemplateResponse, type CreateUserTemplateRequest, type CreateUserTemplateResponse, type CursorPaging, type Cursors, type DateTime, type Decimal, type DefaultValues, type DeleteCampaignRequest, type DeleteCampaignResponse, type Distributed, type DistributionStatistics, type DomainEvent, type DomainEventBodyOneOf, type EmailActivityUpdated, type EmailActivityUpdatedEventTypeOneOf, type EmailDistributionOptions, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EstimateAudienceSizeRequest, type EstimateAudienceSizeResponse, type EstimateFilterSizeRequest, type EstimateFilterSizeResponse, type EventMetadata, type GetAudienceRequest, type GetAudienceResponse, type GetAutomationTranslatorContentRequest, type GetAutomationTranslatorContentResponse, type GetCampaignMappingRequest, type GetCampaignMappingResponse, type GetCampaignOptions, type GetCampaignRequest, type GetCampaignResponse, type GetComposerRequest, type GetComposerResponse, type GetDefaultComponentsRequest, type GetDefaultComponentsResponse, type GetLabelsRequest, type GetLabelsResponse, type GetPlaceholderKeysRequest, type GetPlaceholderKeysResponse, type GetUsedPlaceholderKeysRequest, type GetUsedPlaceholderKeysResponse, type HardBounce, type Html, type IdentificationData, type IdentificationDataIdOneOf, type IdentifySenderAddressRequest, type IdentifySenderAddressResponse, type Integer, type Label, type LandingPageStatistics, type ListCampaignsOptions, type ListCampaignsRequest, type ListCampaignsResponse, type ListRecipientsOptions, type ListRecipientsRequest, type ListRecipientsResponse, type ListStatisticsRequest, type ListStatisticsResponse, type LookupCampaignMappingRequest, type LookupCampaignMappingResponse, type Map, type MessageEnvelope, type Money, type Open, type Paging, type PagingMetadataV2, type PauseSchedulingRequest, type PauseSchedulingResponse, type Paused, type PlaceholderContent, type PlaceholderContentEnum, type PlaceholderContentValueOneOf, type PlainText, type PreviewCampaignRequest, type PreviewCampaignResponse, type PublishCampaignApplicationErrors, type PublishCampaignOptions, type PublishCampaignRequest, type PublishCampaignResponse, type Published, type PublishingData, RecipientsActivityEnum, type RecipientsActivityEnumWithLiterals, type ReconcileContactRequest, type ReconcileContactResponse, type Rejected, type RejectionData, RejectionReasonEnum, type RejectionReasonEnumWithLiterals, type RescheduleRequest, type RescheduleResponse, type ResendToNonOpenersRequest, type ResendToNonOpenersResponse, type RestoreInfo, type ReuseCampaignRequest, type ReuseCampaignResponse, type Scheduled, type SearchContactsRequest, type SearchContactsResponse, type SendTestBulkRequest, type SendTestBulkResponse, type SendTestOptions, type SendTestRequest, type SendTestResponse, type SoftBounce, type SubscribeFromLandingPageRequest, type SubscribeFromLandingPageResponse, type Terminated, type TotalStatistics, type UnarchiveCampaignRequest, type UnarchiveCampaignResponse, type Unarchived, type UpdateComposerRequest, type UpdateComposerResponse, type UpdateTitleRequest, type UpdateTitleResponse, type UpsertAutomationTranslatorContentRequest, type UpsertAutomationTranslatorContentResponse, type UpsertTranslationRequest, type UpsertTranslationResponse, type ValidateHtmlLinksRequest, type ValidateHtmlLinksResponse, type ValidateLinkRequest, type ValidateLinkResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };
|