@wix/auto_sdk_email-marketing_campaigns 1.0.79 → 1.0.81
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 +534 -534
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +479 -479
- 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 +534 -534
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +479 -479
- 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 +534 -534
- 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 +479 -479
- 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 +534 -534
- 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 +479 -479
- 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 {
|
|
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 {
|
|
217
528
|
/**
|
|
218
|
-
*
|
|
529
|
+
* Contact ID.
|
|
219
530
|
* @format GUID
|
|
220
531
|
*/
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
/**
|
|
225
|
-
|
|
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;
|
|
226
547
|
}
|
|
227
|
-
interface
|
|
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;
|
|
228
559
|
}
|
|
229
|
-
interface
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
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.
|
|
@@ -979,213 +1224,86 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
979
1224
|
* ID of a site visitor that has logged in to the site.
|
|
980
1225
|
* @format GUID
|
|
981
1226
|
*/
|
|
982
|
-
memberId?: string;
|
|
983
|
-
/**
|
|
984
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
985
|
-
* @format GUID
|
|
986
|
-
*/
|
|
987
|
-
wixUserId?: string;
|
|
988
|
-
/**
|
|
989
|
-
* ID of an app.
|
|
990
|
-
* @format GUID
|
|
991
|
-
*/
|
|
992
|
-
appId?: string;
|
|
993
|
-
/** @readonly */
|
|
994
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
995
|
-
}
|
|
996
|
-
/** @oneof */
|
|
997
|
-
interface IdentificationDataIdOneOf {
|
|
998
|
-
/**
|
|
999
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1000
|
-
* @format GUID
|
|
1001
|
-
*/
|
|
1002
|
-
anonymousVisitorId?: string;
|
|
1003
|
-
/**
|
|
1004
|
-
* ID of a site visitor that has logged in to the site.
|
|
1005
|
-
* @format GUID
|
|
1006
|
-
*/
|
|
1007
|
-
memberId?: string;
|
|
1008
|
-
/**
|
|
1009
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1010
|
-
* @format GUID
|
|
1011
|
-
*/
|
|
1012
|
-
wixUserId?: string;
|
|
1013
|
-
/**
|
|
1014
|
-
* ID of an app.
|
|
1015
|
-
* @format GUID
|
|
1016
|
-
*/
|
|
1017
|
-
appId?: string;
|
|
1018
|
-
}
|
|
1019
|
-
declare enum WebhookIdentityType {
|
|
1020
|
-
UNKNOWN = "UNKNOWN",
|
|
1021
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1022
|
-
MEMBER = "MEMBER",
|
|
1023
|
-
WIX_USER = "WIX_USER",
|
|
1024
|
-
APP = "APP"
|
|
1025
|
-
}
|
|
1026
|
-
/** @enumType */
|
|
1027
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1028
|
-
interface AccountInfo {
|
|
1029
|
-
/**
|
|
1030
|
-
* ID of the Wix account associated with the event.
|
|
1031
|
-
* @format GUID
|
|
1032
|
-
*/
|
|
1033
|
-
accountId?: string | null;
|
|
1034
|
-
/**
|
|
1035
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1036
|
-
* @format GUID
|
|
1037
|
-
*/
|
|
1038
|
-
parentAccountId?: string | null;
|
|
1039
|
-
/**
|
|
1040
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1041
|
-
* @format GUID
|
|
1042
|
-
*/
|
|
1043
|
-
siteId?: string | null;
|
|
1044
|
-
}
|
|
1045
|
-
interface EstimateFilterSizeRequest {
|
|
1046
|
-
/** Contacts filter expression. */
|
|
1047
|
-
filter?: Record<string, any> | null;
|
|
1048
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1049
|
-
activeContactsOnly?: boolean;
|
|
1050
|
-
/**
|
|
1051
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1052
|
-
* @minLength 1
|
|
1053
|
-
* @maxLength 100
|
|
1054
|
-
*/
|
|
1055
|
-
search?: string | null;
|
|
1056
|
-
}
|
|
1057
|
-
interface EstimateFilterSizeResponse {
|
|
1058
|
-
/** Mailing list size estimation. */
|
|
1059
|
-
estimation?: number;
|
|
1060
|
-
}
|
|
1061
|
-
interface EstimateAudienceSizeRequest {
|
|
1062
|
-
/**
|
|
1063
|
-
* Contact IDs of a campaign audience.
|
|
1064
|
-
* @format GUID
|
|
1065
|
-
*/
|
|
1066
|
-
contactIds?: string[];
|
|
1067
|
-
/** Label IDs of a campaign audience. */
|
|
1068
|
-
labelIds?: string[];
|
|
1069
|
-
/** Contacts filter expression (json). */
|
|
1070
|
-
contactsFilter?: Record<string, any> | null;
|
|
1071
|
-
/**
|
|
1072
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1073
|
-
* @minLength 1
|
|
1074
|
-
* @maxLength 100
|
|
1075
|
-
*/
|
|
1076
|
-
search?: string | null;
|
|
1077
|
-
/**
|
|
1078
|
-
* Segment ids of a campaign audience.
|
|
1079
|
-
* @format GUID
|
|
1080
|
-
*/
|
|
1081
|
-
segmentIds?: string[];
|
|
1082
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1083
|
-
activeContactsOnly?: boolean;
|
|
1227
|
+
memberId?: string;
|
|
1084
1228
|
/**
|
|
1085
|
-
*
|
|
1229
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1086
1230
|
* @format GUID
|
|
1087
1231
|
*/
|
|
1088
|
-
|
|
1089
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1090
|
-
withTotal?: boolean;
|
|
1091
|
-
}
|
|
1092
|
-
interface EstimateAudienceSizeResponse {
|
|
1093
|
-
/** Audience size (estimated number of emails to be sent). */
|
|
1094
|
-
estimation?: number;
|
|
1095
|
-
/** Total number of contacts in provided audience (optional). */
|
|
1096
|
-
total?: number | null;
|
|
1097
|
-
}
|
|
1098
|
-
interface ReconcileContactRequest {
|
|
1232
|
+
wixUserId?: string;
|
|
1099
1233
|
/**
|
|
1100
|
-
*
|
|
1101
|
-
* @format
|
|
1234
|
+
* ID of an app.
|
|
1235
|
+
* @format GUID
|
|
1102
1236
|
*/
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
/** Created or retrieved contact. */
|
|
1107
|
-
contact?: Contact;
|
|
1237
|
+
appId?: string;
|
|
1238
|
+
/** @readonly */
|
|
1239
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1108
1240
|
}
|
|
1109
|
-
|
|
1241
|
+
/** @oneof */
|
|
1242
|
+
interface IdentificationDataIdOneOf {
|
|
1110
1243
|
/**
|
|
1111
|
-
*
|
|
1244
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1112
1245
|
* @format GUID
|
|
1113
1246
|
*/
|
|
1114
|
-
|
|
1247
|
+
anonymousVisitorId?: string;
|
|
1115
1248
|
/**
|
|
1116
|
-
*
|
|
1117
|
-
* @format
|
|
1249
|
+
* ID of a site visitor that has logged in to the site.
|
|
1250
|
+
* @format GUID
|
|
1118
1251
|
*/
|
|
1119
|
-
|
|
1252
|
+
memberId?: string;
|
|
1120
1253
|
/**
|
|
1121
|
-
*
|
|
1122
|
-
* @
|
|
1254
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1255
|
+
* @format GUID
|
|
1123
1256
|
*/
|
|
1124
|
-
|
|
1257
|
+
wixUserId?: string;
|
|
1125
1258
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
* @format
|
|
1128
|
-
* @maxLength 2048
|
|
1259
|
+
* ID of an app.
|
|
1260
|
+
* @format GUID
|
|
1129
1261
|
*/
|
|
1130
|
-
|
|
1262
|
+
appId?: string;
|
|
1131
1263
|
}
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1264
|
+
declare enum WebhookIdentityType {
|
|
1265
|
+
UNKNOWN = "UNKNOWN",
|
|
1266
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1267
|
+
MEMBER = "MEMBER",
|
|
1268
|
+
WIX_USER = "WIX_USER",
|
|
1269
|
+
APP = "APP"
|
|
1270
|
+
}
|
|
1271
|
+
/** @enumType */
|
|
1272
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1273
|
+
interface AccountInfo {
|
|
1140
1274
|
/**
|
|
1141
|
-
*
|
|
1142
|
-
* @
|
|
1275
|
+
* ID of the Wix account associated with the event.
|
|
1276
|
+
* @format GUID
|
|
1143
1277
|
*/
|
|
1144
|
-
|
|
1145
|
-
}
|
|
1146
|
-
interface SearchContactsResponse {
|
|
1147
|
-
/** Search results. */
|
|
1148
|
-
contacts?: Contact[];
|
|
1149
|
-
}
|
|
1150
|
-
interface GetLabelsRequest {
|
|
1151
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1152
|
-
activeContactsOnly?: boolean;
|
|
1153
|
-
}
|
|
1154
|
-
interface GetLabelsResponse {
|
|
1155
|
-
/** Returned labels with contact counts. */
|
|
1156
|
-
labels?: Label[];
|
|
1157
|
-
}
|
|
1158
|
-
interface Label {
|
|
1278
|
+
accountId?: string | null;
|
|
1159
1279
|
/**
|
|
1160
|
-
*
|
|
1161
|
-
* @
|
|
1280
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1281
|
+
* @format GUID
|
|
1162
1282
|
*/
|
|
1163
|
-
|
|
1283
|
+
parentAccountId?: string | null;
|
|
1164
1284
|
/**
|
|
1165
|
-
*
|
|
1166
|
-
* @
|
|
1285
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1286
|
+
* @format GUID
|
|
1167
1287
|
*/
|
|
1168
|
-
|
|
1169
|
-
/** Amount of contacts assigned to the label. */
|
|
1170
|
-
contactsCount?: number;
|
|
1288
|
+
siteId?: string | null;
|
|
1171
1289
|
}
|
|
1172
|
-
interface
|
|
1290
|
+
interface GetPlaceholderKeysRequest {
|
|
1173
1291
|
/**
|
|
1174
|
-
* Campaign ID
|
|
1292
|
+
* Campaign ID.
|
|
1175
1293
|
* @format GUID
|
|
1176
1294
|
*/
|
|
1177
1295
|
campaignId?: string;
|
|
1178
|
-
/**
|
|
1179
|
-
* Email address that is entered into subscription field.
|
|
1180
|
-
* @format EMAIL
|
|
1181
|
-
*/
|
|
1182
|
-
emailAddress?: string;
|
|
1183
|
-
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1184
|
-
consent?: boolean;
|
|
1185
1296
|
}
|
|
1186
|
-
interface
|
|
1187
|
-
/**
|
|
1188
|
-
|
|
1297
|
+
interface GetPlaceholderKeysResponse {
|
|
1298
|
+
/** Keys of placeholders used in the campaign. */
|
|
1299
|
+
placeholderKeys?: string[];
|
|
1300
|
+
}
|
|
1301
|
+
interface GetDefaultComponentsRequest {
|
|
1302
|
+
}
|
|
1303
|
+
interface GetDefaultComponentsResponse {
|
|
1304
|
+
footer?: Record<string, any> | null;
|
|
1305
|
+
logo?: Record<string, any> | null;
|
|
1306
|
+
follow?: Record<string, any> | null;
|
|
1189
1307
|
}
|
|
1190
1308
|
interface ValidateLinkRequest {
|
|
1191
1309
|
/**
|
|
@@ -1209,268 +1327,150 @@ interface ValidateHtmlLinksResponse {
|
|
|
1209
1327
|
/** Non-valid links. */
|
|
1210
1328
|
blacklistedLinks?: string[];
|
|
1211
1329
|
}
|
|
1212
|
-
interface
|
|
1213
|
-
/**
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
automationRuleId?: string;
|
|
1218
|
-
/**
|
|
1219
|
-
* template ID configured for the automation
|
|
1220
|
-
* @format GUID
|
|
1221
|
-
*/
|
|
1222
|
-
templateId?: string;
|
|
1223
|
-
}
|
|
1224
|
-
interface GetCampaignMappingResponse {
|
|
1225
|
-
/** @format GUID */
|
|
1226
|
-
campaignId?: string;
|
|
1227
|
-
}
|
|
1228
|
-
interface UpsertTranslationRequest {
|
|
1229
|
-
/**
|
|
1230
|
-
* Campaign ID.
|
|
1231
|
-
* @format GUID
|
|
1232
|
-
*/
|
|
1233
|
-
campaignId?: string;
|
|
1234
|
-
/** Composer data. */
|
|
1235
|
-
composer?: Composer;
|
|
1236
|
-
/**
|
|
1237
|
-
* Translation language (optional, default value "EN").
|
|
1238
|
-
* @format LANGUAGE
|
|
1239
|
-
*/
|
|
1240
|
-
language?: string | null;
|
|
1241
|
-
/**
|
|
1242
|
-
* For BI event [36:1031] only (optional, default value "n/a").
|
|
1243
|
-
* @format GUID
|
|
1244
|
-
*/
|
|
1245
|
-
automationRuleId?: string | null;
|
|
1246
|
-
/** Should campaign also be published or not (default value "false"). */
|
|
1247
|
-
publish?: boolean;
|
|
1248
|
-
/**
|
|
1249
|
-
* Campaign subject (optional).
|
|
1250
|
-
* @maxLength 1000
|
|
1251
|
-
*/
|
|
1252
|
-
emailSubject?: string | null;
|
|
1330
|
+
interface EstimateFilterSizeRequest {
|
|
1331
|
+
/** Contacts filter expression. */
|
|
1332
|
+
filter?: Record<string, any> | null;
|
|
1333
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1334
|
+
activeContactsOnly?: boolean;
|
|
1253
1335
|
/**
|
|
1254
|
-
*
|
|
1255
|
-
* @
|
|
1336
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1337
|
+
* @minLength 1
|
|
1338
|
+
* @maxLength 100
|
|
1256
1339
|
*/
|
|
1257
|
-
|
|
1340
|
+
search?: string | null;
|
|
1258
1341
|
}
|
|
1259
|
-
interface
|
|
1342
|
+
interface EstimateFilterSizeResponse {
|
|
1343
|
+
/** Mailing list size estimation. */
|
|
1344
|
+
estimation?: number;
|
|
1260
1345
|
}
|
|
1261
|
-
interface
|
|
1346
|
+
interface EstimateAudienceSizeRequest {
|
|
1262
1347
|
/**
|
|
1263
|
-
*
|
|
1348
|
+
* Contact IDs of a campaign audience.
|
|
1264
1349
|
* @format GUID
|
|
1265
1350
|
*/
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
/**
|
|
1270
|
-
|
|
1271
|
-
* @maxLength 200
|
|
1272
|
-
* @maxSize 300
|
|
1273
|
-
*/
|
|
1274
|
-
placeholderKeys?: string[];
|
|
1275
|
-
}
|
|
1276
|
-
interface LookupCampaignMappingRequest {
|
|
1351
|
+
contactIds?: string[];
|
|
1352
|
+
/** Label IDs of a campaign audience. */
|
|
1353
|
+
labelIds?: string[];
|
|
1354
|
+
/** Contacts filter expression (json). */
|
|
1355
|
+
contactsFilter?: Record<string, any> | null;
|
|
1277
1356
|
/**
|
|
1278
|
-
*
|
|
1279
|
-
* @
|
|
1357
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1358
|
+
* @minLength 1
|
|
1359
|
+
* @maxLength 100
|
|
1280
1360
|
*/
|
|
1281
|
-
|
|
1361
|
+
search?: string | null;
|
|
1282
1362
|
/**
|
|
1283
|
-
*
|
|
1363
|
+
* Segment ids of a campaign audience.
|
|
1284
1364
|
* @format GUID
|
|
1285
1365
|
*/
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
/** @format GUID */
|
|
1290
|
-
campaignId?: string | null;
|
|
1291
|
-
}
|
|
1292
|
-
interface UpsertAutomationTranslatorContentRequest {
|
|
1366
|
+
segmentIds?: string[];
|
|
1367
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1368
|
+
activeContactsOnly?: boolean;
|
|
1293
1369
|
/**
|
|
1294
|
-
*
|
|
1370
|
+
* Id of a campaign that is to be resent.
|
|
1295
1371
|
* @format GUID
|
|
1296
1372
|
*/
|
|
1297
|
-
|
|
1298
|
-
/**
|
|
1299
|
-
|
|
1300
|
-
}
|
|
1301
|
-
/** Automation Translator Content */
|
|
1302
|
-
interface AutomationTranslatorContent {
|
|
1303
|
-
/**
|
|
1304
|
-
* AutomationTranslatorContent ID
|
|
1305
|
-
* @minLength 1
|
|
1306
|
-
* @maxLength 256
|
|
1307
|
-
* @immutable
|
|
1308
|
-
*/
|
|
1309
|
-
_id?: string;
|
|
1310
|
-
/**
|
|
1311
|
-
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
1312
|
-
* @minLength 1
|
|
1313
|
-
* @maxLength 800000
|
|
1314
|
-
*/
|
|
1315
|
-
json?: string;
|
|
1373
|
+
resendCampaignId?: string | null;
|
|
1374
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1375
|
+
withTotal?: boolean;
|
|
1316
1376
|
}
|
|
1317
|
-
interface
|
|
1377
|
+
interface EstimateAudienceSizeResponse {
|
|
1378
|
+
/** Audience size (estimated number of emails to be sent). */
|
|
1379
|
+
estimation?: number;
|
|
1380
|
+
/** Total number of contacts in provided audience (optional). */
|
|
1381
|
+
total?: number | null;
|
|
1318
1382
|
}
|
|
1319
|
-
interface
|
|
1383
|
+
interface ReconcileContactRequest {
|
|
1320
1384
|
/**
|
|
1321
|
-
*
|
|
1322
|
-
* @format
|
|
1385
|
+
* Email address of the contact.
|
|
1386
|
+
* @format EMAIL
|
|
1323
1387
|
*/
|
|
1324
|
-
|
|
1388
|
+
emailAddress?: string;
|
|
1325
1389
|
}
|
|
1326
|
-
interface
|
|
1327
|
-
/**
|
|
1328
|
-
|
|
1390
|
+
interface ReconcileContactResponse {
|
|
1391
|
+
/** Created or retrieved contact. */
|
|
1392
|
+
contact?: Contact;
|
|
1329
1393
|
}
|
|
1330
|
-
interface
|
|
1394
|
+
interface Contact {
|
|
1331
1395
|
/**
|
|
1332
|
-
*
|
|
1396
|
+
* Unique ID of the contact entity.
|
|
1333
1397
|
* @format GUID
|
|
1334
1398
|
*/
|
|
1335
|
-
|
|
1399
|
+
_id?: string;
|
|
1336
1400
|
/**
|
|
1337
|
-
*
|
|
1401
|
+
* Primary email address of the contact.
|
|
1338
1402
|
* @format EMAIL
|
|
1339
1403
|
*/
|
|
1340
|
-
|
|
1341
|
-
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
1342
|
-
placeholders?: Record<string, PlaceholderContent>;
|
|
1404
|
+
emailAddress?: string;
|
|
1343
1405
|
/**
|
|
1344
|
-
*
|
|
1406
|
+
* Full name of the contact (optional).
|
|
1345
1407
|
* @maxLength 100
|
|
1346
1408
|
*/
|
|
1347
|
-
|
|
1348
|
-
/**
|
|
1349
|
-
* Reply-to email address
|
|
1350
|
-
* @format EMAIL
|
|
1351
|
-
*/
|
|
1352
|
-
replyToEmailAddress?: string | null;
|
|
1409
|
+
fullName?: string | null;
|
|
1353
1410
|
/**
|
|
1354
|
-
*
|
|
1355
|
-
* @format
|
|
1411
|
+
* Profile picture of the contact (optional).
|
|
1412
|
+
* @format WEB_URL
|
|
1413
|
+
* @maxLength 2048
|
|
1356
1414
|
*/
|
|
1357
|
-
|
|
1358
|
-
}
|
|
1359
|
-
interface SendTestBulkResponse {
|
|
1415
|
+
pictureUrl?: string | null;
|
|
1360
1416
|
}
|
|
1361
|
-
interface
|
|
1417
|
+
interface SearchContactsRequest {
|
|
1362
1418
|
/**
|
|
1363
|
-
*
|
|
1364
|
-
* @
|
|
1365
|
-
* @minSize 1
|
|
1366
|
-
* @maxSize 100
|
|
1419
|
+
* Text to search contacts by - can search by name or email address.
|
|
1420
|
+
* @maxLength 100
|
|
1367
1421
|
*/
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
/** List of statistics. */
|
|
1372
|
-
statistics?: CampaignStatisticsContainer[];
|
|
1373
|
-
}
|
|
1374
|
-
interface CampaignStatisticsContainer {
|
|
1422
|
+
searchTerm?: string;
|
|
1423
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1424
|
+
activeContactsOnly?: boolean;
|
|
1375
1425
|
/**
|
|
1376
|
-
*
|
|
1377
|
-
* @
|
|
1426
|
+
* Page size (default 50, max 1000).
|
|
1427
|
+
* @max 1000
|
|
1378
1428
|
*/
|
|
1379
|
-
|
|
1380
|
-
/** Landing page statistics. */
|
|
1381
|
-
landingPage?: LandingPageStatistics;
|
|
1382
|
-
/** Email campaign statistics. */
|
|
1383
|
-
email?: DistributionStatistics;
|
|
1429
|
+
pageSize?: number | null;
|
|
1384
1430
|
}
|
|
1385
|
-
interface
|
|
1386
|
-
/**
|
|
1387
|
-
|
|
1388
|
-
* @format GUID
|
|
1389
|
-
*/
|
|
1390
|
-
campaignId: string;
|
|
1391
|
-
/** Email activity to filter. */
|
|
1392
|
-
activity: RecipientsActivityEnumWithLiterals;
|
|
1393
|
-
/** Pagination options. */
|
|
1394
|
-
paging?: CursorPaging;
|
|
1431
|
+
interface SearchContactsResponse {
|
|
1432
|
+
/** Search results. */
|
|
1433
|
+
contacts?: Contact[];
|
|
1395
1434
|
}
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
OPENED = "OPENED",
|
|
1400
|
-
CLICKED = "CLICKED",
|
|
1401
|
-
BOUNCED = "BOUNCED",
|
|
1402
|
-
NOT_SENT = "NOT_SENT",
|
|
1403
|
-
SENT = "SENT",
|
|
1404
|
-
NOT_OPENED = "NOT_OPENED"
|
|
1435
|
+
interface GetLabelsRequest {
|
|
1436
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1437
|
+
activeContactsOnly?: boolean;
|
|
1405
1438
|
}
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1439
|
+
interface GetLabelsResponse {
|
|
1440
|
+
/** Returned labels with contact counts. */
|
|
1441
|
+
labels?: Label[];
|
|
1442
|
+
}
|
|
1443
|
+
interface Label {
|
|
1409
1444
|
/**
|
|
1410
|
-
*
|
|
1411
|
-
* @
|
|
1445
|
+
* Unique ID of the label entity.
|
|
1446
|
+
* @maxLength 100
|
|
1412
1447
|
*/
|
|
1413
|
-
|
|
1448
|
+
_id?: string;
|
|
1414
1449
|
/**
|
|
1415
|
-
*
|
|
1416
|
-
*
|
|
1417
|
-
* You can get the relevant cursor token
|
|
1418
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1419
|
-
* Not relevant for the first request.
|
|
1420
|
-
* @maxLength 1000
|
|
1450
|
+
* Name of the label.
|
|
1451
|
+
* @maxLength 100
|
|
1421
1452
|
*/
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
/** List of recipients. */
|
|
1426
|
-
recipients?: CampaignRecipientDetails[];
|
|
1427
|
-
/** Details on the paged set of returned results. */
|
|
1428
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1453
|
+
name?: string;
|
|
1454
|
+
/** Amount of contacts assigned to the label. */
|
|
1455
|
+
contactsCount?: number;
|
|
1429
1456
|
}
|
|
1430
|
-
interface
|
|
1457
|
+
interface SubscribeFromLandingPageRequest {
|
|
1431
1458
|
/**
|
|
1432
|
-
*
|
|
1459
|
+
* Campaign ID that the subscription is happening from.
|
|
1433
1460
|
* @format GUID
|
|
1434
1461
|
*/
|
|
1435
|
-
|
|
1436
|
-
/** Date and time of the last activity. */
|
|
1437
|
-
lastActivityDate?: Date | null;
|
|
1462
|
+
campaignId?: string;
|
|
1438
1463
|
/**
|
|
1439
|
-
*
|
|
1464
|
+
* Email address that is entered into subscription field.
|
|
1440
1465
|
* @format EMAIL
|
|
1441
1466
|
*/
|
|
1442
1467
|
emailAddress?: string;
|
|
1443
|
-
/**
|
|
1444
|
-
|
|
1445
|
-
* @maxLength 100
|
|
1446
|
-
*/
|
|
1447
|
-
fullName?: string | null;
|
|
1448
|
-
/** Is this contact currently deleted from the site or not. */
|
|
1449
|
-
contactDeleted?: boolean;
|
|
1450
|
-
}
|
|
1451
|
-
interface PagingMetadataV2 {
|
|
1452
|
-
/** Number of items returned in the response. */
|
|
1453
|
-
count?: number | null;
|
|
1454
|
-
/** Offset that was requested. */
|
|
1455
|
-
offset?: number | null;
|
|
1456
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1457
|
-
total?: number | null;
|
|
1458
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1459
|
-
tooManyToCount?: boolean | null;
|
|
1460
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1461
|
-
cursors?: Cursors;
|
|
1468
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1469
|
+
consent?: boolean;
|
|
1462
1470
|
}
|
|
1463
|
-
interface
|
|
1464
|
-
/**
|
|
1465
|
-
|
|
1466
|
-
* @maxLength 16000
|
|
1467
|
-
*/
|
|
1468
|
-
next?: string | null;
|
|
1469
|
-
/**
|
|
1470
|
-
* Cursor pointing to the previous page in the list of results.
|
|
1471
|
-
* @maxLength 16000
|
|
1472
|
-
*/
|
|
1473
|
-
prev?: string | null;
|
|
1471
|
+
interface SubscribeFromLandingPageResponse {
|
|
1472
|
+
/** @format GUID */
|
|
1473
|
+
contactId?: string;
|
|
1474
1474
|
}
|
|
1475
1475
|
/** @docsIgnore */
|
|
1476
1476
|
type PublishCampaignApplicationErrors = {
|
|
@@ -1765,6 +1765,46 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1765
1765
|
* @slug email_activity_updated
|
|
1766
1766
|
*/
|
|
1767
1767
|
declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
|
|
1768
|
+
/**
|
|
1769
|
+
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1770
|
+
*
|
|
1771
|
+
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1772
|
+
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1773
|
+
*
|
|
1774
|
+
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1775
|
+
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1776
|
+
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1777
|
+
* @public
|
|
1778
|
+
* @requiredField campaignIds
|
|
1779
|
+
* @permissionId Shoutout.Read
|
|
1780
|
+
* @applicableIdentity APP
|
|
1781
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1782
|
+
*/
|
|
1783
|
+
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>>;
|
|
1784
|
+
/**
|
|
1785
|
+
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1786
|
+
*
|
|
1787
|
+
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1788
|
+
*
|
|
1789
|
+
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1790
|
+
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1791
|
+
*
|
|
1792
|
+
* If no `activity` is included, this method returns an error.
|
|
1793
|
+
* @param campaignId - Campaign ID.
|
|
1794
|
+
* @param activity - Email activity to filter.
|
|
1795
|
+
* @public
|
|
1796
|
+
* @requiredField activity
|
|
1797
|
+
* @requiredField campaignId
|
|
1798
|
+
* @param options - Options to use when getting the list of recipients.
|
|
1799
|
+
* @permissionId Shoutout.Read
|
|
1800
|
+
* @applicableIdentity APP
|
|
1801
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1802
|
+
*/
|
|
1803
|
+
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1804
|
+
interface ListRecipientsOptions {
|
|
1805
|
+
/** Pagination options. */
|
|
1806
|
+
paging?: CursorPaging;
|
|
1807
|
+
}
|
|
1768
1808
|
/**
|
|
1769
1809
|
* Retrieves information about an email campaign.
|
|
1770
1810
|
* @param campaignId - Campaign ID.
|
|
@@ -1939,45 +1979,5 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
|
|
|
1939
1979
|
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
|
|
1940
1980
|
*/
|
|
1941
1981
|
declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
|
|
1942
|
-
/**
|
|
1943
|
-
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1944
|
-
*
|
|
1945
|
-
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1946
|
-
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1947
|
-
*
|
|
1948
|
-
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1949
|
-
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1950
|
-
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1951
|
-
* @public
|
|
1952
|
-
* @requiredField campaignIds
|
|
1953
|
-
* @permissionId Shoutout.Read
|
|
1954
|
-
* @applicableIdentity APP
|
|
1955
|
-
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1956
|
-
*/
|
|
1957
|
-
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>>;
|
|
1958
|
-
/**
|
|
1959
|
-
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1960
|
-
*
|
|
1961
|
-
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1962
|
-
*
|
|
1963
|
-
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1964
|
-
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1965
|
-
*
|
|
1966
|
-
* If no `activity` is included, this method returns an error.
|
|
1967
|
-
* @param campaignId - Campaign ID.
|
|
1968
|
-
* @param activity - Email activity to filter.
|
|
1969
|
-
* @public
|
|
1970
|
-
* @requiredField activity
|
|
1971
|
-
* @requiredField campaignId
|
|
1972
|
-
* @param options - Options to use when getting the list of recipients.
|
|
1973
|
-
* @permissionId Shoutout.Read
|
|
1974
|
-
* @applicableIdentity APP
|
|
1975
|
-
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1976
|
-
*/
|
|
1977
|
-
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1978
|
-
interface ListRecipientsOptions {
|
|
1979
|
-
/** Pagination options. */
|
|
1980
|
-
paging?: CursorPaging;
|
|
1981
|
-
}
|
|
1982
1982
|
|
|
1983
|
-
export { type AccountInfo, 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 };
|
|
1983
|
+
export { type AccountInfo, type AccountInfoMetadata, 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 };
|