@wix/auto_sdk_email-marketing_campaigns 1.0.25 → 1.0.27
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/{internal → cjs}/index.d.ts +64 -37
- package/build/{internal → cjs}/index.js +187 -68
- package/build/cjs/index.js.map +1 -0
- package/build/{email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.mts → cjs/index.typings.d.ts} +801 -253
- package/build/cjs/index.typings.js +1048 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/{internal → cjs}/meta.d.ts +137 -112
- package/build/{meta.js → cjs/meta.js} +129 -36
- package/build/cjs/meta.js.map +1 -0
- package/build/{internal → es}/index.d.mts +64 -37
- package/build/{internal → es}/index.mjs +184 -67
- package/build/es/index.mjs.map +1 -0
- package/build/{email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.ts → es/index.typings.d.mts} +801 -253
- package/build/es/index.typings.mjs +1001 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/{internal → es}/meta.d.mts +137 -112
- package/build/{internal → es}/meta.mjs +126 -35
- package/build/es/meta.mjs.map +1 -0
- package/build/{index.d.ts → internal/cjs/index.d.ts} +64 -37
- package/build/{index.js → internal/cjs/index.js} +187 -68
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/{email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.ts → cjs/index.typings.d.ts} +801 -253
- package/build/internal/cjs/index.typings.js +1048 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/{meta.d.ts → internal/cjs/meta.d.ts} +137 -112
- package/build/internal/{meta.js → cjs/meta.js} +129 -36
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/{index.d.mts → internal/es/index.d.mts} +64 -37
- package/build/{index.mjs → internal/es/index.mjs} +184 -67
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/{email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.mts → es/index.typings.d.mts} +801 -253
- package/build/internal/es/index.typings.mjs +1001 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/{meta.d.mts → internal/es/meta.d.mts} +137 -112
- package/build/{meta.mjs → internal/es/meta.mjs} +126 -35
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +11 -11
- package/build/index.js.map +0 -1
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.js.map +0 -1
- package/build/meta.mjs.map +0 -1
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface Campaign {
|
|
2
4
|
/**
|
|
3
5
|
* Campaign ID.
|
|
@@ -195,6 +197,8 @@ declare enum CampaignSendingStateEnum {
|
|
|
195
197
|
/** Campaign was sent. */
|
|
196
198
|
SENT = "SENT"
|
|
197
199
|
}
|
|
200
|
+
/** @enumType */
|
|
201
|
+
type CampaignSendingStateEnumWithLiterals = CampaignSendingStateEnum | 'DRAFT' | 'REVIEW' | 'REJECTED' | 'SCHEDULED' | 'PAUSED' | 'PUBLISHED' | 'SENDING' | 'PARTIALLY_SENT' | 'SENT';
|
|
198
202
|
declare enum CampaignTypeEnum {
|
|
199
203
|
UNKNOWN = "UNKNOWN",
|
|
200
204
|
/** Email marketing campaign. */
|
|
@@ -206,6 +210,364 @@ declare enum CampaignTypeEnum {
|
|
|
206
210
|
/** Triggered email. */
|
|
207
211
|
TRIGGERED = "TRIGGERED"
|
|
208
212
|
}
|
|
213
|
+
/** @enumType */
|
|
214
|
+
type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
|
|
215
|
+
interface ListStatisticsRequest {
|
|
216
|
+
/**
|
|
217
|
+
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
218
|
+
* @format GUID
|
|
219
|
+
* @minSize 1
|
|
220
|
+
* @maxSize 100
|
|
221
|
+
*/
|
|
222
|
+
campaignIds: string[];
|
|
223
|
+
}
|
|
224
|
+
interface ListStatisticsResponse {
|
|
225
|
+
/** List of statistics. */
|
|
226
|
+
statistics?: CampaignStatisticsContainer[];
|
|
227
|
+
}
|
|
228
|
+
interface CampaignStatisticsContainer {
|
|
229
|
+
/**
|
|
230
|
+
* Campaign ID.
|
|
231
|
+
* @format GUID
|
|
232
|
+
*/
|
|
233
|
+
campaignId?: string;
|
|
234
|
+
/** Landing page statistics. */
|
|
235
|
+
landingPage?: LandingPageStatistics;
|
|
236
|
+
/** Email campaign statistics. */
|
|
237
|
+
email?: DistributionStatistics;
|
|
238
|
+
}
|
|
239
|
+
interface ListRecipientsRequest {
|
|
240
|
+
/**
|
|
241
|
+
* Campaign ID.
|
|
242
|
+
* @format GUID
|
|
243
|
+
*/
|
|
244
|
+
campaignId: string;
|
|
245
|
+
/** Email activity to filter. */
|
|
246
|
+
activity: RecipientsActivityEnumWithLiterals;
|
|
247
|
+
/** Pagination options. */
|
|
248
|
+
paging?: CursorPaging;
|
|
249
|
+
}
|
|
250
|
+
declare enum RecipientsActivityEnum {
|
|
251
|
+
UNKNOWN = "UNKNOWN",
|
|
252
|
+
DELIVERED = "DELIVERED",
|
|
253
|
+
OPENED = "OPENED",
|
|
254
|
+
CLICKED = "CLICKED",
|
|
255
|
+
BOUNCED = "BOUNCED",
|
|
256
|
+
NOT_SENT = "NOT_SENT",
|
|
257
|
+
SENT = "SENT",
|
|
258
|
+
NOT_OPENED = "NOT_OPENED"
|
|
259
|
+
}
|
|
260
|
+
/** @enumType */
|
|
261
|
+
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
262
|
+
interface CursorPaging {
|
|
263
|
+
/**
|
|
264
|
+
* Number of items to load.
|
|
265
|
+
* @max 1000
|
|
266
|
+
*/
|
|
267
|
+
limit?: number | null;
|
|
268
|
+
/**
|
|
269
|
+
* Pointer to the next or previous page in the list of results.
|
|
270
|
+
*
|
|
271
|
+
* You can get the relevant cursor token
|
|
272
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
273
|
+
* Not relevant for the first request.
|
|
274
|
+
* @maxLength 1000
|
|
275
|
+
*/
|
|
276
|
+
cursor?: string | null;
|
|
277
|
+
}
|
|
278
|
+
interface ListRecipientsResponse {
|
|
279
|
+
/** List of recipients. */
|
|
280
|
+
recipients?: CampaignRecipientDetails[];
|
|
281
|
+
/** Details on the paged set of returned results. */
|
|
282
|
+
pagingMetadata?: PagingMetadataV2;
|
|
283
|
+
}
|
|
284
|
+
interface CampaignRecipientDetails {
|
|
285
|
+
/**
|
|
286
|
+
* Contact ID.
|
|
287
|
+
* @format GUID
|
|
288
|
+
*/
|
|
289
|
+
contactId?: string;
|
|
290
|
+
/** Date and time of the last activity. */
|
|
291
|
+
lastActivityDate?: Date | null;
|
|
292
|
+
/**
|
|
293
|
+
* Primary email address of the contact.
|
|
294
|
+
* @format EMAIL
|
|
295
|
+
*/
|
|
296
|
+
emailAddress?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Full name of the contact (optional).
|
|
299
|
+
* @maxLength 100
|
|
300
|
+
*/
|
|
301
|
+
fullName?: string | null;
|
|
302
|
+
/** Is this contact currently deleted from the site or not. */
|
|
303
|
+
contactDeleted?: boolean;
|
|
304
|
+
}
|
|
305
|
+
interface PagingMetadataV2 {
|
|
306
|
+
/** Number of items returned in the response. */
|
|
307
|
+
count?: number | null;
|
|
308
|
+
/** Offset that was requested. */
|
|
309
|
+
offset?: number | null;
|
|
310
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
311
|
+
total?: number | null;
|
|
312
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
313
|
+
tooManyToCount?: boolean | null;
|
|
314
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
315
|
+
cursors?: Cursors;
|
|
316
|
+
}
|
|
317
|
+
interface Cursors {
|
|
318
|
+
/**
|
|
319
|
+
* Cursor string pointing to the next page in the list of results.
|
|
320
|
+
* @maxLength 16000
|
|
321
|
+
*/
|
|
322
|
+
next?: string | null;
|
|
323
|
+
/**
|
|
324
|
+
* Cursor pointing to the previous page in the list of results.
|
|
325
|
+
* @maxLength 16000
|
|
326
|
+
*/
|
|
327
|
+
prev?: string | null;
|
|
328
|
+
}
|
|
329
|
+
interface GetCampaignMappingRequest {
|
|
330
|
+
/**
|
|
331
|
+
* rule ID in automations
|
|
332
|
+
* @format GUID
|
|
333
|
+
*/
|
|
334
|
+
automationRuleId?: string;
|
|
335
|
+
/**
|
|
336
|
+
* template ID configured for the automation
|
|
337
|
+
* @format GUID
|
|
338
|
+
*/
|
|
339
|
+
templateId?: string;
|
|
340
|
+
}
|
|
341
|
+
interface GetCampaignMappingResponse {
|
|
342
|
+
/** @format GUID */
|
|
343
|
+
campaignId?: string;
|
|
344
|
+
}
|
|
345
|
+
interface UpsertTranslationRequest {
|
|
346
|
+
/**
|
|
347
|
+
* Campaign ID.
|
|
348
|
+
* @format GUID
|
|
349
|
+
*/
|
|
350
|
+
campaignId?: string;
|
|
351
|
+
/** Composer data. */
|
|
352
|
+
composer?: Composer;
|
|
353
|
+
/**
|
|
354
|
+
* Translation language (optional, default value "EN").
|
|
355
|
+
* @format LANGUAGE
|
|
356
|
+
*/
|
|
357
|
+
language?: string | null;
|
|
358
|
+
/**
|
|
359
|
+
* For BI event [36:1031] only (optional, default value "n/a").
|
|
360
|
+
* @format GUID
|
|
361
|
+
*/
|
|
362
|
+
automationRuleId?: string | null;
|
|
363
|
+
/** Should campaign also be published or not (default value "false"). */
|
|
364
|
+
publish?: boolean;
|
|
365
|
+
/**
|
|
366
|
+
* Campaign subject (optional).
|
|
367
|
+
* @maxLength 1000
|
|
368
|
+
*/
|
|
369
|
+
emailSubject?: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* Campaign preheader (optional).
|
|
372
|
+
* @maxLength 1000
|
|
373
|
+
*/
|
|
374
|
+
emailPreheader?: string | null;
|
|
375
|
+
}
|
|
376
|
+
interface Composer {
|
|
377
|
+
/**
|
|
378
|
+
* Internal data structure for editor/viewer to render the campaign.
|
|
379
|
+
* @maxLength 10000000
|
|
380
|
+
*/
|
|
381
|
+
composerDataJson?: string;
|
|
382
|
+
/** Default values of existing placeholders. */
|
|
383
|
+
defaultValues?: DefaultValues;
|
|
384
|
+
}
|
|
385
|
+
interface DefaultValues {
|
|
386
|
+
/** @maxSize 500 */
|
|
387
|
+
map?: Record<string, string>;
|
|
388
|
+
}
|
|
389
|
+
interface UpsertTranslationResponse {
|
|
390
|
+
}
|
|
391
|
+
interface GetUsedPlaceholderKeysRequest {
|
|
392
|
+
/**
|
|
393
|
+
* Campaign ID.
|
|
394
|
+
* @format GUID
|
|
395
|
+
*/
|
|
396
|
+
campaignId?: string;
|
|
397
|
+
}
|
|
398
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
399
|
+
/**
|
|
400
|
+
* Keys of placeholders used in the automation.
|
|
401
|
+
* @maxLength 200
|
|
402
|
+
* @maxSize 300
|
|
403
|
+
*/
|
|
404
|
+
placeholderKeys?: string[];
|
|
405
|
+
}
|
|
406
|
+
interface LookupCampaignMappingRequest {
|
|
407
|
+
/**
|
|
408
|
+
* rule ID in automations
|
|
409
|
+
* @format GUID
|
|
410
|
+
*/
|
|
411
|
+
automationRuleId?: string;
|
|
412
|
+
/**
|
|
413
|
+
* template ID configured for the automation
|
|
414
|
+
* @format GUID
|
|
415
|
+
*/
|
|
416
|
+
templateId?: string;
|
|
417
|
+
}
|
|
418
|
+
interface LookupCampaignMappingResponse {
|
|
419
|
+
/** @format GUID */
|
|
420
|
+
campaignId?: string | null;
|
|
421
|
+
}
|
|
422
|
+
interface UpsertAutomationTranslatorContentRequest {
|
|
423
|
+
/**
|
|
424
|
+
* Campaign ID that the content belongs to
|
|
425
|
+
* @format GUID
|
|
426
|
+
*/
|
|
427
|
+
campaignId?: string;
|
|
428
|
+
/** Automation translator content */
|
|
429
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
430
|
+
}
|
|
431
|
+
/** Automation Translator Content */
|
|
432
|
+
interface AutomationTranslatorContent {
|
|
433
|
+
/**
|
|
434
|
+
* AutomationTranslatorContent ID
|
|
435
|
+
* @minLength 1
|
|
436
|
+
* @maxLength 256
|
|
437
|
+
* @immutable
|
|
438
|
+
*/
|
|
439
|
+
_id?: string;
|
|
440
|
+
/**
|
|
441
|
+
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
442
|
+
* @minLength 1
|
|
443
|
+
* @maxLength 800000
|
|
444
|
+
*/
|
|
445
|
+
json?: string;
|
|
446
|
+
}
|
|
447
|
+
interface UpsertAutomationTranslatorContentResponse {
|
|
448
|
+
}
|
|
449
|
+
interface GetAutomationTranslatorContentRequest {
|
|
450
|
+
/**
|
|
451
|
+
* Campaign ID
|
|
452
|
+
* @format GUID
|
|
453
|
+
*/
|
|
454
|
+
campaignId?: string;
|
|
455
|
+
}
|
|
456
|
+
interface GetAutomationTranslatorContentResponse {
|
|
457
|
+
/** Automation translator content */
|
|
458
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
459
|
+
}
|
|
460
|
+
interface SendTestBulkRequest {
|
|
461
|
+
/**
|
|
462
|
+
* Campaign ID
|
|
463
|
+
* @format GUID
|
|
464
|
+
*/
|
|
465
|
+
campaignId?: string;
|
|
466
|
+
/**
|
|
467
|
+
* Recipient email address
|
|
468
|
+
* @format EMAIL
|
|
469
|
+
*/
|
|
470
|
+
toEmailAddress?: string;
|
|
471
|
+
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
472
|
+
placeholders?: Record<string, PlaceholderContent>;
|
|
473
|
+
/**
|
|
474
|
+
* Sender from name
|
|
475
|
+
* @maxLength 100
|
|
476
|
+
*/
|
|
477
|
+
fromName?: string | null;
|
|
478
|
+
/**
|
|
479
|
+
* Reply-to email address
|
|
480
|
+
* @format EMAIL
|
|
481
|
+
*/
|
|
482
|
+
replyToEmailAddress?: string | null;
|
|
483
|
+
/**
|
|
484
|
+
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
485
|
+
* @format LANGUAGE
|
|
486
|
+
*/
|
|
487
|
+
language?: string | null;
|
|
488
|
+
}
|
|
489
|
+
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
490
|
+
text?: PlainText;
|
|
491
|
+
html?: Html;
|
|
492
|
+
money?: Money;
|
|
493
|
+
dateTime?: DateTime;
|
|
494
|
+
map?: Map;
|
|
495
|
+
array?: _Array;
|
|
496
|
+
enum?: PlaceholderContentEnum;
|
|
497
|
+
attachment?: Attachment;
|
|
498
|
+
integer?: Integer;
|
|
499
|
+
decimal?: Decimal;
|
|
500
|
+
}
|
|
501
|
+
/** @oneof */
|
|
502
|
+
interface PlaceholderContentValueOneOf {
|
|
503
|
+
text?: PlainText;
|
|
504
|
+
html?: Html;
|
|
505
|
+
money?: Money;
|
|
506
|
+
dateTime?: DateTime;
|
|
507
|
+
map?: Map;
|
|
508
|
+
array?: _Array;
|
|
509
|
+
enum?: PlaceholderContentEnum;
|
|
510
|
+
attachment?: Attachment;
|
|
511
|
+
integer?: Integer;
|
|
512
|
+
decimal?: Decimal;
|
|
513
|
+
}
|
|
514
|
+
interface PlainText {
|
|
515
|
+
text?: string;
|
|
516
|
+
}
|
|
517
|
+
interface Html {
|
|
518
|
+
html?: string;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Money.
|
|
522
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
523
|
+
*/
|
|
524
|
+
interface Money {
|
|
525
|
+
/**
|
|
526
|
+
* 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.
|
|
527
|
+
* @format DECIMAL_VALUE
|
|
528
|
+
*/
|
|
529
|
+
value?: string;
|
|
530
|
+
/**
|
|
531
|
+
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
532
|
+
* @format CURRENCY
|
|
533
|
+
*/
|
|
534
|
+
currency?: string;
|
|
535
|
+
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
536
|
+
formattedValue?: string | null;
|
|
537
|
+
}
|
|
538
|
+
interface DateTime {
|
|
539
|
+
timestamp?: Date | null;
|
|
540
|
+
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
541
|
+
timeZone?: string | null;
|
|
542
|
+
}
|
|
543
|
+
interface Map {
|
|
544
|
+
variables?: Record<string, PlaceholderContent>;
|
|
545
|
+
}
|
|
546
|
+
interface _Array {
|
|
547
|
+
items?: PlaceholderContent[];
|
|
548
|
+
}
|
|
549
|
+
interface PlaceholderContentEnum {
|
|
550
|
+
value?: string;
|
|
551
|
+
translation?: string;
|
|
552
|
+
}
|
|
553
|
+
interface Attachment {
|
|
554
|
+
fileName?: string;
|
|
555
|
+
downloadUrl?: string;
|
|
556
|
+
}
|
|
557
|
+
interface Integer {
|
|
558
|
+
/** min value: -2147483648, max value: 2147483647 */
|
|
559
|
+
value?: number;
|
|
560
|
+
}
|
|
561
|
+
interface Decimal {
|
|
562
|
+
/**
|
|
563
|
+
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
564
|
+
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
565
|
+
* @format DECIMAL_VALUE
|
|
566
|
+
*/
|
|
567
|
+
value?: string;
|
|
568
|
+
}
|
|
569
|
+
interface SendTestBulkResponse {
|
|
570
|
+
}
|
|
209
571
|
interface GetCampaignRequest {
|
|
210
572
|
/**
|
|
211
573
|
* Campaign ID.
|
|
@@ -455,133 +817,53 @@ declare enum ActivityType {
|
|
|
455
817
|
/** Triggered when the email bounces. */
|
|
456
818
|
HARD_BOUNCED = "HARD_BOUNCED"
|
|
457
819
|
}
|
|
458
|
-
/** @enumType */
|
|
459
|
-
type ActivityTypeWithLiterals = ActivityType | 'DELIVERY' | 'CLICK' | 'OPEN' | 'SOFT_BOUNCE' | 'HARD_BOUNCED';
|
|
460
|
-
interface Click {
|
|
461
|
-
/** URL that was clicked. */
|
|
462
|
-
url?: string;
|
|
463
|
-
/** Browser user agent of the recipient. */
|
|
464
|
-
userAgent?: string;
|
|
465
|
-
}
|
|
466
|
-
interface Open {
|
|
467
|
-
/** Browser user agent of the recipient. */
|
|
468
|
-
userAgent?: string;
|
|
469
|
-
}
|
|
470
|
-
interface SoftBounce {
|
|
471
|
-
/** Reason the email soft bounced. */
|
|
472
|
-
reason?: string;
|
|
473
|
-
}
|
|
474
|
-
interface HardBounce {
|
|
475
|
-
/** Reason the email hard bounced. */
|
|
476
|
-
reason?: string;
|
|
477
|
-
}
|
|
478
|
-
interface Scheduled {
|
|
479
|
-
/**
|
|
480
|
-
* ID of the campaign that was scheduled.
|
|
481
|
-
* @format GUID
|
|
482
|
-
*/
|
|
483
|
-
campaignId?: string;
|
|
484
|
-
/** The timestamp campaign is scheduled for. */
|
|
485
|
-
sendAt?: Date | null;
|
|
486
|
-
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
487
|
-
rescheduled?: boolean;
|
|
488
|
-
}
|
|
489
|
-
interface SendTestRequest {
|
|
490
|
-
/**
|
|
491
|
-
* Campaign ID.
|
|
492
|
-
* @format GUID
|
|
493
|
-
*/
|
|
494
|
-
campaignId: string;
|
|
495
|
-
/**
|
|
496
|
-
* Email subject.
|
|
497
|
-
* @maxLength 1000
|
|
498
|
-
*/
|
|
499
|
-
emailSubject?: string | null;
|
|
500
|
-
/**
|
|
501
|
-
* Recipient email address.
|
|
502
|
-
* @format EMAIL
|
|
503
|
-
*/
|
|
504
|
-
toEmailAddress: string;
|
|
505
|
-
}
|
|
506
|
-
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
507
|
-
text?: PlainText;
|
|
508
|
-
html?: Html;
|
|
509
|
-
money?: Money;
|
|
510
|
-
dateTime?: DateTime;
|
|
511
|
-
map?: Map;
|
|
512
|
-
array?: _Array;
|
|
513
|
-
enum?: PlaceholderContentEnum;
|
|
514
|
-
attachment?: Attachment;
|
|
515
|
-
integer?: Integer;
|
|
516
|
-
decimal?: Decimal;
|
|
517
|
-
}
|
|
518
|
-
/** @oneof */
|
|
519
|
-
interface PlaceholderContentValueOneOf {
|
|
520
|
-
text?: PlainText;
|
|
521
|
-
html?: Html;
|
|
522
|
-
money?: Money;
|
|
523
|
-
dateTime?: DateTime;
|
|
524
|
-
map?: Map;
|
|
525
|
-
array?: _Array;
|
|
526
|
-
enum?: PlaceholderContentEnum;
|
|
527
|
-
attachment?: Attachment;
|
|
528
|
-
integer?: Integer;
|
|
529
|
-
decimal?: Decimal;
|
|
530
|
-
}
|
|
531
|
-
interface PlainText {
|
|
532
|
-
text?: string;
|
|
533
|
-
}
|
|
534
|
-
interface Html {
|
|
535
|
-
html?: string;
|
|
536
|
-
}
|
|
537
|
-
/**
|
|
538
|
-
* Money.
|
|
539
|
-
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
540
|
-
*/
|
|
541
|
-
interface Money {
|
|
542
|
-
/**
|
|
543
|
-
* 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.
|
|
544
|
-
* @format DECIMAL_VALUE
|
|
545
|
-
*/
|
|
546
|
-
value?: string;
|
|
547
|
-
/**
|
|
548
|
-
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
549
|
-
* @format CURRENCY
|
|
550
|
-
*/
|
|
551
|
-
currency?: string;
|
|
552
|
-
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
553
|
-
formattedValue?: string | null;
|
|
554
|
-
}
|
|
555
|
-
interface DateTime {
|
|
556
|
-
timestamp?: Date | null;
|
|
557
|
-
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
558
|
-
timeZone?: string | null;
|
|
559
|
-
}
|
|
560
|
-
interface Map {
|
|
561
|
-
variables?: Record<string, PlaceholderContent>;
|
|
562
|
-
}
|
|
563
|
-
interface _Array {
|
|
564
|
-
items?: PlaceholderContent[];
|
|
820
|
+
/** @enumType */
|
|
821
|
+
type ActivityTypeWithLiterals = ActivityType | 'DELIVERY' | 'CLICK' | 'OPEN' | 'SOFT_BOUNCE' | 'HARD_BOUNCED';
|
|
822
|
+
interface Click {
|
|
823
|
+
/** URL that was clicked. */
|
|
824
|
+
url?: string;
|
|
825
|
+
/** Browser user agent of the recipient. */
|
|
826
|
+
userAgent?: string;
|
|
565
827
|
}
|
|
566
|
-
interface
|
|
567
|
-
|
|
568
|
-
|
|
828
|
+
interface Open {
|
|
829
|
+
/** Browser user agent of the recipient. */
|
|
830
|
+
userAgent?: string;
|
|
569
831
|
}
|
|
570
|
-
interface
|
|
571
|
-
|
|
572
|
-
|
|
832
|
+
interface SoftBounce {
|
|
833
|
+
/** Reason the email soft bounced. */
|
|
834
|
+
reason?: string;
|
|
573
835
|
}
|
|
574
|
-
interface
|
|
575
|
-
/**
|
|
576
|
-
|
|
836
|
+
interface HardBounce {
|
|
837
|
+
/** Reason the email hard bounced. */
|
|
838
|
+
reason?: string;
|
|
577
839
|
}
|
|
578
|
-
interface
|
|
840
|
+
interface Scheduled {
|
|
579
841
|
/**
|
|
580
|
-
*
|
|
581
|
-
*
|
|
582
|
-
* @format DECIMAL_VALUE
|
|
842
|
+
* ID of the campaign that was scheduled.
|
|
843
|
+
* @format GUID
|
|
583
844
|
*/
|
|
584
|
-
|
|
845
|
+
campaignId?: string;
|
|
846
|
+
/** The timestamp campaign is scheduled for. */
|
|
847
|
+
sendAt?: Date | null;
|
|
848
|
+
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
849
|
+
rescheduled?: boolean;
|
|
850
|
+
}
|
|
851
|
+
interface SendTestRequest {
|
|
852
|
+
/**
|
|
853
|
+
* Campaign ID.
|
|
854
|
+
* @format GUID
|
|
855
|
+
*/
|
|
856
|
+
campaignId: string;
|
|
857
|
+
/**
|
|
858
|
+
* Email subject.
|
|
859
|
+
* @maxLength 1000
|
|
860
|
+
*/
|
|
861
|
+
emailSubject?: string | null;
|
|
862
|
+
/**
|
|
863
|
+
* Recipient email address.
|
|
864
|
+
* @format EMAIL
|
|
865
|
+
*/
|
|
866
|
+
toEmailAddress: string;
|
|
585
867
|
}
|
|
586
868
|
interface SendTestResponse {
|
|
587
869
|
}
|
|
@@ -726,19 +1008,6 @@ interface GetComposerResponse {
|
|
|
726
1008
|
*/
|
|
727
1009
|
emailPreheader?: string | null;
|
|
728
1010
|
}
|
|
729
|
-
interface Composer {
|
|
730
|
-
/**
|
|
731
|
-
* Internal data structure for editor/viewer to render the campaign.
|
|
732
|
-
* @maxLength 10000000
|
|
733
|
-
*/
|
|
734
|
-
composerDataJson?: string;
|
|
735
|
-
/** Default values of existing placeholders. */
|
|
736
|
-
defaultValues?: DefaultValues;
|
|
737
|
-
}
|
|
738
|
-
interface DefaultValues {
|
|
739
|
-
/** @maxSize 500 */
|
|
740
|
-
map?: Record<string, string>;
|
|
741
|
-
}
|
|
742
1011
|
interface UpdateComposerRequest {
|
|
743
1012
|
/**
|
|
744
1013
|
* Campaign ID.
|
|
@@ -998,6 +1267,46 @@ declare enum WebhookIdentityType {
|
|
|
998
1267
|
}
|
|
999
1268
|
/** @enumType */
|
|
1000
1269
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1270
|
+
interface GetPlaceholderKeysRequest {
|
|
1271
|
+
/**
|
|
1272
|
+
* Campaign ID.
|
|
1273
|
+
* @format GUID
|
|
1274
|
+
*/
|
|
1275
|
+
campaignId?: string;
|
|
1276
|
+
}
|
|
1277
|
+
interface GetPlaceholderKeysResponse {
|
|
1278
|
+
/** Keys of placeholders used in the campaign. */
|
|
1279
|
+
placeholderKeys?: string[];
|
|
1280
|
+
}
|
|
1281
|
+
interface GetDefaultComponentsRequest {
|
|
1282
|
+
}
|
|
1283
|
+
interface GetDefaultComponentsResponse {
|
|
1284
|
+
footer?: Record<string, any> | null;
|
|
1285
|
+
logo?: Record<string, any> | null;
|
|
1286
|
+
follow?: Record<string, any> | null;
|
|
1287
|
+
}
|
|
1288
|
+
interface ValidateLinkRequest {
|
|
1289
|
+
/**
|
|
1290
|
+
* URL to validate.
|
|
1291
|
+
* @minLength 1
|
|
1292
|
+
*/
|
|
1293
|
+
url: string;
|
|
1294
|
+
}
|
|
1295
|
+
interface ValidateLinkResponse {
|
|
1296
|
+
/** Whether the link is valid. */
|
|
1297
|
+
valid?: boolean;
|
|
1298
|
+
}
|
|
1299
|
+
interface ValidateHtmlLinksRequest {
|
|
1300
|
+
/**
|
|
1301
|
+
* HTML string with links.
|
|
1302
|
+
* @maxLength 1000000
|
|
1303
|
+
*/
|
|
1304
|
+
html: string;
|
|
1305
|
+
}
|
|
1306
|
+
interface ValidateHtmlLinksResponse {
|
|
1307
|
+
/** Non-valid links. */
|
|
1308
|
+
blacklistedLinks?: string[];
|
|
1309
|
+
}
|
|
1001
1310
|
interface EstimateFilterSizeRequest {
|
|
1002
1311
|
/** Contacts filter expression. */
|
|
1003
1312
|
filter?: Record<string, any> | null;
|
|
@@ -1143,120 +1452,11 @@ interface SubscribeFromLandingPageResponse {
|
|
|
1143
1452
|
/** @format GUID */
|
|
1144
1453
|
contactId?: string;
|
|
1145
1454
|
}
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
* @maxSize 100
|
|
1152
|
-
*/
|
|
1153
|
-
campaignIds: string[];
|
|
1154
|
-
}
|
|
1155
|
-
interface ListStatisticsResponse {
|
|
1156
|
-
/** List of statistics. */
|
|
1157
|
-
statistics?: CampaignStatisticsContainer[];
|
|
1158
|
-
}
|
|
1159
|
-
interface CampaignStatisticsContainer {
|
|
1160
|
-
/**
|
|
1161
|
-
* Campaign ID.
|
|
1162
|
-
* @format GUID
|
|
1163
|
-
*/
|
|
1164
|
-
campaignId?: string;
|
|
1165
|
-
/** Landing page statistics. */
|
|
1166
|
-
landingPage?: LandingPageStatistics;
|
|
1167
|
-
/** Email campaign statistics. */
|
|
1168
|
-
email?: DistributionStatistics;
|
|
1169
|
-
}
|
|
1170
|
-
interface ListRecipientsRequest {
|
|
1171
|
-
/**
|
|
1172
|
-
* Campaign ID.
|
|
1173
|
-
* @format GUID
|
|
1174
|
-
*/
|
|
1175
|
-
campaignId: string;
|
|
1176
|
-
/** Email activity to filter. */
|
|
1177
|
-
activity: RecipientsActivityEnumWithLiterals;
|
|
1178
|
-
/** Pagination options. */
|
|
1179
|
-
paging?: CursorPaging;
|
|
1180
|
-
}
|
|
1181
|
-
declare enum RecipientsActivityEnum {
|
|
1182
|
-
UNKNOWN = "UNKNOWN",
|
|
1183
|
-
DELIVERED = "DELIVERED",
|
|
1184
|
-
OPENED = "OPENED",
|
|
1185
|
-
CLICKED = "CLICKED",
|
|
1186
|
-
BOUNCED = "BOUNCED",
|
|
1187
|
-
NOT_SENT = "NOT_SENT",
|
|
1188
|
-
SENT = "SENT",
|
|
1189
|
-
NOT_OPENED = "NOT_OPENED"
|
|
1190
|
-
}
|
|
1191
|
-
/** @enumType */
|
|
1192
|
-
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
1193
|
-
interface CursorPaging {
|
|
1194
|
-
/**
|
|
1195
|
-
* Number of items to load.
|
|
1196
|
-
* @max 1000
|
|
1197
|
-
*/
|
|
1198
|
-
limit?: number | null;
|
|
1199
|
-
/**
|
|
1200
|
-
* Pointer to the next or previous page in the list of results.
|
|
1201
|
-
*
|
|
1202
|
-
* You can get the relevant cursor token
|
|
1203
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1204
|
-
* Not relevant for the first request.
|
|
1205
|
-
* @maxLength 1000
|
|
1206
|
-
*/
|
|
1207
|
-
cursor?: string | null;
|
|
1208
|
-
}
|
|
1209
|
-
interface ListRecipientsResponse {
|
|
1210
|
-
/** List of recipients. */
|
|
1211
|
-
recipients?: CampaignRecipientDetails[];
|
|
1212
|
-
/** Details on the paged set of returned results. */
|
|
1213
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1214
|
-
}
|
|
1215
|
-
interface CampaignRecipientDetails {
|
|
1216
|
-
/**
|
|
1217
|
-
* Contact ID.
|
|
1218
|
-
* @format GUID
|
|
1219
|
-
*/
|
|
1220
|
-
contactId?: string;
|
|
1221
|
-
/** Date and time of the last activity. */
|
|
1222
|
-
lastActivityDate?: Date | null;
|
|
1223
|
-
/**
|
|
1224
|
-
* Primary email address of the contact.
|
|
1225
|
-
* @format EMAIL
|
|
1226
|
-
*/
|
|
1227
|
-
emailAddress?: string;
|
|
1228
|
-
/**
|
|
1229
|
-
* Full name of the contact (optional).
|
|
1230
|
-
* @maxLength 100
|
|
1231
|
-
*/
|
|
1232
|
-
fullName?: string | null;
|
|
1233
|
-
/** Is this contact currently deleted from the site or not. */
|
|
1234
|
-
contactDeleted?: boolean;
|
|
1235
|
-
}
|
|
1236
|
-
interface PagingMetadataV2 {
|
|
1237
|
-
/** Number of items returned in the response. */
|
|
1238
|
-
count?: number | null;
|
|
1239
|
-
/** Offset that was requested. */
|
|
1240
|
-
offset?: number | null;
|
|
1241
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1242
|
-
total?: number | null;
|
|
1243
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1244
|
-
tooManyToCount?: boolean | null;
|
|
1245
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1246
|
-
cursors?: Cursors;
|
|
1247
|
-
}
|
|
1248
|
-
interface Cursors {
|
|
1249
|
-
/**
|
|
1250
|
-
* Cursor string pointing to the next page in the list of results.
|
|
1251
|
-
* @maxLength 16000
|
|
1252
|
-
*/
|
|
1253
|
-
next?: string | null;
|
|
1254
|
-
/**
|
|
1255
|
-
* Cursor pointing to the previous page in the list of results.
|
|
1256
|
-
* @maxLength 16000
|
|
1257
|
-
*/
|
|
1258
|
-
prev?: string | null;
|
|
1259
|
-
}
|
|
1455
|
+
type PublishCampaignApplicationErrors = {
|
|
1456
|
+
code?: 'ALREADY_SENT';
|
|
1457
|
+
description?: string;
|
|
1458
|
+
data?: Record<string, any>;
|
|
1459
|
+
};
|
|
1260
1460
|
interface BaseEventMetadata {
|
|
1261
1461
|
/**
|
|
1262
1462
|
* App instance ID.
|
|
@@ -1305,37 +1505,261 @@ interface CampaignDistributedEnvelope {
|
|
|
1305
1505
|
data: Distributed;
|
|
1306
1506
|
metadata: EventMetadata;
|
|
1307
1507
|
}
|
|
1508
|
+
/**
|
|
1509
|
+
* Triggered when a campaign is successfully distributed to all recipients.
|
|
1510
|
+
* @permissionScope Manage Stores
|
|
1511
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1512
|
+
* @permissionScope Access Verticals by Automations
|
|
1513
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1514
|
+
* @permissionScope Set Up Automations
|
|
1515
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1516
|
+
* @permissionScope Read Email Marketing
|
|
1517
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1518
|
+
* @permissionScope Manage Email Marketing
|
|
1519
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1520
|
+
* @permissionId Shoutout.Read
|
|
1521
|
+
* @webhook
|
|
1522
|
+
* @eventType wix.email_marketing.v1.campaign_campaign_distributed_event
|
|
1523
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1524
|
+
* @slug campaign_distributed_event
|
|
1525
|
+
*/
|
|
1526
|
+
declare function onCampaignDistributedEvent(handler: (event: CampaignDistributedEnvelope) => void | Promise<void>): void;
|
|
1308
1527
|
interface CampaignPausedEnvelope {
|
|
1309
1528
|
data: Paused;
|
|
1310
1529
|
metadata: EventMetadata;
|
|
1311
1530
|
}
|
|
1531
|
+
/**
|
|
1532
|
+
* Triggered when a scheduled campaign is paused.
|
|
1533
|
+
* @permissionScope Manage Stores
|
|
1534
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1535
|
+
* @permissionScope Access Verticals by Automations
|
|
1536
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1537
|
+
* @permissionScope Set Up Automations
|
|
1538
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1539
|
+
* @permissionScope Read Email Marketing
|
|
1540
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1541
|
+
* @permissionScope Manage Email Marketing
|
|
1542
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1543
|
+
* @permissionId Shoutout.Read
|
|
1544
|
+
* @webhook
|
|
1545
|
+
* @eventType wix.email_marketing.v1.campaign_campaign_paused_event
|
|
1546
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1547
|
+
* @slug campaign_paused_event
|
|
1548
|
+
*/
|
|
1549
|
+
declare function onCampaignPausedEvent(handler: (event: CampaignPausedEnvelope) => void | Promise<void>): void;
|
|
1312
1550
|
interface CampaignPublishedEnvelope {
|
|
1313
1551
|
data: Published;
|
|
1314
1552
|
metadata: EventMetadata;
|
|
1315
1553
|
}
|
|
1554
|
+
/**
|
|
1555
|
+
* Triggered when a draft campaign is published.
|
|
1556
|
+
* @permissionScope Manage Stores
|
|
1557
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1558
|
+
* @permissionScope Access Verticals by Automations
|
|
1559
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1560
|
+
* @permissionScope Set Up Automations
|
|
1561
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1562
|
+
* @permissionScope Read Email Marketing
|
|
1563
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1564
|
+
* @permissionScope Manage Email Marketing
|
|
1565
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1566
|
+
* @permissionId Shoutout.Read
|
|
1567
|
+
* @webhook
|
|
1568
|
+
* @eventType wix.email_marketing.v1.campaign_campaign_published_event
|
|
1569
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1570
|
+
* @slug campaign_published_event
|
|
1571
|
+
*/
|
|
1572
|
+
declare function onCampaignPublishedEvent(handler: (event: CampaignPublishedEnvelope) => void | Promise<void>): void;
|
|
1316
1573
|
interface CampaignRejectedEnvelope {
|
|
1317
1574
|
data: Rejected;
|
|
1318
1575
|
metadata: EventMetadata;
|
|
1319
1576
|
}
|
|
1577
|
+
/**
|
|
1578
|
+
* Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
|
|
1579
|
+
* @permissionScope Manage Stores
|
|
1580
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1581
|
+
* @permissionScope Access Verticals by Automations
|
|
1582
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1583
|
+
* @permissionScope Set Up Automations
|
|
1584
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1585
|
+
* @permissionScope Read Email Marketing
|
|
1586
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1587
|
+
* @permissionScope Manage Email Marketing
|
|
1588
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1589
|
+
* @permissionId Shoutout.Read
|
|
1590
|
+
* @webhook
|
|
1591
|
+
* @eventType wix.email_marketing.v1.campaign_campaign_rejected_event
|
|
1592
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1593
|
+
* @slug campaign_rejected_event
|
|
1594
|
+
*/
|
|
1595
|
+
declare function onCampaignRejectedEvent(handler: (event: CampaignRejectedEnvelope) => void | Promise<void>): void;
|
|
1320
1596
|
interface CampaignScheduledEnvelope {
|
|
1321
1597
|
data: Scheduled;
|
|
1322
1598
|
metadata: EventMetadata;
|
|
1323
1599
|
}
|
|
1600
|
+
/**
|
|
1601
|
+
* Triggered when a campaign is scheduled to be sent out at the specific time.
|
|
1602
|
+
* @permissionScope Manage Stores
|
|
1603
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1604
|
+
* @permissionScope Access Verticals by Automations
|
|
1605
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1606
|
+
* @permissionScope Set Up Automations
|
|
1607
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1608
|
+
* @permissionScope Read Email Marketing
|
|
1609
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1610
|
+
* @permissionScope Manage Email Marketing
|
|
1611
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1612
|
+
* @permissionId Shoutout.Read
|
|
1613
|
+
* @webhook
|
|
1614
|
+
* @eventType wix.email_marketing.v1.campaign_campaign_scheduled_event
|
|
1615
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1616
|
+
* @slug campaign_scheduled_event
|
|
1617
|
+
*/
|
|
1618
|
+
declare function onCampaignScheduledEvent(handler: (event: CampaignScheduledEnvelope) => void | Promise<void>): void;
|
|
1324
1619
|
interface CampaignTerminatedEnvelope {
|
|
1325
1620
|
data: Terminated;
|
|
1326
1621
|
metadata: EventMetadata;
|
|
1327
1622
|
}
|
|
1623
|
+
/**
|
|
1624
|
+
* Triggered when the mailing list isn't clean and campaign was terminated.
|
|
1625
|
+
* @permissionScope Manage Stores
|
|
1626
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1627
|
+
* @permissionScope Access Verticals by Automations
|
|
1628
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1629
|
+
* @permissionScope Set Up Automations
|
|
1630
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1631
|
+
* @permissionScope Read Email Marketing
|
|
1632
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1633
|
+
* @permissionScope Manage Email Marketing
|
|
1634
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1635
|
+
* @permissionId Shoutout.Read
|
|
1636
|
+
* @webhook
|
|
1637
|
+
* @eventType wix.email_marketing.v1.campaign_campaign_terminated_event
|
|
1638
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1639
|
+
* @slug campaign_terminated_event
|
|
1640
|
+
*/
|
|
1641
|
+
declare function onCampaignTerminatedEvent(handler: (event: CampaignTerminatedEnvelope) => void | Promise<void>): void;
|
|
1328
1642
|
interface CampaignCreatedEnvelope {
|
|
1329
1643
|
entity: Campaign;
|
|
1330
1644
|
metadata: EventMetadata;
|
|
1331
1645
|
}
|
|
1646
|
+
/**
|
|
1647
|
+
* Triggered when a campaign is created.
|
|
1648
|
+
* @permissionScope Manage Stores
|
|
1649
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1650
|
+
* @permissionScope Access Verticals by Automations
|
|
1651
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1652
|
+
* @permissionScope Set Up Automations
|
|
1653
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1654
|
+
* @permissionScope Read Email Marketing
|
|
1655
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1656
|
+
* @permissionScope Manage Email Marketing
|
|
1657
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1658
|
+
* @permissionId Shoutout.Read
|
|
1659
|
+
* @webhook
|
|
1660
|
+
* @eventType wix.email_marketing.v1.campaign_created
|
|
1661
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1662
|
+
* @slug created
|
|
1663
|
+
*/
|
|
1664
|
+
declare function onCampaignCreated(handler: (event: CampaignCreatedEnvelope) => void | Promise<void>): void;
|
|
1332
1665
|
interface CampaignDeletedEnvelope {
|
|
1333
1666
|
metadata: EventMetadata;
|
|
1334
1667
|
}
|
|
1668
|
+
/**
|
|
1669
|
+
* Triggered when a campaign is deleted.
|
|
1670
|
+
* @permissionScope Manage Stores
|
|
1671
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1672
|
+
* @permissionScope Access Verticals by Automations
|
|
1673
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1674
|
+
* @permissionScope Set Up Automations
|
|
1675
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1676
|
+
* @permissionScope Read Email Marketing
|
|
1677
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1678
|
+
* @permissionScope Manage Email Marketing
|
|
1679
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1680
|
+
* @permissionId Shoutout.Read
|
|
1681
|
+
* @webhook
|
|
1682
|
+
* @eventType wix.email_marketing.v1.campaign_deleted
|
|
1683
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1684
|
+
* @slug deleted
|
|
1685
|
+
*/
|
|
1686
|
+
declare function onCampaignDeleted(handler: (event: CampaignDeletedEnvelope) => void | Promise<void>): void;
|
|
1335
1687
|
interface CampaignEmailActivityUpdatedEnvelope {
|
|
1336
1688
|
data: EmailActivityUpdated;
|
|
1337
1689
|
metadata: EventMetadata;
|
|
1338
1690
|
}
|
|
1691
|
+
/**
|
|
1692
|
+
* Triggered when an email campaign has a new recipient activity.
|
|
1693
|
+
* @permissionScope Manage Stores
|
|
1694
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1695
|
+
* @permissionScope Access Verticals by Automations
|
|
1696
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1697
|
+
* @permissionScope Set Up Automations
|
|
1698
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1699
|
+
* @permissionScope Read Email Marketing
|
|
1700
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING
|
|
1701
|
+
* @permissionScope Manage Email Marketing
|
|
1702
|
+
* @permissionScopeId SCOPE.DC-PROMOTE.EMAIL-MARKETING
|
|
1703
|
+
* @permissionId Shoutout.Read
|
|
1704
|
+
* @webhook
|
|
1705
|
+
* @eventType wix.email_marketing.v1.campaign_email_activity_updated
|
|
1706
|
+
* @serviceIdentifier wix.emailmarketing.api.v1.CampaignService
|
|
1707
|
+
* @slug email_activity_updated
|
|
1708
|
+
*/
|
|
1709
|
+
declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
|
|
1710
|
+
type CampaignNonNullablePaths = `campaignId` | `editorType` | `status` | `visibilityStatus` | `distributionStatus` | `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked` | `emailSubject`;
|
|
1711
|
+
/**
|
|
1712
|
+
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1713
|
+
*
|
|
1714
|
+
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
1715
|
+
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
1716
|
+
*
|
|
1717
|
+
* Call List Campaigns to retrieve additional information for a site's campaigns.
|
|
1718
|
+
* Call List Recipients to retrieve a list of recipients and their activities related to a selected campaign.
|
|
1719
|
+
* @param campaignIds - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1720
|
+
* @public
|
|
1721
|
+
* @requiredField campaignIds
|
|
1722
|
+
* @permissionId Shoutout.Read
|
|
1723
|
+
* @applicableIdentity APP
|
|
1724
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1725
|
+
*/
|
|
1726
|
+
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`>>;
|
|
1727
|
+
/**
|
|
1728
|
+
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1729
|
+
*
|
|
1730
|
+
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
1731
|
+
*
|
|
1732
|
+
* Call List Statistics to retrieve a list of activity for selected campaigns.
|
|
1733
|
+
* Call List Campaigns to retrieve additional information for your campaigns.
|
|
1734
|
+
*
|
|
1735
|
+
* If no `activity` is included, this method returns an error.
|
|
1736
|
+
* @param campaignId - Campaign ID.
|
|
1737
|
+
* @param activity - Email activity to filter.
|
|
1738
|
+
* @public
|
|
1739
|
+
* @requiredField activity
|
|
1740
|
+
* @requiredField campaignId
|
|
1741
|
+
* @param options - Options to use when getting the list of recipients.
|
|
1742
|
+
* @permissionId Shoutout.Read
|
|
1743
|
+
* @applicableIdentity APP
|
|
1744
|
+
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1745
|
+
*/
|
|
1746
|
+
declare function listRecipients(campaignId: string, activity: RecipientsActivityEnumWithLiterals, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`>>;
|
|
1747
|
+
interface ListRecipientsOptions {
|
|
1748
|
+
/** Pagination options. */
|
|
1749
|
+
paging?: CursorPaging;
|
|
1750
|
+
}
|
|
1751
|
+
/**
|
|
1752
|
+
* Retrieves information about an email campaign.
|
|
1753
|
+
* @param campaignId - Campaign ID.
|
|
1754
|
+
* @public
|
|
1755
|
+
* @requiredField campaignId
|
|
1756
|
+
* @param options - Options to use when getting a campaign.
|
|
1757
|
+
* @permissionId Shoutout.Manage
|
|
1758
|
+
* @applicableIdentity APP
|
|
1759
|
+
* @returns Campaign information.
|
|
1760
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.Get
|
|
1761
|
+
*/
|
|
1762
|
+
declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<NonNullablePaths<Campaign, CampaignNonNullablePaths>>;
|
|
1339
1763
|
interface GetCampaignOptions {
|
|
1340
1764
|
/**
|
|
1341
1765
|
* Whether a returned campaign should include `publishingData.statistics`.
|
|
@@ -1344,6 +1768,19 @@ interface GetCampaignOptions {
|
|
|
1344
1768
|
*/
|
|
1345
1769
|
optionIncludeStatistics?: boolean;
|
|
1346
1770
|
}
|
|
1771
|
+
/**
|
|
1772
|
+
* Retrieves a list of email campaigns.
|
|
1773
|
+
*
|
|
1774
|
+
* Default sorts by `dateUpdated` in `DESC` order.
|
|
1775
|
+
* @public
|
|
1776
|
+
* @param options - Options to use when getting the list of campaigns.
|
|
1777
|
+
* @permissionId Shoutout.Read
|
|
1778
|
+
* @applicableIdentity APP
|
|
1779
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.List
|
|
1780
|
+
*/
|
|
1781
|
+
declare function listCampaigns(options?: ListCampaignsOptions): Promise<NonNullablePaths<ListCampaignsResponse, {
|
|
1782
|
+
[P in CampaignNonNullablePaths]: `campaigns.${number}.${P}`;
|
|
1783
|
+
}[CampaignNonNullablePaths]>>;
|
|
1347
1784
|
interface ListCampaignsOptions {
|
|
1348
1785
|
/** Paging parameters. */
|
|
1349
1786
|
paging?: Paging;
|
|
@@ -1358,10 +1795,39 @@ interface ListCampaignsOptions {
|
|
|
1358
1795
|
/** Visibility status. */
|
|
1359
1796
|
visibilityStatuses?: CampaignVisibilityStatusEnumWithLiterals[];
|
|
1360
1797
|
}
|
|
1798
|
+
/**
|
|
1799
|
+
* Publishes and sends a specified campaign.
|
|
1800
|
+
*
|
|
1801
|
+
* If the `email_distribution_options` object isn't passed in the request, the campaign is only published as a landing page.
|
|
1802
|
+
* @param campaignId - Campaign ID
|
|
1803
|
+
* @public
|
|
1804
|
+
* @requiredField campaignId
|
|
1805
|
+
* @param options - Options to use when publishing a campaign.
|
|
1806
|
+
* @permissionId Shoutout.Manage
|
|
1807
|
+
* @applicableIdentity APP
|
|
1808
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.Publish
|
|
1809
|
+
*/
|
|
1810
|
+
declare function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise<NonNullablePaths<PublishCampaignResponse, `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked`> & {
|
|
1811
|
+
__applicationErrorsType?: PublishCampaignApplicationErrors;
|
|
1812
|
+
}>;
|
|
1361
1813
|
interface PublishCampaignOptions {
|
|
1362
1814
|
/** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
|
|
1363
1815
|
emailDistributionOptions?: EmailDistributionOptions;
|
|
1364
1816
|
}
|
|
1817
|
+
/**
|
|
1818
|
+
* Sends a test email. Call this method to preview your email campaign.
|
|
1819
|
+
*
|
|
1820
|
+
* We strongly recommend calling this method only a few times in a row, as there is a rate limit to prevent abuse of the Send Test method.
|
|
1821
|
+
* @param campaignId - Campaign ID.
|
|
1822
|
+
* @public
|
|
1823
|
+
* @requiredField campaignId
|
|
1824
|
+
* @requiredField options.toEmailAddress
|
|
1825
|
+
* @param options - Options for sending a test email.
|
|
1826
|
+
* @permissionId Shoutout.Manage
|
|
1827
|
+
* @applicableIdentity APP
|
|
1828
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
|
|
1829
|
+
*/
|
|
1830
|
+
declare function sendTest(campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`>): Promise<void>;
|
|
1365
1831
|
interface SendTestOptions {
|
|
1366
1832
|
/**
|
|
1367
1833
|
* Email subject.
|
|
@@ -1374,9 +1840,91 @@ interface SendTestOptions {
|
|
|
1374
1840
|
*/
|
|
1375
1841
|
toEmailAddress: string;
|
|
1376
1842
|
}
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1843
|
+
/**
|
|
1844
|
+
* Pauses a scheduled campaign.
|
|
1845
|
+
* @param campaignId - Campaign ID.
|
|
1846
|
+
* @public
|
|
1847
|
+
* @requiredField campaignId
|
|
1848
|
+
* @permissionId Shoutout.Manage
|
|
1849
|
+
* @applicableIdentity APP
|
|
1850
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.PauseScheduling
|
|
1851
|
+
*/
|
|
1852
|
+
declare function pauseScheduling(campaignId: string): Promise<void>;
|
|
1853
|
+
/**
|
|
1854
|
+
* Changes the sending time for an already scheduled campaign.
|
|
1855
|
+
* @param campaignId - ID of the campaign to reschedule.
|
|
1856
|
+
* @param sendAt - New time for sending out the campaign.
|
|
1857
|
+
* @public
|
|
1858
|
+
* @requiredField campaignId
|
|
1859
|
+
* @requiredField sendAt
|
|
1860
|
+
* @permissionId Shoutout.Manage
|
|
1861
|
+
* @applicableIdentity APP
|
|
1862
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.Reschedule
|
|
1863
|
+
*/
|
|
1864
|
+
declare function reschedule(campaignId: string, sendAt: Date): Promise<void>;
|
|
1865
|
+
/**
|
|
1866
|
+
* Permanently deletes a campaign.
|
|
1867
|
+
* @param campaignId - Campaign ID.
|
|
1868
|
+
* @public
|
|
1869
|
+
* @requiredField campaignId
|
|
1870
|
+
* @permissionId Shoutout.Manage
|
|
1871
|
+
* @applicableIdentity APP
|
|
1872
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService._delete
|
|
1873
|
+
*/
|
|
1874
|
+
declare function deleteCampaign(campaignId: string): Promise<void>;
|
|
1875
|
+
/**
|
|
1876
|
+
* Creates a copy of an existing campaign.
|
|
1877
|
+
* @param campaignId - ID of the message to be duplicated.
|
|
1878
|
+
* @public
|
|
1879
|
+
* @requiredField campaignId
|
|
1880
|
+
* @permissionId Shoutout.Manage
|
|
1881
|
+
* @applicableIdentity APP
|
|
1882
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
|
|
1883
|
+
*/
|
|
1884
|
+
declare function reuseCampaign(campaignId: string): Promise<NonNullablePaths<ReuseCampaignResponse, {
|
|
1885
|
+
[P in CampaignNonNullablePaths]: `campaign.${P}`;
|
|
1886
|
+
}[CampaignNonNullablePaths]>>;
|
|
1887
|
+
/**
|
|
1888
|
+
* Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.
|
|
1889
|
+
* @param campaignId - Campaign ID.
|
|
1890
|
+
* @public
|
|
1891
|
+
* @requiredField campaignId
|
|
1892
|
+
* @permissionId Shoutout.Manage
|
|
1893
|
+
* @applicableIdentity APP
|
|
1894
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
|
|
1895
|
+
*/
|
|
1896
|
+
declare function getAudience(campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`>>;
|
|
1897
|
+
/**
|
|
1898
|
+
* Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
|
|
1899
|
+
* @param emailAddress - Email address to verify.
|
|
1900
|
+
* @public
|
|
1901
|
+
* @requiredField emailAddress
|
|
1902
|
+
* @permissionId Shoutout.Manage
|
|
1903
|
+
* @applicableIdentity APP
|
|
1904
|
+
* @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
|
|
1905
|
+
*/
|
|
1906
|
+
declare function identifySenderAddress(emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`>>;
|
|
1907
|
+
/**
|
|
1908
|
+
* Validates any provided link. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
|
|
1909
|
+
*
|
|
1910
|
+
* If you provide a link as a placeholder, it's returned in a response as valid.
|
|
1911
|
+
* @param url - URL to validate.
|
|
1912
|
+
* @public
|
|
1913
|
+
* @requiredField url
|
|
1914
|
+
* @permissionId Shoutout.Manage
|
|
1915
|
+
* @applicableIdentity APP
|
|
1916
|
+
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
|
|
1917
|
+
*/
|
|
1918
|
+
declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`>>;
|
|
1919
|
+
/**
|
|
1920
|
+
* Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
|
|
1921
|
+
* @param html - HTML string with links.
|
|
1922
|
+
* @public
|
|
1923
|
+
* @requiredField html
|
|
1924
|
+
* @permissionId Shoutout.Manage
|
|
1925
|
+
* @applicableIdentity APP
|
|
1926
|
+
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
|
|
1927
|
+
*/
|
|
1928
|
+
declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`>>;
|
|
1381
1929
|
|
|
1382
|
-
export { type
|
|
1930
|
+
export { type ActionEvent, ActivityType, type ActivityTypeWithLiterals, type ArchiveCampaignRequest, type ArchiveCampaignResponse, type Archived, type Attachment, type AutomationTranslatorContent, type BaseEventMetadata, type Campaign, type CampaignAudience, type CampaignCreatedEnvelope, type CampaignDeletedEnvelope, type CampaignDistributedEnvelope, type CampaignEditorType, CampaignEditorTypeEnum, type CampaignEditorTypeEnumWithLiterals, type CampaignEmailActivityUpdatedEnvelope, type CampaignPausedEnvelope, type CampaignPublishedEnvelope, type CampaignRecipientDetails, type CampaignRejectedEnvelope, type CampaignScheduledEnvelope, CampaignSendingStateEnum, type CampaignSendingStateEnumWithLiterals, type CampaignStatistics, type CampaignStatisticsContainer, CampaignStatusEnum, type CampaignStatusEnumWithLiterals, type CampaignTerminatedEnvelope, CampaignTypeEnum, type CampaignTypeEnumWithLiterals, CampaignVisibilityStatusEnum, type CampaignVisibilityStatusEnumWithLiterals, type Click, type Composer, type Contact, type CountCampaignsRequest, type CountCampaignsResponse, type CreateCampaignRequest, type CreateCampaignResponse, type CreateFromTemplateRequest, type CreateFromTemplateResponse, type CreateFromUserTemplateRequest, type CreateFromUserTemplateResponse, type CreateUserTemplateRequest, type CreateUserTemplateResponse, type CursorPaging, type Cursors, type DateTime, type Decimal, type DefaultValues, type DeleteCampaignRequest, type DeleteCampaignResponse, type Distributed, type DistributionStatistics, type DomainEvent, type DomainEventBodyOneOf, type EmailActivityUpdated, type EmailActivityUpdatedEventTypeOneOf, type EmailDistributionOptions, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EstimateAudienceSizeRequest, type EstimateAudienceSizeResponse, type EstimateFilterSizeRequest, type EstimateFilterSizeResponse, type EventMetadata, type GetAudienceRequest, type GetAudienceResponse, type GetAutomationTranslatorContentRequest, type GetAutomationTranslatorContentResponse, type GetCampaignMappingRequest, type GetCampaignMappingResponse, type GetCampaignOptions, type GetCampaignRequest, type GetCampaignResponse, type GetComposerRequest, type GetComposerResponse, type GetDefaultComponentsRequest, type GetDefaultComponentsResponse, type GetLabelsRequest, type GetLabelsResponse, type GetPlaceholderKeysRequest, type GetPlaceholderKeysResponse, type GetUsedPlaceholderKeysRequest, type GetUsedPlaceholderKeysResponse, type HardBounce, type Html, type IdentificationData, type IdentificationDataIdOneOf, type IdentifySenderAddressRequest, type IdentifySenderAddressResponse, type Integer, type Label, type LandingPageStatistics, type ListCampaignsOptions, type ListCampaignsRequest, type ListCampaignsResponse, type ListRecipientsOptions, type ListRecipientsRequest, type ListRecipientsResponse, type ListStatisticsRequest, type ListStatisticsResponse, type LookupCampaignMappingRequest, type LookupCampaignMappingResponse, type Map, type MessageEnvelope, type Money, type Open, type Paging, type PagingMetadataV2, type PauseSchedulingRequest, type PauseSchedulingResponse, type Paused, type PlaceholderContent, type PlaceholderContentEnum, type PlaceholderContentValueOneOf, type PlainText, type PreviewCampaignRequest, type PreviewCampaignResponse, type PublishCampaignApplicationErrors, type PublishCampaignOptions, type PublishCampaignRequest, type PublishCampaignResponse, type Published, type PublishingData, RecipientsActivityEnum, type RecipientsActivityEnumWithLiterals, type ReconcileContactRequest, type ReconcileContactResponse, type Rejected, type RejectionData, RejectionReasonEnum, type RejectionReasonEnumWithLiterals, type RescheduleRequest, type RescheduleResponse, type ResendToNonOpenersRequest, type ResendToNonOpenersResponse, type RestoreInfo, type ReuseCampaignRequest, type ReuseCampaignResponse, type Scheduled, type SearchContactsRequest, type SearchContactsResponse, type SendTestBulkRequest, type SendTestBulkResponse, type SendTestOptions, type SendTestRequest, type SendTestResponse, type SoftBounce, type SubscribeFromLandingPageRequest, type SubscribeFromLandingPageResponse, type Terminated, type TotalStatistics, type UnarchiveCampaignRequest, type UnarchiveCampaignResponse, type Unarchived, type UpdateComposerRequest, type UpdateComposerResponse, type UpdateTitleRequest, type UpdateTitleResponse, type UpsertAutomationTranslatorContentRequest, type UpsertAutomationTranslatorContentResponse, type UpsertTranslationRequest, type UpsertTranslationResponse, type ValidateHtmlLinksRequest, type ValidateHtmlLinksResponse, type ValidateLinkRequest, type ValidateLinkResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, onCampaignCreated, onCampaignDeleted, onCampaignDistributedEvent, onCampaignEmailActivityUpdated, onCampaignPausedEvent, onCampaignPublishedEvent, onCampaignRejectedEvent, onCampaignScheduledEvent, onCampaignTerminatedEvent, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };
|