@wix/auto_sdk_email-marketing_campaigns 1.0.79 → 1.0.81
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +35 -35
- package/build/cjs/index.js +170 -170
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +534 -534
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +479 -479
- package/build/cjs/meta.js +134 -134
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +35 -35
- package/build/es/index.mjs +170 -170
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +534 -534
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +479 -479
- package/build/es/meta.mjs +134 -134
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +35 -35
- package/build/internal/cjs/index.js +170 -170
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +534 -534
- package/build/internal/cjs/index.typings.js +154 -154
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +479 -479
- package/build/internal/cjs/meta.js +134 -134
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +35 -35
- package/build/internal/es/index.mjs +170 -170
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +534 -534
- package/build/internal/es/index.typings.mjs +154 -154
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +479 -479
- package/build/internal/es/meta.mjs +134 -134
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
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
|
|
1
|
+
import { ListStatisticsRequest as ListStatisticsRequest$1, ListStatisticsResponse as ListStatisticsResponse$1, ListRecipientsRequest as ListRecipientsRequest$1, ListRecipientsResponse as ListRecipientsResponse$1, 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 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Campaign {
|
|
@@ -214,23 +214,361 @@ declare enum CampaignTypeEnum {
|
|
|
214
214
|
}
|
|
215
215
|
/** @enumType */
|
|
216
216
|
type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
|
|
217
|
-
interface
|
|
217
|
+
interface GetCampaignMappingRequest {
|
|
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 {
|
|
218
234
|
/**
|
|
219
235
|
* Campaign ID.
|
|
220
236
|
* @format GUID
|
|
221
237
|
*/
|
|
222
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;
|
|
223
263
|
}
|
|
224
|
-
interface
|
|
225
|
-
/**
|
|
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 {
|
|
280
|
+
/**
|
|
281
|
+
* Campaign ID.
|
|
282
|
+
* @format GUID
|
|
283
|
+
*/
|
|
284
|
+
campaignId?: string;
|
|
285
|
+
}
|
|
286
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
287
|
+
/**
|
|
288
|
+
* Keys of placeholders used in the automation.
|
|
289
|
+
* @maxLength 200
|
|
290
|
+
* @maxSize 300
|
|
291
|
+
*/
|
|
226
292
|
placeholderKeys?: string[];
|
|
227
293
|
}
|
|
228
|
-
interface
|
|
294
|
+
interface LookupCampaignMappingRequest {
|
|
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;
|
|
229
305
|
}
|
|
230
|
-
interface
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
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;
|
|
560
|
+
}
|
|
561
|
+
interface Cursors {
|
|
562
|
+
/**
|
|
563
|
+
* Cursor string pointing to the next page in the list of results.
|
|
564
|
+
* @maxLength 16000
|
|
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;
|
|
234
572
|
}
|
|
235
573
|
interface GetCampaignRequest {
|
|
236
574
|
/**
|
|
@@ -516,102 +854,22 @@ interface Scheduled {
|
|
|
516
854
|
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
517
855
|
rescheduled?: boolean;
|
|
518
856
|
}
|
|
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;
|
|
603
|
-
}
|
|
604
|
-
interface Integer {
|
|
605
|
-
/** min value: -2147483648, max value: 2147483647 */
|
|
606
|
-
value?: number;
|
|
607
|
-
}
|
|
608
|
-
interface Decimal {
|
|
857
|
+
interface SendTestRequest {
|
|
609
858
|
/**
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
* @format DECIMAL_VALUE
|
|
859
|
+
* Campaign ID.
|
|
860
|
+
* @format GUID
|
|
613
861
|
*/
|
|
614
|
-
|
|
862
|
+
campaignId: string;
|
|
863
|
+
/**
|
|
864
|
+
* Email subject.
|
|
865
|
+
* @maxLength 1000
|
|
866
|
+
*/
|
|
867
|
+
emailSubject?: string | null;
|
|
868
|
+
/**
|
|
869
|
+
* Recipient email address.
|
|
870
|
+
* @format EMAIL
|
|
871
|
+
*/
|
|
872
|
+
toEmailAddress: string;
|
|
615
873
|
}
|
|
616
874
|
interface SendTestResponse {
|
|
617
875
|
}
|
|
@@ -756,19 +1014,6 @@ interface GetComposerResponse {
|
|
|
756
1014
|
*/
|
|
757
1015
|
emailPreheader?: string | null;
|
|
758
1016
|
}
|
|
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
|
-
}
|
|
772
1017
|
interface UpdateComposerRequest {
|
|
773
1018
|
/**
|
|
774
1019
|
* Campaign ID.
|
|
@@ -1045,150 +1290,23 @@ interface AccountInfo {
|
|
|
1045
1290
|
*/
|
|
1046
1291
|
siteId?: string | null;
|
|
1047
1292
|
}
|
|
1048
|
-
interface
|
|
1049
|
-
/** Contacts filter expression. */
|
|
1050
|
-
filter?: Record<string, any> | null;
|
|
1051
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1052
|
-
activeContactsOnly?: boolean;
|
|
1053
|
-
/**
|
|
1054
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1055
|
-
* @minLength 1
|
|
1056
|
-
* @maxLength 100
|
|
1057
|
-
*/
|
|
1058
|
-
search?: string | null;
|
|
1059
|
-
}
|
|
1060
|
-
interface EstimateFilterSizeResponse {
|
|
1061
|
-
/** Mailing list size estimation. */
|
|
1062
|
-
estimation?: number;
|
|
1063
|
-
}
|
|
1064
|
-
interface EstimateAudienceSizeRequest {
|
|
1065
|
-
/**
|
|
1066
|
-
* Contact IDs of a campaign audience.
|
|
1067
|
-
* @format GUID
|
|
1068
|
-
*/
|
|
1069
|
-
contactIds?: string[];
|
|
1070
|
-
/** Label IDs of a campaign audience. */
|
|
1071
|
-
labelIds?: string[];
|
|
1072
|
-
/** Contacts filter expression (json). */
|
|
1073
|
-
contactsFilter?: Record<string, any> | null;
|
|
1074
|
-
/**
|
|
1075
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1076
|
-
* @minLength 1
|
|
1077
|
-
* @maxLength 100
|
|
1078
|
-
*/
|
|
1079
|
-
search?: string | null;
|
|
1080
|
-
/**
|
|
1081
|
-
* Segment ids of a campaign audience.
|
|
1082
|
-
* @format GUID
|
|
1083
|
-
*/
|
|
1084
|
-
segmentIds?: string[];
|
|
1085
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1086
|
-
activeContactsOnly?: boolean;
|
|
1087
|
-
/**
|
|
1088
|
-
* Id of a campaign that is to be resent.
|
|
1089
|
-
* @format GUID
|
|
1090
|
-
*/
|
|
1091
|
-
resendCampaignId?: string | null;
|
|
1092
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1093
|
-
withTotal?: boolean;
|
|
1094
|
-
}
|
|
1095
|
-
interface EstimateAudienceSizeResponse {
|
|
1096
|
-
/** Audience size (estimated number of emails to be sent). */
|
|
1097
|
-
estimation?: number;
|
|
1098
|
-
/** Total number of contacts in provided audience (optional). */
|
|
1099
|
-
total?: number | null;
|
|
1100
|
-
}
|
|
1101
|
-
interface ReconcileContactRequest {
|
|
1102
|
-
/**
|
|
1103
|
-
* Email address of the contact.
|
|
1104
|
-
* @format EMAIL
|
|
1105
|
-
*/
|
|
1106
|
-
emailAddress?: string;
|
|
1107
|
-
}
|
|
1108
|
-
interface ReconcileContactResponse {
|
|
1109
|
-
/** Created or retrieved contact. */
|
|
1110
|
-
contact?: Contact;
|
|
1111
|
-
}
|
|
1112
|
-
interface Contact {
|
|
1293
|
+
interface GetPlaceholderKeysRequest {
|
|
1113
1294
|
/**
|
|
1114
|
-
*
|
|
1295
|
+
* Campaign ID.
|
|
1115
1296
|
* @format GUID
|
|
1116
1297
|
*/
|
|
1117
|
-
|
|
1118
|
-
/**
|
|
1119
|
-
* Primary email address of the contact.
|
|
1120
|
-
* @format EMAIL
|
|
1121
|
-
*/
|
|
1122
|
-
emailAddress?: string;
|
|
1123
|
-
/**
|
|
1124
|
-
* Full name of the contact (optional).
|
|
1125
|
-
* @maxLength 100
|
|
1126
|
-
*/
|
|
1127
|
-
fullName?: string | null;
|
|
1128
|
-
/**
|
|
1129
|
-
* Profile picture of the contact (optional).
|
|
1130
|
-
* @format WEB_URL
|
|
1131
|
-
* @maxLength 2048
|
|
1132
|
-
*/
|
|
1133
|
-
pictureUrl?: string | null;
|
|
1134
|
-
}
|
|
1135
|
-
interface SearchContactsRequest {
|
|
1136
|
-
/**
|
|
1137
|
-
* Text to search contacts by - can search by name or email address.
|
|
1138
|
-
* @maxLength 100
|
|
1139
|
-
*/
|
|
1140
|
-
searchTerm?: string;
|
|
1141
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1142
|
-
activeContactsOnly?: boolean;
|
|
1143
|
-
/**
|
|
1144
|
-
* Page size (default 50, max 1000).
|
|
1145
|
-
* @max 1000
|
|
1146
|
-
*/
|
|
1147
|
-
pageSize?: number | null;
|
|
1148
|
-
}
|
|
1149
|
-
interface SearchContactsResponse {
|
|
1150
|
-
/** Search results. */
|
|
1151
|
-
contacts?: Contact[];
|
|
1152
|
-
}
|
|
1153
|
-
interface GetLabelsRequest {
|
|
1154
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1155
|
-
activeContactsOnly?: boolean;
|
|
1156
|
-
}
|
|
1157
|
-
interface GetLabelsResponse {
|
|
1158
|
-
/** Returned labels with contact counts. */
|
|
1159
|
-
labels?: Label[];
|
|
1298
|
+
campaignId?: string;
|
|
1160
1299
|
}
|
|
1161
|
-
interface
|
|
1162
|
-
/**
|
|
1163
|
-
|
|
1164
|
-
* @maxLength 100
|
|
1165
|
-
*/
|
|
1166
|
-
id?: string;
|
|
1167
|
-
/**
|
|
1168
|
-
* Name of the label.
|
|
1169
|
-
* @maxLength 100
|
|
1170
|
-
*/
|
|
1171
|
-
name?: string;
|
|
1172
|
-
/** Amount of contacts assigned to the label. */
|
|
1173
|
-
contactsCount?: number;
|
|
1300
|
+
interface GetPlaceholderKeysResponse {
|
|
1301
|
+
/** Keys of placeholders used in the campaign. */
|
|
1302
|
+
placeholderKeys?: string[];
|
|
1174
1303
|
}
|
|
1175
|
-
interface
|
|
1176
|
-
/**
|
|
1177
|
-
* Campaign ID that the subscription is happening from.
|
|
1178
|
-
* @format GUID
|
|
1179
|
-
*/
|
|
1180
|
-
campaignId?: string;
|
|
1181
|
-
/**
|
|
1182
|
-
* Email address that is entered into subscription field.
|
|
1183
|
-
* @format EMAIL
|
|
1184
|
-
*/
|
|
1185
|
-
emailAddress?: string;
|
|
1186
|
-
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1187
|
-
consent?: boolean;
|
|
1304
|
+
interface GetDefaultComponentsRequest {
|
|
1188
1305
|
}
|
|
1189
|
-
interface
|
|
1190
|
-
|
|
1191
|
-
|
|
1306
|
+
interface GetDefaultComponentsResponse {
|
|
1307
|
+
footer?: Record<string, any> | null;
|
|
1308
|
+
logo?: Record<string, any> | null;
|
|
1309
|
+
follow?: Record<string, any> | null;
|
|
1192
1310
|
}
|
|
1193
1311
|
interface ValidateLinkRequest {
|
|
1194
1312
|
/**
|
|
@@ -1201,279 +1319,161 @@ interface ValidateLinkResponse {
|
|
|
1201
1319
|
/** Whether the link is valid. */
|
|
1202
1320
|
valid?: boolean;
|
|
1203
1321
|
}
|
|
1204
|
-
interface ValidateHtmlLinksRequest {
|
|
1205
|
-
/**
|
|
1206
|
-
* HTML string with links.
|
|
1207
|
-
* @maxLength 1000000
|
|
1208
|
-
*/
|
|
1209
|
-
html: string;
|
|
1210
|
-
}
|
|
1211
|
-
interface ValidateHtmlLinksResponse {
|
|
1212
|
-
/** Non-valid links. */
|
|
1213
|
-
blacklistedLinks?: string[];
|
|
1214
|
-
}
|
|
1215
|
-
interface GetCampaignMappingRequest {
|
|
1216
|
-
/**
|
|
1217
|
-
* rule ID in automations
|
|
1218
|
-
* @format GUID
|
|
1219
|
-
*/
|
|
1220
|
-
automationRuleId?: string;
|
|
1221
|
-
/**
|
|
1222
|
-
* template ID configured for the automation
|
|
1223
|
-
* @format GUID
|
|
1224
|
-
*/
|
|
1225
|
-
templateId?: string;
|
|
1226
|
-
}
|
|
1227
|
-
interface GetCampaignMappingResponse {
|
|
1228
|
-
/** @format GUID */
|
|
1229
|
-
campaignId?: string;
|
|
1230
|
-
}
|
|
1231
|
-
interface UpsertTranslationRequest {
|
|
1232
|
-
/**
|
|
1233
|
-
* Campaign ID.
|
|
1234
|
-
* @format GUID
|
|
1235
|
-
*/
|
|
1236
|
-
campaignId?: string;
|
|
1237
|
-
/** Composer data. */
|
|
1238
|
-
composer?: Composer;
|
|
1239
|
-
/**
|
|
1240
|
-
* Translation language (optional, default value "EN").
|
|
1241
|
-
* @format LANGUAGE
|
|
1242
|
-
*/
|
|
1243
|
-
language?: string | null;
|
|
1244
|
-
/**
|
|
1245
|
-
* For BI event [36:1031] only (optional, default value "n/a").
|
|
1246
|
-
* @format GUID
|
|
1247
|
-
*/
|
|
1248
|
-
automationRuleId?: string | null;
|
|
1249
|
-
/** Should campaign also be published or not (default value "false"). */
|
|
1250
|
-
publish?: boolean;
|
|
1251
|
-
/**
|
|
1252
|
-
* Campaign subject (optional).
|
|
1253
|
-
* @maxLength 1000
|
|
1254
|
-
*/
|
|
1255
|
-
emailSubject?: string | null;
|
|
1256
|
-
/**
|
|
1257
|
-
* Campaign preheader (optional).
|
|
1258
|
-
* @maxLength 1000
|
|
1259
|
-
*/
|
|
1260
|
-
emailPreheader?: string | null;
|
|
1261
|
-
}
|
|
1262
|
-
interface UpsertTranslationResponse {
|
|
1263
|
-
}
|
|
1264
|
-
interface GetUsedPlaceholderKeysRequest {
|
|
1265
|
-
/**
|
|
1266
|
-
* Campaign ID.
|
|
1267
|
-
* @format GUID
|
|
1268
|
-
*/
|
|
1269
|
-
campaignId?: string;
|
|
1270
|
-
}
|
|
1271
|
-
interface GetUsedPlaceholderKeysResponse {
|
|
1272
|
-
/**
|
|
1273
|
-
* Keys of placeholders used in the automation.
|
|
1274
|
-
* @maxLength 200
|
|
1275
|
-
* @maxSize 300
|
|
1276
|
-
*/
|
|
1277
|
-
placeholderKeys?: string[];
|
|
1278
|
-
}
|
|
1279
|
-
interface LookupCampaignMappingRequest {
|
|
1322
|
+
interface ValidateHtmlLinksRequest {
|
|
1280
1323
|
/**
|
|
1281
|
-
*
|
|
1282
|
-
* @
|
|
1324
|
+
* HTML string with links.
|
|
1325
|
+
* @maxLength 1000000
|
|
1283
1326
|
*/
|
|
1284
|
-
|
|
1327
|
+
html: string;
|
|
1328
|
+
}
|
|
1329
|
+
interface ValidateHtmlLinksResponse {
|
|
1330
|
+
/** Non-valid links. */
|
|
1331
|
+
blacklistedLinks?: string[];
|
|
1332
|
+
}
|
|
1333
|
+
interface EstimateFilterSizeRequest {
|
|
1334
|
+
/** Contacts filter expression. */
|
|
1335
|
+
filter?: Record<string, any> | null;
|
|
1336
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1337
|
+
activeContactsOnly?: boolean;
|
|
1285
1338
|
/**
|
|
1286
|
-
*
|
|
1287
|
-
* @
|
|
1339
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1340
|
+
* @minLength 1
|
|
1341
|
+
* @maxLength 100
|
|
1288
1342
|
*/
|
|
1289
|
-
|
|
1343
|
+
search?: string | null;
|
|
1290
1344
|
}
|
|
1291
|
-
interface
|
|
1292
|
-
/**
|
|
1293
|
-
|
|
1345
|
+
interface EstimateFilterSizeResponse {
|
|
1346
|
+
/** Mailing list size estimation. */
|
|
1347
|
+
estimation?: number;
|
|
1294
1348
|
}
|
|
1295
|
-
interface
|
|
1349
|
+
interface EstimateAudienceSizeRequest {
|
|
1296
1350
|
/**
|
|
1297
|
-
*
|
|
1351
|
+
* Contact IDs of a campaign audience.
|
|
1298
1352
|
* @format GUID
|
|
1299
1353
|
*/
|
|
1300
|
-
|
|
1301
|
-
/**
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
interface AutomationTranslatorContent {
|
|
1354
|
+
contactIds?: string[];
|
|
1355
|
+
/** Label IDs of a campaign audience. */
|
|
1356
|
+
labelIds?: string[];
|
|
1357
|
+
/** Contacts filter expression (json). */
|
|
1358
|
+
contactsFilter?: Record<string, any> | null;
|
|
1306
1359
|
/**
|
|
1307
|
-
*
|
|
1360
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1308
1361
|
* @minLength 1
|
|
1309
|
-
* @maxLength
|
|
1310
|
-
* @immutable
|
|
1362
|
+
* @maxLength 100
|
|
1311
1363
|
*/
|
|
1312
|
-
|
|
1364
|
+
search?: string | null;
|
|
1313
1365
|
/**
|
|
1314
|
-
*
|
|
1315
|
-
* @
|
|
1316
|
-
* @maxLength 800000
|
|
1366
|
+
* Segment ids of a campaign audience.
|
|
1367
|
+
* @format GUID
|
|
1317
1368
|
*/
|
|
1318
|
-
|
|
1369
|
+
segmentIds?: string[];
|
|
1370
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1371
|
+
activeContactsOnly?: boolean;
|
|
1372
|
+
/**
|
|
1373
|
+
* Id of a campaign that is to be resent.
|
|
1374
|
+
* @format GUID
|
|
1375
|
+
*/
|
|
1376
|
+
resendCampaignId?: string | null;
|
|
1377
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1378
|
+
withTotal?: boolean;
|
|
1319
1379
|
}
|
|
1320
|
-
interface
|
|
1380
|
+
interface EstimateAudienceSizeResponse {
|
|
1381
|
+
/** Audience size (estimated number of emails to be sent). */
|
|
1382
|
+
estimation?: number;
|
|
1383
|
+
/** Total number of contacts in provided audience (optional). */
|
|
1384
|
+
total?: number | null;
|
|
1321
1385
|
}
|
|
1322
|
-
interface
|
|
1386
|
+
interface ReconcileContactRequest {
|
|
1323
1387
|
/**
|
|
1324
|
-
*
|
|
1325
|
-
* @format
|
|
1388
|
+
* Email address of the contact.
|
|
1389
|
+
* @format EMAIL
|
|
1326
1390
|
*/
|
|
1327
|
-
|
|
1391
|
+
emailAddress?: string;
|
|
1328
1392
|
}
|
|
1329
|
-
interface
|
|
1330
|
-
/**
|
|
1331
|
-
|
|
1393
|
+
interface ReconcileContactResponse {
|
|
1394
|
+
/** Created or retrieved contact. */
|
|
1395
|
+
contact?: Contact;
|
|
1332
1396
|
}
|
|
1333
|
-
interface
|
|
1397
|
+
interface Contact {
|
|
1334
1398
|
/**
|
|
1335
|
-
*
|
|
1399
|
+
* Unique ID of the contact entity.
|
|
1336
1400
|
* @format GUID
|
|
1337
1401
|
*/
|
|
1338
|
-
|
|
1402
|
+
id?: string;
|
|
1339
1403
|
/**
|
|
1340
|
-
*
|
|
1404
|
+
* Primary email address of the contact.
|
|
1341
1405
|
* @format EMAIL
|
|
1342
1406
|
*/
|
|
1343
|
-
|
|
1344
|
-
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
1345
|
-
placeholders?: Record<string, PlaceholderContent>;
|
|
1407
|
+
emailAddress?: string;
|
|
1346
1408
|
/**
|
|
1347
|
-
*
|
|
1409
|
+
* Full name of the contact (optional).
|
|
1348
1410
|
* @maxLength 100
|
|
1349
1411
|
*/
|
|
1350
|
-
|
|
1351
|
-
/**
|
|
1352
|
-
* Reply-to email address
|
|
1353
|
-
* @format EMAIL
|
|
1354
|
-
*/
|
|
1355
|
-
replyToEmailAddress?: string | null;
|
|
1412
|
+
fullName?: string | null;
|
|
1356
1413
|
/**
|
|
1357
|
-
*
|
|
1358
|
-
* @format
|
|
1414
|
+
* Profile picture of the contact (optional).
|
|
1415
|
+
* @format WEB_URL
|
|
1416
|
+
* @maxLength 2048
|
|
1359
1417
|
*/
|
|
1360
|
-
|
|
1361
|
-
}
|
|
1362
|
-
interface SendTestBulkResponse {
|
|
1418
|
+
pictureUrl?: string | null;
|
|
1363
1419
|
}
|
|
1364
|
-
interface
|
|
1420
|
+
interface SearchContactsRequest {
|
|
1365
1421
|
/**
|
|
1366
|
-
*
|
|
1367
|
-
* @
|
|
1368
|
-
* @minSize 1
|
|
1369
|
-
* @maxSize 100
|
|
1422
|
+
* Text to search contacts by - can search by name or email address.
|
|
1423
|
+
* @maxLength 100
|
|
1370
1424
|
*/
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
/** List of statistics. */
|
|
1375
|
-
statistics?: CampaignStatisticsContainer[];
|
|
1376
|
-
}
|
|
1377
|
-
interface CampaignStatisticsContainer {
|
|
1425
|
+
searchTerm?: string;
|
|
1426
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1427
|
+
activeContactsOnly?: boolean;
|
|
1378
1428
|
/**
|
|
1379
|
-
*
|
|
1380
|
-
* @
|
|
1429
|
+
* Page size (default 50, max 1000).
|
|
1430
|
+
* @max 1000
|
|
1381
1431
|
*/
|
|
1382
|
-
|
|
1383
|
-
/** Landing page statistics. */
|
|
1384
|
-
landingPage?: LandingPageStatistics;
|
|
1385
|
-
/** Email campaign statistics. */
|
|
1386
|
-
email?: DistributionStatistics;
|
|
1432
|
+
pageSize?: number | null;
|
|
1387
1433
|
}
|
|
1388
|
-
interface
|
|
1389
|
-
/**
|
|
1390
|
-
|
|
1391
|
-
* @format GUID
|
|
1392
|
-
*/
|
|
1393
|
-
campaignId: string;
|
|
1394
|
-
/** Email activity to filter. */
|
|
1395
|
-
activity: RecipientsActivityEnumWithLiterals;
|
|
1396
|
-
/** Pagination options. */
|
|
1397
|
-
paging?: CursorPaging;
|
|
1434
|
+
interface SearchContactsResponse {
|
|
1435
|
+
/** Search results. */
|
|
1436
|
+
contacts?: Contact[];
|
|
1398
1437
|
}
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
OPENED = "OPENED",
|
|
1403
|
-
CLICKED = "CLICKED",
|
|
1404
|
-
BOUNCED = "BOUNCED",
|
|
1405
|
-
NOT_SENT = "NOT_SENT",
|
|
1406
|
-
SENT = "SENT",
|
|
1407
|
-
NOT_OPENED = "NOT_OPENED"
|
|
1438
|
+
interface GetLabelsRequest {
|
|
1439
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1440
|
+
activeContactsOnly?: boolean;
|
|
1408
1441
|
}
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1442
|
+
interface GetLabelsResponse {
|
|
1443
|
+
/** Returned labels with contact counts. */
|
|
1444
|
+
labels?: Label[];
|
|
1445
|
+
}
|
|
1446
|
+
interface Label {
|
|
1412
1447
|
/**
|
|
1413
|
-
*
|
|
1414
|
-
* @
|
|
1448
|
+
* Unique ID of the label entity.
|
|
1449
|
+
* @maxLength 100
|
|
1415
1450
|
*/
|
|
1416
|
-
|
|
1451
|
+
id?: string;
|
|
1417
1452
|
/**
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
* You can get the relevant cursor token
|
|
1421
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1422
|
-
* Not relevant for the first request.
|
|
1423
|
-
* @maxLength 1000
|
|
1453
|
+
* Name of the label.
|
|
1454
|
+
* @maxLength 100
|
|
1424
1455
|
*/
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
/** List of recipients. */
|
|
1429
|
-
recipients?: CampaignRecipientDetails[];
|
|
1430
|
-
/** Details on the paged set of returned results. */
|
|
1431
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1456
|
+
name?: string;
|
|
1457
|
+
/** Amount of contacts assigned to the label. */
|
|
1458
|
+
contactsCount?: number;
|
|
1432
1459
|
}
|
|
1433
|
-
interface
|
|
1460
|
+
interface SubscribeFromLandingPageRequest {
|
|
1434
1461
|
/**
|
|
1435
|
-
*
|
|
1462
|
+
* Campaign ID that the subscription is happening from.
|
|
1436
1463
|
* @format GUID
|
|
1437
1464
|
*/
|
|
1438
|
-
|
|
1439
|
-
/** Date and time of the last activity. */
|
|
1440
|
-
lastActivityDate?: Date | null;
|
|
1465
|
+
campaignId?: string;
|
|
1441
1466
|
/**
|
|
1442
|
-
*
|
|
1467
|
+
* Email address that is entered into subscription field.
|
|
1443
1468
|
* @format EMAIL
|
|
1444
1469
|
*/
|
|
1445
1470
|
emailAddress?: string;
|
|
1446
|
-
/**
|
|
1447
|
-
|
|
1448
|
-
* @maxLength 100
|
|
1449
|
-
*/
|
|
1450
|
-
fullName?: string | null;
|
|
1451
|
-
/** Is this contact currently deleted from the site or not. */
|
|
1452
|
-
contactDeleted?: boolean;
|
|
1453
|
-
}
|
|
1454
|
-
interface PagingMetadataV2 {
|
|
1455
|
-
/** Number of items returned in the response. */
|
|
1456
|
-
count?: number | null;
|
|
1457
|
-
/** Offset that was requested. */
|
|
1458
|
-
offset?: number | null;
|
|
1459
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1460
|
-
total?: number | null;
|
|
1461
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1462
|
-
tooManyToCount?: boolean | null;
|
|
1463
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1464
|
-
cursors?: Cursors;
|
|
1471
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1472
|
+
consent?: boolean;
|
|
1465
1473
|
}
|
|
1466
|
-
interface
|
|
1467
|
-
/**
|
|
1468
|
-
|
|
1469
|
-
* @maxLength 16000
|
|
1470
|
-
*/
|
|
1471
|
-
next?: string | null;
|
|
1472
|
-
/**
|
|
1473
|
-
* Cursor pointing to the previous page in the list of results.
|
|
1474
|
-
* @maxLength 16000
|
|
1475
|
-
*/
|
|
1476
|
-
prev?: string | null;
|
|
1474
|
+
interface SubscribeFromLandingPageResponse {
|
|
1475
|
+
/** @format GUID */
|
|
1476
|
+
contactId?: string;
|
|
1477
1477
|
}
|
|
1478
1478
|
/** @docsIgnore */
|
|
1479
1479
|
type PublishApplicationErrors = {
|
|
@@ -1500,6 +1500,10 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
1500
1500
|
__responseType: Q;
|
|
1501
1501
|
__originalResponseType: R;
|
|
1502
1502
|
};
|
|
1503
|
+
declare function listStatistics(): __PublicMethodMetaInfo<'GET', {}, ListStatisticsRequest$1, ListStatisticsRequest, ListStatisticsResponse$1, ListStatisticsResponse>;
|
|
1504
|
+
declare function listRecipients(): __PublicMethodMetaInfo<'GET', {
|
|
1505
|
+
campaignId: string;
|
|
1506
|
+
}, ListRecipientsRequest$1, ListRecipientsRequest, ListRecipientsResponse$1, ListRecipientsResponse>;
|
|
1503
1507
|
declare function getCampaign(): __PublicMethodMetaInfo<'GET', {
|
|
1504
1508
|
campaignId: string;
|
|
1505
1509
|
}, GetCampaignRequest$1, GetCampaignRequest, GetCampaignResponse$1, GetCampaignResponse>;
|
|
@@ -1528,9 +1532,5 @@ declare function getAudience(): __PublicMethodMetaInfo<'POST', {
|
|
|
1528
1532
|
declare function identifySenderAddress(): __PublicMethodMetaInfo<'POST', {}, IdentifySenderAddressRequest$1, IdentifySenderAddressRequest, IdentifySenderAddressResponse$1, IdentifySenderAddressResponse>;
|
|
1529
1533
|
declare function validateLink(): __PublicMethodMetaInfo<'POST', {}, ValidateLinkRequest$1, ValidateLinkRequest, ValidateLinkResponse$1, ValidateLinkResponse>;
|
|
1530
1534
|
declare function validateHtmlLinks(): __PublicMethodMetaInfo<'POST', {}, ValidateHtmlLinksRequest$1, ValidateHtmlLinksRequest, ValidateHtmlLinksResponse$1, ValidateHtmlLinksResponse>;
|
|
1531
|
-
declare function listStatistics(): __PublicMethodMetaInfo<'GET', {}, ListStatisticsRequest$1, ListStatisticsRequest, ListStatisticsResponse$1, ListStatisticsResponse>;
|
|
1532
|
-
declare function listRecipients(): __PublicMethodMetaInfo<'GET', {
|
|
1533
|
-
campaignId: string;
|
|
1534
|
-
}, ListRecipientsRequest$1, ListRecipientsRequest, ListRecipientsResponse$1, ListRecipientsResponse>;
|
|
1535
1535
|
|
|
1536
1536
|
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 };
|