@wix/auto_sdk_email-marketing_campaigns 1.0.74 → 1.0.76
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +34 -34
- package/build/cjs/index.js +170 -170
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +533 -533
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +481 -481
- package/build/cjs/meta.js +134 -134
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +34 -34
- package/build/es/index.mjs +170 -170
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +533 -533
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +481 -481
- package/build/es/meta.mjs +134 -134
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +34 -34
- package/build/internal/cjs/index.js +170 -170
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +533 -533
- package/build/internal/cjs/index.typings.js +154 -154
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +481 -481
- package/build/internal/cjs/meta.js +134 -134
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +34 -34
- package/build/internal/es/index.mjs +170 -170
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +533 -533
- package/build/internal/es/index.typings.mjs +154 -154
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +481 -481
- package/build/internal/es/meta.mjs +134 -134
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { GetCampaignRequest as GetCampaignRequest$1, GetCampaignResponse as GetCampaignResponse$1, ListCampaignsRequest as ListCampaignsRequest$1, ListCampaignsResponse as ListCampaignsResponse$1, PublishCampaignRequest as PublishCampaignRequest$1, PublishCampaignResponse as PublishCampaignResponse$1, SendTestRequest as SendTestRequest$1, SendTestResponse as SendTestResponse$1, PauseSchedulingRequest as PauseSchedulingRequest$1, PauseSchedulingResponse as PauseSchedulingResponse$1, RescheduleRequest as RescheduleRequest$1, RescheduleResponse as RescheduleResponse$1, DeleteCampaignRequest as DeleteCampaignRequest$1, DeleteCampaignResponse as DeleteCampaignResponse$1, ReuseCampaignRequest as ReuseCampaignRequest$1, ReuseCampaignResponse as ReuseCampaignResponse$1, GetAudienceRequest as GetAudienceRequest$1, GetAudienceResponse as GetAudienceResponse$1, IdentifySenderAddressRequest as IdentifySenderAddressRequest$1, IdentifySenderAddressResponse as IdentifySenderAddressResponse$1, ValidateLinkRequest as ValidateLinkRequest$1, ValidateLinkResponse as ValidateLinkResponse$1, ValidateHtmlLinksRequest as ValidateHtmlLinksRequest$1, ValidateHtmlLinksResponse as ValidateHtmlLinksResponse$1, ListStatisticsRequest as ListStatisticsRequest$1, ListStatisticsResponse as ListStatisticsResponse$1, ListRecipientsRequest as ListRecipientsRequest$1, ListRecipientsResponse as ListRecipientsResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Campaign {
|
|
@@ -214,361 +214,23 @@ declare enum CampaignTypeEnum {
|
|
|
214
214
|
}
|
|
215
215
|
/** @enumType */
|
|
216
216
|
type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
|
|
217
|
-
interface
|
|
218
|
-
/**
|
|
219
|
-
* rule ID in automations
|
|
220
|
-
* @format GUID
|
|
221
|
-
*/
|
|
222
|
-
automationRuleId?: string;
|
|
223
|
-
/**
|
|
224
|
-
* template ID configured for the automation
|
|
225
|
-
* @format GUID
|
|
226
|
-
*/
|
|
227
|
-
templateId?: string;
|
|
228
|
-
}
|
|
229
|
-
interface GetCampaignMappingResponse {
|
|
230
|
-
/** @format GUID */
|
|
231
|
-
campaignId?: string;
|
|
232
|
-
}
|
|
233
|
-
interface UpsertTranslationRequest {
|
|
234
|
-
/**
|
|
235
|
-
* Campaign ID.
|
|
236
|
-
* @format GUID
|
|
237
|
-
*/
|
|
238
|
-
campaignId?: string;
|
|
239
|
-
/** Composer data. */
|
|
240
|
-
composer?: Composer;
|
|
241
|
-
/**
|
|
242
|
-
* Translation language (optional, default value "EN").
|
|
243
|
-
* @format LANGUAGE
|
|
244
|
-
*/
|
|
245
|
-
language?: string | null;
|
|
246
|
-
/**
|
|
247
|
-
* For BI event [36:1031] only (optional, default value "n/a").
|
|
248
|
-
* @format GUID
|
|
249
|
-
*/
|
|
250
|
-
automationRuleId?: string | null;
|
|
251
|
-
/** Should campaign also be published or not (default value "false"). */
|
|
252
|
-
publish?: boolean;
|
|
253
|
-
/**
|
|
254
|
-
* Campaign subject (optional).
|
|
255
|
-
* @maxLength 1000
|
|
256
|
-
*/
|
|
257
|
-
emailSubject?: string | null;
|
|
258
|
-
/**
|
|
259
|
-
* Campaign preheader (optional).
|
|
260
|
-
* @maxLength 1000
|
|
261
|
-
*/
|
|
262
|
-
emailPreheader?: string | null;
|
|
263
|
-
}
|
|
264
|
-
interface Composer {
|
|
265
|
-
/**
|
|
266
|
-
* Internal data structure for editor/viewer to render the campaign.
|
|
267
|
-
* @maxLength 10000000
|
|
268
|
-
*/
|
|
269
|
-
composerDataJson?: string;
|
|
270
|
-
/** Default values of existing placeholders. */
|
|
271
|
-
defaultValues?: DefaultValues;
|
|
272
|
-
}
|
|
273
|
-
interface DefaultValues {
|
|
274
|
-
/** @maxSize 500 */
|
|
275
|
-
map?: Record<string, string>;
|
|
276
|
-
}
|
|
277
|
-
interface UpsertTranslationResponse {
|
|
278
|
-
}
|
|
279
|
-
interface GetUsedPlaceholderKeysRequest {
|
|
217
|
+
interface GetPlaceholderKeysRequest {
|
|
280
218
|
/**
|
|
281
219
|
* Campaign ID.
|
|
282
220
|
* @format GUID
|
|
283
221
|
*/
|
|
284
222
|
campaignId?: string;
|
|
285
223
|
}
|
|
286
|
-
interface
|
|
287
|
-
/**
|
|
288
|
-
* Keys of placeholders used in the automation.
|
|
289
|
-
* @maxLength 200
|
|
290
|
-
* @maxSize 300
|
|
291
|
-
*/
|
|
224
|
+
interface GetPlaceholderKeysResponse {
|
|
225
|
+
/** Keys of placeholders used in the campaign. */
|
|
292
226
|
placeholderKeys?: string[];
|
|
293
227
|
}
|
|
294
|
-
interface
|
|
295
|
-
/**
|
|
296
|
-
* rule ID in automations
|
|
297
|
-
* @format GUID
|
|
298
|
-
*/
|
|
299
|
-
automationRuleId?: string;
|
|
300
|
-
/**
|
|
301
|
-
* template ID configured for the automation
|
|
302
|
-
* @format GUID
|
|
303
|
-
*/
|
|
304
|
-
templateId?: string;
|
|
305
|
-
}
|
|
306
|
-
interface LookupCampaignMappingResponse {
|
|
307
|
-
/** @format GUID */
|
|
308
|
-
campaignId?: string | null;
|
|
309
|
-
}
|
|
310
|
-
interface UpsertAutomationTranslatorContentRequest {
|
|
311
|
-
/**
|
|
312
|
-
* Campaign ID that the content belongs to
|
|
313
|
-
* @format GUID
|
|
314
|
-
*/
|
|
315
|
-
campaignId?: string;
|
|
316
|
-
/** Automation translator content */
|
|
317
|
-
automationTranslatorContent?: AutomationTranslatorContent;
|
|
318
|
-
}
|
|
319
|
-
/** Automation Translator Content */
|
|
320
|
-
interface AutomationTranslatorContent {
|
|
321
|
-
/**
|
|
322
|
-
* AutomationTranslatorContent ID
|
|
323
|
-
* @minLength 1
|
|
324
|
-
* @maxLength 256
|
|
325
|
-
* @immutable
|
|
326
|
-
*/
|
|
327
|
-
id?: string;
|
|
328
|
-
/**
|
|
329
|
-
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
330
|
-
* @minLength 1
|
|
331
|
-
* @maxLength 800000
|
|
332
|
-
*/
|
|
333
|
-
json?: string;
|
|
334
|
-
}
|
|
335
|
-
interface UpsertAutomationTranslatorContentResponse {
|
|
336
|
-
}
|
|
337
|
-
interface GetAutomationTranslatorContentRequest {
|
|
338
|
-
/**
|
|
339
|
-
* Campaign ID
|
|
340
|
-
* @format GUID
|
|
341
|
-
*/
|
|
342
|
-
campaignId?: string;
|
|
343
|
-
}
|
|
344
|
-
interface GetAutomationTranslatorContentResponse {
|
|
345
|
-
/** Automation translator content */
|
|
346
|
-
automationTranslatorContent?: AutomationTranslatorContent;
|
|
347
|
-
}
|
|
348
|
-
interface SendTestBulkRequest {
|
|
349
|
-
/**
|
|
350
|
-
* Campaign ID
|
|
351
|
-
* @format GUID
|
|
352
|
-
*/
|
|
353
|
-
campaignId?: string;
|
|
354
|
-
/**
|
|
355
|
-
* Recipient email address
|
|
356
|
-
* @format EMAIL
|
|
357
|
-
*/
|
|
358
|
-
toEmailAddress?: string;
|
|
359
|
-
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
360
|
-
placeholders?: Record<string, PlaceholderContent>;
|
|
361
|
-
/**
|
|
362
|
-
* Sender from name
|
|
363
|
-
* @maxLength 100
|
|
364
|
-
*/
|
|
365
|
-
fromName?: string | null;
|
|
366
|
-
/**
|
|
367
|
-
* Reply-to email address
|
|
368
|
-
* @format EMAIL
|
|
369
|
-
*/
|
|
370
|
-
replyToEmailAddress?: string | null;
|
|
371
|
-
/**
|
|
372
|
-
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
373
|
-
* @format LANGUAGE
|
|
374
|
-
*/
|
|
375
|
-
language?: string | null;
|
|
376
|
-
}
|
|
377
|
-
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
378
|
-
text?: PlainText;
|
|
379
|
-
html?: Html;
|
|
380
|
-
money?: Money;
|
|
381
|
-
dateTime?: DateTime;
|
|
382
|
-
map?: Map;
|
|
383
|
-
array?: _Array;
|
|
384
|
-
enum?: PlaceholderContentEnum;
|
|
385
|
-
attachment?: Attachment;
|
|
386
|
-
integer?: Integer;
|
|
387
|
-
decimal?: Decimal;
|
|
388
|
-
}
|
|
389
|
-
/** @oneof */
|
|
390
|
-
interface PlaceholderContentValueOneOf {
|
|
391
|
-
text?: PlainText;
|
|
392
|
-
html?: Html;
|
|
393
|
-
money?: Money;
|
|
394
|
-
dateTime?: DateTime;
|
|
395
|
-
map?: Map;
|
|
396
|
-
array?: _Array;
|
|
397
|
-
enum?: PlaceholderContentEnum;
|
|
398
|
-
attachment?: Attachment;
|
|
399
|
-
integer?: Integer;
|
|
400
|
-
decimal?: Decimal;
|
|
401
|
-
}
|
|
402
|
-
interface PlainText {
|
|
403
|
-
text?: string;
|
|
404
|
-
}
|
|
405
|
-
interface Html {
|
|
406
|
-
html?: string;
|
|
407
|
-
}
|
|
408
|
-
/**
|
|
409
|
-
* Money.
|
|
410
|
-
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
411
|
-
*/
|
|
412
|
-
interface Money {
|
|
413
|
-
/**
|
|
414
|
-
* 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.
|
|
415
|
-
* @format DECIMAL_VALUE
|
|
416
|
-
*/
|
|
417
|
-
value?: string;
|
|
418
|
-
/**
|
|
419
|
-
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
420
|
-
* @format CURRENCY
|
|
421
|
-
*/
|
|
422
|
-
currency?: string;
|
|
423
|
-
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
424
|
-
formattedValue?: string | null;
|
|
425
|
-
}
|
|
426
|
-
interface DateTime {
|
|
427
|
-
timestamp?: Date | null;
|
|
428
|
-
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
429
|
-
timeZone?: string | null;
|
|
430
|
-
}
|
|
431
|
-
interface Map {
|
|
432
|
-
variables?: Record<string, PlaceholderContent>;
|
|
433
|
-
}
|
|
434
|
-
interface _Array {
|
|
435
|
-
items?: PlaceholderContent[];
|
|
436
|
-
}
|
|
437
|
-
interface PlaceholderContentEnum {
|
|
438
|
-
value?: string;
|
|
439
|
-
translation?: string;
|
|
440
|
-
}
|
|
441
|
-
interface Attachment {
|
|
442
|
-
fileName?: string;
|
|
443
|
-
downloadUrl?: string;
|
|
444
|
-
}
|
|
445
|
-
interface Integer {
|
|
446
|
-
/** min value: -2147483648, max value: 2147483647 */
|
|
447
|
-
value?: number;
|
|
448
|
-
}
|
|
449
|
-
interface Decimal {
|
|
450
|
-
/**
|
|
451
|
-
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
452
|
-
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
453
|
-
* @format DECIMAL_VALUE
|
|
454
|
-
*/
|
|
455
|
-
value?: string;
|
|
456
|
-
}
|
|
457
|
-
interface SendTestBulkResponse {
|
|
458
|
-
}
|
|
459
|
-
interface ListStatisticsRequest {
|
|
460
|
-
/**
|
|
461
|
-
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
462
|
-
* @format GUID
|
|
463
|
-
* @minSize 1
|
|
464
|
-
* @maxSize 100
|
|
465
|
-
*/
|
|
466
|
-
campaignIds: string[];
|
|
467
|
-
}
|
|
468
|
-
interface ListStatisticsResponse {
|
|
469
|
-
/** List of statistics. */
|
|
470
|
-
statistics?: CampaignStatisticsContainer[];
|
|
471
|
-
}
|
|
472
|
-
interface CampaignStatisticsContainer {
|
|
473
|
-
/**
|
|
474
|
-
* Campaign ID.
|
|
475
|
-
* @format GUID
|
|
476
|
-
*/
|
|
477
|
-
campaignId?: string;
|
|
478
|
-
/** Landing page statistics. */
|
|
479
|
-
landingPage?: LandingPageStatistics;
|
|
480
|
-
/** Email campaign statistics. */
|
|
481
|
-
email?: DistributionStatistics;
|
|
482
|
-
}
|
|
483
|
-
interface ListRecipientsRequest {
|
|
484
|
-
/**
|
|
485
|
-
* Campaign ID.
|
|
486
|
-
* @format GUID
|
|
487
|
-
*/
|
|
488
|
-
campaignId: string;
|
|
489
|
-
/** Email activity to filter. */
|
|
490
|
-
activity: RecipientsActivityEnumWithLiterals;
|
|
491
|
-
/** Pagination options. */
|
|
492
|
-
paging?: CursorPaging;
|
|
493
|
-
}
|
|
494
|
-
declare enum RecipientsActivityEnum {
|
|
495
|
-
UNKNOWN = "UNKNOWN",
|
|
496
|
-
DELIVERED = "DELIVERED",
|
|
497
|
-
OPENED = "OPENED",
|
|
498
|
-
CLICKED = "CLICKED",
|
|
499
|
-
BOUNCED = "BOUNCED",
|
|
500
|
-
NOT_SENT = "NOT_SENT",
|
|
501
|
-
SENT = "SENT",
|
|
502
|
-
NOT_OPENED = "NOT_OPENED"
|
|
503
|
-
}
|
|
504
|
-
/** @enumType */
|
|
505
|
-
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
506
|
-
interface CursorPaging {
|
|
507
|
-
/**
|
|
508
|
-
* Number of items to load.
|
|
509
|
-
* @max 1000
|
|
510
|
-
*/
|
|
511
|
-
limit?: number | null;
|
|
512
|
-
/**
|
|
513
|
-
* Pointer to the next or previous page in the list of results.
|
|
514
|
-
*
|
|
515
|
-
* You can get the relevant cursor token
|
|
516
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
517
|
-
* Not relevant for the first request.
|
|
518
|
-
* @maxLength 1000
|
|
519
|
-
*/
|
|
520
|
-
cursor?: string | null;
|
|
521
|
-
}
|
|
522
|
-
interface ListRecipientsResponse {
|
|
523
|
-
/** List of recipients. */
|
|
524
|
-
recipients?: CampaignRecipientDetails[];
|
|
525
|
-
/** Details on the paged set of returned results. */
|
|
526
|
-
pagingMetadata?: PagingMetadataV2;
|
|
527
|
-
}
|
|
528
|
-
interface CampaignRecipientDetails {
|
|
529
|
-
/**
|
|
530
|
-
* Contact ID.
|
|
531
|
-
* @format GUID
|
|
532
|
-
*/
|
|
533
|
-
contactId?: string;
|
|
534
|
-
/** Date and time of the last activity. */
|
|
535
|
-
lastActivityDate?: Date | null;
|
|
536
|
-
/**
|
|
537
|
-
* Primary email address of the contact.
|
|
538
|
-
* @format EMAIL
|
|
539
|
-
*/
|
|
540
|
-
emailAddress?: string;
|
|
541
|
-
/**
|
|
542
|
-
* Full name of the contact (optional).
|
|
543
|
-
* @maxLength 100
|
|
544
|
-
*/
|
|
545
|
-
fullName?: string | null;
|
|
546
|
-
/** Is this contact currently deleted from the site or not. */
|
|
547
|
-
contactDeleted?: boolean;
|
|
548
|
-
}
|
|
549
|
-
interface PagingMetadataV2 {
|
|
550
|
-
/** Number of items returned in the response. */
|
|
551
|
-
count?: number | null;
|
|
552
|
-
/** Offset that was requested. */
|
|
553
|
-
offset?: number | null;
|
|
554
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
555
|
-
total?: number | null;
|
|
556
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
557
|
-
tooManyToCount?: boolean | null;
|
|
558
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
559
|
-
cursors?: Cursors;
|
|
228
|
+
interface GetDefaultComponentsRequest {
|
|
560
229
|
}
|
|
561
|
-
interface
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
*/
|
|
566
|
-
next?: string | null;
|
|
567
|
-
/**
|
|
568
|
-
* Cursor pointing to the previous page in the list of results.
|
|
569
|
-
* @maxLength 16000
|
|
570
|
-
*/
|
|
571
|
-
prev?: string | null;
|
|
230
|
+
interface GetDefaultComponentsResponse {
|
|
231
|
+
footer?: Record<string, any> | null;
|
|
232
|
+
logo?: Record<string, any> | null;
|
|
233
|
+
follow?: Record<string, any> | null;
|
|
572
234
|
}
|
|
573
235
|
interface GetCampaignRequest {
|
|
574
236
|
/**
|
|
@@ -839,37 +501,117 @@ interface SoftBounce {
|
|
|
839
501
|
/** Reason the email soft bounced. */
|
|
840
502
|
reason?: string;
|
|
841
503
|
}
|
|
842
|
-
interface HardBounce {
|
|
843
|
-
/** Reason the email hard bounced. */
|
|
844
|
-
reason?: string;
|
|
504
|
+
interface HardBounce {
|
|
505
|
+
/** Reason the email hard bounced. */
|
|
506
|
+
reason?: string;
|
|
507
|
+
}
|
|
508
|
+
interface Scheduled {
|
|
509
|
+
/**
|
|
510
|
+
* ID of the campaign that was scheduled.
|
|
511
|
+
* @format GUID
|
|
512
|
+
*/
|
|
513
|
+
campaignId?: string;
|
|
514
|
+
/** The timestamp campaign is scheduled for. */
|
|
515
|
+
sendAt?: Date | null;
|
|
516
|
+
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
517
|
+
rescheduled?: boolean;
|
|
518
|
+
}
|
|
519
|
+
interface SendTestRequest {
|
|
520
|
+
/**
|
|
521
|
+
* Campaign ID.
|
|
522
|
+
* @format GUID
|
|
523
|
+
*/
|
|
524
|
+
campaignId: string;
|
|
525
|
+
/**
|
|
526
|
+
* Email subject.
|
|
527
|
+
* @maxLength 1000
|
|
528
|
+
*/
|
|
529
|
+
emailSubject?: string | null;
|
|
530
|
+
/**
|
|
531
|
+
* Recipient email address.
|
|
532
|
+
* @format EMAIL
|
|
533
|
+
*/
|
|
534
|
+
toEmailAddress: string;
|
|
535
|
+
}
|
|
536
|
+
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
537
|
+
text?: PlainText;
|
|
538
|
+
html?: Html;
|
|
539
|
+
money?: Money;
|
|
540
|
+
dateTime?: DateTime;
|
|
541
|
+
map?: Map;
|
|
542
|
+
array?: _Array;
|
|
543
|
+
enum?: PlaceholderContentEnum;
|
|
544
|
+
attachment?: Attachment;
|
|
545
|
+
integer?: Integer;
|
|
546
|
+
decimal?: Decimal;
|
|
547
|
+
}
|
|
548
|
+
/** @oneof */
|
|
549
|
+
interface PlaceholderContentValueOneOf {
|
|
550
|
+
text?: PlainText;
|
|
551
|
+
html?: Html;
|
|
552
|
+
money?: Money;
|
|
553
|
+
dateTime?: DateTime;
|
|
554
|
+
map?: Map;
|
|
555
|
+
array?: _Array;
|
|
556
|
+
enum?: PlaceholderContentEnum;
|
|
557
|
+
attachment?: Attachment;
|
|
558
|
+
integer?: Integer;
|
|
559
|
+
decimal?: Decimal;
|
|
560
|
+
}
|
|
561
|
+
interface PlainText {
|
|
562
|
+
text?: string;
|
|
563
|
+
}
|
|
564
|
+
interface Html {
|
|
565
|
+
html?: string;
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
* Money.
|
|
569
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
570
|
+
*/
|
|
571
|
+
interface Money {
|
|
572
|
+
/**
|
|
573
|
+
* 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.
|
|
574
|
+
* @format DECIMAL_VALUE
|
|
575
|
+
*/
|
|
576
|
+
value?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
579
|
+
* @format CURRENCY
|
|
580
|
+
*/
|
|
581
|
+
currency?: string;
|
|
582
|
+
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
583
|
+
formattedValue?: string | null;
|
|
584
|
+
}
|
|
585
|
+
interface DateTime {
|
|
586
|
+
timestamp?: Date | null;
|
|
587
|
+
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
588
|
+
timeZone?: string | null;
|
|
589
|
+
}
|
|
590
|
+
interface Map {
|
|
591
|
+
variables?: Record<string, PlaceholderContent>;
|
|
592
|
+
}
|
|
593
|
+
interface _Array {
|
|
594
|
+
items?: PlaceholderContent[];
|
|
595
|
+
}
|
|
596
|
+
interface PlaceholderContentEnum {
|
|
597
|
+
value?: string;
|
|
598
|
+
translation?: string;
|
|
599
|
+
}
|
|
600
|
+
interface Attachment {
|
|
601
|
+
fileName?: string;
|
|
602
|
+
downloadUrl?: string;
|
|
845
603
|
}
|
|
846
|
-
interface
|
|
847
|
-
/**
|
|
848
|
-
|
|
849
|
-
* @format GUID
|
|
850
|
-
*/
|
|
851
|
-
campaignId?: string;
|
|
852
|
-
/** The timestamp campaign is scheduled for. */
|
|
853
|
-
sendAt?: Date | null;
|
|
854
|
-
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
855
|
-
rescheduled?: boolean;
|
|
604
|
+
interface Integer {
|
|
605
|
+
/** min value: -2147483648, max value: 2147483647 */
|
|
606
|
+
value?: number;
|
|
856
607
|
}
|
|
857
|
-
interface
|
|
858
|
-
/**
|
|
859
|
-
* Campaign ID.
|
|
860
|
-
* @format GUID
|
|
861
|
-
*/
|
|
862
|
-
campaignId: string;
|
|
863
|
-
/**
|
|
864
|
-
* Email subject.
|
|
865
|
-
* @maxLength 1000
|
|
866
|
-
*/
|
|
867
|
-
emailSubject?: string | null;
|
|
608
|
+
interface Decimal {
|
|
868
609
|
/**
|
|
869
|
-
*
|
|
870
|
-
*
|
|
610
|
+
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
611
|
+
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
612
|
+
* @format DECIMAL_VALUE
|
|
871
613
|
*/
|
|
872
|
-
|
|
614
|
+
value?: string;
|
|
873
615
|
}
|
|
874
616
|
interface SendTestResponse {
|
|
875
617
|
}
|
|
@@ -1014,6 +756,19 @@ interface GetComposerResponse {
|
|
|
1014
756
|
*/
|
|
1015
757
|
emailPreheader?: string | null;
|
|
1016
758
|
}
|
|
759
|
+
interface Composer {
|
|
760
|
+
/**
|
|
761
|
+
* Internal data structure for editor/viewer to render the campaign.
|
|
762
|
+
* @maxLength 10000000
|
|
763
|
+
*/
|
|
764
|
+
composerDataJson?: string;
|
|
765
|
+
/** Default values of existing placeholders. */
|
|
766
|
+
defaultValues?: DefaultValues;
|
|
767
|
+
}
|
|
768
|
+
interface DefaultValues {
|
|
769
|
+
/** @maxSize 500 */
|
|
770
|
+
map?: Record<string, string>;
|
|
771
|
+
}
|
|
1017
772
|
interface UpdateComposerRequest {
|
|
1018
773
|
/**
|
|
1019
774
|
* Campaign ID.
|
|
@@ -1288,23 +1043,150 @@ interface AccountInfo {
|
|
|
1288
1043
|
*/
|
|
1289
1044
|
siteId?: string | null;
|
|
1290
1045
|
}
|
|
1291
|
-
interface
|
|
1046
|
+
interface EstimateFilterSizeRequest {
|
|
1047
|
+
/** Contacts filter expression. */
|
|
1048
|
+
filter?: Record<string, any> | null;
|
|
1049
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1050
|
+
activeContactsOnly?: boolean;
|
|
1292
1051
|
/**
|
|
1293
|
-
*
|
|
1052
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1053
|
+
* @minLength 1
|
|
1054
|
+
* @maxLength 100
|
|
1055
|
+
*/
|
|
1056
|
+
search?: string | null;
|
|
1057
|
+
}
|
|
1058
|
+
interface EstimateFilterSizeResponse {
|
|
1059
|
+
/** Mailing list size estimation. */
|
|
1060
|
+
estimation?: number;
|
|
1061
|
+
}
|
|
1062
|
+
interface EstimateAudienceSizeRequest {
|
|
1063
|
+
/**
|
|
1064
|
+
* Contact IDs of a campaign audience.
|
|
1294
1065
|
* @format GUID
|
|
1295
1066
|
*/
|
|
1296
|
-
|
|
1067
|
+
contactIds?: string[];
|
|
1068
|
+
/** Label IDs of a campaign audience. */
|
|
1069
|
+
labelIds?: string[];
|
|
1070
|
+
/** Contacts filter expression (json). */
|
|
1071
|
+
contactsFilter?: Record<string, any> | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1074
|
+
* @minLength 1
|
|
1075
|
+
* @maxLength 100
|
|
1076
|
+
*/
|
|
1077
|
+
search?: string | null;
|
|
1078
|
+
/**
|
|
1079
|
+
* Segment ids of a campaign audience.
|
|
1080
|
+
* @format GUID
|
|
1081
|
+
*/
|
|
1082
|
+
segmentIds?: string[];
|
|
1083
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1084
|
+
activeContactsOnly?: boolean;
|
|
1085
|
+
/**
|
|
1086
|
+
* Id of a campaign that is to be resent.
|
|
1087
|
+
* @format GUID
|
|
1088
|
+
*/
|
|
1089
|
+
resendCampaignId?: string | null;
|
|
1090
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1091
|
+
withTotal?: boolean;
|
|
1297
1092
|
}
|
|
1298
|
-
interface
|
|
1299
|
-
/**
|
|
1300
|
-
|
|
1093
|
+
interface EstimateAudienceSizeResponse {
|
|
1094
|
+
/** Audience size (estimated number of emails to be sent). */
|
|
1095
|
+
estimation?: number;
|
|
1096
|
+
/** Total number of contacts in provided audience (optional). */
|
|
1097
|
+
total?: number | null;
|
|
1301
1098
|
}
|
|
1302
|
-
interface
|
|
1099
|
+
interface ReconcileContactRequest {
|
|
1100
|
+
/**
|
|
1101
|
+
* Email address of the contact.
|
|
1102
|
+
* @format EMAIL
|
|
1103
|
+
*/
|
|
1104
|
+
emailAddress?: string;
|
|
1303
1105
|
}
|
|
1304
|
-
interface
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1106
|
+
interface ReconcileContactResponse {
|
|
1107
|
+
/** Created or retrieved contact. */
|
|
1108
|
+
contact?: Contact;
|
|
1109
|
+
}
|
|
1110
|
+
interface Contact {
|
|
1111
|
+
/**
|
|
1112
|
+
* Unique ID of the contact entity.
|
|
1113
|
+
* @format GUID
|
|
1114
|
+
*/
|
|
1115
|
+
id?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* Primary email address of the contact.
|
|
1118
|
+
* @format EMAIL
|
|
1119
|
+
*/
|
|
1120
|
+
emailAddress?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Full name of the contact (optional).
|
|
1123
|
+
* @maxLength 100
|
|
1124
|
+
*/
|
|
1125
|
+
fullName?: string | null;
|
|
1126
|
+
/**
|
|
1127
|
+
* Profile picture of the contact (optional).
|
|
1128
|
+
* @format WEB_URL
|
|
1129
|
+
* @maxLength 2048
|
|
1130
|
+
*/
|
|
1131
|
+
pictureUrl?: string | null;
|
|
1132
|
+
}
|
|
1133
|
+
interface SearchContactsRequest {
|
|
1134
|
+
/**
|
|
1135
|
+
* Text to search contacts by - can search by name or email address.
|
|
1136
|
+
* @maxLength 100
|
|
1137
|
+
*/
|
|
1138
|
+
searchTerm?: string;
|
|
1139
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1140
|
+
activeContactsOnly?: boolean;
|
|
1141
|
+
/**
|
|
1142
|
+
* Page size (default 50, max 1000).
|
|
1143
|
+
* @max 1000
|
|
1144
|
+
*/
|
|
1145
|
+
pageSize?: number | null;
|
|
1146
|
+
}
|
|
1147
|
+
interface SearchContactsResponse {
|
|
1148
|
+
/** Search results. */
|
|
1149
|
+
contacts?: Contact[];
|
|
1150
|
+
}
|
|
1151
|
+
interface GetLabelsRequest {
|
|
1152
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1153
|
+
activeContactsOnly?: boolean;
|
|
1154
|
+
}
|
|
1155
|
+
interface GetLabelsResponse {
|
|
1156
|
+
/** Returned labels with contact counts. */
|
|
1157
|
+
labels?: Label[];
|
|
1158
|
+
}
|
|
1159
|
+
interface Label {
|
|
1160
|
+
/**
|
|
1161
|
+
* Unique ID of the label entity.
|
|
1162
|
+
* @maxLength 100
|
|
1163
|
+
*/
|
|
1164
|
+
id?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* Name of the label.
|
|
1167
|
+
* @maxLength 100
|
|
1168
|
+
*/
|
|
1169
|
+
name?: string;
|
|
1170
|
+
/** Amount of contacts assigned to the label. */
|
|
1171
|
+
contactsCount?: number;
|
|
1172
|
+
}
|
|
1173
|
+
interface SubscribeFromLandingPageRequest {
|
|
1174
|
+
/**
|
|
1175
|
+
* Campaign ID that the subscription is happening from.
|
|
1176
|
+
* @format GUID
|
|
1177
|
+
*/
|
|
1178
|
+
campaignId?: string;
|
|
1179
|
+
/**
|
|
1180
|
+
* Email address that is entered into subscription field.
|
|
1181
|
+
* @format EMAIL
|
|
1182
|
+
*/
|
|
1183
|
+
emailAddress?: string;
|
|
1184
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1185
|
+
consent?: boolean;
|
|
1186
|
+
}
|
|
1187
|
+
interface SubscribeFromLandingPageResponse {
|
|
1188
|
+
/** @format GUID */
|
|
1189
|
+
contactId?: string;
|
|
1308
1190
|
}
|
|
1309
1191
|
interface ValidateLinkRequest {
|
|
1310
1192
|
/**
|
|
@@ -1328,150 +1210,268 @@ interface ValidateHtmlLinksResponse {
|
|
|
1328
1210
|
/** Non-valid links. */
|
|
1329
1211
|
blacklistedLinks?: string[];
|
|
1330
1212
|
}
|
|
1331
|
-
interface
|
|
1332
|
-
/**
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1213
|
+
interface GetCampaignMappingRequest {
|
|
1214
|
+
/**
|
|
1215
|
+
* rule ID in automations
|
|
1216
|
+
* @format GUID
|
|
1217
|
+
*/
|
|
1218
|
+
automationRuleId?: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* template ID configured for the automation
|
|
1221
|
+
* @format GUID
|
|
1222
|
+
*/
|
|
1223
|
+
templateId?: string;
|
|
1224
|
+
}
|
|
1225
|
+
interface GetCampaignMappingResponse {
|
|
1226
|
+
/** @format GUID */
|
|
1227
|
+
campaignId?: string;
|
|
1228
|
+
}
|
|
1229
|
+
interface UpsertTranslationRequest {
|
|
1230
|
+
/**
|
|
1231
|
+
* Campaign ID.
|
|
1232
|
+
* @format GUID
|
|
1233
|
+
*/
|
|
1234
|
+
campaignId?: string;
|
|
1235
|
+
/** Composer data. */
|
|
1236
|
+
composer?: Composer;
|
|
1237
|
+
/**
|
|
1238
|
+
* Translation language (optional, default value "EN").
|
|
1239
|
+
* @format LANGUAGE
|
|
1240
|
+
*/
|
|
1241
|
+
language?: string | null;
|
|
1242
|
+
/**
|
|
1243
|
+
* For BI event [36:1031] only (optional, default value "n/a").
|
|
1244
|
+
* @format GUID
|
|
1245
|
+
*/
|
|
1246
|
+
automationRuleId?: string | null;
|
|
1247
|
+
/** Should campaign also be published or not (default value "false"). */
|
|
1248
|
+
publish?: boolean;
|
|
1249
|
+
/**
|
|
1250
|
+
* Campaign subject (optional).
|
|
1251
|
+
* @maxLength 1000
|
|
1252
|
+
*/
|
|
1253
|
+
emailSubject?: string | null;
|
|
1254
|
+
/**
|
|
1255
|
+
* Campaign preheader (optional).
|
|
1256
|
+
* @maxLength 1000
|
|
1257
|
+
*/
|
|
1258
|
+
emailPreheader?: string | null;
|
|
1259
|
+
}
|
|
1260
|
+
interface UpsertTranslationResponse {
|
|
1261
|
+
}
|
|
1262
|
+
interface GetUsedPlaceholderKeysRequest {
|
|
1336
1263
|
/**
|
|
1337
|
-
*
|
|
1338
|
-
* @
|
|
1339
|
-
* @maxLength 100
|
|
1264
|
+
* Campaign ID.
|
|
1265
|
+
* @format GUID
|
|
1340
1266
|
*/
|
|
1341
|
-
|
|
1267
|
+
campaignId?: string;
|
|
1342
1268
|
}
|
|
1343
|
-
interface
|
|
1344
|
-
/**
|
|
1345
|
-
|
|
1269
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
1270
|
+
/**
|
|
1271
|
+
* Keys of placeholders used in the automation.
|
|
1272
|
+
* @maxLength 200
|
|
1273
|
+
* @maxSize 300
|
|
1274
|
+
*/
|
|
1275
|
+
placeholderKeys?: string[];
|
|
1346
1276
|
}
|
|
1347
|
-
interface
|
|
1277
|
+
interface LookupCampaignMappingRequest {
|
|
1348
1278
|
/**
|
|
1349
|
-
*
|
|
1279
|
+
* rule ID in automations
|
|
1350
1280
|
* @format GUID
|
|
1351
1281
|
*/
|
|
1352
|
-
|
|
1353
|
-
/** Label IDs of a campaign audience. */
|
|
1354
|
-
labelIds?: string[];
|
|
1355
|
-
/** Contacts filter expression (json). */
|
|
1356
|
-
contactsFilter?: Record<string, any> | null;
|
|
1282
|
+
automationRuleId?: string;
|
|
1357
1283
|
/**
|
|
1358
|
-
*
|
|
1359
|
-
* @
|
|
1360
|
-
* @maxLength 100
|
|
1284
|
+
* template ID configured for the automation
|
|
1285
|
+
* @format GUID
|
|
1361
1286
|
*/
|
|
1362
|
-
|
|
1287
|
+
templateId?: string;
|
|
1288
|
+
}
|
|
1289
|
+
interface LookupCampaignMappingResponse {
|
|
1290
|
+
/** @format GUID */
|
|
1291
|
+
campaignId?: string | null;
|
|
1292
|
+
}
|
|
1293
|
+
interface UpsertAutomationTranslatorContentRequest {
|
|
1363
1294
|
/**
|
|
1364
|
-
*
|
|
1295
|
+
* Campaign ID that the content belongs to
|
|
1365
1296
|
* @format GUID
|
|
1366
1297
|
*/
|
|
1367
|
-
|
|
1368
|
-
/**
|
|
1369
|
-
|
|
1298
|
+
campaignId?: string;
|
|
1299
|
+
/** Automation translator content */
|
|
1300
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
1301
|
+
}
|
|
1302
|
+
/** Automation Translator Content */
|
|
1303
|
+
interface AutomationTranslatorContent {
|
|
1370
1304
|
/**
|
|
1371
|
-
*
|
|
1372
|
-
* @
|
|
1305
|
+
* AutomationTranslatorContent ID
|
|
1306
|
+
* @minLength 1
|
|
1307
|
+
* @maxLength 256
|
|
1308
|
+
* @immutable
|
|
1373
1309
|
*/
|
|
1374
|
-
|
|
1375
|
-
/**
|
|
1376
|
-
|
|
1310
|
+
id?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
1313
|
+
* @minLength 1
|
|
1314
|
+
* @maxLength 800000
|
|
1315
|
+
*/
|
|
1316
|
+
json?: string;
|
|
1377
1317
|
}
|
|
1378
|
-
interface
|
|
1379
|
-
/** Audience size (estimated number of emails to be sent). */
|
|
1380
|
-
estimation?: number;
|
|
1381
|
-
/** Total number of contacts in provided audience (optional). */
|
|
1382
|
-
total?: number | null;
|
|
1318
|
+
interface UpsertAutomationTranslatorContentResponse {
|
|
1383
1319
|
}
|
|
1384
|
-
interface
|
|
1320
|
+
interface GetAutomationTranslatorContentRequest {
|
|
1385
1321
|
/**
|
|
1386
|
-
*
|
|
1387
|
-
* @format
|
|
1322
|
+
* Campaign ID
|
|
1323
|
+
* @format GUID
|
|
1388
1324
|
*/
|
|
1389
|
-
|
|
1325
|
+
campaignId?: string;
|
|
1390
1326
|
}
|
|
1391
|
-
interface
|
|
1392
|
-
/**
|
|
1393
|
-
|
|
1327
|
+
interface GetAutomationTranslatorContentResponse {
|
|
1328
|
+
/** Automation translator content */
|
|
1329
|
+
automationTranslatorContent?: AutomationTranslatorContent;
|
|
1394
1330
|
}
|
|
1395
|
-
interface
|
|
1331
|
+
interface SendTestBulkRequest {
|
|
1396
1332
|
/**
|
|
1397
|
-
*
|
|
1333
|
+
* Campaign ID
|
|
1398
1334
|
* @format GUID
|
|
1399
1335
|
*/
|
|
1400
|
-
|
|
1336
|
+
campaignId?: string;
|
|
1401
1337
|
/**
|
|
1402
|
-
*
|
|
1338
|
+
* Recipient email address
|
|
1403
1339
|
* @format EMAIL
|
|
1404
1340
|
*/
|
|
1405
|
-
|
|
1341
|
+
toEmailAddress?: string;
|
|
1342
|
+
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
1343
|
+
placeholders?: Record<string, PlaceholderContent>;
|
|
1406
1344
|
/**
|
|
1407
|
-
*
|
|
1345
|
+
* Sender from name
|
|
1408
1346
|
* @maxLength 100
|
|
1409
1347
|
*/
|
|
1410
|
-
|
|
1348
|
+
fromName?: string | null;
|
|
1411
1349
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
* @format
|
|
1414
|
-
* @maxLength 2048
|
|
1350
|
+
* Reply-to email address
|
|
1351
|
+
* @format EMAIL
|
|
1415
1352
|
*/
|
|
1416
|
-
|
|
1417
|
-
}
|
|
1418
|
-
interface SearchContactsRequest {
|
|
1353
|
+
replyToEmailAddress?: string | null;
|
|
1419
1354
|
/**
|
|
1420
|
-
*
|
|
1421
|
-
* @
|
|
1355
|
+
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
1356
|
+
* @format LANGUAGE
|
|
1422
1357
|
*/
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1358
|
+
language?: string | null;
|
|
1359
|
+
}
|
|
1360
|
+
interface SendTestBulkResponse {
|
|
1361
|
+
}
|
|
1362
|
+
interface ListStatisticsRequest {
|
|
1426
1363
|
/**
|
|
1427
|
-
*
|
|
1428
|
-
* @
|
|
1364
|
+
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1365
|
+
* @format GUID
|
|
1366
|
+
* @minSize 1
|
|
1367
|
+
* @maxSize 100
|
|
1429
1368
|
*/
|
|
1430
|
-
|
|
1369
|
+
campaignIds: string[];
|
|
1431
1370
|
}
|
|
1432
|
-
interface
|
|
1433
|
-
/**
|
|
1434
|
-
|
|
1371
|
+
interface ListStatisticsResponse {
|
|
1372
|
+
/** List of statistics. */
|
|
1373
|
+
statistics?: CampaignStatisticsContainer[];
|
|
1435
1374
|
}
|
|
1436
|
-
interface
|
|
1437
|
-
/**
|
|
1438
|
-
|
|
1375
|
+
interface CampaignStatisticsContainer {
|
|
1376
|
+
/**
|
|
1377
|
+
* Campaign ID.
|
|
1378
|
+
* @format GUID
|
|
1379
|
+
*/
|
|
1380
|
+
campaignId?: string;
|
|
1381
|
+
/** Landing page statistics. */
|
|
1382
|
+
landingPage?: LandingPageStatistics;
|
|
1383
|
+
/** Email campaign statistics. */
|
|
1384
|
+
email?: DistributionStatistics;
|
|
1439
1385
|
}
|
|
1440
|
-
interface
|
|
1441
|
-
/**
|
|
1442
|
-
|
|
1386
|
+
interface ListRecipientsRequest {
|
|
1387
|
+
/**
|
|
1388
|
+
* Campaign ID.
|
|
1389
|
+
* @format GUID
|
|
1390
|
+
*/
|
|
1391
|
+
campaignId: string;
|
|
1392
|
+
/** Email activity to filter. */
|
|
1393
|
+
activity: RecipientsActivityEnumWithLiterals;
|
|
1394
|
+
/** Pagination options. */
|
|
1395
|
+
paging?: CursorPaging;
|
|
1443
1396
|
}
|
|
1444
|
-
|
|
1397
|
+
declare enum RecipientsActivityEnum {
|
|
1398
|
+
UNKNOWN = "UNKNOWN",
|
|
1399
|
+
DELIVERED = "DELIVERED",
|
|
1400
|
+
OPENED = "OPENED",
|
|
1401
|
+
CLICKED = "CLICKED",
|
|
1402
|
+
BOUNCED = "BOUNCED",
|
|
1403
|
+
NOT_SENT = "NOT_SENT",
|
|
1404
|
+
SENT = "SENT",
|
|
1405
|
+
NOT_OPENED = "NOT_OPENED"
|
|
1406
|
+
}
|
|
1407
|
+
/** @enumType */
|
|
1408
|
+
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
1409
|
+
interface CursorPaging {
|
|
1445
1410
|
/**
|
|
1446
|
-
*
|
|
1447
|
-
* @
|
|
1411
|
+
* Number of items to load.
|
|
1412
|
+
* @max 1000
|
|
1448
1413
|
*/
|
|
1449
|
-
|
|
1414
|
+
limit?: number | null;
|
|
1450
1415
|
/**
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1416
|
+
* Pointer to the next or previous page in the list of results.
|
|
1417
|
+
*
|
|
1418
|
+
* You can get the relevant cursor token
|
|
1419
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1420
|
+
* Not relevant for the first request.
|
|
1421
|
+
* @maxLength 1000
|
|
1453
1422
|
*/
|
|
1454
|
-
|
|
1455
|
-
/** Amount of contacts assigned to the label. */
|
|
1456
|
-
contactsCount?: number;
|
|
1423
|
+
cursor?: string | null;
|
|
1457
1424
|
}
|
|
1458
|
-
interface
|
|
1425
|
+
interface ListRecipientsResponse {
|
|
1426
|
+
/** List of recipients. */
|
|
1427
|
+
recipients?: CampaignRecipientDetails[];
|
|
1428
|
+
/** Details on the paged set of returned results. */
|
|
1429
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1430
|
+
}
|
|
1431
|
+
interface CampaignRecipientDetails {
|
|
1459
1432
|
/**
|
|
1460
|
-
*
|
|
1433
|
+
* Contact ID.
|
|
1461
1434
|
* @format GUID
|
|
1462
1435
|
*/
|
|
1463
|
-
|
|
1436
|
+
contactId?: string;
|
|
1437
|
+
/** Date and time of the last activity. */
|
|
1438
|
+
lastActivityDate?: Date | null;
|
|
1464
1439
|
/**
|
|
1465
|
-
*
|
|
1440
|
+
* Primary email address of the contact.
|
|
1466
1441
|
* @format EMAIL
|
|
1467
1442
|
*/
|
|
1468
1443
|
emailAddress?: string;
|
|
1469
|
-
/**
|
|
1470
|
-
|
|
1444
|
+
/**
|
|
1445
|
+
* Full name of the contact (optional).
|
|
1446
|
+
* @maxLength 100
|
|
1447
|
+
*/
|
|
1448
|
+
fullName?: string | null;
|
|
1449
|
+
/** Is this contact currently deleted from the site or not. */
|
|
1450
|
+
contactDeleted?: boolean;
|
|
1471
1451
|
}
|
|
1472
|
-
interface
|
|
1473
|
-
/**
|
|
1474
|
-
|
|
1452
|
+
interface PagingMetadataV2 {
|
|
1453
|
+
/** Number of items returned in the response. */
|
|
1454
|
+
count?: number | null;
|
|
1455
|
+
/** Offset that was requested. */
|
|
1456
|
+
offset?: number | null;
|
|
1457
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1458
|
+
total?: number | null;
|
|
1459
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1460
|
+
tooManyToCount?: boolean | null;
|
|
1461
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1462
|
+
cursors?: Cursors;
|
|
1463
|
+
}
|
|
1464
|
+
interface Cursors {
|
|
1465
|
+
/**
|
|
1466
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1467
|
+
* @maxLength 16000
|
|
1468
|
+
*/
|
|
1469
|
+
next?: string | null;
|
|
1470
|
+
/**
|
|
1471
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1472
|
+
* @maxLength 16000
|
|
1473
|
+
*/
|
|
1474
|
+
prev?: string | null;
|
|
1475
1475
|
}
|
|
1476
1476
|
/** @docsIgnore */
|
|
1477
1477
|
type PublishApplicationErrors = {
|
|
@@ -1498,10 +1498,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
1498
1498
|
__responseType: Q;
|
|
1499
1499
|
__originalResponseType: R;
|
|
1500
1500
|
};
|
|
1501
|
-
declare function listStatistics(): __PublicMethodMetaInfo<'GET', {}, ListStatisticsRequest$1, ListStatisticsRequest, ListStatisticsResponse$1, ListStatisticsResponse>;
|
|
1502
|
-
declare function listRecipients(): __PublicMethodMetaInfo<'GET', {
|
|
1503
|
-
campaignId: string;
|
|
1504
|
-
}, ListRecipientsRequest$1, ListRecipientsRequest, ListRecipientsResponse$1, ListRecipientsResponse>;
|
|
1505
1501
|
declare function getCampaign(): __PublicMethodMetaInfo<'GET', {
|
|
1506
1502
|
campaignId: string;
|
|
1507
1503
|
}, GetCampaignRequest$1, GetCampaignRequest, GetCampaignResponse$1, GetCampaignResponse>;
|
|
@@ -1530,5 +1526,9 @@ declare function getAudience(): __PublicMethodMetaInfo<'POST', {
|
|
|
1530
1526
|
declare function identifySenderAddress(): __PublicMethodMetaInfo<'POST', {}, IdentifySenderAddressRequest$1, IdentifySenderAddressRequest, IdentifySenderAddressResponse$1, IdentifySenderAddressResponse>;
|
|
1531
1527
|
declare function validateLink(): __PublicMethodMetaInfo<'POST', {}, ValidateLinkRequest$1, ValidateLinkRequest, ValidateLinkResponse$1, ValidateLinkResponse>;
|
|
1532
1528
|
declare function validateHtmlLinks(): __PublicMethodMetaInfo<'POST', {}, ValidateHtmlLinksRequest$1, ValidateHtmlLinksRequest, ValidateHtmlLinksResponse$1, ValidateHtmlLinksResponse>;
|
|
1529
|
+
declare function listStatistics(): __PublicMethodMetaInfo<'GET', {}, ListStatisticsRequest$1, ListStatisticsRequest, ListStatisticsResponse$1, ListStatisticsResponse>;
|
|
1530
|
+
declare function listRecipients(): __PublicMethodMetaInfo<'GET', {
|
|
1531
|
+
campaignId: string;
|
|
1532
|
+
}, ListRecipientsRequest$1, ListRecipientsRequest, ListRecipientsResponse$1, ListRecipientsResponse>;
|
|
1533
1533
|
|
|
1534
1534
|
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type ArchiveCampaignRequest as ArchiveCampaignRequestOriginal, type ArchiveCampaignResponse as ArchiveCampaignResponseOriginal, type Archived as ArchivedOriginal, type Attachment as AttachmentOriginal, type AutomationTranslatorContent as AutomationTranslatorContentOriginal, type CampaignAudience as CampaignAudienceOriginal, CampaignEditorTypeEnum as CampaignEditorTypeEnumOriginal, type CampaignEditorTypeEnumWithLiterals as CampaignEditorTypeEnumWithLiteralsOriginal, type CampaignEditorType as CampaignEditorTypeOriginal, type Campaign as CampaignOriginal, type CampaignRecipientDetails as CampaignRecipientDetailsOriginal, CampaignSendingStateEnum as CampaignSendingStateEnumOriginal, type CampaignSendingStateEnumWithLiterals as CampaignSendingStateEnumWithLiteralsOriginal, type CampaignStatisticsContainer as CampaignStatisticsContainerOriginal, type CampaignStatistics as CampaignStatisticsOriginal, CampaignStatusEnum as CampaignStatusEnumOriginal, type CampaignStatusEnumWithLiterals as CampaignStatusEnumWithLiteralsOriginal, CampaignTypeEnum as CampaignTypeEnumOriginal, type CampaignTypeEnumWithLiterals as CampaignTypeEnumWithLiteralsOriginal, CampaignVisibilityStatusEnum as CampaignVisibilityStatusEnumOriginal, type CampaignVisibilityStatusEnumWithLiterals as CampaignVisibilityStatusEnumWithLiteralsOriginal, type Click as ClickOriginal, type Composer as ComposerOriginal, type Contact as ContactOriginal, type CountCampaignsRequest as CountCampaignsRequestOriginal, type CountCampaignsResponse as CountCampaignsResponseOriginal, type CreateCampaignRequest as CreateCampaignRequestOriginal, type CreateCampaignResponse as CreateCampaignResponseOriginal, type CreateFromTemplateRequest as CreateFromTemplateRequestOriginal, type CreateFromTemplateResponse as CreateFromTemplateResponseOriginal, type CreateFromUserTemplateRequest as CreateFromUserTemplateRequestOriginal, type CreateFromUserTemplateResponse as CreateFromUserTemplateResponseOriginal, type CreateUserTemplateRequest as CreateUserTemplateRequestOriginal, type CreateUserTemplateResponse as CreateUserTemplateResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DateTime as DateTimeOriginal, type Decimal as DecimalOriginal, type DefaultValues as DefaultValuesOriginal, type DeleteCampaignRequest as DeleteCampaignRequestOriginal, type DeleteCampaignResponse as DeleteCampaignResponseOriginal, type Distributed as DistributedOriginal, type DistributionStatistics as DistributionStatisticsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EmailActivityUpdatedEventTypeOneOf as EmailActivityUpdatedEventTypeOneOfOriginal, type EmailActivityUpdated as EmailActivityUpdatedOriginal, type EmailDistributionOptions as EmailDistributionOptionsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type EstimateAudienceSizeRequest as EstimateAudienceSizeRequestOriginal, type EstimateAudienceSizeResponse as EstimateAudienceSizeResponseOriginal, type EstimateFilterSizeRequest as EstimateFilterSizeRequestOriginal, type EstimateFilterSizeResponse as EstimateFilterSizeResponseOriginal, type GetAudienceRequest as GetAudienceRequestOriginal, type GetAudienceResponse as GetAudienceResponseOriginal, type GetAutomationTranslatorContentRequest as GetAutomationTranslatorContentRequestOriginal, type GetAutomationTranslatorContentResponse as GetAutomationTranslatorContentResponseOriginal, type GetCampaignMappingRequest as GetCampaignMappingRequestOriginal, type GetCampaignMappingResponse as GetCampaignMappingResponseOriginal, type GetCampaignRequest as GetCampaignRequestOriginal, type GetCampaignResponse as GetCampaignResponseOriginal, type GetComposerRequest as GetComposerRequestOriginal, type GetComposerResponse as GetComposerResponseOriginal, type GetDefaultComponentsRequest as GetDefaultComponentsRequestOriginal, type GetDefaultComponentsResponse as GetDefaultComponentsResponseOriginal, type GetLabelsRequest as GetLabelsRequestOriginal, type GetLabelsResponse as GetLabelsResponseOriginal, type GetPlaceholderKeysRequest as GetPlaceholderKeysRequestOriginal, type GetPlaceholderKeysResponse as GetPlaceholderKeysResponseOriginal, type GetUsedPlaceholderKeysRequest as GetUsedPlaceholderKeysRequestOriginal, type GetUsedPlaceholderKeysResponse as GetUsedPlaceholderKeysResponseOriginal, type HardBounce as HardBounceOriginal, type Html as HtmlOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IdentifySenderAddressRequest as IdentifySenderAddressRequestOriginal, type IdentifySenderAddressResponse as IdentifySenderAddressResponseOriginal, type Integer as IntegerOriginal, type Label as LabelOriginal, type LandingPageStatistics as LandingPageStatisticsOriginal, type ListCampaignsRequest as ListCampaignsRequestOriginal, type ListCampaignsResponse as ListCampaignsResponseOriginal, type ListRecipientsRequest as ListRecipientsRequestOriginal, type ListRecipientsResponse as ListRecipientsResponseOriginal, type ListStatisticsRequest as ListStatisticsRequestOriginal, type ListStatisticsResponse as ListStatisticsResponseOriginal, type LookupCampaignMappingRequest as LookupCampaignMappingRequestOriginal, type LookupCampaignMappingResponse as LookupCampaignMappingResponseOriginal, type Map as MapOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, type Open as OpenOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PauseSchedulingRequest as PauseSchedulingRequestOriginal, type PauseSchedulingResponse as PauseSchedulingResponseOriginal, type Paused as PausedOriginal, type PlaceholderContentEnum as PlaceholderContentEnumOriginal, type PlaceholderContent as PlaceholderContentOriginal, type PlaceholderContentValueOneOf as PlaceholderContentValueOneOfOriginal, type PlainText as PlainTextOriginal, type PreviewCampaignRequest as PreviewCampaignRequestOriginal, type PreviewCampaignResponse as PreviewCampaignResponseOriginal, type PublishApplicationErrors as PublishApplicationErrorsOriginal, type PublishCampaignRequest as PublishCampaignRequestOriginal, type PublishCampaignResponse as PublishCampaignResponseOriginal, type Published as PublishedOriginal, type PublishingData as PublishingDataOriginal, RecipientsActivityEnum as RecipientsActivityEnumOriginal, type RecipientsActivityEnumWithLiterals as RecipientsActivityEnumWithLiteralsOriginal, type ReconcileContactRequest as ReconcileContactRequestOriginal, type ReconcileContactResponse as ReconcileContactResponseOriginal, type Rejected as RejectedOriginal, type RejectionData as RejectionDataOriginal, RejectionReasonEnum as RejectionReasonEnumOriginal, type RejectionReasonEnumWithLiterals as RejectionReasonEnumWithLiteralsOriginal, type RescheduleRequest as RescheduleRequestOriginal, type RescheduleResponse as RescheduleResponseOriginal, type ResendToNonOpenersRequest as ResendToNonOpenersRequestOriginal, type ResendToNonOpenersResponse as ResendToNonOpenersResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ReuseCampaignRequest as ReuseCampaignRequestOriginal, type ReuseCampaignResponse as ReuseCampaignResponseOriginal, type Scheduled as ScheduledOriginal, type SearchContactsRequest as SearchContactsRequestOriginal, type SearchContactsResponse as SearchContactsResponseOriginal, type SendTestBulkRequest as SendTestBulkRequestOriginal, type SendTestBulkResponse as SendTestBulkResponseOriginal, type SendTestRequest as SendTestRequestOriginal, type SendTestResponse as SendTestResponseOriginal, type SoftBounce as SoftBounceOriginal, type SubscribeFromLandingPageRequest as SubscribeFromLandingPageRequestOriginal, type SubscribeFromLandingPageResponse as SubscribeFromLandingPageResponseOriginal, type Terminated as TerminatedOriginal, type TotalStatistics as TotalStatisticsOriginal, type UnarchiveCampaignRequest as UnarchiveCampaignRequestOriginal, type UnarchiveCampaignResponse as UnarchiveCampaignResponseOriginal, type Unarchived as UnarchivedOriginal, type UpdateComposerRequest as UpdateComposerRequestOriginal, type UpdateComposerResponse as UpdateComposerResponseOriginal, type UpdateTitleRequest as UpdateTitleRequestOriginal, type UpdateTitleResponse as UpdateTitleResponseOriginal, type UpsertAutomationTranslatorContentRequest as UpsertAutomationTranslatorContentRequestOriginal, type UpsertAutomationTranslatorContentResponse as UpsertAutomationTranslatorContentResponseOriginal, type UpsertTranslationRequest as UpsertTranslationRequestOriginal, type UpsertTranslationResponse as UpsertTranslationResponseOriginal, type ValidateHtmlLinksRequest as ValidateHtmlLinksRequestOriginal, type ValidateHtmlLinksResponse as ValidateHtmlLinksResponseOriginal, type ValidateLinkRequest as ValidateLinkRequestOriginal, type ValidateLinkResponse as ValidateLinkResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type _Array as _ArrayOriginal, type __PublicMethodMetaInfo, deleteCampaign, getAudience, getCampaign, identifySenderAddress, listCampaigns, listRecipients, listStatistics, pauseScheduling, publishCampaign, reschedule, reuseCampaign, sendTest, validateHtmlLinks, validateLink };
|