@wix/auto_sdk_email-marketing_campaigns 1.0.73 → 1.0.75
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 +554 -536
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +486 -486
- 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 +554 -536
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +486 -486
- 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 +554 -536
- 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 +486 -486
- 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 +554 -536
- 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 +486 -486
- package/build/internal/es/meta.mjs +134 -134
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -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.
|
|
@@ -1217,91 +972,218 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1217
972
|
* ID of a site visitor that has not logged in to the site.
|
|
1218
973
|
* @format GUID
|
|
1219
974
|
*/
|
|
1220
|
-
anonymousVisitorId?: string;
|
|
975
|
+
anonymousVisitorId?: string;
|
|
976
|
+
/**
|
|
977
|
+
* ID of a site visitor that has logged in to the site.
|
|
978
|
+
* @format GUID
|
|
979
|
+
*/
|
|
980
|
+
memberId?: string;
|
|
981
|
+
/**
|
|
982
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
983
|
+
* @format GUID
|
|
984
|
+
*/
|
|
985
|
+
wixUserId?: string;
|
|
986
|
+
/**
|
|
987
|
+
* ID of an app.
|
|
988
|
+
* @format GUID
|
|
989
|
+
*/
|
|
990
|
+
appId?: string;
|
|
991
|
+
/** @readonly */
|
|
992
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
993
|
+
}
|
|
994
|
+
/** @oneof */
|
|
995
|
+
interface IdentificationDataIdOneOf {
|
|
996
|
+
/**
|
|
997
|
+
* ID of a site visitor that has not logged in to the site.
|
|
998
|
+
* @format GUID
|
|
999
|
+
*/
|
|
1000
|
+
anonymousVisitorId?: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* ID of a site visitor that has logged in to the site.
|
|
1003
|
+
* @format GUID
|
|
1004
|
+
*/
|
|
1005
|
+
memberId?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1008
|
+
* @format GUID
|
|
1009
|
+
*/
|
|
1010
|
+
wixUserId?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* ID of an app.
|
|
1013
|
+
* @format GUID
|
|
1014
|
+
*/
|
|
1015
|
+
appId?: string;
|
|
1016
|
+
}
|
|
1017
|
+
declare enum WebhookIdentityType {
|
|
1018
|
+
UNKNOWN = "UNKNOWN",
|
|
1019
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1020
|
+
MEMBER = "MEMBER",
|
|
1021
|
+
WIX_USER = "WIX_USER",
|
|
1022
|
+
APP = "APP"
|
|
1023
|
+
}
|
|
1024
|
+
/** @enumType */
|
|
1025
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1026
|
+
interface AccountInfo {
|
|
1027
|
+
/**
|
|
1028
|
+
* ID of the Wix account associated with the event.
|
|
1029
|
+
* @format GUID
|
|
1030
|
+
*/
|
|
1031
|
+
accountId?: string | null;
|
|
1032
|
+
/**
|
|
1033
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1034
|
+
* @format GUID
|
|
1035
|
+
*/
|
|
1036
|
+
parentAccountId?: string | null;
|
|
1037
|
+
/**
|
|
1038
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1039
|
+
* @format GUID
|
|
1040
|
+
*/
|
|
1041
|
+
siteId?: string | null;
|
|
1042
|
+
}
|
|
1043
|
+
interface EstimateFilterSizeRequest {
|
|
1044
|
+
/** Contacts filter expression. */
|
|
1045
|
+
filter?: Record<string, any> | null;
|
|
1046
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1047
|
+
activeContactsOnly?: boolean;
|
|
1048
|
+
/**
|
|
1049
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1050
|
+
* @minLength 1
|
|
1051
|
+
* @maxLength 100
|
|
1052
|
+
*/
|
|
1053
|
+
search?: string | null;
|
|
1054
|
+
}
|
|
1055
|
+
interface EstimateFilterSizeResponse {
|
|
1056
|
+
/** Mailing list size estimation. */
|
|
1057
|
+
estimation?: number;
|
|
1058
|
+
}
|
|
1059
|
+
interface EstimateAudienceSizeRequest {
|
|
1060
|
+
/**
|
|
1061
|
+
* Contact IDs of a campaign audience.
|
|
1062
|
+
* @format GUID
|
|
1063
|
+
*/
|
|
1064
|
+
contactIds?: string[];
|
|
1065
|
+
/** Label IDs of a campaign audience. */
|
|
1066
|
+
labelIds?: string[];
|
|
1067
|
+
/** Contacts filter expression (json). */
|
|
1068
|
+
contactsFilter?: Record<string, any> | null;
|
|
1069
|
+
/**
|
|
1070
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1071
|
+
* @minLength 1
|
|
1072
|
+
* @maxLength 100
|
|
1073
|
+
*/
|
|
1074
|
+
search?: string | null;
|
|
1221
1075
|
/**
|
|
1222
|
-
*
|
|
1076
|
+
* Segment ids of a campaign audience.
|
|
1223
1077
|
* @format GUID
|
|
1224
1078
|
*/
|
|
1225
|
-
|
|
1079
|
+
segmentIds?: string[];
|
|
1080
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1081
|
+
activeContactsOnly?: boolean;
|
|
1226
1082
|
/**
|
|
1227
|
-
*
|
|
1083
|
+
* Id of a campaign that is to be resent.
|
|
1228
1084
|
* @format GUID
|
|
1229
1085
|
*/
|
|
1230
|
-
|
|
1086
|
+
resendCampaignId?: string | null;
|
|
1087
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1088
|
+
withTotal?: boolean;
|
|
1089
|
+
}
|
|
1090
|
+
interface EstimateAudienceSizeResponse {
|
|
1091
|
+
/** Audience size (estimated number of emails to be sent). */
|
|
1092
|
+
estimation?: number;
|
|
1093
|
+
/** Total number of contacts in provided audience (optional). */
|
|
1094
|
+
total?: number | null;
|
|
1095
|
+
}
|
|
1096
|
+
interface ReconcileContactRequest {
|
|
1231
1097
|
/**
|
|
1232
|
-
*
|
|
1233
|
-
* @format
|
|
1098
|
+
* Email address of the contact.
|
|
1099
|
+
* @format EMAIL
|
|
1234
1100
|
*/
|
|
1235
|
-
|
|
1236
|
-
/** @readonly */
|
|
1237
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1101
|
+
emailAddress?: string;
|
|
1238
1102
|
}
|
|
1239
|
-
|
|
1240
|
-
|
|
1103
|
+
interface ReconcileContactResponse {
|
|
1104
|
+
/** Created or retrieved contact. */
|
|
1105
|
+
contact?: Contact;
|
|
1106
|
+
}
|
|
1107
|
+
interface Contact {
|
|
1241
1108
|
/**
|
|
1242
|
-
* ID of
|
|
1109
|
+
* Unique ID of the contact entity.
|
|
1243
1110
|
* @format GUID
|
|
1244
1111
|
*/
|
|
1245
|
-
|
|
1112
|
+
_id?: string;
|
|
1246
1113
|
/**
|
|
1247
|
-
*
|
|
1248
|
-
* @format
|
|
1114
|
+
* Primary email address of the contact.
|
|
1115
|
+
* @format EMAIL
|
|
1249
1116
|
*/
|
|
1250
|
-
|
|
1117
|
+
emailAddress?: string;
|
|
1251
1118
|
/**
|
|
1252
|
-
*
|
|
1253
|
-
* @
|
|
1119
|
+
* Full name of the contact (optional).
|
|
1120
|
+
* @maxLength 100
|
|
1254
1121
|
*/
|
|
1255
|
-
|
|
1122
|
+
fullName?: string | null;
|
|
1256
1123
|
/**
|
|
1257
|
-
*
|
|
1258
|
-
* @format
|
|
1124
|
+
* Profile picture of the contact (optional).
|
|
1125
|
+
* @format WEB_URL
|
|
1126
|
+
* @maxLength 2048
|
|
1259
1127
|
*/
|
|
1260
|
-
|
|
1261
|
-
}
|
|
1262
|
-
declare enum WebhookIdentityType {
|
|
1263
|
-
UNKNOWN = "UNKNOWN",
|
|
1264
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1265
|
-
MEMBER = "MEMBER",
|
|
1266
|
-
WIX_USER = "WIX_USER",
|
|
1267
|
-
APP = "APP"
|
|
1128
|
+
pictureUrl?: string | null;
|
|
1268
1129
|
}
|
|
1269
|
-
|
|
1270
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1271
|
-
interface AccountDetails {
|
|
1130
|
+
interface SearchContactsRequest {
|
|
1272
1131
|
/**
|
|
1273
|
-
*
|
|
1274
|
-
* @
|
|
1132
|
+
* Text to search contacts by - can search by name or email address.
|
|
1133
|
+
* @maxLength 100
|
|
1275
1134
|
*/
|
|
1276
|
-
|
|
1135
|
+
searchTerm?: string;
|
|
1136
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1137
|
+
activeContactsOnly?: boolean;
|
|
1277
1138
|
/**
|
|
1278
|
-
*
|
|
1279
|
-
* @
|
|
1139
|
+
* Page size (default 50, max 1000).
|
|
1140
|
+
* @max 1000
|
|
1280
1141
|
*/
|
|
1281
|
-
|
|
1142
|
+
pageSize?: number | null;
|
|
1143
|
+
}
|
|
1144
|
+
interface SearchContactsResponse {
|
|
1145
|
+
/** Search results. */
|
|
1146
|
+
contacts?: Contact[];
|
|
1147
|
+
}
|
|
1148
|
+
interface GetLabelsRequest {
|
|
1149
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1150
|
+
activeContactsOnly?: boolean;
|
|
1151
|
+
}
|
|
1152
|
+
interface GetLabelsResponse {
|
|
1153
|
+
/** Returned labels with contact counts. */
|
|
1154
|
+
labels?: Label[];
|
|
1155
|
+
}
|
|
1156
|
+
interface Label {
|
|
1282
1157
|
/**
|
|
1283
|
-
* ID of the
|
|
1284
|
-
* @
|
|
1158
|
+
* Unique ID of the label entity.
|
|
1159
|
+
* @maxLength 100
|
|
1285
1160
|
*/
|
|
1286
|
-
|
|
1161
|
+
_id?: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* Name of the label.
|
|
1164
|
+
* @maxLength 100
|
|
1165
|
+
*/
|
|
1166
|
+
name?: string;
|
|
1167
|
+
/** Amount of contacts assigned to the label. */
|
|
1168
|
+
contactsCount?: number;
|
|
1287
1169
|
}
|
|
1288
|
-
interface
|
|
1170
|
+
interface SubscribeFromLandingPageRequest {
|
|
1289
1171
|
/**
|
|
1290
|
-
* Campaign ID.
|
|
1172
|
+
* Campaign ID that the subscription is happening from.
|
|
1291
1173
|
* @format GUID
|
|
1292
1174
|
*/
|
|
1293
1175
|
campaignId?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Email address that is entered into subscription field.
|
|
1178
|
+
* @format EMAIL
|
|
1179
|
+
*/
|
|
1180
|
+
emailAddress?: string;
|
|
1181
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1182
|
+
consent?: boolean;
|
|
1294
1183
|
}
|
|
1295
|
-
interface
|
|
1296
|
-
/**
|
|
1297
|
-
|
|
1298
|
-
}
|
|
1299
|
-
interface GetDefaultComponentsRequest {
|
|
1300
|
-
}
|
|
1301
|
-
interface GetDefaultComponentsResponse {
|
|
1302
|
-
footer?: Record<string, any> | null;
|
|
1303
|
-
logo?: Record<string, any> | null;
|
|
1304
|
-
follow?: Record<string, any> | null;
|
|
1184
|
+
interface SubscribeFromLandingPageResponse {
|
|
1185
|
+
/** @format GUID */
|
|
1186
|
+
contactId?: string;
|
|
1305
1187
|
}
|
|
1306
1188
|
interface ValidateLinkRequest {
|
|
1307
1189
|
/**
|
|
@@ -1325,150 +1207,268 @@ interface ValidateHtmlLinksResponse {
|
|
|
1325
1207
|
/** Non-valid links. */
|
|
1326
1208
|
blacklistedLinks?: string[];
|
|
1327
1209
|
}
|
|
1328
|
-
interface
|
|
1329
|
-
/** Contacts filter expression. */
|
|
1330
|
-
filter?: Record<string, any> | null;
|
|
1331
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1332
|
-
activeContactsOnly?: boolean;
|
|
1210
|
+
interface GetCampaignMappingRequest {
|
|
1333
1211
|
/**
|
|
1334
|
-
*
|
|
1335
|
-
* @
|
|
1336
|
-
* @maxLength 100
|
|
1212
|
+
* rule ID in automations
|
|
1213
|
+
* @format GUID
|
|
1337
1214
|
*/
|
|
1338
|
-
|
|
1215
|
+
automationRuleId?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* template ID configured for the automation
|
|
1218
|
+
* @format GUID
|
|
1219
|
+
*/
|
|
1220
|
+
templateId?: string;
|
|
1339
1221
|
}
|
|
1340
|
-
interface
|
|
1341
|
-
/**
|
|
1342
|
-
|
|
1222
|
+
interface GetCampaignMappingResponse {
|
|
1223
|
+
/** @format GUID */
|
|
1224
|
+
campaignId?: string;
|
|
1343
1225
|
}
|
|
1344
|
-
interface
|
|
1226
|
+
interface UpsertTranslationRequest {
|
|
1345
1227
|
/**
|
|
1346
|
-
*
|
|
1228
|
+
* Campaign ID.
|
|
1347
1229
|
* @format GUID
|
|
1348
1230
|
*/
|
|
1349
|
-
|
|
1350
|
-
/**
|
|
1351
|
-
|
|
1352
|
-
/** Contacts filter expression (json). */
|
|
1353
|
-
contactsFilter?: Record<string, any> | null;
|
|
1231
|
+
campaignId?: string;
|
|
1232
|
+
/** Composer data. */
|
|
1233
|
+
composer?: Composer;
|
|
1354
1234
|
/**
|
|
1355
|
-
*
|
|
1356
|
-
* @
|
|
1357
|
-
* @maxLength 100
|
|
1235
|
+
* Translation language (optional, default value "EN").
|
|
1236
|
+
* @format LANGUAGE
|
|
1358
1237
|
*/
|
|
1359
|
-
|
|
1238
|
+
language?: string | null;
|
|
1360
1239
|
/**
|
|
1361
|
-
*
|
|
1240
|
+
* For BI event [36:1031] only (optional, default value "n/a").
|
|
1362
1241
|
* @format GUID
|
|
1363
1242
|
*/
|
|
1364
|
-
|
|
1365
|
-
/** Should
|
|
1366
|
-
|
|
1243
|
+
automationRuleId?: string | null;
|
|
1244
|
+
/** Should campaign also be published or not (default value "false"). */
|
|
1245
|
+
publish?: boolean;
|
|
1367
1246
|
/**
|
|
1368
|
-
*
|
|
1247
|
+
* Campaign subject (optional).
|
|
1248
|
+
* @maxLength 1000
|
|
1249
|
+
*/
|
|
1250
|
+
emailSubject?: string | null;
|
|
1251
|
+
/**
|
|
1252
|
+
* Campaign preheader (optional).
|
|
1253
|
+
* @maxLength 1000
|
|
1254
|
+
*/
|
|
1255
|
+
emailPreheader?: string | null;
|
|
1256
|
+
}
|
|
1257
|
+
interface UpsertTranslationResponse {
|
|
1258
|
+
}
|
|
1259
|
+
interface GetUsedPlaceholderKeysRequest {
|
|
1260
|
+
/**
|
|
1261
|
+
* Campaign ID.
|
|
1369
1262
|
* @format GUID
|
|
1370
1263
|
*/
|
|
1371
|
-
|
|
1372
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1373
|
-
withTotal?: boolean;
|
|
1264
|
+
campaignId?: string;
|
|
1374
1265
|
}
|
|
1375
|
-
interface
|
|
1376
|
-
/**
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1266
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
1267
|
+
/**
|
|
1268
|
+
* Keys of placeholders used in the automation.
|
|
1269
|
+
* @maxLength 200
|
|
1270
|
+
* @maxSize 300
|
|
1271
|
+
*/
|
|
1272
|
+
placeholderKeys?: string[];
|
|
1273
|
+
}
|
|
1274
|
+
interface LookupCampaignMappingRequest {
|
|
1275
|
+
/**
|
|
1276
|
+
* rule ID in automations
|
|
1277
|
+
* @format GUID
|
|
1278
|
+
*/
|
|
1279
|
+
automationRuleId?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* template ID configured for the automation
|
|
1282
|
+
* @format GUID
|
|
1283
|
+
*/
|
|
1284
|
+
templateId?: string;
|
|
1285
|
+
}
|
|
1286
|
+
interface LookupCampaignMappingResponse {
|
|
1287
|
+
/** @format GUID */
|
|
1288
|
+
campaignId?: string | null;
|
|
1289
|
+
}
|
|
1290
|
+
interface UpsertAutomationTranslatorContentRequest {
|
|
1291
|
+
/**
|
|
1292
|
+
* Campaign ID that the content belongs to
|
|
1293
|
+
* @format GUID
|
|
1294
|
+
*/
|
|
1295
|
+
campaignId?: string;
|
|
1296
|
+
/** Automation translator content */
|
|
1297
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
1298
|
+
}
|
|
1299
|
+
/** Automation Translator Content */
|
|
1300
|
+
interface AutomationTranslatorContent {
|
|
1301
|
+
/**
|
|
1302
|
+
* AutomationTranslatorContent ID
|
|
1303
|
+
* @minLength 1
|
|
1304
|
+
* @maxLength 256
|
|
1305
|
+
* @immutable
|
|
1306
|
+
*/
|
|
1307
|
+
_id?: string;
|
|
1308
|
+
/**
|
|
1309
|
+
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
1310
|
+
* @minLength 1
|
|
1311
|
+
* @maxLength 800000
|
|
1312
|
+
*/
|
|
1313
|
+
json?: string;
|
|
1380
1314
|
}
|
|
1381
|
-
interface
|
|
1315
|
+
interface UpsertAutomationTranslatorContentResponse {
|
|
1316
|
+
}
|
|
1317
|
+
interface GetAutomationTranslatorContentRequest {
|
|
1382
1318
|
/**
|
|
1383
|
-
*
|
|
1384
|
-
* @format
|
|
1319
|
+
* Campaign ID
|
|
1320
|
+
* @format GUID
|
|
1385
1321
|
*/
|
|
1386
|
-
|
|
1322
|
+
campaignId?: string;
|
|
1387
1323
|
}
|
|
1388
|
-
interface
|
|
1389
|
-
/**
|
|
1390
|
-
|
|
1324
|
+
interface GetAutomationTranslatorContentResponse {
|
|
1325
|
+
/** Automation translator content */
|
|
1326
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
1391
1327
|
}
|
|
1392
|
-
interface
|
|
1328
|
+
interface SendTestBulkRequest {
|
|
1393
1329
|
/**
|
|
1394
|
-
*
|
|
1330
|
+
* Campaign ID
|
|
1395
1331
|
* @format GUID
|
|
1396
1332
|
*/
|
|
1397
|
-
|
|
1333
|
+
campaignId?: string;
|
|
1398
1334
|
/**
|
|
1399
|
-
*
|
|
1335
|
+
* Recipient email address
|
|
1400
1336
|
* @format EMAIL
|
|
1401
1337
|
*/
|
|
1402
|
-
|
|
1338
|
+
toEmailAddress?: string;
|
|
1339
|
+
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
1340
|
+
placeholders?: Record<string, PlaceholderContent>;
|
|
1403
1341
|
/**
|
|
1404
|
-
*
|
|
1342
|
+
* Sender from name
|
|
1405
1343
|
* @maxLength 100
|
|
1406
1344
|
*/
|
|
1407
|
-
|
|
1345
|
+
fromName?: string | null;
|
|
1408
1346
|
/**
|
|
1409
|
-
*
|
|
1410
|
-
* @format
|
|
1411
|
-
* @maxLength 2048
|
|
1347
|
+
* Reply-to email address
|
|
1348
|
+
* @format EMAIL
|
|
1412
1349
|
*/
|
|
1413
|
-
|
|
1414
|
-
}
|
|
1415
|
-
interface SearchContactsRequest {
|
|
1350
|
+
replyToEmailAddress?: string | null;
|
|
1416
1351
|
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @
|
|
1352
|
+
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
1353
|
+
* @format LANGUAGE
|
|
1419
1354
|
*/
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1355
|
+
language?: string | null;
|
|
1356
|
+
}
|
|
1357
|
+
interface SendTestBulkResponse {
|
|
1358
|
+
}
|
|
1359
|
+
interface ListStatisticsRequest {
|
|
1423
1360
|
/**
|
|
1424
|
-
*
|
|
1425
|
-
* @
|
|
1361
|
+
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1362
|
+
* @format GUID
|
|
1363
|
+
* @minSize 1
|
|
1364
|
+
* @maxSize 100
|
|
1426
1365
|
*/
|
|
1427
|
-
|
|
1366
|
+
campaignIds: string[];
|
|
1428
1367
|
}
|
|
1429
|
-
interface
|
|
1430
|
-
/**
|
|
1431
|
-
|
|
1368
|
+
interface ListStatisticsResponse {
|
|
1369
|
+
/** List of statistics. */
|
|
1370
|
+
statistics?: CampaignStatisticsContainer[];
|
|
1432
1371
|
}
|
|
1433
|
-
interface
|
|
1434
|
-
/**
|
|
1435
|
-
|
|
1372
|
+
interface CampaignStatisticsContainer {
|
|
1373
|
+
/**
|
|
1374
|
+
* Campaign ID.
|
|
1375
|
+
* @format GUID
|
|
1376
|
+
*/
|
|
1377
|
+
campaignId?: string;
|
|
1378
|
+
/** Landing page statistics. */
|
|
1379
|
+
landingPage?: LandingPageStatistics;
|
|
1380
|
+
/** Email campaign statistics. */
|
|
1381
|
+
email?: DistributionStatistics;
|
|
1436
1382
|
}
|
|
1437
|
-
interface
|
|
1438
|
-
/**
|
|
1439
|
-
|
|
1383
|
+
interface ListRecipientsRequest {
|
|
1384
|
+
/**
|
|
1385
|
+
* Campaign ID.
|
|
1386
|
+
* @format GUID
|
|
1387
|
+
*/
|
|
1388
|
+
campaignId: string;
|
|
1389
|
+
/** Email activity to filter. */
|
|
1390
|
+
activity: RecipientsActivityEnumWithLiterals;
|
|
1391
|
+
/** Pagination options. */
|
|
1392
|
+
paging?: CursorPaging;
|
|
1440
1393
|
}
|
|
1441
|
-
|
|
1394
|
+
declare enum RecipientsActivityEnum {
|
|
1395
|
+
UNKNOWN = "UNKNOWN",
|
|
1396
|
+
DELIVERED = "DELIVERED",
|
|
1397
|
+
OPENED = "OPENED",
|
|
1398
|
+
CLICKED = "CLICKED",
|
|
1399
|
+
BOUNCED = "BOUNCED",
|
|
1400
|
+
NOT_SENT = "NOT_SENT",
|
|
1401
|
+
SENT = "SENT",
|
|
1402
|
+
NOT_OPENED = "NOT_OPENED"
|
|
1403
|
+
}
|
|
1404
|
+
/** @enumType */
|
|
1405
|
+
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
1406
|
+
interface CursorPaging {
|
|
1442
1407
|
/**
|
|
1443
|
-
*
|
|
1444
|
-
* @
|
|
1408
|
+
* Number of items to load.
|
|
1409
|
+
* @max 1000
|
|
1445
1410
|
*/
|
|
1446
|
-
|
|
1411
|
+
limit?: number | null;
|
|
1447
1412
|
/**
|
|
1448
|
-
*
|
|
1449
|
-
*
|
|
1413
|
+
* Pointer to the next or previous page in the list of results.
|
|
1414
|
+
*
|
|
1415
|
+
* You can get the relevant cursor token
|
|
1416
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1417
|
+
* Not relevant for the first request.
|
|
1418
|
+
* @maxLength 1000
|
|
1450
1419
|
*/
|
|
1451
|
-
|
|
1452
|
-
/** Amount of contacts assigned to the label. */
|
|
1453
|
-
contactsCount?: number;
|
|
1420
|
+
cursor?: string | null;
|
|
1454
1421
|
}
|
|
1455
|
-
interface
|
|
1422
|
+
interface ListRecipientsResponse {
|
|
1423
|
+
/** List of recipients. */
|
|
1424
|
+
recipients?: CampaignRecipientDetails[];
|
|
1425
|
+
/** Details on the paged set of returned results. */
|
|
1426
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1427
|
+
}
|
|
1428
|
+
interface CampaignRecipientDetails {
|
|
1456
1429
|
/**
|
|
1457
|
-
*
|
|
1430
|
+
* Contact ID.
|
|
1458
1431
|
* @format GUID
|
|
1459
1432
|
*/
|
|
1460
|
-
|
|
1433
|
+
contactId?: string;
|
|
1434
|
+
/** Date and time of the last activity. */
|
|
1435
|
+
lastActivityDate?: Date | null;
|
|
1461
1436
|
/**
|
|
1462
|
-
*
|
|
1437
|
+
* Primary email address of the contact.
|
|
1463
1438
|
* @format EMAIL
|
|
1464
1439
|
*/
|
|
1465
1440
|
emailAddress?: string;
|
|
1466
|
-
/**
|
|
1467
|
-
|
|
1441
|
+
/**
|
|
1442
|
+
* Full name of the contact (optional).
|
|
1443
|
+
* @maxLength 100
|
|
1444
|
+
*/
|
|
1445
|
+
fullName?: string | null;
|
|
1446
|
+
/** Is this contact currently deleted from the site or not. */
|
|
1447
|
+
contactDeleted?: boolean;
|
|
1468
1448
|
}
|
|
1469
|
-
interface
|
|
1470
|
-
/**
|
|
1471
|
-
|
|
1449
|
+
interface PagingMetadataV2 {
|
|
1450
|
+
/** Number of items returned in the response. */
|
|
1451
|
+
count?: number | null;
|
|
1452
|
+
/** Offset that was requested. */
|
|
1453
|
+
offset?: number | null;
|
|
1454
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1455
|
+
total?: number | null;
|
|
1456
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1457
|
+
tooManyToCount?: boolean | null;
|
|
1458
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1459
|
+
cursors?: Cursors;
|
|
1460
|
+
}
|
|
1461
|
+
interface Cursors {
|
|
1462
|
+
/**
|
|
1463
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1464
|
+
* @maxLength 16000
|
|
1465
|
+
*/
|
|
1466
|
+
next?: string | null;
|
|
1467
|
+
/**
|
|
1468
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1469
|
+
* @maxLength 16000
|
|
1470
|
+
*/
|
|
1471
|
+
prev?: string | null;
|
|
1472
1472
|
}
|
|
1473
1473
|
/** @docsIgnore */
|
|
1474
1474
|
type PublishCampaignApplicationErrors = {
|
|
@@ -1538,6 +1538,8 @@ interface CampaignDistributedEnvelope {
|
|
|
1538
1538
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1539
1539
|
* @permissionScope Access Verticals by Automations
|
|
1540
1540
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1541
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1542
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1541
1543
|
* @permissionScope Set Up Automations
|
|
1542
1544
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1543
1545
|
* @permissionScope Read Email Marketing
|
|
@@ -1561,6 +1563,8 @@ interface CampaignPausedEnvelope {
|
|
|
1561
1563
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1562
1564
|
* @permissionScope Access Verticals by Automations
|
|
1563
1565
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1566
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1567
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1564
1568
|
* @permissionScope Set Up Automations
|
|
1565
1569
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1566
1570
|
* @permissionScope Read Email Marketing
|
|
@@ -1584,6 +1588,8 @@ interface CampaignPublishedEnvelope {
|
|
|
1584
1588
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1585
1589
|
* @permissionScope Access Verticals by Automations
|
|
1586
1590
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1591
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1592
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1587
1593
|
* @permissionScope Set Up Automations
|
|
1588
1594
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1589
1595
|
* @permissionScope Read Email Marketing
|
|
@@ -1607,6 +1613,8 @@ interface CampaignRejectedEnvelope {
|
|
|
1607
1613
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1608
1614
|
* @permissionScope Access Verticals by Automations
|
|
1609
1615
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1616
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1617
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1610
1618
|
* @permissionScope Set Up Automations
|
|
1611
1619
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1612
1620
|
* @permissionScope Read Email Marketing
|
|
@@ -1630,6 +1638,8 @@ interface CampaignScheduledEnvelope {
|
|
|
1630
1638
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1631
1639
|
* @permissionScope Access Verticals by Automations
|
|
1632
1640
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1641
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1642
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1633
1643
|
* @permissionScope Set Up Automations
|
|
1634
1644
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1635
1645
|
* @permissionScope Read Email Marketing
|
|
@@ -1653,6 +1663,8 @@ interface CampaignTerminatedEnvelope {
|
|
|
1653
1663
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1654
1664
|
* @permissionScope Access Verticals by Automations
|
|
1655
1665
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1666
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1667
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1656
1668
|
* @permissionScope Set Up Automations
|
|
1657
1669
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1658
1670
|
* @permissionScope Read Email Marketing
|
|
@@ -1676,6 +1688,8 @@ interface CampaignCreatedEnvelope {
|
|
|
1676
1688
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1677
1689
|
* @permissionScope Access Verticals by Automations
|
|
1678
1690
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1691
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1692
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1679
1693
|
* @permissionScope Set Up Automations
|
|
1680
1694
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1681
1695
|
* @permissionScope Read Email Marketing
|
|
@@ -1698,6 +1712,8 @@ interface CampaignDeletedEnvelope {
|
|
|
1698
1712
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1699
1713
|
* @permissionScope Access Verticals by Automations
|
|
1700
1714
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1715
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1716
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1701
1717
|
* @permissionScope Set Up Automations
|
|
1702
1718
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1703
1719
|
* @permissionScope Read Email Marketing
|
|
@@ -1721,6 +1737,8 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1721
1737
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1722
1738
|
* @permissionScope Access Verticals by Automations
|
|
1723
1739
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1740
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1741
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1724
1742
|
* @permissionScope Set Up Automations
|
|
1725
1743
|
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1726
1744
|
* @permissionScope Read Email Marketing
|
|
@@ -1734,46 +1752,6 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1734
1752
|
* @slug email_activity_updated
|
|
1735
1753
|
*/
|
|
1736
1754
|
declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
|
|
1737
|
-
/**
|
|
1738
|
-
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1739
|
-
*
|
|
1740
|
-
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1741
|
-
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1742
|
-
*
|
|
1743
|
-
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1744
|
-
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1745
|
-
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1746
|
-
* @public
|
|
1747
|
-
* @requiredField campaignIds
|
|
1748
|
-
* @permissionId Shoutout.Read
|
|
1749
|
-
* @applicableIdentity APP
|
|
1750
|
-
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1751
|
-
*/
|
|
1752
|
-
declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`, 5>>;
|
|
1753
|
-
/**
|
|
1754
|
-
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1755
|
-
*
|
|
1756
|
-
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1757
|
-
*
|
|
1758
|
-
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1759
|
-
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1760
|
-
*
|
|
1761
|
-
* If no `activity` is included, this method returns an error.
|
|
1762
|
-
* @param campaignId - Campaign ID.
|
|
1763
|
-
* @param activity - Email activity to filter.
|
|
1764
|
-
* @public
|
|
1765
|
-
* @requiredField activity
|
|
1766
|
-
* @requiredField campaignId
|
|
1767
|
-
* @param options - Options to use when getting the list of recipients.
|
|
1768
|
-
* @permissionId Shoutout.Read
|
|
1769
|
-
* @applicableIdentity APP
|
|
1770
|
-
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1771
|
-
*/
|
|
1772
|
-
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1773
|
-
interface ListRecipientsOptions {
|
|
1774
|
-
/** Pagination options. */
|
|
1775
|
-
paging?: CursorPaging;
|
|
1776
|
-
}
|
|
1777
1755
|
/**
|
|
1778
1756
|
* Retrieves information about an email campaign.
|
|
1779
1757
|
* @param campaignId - Campaign ID.
|
|
@@ -1948,5 +1926,45 @@ declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLin
|
|
|
1948
1926
|
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
|
|
1949
1927
|
*/
|
|
1950
1928
|
declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`, 2>>;
|
|
1929
|
+
/**
|
|
1930
|
+
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1931
|
+
*
|
|
1932
|
+
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1933
|
+
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1934
|
+
*
|
|
1935
|
+
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1936
|
+
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1937
|
+
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1938
|
+
* @public
|
|
1939
|
+
* @requiredField campaignIds
|
|
1940
|
+
* @permissionId Shoutout.Read
|
|
1941
|
+
* @applicableIdentity APP
|
|
1942
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1943
|
+
*/
|
|
1944
|
+
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>>;
|
|
1945
|
+
/**
|
|
1946
|
+
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1947
|
+
*
|
|
1948
|
+
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1949
|
+
*
|
|
1950
|
+
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1951
|
+
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1952
|
+
*
|
|
1953
|
+
* If no `activity` is included, this method returns an error.
|
|
1954
|
+
* @param campaignId - Campaign ID.
|
|
1955
|
+
* @param activity - Email activity to filter.
|
|
1956
|
+
* @public
|
|
1957
|
+
* @requiredField activity
|
|
1958
|
+
* @requiredField campaignId
|
|
1959
|
+
* @param options - Options to use when getting the list of recipients.
|
|
1960
|
+
* @permissionId Shoutout.Read
|
|
1961
|
+
* @applicableIdentity APP
|
|
1962
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1963
|
+
*/
|
|
1964
|
+
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`, 4>>;
|
|
1965
|
+
interface ListRecipientsOptions {
|
|
1966
|
+
/** Pagination options. */
|
|
1967
|
+
paging?: CursorPaging;
|
|
1968
|
+
}
|
|
1951
1969
|
|
|
1952
|
-
export { type
|
|
1970
|
+
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 };
|