@wix/auto_sdk_email-marketing_campaigns 1.0.71 → 1.0.72
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 +539 -522
- package/build/cjs/index.typings.js +154 -154
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +625 -608
- 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 +539 -522
- package/build/es/index.typings.mjs +154 -154
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +625 -608
- 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 +539 -522
- 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 +625 -608
- 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 +539 -522
- 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 +625 -608
- 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
|
/**
|
|
@@ -533,86 +871,6 @@ interface SendTestRequest {
|
|
|
533
871
|
*/
|
|
534
872
|
toEmailAddress: string;
|
|
535
873
|
}
|
|
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 {
|
|
609
|
-
/**
|
|
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
|
|
613
|
-
*/
|
|
614
|
-
value?: string;
|
|
615
|
-
}
|
|
616
874
|
interface SendTestResponse {
|
|
617
875
|
}
|
|
618
876
|
interface PauseSchedulingRequest {
|
|
@@ -748,26 +1006,13 @@ interface GetComposerResponse {
|
|
|
748
1006
|
/**
|
|
749
1007
|
* Campaign subject.
|
|
750
1008
|
* @maxLength 1000
|
|
751
|
-
*/
|
|
752
|
-
emailSubject?: string;
|
|
753
|
-
/**
|
|
754
|
-
* Campaign preheader (optional).
|
|
755
|
-
* @maxLength 1000
|
|
756
|
-
*/
|
|
757
|
-
emailPreheader?: string | null;
|
|
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>;
|
|
1009
|
+
*/
|
|
1010
|
+
emailSubject?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Campaign preheader (optional).
|
|
1013
|
+
* @maxLength 1000
|
|
1014
|
+
*/
|
|
1015
|
+
emailPreheader?: string | null;
|
|
771
1016
|
}
|
|
772
1017
|
interface UpdateComposerRequest {
|
|
773
1018
|
/**
|
|
@@ -842,583 +1087,317 @@ interface GetAudienceResponse {
|
|
|
842
1087
|
/** Campaign audience. */
|
|
843
1088
|
audience?: CampaignAudience;
|
|
844
1089
|
}
|
|
845
|
-
interface CampaignAudience {
|
|
846
|
-
/**
|
|
847
|
-
* IDs of contacts to whom to send the campaign.
|
|
848
|
-
* @format GUID
|
|
849
|
-
* @maxSize 100
|
|
850
|
-
*/
|
|
851
|
-
contactIds?: string[];
|
|
852
|
-
/**
|
|
853
|
-
* Labels IDs.
|
|
854
|
-
* @maxLength 100
|
|
855
|
-
* @maxSize 20
|
|
856
|
-
*/
|
|
857
|
-
labelIds?: string[];
|
|
858
|
-
/**
|
|
859
|
-
* Segment IDs.
|
|
860
|
-
* @format GUID
|
|
861
|
-
* @maxSize 20
|
|
862
|
-
*/
|
|
863
|
-
segmentIds?: string[];
|
|
864
|
-
/** Filter for contacts in JSON format. */
|
|
865
|
-
contactsFilter?: Record<string, any> | null;
|
|
866
|
-
/**
|
|
867
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
868
|
-
* @minLength 1
|
|
869
|
-
* @maxLength 100
|
|
870
|
-
*/
|
|
871
|
-
contactsSearchTerm?: string | null;
|
|
872
|
-
/** Should "inactive" contacts be excluded or not. */
|
|
873
|
-
activeContactsOnly?: boolean;
|
|
874
|
-
}
|
|
875
|
-
interface IdentifySenderAddressRequest {
|
|
876
|
-
/**
|
|
877
|
-
* Email address to verify.
|
|
878
|
-
* @format EMAIL
|
|
879
|
-
* @minLength 6
|
|
880
|
-
* @maxLength 254
|
|
881
|
-
*/
|
|
882
|
-
emailAddress: string;
|
|
883
|
-
}
|
|
884
|
-
interface IdentifySenderAddressResponse {
|
|
885
|
-
/**
|
|
886
|
-
* Actual "from" address that will be used for sending emails.
|
|
887
|
-
* @format EMAIL
|
|
888
|
-
* @minLength 6
|
|
889
|
-
* @maxLength 254
|
|
890
|
-
*/
|
|
891
|
-
senderAddress?: string;
|
|
892
|
-
}
|
|
893
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
894
|
-
createdEvent?: EntityCreatedEvent;
|
|
895
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
896
|
-
deletedEvent?: EntityDeletedEvent;
|
|
897
|
-
actionEvent?: ActionEvent;
|
|
898
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
899
|
-
id?: string;
|
|
900
|
-
/**
|
|
901
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
902
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
903
|
-
*/
|
|
904
|
-
entityFqdn?: string;
|
|
905
|
-
/**
|
|
906
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
907
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
908
|
-
*/
|
|
909
|
-
slug?: string;
|
|
910
|
-
/** ID of the entity associated with the event. */
|
|
911
|
-
entityId?: string;
|
|
912
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
913
|
-
eventTime?: Date | null;
|
|
914
|
-
/**
|
|
915
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
916
|
-
* (for example, GDPR).
|
|
917
|
-
*/
|
|
918
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
919
|
-
/** If present, indicates the action that triggered the event. */
|
|
920
|
-
originatedFrom?: string | null;
|
|
921
|
-
/**
|
|
922
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
923
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
924
|
-
*/
|
|
925
|
-
entityEventSequence?: string | null;
|
|
926
|
-
}
|
|
927
|
-
/** @oneof */
|
|
928
|
-
interface DomainEventBodyOneOf {
|
|
929
|
-
createdEvent?: EntityCreatedEvent;
|
|
930
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
931
|
-
deletedEvent?: EntityDeletedEvent;
|
|
932
|
-
actionEvent?: ActionEvent;
|
|
933
|
-
}
|
|
934
|
-
interface EntityCreatedEvent {
|
|
935
|
-
entityAsJson?: string;
|
|
936
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
937
|
-
restoreInfo?: RestoreInfo;
|
|
938
|
-
}
|
|
939
|
-
interface RestoreInfo {
|
|
940
|
-
deletedDate?: Date | null;
|
|
941
|
-
}
|
|
942
|
-
interface EntityUpdatedEvent {
|
|
943
|
-
/**
|
|
944
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
945
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
946
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
947
|
-
*/
|
|
948
|
-
currentEntityAsJson?: string;
|
|
949
|
-
}
|
|
950
|
-
interface EntityDeletedEvent {
|
|
951
|
-
/** Entity that was deleted. */
|
|
952
|
-
deletedEntityAsJson?: string | null;
|
|
953
|
-
}
|
|
954
|
-
interface ActionEvent {
|
|
955
|
-
bodyAsJson?: string;
|
|
956
|
-
}
|
|
957
|
-
interface MessageEnvelope {
|
|
958
|
-
/**
|
|
959
|
-
* App instance ID.
|
|
960
|
-
* @format GUID
|
|
961
|
-
*/
|
|
962
|
-
instanceId?: string | null;
|
|
963
|
-
/**
|
|
964
|
-
* Event type.
|
|
965
|
-
* @maxLength 150
|
|
966
|
-
*/
|
|
967
|
-
eventType?: string;
|
|
968
|
-
/** The identification type and identity data. */
|
|
969
|
-
identity?: IdentificationData;
|
|
970
|
-
/** Stringify payload. */
|
|
971
|
-
data?: string;
|
|
972
|
-
}
|
|
973
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
974
|
-
/**
|
|
975
|
-
* ID of a site visitor that has not logged in to the site.
|
|
976
|
-
* @format GUID
|
|
977
|
-
*/
|
|
978
|
-
anonymousVisitorId?: string;
|
|
979
|
-
/**
|
|
980
|
-
* ID of a site visitor that has logged in to the site.
|
|
981
|
-
* @format GUID
|
|
982
|
-
*/
|
|
983
|
-
memberId?: string;
|
|
984
|
-
/**
|
|
985
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
986
|
-
* @format GUID
|
|
987
|
-
*/
|
|
988
|
-
wixUserId?: string;
|
|
989
|
-
/**
|
|
990
|
-
* ID of an app.
|
|
991
|
-
* @format GUID
|
|
992
|
-
*/
|
|
993
|
-
appId?: string;
|
|
994
|
-
/** @readonly */
|
|
995
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
996
|
-
}
|
|
997
|
-
/** @oneof */
|
|
998
|
-
interface IdentificationDataIdOneOf {
|
|
999
|
-
/**
|
|
1000
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1001
|
-
* @format GUID
|
|
1002
|
-
*/
|
|
1003
|
-
anonymousVisitorId?: string;
|
|
1004
|
-
/**
|
|
1005
|
-
* ID of a site visitor that has logged in to the site.
|
|
1006
|
-
* @format GUID
|
|
1007
|
-
*/
|
|
1008
|
-
memberId?: string;
|
|
1009
|
-
/**
|
|
1010
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1011
|
-
* @format GUID
|
|
1012
|
-
*/
|
|
1013
|
-
wixUserId?: string;
|
|
1014
|
-
/**
|
|
1015
|
-
* ID of an app.
|
|
1016
|
-
* @format GUID
|
|
1017
|
-
*/
|
|
1018
|
-
appId?: string;
|
|
1019
|
-
}
|
|
1020
|
-
declare enum WebhookIdentityType {
|
|
1021
|
-
UNKNOWN = "UNKNOWN",
|
|
1022
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1023
|
-
MEMBER = "MEMBER",
|
|
1024
|
-
WIX_USER = "WIX_USER",
|
|
1025
|
-
APP = "APP"
|
|
1026
|
-
}
|
|
1027
|
-
/** @enumType */
|
|
1028
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1029
|
-
interface EstimateFilterSizeRequest {
|
|
1030
|
-
/** Contacts filter expression. */
|
|
1031
|
-
filter?: Record<string, any> | null;
|
|
1032
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1033
|
-
activeContactsOnly?: boolean;
|
|
1034
|
-
/**
|
|
1035
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1036
|
-
* @minLength 1
|
|
1037
|
-
* @maxLength 100
|
|
1038
|
-
*/
|
|
1039
|
-
search?: string | null;
|
|
1040
|
-
}
|
|
1041
|
-
interface EstimateFilterSizeResponse {
|
|
1042
|
-
/** Mailing list size estimation. */
|
|
1043
|
-
estimation?: number;
|
|
1044
|
-
}
|
|
1045
|
-
interface EstimateAudienceSizeRequest {
|
|
1046
|
-
/**
|
|
1047
|
-
* Contact IDs of a campaign audience.
|
|
1048
|
-
* @format GUID
|
|
1049
|
-
*/
|
|
1050
|
-
contactIds?: string[];
|
|
1051
|
-
/** Label IDs of a campaign audience. */
|
|
1052
|
-
labelIds?: string[];
|
|
1053
|
-
/** Contacts filter expression (json). */
|
|
1054
|
-
contactsFilter?: Record<string, any> | null;
|
|
1055
|
-
/**
|
|
1056
|
-
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1057
|
-
* @minLength 1
|
|
1058
|
-
* @maxLength 100
|
|
1059
|
-
*/
|
|
1060
|
-
search?: string | null;
|
|
1061
|
-
/**
|
|
1062
|
-
* Segment ids of a campaign audience.
|
|
1063
|
-
* @format GUID
|
|
1064
|
-
*/
|
|
1065
|
-
segmentIds?: string[];
|
|
1066
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1067
|
-
activeContactsOnly?: boolean;
|
|
1068
|
-
/**
|
|
1069
|
-
* Id of a campaign that is to be resent.
|
|
1070
|
-
* @format GUID
|
|
1071
|
-
*/
|
|
1072
|
-
resendCampaignId?: string | null;
|
|
1073
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1074
|
-
withTotal?: boolean;
|
|
1075
|
-
}
|
|
1076
|
-
interface EstimateAudienceSizeResponse {
|
|
1077
|
-
/** Audience size (estimated number of emails to be sent). */
|
|
1078
|
-
estimation?: number;
|
|
1079
|
-
/** Total number of contacts in provided audience (optional). */
|
|
1080
|
-
total?: number | null;
|
|
1081
|
-
}
|
|
1082
|
-
interface ReconcileContactRequest {
|
|
1083
|
-
/**
|
|
1084
|
-
* Email address of the contact.
|
|
1085
|
-
* @format EMAIL
|
|
1086
|
-
*/
|
|
1087
|
-
emailAddress?: string;
|
|
1088
|
-
}
|
|
1089
|
-
interface ReconcileContactResponse {
|
|
1090
|
-
/** Created or retrieved contact. */
|
|
1091
|
-
contact?: Contact;
|
|
1092
|
-
}
|
|
1093
|
-
interface Contact {
|
|
1090
|
+
interface CampaignAudience {
|
|
1094
1091
|
/**
|
|
1095
|
-
*
|
|
1092
|
+
* IDs of contacts to whom to send the campaign.
|
|
1096
1093
|
* @format GUID
|
|
1094
|
+
* @maxSize 100
|
|
1097
1095
|
*/
|
|
1098
|
-
|
|
1099
|
-
/**
|
|
1100
|
-
* Primary email address of the contact.
|
|
1101
|
-
* @format EMAIL
|
|
1102
|
-
*/
|
|
1103
|
-
emailAddress?: string;
|
|
1096
|
+
contactIds?: string[];
|
|
1104
1097
|
/**
|
|
1105
|
-
*
|
|
1098
|
+
* Labels IDs.
|
|
1106
1099
|
* @maxLength 100
|
|
1100
|
+
* @maxSize 20
|
|
1107
1101
|
*/
|
|
1108
|
-
|
|
1102
|
+
labelIds?: string[];
|
|
1109
1103
|
/**
|
|
1110
|
-
*
|
|
1111
|
-
* @format
|
|
1112
|
-
* @
|
|
1104
|
+
* Segment IDs.
|
|
1105
|
+
* @format GUID
|
|
1106
|
+
* @maxSize 20
|
|
1113
1107
|
*/
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1108
|
+
segmentIds?: string[];
|
|
1109
|
+
/** Filter for contacts in JSON format. */
|
|
1110
|
+
contactsFilter?: Record<string, any> | null;
|
|
1117
1111
|
/**
|
|
1118
|
-
*
|
|
1112
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1113
|
+
* @minLength 1
|
|
1119
1114
|
* @maxLength 100
|
|
1120
1115
|
*/
|
|
1121
|
-
|
|
1122
|
-
/** Should "inactive" contacts be excluded or not
|
|
1116
|
+
contactsSearchTerm?: string | null;
|
|
1117
|
+
/** Should "inactive" contacts be excluded or not. */
|
|
1123
1118
|
activeContactsOnly?: boolean;
|
|
1119
|
+
}
|
|
1120
|
+
interface IdentifySenderAddressRequest {
|
|
1124
1121
|
/**
|
|
1125
|
-
*
|
|
1126
|
-
* @
|
|
1122
|
+
* Email address to verify.
|
|
1123
|
+
* @format EMAIL
|
|
1124
|
+
* @minLength 6
|
|
1125
|
+
* @maxLength 254
|
|
1127
1126
|
*/
|
|
1128
|
-
|
|
1129
|
-
}
|
|
1130
|
-
interface SearchContactsResponse {
|
|
1131
|
-
/** Search results. */
|
|
1132
|
-
contacts?: Contact[];
|
|
1133
|
-
}
|
|
1134
|
-
interface GetLabelsRequest {
|
|
1135
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1136
|
-
activeContactsOnly?: boolean;
|
|
1137
|
-
}
|
|
1138
|
-
interface GetLabelsResponse {
|
|
1139
|
-
/** Returned labels with contact counts. */
|
|
1140
|
-
labels?: Label[];
|
|
1127
|
+
emailAddress: string;
|
|
1141
1128
|
}
|
|
1142
|
-
interface
|
|
1129
|
+
interface IdentifySenderAddressResponse {
|
|
1143
1130
|
/**
|
|
1144
|
-
*
|
|
1145
|
-
* @
|
|
1131
|
+
* Actual "from" address that will be used for sending emails.
|
|
1132
|
+
* @format EMAIL
|
|
1133
|
+
* @minLength 6
|
|
1134
|
+
* @maxLength 254
|
|
1146
1135
|
*/
|
|
1136
|
+
senderAddress?: string;
|
|
1137
|
+
}
|
|
1138
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1139
|
+
createdEvent?: EntityCreatedEvent;
|
|
1140
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1141
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1142
|
+
actionEvent?: ActionEvent;
|
|
1143
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1147
1144
|
id?: string;
|
|
1148
1145
|
/**
|
|
1149
|
-
* Name of the
|
|
1150
|
-
*
|
|
1146
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1147
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1151
1148
|
*/
|
|
1152
|
-
|
|
1153
|
-
/** Amount of contacts assigned to the label. */
|
|
1154
|
-
contactsCount?: number;
|
|
1155
|
-
}
|
|
1156
|
-
interface SubscribeFromLandingPageRequest {
|
|
1149
|
+
entityFqdn?: string;
|
|
1157
1150
|
/**
|
|
1158
|
-
*
|
|
1159
|
-
*
|
|
1151
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1152
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1160
1153
|
*/
|
|
1161
|
-
|
|
1154
|
+
slug?: string;
|
|
1155
|
+
/** ID of the entity associated with the event. */
|
|
1156
|
+
entityId?: string;
|
|
1157
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1158
|
+
eventTime?: Date | null;
|
|
1162
1159
|
/**
|
|
1163
|
-
*
|
|
1164
|
-
*
|
|
1160
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1161
|
+
* (for example, GDPR).
|
|
1165
1162
|
*/
|
|
1166
|
-
|
|
1167
|
-
/**
|
|
1168
|
-
|
|
1169
|
-
}
|
|
1170
|
-
interface SubscribeFromLandingPageResponse {
|
|
1171
|
-
/** @format GUID */
|
|
1172
|
-
contactId?: string;
|
|
1173
|
-
}
|
|
1174
|
-
interface ValidateLinkRequest {
|
|
1163
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1164
|
+
/** If present, indicates the action that triggered the event. */
|
|
1165
|
+
originatedFrom?: string | null;
|
|
1175
1166
|
/**
|
|
1176
|
-
*
|
|
1177
|
-
*
|
|
1167
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1168
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1178
1169
|
*/
|
|
1179
|
-
|
|
1170
|
+
entityEventSequence?: string | null;
|
|
1180
1171
|
}
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1172
|
+
/** @oneof */
|
|
1173
|
+
interface DomainEventBodyOneOf {
|
|
1174
|
+
createdEvent?: EntityCreatedEvent;
|
|
1175
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1176
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1177
|
+
actionEvent?: ActionEvent;
|
|
1184
1178
|
}
|
|
1185
|
-
interface
|
|
1179
|
+
interface EntityCreatedEvent {
|
|
1180
|
+
entityAsJson?: string;
|
|
1181
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1182
|
+
restoreInfo?: RestoreInfo;
|
|
1183
|
+
}
|
|
1184
|
+
interface RestoreInfo {
|
|
1185
|
+
deletedDate?: Date | null;
|
|
1186
|
+
}
|
|
1187
|
+
interface EntityUpdatedEvent {
|
|
1186
1188
|
/**
|
|
1187
|
-
*
|
|
1188
|
-
*
|
|
1189
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1190
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1191
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1189
1192
|
*/
|
|
1190
|
-
|
|
1193
|
+
currentEntityAsJson?: string;
|
|
1191
1194
|
}
|
|
1192
|
-
interface
|
|
1193
|
-
/**
|
|
1194
|
-
|
|
1195
|
+
interface EntityDeletedEvent {
|
|
1196
|
+
/** Entity that was deleted. */
|
|
1197
|
+
deletedEntityAsJson?: string | null;
|
|
1195
1198
|
}
|
|
1196
|
-
interface
|
|
1199
|
+
interface ActionEvent {
|
|
1200
|
+
bodyAsJson?: string;
|
|
1201
|
+
}
|
|
1202
|
+
interface MessageEnvelope {
|
|
1197
1203
|
/**
|
|
1198
|
-
*
|
|
1204
|
+
* App instance ID.
|
|
1199
1205
|
* @format GUID
|
|
1200
1206
|
*/
|
|
1201
|
-
|
|
1207
|
+
instanceId?: string | null;
|
|
1202
1208
|
/**
|
|
1203
|
-
*
|
|
1204
|
-
* @
|
|
1209
|
+
* Event type.
|
|
1210
|
+
* @maxLength 150
|
|
1205
1211
|
*/
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
/**
|
|
1210
|
-
|
|
1212
|
+
eventType?: string;
|
|
1213
|
+
/** The identification type and identity data. */
|
|
1214
|
+
identity?: IdentificationData;
|
|
1215
|
+
/** Stringify payload. */
|
|
1216
|
+
data?: string;
|
|
1211
1217
|
}
|
|
1212
|
-
interface
|
|
1218
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1213
1219
|
/**
|
|
1214
|
-
*
|
|
1220
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1215
1221
|
* @format GUID
|
|
1216
1222
|
*/
|
|
1217
|
-
|
|
1218
|
-
/** Composer data. */
|
|
1219
|
-
composer?: Composer;
|
|
1220
|
-
/**
|
|
1221
|
-
* Translation language (optional, default value "EN").
|
|
1222
|
-
* @format LANGUAGE
|
|
1223
|
-
*/
|
|
1224
|
-
language?: string | null;
|
|
1223
|
+
anonymousVisitorId?: string;
|
|
1225
1224
|
/**
|
|
1226
|
-
*
|
|
1225
|
+
* ID of a site visitor that has logged in to the site.
|
|
1227
1226
|
* @format GUID
|
|
1228
1227
|
*/
|
|
1229
|
-
|
|
1230
|
-
/** Should campaign also be published or not (default value "false"). */
|
|
1231
|
-
publish?: boolean;
|
|
1228
|
+
memberId?: string;
|
|
1232
1229
|
/**
|
|
1233
|
-
*
|
|
1234
|
-
* @
|
|
1230
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1231
|
+
* @format GUID
|
|
1235
1232
|
*/
|
|
1236
|
-
|
|
1233
|
+
wixUserId?: string;
|
|
1237
1234
|
/**
|
|
1238
|
-
*
|
|
1239
|
-
* @
|
|
1235
|
+
* ID of an app.
|
|
1236
|
+
* @format GUID
|
|
1240
1237
|
*/
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1238
|
+
appId?: string;
|
|
1239
|
+
/** @readonly */
|
|
1240
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1244
1241
|
}
|
|
1245
|
-
|
|
1242
|
+
/** @oneof */
|
|
1243
|
+
interface IdentificationDataIdOneOf {
|
|
1246
1244
|
/**
|
|
1247
|
-
*
|
|
1245
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1248
1246
|
* @format GUID
|
|
1249
1247
|
*/
|
|
1250
|
-
|
|
1251
|
-
}
|
|
1252
|
-
interface GetUsedPlaceholderKeysResponse {
|
|
1248
|
+
anonymousVisitorId?: string;
|
|
1253
1249
|
/**
|
|
1254
|
-
*
|
|
1255
|
-
* @
|
|
1256
|
-
* @maxSize 300
|
|
1250
|
+
* ID of a site visitor that has logged in to the site.
|
|
1251
|
+
* @format GUID
|
|
1257
1252
|
*/
|
|
1258
|
-
|
|
1259
|
-
}
|
|
1260
|
-
interface LookupCampaignMappingRequest {
|
|
1253
|
+
memberId?: string;
|
|
1261
1254
|
/**
|
|
1262
|
-
*
|
|
1255
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1263
1256
|
* @format GUID
|
|
1264
1257
|
*/
|
|
1265
|
-
|
|
1258
|
+
wixUserId?: string;
|
|
1266
1259
|
/**
|
|
1267
|
-
*
|
|
1260
|
+
* ID of an app.
|
|
1268
1261
|
* @format GUID
|
|
1269
1262
|
*/
|
|
1270
|
-
|
|
1263
|
+
appId?: string;
|
|
1271
1264
|
}
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1265
|
+
declare enum WebhookIdentityType {
|
|
1266
|
+
UNKNOWN = "UNKNOWN",
|
|
1267
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1268
|
+
MEMBER = "MEMBER",
|
|
1269
|
+
WIX_USER = "WIX_USER",
|
|
1270
|
+
APP = "APP"
|
|
1275
1271
|
}
|
|
1276
|
-
|
|
1272
|
+
/** @enumType */
|
|
1273
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1274
|
+
interface AccountDetails {
|
|
1277
1275
|
/**
|
|
1278
|
-
*
|
|
1276
|
+
* ID of the account.
|
|
1279
1277
|
* @format GUID
|
|
1280
1278
|
*/
|
|
1281
|
-
|
|
1282
|
-
/** Automation translator content */
|
|
1283
|
-
automationTranslatorContent?: AutomationTranslatorContent;
|
|
1284
|
-
}
|
|
1285
|
-
/** Automation Translator Content */
|
|
1286
|
-
interface AutomationTranslatorContent {
|
|
1279
|
+
accountId?: string | null;
|
|
1287
1280
|
/**
|
|
1288
|
-
*
|
|
1289
|
-
* @
|
|
1290
|
-
* @maxLength 256
|
|
1291
|
-
* @immutable
|
|
1281
|
+
* ID of the parent account.
|
|
1282
|
+
* @format GUID
|
|
1292
1283
|
*/
|
|
1293
|
-
|
|
1284
|
+
parentAccountId?: string | null;
|
|
1294
1285
|
/**
|
|
1295
|
-
*
|
|
1296
|
-
* @
|
|
1297
|
-
* @maxLength 800000
|
|
1286
|
+
* ID of the site, if applicable.
|
|
1287
|
+
* @format GUID
|
|
1298
1288
|
*/
|
|
1299
|
-
|
|
1300
|
-
}
|
|
1301
|
-
interface UpsertAutomationTranslatorContentResponse {
|
|
1289
|
+
siteId?: string | null;
|
|
1302
1290
|
}
|
|
1303
|
-
interface
|
|
1291
|
+
interface GetPlaceholderKeysRequest {
|
|
1304
1292
|
/**
|
|
1305
|
-
* Campaign ID
|
|
1293
|
+
* Campaign ID.
|
|
1306
1294
|
* @format GUID
|
|
1307
1295
|
*/
|
|
1308
1296
|
campaignId?: string;
|
|
1309
1297
|
}
|
|
1310
|
-
interface
|
|
1311
|
-
/**
|
|
1312
|
-
|
|
1298
|
+
interface GetPlaceholderKeysResponse {
|
|
1299
|
+
/** Keys of placeholders used in the campaign. */
|
|
1300
|
+
placeholderKeys?: string[];
|
|
1313
1301
|
}
|
|
1314
|
-
interface
|
|
1302
|
+
interface GetDefaultComponentsRequest {
|
|
1303
|
+
}
|
|
1304
|
+
interface GetDefaultComponentsResponse {
|
|
1305
|
+
footer?: Record<string, any> | null;
|
|
1306
|
+
logo?: Record<string, any> | null;
|
|
1307
|
+
follow?: Record<string, any> | null;
|
|
1308
|
+
}
|
|
1309
|
+
interface ValidateLinkRequest {
|
|
1315
1310
|
/**
|
|
1316
|
-
*
|
|
1317
|
-
* @
|
|
1311
|
+
* URL to validate.
|
|
1312
|
+
* @minLength 1
|
|
1318
1313
|
*/
|
|
1319
|
-
|
|
1314
|
+
url: string;
|
|
1315
|
+
}
|
|
1316
|
+
interface ValidateLinkResponse {
|
|
1317
|
+
/** Whether the link is valid. */
|
|
1318
|
+
valid?: boolean;
|
|
1319
|
+
}
|
|
1320
|
+
interface ValidateHtmlLinksRequest {
|
|
1320
1321
|
/**
|
|
1321
|
-
*
|
|
1322
|
-
* @
|
|
1322
|
+
* HTML string with links.
|
|
1323
|
+
* @maxLength 1000000
|
|
1323
1324
|
*/
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1325
|
+
html: string;
|
|
1326
|
+
}
|
|
1327
|
+
interface ValidateHtmlLinksResponse {
|
|
1328
|
+
/** Non-valid links. */
|
|
1329
|
+
blacklistedLinks?: string[];
|
|
1330
|
+
}
|
|
1331
|
+
interface EstimateFilterSizeRequest {
|
|
1332
|
+
/** Contacts filter expression. */
|
|
1333
|
+
filter?: Record<string, any> | null;
|
|
1334
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1335
|
+
activeContactsOnly?: boolean;
|
|
1327
1336
|
/**
|
|
1328
|
-
*
|
|
1337
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1338
|
+
* @minLength 1
|
|
1329
1339
|
* @maxLength 100
|
|
1330
1340
|
*/
|
|
1331
|
-
|
|
1332
|
-
/**
|
|
1333
|
-
* Reply-to email address
|
|
1334
|
-
* @format EMAIL
|
|
1335
|
-
*/
|
|
1336
|
-
replyToEmailAddress?: string | null;
|
|
1337
|
-
/**
|
|
1338
|
-
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
1339
|
-
* @format LANGUAGE
|
|
1340
|
-
*/
|
|
1341
|
-
language?: string | null;
|
|
1341
|
+
search?: string | null;
|
|
1342
1342
|
}
|
|
1343
|
-
interface
|
|
1343
|
+
interface EstimateFilterSizeResponse {
|
|
1344
|
+
/** Mailing list size estimation. */
|
|
1345
|
+
estimation?: number;
|
|
1344
1346
|
}
|
|
1345
|
-
interface
|
|
1347
|
+
interface EstimateAudienceSizeRequest {
|
|
1346
1348
|
/**
|
|
1347
|
-
* IDs of
|
|
1349
|
+
* Contact IDs of a campaign audience.
|
|
1348
1350
|
* @format GUID
|
|
1349
|
-
* @minSize 1
|
|
1350
|
-
* @maxSize 100
|
|
1351
1351
|
*/
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
/**
|
|
1356
|
-
|
|
1357
|
-
}
|
|
1358
|
-
interface CampaignStatisticsContainer {
|
|
1352
|
+
contactIds?: string[];
|
|
1353
|
+
/** Label IDs of a campaign audience. */
|
|
1354
|
+
labelIds?: string[];
|
|
1355
|
+
/** Contacts filter expression (json). */
|
|
1356
|
+
contactsFilter?: Record<string, any> | null;
|
|
1359
1357
|
/**
|
|
1360
|
-
*
|
|
1358
|
+
* Contacts plain text search expression (searches in name, phone and email fields).
|
|
1359
|
+
* @minLength 1
|
|
1360
|
+
* @maxLength 100
|
|
1361
|
+
*/
|
|
1362
|
+
search?: string | null;
|
|
1363
|
+
/**
|
|
1364
|
+
* Segment ids of a campaign audience.
|
|
1361
1365
|
* @format GUID
|
|
1362
1366
|
*/
|
|
1363
|
-
|
|
1364
|
-
/**
|
|
1365
|
-
|
|
1366
|
-
/** Email campaign statistics. */
|
|
1367
|
-
email?: DistributionStatistics;
|
|
1368
|
-
}
|
|
1369
|
-
interface ListRecipientsRequest {
|
|
1367
|
+
segmentIds?: string[];
|
|
1368
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1369
|
+
activeContactsOnly?: boolean;
|
|
1370
1370
|
/**
|
|
1371
|
-
*
|
|
1371
|
+
* Id of a campaign that is to be resent.
|
|
1372
1372
|
* @format GUID
|
|
1373
1373
|
*/
|
|
1374
|
-
|
|
1375
|
-
/**
|
|
1376
|
-
|
|
1377
|
-
/** Pagination options. */
|
|
1378
|
-
paging?: CursorPaging;
|
|
1374
|
+
resendCampaignId?: string | null;
|
|
1375
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1376
|
+
withTotal?: boolean;
|
|
1379
1377
|
}
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
BOUNCED = "BOUNCED",
|
|
1386
|
-
NOT_SENT = "NOT_SENT",
|
|
1387
|
-
SENT = "SENT",
|
|
1388
|
-
NOT_OPENED = "NOT_OPENED"
|
|
1378
|
+
interface EstimateAudienceSizeResponse {
|
|
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;
|
|
1389
1383
|
}
|
|
1390
|
-
|
|
1391
|
-
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
1392
|
-
interface CursorPaging {
|
|
1393
|
-
/**
|
|
1394
|
-
* Number of items to load.
|
|
1395
|
-
* @max 1000
|
|
1396
|
-
*/
|
|
1397
|
-
limit?: number | null;
|
|
1384
|
+
interface ReconcileContactRequest {
|
|
1398
1385
|
/**
|
|
1399
|
-
*
|
|
1400
|
-
*
|
|
1401
|
-
* You can get the relevant cursor token
|
|
1402
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1403
|
-
* Not relevant for the first request.
|
|
1404
|
-
* @maxLength 1000
|
|
1386
|
+
* Email address of the contact.
|
|
1387
|
+
* @format EMAIL
|
|
1405
1388
|
*/
|
|
1406
|
-
|
|
1389
|
+
emailAddress?: string;
|
|
1407
1390
|
}
|
|
1408
|
-
interface
|
|
1409
|
-
/**
|
|
1410
|
-
|
|
1411
|
-
/** Details on the paged set of returned results. */
|
|
1412
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1391
|
+
interface ReconcileContactResponse {
|
|
1392
|
+
/** Created or retrieved contact. */
|
|
1393
|
+
contact?: Contact;
|
|
1413
1394
|
}
|
|
1414
|
-
interface
|
|
1395
|
+
interface Contact {
|
|
1415
1396
|
/**
|
|
1416
|
-
*
|
|
1397
|
+
* Unique ID of the contact entity.
|
|
1417
1398
|
* @format GUID
|
|
1418
1399
|
*/
|
|
1419
|
-
|
|
1420
|
-
/** Date and time of the last activity. */
|
|
1421
|
-
lastActivityDate?: Date | null;
|
|
1400
|
+
id?: string;
|
|
1422
1401
|
/**
|
|
1423
1402
|
* Primary email address of the contact.
|
|
1424
1403
|
* @format EMAIL
|
|
@@ -1429,32 +1408,70 @@ interface CampaignRecipientDetails {
|
|
|
1429
1408
|
* @maxLength 100
|
|
1430
1409
|
*/
|
|
1431
1410
|
fullName?: string | null;
|
|
1432
|
-
/**
|
|
1433
|
-
|
|
1411
|
+
/**
|
|
1412
|
+
* Profile picture of the contact (optional).
|
|
1413
|
+
* @format WEB_URL
|
|
1414
|
+
* @maxLength 2048
|
|
1415
|
+
*/
|
|
1416
|
+
pictureUrl?: string | null;
|
|
1434
1417
|
}
|
|
1435
|
-
interface
|
|
1436
|
-
/**
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1418
|
+
interface SearchContactsRequest {
|
|
1419
|
+
/**
|
|
1420
|
+
* Text to search contacts by - can search by name or email address.
|
|
1421
|
+
* @maxLength 100
|
|
1422
|
+
*/
|
|
1423
|
+
searchTerm?: string;
|
|
1424
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1425
|
+
activeContactsOnly?: boolean;
|
|
1426
|
+
/**
|
|
1427
|
+
* Page size (default 50, max 1000).
|
|
1428
|
+
* @max 1000
|
|
1429
|
+
*/
|
|
1430
|
+
pageSize?: number | null;
|
|
1446
1431
|
}
|
|
1447
|
-
interface
|
|
1432
|
+
interface SearchContactsResponse {
|
|
1433
|
+
/** Search results. */
|
|
1434
|
+
contacts?: Contact[];
|
|
1435
|
+
}
|
|
1436
|
+
interface GetLabelsRequest {
|
|
1437
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1438
|
+
activeContactsOnly?: boolean;
|
|
1439
|
+
}
|
|
1440
|
+
interface GetLabelsResponse {
|
|
1441
|
+
/** Returned labels with contact counts. */
|
|
1442
|
+
labels?: Label[];
|
|
1443
|
+
}
|
|
1444
|
+
interface Label {
|
|
1448
1445
|
/**
|
|
1449
|
-
*
|
|
1450
|
-
* @maxLength
|
|
1446
|
+
* Unique ID of the label entity.
|
|
1447
|
+
* @maxLength 100
|
|
1451
1448
|
*/
|
|
1452
|
-
|
|
1449
|
+
id?: string;
|
|
1453
1450
|
/**
|
|
1454
|
-
*
|
|
1455
|
-
* @maxLength
|
|
1451
|
+
* Name of the label.
|
|
1452
|
+
* @maxLength 100
|
|
1456
1453
|
*/
|
|
1457
|
-
|
|
1454
|
+
name?: string;
|
|
1455
|
+
/** Amount of contacts assigned to the label. */
|
|
1456
|
+
contactsCount?: number;
|
|
1457
|
+
}
|
|
1458
|
+
interface SubscribeFromLandingPageRequest {
|
|
1459
|
+
/**
|
|
1460
|
+
* Campaign ID that the subscription is happening from.
|
|
1461
|
+
* @format GUID
|
|
1462
|
+
*/
|
|
1463
|
+
campaignId?: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* Email address that is entered into subscription field.
|
|
1466
|
+
* @format EMAIL
|
|
1467
|
+
*/
|
|
1468
|
+
emailAddress?: string;
|
|
1469
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1470
|
+
consent?: boolean;
|
|
1471
|
+
}
|
|
1472
|
+
interface SubscribeFromLandingPageResponse {
|
|
1473
|
+
/** @format GUID */
|
|
1474
|
+
contactId?: string;
|
|
1458
1475
|
}
|
|
1459
1476
|
/** @docsIgnore */
|
|
1460
1477
|
type PublishApplicationErrors = {
|
|
@@ -1481,6 +1498,10 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
1481
1498
|
__responseType: Q;
|
|
1482
1499
|
__originalResponseType: R;
|
|
1483
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>;
|
|
1484
1505
|
declare function getCampaign(): __PublicMethodMetaInfo<'GET', {
|
|
1485
1506
|
campaignId: string;
|
|
1486
1507
|
}, GetCampaignRequest$1, GetCampaignRequest, GetCampaignResponse$1, GetCampaignResponse>;
|
|
@@ -1509,9 +1530,5 @@ declare function getAudience(): __PublicMethodMetaInfo<'POST', {
|
|
|
1509
1530
|
declare function identifySenderAddress(): __PublicMethodMetaInfo<'POST', {}, IdentifySenderAddressRequest$1, IdentifySenderAddressRequest, IdentifySenderAddressResponse$1, IdentifySenderAddressResponse>;
|
|
1510
1531
|
declare function validateLink(): __PublicMethodMetaInfo<'POST', {}, ValidateLinkRequest$1, ValidateLinkRequest, ValidateLinkResponse$1, ValidateLinkResponse>;
|
|
1511
1532
|
declare function validateHtmlLinks(): __PublicMethodMetaInfo<'POST', {}, ValidateHtmlLinksRequest$1, ValidateHtmlLinksRequest, ValidateHtmlLinksResponse$1, ValidateHtmlLinksResponse>;
|
|
1512
|
-
declare function listStatistics(): __PublicMethodMetaInfo<'GET', {}, ListStatisticsRequest$1, ListStatisticsRequest, ListStatisticsResponse$1, ListStatisticsResponse>;
|
|
1513
|
-
declare function listRecipients(): __PublicMethodMetaInfo<'GET', {
|
|
1514
|
-
campaignId: string;
|
|
1515
|
-
}, ListRecipientsRequest$1, ListRecipientsRequest, ListRecipientsResponse$1, ListRecipientsResponse>;
|
|
1516
1533
|
|
|
1517
|
-
export { 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 };
|
|
1534
|
+
export { type AccountDetails as AccountDetailsOriginal, 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 };
|