@wix/auto_sdk_email-marketing_campaigns 1.0.11 → 1.0.13
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/src/email-marketing-v1-campaign-campaigns.context.d.ts +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +10 -10
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +13 -13
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts +120 -217
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +188 -244
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +24 -0
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +10 -10
- package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +13 -13
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.d.ts +120 -217
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +188 -244
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js +24 -0
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +10 -10
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +13 -13
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts +120 -217
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +188 -244
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +24 -0
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +10 -10
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +13 -13
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.d.ts +120 -217
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js.map +1 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +188 -244
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js +24 -0
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
export interface Campaign {
|
|
2
3
|
/**
|
|
3
4
|
* Campaign ID.
|
|
@@ -196,117 +197,6 @@ export declare enum CampaignTypeEnum {
|
|
|
196
197
|
/** Triggered email. */
|
|
197
198
|
TRIGGERED = "TRIGGERED"
|
|
198
199
|
}
|
|
199
|
-
export interface ListStatisticsRequest {
|
|
200
|
-
/**
|
|
201
|
-
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
202
|
-
* @format GUID
|
|
203
|
-
* @minSize 1
|
|
204
|
-
* @maxSize 100
|
|
205
|
-
*/
|
|
206
|
-
campaignIds: string[];
|
|
207
|
-
}
|
|
208
|
-
export interface ListStatisticsResponse {
|
|
209
|
-
/** List of statistics. */
|
|
210
|
-
statistics?: CampaignStatisticsContainer[];
|
|
211
|
-
}
|
|
212
|
-
export interface CampaignStatisticsContainer {
|
|
213
|
-
/**
|
|
214
|
-
* Campaign ID.
|
|
215
|
-
* @format GUID
|
|
216
|
-
*/
|
|
217
|
-
campaignId?: string;
|
|
218
|
-
/** Landing page statistics. */
|
|
219
|
-
landingPage?: LandingPageStatistics;
|
|
220
|
-
/** Email campaign statistics. */
|
|
221
|
-
email?: DistributionStatistics;
|
|
222
|
-
}
|
|
223
|
-
export interface ListRecipientsRequest {
|
|
224
|
-
/**
|
|
225
|
-
* Campaign ID.
|
|
226
|
-
* @format GUID
|
|
227
|
-
*/
|
|
228
|
-
campaignId: string;
|
|
229
|
-
/** Email activity to filter. */
|
|
230
|
-
activity: RecipientsActivityEnum;
|
|
231
|
-
/** Pagination options. */
|
|
232
|
-
paging?: CursorPaging;
|
|
233
|
-
}
|
|
234
|
-
export declare enum RecipientsActivityEnum {
|
|
235
|
-
UNKNOWN = "UNKNOWN",
|
|
236
|
-
DELIVERED = "DELIVERED",
|
|
237
|
-
OPENED = "OPENED",
|
|
238
|
-
CLICKED = "CLICKED",
|
|
239
|
-
BOUNCED = "BOUNCED",
|
|
240
|
-
NOT_SENT = "NOT_SENT",
|
|
241
|
-
SENT = "SENT",
|
|
242
|
-
NOT_OPENED = "NOT_OPENED"
|
|
243
|
-
}
|
|
244
|
-
export interface CursorPaging {
|
|
245
|
-
/**
|
|
246
|
-
* Number of items to load.
|
|
247
|
-
* @max 1000
|
|
248
|
-
*/
|
|
249
|
-
limit?: number | null;
|
|
250
|
-
/**
|
|
251
|
-
* Pointer to the next or previous page in the list of results.
|
|
252
|
-
*
|
|
253
|
-
* You can get the relevant cursor token
|
|
254
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
255
|
-
* Not relevant for the first request.
|
|
256
|
-
*/
|
|
257
|
-
cursor?: string | null;
|
|
258
|
-
}
|
|
259
|
-
export interface ListRecipientsResponse {
|
|
260
|
-
/** List of recipients. */
|
|
261
|
-
recipients?: CampaignRecipientDetails[];
|
|
262
|
-
/** Details on the paged set of returned results. */
|
|
263
|
-
pagingMetadata?: PagingMetadataV2;
|
|
264
|
-
}
|
|
265
|
-
export interface CampaignRecipientDetails {
|
|
266
|
-
/**
|
|
267
|
-
* Contact ID.
|
|
268
|
-
* @format GUID
|
|
269
|
-
*/
|
|
270
|
-
contactId?: string;
|
|
271
|
-
/** Date and time of the last activity. */
|
|
272
|
-
lastActivityDate?: Date | null;
|
|
273
|
-
/**
|
|
274
|
-
* Primary email address of the contact.
|
|
275
|
-
* @format EMAIL
|
|
276
|
-
*/
|
|
277
|
-
emailAddress?: string;
|
|
278
|
-
/**
|
|
279
|
-
* Full name of the contact (optional).
|
|
280
|
-
* @maxLength 100
|
|
281
|
-
*/
|
|
282
|
-
fullName?: string | null;
|
|
283
|
-
/** Is this contact currently deleted from the site or not. */
|
|
284
|
-
contactDeleted?: boolean;
|
|
285
|
-
}
|
|
286
|
-
export interface PagingMetadataV2 {
|
|
287
|
-
/** Number of items returned in the response. */
|
|
288
|
-
count?: number | null;
|
|
289
|
-
/** Offset that was requested. */
|
|
290
|
-
offset?: number | null;
|
|
291
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
292
|
-
total?: number | null;
|
|
293
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
294
|
-
tooManyToCount?: boolean | null;
|
|
295
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
296
|
-
cursors?: Cursors;
|
|
297
|
-
}
|
|
298
|
-
export interface Cursors {
|
|
299
|
-
/**
|
|
300
|
-
* Cursor string pointing to the next page in the list of results.
|
|
301
|
-
* @maxLength 16000
|
|
302
|
-
*/
|
|
303
|
-
next?: string | null;
|
|
304
|
-
/**
|
|
305
|
-
* Cursor pointing to the previous page in the list of results.
|
|
306
|
-
* @maxLength 16000
|
|
307
|
-
*/
|
|
308
|
-
prev?: string | null;
|
|
309
|
-
}
|
|
310
200
|
export interface GetCampaignMappingRequest {
|
|
311
201
|
/**
|
|
312
202
|
* rule ID in automations
|
|
@@ -549,6 +439,117 @@ export interface Decimal {
|
|
|
549
439
|
}
|
|
550
440
|
export interface SendTestBulkResponse {
|
|
551
441
|
}
|
|
442
|
+
export interface ListStatisticsRequest {
|
|
443
|
+
/**
|
|
444
|
+
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
445
|
+
* @format GUID
|
|
446
|
+
* @minSize 1
|
|
447
|
+
* @maxSize 100
|
|
448
|
+
*/
|
|
449
|
+
campaignIds: string[];
|
|
450
|
+
}
|
|
451
|
+
export interface ListStatisticsResponse {
|
|
452
|
+
/** List of statistics. */
|
|
453
|
+
statistics?: CampaignStatisticsContainer[];
|
|
454
|
+
}
|
|
455
|
+
export interface CampaignStatisticsContainer {
|
|
456
|
+
/**
|
|
457
|
+
* Campaign ID.
|
|
458
|
+
* @format GUID
|
|
459
|
+
*/
|
|
460
|
+
campaignId?: string;
|
|
461
|
+
/** Landing page statistics. */
|
|
462
|
+
landingPage?: LandingPageStatistics;
|
|
463
|
+
/** Email campaign statistics. */
|
|
464
|
+
email?: DistributionStatistics;
|
|
465
|
+
}
|
|
466
|
+
export interface ListRecipientsRequest {
|
|
467
|
+
/**
|
|
468
|
+
* Campaign ID.
|
|
469
|
+
* @format GUID
|
|
470
|
+
*/
|
|
471
|
+
campaignId: string;
|
|
472
|
+
/** Email activity to filter. */
|
|
473
|
+
activity: RecipientsActivityEnum;
|
|
474
|
+
/** Pagination options. */
|
|
475
|
+
paging?: CursorPaging;
|
|
476
|
+
}
|
|
477
|
+
export declare enum RecipientsActivityEnum {
|
|
478
|
+
UNKNOWN = "UNKNOWN",
|
|
479
|
+
DELIVERED = "DELIVERED",
|
|
480
|
+
OPENED = "OPENED",
|
|
481
|
+
CLICKED = "CLICKED",
|
|
482
|
+
BOUNCED = "BOUNCED",
|
|
483
|
+
NOT_SENT = "NOT_SENT",
|
|
484
|
+
SENT = "SENT",
|
|
485
|
+
NOT_OPENED = "NOT_OPENED"
|
|
486
|
+
}
|
|
487
|
+
export interface CursorPaging {
|
|
488
|
+
/**
|
|
489
|
+
* Number of items to load.
|
|
490
|
+
* @max 1000
|
|
491
|
+
*/
|
|
492
|
+
limit?: number | null;
|
|
493
|
+
/**
|
|
494
|
+
* Pointer to the next or previous page in the list of results.
|
|
495
|
+
*
|
|
496
|
+
* You can get the relevant cursor token
|
|
497
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
498
|
+
* Not relevant for the first request.
|
|
499
|
+
*/
|
|
500
|
+
cursor?: string | null;
|
|
501
|
+
}
|
|
502
|
+
export interface ListRecipientsResponse {
|
|
503
|
+
/** List of recipients. */
|
|
504
|
+
recipients?: CampaignRecipientDetails[];
|
|
505
|
+
/** Details on the paged set of returned results. */
|
|
506
|
+
pagingMetadata?: PagingMetadataV2;
|
|
507
|
+
}
|
|
508
|
+
export interface CampaignRecipientDetails {
|
|
509
|
+
/**
|
|
510
|
+
* Contact ID.
|
|
511
|
+
* @format GUID
|
|
512
|
+
*/
|
|
513
|
+
contactId?: string;
|
|
514
|
+
/** Date and time of the last activity. */
|
|
515
|
+
lastActivityDate?: Date | null;
|
|
516
|
+
/**
|
|
517
|
+
* Primary email address of the contact.
|
|
518
|
+
* @format EMAIL
|
|
519
|
+
*/
|
|
520
|
+
emailAddress?: string;
|
|
521
|
+
/**
|
|
522
|
+
* Full name of the contact (optional).
|
|
523
|
+
* @maxLength 100
|
|
524
|
+
*/
|
|
525
|
+
fullName?: string | null;
|
|
526
|
+
/** Is this contact currently deleted from the site or not. */
|
|
527
|
+
contactDeleted?: boolean;
|
|
528
|
+
}
|
|
529
|
+
export interface PagingMetadataV2 {
|
|
530
|
+
/** Number of items returned in the response. */
|
|
531
|
+
count?: number | null;
|
|
532
|
+
/** Offset that was requested. */
|
|
533
|
+
offset?: number | null;
|
|
534
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
535
|
+
total?: number | null;
|
|
536
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
537
|
+
tooManyToCount?: boolean | null;
|
|
538
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
539
|
+
cursors?: Cursors;
|
|
540
|
+
}
|
|
541
|
+
export interface Cursors {
|
|
542
|
+
/**
|
|
543
|
+
* Cursor string pointing to the next page in the list of results.
|
|
544
|
+
* @maxLength 16000
|
|
545
|
+
*/
|
|
546
|
+
next?: string | null;
|
|
547
|
+
/**
|
|
548
|
+
* Cursor pointing to the previous page in the list of results.
|
|
549
|
+
* @maxLength 16000
|
|
550
|
+
*/
|
|
551
|
+
prev?: string | null;
|
|
552
|
+
}
|
|
552
553
|
export interface GetCampaignRequest {
|
|
553
554
|
/**
|
|
554
555
|
* Campaign ID.
|
|
@@ -1117,25 +1118,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1117
1118
|
updatedEvent?: EntityUpdatedEvent;
|
|
1118
1119
|
deletedEvent?: EntityDeletedEvent;
|
|
1119
1120
|
actionEvent?: ActionEvent;
|
|
1120
|
-
/**
|
|
1121
|
-
* Unique event ID.
|
|
1122
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1123
|
-
*/
|
|
1121
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1124
1122
|
_id?: string;
|
|
1125
1123
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1124
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1125
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1128
1126
|
*/
|
|
1129
1127
|
entityFqdn?: string;
|
|
1130
1128
|
/**
|
|
1131
|
-
*
|
|
1132
|
-
*
|
|
1133
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1129
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1130
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1134
1131
|
*/
|
|
1135
1132
|
slug?: string;
|
|
1136
1133
|
/** ID of the entity associated with the event. */
|
|
1137
1134
|
entityId?: string;
|
|
1138
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
1135
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1139
1136
|
eventTime?: Date | null;
|
|
1140
1137
|
/**
|
|
1141
1138
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -1145,12 +1142,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1145
1142
|
/** If present, indicates the action that triggered the event. */
|
|
1146
1143
|
originatedFrom?: string | null;
|
|
1147
1144
|
/**
|
|
1148
|
-
* A sequence number
|
|
1149
|
-
*
|
|
1150
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1151
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1152
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1153
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1145
|
+
* 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.
|
|
1146
|
+
* 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.
|
|
1154
1147
|
*/
|
|
1155
1148
|
entityEventSequence?: string | null;
|
|
1156
1149
|
}
|
|
@@ -1176,7 +1169,7 @@ export interface EntityUpdatedEvent {
|
|
|
1176
1169
|
currentEntity?: string;
|
|
1177
1170
|
}
|
|
1178
1171
|
export interface EntityDeletedEvent {
|
|
1179
|
-
/** Entity that was deleted */
|
|
1172
|
+
/** Entity that was deleted. */
|
|
1180
1173
|
deletedEntity?: string | null;
|
|
1181
1174
|
}
|
|
1182
1175
|
export interface ActionEvent {
|
|
@@ -1437,94 +1430,6 @@ export interface SubscribeFromLandingPageResponse {
|
|
|
1437
1430
|
/** @format GUID */
|
|
1438
1431
|
contactId?: string;
|
|
1439
1432
|
}
|
|
1440
|
-
interface LandingPageStatisticsNonNullableFields {
|
|
1441
|
-
opened: number;
|
|
1442
|
-
clicked: number;
|
|
1443
|
-
}
|
|
1444
|
-
interface DistributionStatisticsNonNullableFields {
|
|
1445
|
-
delivered: number;
|
|
1446
|
-
opened: number;
|
|
1447
|
-
clicked: number;
|
|
1448
|
-
bounced: number;
|
|
1449
|
-
complained: number;
|
|
1450
|
-
notSent: number;
|
|
1451
|
-
}
|
|
1452
|
-
interface CampaignStatisticsContainerNonNullableFields {
|
|
1453
|
-
campaignId: string;
|
|
1454
|
-
landingPage?: LandingPageStatisticsNonNullableFields;
|
|
1455
|
-
email?: DistributionStatisticsNonNullableFields;
|
|
1456
|
-
}
|
|
1457
|
-
export interface ListStatisticsResponseNonNullableFields {
|
|
1458
|
-
statistics: CampaignStatisticsContainerNonNullableFields[];
|
|
1459
|
-
}
|
|
1460
|
-
interface CampaignRecipientDetailsNonNullableFields {
|
|
1461
|
-
contactId: string;
|
|
1462
|
-
emailAddress: string;
|
|
1463
|
-
contactDeleted: boolean;
|
|
1464
|
-
}
|
|
1465
|
-
export interface ListRecipientsResponseNonNullableFields {
|
|
1466
|
-
recipients: CampaignRecipientDetailsNonNullableFields[];
|
|
1467
|
-
}
|
|
1468
|
-
interface TotalStatisticsNonNullableFields {
|
|
1469
|
-
mailsSent: number;
|
|
1470
|
-
opened: number;
|
|
1471
|
-
clicked: number;
|
|
1472
|
-
}
|
|
1473
|
-
interface CampaignStatisticsNonNullableFields {
|
|
1474
|
-
landingPage?: LandingPageStatisticsNonNullableFields;
|
|
1475
|
-
emailCampaign?: DistributionStatisticsNonNullableFields;
|
|
1476
|
-
total?: TotalStatisticsNonNullableFields;
|
|
1477
|
-
}
|
|
1478
|
-
interface PublishingDataNonNullableFields {
|
|
1479
|
-
landingPageUrl: string;
|
|
1480
|
-
statistics?: CampaignStatisticsNonNullableFields;
|
|
1481
|
-
wasResentToNonOpeners: boolean;
|
|
1482
|
-
}
|
|
1483
|
-
interface RejectionDataNonNullableFields {
|
|
1484
|
-
rejectionReasons: RejectionReasonEnum[];
|
|
1485
|
-
}
|
|
1486
|
-
export interface CampaignNonNullableFields {
|
|
1487
|
-
campaignId: string;
|
|
1488
|
-
editorType: CampaignEditorTypeEnum;
|
|
1489
|
-
status: CampaignStatusEnum;
|
|
1490
|
-
visibilityStatus: CampaignVisibilityStatusEnum;
|
|
1491
|
-
distributionStatus: Enum;
|
|
1492
|
-
publishingData?: PublishingDataNonNullableFields;
|
|
1493
|
-
rejectionData?: RejectionDataNonNullableFields;
|
|
1494
|
-
sendingState: CampaignSendingStateEnum;
|
|
1495
|
-
campaignType: CampaignTypeEnum;
|
|
1496
|
-
emailSubject: string;
|
|
1497
|
-
}
|
|
1498
|
-
export interface GetCampaignResponseNonNullableFields {
|
|
1499
|
-
campaign?: CampaignNonNullableFields;
|
|
1500
|
-
}
|
|
1501
|
-
export interface ListCampaignsResponseNonNullableFields {
|
|
1502
|
-
campaigns: CampaignNonNullableFields[];
|
|
1503
|
-
}
|
|
1504
|
-
export interface PublishCampaignResponseNonNullableFields {
|
|
1505
|
-
publishingData?: PublishingDataNonNullableFields;
|
|
1506
|
-
}
|
|
1507
|
-
export interface ReuseCampaignResponseNonNullableFields {
|
|
1508
|
-
campaign?: CampaignNonNullableFields;
|
|
1509
|
-
}
|
|
1510
|
-
interface CampaignAudienceNonNullableFields {
|
|
1511
|
-
contactIds: string[];
|
|
1512
|
-
labelIds: string[];
|
|
1513
|
-
segmentIds: string[];
|
|
1514
|
-
activeContactsOnly: boolean;
|
|
1515
|
-
}
|
|
1516
|
-
export interface GetAudienceResponseNonNullableFields {
|
|
1517
|
-
audience?: CampaignAudienceNonNullableFields;
|
|
1518
|
-
}
|
|
1519
|
-
export interface IdentifySenderAddressResponseNonNullableFields {
|
|
1520
|
-
senderAddress: string;
|
|
1521
|
-
}
|
|
1522
|
-
export interface ValidateLinkResponseNonNullableFields {
|
|
1523
|
-
valid: boolean;
|
|
1524
|
-
}
|
|
1525
|
-
export interface ValidateHtmlLinksResponseNonNullableFields {
|
|
1526
|
-
blacklistedLinks: string[];
|
|
1527
|
-
}
|
|
1528
1433
|
export interface BaseEventMetadata {
|
|
1529
1434
|
/**
|
|
1530
1435
|
* App instance ID.
|
|
@@ -1540,25 +1445,21 @@ export interface BaseEventMetadata {
|
|
|
1540
1445
|
identity?: IdentificationData;
|
|
1541
1446
|
}
|
|
1542
1447
|
export interface EventMetadata extends BaseEventMetadata {
|
|
1543
|
-
/**
|
|
1544
|
-
* Unique event ID.
|
|
1545
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1546
|
-
*/
|
|
1448
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1547
1449
|
_id?: string;
|
|
1548
1450
|
/**
|
|
1549
|
-
*
|
|
1550
|
-
*
|
|
1451
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1452
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1551
1453
|
*/
|
|
1552
1454
|
entityFqdn?: string;
|
|
1553
1455
|
/**
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1556
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1456
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1457
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1557
1458
|
*/
|
|
1558
1459
|
slug?: string;
|
|
1559
1460
|
/** ID of the entity associated with the event. */
|
|
1560
1461
|
entityId?: string;
|
|
1561
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
1462
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1562
1463
|
eventTime?: Date | null;
|
|
1563
1464
|
/**
|
|
1564
1465
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -1568,12 +1469,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1568
1469
|
/** If present, indicates the action that triggered the event. */
|
|
1569
1470
|
originatedFrom?: string | null;
|
|
1570
1471
|
/**
|
|
1571
|
-
* A sequence number
|
|
1572
|
-
*
|
|
1573
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1574
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1575
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1576
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1472
|
+
* 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.
|
|
1473
|
+
* 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.
|
|
1577
1474
|
*/
|
|
1578
1475
|
entityEventSequence?: string | null;
|
|
1579
1476
|
}
|
|
@@ -1583,6 +1480,8 @@ export interface CampaignDistributedEnvelope {
|
|
|
1583
1480
|
}
|
|
1584
1481
|
/**
|
|
1585
1482
|
* Triggered when a campaign is successfully distributed to all recipients.
|
|
1483
|
+
* @permissionScope Manage Stores
|
|
1484
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1586
1485
|
* @permissionScope Access Verticals by Automations
|
|
1587
1486
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1588
1487
|
* @permissionScope Set Up Automations
|
|
@@ -1604,6 +1503,8 @@ export interface CampaignPausedEnvelope {
|
|
|
1604
1503
|
}
|
|
1605
1504
|
/**
|
|
1606
1505
|
* Triggered when a scheduled campaign is paused.
|
|
1506
|
+
* @permissionScope Manage Stores
|
|
1507
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1607
1508
|
* @permissionScope Access Verticals by Automations
|
|
1608
1509
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1609
1510
|
* @permissionScope Set Up Automations
|
|
@@ -1625,6 +1526,8 @@ export interface CampaignPublishedEnvelope {
|
|
|
1625
1526
|
}
|
|
1626
1527
|
/**
|
|
1627
1528
|
* Triggered when a draft campaign is published.
|
|
1529
|
+
* @permissionScope Manage Stores
|
|
1530
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1628
1531
|
* @permissionScope Access Verticals by Automations
|
|
1629
1532
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1630
1533
|
* @permissionScope Set Up Automations
|
|
@@ -1646,6 +1549,8 @@ export interface CampaignRejectedEnvelope {
|
|
|
1646
1549
|
}
|
|
1647
1550
|
/**
|
|
1648
1551
|
* Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
|
|
1552
|
+
* @permissionScope Manage Stores
|
|
1553
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1649
1554
|
* @permissionScope Access Verticals by Automations
|
|
1650
1555
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1651
1556
|
* @permissionScope Set Up Automations
|
|
@@ -1667,6 +1572,8 @@ export interface CampaignScheduledEnvelope {
|
|
|
1667
1572
|
}
|
|
1668
1573
|
/**
|
|
1669
1574
|
* Triggered when a campaign is scheduled to be sent out at the specific time.
|
|
1575
|
+
* @permissionScope Manage Stores
|
|
1576
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1670
1577
|
* @permissionScope Access Verticals by Automations
|
|
1671
1578
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1672
1579
|
* @permissionScope Set Up Automations
|
|
@@ -1688,6 +1595,8 @@ export interface CampaignTerminatedEnvelope {
|
|
|
1688
1595
|
}
|
|
1689
1596
|
/**
|
|
1690
1597
|
* Triggered when the mailing list isn't clean and campaign was terminated.
|
|
1598
|
+
* @permissionScope Manage Stores
|
|
1599
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1691
1600
|
* @permissionScope Access Verticals by Automations
|
|
1692
1601
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1693
1602
|
* @permissionScope Set Up Automations
|
|
@@ -1709,6 +1618,8 @@ export interface CampaignCreatedEnvelope {
|
|
|
1709
1618
|
}
|
|
1710
1619
|
/**
|
|
1711
1620
|
* Triggered when a campaign is created.
|
|
1621
|
+
* @permissionScope Manage Stores
|
|
1622
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1712
1623
|
* @permissionScope Access Verticals by Automations
|
|
1713
1624
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1714
1625
|
* @permissionScope Set Up Automations
|
|
@@ -1729,6 +1640,8 @@ export interface CampaignDeletedEnvelope {
|
|
|
1729
1640
|
}
|
|
1730
1641
|
/**
|
|
1731
1642
|
* Triggered when a campaign is deleted.
|
|
1643
|
+
* @permissionScope Manage Stores
|
|
1644
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1732
1645
|
* @permissionScope Access Verticals by Automations
|
|
1733
1646
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1734
1647
|
* @permissionScope Set Up Automations
|
|
@@ -1750,6 +1663,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1750
1663
|
}
|
|
1751
1664
|
/**
|
|
1752
1665
|
* Triggered when an email campaign has a new recipient activity.
|
|
1666
|
+
* @permissionScope Manage Stores
|
|
1667
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1753
1668
|
* @permissionScope Access Verticals by Automations
|
|
1754
1669
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1755
1670
|
* @permissionScope Set Up Automations
|
|
@@ -1765,6 +1680,7 @@ export interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
1765
1680
|
* @slug email_activity_updated
|
|
1766
1681
|
*/
|
|
1767
1682
|
export declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
|
|
1683
|
+
type CampaignNonNullablePaths = `campaignId` | `editorType` | `status` | `visibilityStatus` | `distributionStatus` | `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked` | `emailSubject`;
|
|
1768
1684
|
/**
|
|
1769
1685
|
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
1770
1686
|
*
|
|
@@ -1777,6 +1693,8 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
|
|
|
1777
1693
|
* @public
|
|
1778
1694
|
* @requiredField campaignIds
|
|
1779
1695
|
* @permissionId Shoutout.Read
|
|
1696
|
+
* @permissionScope Manage Stores
|
|
1697
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1780
1698
|
* @permissionScope Access Verticals by Automations
|
|
1781
1699
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1782
1700
|
* @permissionScope Set Up Automations
|
|
@@ -1788,7 +1706,7 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
|
|
|
1788
1706
|
* @applicableIdentity APP
|
|
1789
1707
|
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
|
|
1790
1708
|
*/
|
|
1791
|
-
export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse
|
|
1709
|
+
export declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`>>;
|
|
1792
1710
|
/**
|
|
1793
1711
|
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
1794
1712
|
*
|
|
@@ -1805,6 +1723,8 @@ export declare function listStatistics(campaignIds: string[]): Promise<ListStati
|
|
|
1805
1723
|
* @requiredField campaignId
|
|
1806
1724
|
* @param options - Options to use when getting the list of recipients.
|
|
1807
1725
|
* @permissionId Shoutout.Read
|
|
1726
|
+
* @permissionScope Manage Stores
|
|
1727
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1808
1728
|
* @permissionScope Access Verticals by Automations
|
|
1809
1729
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1810
1730
|
* @permissionScope Set Up Automations
|
|
@@ -1816,7 +1736,7 @@ export declare function listStatistics(campaignIds: string[]): Promise<ListStati
|
|
|
1816
1736
|
* @applicableIdentity APP
|
|
1817
1737
|
* @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
|
|
1818
1738
|
*/
|
|
1819
|
-
export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse
|
|
1739
|
+
export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`>>;
|
|
1820
1740
|
export interface ListRecipientsOptions {
|
|
1821
1741
|
/** Pagination options. */
|
|
1822
1742
|
paging?: CursorPaging;
|
|
@@ -1828,6 +1748,8 @@ export interface ListRecipientsOptions {
|
|
|
1828
1748
|
* @requiredField campaignId
|
|
1829
1749
|
* @param options - Options to use when getting a campaign.
|
|
1830
1750
|
* @permissionId Shoutout.Manage
|
|
1751
|
+
* @permissionScope Manage Stores
|
|
1752
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1831
1753
|
* @permissionScope Access Verticals by Automations
|
|
1832
1754
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1833
1755
|
* @permissionScope Set Up Automations
|
|
@@ -1838,7 +1760,7 @@ export interface ListRecipientsOptions {
|
|
|
1838
1760
|
* @returns Campaign information.
|
|
1839
1761
|
* @fqn wix.emailmarketing.api.v1.CampaignService.Get
|
|
1840
1762
|
*/
|
|
1841
|
-
export declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<Campaign
|
|
1763
|
+
export declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<NonNullablePaths<Campaign, CampaignNonNullablePaths>>;
|
|
1842
1764
|
export interface GetCampaignOptions {
|
|
1843
1765
|
/**
|
|
1844
1766
|
* Whether a returned campaign should include `publishingData.statistics`.
|
|
@@ -1854,6 +1776,8 @@ export interface GetCampaignOptions {
|
|
|
1854
1776
|
* @public
|
|
1855
1777
|
* @param options - Options to use when getting the list of campaigns.
|
|
1856
1778
|
* @permissionId Shoutout.Read
|
|
1779
|
+
* @permissionScope Manage Stores
|
|
1780
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1857
1781
|
* @permissionScope Access Verticals by Automations
|
|
1858
1782
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1859
1783
|
* @permissionScope Set Up Automations
|
|
@@ -1865,7 +1789,9 @@ export interface GetCampaignOptions {
|
|
|
1865
1789
|
* @applicableIdentity APP
|
|
1866
1790
|
* @fqn wix.emailmarketing.api.v1.CampaignService.List
|
|
1867
1791
|
*/
|
|
1868
|
-
export declare function listCampaigns(options?: ListCampaignsOptions): Promise<ListCampaignsResponse
|
|
1792
|
+
export declare function listCampaigns(options?: ListCampaignsOptions): Promise<NonNullablePaths<ListCampaignsResponse, {
|
|
1793
|
+
[P in CampaignNonNullablePaths]: `campaigns.${number}.${P}`;
|
|
1794
|
+
}[CampaignNonNullablePaths]>>;
|
|
1869
1795
|
export interface ListCampaignsOptions {
|
|
1870
1796
|
/** Paging parameters. */
|
|
1871
1797
|
paging?: Paging;
|
|
@@ -1889,6 +1815,8 @@ export interface ListCampaignsOptions {
|
|
|
1889
1815
|
* @requiredField campaignId
|
|
1890
1816
|
* @param options - Options to use when publishing a campaign.
|
|
1891
1817
|
* @permissionId Shoutout.Manage
|
|
1818
|
+
* @permissionScope Manage Stores
|
|
1819
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1892
1820
|
* @permissionScope Access Verticals by Automations
|
|
1893
1821
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1894
1822
|
* @permissionScope Set Up Automations
|
|
@@ -1898,7 +1826,7 @@ export interface ListCampaignsOptions {
|
|
|
1898
1826
|
* @applicableIdentity APP
|
|
1899
1827
|
* @fqn wix.emailmarketing.api.v1.CampaignService.Publish
|
|
1900
1828
|
*/
|
|
1901
|
-
export declare function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise<PublishCampaignResponse
|
|
1829
|
+
export declare function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise<NonNullablePaths<PublishCampaignResponse, `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked`>>;
|
|
1902
1830
|
export interface PublishCampaignOptions {
|
|
1903
1831
|
/** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
|
|
1904
1832
|
emailDistributionOptions?: EmailDistributionOptions;
|
|
@@ -1913,6 +1841,8 @@ export interface PublishCampaignOptions {
|
|
|
1913
1841
|
* @requiredField options.toEmailAddress
|
|
1914
1842
|
* @param options - Options for sending a test email.
|
|
1915
1843
|
* @permissionId Shoutout.Manage
|
|
1844
|
+
* @permissionScope Manage Stores
|
|
1845
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1916
1846
|
* @permissionScope Access Verticals by Automations
|
|
1917
1847
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1918
1848
|
* @permissionScope Set Up Automations
|
|
@@ -1922,7 +1852,7 @@ export interface PublishCampaignOptions {
|
|
|
1922
1852
|
* @applicableIdentity APP
|
|
1923
1853
|
* @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
|
|
1924
1854
|
*/
|
|
1925
|
-
export declare function sendTest(campaignId: string, options?: SendTestOptions): Promise<void>;
|
|
1855
|
+
export declare function sendTest(campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`>): Promise<void>;
|
|
1926
1856
|
export interface SendTestOptions {
|
|
1927
1857
|
/**
|
|
1928
1858
|
* Email subject.
|
|
@@ -1941,6 +1871,8 @@ export interface SendTestOptions {
|
|
|
1941
1871
|
* @public
|
|
1942
1872
|
* @requiredField campaignId
|
|
1943
1873
|
* @permissionId Shoutout.Manage
|
|
1874
|
+
* @permissionScope Manage Stores
|
|
1875
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1944
1876
|
* @permissionScope Access Verticals by Automations
|
|
1945
1877
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1946
1878
|
* @permissionScope Set Up Automations
|
|
@@ -1959,6 +1891,8 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
|
|
|
1959
1891
|
* @requiredField campaignId
|
|
1960
1892
|
* @requiredField sendAt
|
|
1961
1893
|
* @permissionId Shoutout.Manage
|
|
1894
|
+
* @permissionScope Manage Stores
|
|
1895
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1962
1896
|
* @permissionScope Access Verticals by Automations
|
|
1963
1897
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1964
1898
|
* @permissionScope Set Up Automations
|
|
@@ -1968,13 +1902,15 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
|
|
|
1968
1902
|
* @applicableIdentity APP
|
|
1969
1903
|
* @fqn wix.emailmarketing.api.v1.CampaignService.Reschedule
|
|
1970
1904
|
*/
|
|
1971
|
-
export declare function reschedule(campaignId: string, sendAt: Date
|
|
1905
|
+
export declare function reschedule(campaignId: string, sendAt: Date): Promise<void>;
|
|
1972
1906
|
/**
|
|
1973
1907
|
* Permanently deletes a campaign.
|
|
1974
1908
|
* @param campaignId - Campaign ID.
|
|
1975
1909
|
* @public
|
|
1976
1910
|
* @requiredField campaignId
|
|
1977
1911
|
* @permissionId Shoutout.Manage
|
|
1912
|
+
* @permissionScope Manage Stores
|
|
1913
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1978
1914
|
* @permissionScope Access Verticals by Automations
|
|
1979
1915
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1980
1916
|
* @permissionScope Set Up Automations
|
|
@@ -1991,6 +1927,8 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
|
|
|
1991
1927
|
* @public
|
|
1992
1928
|
* @requiredField campaignId
|
|
1993
1929
|
* @permissionId Shoutout.Manage
|
|
1930
|
+
* @permissionScope Manage Stores
|
|
1931
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1994
1932
|
* @permissionScope Access Verticals by Automations
|
|
1995
1933
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1996
1934
|
* @permissionScope Set Up Automations
|
|
@@ -2000,13 +1938,17 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
|
|
|
2000
1938
|
* @applicableIdentity APP
|
|
2001
1939
|
* @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
|
|
2002
1940
|
*/
|
|
2003
|
-
export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaignResponse
|
|
1941
|
+
export declare function reuseCampaign(campaignId: string): Promise<NonNullablePaths<ReuseCampaignResponse, {
|
|
1942
|
+
[P in CampaignNonNullablePaths]: `campaign.${P}`;
|
|
1943
|
+
}[CampaignNonNullablePaths]>>;
|
|
2004
1944
|
/**
|
|
2005
1945
|
* Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.
|
|
2006
1946
|
* @param campaignId - Campaign ID.
|
|
2007
1947
|
* @public
|
|
2008
1948
|
* @requiredField campaignId
|
|
2009
1949
|
* @permissionId Shoutout.Manage
|
|
1950
|
+
* @permissionScope Manage Stores
|
|
1951
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2010
1952
|
* @permissionScope Access Verticals by Automations
|
|
2011
1953
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2012
1954
|
* @permissionScope Set Up Automations
|
|
@@ -2016,13 +1958,15 @@ export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaign
|
|
|
2016
1958
|
* @applicableIdentity APP
|
|
2017
1959
|
* @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
|
|
2018
1960
|
*/
|
|
2019
|
-
export declare function getAudience(campaignId: string): Promise<GetAudienceResponse
|
|
1961
|
+
export declare function getAudience(campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`>>;
|
|
2020
1962
|
/**
|
|
2021
1963
|
* Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
|
|
2022
1964
|
* @param emailAddress - Email address to verify.
|
|
2023
1965
|
* @public
|
|
2024
1966
|
* @requiredField emailAddress
|
|
2025
1967
|
* @permissionId Shoutout.Manage
|
|
1968
|
+
* @permissionScope Manage Stores
|
|
1969
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2026
1970
|
* @permissionScope Access Verticals by Automations
|
|
2027
1971
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2028
1972
|
* @permissionScope Set Up Automations
|
|
@@ -2032,7 +1976,7 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
|
|
|
2032
1976
|
* @applicableIdentity APP
|
|
2033
1977
|
* @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
|
|
2034
1978
|
*/
|
|
2035
|
-
export declare function identifySenderAddress(emailAddress: string): Promise<IdentifySenderAddressResponse
|
|
1979
|
+
export declare function identifySenderAddress(emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`>>;
|
|
2036
1980
|
/**
|
|
2037
1981
|
* Validates any provided link. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
|
|
2038
1982
|
*
|
|
@@ -2050,7 +1994,7 @@ export declare function identifySenderAddress(emailAddress: string): Promise<Ide
|
|
|
2050
1994
|
* @applicableIdentity APP
|
|
2051
1995
|
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
|
|
2052
1996
|
*/
|
|
2053
|
-
export declare function validateLink(url: string): Promise<ValidateLinkResponse
|
|
1997
|
+
export declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`>>;
|
|
2054
1998
|
/**
|
|
2055
1999
|
* Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
|
|
2056
2000
|
* @param html - HTML string with links.
|
|
@@ -2066,5 +2010,5 @@ export declare function validateLink(url: string): Promise<ValidateLinkResponse
|
|
|
2066
2010
|
* @applicableIdentity APP
|
|
2067
2011
|
* @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
|
|
2068
2012
|
*/
|
|
2069
|
-
export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLinksResponse
|
|
2013
|
+
export declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`>>;
|
|
2070
2014
|
export {};
|