@wix/auto_sdk_email-marketing_campaigns 1.0.97 → 1.0.98
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 +34 -34
- package/build/cjs/index.js +170 -170
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +533 -551
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +481 -481
- package/build/cjs/meta.js +134 -134
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +34 -34
- package/build/es/index.mjs +170 -170
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +533 -551
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +481 -481
- package/build/es/meta.mjs +134 -134
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +34 -34
- 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 +533 -551
- 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 +481 -481
- package/build/internal/cjs/meta.js +134 -134
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +34 -34
- 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 +533 -551
- 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 +481 -481
- package/build/internal/es/meta.mjs +134 -134
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -213,361 +213,23 @@ declare enum CampaignTypeEnum {
|
|
|
213
213
|
}
|
|
214
214
|
/** @enumType */
|
|
215
215
|
type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
|
|
216
|
-
interface
|
|
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 {
|
|
216
|
+
interface GetPlaceholderKeysRequest {
|
|
528
217
|
/**
|
|
529
|
-
*
|
|
218
|
+
* Campaign ID.
|
|
530
219
|
* @format GUID
|
|
531
220
|
*/
|
|
532
|
-
|
|
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;
|
|
221
|
+
campaignId?: string;
|
|
547
222
|
}
|
|
548
|
-
interface
|
|
549
|
-
/**
|
|
550
|
-
|
|
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;
|
|
223
|
+
interface GetPlaceholderKeysResponse {
|
|
224
|
+
/** Keys of placeholders used in the campaign. */
|
|
225
|
+
placeholderKeys?: string[];
|
|
559
226
|
}
|
|
560
|
-
interface
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
/**
|
|
567
|
-
* Cursor pointing to the previous page in the list of results.
|
|
568
|
-
* @maxLength 16000
|
|
569
|
-
*/
|
|
570
|
-
prev?: string | null;
|
|
227
|
+
interface GetDefaultComponentsRequest {
|
|
228
|
+
}
|
|
229
|
+
interface GetDefaultComponentsResponse {
|
|
230
|
+
footer?: Record<string, any> | null;
|
|
231
|
+
logo?: Record<string, any> | null;
|
|
232
|
+
follow?: Record<string, any> | null;
|
|
571
233
|
}
|
|
572
234
|
interface GetCampaignRequest {
|
|
573
235
|
/**
|
|
@@ -870,6 +532,86 @@ interface SendTestRequest {
|
|
|
870
532
|
*/
|
|
871
533
|
toEmailAddress: string;
|
|
872
534
|
}
|
|
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
|
+
}
|
|
873
615
|
interface SendTestResponse {
|
|
874
616
|
}
|
|
875
617
|
interface PauseSchedulingRequest {
|
|
@@ -1013,6 +755,19 @@ interface GetComposerResponse {
|
|
|
1013
755
|
*/
|
|
1014
756
|
emailPreheader?: string | null;
|
|
1015
757
|
}
|
|
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
|
+
}
|
|
1016
771
|
interface UpdateComposerRequest {
|
|
1017
772
|
/**
|
|
1018
773
|
* Campaign ID.
|
|
@@ -1224,86 +979,213 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1224
979
|
* ID of a site visitor that has logged in to the site.
|
|
1225
980
|
* @format GUID
|
|
1226
981
|
*/
|
|
1227
|
-
memberId?: string;
|
|
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;
|
|
1228
1084
|
/**
|
|
1229
|
-
*
|
|
1085
|
+
* Id of a campaign that is to be resent.
|
|
1230
1086
|
* @format GUID
|
|
1231
1087
|
*/
|
|
1232
|
-
|
|
1088
|
+
resendCampaignId?: string | null;
|
|
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 {
|
|
1233
1099
|
/**
|
|
1234
|
-
*
|
|
1235
|
-
* @format
|
|
1100
|
+
* Email address of the contact.
|
|
1101
|
+
* @format EMAIL
|
|
1236
1102
|
*/
|
|
1237
|
-
|
|
1238
|
-
/** @readonly */
|
|
1239
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1103
|
+
emailAddress?: string;
|
|
1240
1104
|
}
|
|
1241
|
-
|
|
1242
|
-
|
|
1105
|
+
interface ReconcileContactResponse {
|
|
1106
|
+
/** Created or retrieved contact. */
|
|
1107
|
+
contact?: Contact;
|
|
1108
|
+
}
|
|
1109
|
+
interface Contact {
|
|
1243
1110
|
/**
|
|
1244
|
-
* ID of
|
|
1111
|
+
* Unique ID of the contact entity.
|
|
1245
1112
|
* @format GUID
|
|
1246
1113
|
*/
|
|
1247
|
-
|
|
1114
|
+
_id?: string;
|
|
1248
1115
|
/**
|
|
1249
|
-
*
|
|
1250
|
-
* @format
|
|
1116
|
+
* Primary email address of the contact.
|
|
1117
|
+
* @format EMAIL
|
|
1251
1118
|
*/
|
|
1252
|
-
|
|
1119
|
+
emailAddress?: string;
|
|
1253
1120
|
/**
|
|
1254
|
-
*
|
|
1255
|
-
* @
|
|
1121
|
+
* Full name of the contact (optional).
|
|
1122
|
+
* @maxLength 100
|
|
1256
1123
|
*/
|
|
1257
|
-
|
|
1124
|
+
fullName?: string | null;
|
|
1258
1125
|
/**
|
|
1259
|
-
*
|
|
1260
|
-
* @format
|
|
1126
|
+
* Profile picture of the contact (optional).
|
|
1127
|
+
* @format WEB_URL
|
|
1128
|
+
* @maxLength 2048
|
|
1261
1129
|
*/
|
|
1262
|
-
|
|
1263
|
-
}
|
|
1264
|
-
declare enum WebhookIdentityType {
|
|
1265
|
-
UNKNOWN = "UNKNOWN",
|
|
1266
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1267
|
-
MEMBER = "MEMBER",
|
|
1268
|
-
WIX_USER = "WIX_USER",
|
|
1269
|
-
APP = "APP"
|
|
1130
|
+
pictureUrl?: string | null;
|
|
1270
1131
|
}
|
|
1271
|
-
|
|
1272
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1273
|
-
interface AccountInfo {
|
|
1132
|
+
interface SearchContactsRequest {
|
|
1274
1133
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
* @
|
|
1134
|
+
* Text to search contacts by - can search by name or email address.
|
|
1135
|
+
* @maxLength 100
|
|
1277
1136
|
*/
|
|
1278
|
-
|
|
1137
|
+
searchTerm?: string;
|
|
1138
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1139
|
+
activeContactsOnly?: boolean;
|
|
1279
1140
|
/**
|
|
1280
|
-
*
|
|
1281
|
-
* @
|
|
1141
|
+
* Page size (default 50, max 1000).
|
|
1142
|
+
* @max 1000
|
|
1282
1143
|
*/
|
|
1283
|
-
|
|
1144
|
+
pageSize?: number | null;
|
|
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 {
|
|
1284
1159
|
/**
|
|
1285
|
-
* ID of the
|
|
1286
|
-
* @
|
|
1160
|
+
* Unique ID of the label entity.
|
|
1161
|
+
* @maxLength 100
|
|
1287
1162
|
*/
|
|
1288
|
-
|
|
1163
|
+
_id?: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* Name of the label.
|
|
1166
|
+
* @maxLength 100
|
|
1167
|
+
*/
|
|
1168
|
+
name?: string;
|
|
1169
|
+
/** Amount of contacts assigned to the label. */
|
|
1170
|
+
contactsCount?: number;
|
|
1289
1171
|
}
|
|
1290
|
-
interface
|
|
1172
|
+
interface SubscribeFromLandingPageRequest {
|
|
1291
1173
|
/**
|
|
1292
|
-
* Campaign ID.
|
|
1174
|
+
* Campaign ID that the subscription is happening from.
|
|
1293
1175
|
* @format GUID
|
|
1294
1176
|
*/
|
|
1295
1177
|
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;
|
|
1296
1185
|
}
|
|
1297
|
-
interface
|
|
1298
|
-
/**
|
|
1299
|
-
|
|
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;
|
|
1186
|
+
interface SubscribeFromLandingPageResponse {
|
|
1187
|
+
/** @format GUID */
|
|
1188
|
+
contactId?: string;
|
|
1307
1189
|
}
|
|
1308
1190
|
interface ValidateLinkRequest {
|
|
1309
1191
|
/**
|
|
@@ -1327,150 +1209,268 @@ interface ValidateHtmlLinksResponse {
|
|
|
1327
1209
|
/** Non-valid links. */
|
|
1328
1210
|
blacklistedLinks?: string[];
|
|
1329
1211
|
}
|
|
1330
|
-
interface
|
|
1331
|
-
/** Contacts filter expression. */
|
|
1332
|
-
filter?: Record<string, any> | null;
|
|
1333
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1334
|
-
activeContactsOnly?: boolean;
|
|
1212
|
+
interface GetCampaignMappingRequest {
|
|
1335
1213
|
/**
|
|
1336
|
-
*
|
|
1337
|
-
* @
|
|
1338
|
-
* @maxLength 100
|
|
1214
|
+
* rule ID in automations
|
|
1215
|
+
* @format GUID
|
|
1339
1216
|
*/
|
|
1340
|
-
|
|
1217
|
+
automationRuleId?: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* template ID configured for the automation
|
|
1220
|
+
* @format GUID
|
|
1221
|
+
*/
|
|
1222
|
+
templateId?: string;
|
|
1341
1223
|
}
|
|
1342
|
-
interface
|
|
1343
|
-
/**
|
|
1344
|
-
|
|
1224
|
+
interface GetCampaignMappingResponse {
|
|
1225
|
+
/** @format GUID */
|
|
1226
|
+
campaignId?: string;
|
|
1345
1227
|
}
|
|
1346
|
-
interface
|
|
1228
|
+
interface UpsertTranslationRequest {
|
|
1347
1229
|
/**
|
|
1348
|
-
*
|
|
1230
|
+
* Campaign ID.
|
|
1349
1231
|
* @format GUID
|
|
1350
1232
|
*/
|
|
1351
|
-
|
|
1352
|
-
/**
|
|
1353
|
-
|
|
1354
|
-
/** Contacts filter expression (json). */
|
|
1355
|
-
contactsFilter?: Record<string, any> | null;
|
|
1233
|
+
campaignId?: string;
|
|
1234
|
+
/** Composer data. */
|
|
1235
|
+
composer?: Composer;
|
|
1356
1236
|
/**
|
|
1357
|
-
*
|
|
1358
|
-
* @
|
|
1359
|
-
* @maxLength 100
|
|
1237
|
+
* Translation language (optional, default value "EN").
|
|
1238
|
+
* @format LANGUAGE
|
|
1360
1239
|
*/
|
|
1361
|
-
|
|
1240
|
+
language?: string | null;
|
|
1362
1241
|
/**
|
|
1363
|
-
*
|
|
1242
|
+
* For BI event [36:1031] only (optional, default value "n/a").
|
|
1364
1243
|
* @format GUID
|
|
1365
1244
|
*/
|
|
1366
|
-
|
|
1367
|
-
/** Should
|
|
1368
|
-
|
|
1245
|
+
automationRuleId?: string | null;
|
|
1246
|
+
/** Should campaign also be published or not (default value "false"). */
|
|
1247
|
+
publish?: boolean;
|
|
1369
1248
|
/**
|
|
1370
|
-
*
|
|
1249
|
+
* Campaign subject (optional).
|
|
1250
|
+
* @maxLength 1000
|
|
1251
|
+
*/
|
|
1252
|
+
emailSubject?: string | null;
|
|
1253
|
+
/**
|
|
1254
|
+
* Campaign preheader (optional).
|
|
1255
|
+
* @maxLength 1000
|
|
1256
|
+
*/
|
|
1257
|
+
emailPreheader?: string | null;
|
|
1258
|
+
}
|
|
1259
|
+
interface UpsertTranslationResponse {
|
|
1260
|
+
}
|
|
1261
|
+
interface GetUsedPlaceholderKeysRequest {
|
|
1262
|
+
/**
|
|
1263
|
+
* Campaign ID.
|
|
1371
1264
|
* @format GUID
|
|
1372
1265
|
*/
|
|
1373
|
-
|
|
1374
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1375
|
-
withTotal?: boolean;
|
|
1266
|
+
campaignId?: string;
|
|
1376
1267
|
}
|
|
1377
|
-
interface
|
|
1378
|
-
/**
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1268
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
1269
|
+
/**
|
|
1270
|
+
* Keys of placeholders used in the automation.
|
|
1271
|
+
* @maxLength 200
|
|
1272
|
+
* @maxSize 300
|
|
1273
|
+
*/
|
|
1274
|
+
placeholderKeys?: string[];
|
|
1275
|
+
}
|
|
1276
|
+
interface LookupCampaignMappingRequest {
|
|
1277
|
+
/**
|
|
1278
|
+
* rule ID in automations
|
|
1279
|
+
* @format GUID
|
|
1280
|
+
*/
|
|
1281
|
+
automationRuleId?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* template ID configured for the automation
|
|
1284
|
+
* @format GUID
|
|
1285
|
+
*/
|
|
1286
|
+
templateId?: string;
|
|
1287
|
+
}
|
|
1288
|
+
interface LookupCampaignMappingResponse {
|
|
1289
|
+
/** @format GUID */
|
|
1290
|
+
campaignId?: string | null;
|
|
1291
|
+
}
|
|
1292
|
+
interface UpsertAutomationTranslatorContentRequest {
|
|
1293
|
+
/**
|
|
1294
|
+
* Campaign ID that the content belongs to
|
|
1295
|
+
* @format GUID
|
|
1296
|
+
*/
|
|
1297
|
+
campaignId?: string;
|
|
1298
|
+
/** Automation translator content */
|
|
1299
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
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;
|
|
1382
1316
|
}
|
|
1383
|
-
interface
|
|
1317
|
+
interface UpsertAutomationTranslatorContentResponse {
|
|
1318
|
+
}
|
|
1319
|
+
interface GetAutomationTranslatorContentRequest {
|
|
1384
1320
|
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @format
|
|
1321
|
+
* Campaign ID
|
|
1322
|
+
* @format GUID
|
|
1387
1323
|
*/
|
|
1388
|
-
|
|
1324
|
+
campaignId?: string;
|
|
1389
1325
|
}
|
|
1390
|
-
interface
|
|
1391
|
-
/**
|
|
1392
|
-
|
|
1326
|
+
interface GetAutomationTranslatorContentResponse {
|
|
1327
|
+
/** Automation translator content */
|
|
1328
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
1393
1329
|
}
|
|
1394
|
-
interface
|
|
1330
|
+
interface SendTestBulkRequest {
|
|
1395
1331
|
/**
|
|
1396
|
-
*
|
|
1332
|
+
* Campaign ID
|
|
1397
1333
|
* @format GUID
|
|
1398
1334
|
*/
|
|
1399
|
-
|
|
1335
|
+
campaignId?: string;
|
|
1400
1336
|
/**
|
|
1401
|
-
*
|
|
1337
|
+
* Recipient email address
|
|
1402
1338
|
* @format EMAIL
|
|
1403
1339
|
*/
|
|
1404
|
-
|
|
1340
|
+
toEmailAddress?: string;
|
|
1341
|
+
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
1342
|
+
placeholders?: Record<string, PlaceholderContent>;
|
|
1405
1343
|
/**
|
|
1406
|
-
*
|
|
1344
|
+
* Sender from name
|
|
1407
1345
|
* @maxLength 100
|
|
1408
1346
|
*/
|
|
1409
|
-
|
|
1347
|
+
fromName?: string | null;
|
|
1410
1348
|
/**
|
|
1411
|
-
*
|
|
1412
|
-
* @format
|
|
1413
|
-
* @maxLength 2048
|
|
1349
|
+
* Reply-to email address
|
|
1350
|
+
* @format EMAIL
|
|
1414
1351
|
*/
|
|
1415
|
-
|
|
1416
|
-
}
|
|
1417
|
-
interface SearchContactsRequest {
|
|
1352
|
+
replyToEmailAddress?: string | null;
|
|
1418
1353
|
/**
|
|
1419
|
-
*
|
|
1420
|
-
* @
|
|
1354
|
+
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
1355
|
+
* @format LANGUAGE
|
|
1421
1356
|
*/
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1357
|
+
language?: string | null;
|
|
1358
|
+
}
|
|
1359
|
+
interface SendTestBulkResponse {
|
|
1360
|
+
}
|
|
1361
|
+
interface ListStatisticsRequest {
|
|
1425
1362
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
* @
|
|
1363
|
+
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1364
|
+
* @format GUID
|
|
1365
|
+
* @minSize 1
|
|
1366
|
+
* @maxSize 100
|
|
1428
1367
|
*/
|
|
1429
|
-
|
|
1368
|
+
campaignIds: string[];
|
|
1430
1369
|
}
|
|
1431
|
-
interface
|
|
1432
|
-
/**
|
|
1433
|
-
|
|
1370
|
+
interface ListStatisticsResponse {
|
|
1371
|
+
/** List of statistics. */
|
|
1372
|
+
statistics?: CampaignStatisticsContainer[];
|
|
1434
1373
|
}
|
|
1435
|
-
interface
|
|
1436
|
-
/**
|
|
1437
|
-
|
|
1374
|
+
interface CampaignStatisticsContainer {
|
|
1375
|
+
/**
|
|
1376
|
+
* Campaign ID.
|
|
1377
|
+
* @format GUID
|
|
1378
|
+
*/
|
|
1379
|
+
campaignId?: string;
|
|
1380
|
+
/** Landing page statistics. */
|
|
1381
|
+
landingPage?: LandingPageStatistics;
|
|
1382
|
+
/** Email campaign statistics. */
|
|
1383
|
+
email?: DistributionStatistics;
|
|
1438
1384
|
}
|
|
1439
|
-
interface
|
|
1440
|
-
/**
|
|
1441
|
-
|
|
1385
|
+
interface ListRecipientsRequest {
|
|
1386
|
+
/**
|
|
1387
|
+
* Campaign ID.
|
|
1388
|
+
* @format GUID
|
|
1389
|
+
*/
|
|
1390
|
+
campaignId: string;
|
|
1391
|
+
/** Email activity to filter. */
|
|
1392
|
+
activity: RecipientsActivityEnumWithLiterals;
|
|
1393
|
+
/** Pagination options. */
|
|
1394
|
+
paging?: CursorPaging;
|
|
1442
1395
|
}
|
|
1443
|
-
|
|
1396
|
+
declare enum RecipientsActivityEnum {
|
|
1397
|
+
UNKNOWN = "UNKNOWN",
|
|
1398
|
+
DELIVERED = "DELIVERED",
|
|
1399
|
+
OPENED = "OPENED",
|
|
1400
|
+
CLICKED = "CLICKED",
|
|
1401
|
+
BOUNCED = "BOUNCED",
|
|
1402
|
+
NOT_SENT = "NOT_SENT",
|
|
1403
|
+
SENT = "SENT",
|
|
1404
|
+
NOT_OPENED = "NOT_OPENED"
|
|
1405
|
+
}
|
|
1406
|
+
/** @enumType */
|
|
1407
|
+
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
1408
|
+
interface CursorPaging {
|
|
1444
1409
|
/**
|
|
1445
|
-
*
|
|
1446
|
-
* @
|
|
1410
|
+
* Number of items to load.
|
|
1411
|
+
* @max 1000
|
|
1447
1412
|
*/
|
|
1448
|
-
|
|
1413
|
+
limit?: number | null;
|
|
1449
1414
|
/**
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1415
|
+
* Pointer to the next or previous page in the list of results.
|
|
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
|
|
1452
1421
|
*/
|
|
1453
|
-
|
|
1454
|
-
/** Amount of contacts assigned to the label. */
|
|
1455
|
-
contactsCount?: number;
|
|
1422
|
+
cursor?: string | null;
|
|
1456
1423
|
}
|
|
1457
|
-
interface
|
|
1424
|
+
interface ListRecipientsResponse {
|
|
1425
|
+
/** List of recipients. */
|
|
1426
|
+
recipients?: CampaignRecipientDetails[];
|
|
1427
|
+
/** Details on the paged set of returned results. */
|
|
1428
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1429
|
+
}
|
|
1430
|
+
interface CampaignRecipientDetails {
|
|
1458
1431
|
/**
|
|
1459
|
-
*
|
|
1432
|
+
* Contact ID.
|
|
1460
1433
|
* @format GUID
|
|
1461
1434
|
*/
|
|
1462
|
-
|
|
1435
|
+
contactId?: string;
|
|
1436
|
+
/** Date and time of the last activity. */
|
|
1437
|
+
lastActivityDate?: Date | null;
|
|
1463
1438
|
/**
|
|
1464
|
-
*
|
|
1439
|
+
* Primary email address of the contact.
|
|
1465
1440
|
* @format EMAIL
|
|
1466
1441
|
*/
|
|
1467
1442
|
emailAddress?: string;
|
|
1468
|
-
/**
|
|
1469
|
-
|
|
1443
|
+
/**
|
|
1444
|
+
* Full name of the contact (optional).
|
|
1445
|
+
* @maxLength 100
|
|
1446
|
+
*/
|
|
1447
|
+
fullName?: string | null;
|
|
1448
|
+
/** Is this contact currently deleted from the site or not. */
|
|
1449
|
+
contactDeleted?: boolean;
|
|
1470
1450
|
}
|
|
1471
|
-
interface
|
|
1472
|
-
/**
|
|
1473
|
-
|
|
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;
|
|
1462
|
+
}
|
|
1463
|
+
interface Cursors {
|
|
1464
|
+
/**
|
|
1465
|
+
* Cursor string pointing to the next page in the list of results.
|
|
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;
|
|
1474
1474
|
}
|
|
1475
1475
|
/** @docsIgnore */
|
|
1476
1476
|
type PublishCampaignApplicationErrors = {
|
|
@@ -1551,8 +1551,6 @@ interface CampaignDistributedEnvelope {
|
|
|
1551
1551
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1552
1552
|
* @permissionScope Access Verticals by Automations
|
|
1553
1553
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1554
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1555
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1556
1554
|
* @permissionScope Set Up Automations
|
|
1557
1555
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1558
1556
|
* @permissionScope Read Email Marketing
|
|
@@ -1576,8 +1574,6 @@ interface CampaignPausedEnvelope {
|
|
|
1576
1574
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1577
1575
|
* @permissionScope Access Verticals by Automations
|
|
1578
1576
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1579
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1580
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1581
1577
|
* @permissionScope Set Up Automations
|
|
1582
1578
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1583
1579
|
* @permissionScope Read Email Marketing
|
|
@@ -1601,8 +1597,6 @@ interface CampaignPublishedEnvelope {
|
|
|
1601
1597
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1602
1598
|
* @permissionScope Access Verticals by Automations
|
|
1603
1599
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1604
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1605
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1606
1600
|
* @permissionScope Set Up Automations
|
|
1607
1601
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1608
1602
|
* @permissionScope Read Email Marketing
|
|
@@ -1626,8 +1620,6 @@ interface CampaignRejectedEnvelope {
|
|
|
1626
1620
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1627
1621
|
* @permissionScope Access Verticals by Automations
|
|
1628
1622
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1629
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1630
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1631
1623
|
* @permissionScope Set Up Automations
|
|
1632
1624
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1633
1625
|
* @permissionScope Read Email Marketing
|
|
@@ -1651,8 +1643,6 @@ interface CampaignScheduledEnvelope {
|
|
|
1651
1643
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1652
1644
|
* @permissionScope Access Verticals by Automations
|
|
1653
1645
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1654
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1655
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1656
1646
|
* @permissionScope Set Up Automations
|
|
1657
1647
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1658
1648
|
* @permissionScope Read Email Marketing
|
|
@@ -1676,8 +1666,6 @@ interface CampaignTerminatedEnvelope {
|
|
|
1676
1666
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1677
1667
|
* @permissionScope Access Verticals by Automations
|
|
1678
1668
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1679
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1680
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1681
1669
|
* @permissionScope Set Up Automations
|
|
1682
1670
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1683
1671
|
* @permissionScope Read Email Marketing
|
|
@@ -1701,8 +1689,6 @@ interface CampaignCreatedEnvelope {
|
|
|
1701
1689
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1702
1690
|
* @permissionScope Access Verticals by Automations
|
|
1703
1691
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1704
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1705
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1706
1692
|
* @permissionScope Set Up Automations
|
|
1707
1693
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1708
1694
|
* @permissionScope Read Email Marketing
|
|
@@ -1725,8 +1711,6 @@ interface CampaignDeletedEnvelope {
|
|
|
1725
1711
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1726
1712
|
* @permissionScope Access Verticals by Automations
|
|
1727
1713
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1728
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1729
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1730
1714
|
* @permissionScope Set Up Automations
|
|
1731
1715
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1732
1716
|
* @permissionScope Read Email Marketing
|
|
@@ -1750,8 +1734,6 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1750
1734
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1751
1735
|
* @permissionScope Access Verticals by Automations
|
|
1752
1736
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1753
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1754
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1755
1737
|
* @permissionScope Set Up Automations
|
|
1756
1738
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1757
1739
|
* @permissionScope Read Email Marketing
|
|
@@ -1765,46 +1747,6 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1765
1747
|
* @slug email_activity_updated
|
|
1766
1748
|
*/
|
|
1767
1749
|
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
|
-
}
|
|
1808
1750
|
/**
|
|
1809
1751
|
* Retrieves information about an email campaign.
|
|
1810
1752
|
* @param campaignId - Campaign ID.
|
|
@@ -1979,5 +1921,45 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
|
|
|
1979
1921
|
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
|
|
1980
1922
|
*/
|
|
1981
1923
|
declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
|
|
1924
|
+
/**
|
|
1925
|
+
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1926
|
+
*
|
|
1927
|
+
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1928
|
+
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1929
|
+
*
|
|
1930
|
+
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1931
|
+
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1932
|
+
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1933
|
+
* @public
|
|
1934
|
+
* @requiredField campaignIds
|
|
1935
|
+
* @permissionId Shoutout.Read
|
|
1936
|
+
* @applicableIdentity APP
|
|
1937
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1938
|
+
*/
|
|
1939
|
+
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>>;
|
|
1940
|
+
/**
|
|
1941
|
+
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1942
|
+
*
|
|
1943
|
+
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1944
|
+
*
|
|
1945
|
+
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1946
|
+
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1947
|
+
*
|
|
1948
|
+
* If no `activity` is included, this method returns an error.
|
|
1949
|
+
* @param campaignId - Campaign ID.
|
|
1950
|
+
* @param activity - Email activity to filter.
|
|
1951
|
+
* @public
|
|
1952
|
+
* @requiredField activity
|
|
1953
|
+
* @requiredField campaignId
|
|
1954
|
+
* @param options - Options to use when getting the list of recipients.
|
|
1955
|
+
* @permissionId Shoutout.Read
|
|
1956
|
+
* @applicableIdentity APP
|
|
1957
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1958
|
+
*/
|
|
1959
|
+
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1960
|
+
interface ListRecipientsOptions {
|
|
1961
|
+
/** Pagination options. */
|
|
1962
|
+
paging?: CursorPaging;
|
|
1963
|
+
}
|
|
1982
1964
|
|
|
1983
1965
|
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 };
|