@wix/email-marketing 1.0.102 → 1.0.104
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/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +285 -284
- package/type-bundles/index.bundle.d.ts +285 -284
- package/type-bundles/meta.bundle.d.ts +209 -209
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/email-marketing",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.104",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"type-bundles"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@wix/email-marketing_account-details": "1.0.
|
|
25
|
-
"@wix/email-marketing_campaigns": "1.0.
|
|
24
|
+
"@wix/email-marketing_account-details": "1.0.34",
|
|
25
|
+
"@wix/email-marketing_campaigns": "1.0.56",
|
|
26
26
|
"@wix/email-marketing_sender-details": "1.0.35"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": ""
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "271b18faa7af6e4c582f656c3868d86df4752228650b32ad1a8d8e38"
|
|
52
52
|
}
|
|
@@ -865,6 +865,114 @@ declare enum CampaignTypeEnum {
|
|
|
865
865
|
/** triggered email */
|
|
866
866
|
TRIGGERED = "TRIGGERED"
|
|
867
867
|
}
|
|
868
|
+
interface EstimateFilterSizeRequest {
|
|
869
|
+
/** Contacts filter expression. */
|
|
870
|
+
filter?: Record<string, any> | null;
|
|
871
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
872
|
+
activeContactsOnly?: boolean;
|
|
873
|
+
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
874
|
+
search?: string | null;
|
|
875
|
+
}
|
|
876
|
+
interface EstimateFilterSizeResponse {
|
|
877
|
+
/** Mailing list size estimation. */
|
|
878
|
+
estimation?: number;
|
|
879
|
+
}
|
|
880
|
+
interface EstimateAudienceSizeRequest {
|
|
881
|
+
/** Contact IDs of a campaign audience. */
|
|
882
|
+
contactIds?: string[];
|
|
883
|
+
/** Label IDs of a campaign audience. */
|
|
884
|
+
labelIds?: string[];
|
|
885
|
+
/** Contacts filter expression (json). */
|
|
886
|
+
contactsFilter?: Record<string, any> | null;
|
|
887
|
+
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
888
|
+
search?: string | null;
|
|
889
|
+
/** Segment ids of a campaign audience. */
|
|
890
|
+
segmentIds?: string[];
|
|
891
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
892
|
+
activeContactsOnly?: boolean;
|
|
893
|
+
/** Id of a campaign that is to be resent. */
|
|
894
|
+
resendCampaignId?: string | null;
|
|
895
|
+
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
896
|
+
withTotal?: boolean;
|
|
897
|
+
}
|
|
898
|
+
interface EstimateAudienceSizeResponse {
|
|
899
|
+
/** Audience size (estimated number of emails to be sent). */
|
|
900
|
+
estimation?: number;
|
|
901
|
+
/** Total number of contacts in provided audience (optional). */
|
|
902
|
+
total?: number | null;
|
|
903
|
+
}
|
|
904
|
+
interface ReconcileContactRequest {
|
|
905
|
+
/** Email address of the contact. */
|
|
906
|
+
emailAddress?: string;
|
|
907
|
+
}
|
|
908
|
+
interface ReconcileContactResponse {
|
|
909
|
+
/** Created or retrieved contact. */
|
|
910
|
+
contact?: Contact;
|
|
911
|
+
}
|
|
912
|
+
interface Contact {
|
|
913
|
+
/** Unique ID of the contact entity. */
|
|
914
|
+
_id?: string;
|
|
915
|
+
/** Primary email address of the contact. */
|
|
916
|
+
emailAddress?: string;
|
|
917
|
+
/** Full name of the contact (optional). */
|
|
918
|
+
fullName?: string | null;
|
|
919
|
+
/** Profile picture of the contact (optional). */
|
|
920
|
+
pictureUrl?: string | null;
|
|
921
|
+
}
|
|
922
|
+
interface SearchContactsRequest {
|
|
923
|
+
/** Text to search contacts by - can search by name or email address. */
|
|
924
|
+
searchTerm?: string;
|
|
925
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
926
|
+
activeContactsOnly?: boolean;
|
|
927
|
+
/** Page size (default 50, max 1000). */
|
|
928
|
+
pageSize?: number | null;
|
|
929
|
+
}
|
|
930
|
+
interface SearchContactsResponse {
|
|
931
|
+
/** Search results. */
|
|
932
|
+
contacts?: Contact[];
|
|
933
|
+
}
|
|
934
|
+
interface GetLabelsRequest {
|
|
935
|
+
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
936
|
+
activeContactsOnly?: boolean;
|
|
937
|
+
}
|
|
938
|
+
interface GetLabelsResponse {
|
|
939
|
+
/** Returned labels with contact counts. */
|
|
940
|
+
labels?: Label[];
|
|
941
|
+
}
|
|
942
|
+
interface Label {
|
|
943
|
+
/** Unique ID of the label entity. */
|
|
944
|
+
_id?: string;
|
|
945
|
+
/** Name of the label. */
|
|
946
|
+
name?: string;
|
|
947
|
+
/** Amount of contacts assigned to the label. */
|
|
948
|
+
contactsCount?: number;
|
|
949
|
+
}
|
|
950
|
+
interface SubscribeFromLandingPageRequest {
|
|
951
|
+
/** Campaign ID that the subscription is happening from. */
|
|
952
|
+
campaignId?: string;
|
|
953
|
+
/** Email address that is entered into subscription field. */
|
|
954
|
+
emailAddress?: string;
|
|
955
|
+
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
956
|
+
consent?: boolean;
|
|
957
|
+
}
|
|
958
|
+
interface SubscribeFromLandingPageResponse {
|
|
959
|
+
contactId?: string;
|
|
960
|
+
}
|
|
961
|
+
interface GetPlaceholderKeysRequest {
|
|
962
|
+
/** Campaign ID. */
|
|
963
|
+
campaignId?: string;
|
|
964
|
+
}
|
|
965
|
+
interface GetPlaceholderKeysResponse {
|
|
966
|
+
/** Keys of placeholders used in the campaign. */
|
|
967
|
+
placeholderKeys?: string[];
|
|
968
|
+
}
|
|
969
|
+
interface GetDefaultComponentsRequest {
|
|
970
|
+
}
|
|
971
|
+
interface GetDefaultComponentsResponse {
|
|
972
|
+
footer?: Record<string, any> | null;
|
|
973
|
+
logo?: Record<string, any> | null;
|
|
974
|
+
follow?: Record<string, any> | null;
|
|
975
|
+
}
|
|
868
976
|
interface ValidateLinkRequest {
|
|
869
977
|
/** web URL */
|
|
870
978
|
url: string;
|
|
@@ -881,6 +989,95 @@ interface ValidateHtmlLinksResponse {
|
|
|
881
989
|
/** array of blacklisted links */
|
|
882
990
|
blacklistedLinks?: string[];
|
|
883
991
|
}
|
|
992
|
+
interface ListStatisticsRequest {
|
|
993
|
+
/** IDs of the campaigns to retrieve (max 100 campaigns). */
|
|
994
|
+
campaignIds: string[];
|
|
995
|
+
}
|
|
996
|
+
interface ListStatisticsResponse {
|
|
997
|
+
/** List of statistics. */
|
|
998
|
+
statistics?: CampaignStatisticsContainer[];
|
|
999
|
+
}
|
|
1000
|
+
interface CampaignStatisticsContainer {
|
|
1001
|
+
/** Campaign ID. */
|
|
1002
|
+
campaignId?: string;
|
|
1003
|
+
/** Landing page statistics. */
|
|
1004
|
+
landingPage?: LandingPageStatistics;
|
|
1005
|
+
/** Email campaign statistics. */
|
|
1006
|
+
email?: DistributionStatistics;
|
|
1007
|
+
}
|
|
1008
|
+
interface ListRecipientsRequest {
|
|
1009
|
+
/** Campaign ID. */
|
|
1010
|
+
campaignId: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* __Required.__ Email activity to filter for. One of:
|
|
1013
|
+
* + `'DELIVERED'`
|
|
1014
|
+
* + `'OPENED'`
|
|
1015
|
+
* + `'CLICKED'`
|
|
1016
|
+
* + `'BOUNCED'`
|
|
1017
|
+
* + `'NOT_SENT'`
|
|
1018
|
+
*/
|
|
1019
|
+
activity: RecipientsActivityEnum;
|
|
1020
|
+
/** Pagination options. */
|
|
1021
|
+
paging?: CursorPaging;
|
|
1022
|
+
}
|
|
1023
|
+
declare enum RecipientsActivityEnum {
|
|
1024
|
+
UNKNOWN = "UNKNOWN",
|
|
1025
|
+
DELIVERED = "DELIVERED",
|
|
1026
|
+
OPENED = "OPENED",
|
|
1027
|
+
CLICKED = "CLICKED",
|
|
1028
|
+
BOUNCED = "BOUNCED",
|
|
1029
|
+
NOT_SENT = "NOT_SENT",
|
|
1030
|
+
SENT = "SENT",
|
|
1031
|
+
NOT_OPENED = "NOT_OPENED"
|
|
1032
|
+
}
|
|
1033
|
+
interface CursorPaging {
|
|
1034
|
+
/** Number of items to load. */
|
|
1035
|
+
limit?: number | null;
|
|
1036
|
+
/**
|
|
1037
|
+
* Pointer to the next or previous page in the list of results.
|
|
1038
|
+
*
|
|
1039
|
+
* You can get the relevant cursor token
|
|
1040
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1041
|
+
* Not relevant for the first request.
|
|
1042
|
+
*/
|
|
1043
|
+
cursor?: string | null;
|
|
1044
|
+
}
|
|
1045
|
+
interface ListRecipientsResponse {
|
|
1046
|
+
/** List of recipients. */
|
|
1047
|
+
recipients?: CampaignRecipientDetails[];
|
|
1048
|
+
/** Details on the paged set of returned results. */
|
|
1049
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1050
|
+
}
|
|
1051
|
+
interface CampaignRecipientDetails {
|
|
1052
|
+
/** Contact ID. */
|
|
1053
|
+
contactId?: string;
|
|
1054
|
+
/** Date and time of the last activity. */
|
|
1055
|
+
lastActivityDate?: Date | null;
|
|
1056
|
+
/** Primary email address of the contact. */
|
|
1057
|
+
emailAddress?: string;
|
|
1058
|
+
/** Full name of the contact (optional). */
|
|
1059
|
+
fullName?: string | null;
|
|
1060
|
+
/** Is this contact currently deleted from the site or not. */
|
|
1061
|
+
contactDeleted?: boolean;
|
|
1062
|
+
}
|
|
1063
|
+
interface PagingMetadataV2 {
|
|
1064
|
+
/** Number of items returned in the response. */
|
|
1065
|
+
count?: number | null;
|
|
1066
|
+
/** Offset that was requested. */
|
|
1067
|
+
offset?: number | null;
|
|
1068
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1069
|
+
total?: number | null;
|
|
1070
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1071
|
+
tooManyToCount?: boolean | null;
|
|
1072
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1073
|
+
cursors?: Cursors;
|
|
1074
|
+
}
|
|
1075
|
+
interface Cursors {
|
|
1076
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
1077
|
+
next?: string | null;
|
|
1078
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
1079
|
+
prev?: string | null;
|
|
1080
|
+
}
|
|
884
1081
|
interface GetCampaignMappingRequest {
|
|
885
1082
|
/** rule ID in automations */
|
|
886
1083
|
automationRuleId?: string;
|
|
@@ -1190,153 +1387,45 @@ interface UpsertTranslationRequest {
|
|
|
1190
1387
|
automationRuleId?: string | null;
|
|
1191
1388
|
/** Should campaign also be published or not (default value "false"). */
|
|
1192
1389
|
publish?: boolean;
|
|
1193
|
-
/** Campaign subject (optional). */
|
|
1194
|
-
emailSubject?: string | null;
|
|
1195
|
-
/** Campaign preheader (optional). */
|
|
1196
|
-
emailPreheader?: string | null;
|
|
1197
|
-
}
|
|
1198
|
-
interface Composer {
|
|
1199
|
-
/** Internal data structure for editor/viewer to render the campaign. */
|
|
1200
|
-
composerDataJson?: string;
|
|
1201
|
-
/** Default values of existing placeholders. */
|
|
1202
|
-
defaultValues?: DefaultValues;
|
|
1203
|
-
}
|
|
1204
|
-
interface DefaultValues {
|
|
1205
|
-
map?: Record<string, string>;
|
|
1206
|
-
}
|
|
1207
|
-
interface UpsertTranslationResponse {
|
|
1208
|
-
}
|
|
1209
|
-
interface GetUsedPlaceholderKeysRequest {
|
|
1210
|
-
/** Campaign ID. */
|
|
1211
|
-
campaignId?: string;
|
|
1212
|
-
}
|
|
1213
|
-
interface GetUsedPlaceholderKeysResponse {
|
|
1214
|
-
/** Keys of placeholders used in the automation. */
|
|
1215
|
-
placeholderKeys?: string[];
|
|
1216
|
-
}
|
|
1217
|
-
interface LookupCampaignMappingRequest {
|
|
1218
|
-
/** rule ID in automations */
|
|
1219
|
-
automationRuleId?: string;
|
|
1220
|
-
/** template ID configured for the automation */
|
|
1221
|
-
templateId?: string;
|
|
1222
|
-
}
|
|
1223
|
-
interface LookupCampaignMappingResponse {
|
|
1224
|
-
campaignId?: string | null;
|
|
1225
|
-
}
|
|
1226
|
-
interface GetPlaceholderKeysRequest {
|
|
1227
|
-
/** Campaign ID. */
|
|
1228
|
-
campaignId?: string;
|
|
1229
|
-
}
|
|
1230
|
-
interface GetPlaceholderKeysResponse {
|
|
1231
|
-
/** Keys of placeholders used in the campaign. */
|
|
1232
|
-
placeholderKeys?: string[];
|
|
1233
|
-
}
|
|
1234
|
-
interface GetDefaultComponentsRequest {
|
|
1235
|
-
}
|
|
1236
|
-
interface GetDefaultComponentsResponse {
|
|
1237
|
-
footer?: Record<string, any> | null;
|
|
1238
|
-
logo?: Record<string, any> | null;
|
|
1239
|
-
follow?: Record<string, any> | null;
|
|
1240
|
-
}
|
|
1241
|
-
interface EstimateFilterSizeRequest {
|
|
1242
|
-
/** Contacts filter expression. */
|
|
1243
|
-
filter?: Record<string, any> | null;
|
|
1244
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1245
|
-
activeContactsOnly?: boolean;
|
|
1246
|
-
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
1247
|
-
search?: string | null;
|
|
1248
|
-
}
|
|
1249
|
-
interface EstimateFilterSizeResponse {
|
|
1250
|
-
/** Mailing list size estimation. */
|
|
1251
|
-
estimation?: number;
|
|
1252
|
-
}
|
|
1253
|
-
interface EstimateAudienceSizeRequest {
|
|
1254
|
-
/** Contact IDs of a campaign audience. */
|
|
1255
|
-
contactIds?: string[];
|
|
1256
|
-
/** Label IDs of a campaign audience. */
|
|
1257
|
-
labelIds?: string[];
|
|
1258
|
-
/** Contacts filter expression (json). */
|
|
1259
|
-
contactsFilter?: Record<string, any> | null;
|
|
1260
|
-
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
1261
|
-
search?: string | null;
|
|
1262
|
-
/** Segment ids of a campaign audience. */
|
|
1263
|
-
segmentIds?: string[];
|
|
1264
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1265
|
-
activeContactsOnly?: boolean;
|
|
1266
|
-
/** Id of a campaign that is to be resent. */
|
|
1267
|
-
resendCampaignId?: string | null;
|
|
1268
|
-
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1269
|
-
withTotal?: boolean;
|
|
1270
|
-
}
|
|
1271
|
-
interface EstimateAudienceSizeResponse {
|
|
1272
|
-
/** Audience size (estimated number of emails to be sent). */
|
|
1273
|
-
estimation?: number;
|
|
1274
|
-
/** Total number of contacts in provided audience (optional). */
|
|
1275
|
-
total?: number | null;
|
|
1276
|
-
}
|
|
1277
|
-
interface ReconcileContactRequest {
|
|
1278
|
-
/** Email address of the contact. */
|
|
1279
|
-
emailAddress?: string;
|
|
1280
|
-
}
|
|
1281
|
-
interface ReconcileContactResponse {
|
|
1282
|
-
/** Created or retrieved contact. */
|
|
1283
|
-
contact?: Contact;
|
|
1284
|
-
}
|
|
1285
|
-
interface Contact {
|
|
1286
|
-
/** Unique ID of the contact entity. */
|
|
1287
|
-
_id?: string;
|
|
1288
|
-
/** Primary email address of the contact. */
|
|
1289
|
-
emailAddress?: string;
|
|
1290
|
-
/** Full name of the contact (optional). */
|
|
1291
|
-
fullName?: string | null;
|
|
1292
|
-
/** Profile picture of the contact (optional). */
|
|
1293
|
-
pictureUrl?: string | null;
|
|
1294
|
-
}
|
|
1295
|
-
interface SearchContactsRequest {
|
|
1296
|
-
/** Text to search contacts by - can search by name or email address. */
|
|
1297
|
-
searchTerm?: string;
|
|
1298
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1299
|
-
activeContactsOnly?: boolean;
|
|
1300
|
-
/** Page size (default 50, max 1000). */
|
|
1301
|
-
pageSize?: number | null;
|
|
1302
|
-
}
|
|
1303
|
-
interface SearchContactsResponse {
|
|
1304
|
-
/** Search results. */
|
|
1305
|
-
contacts?: Contact[];
|
|
1390
|
+
/** Campaign subject (optional). */
|
|
1391
|
+
emailSubject?: string | null;
|
|
1392
|
+
/** Campaign preheader (optional). */
|
|
1393
|
+
emailPreheader?: string | null;
|
|
1306
1394
|
}
|
|
1307
|
-
interface
|
|
1308
|
-
/**
|
|
1309
|
-
|
|
1395
|
+
interface Composer {
|
|
1396
|
+
/** Internal data structure for editor/viewer to render the campaign. */
|
|
1397
|
+
composerDataJson?: string;
|
|
1398
|
+
/** Default values of existing placeholders. */
|
|
1399
|
+
defaultValues?: DefaultValues;
|
|
1310
1400
|
}
|
|
1311
|
-
interface
|
|
1312
|
-
|
|
1313
|
-
labels?: Label[];
|
|
1401
|
+
interface DefaultValues {
|
|
1402
|
+
map?: Record<string, string>;
|
|
1314
1403
|
}
|
|
1315
|
-
interface
|
|
1316
|
-
/** Unique ID of the label entity. */
|
|
1317
|
-
_id?: string;
|
|
1318
|
-
/** Name of the label. */
|
|
1319
|
-
name?: string;
|
|
1320
|
-
/** Amount of contacts assigned to the label. */
|
|
1321
|
-
contactsCount?: number;
|
|
1404
|
+
interface UpsertTranslationResponse {
|
|
1322
1405
|
}
|
|
1323
|
-
interface
|
|
1324
|
-
/** Campaign ID
|
|
1406
|
+
interface GetUsedPlaceholderKeysRequest {
|
|
1407
|
+
/** Campaign ID. */
|
|
1325
1408
|
campaignId?: string;
|
|
1326
|
-
/** Email address that is entered into subscription field. */
|
|
1327
|
-
emailAddress?: string;
|
|
1328
|
-
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1329
|
-
consent?: boolean;
|
|
1330
1409
|
}
|
|
1331
|
-
interface
|
|
1332
|
-
|
|
1410
|
+
interface GetUsedPlaceholderKeysResponse {
|
|
1411
|
+
/** Keys of placeholders used in the automation. */
|
|
1412
|
+
placeholderKeys?: string[];
|
|
1413
|
+
}
|
|
1414
|
+
interface LookupCampaignMappingRequest {
|
|
1415
|
+
/** rule ID in automations */
|
|
1416
|
+
automationRuleId?: string;
|
|
1417
|
+
/** template ID configured for the automation */
|
|
1418
|
+
templateId?: string;
|
|
1419
|
+
}
|
|
1420
|
+
interface LookupCampaignMappingResponse {
|
|
1421
|
+
campaignId?: string | null;
|
|
1333
1422
|
}
|
|
1334
1423
|
interface GetCampaignRequest {
|
|
1335
1424
|
/** Campaign ID. */
|
|
1336
1425
|
campaignId: string;
|
|
1337
1426
|
/**
|
|
1338
1427
|
* Whether a returned campaign object should include `publishingData.statistics`.
|
|
1339
|
-
* Default: `false
|
|
1428
|
+
* Default: `false`.
|
|
1340
1429
|
*/
|
|
1341
1430
|
optionIncludeStatistics?: boolean;
|
|
1342
1431
|
}
|
|
@@ -1689,6 +1778,7 @@ interface Unarchived {
|
|
|
1689
1778
|
interface UpdateTitleRequest {
|
|
1690
1779
|
/** ID of the campaign to change title of. */
|
|
1691
1780
|
campaignId?: string;
|
|
1781
|
+
/** New title to set. */
|
|
1692
1782
|
title?: string;
|
|
1693
1783
|
}
|
|
1694
1784
|
interface UpdateTitleResponse {
|
|
@@ -1913,95 +2003,6 @@ declare enum WebhookIdentityType$1 {
|
|
|
1913
2003
|
WIX_USER = "WIX_USER",
|
|
1914
2004
|
APP = "APP"
|
|
1915
2005
|
}
|
|
1916
|
-
interface ListStatisticsRequest {
|
|
1917
|
-
/** IDs of the campaigns to retrieve (max 100 campaigns). */
|
|
1918
|
-
campaignIds: string[];
|
|
1919
|
-
}
|
|
1920
|
-
interface ListStatisticsResponse {
|
|
1921
|
-
/** List of statistics. */
|
|
1922
|
-
statistics?: CampaignStatisticsContainer[];
|
|
1923
|
-
}
|
|
1924
|
-
interface CampaignStatisticsContainer {
|
|
1925
|
-
/** Campaign ID. */
|
|
1926
|
-
campaignId?: string;
|
|
1927
|
-
/** Landing page statistics. */
|
|
1928
|
-
landingPage?: LandingPageStatistics;
|
|
1929
|
-
/** Email campaign statistics. */
|
|
1930
|
-
email?: DistributionStatistics;
|
|
1931
|
-
}
|
|
1932
|
-
interface ListRecipientsRequest {
|
|
1933
|
-
/** Campaign ID. */
|
|
1934
|
-
campaignId: string;
|
|
1935
|
-
/**
|
|
1936
|
-
* __Required.__ Email activity to filter for. One of:
|
|
1937
|
-
* + `'DELIVERED'`
|
|
1938
|
-
* + `'OPENED'`
|
|
1939
|
-
* + `'CLICKED'`
|
|
1940
|
-
* + `'BOUNCED'`
|
|
1941
|
-
* + `'NOT_SENT'`
|
|
1942
|
-
*/
|
|
1943
|
-
activity: RecipientsActivityEnum;
|
|
1944
|
-
/** Pagination options. */
|
|
1945
|
-
paging?: CursorPaging;
|
|
1946
|
-
}
|
|
1947
|
-
declare enum RecipientsActivityEnum {
|
|
1948
|
-
UNKNOWN = "UNKNOWN",
|
|
1949
|
-
DELIVERED = "DELIVERED",
|
|
1950
|
-
OPENED = "OPENED",
|
|
1951
|
-
CLICKED = "CLICKED",
|
|
1952
|
-
BOUNCED = "BOUNCED",
|
|
1953
|
-
NOT_SENT = "NOT_SENT",
|
|
1954
|
-
SENT = "SENT",
|
|
1955
|
-
NOT_OPENED = "NOT_OPENED"
|
|
1956
|
-
}
|
|
1957
|
-
interface CursorPaging {
|
|
1958
|
-
/** Number of items to load. */
|
|
1959
|
-
limit?: number | null;
|
|
1960
|
-
/**
|
|
1961
|
-
* Pointer to the next or previous page in the list of results.
|
|
1962
|
-
*
|
|
1963
|
-
* You can get the relevant cursor token
|
|
1964
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1965
|
-
* Not relevant for the first request.
|
|
1966
|
-
*/
|
|
1967
|
-
cursor?: string | null;
|
|
1968
|
-
}
|
|
1969
|
-
interface ListRecipientsResponse {
|
|
1970
|
-
/** List of recipients. */
|
|
1971
|
-
recipients?: CampaignRecipientDetails[];
|
|
1972
|
-
/** Details on the paged set of returned results. */
|
|
1973
|
-
pagingMetadata?: PagingMetadataV2;
|
|
1974
|
-
}
|
|
1975
|
-
interface CampaignRecipientDetails {
|
|
1976
|
-
/** Contact ID. */
|
|
1977
|
-
contactId?: string;
|
|
1978
|
-
/** Date and time of the last activity. */
|
|
1979
|
-
lastActivityDate?: Date | null;
|
|
1980
|
-
/** Primary email address of the contact. */
|
|
1981
|
-
emailAddress?: string;
|
|
1982
|
-
/** Full name of the contact (optional). */
|
|
1983
|
-
fullName?: string | null;
|
|
1984
|
-
/** Is this contact currently deleted from the site or not. */
|
|
1985
|
-
contactDeleted?: boolean;
|
|
1986
|
-
}
|
|
1987
|
-
interface PagingMetadataV2 {
|
|
1988
|
-
/** Number of items returned in the response. */
|
|
1989
|
-
count?: number | null;
|
|
1990
|
-
/** Offset that was requested. */
|
|
1991
|
-
offset?: number | null;
|
|
1992
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1993
|
-
total?: number | null;
|
|
1994
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1995
|
-
tooManyToCount?: boolean | null;
|
|
1996
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1997
|
-
cursors?: Cursors;
|
|
1998
|
-
}
|
|
1999
|
-
interface Cursors {
|
|
2000
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
2001
|
-
next?: string | null;
|
|
2002
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
2003
|
-
prev?: string | null;
|
|
2004
|
-
}
|
|
2005
2006
|
interface ValidateLinkResponseNonNullableFields {
|
|
2006
2007
|
valid: boolean;
|
|
2007
2008
|
}
|
|
@@ -2020,6 +2021,22 @@ interface DistributionStatisticsNonNullableFields {
|
|
|
2020
2021
|
complained: number;
|
|
2021
2022
|
notSent: number;
|
|
2022
2023
|
}
|
|
2024
|
+
interface CampaignStatisticsContainerNonNullableFields {
|
|
2025
|
+
campaignId: string;
|
|
2026
|
+
landingPage?: LandingPageStatisticsNonNullableFields;
|
|
2027
|
+
email?: DistributionStatisticsNonNullableFields;
|
|
2028
|
+
}
|
|
2029
|
+
interface ListStatisticsResponseNonNullableFields {
|
|
2030
|
+
statistics: CampaignStatisticsContainerNonNullableFields[];
|
|
2031
|
+
}
|
|
2032
|
+
interface CampaignRecipientDetailsNonNullableFields {
|
|
2033
|
+
contactId: string;
|
|
2034
|
+
emailAddress: string;
|
|
2035
|
+
contactDeleted: boolean;
|
|
2036
|
+
}
|
|
2037
|
+
interface ListRecipientsResponseNonNullableFields {
|
|
2038
|
+
recipients: CampaignRecipientDetailsNonNullableFields[];
|
|
2039
|
+
}
|
|
2023
2040
|
interface TotalStatisticsNonNullableFields {
|
|
2024
2041
|
mailsSent: number;
|
|
2025
2042
|
opened: number;
|
|
@@ -2074,22 +2091,6 @@ interface GetAudienceResponseNonNullableFields {
|
|
|
2074
2091
|
interface IdentifySenderAddressResponseNonNullableFields {
|
|
2075
2092
|
senderAddress: string;
|
|
2076
2093
|
}
|
|
2077
|
-
interface CampaignStatisticsContainerNonNullableFields {
|
|
2078
|
-
campaignId: string;
|
|
2079
|
-
landingPage?: LandingPageStatisticsNonNullableFields;
|
|
2080
|
-
email?: DistributionStatisticsNonNullableFields;
|
|
2081
|
-
}
|
|
2082
|
-
interface ListStatisticsResponseNonNullableFields {
|
|
2083
|
-
statistics: CampaignStatisticsContainerNonNullableFields[];
|
|
2084
|
-
}
|
|
2085
|
-
interface CampaignRecipientDetailsNonNullableFields {
|
|
2086
|
-
contactId: string;
|
|
2087
|
-
emailAddress: string;
|
|
2088
|
-
contactDeleted: boolean;
|
|
2089
|
-
}
|
|
2090
|
-
interface ListRecipientsResponseNonNullableFields {
|
|
2091
|
-
recipients: CampaignRecipientDetailsNonNullableFields[];
|
|
2092
|
-
}
|
|
2093
2094
|
interface BaseEventMetadata$1 {
|
|
2094
2095
|
/** App instance ID. */
|
|
2095
2096
|
instanceId?: string | null;
|
|
@@ -2171,10 +2172,14 @@ interface CampaignEmailActivityUpdatedEnvelope {
|
|
|
2171
2172
|
data: EmailActivityUpdated;
|
|
2172
2173
|
metadata: EventMetadata$1;
|
|
2173
2174
|
}
|
|
2175
|
+
interface ListRecipientsOptions {
|
|
2176
|
+
/** Pagination options. */
|
|
2177
|
+
paging?: CursorPaging;
|
|
2178
|
+
}
|
|
2174
2179
|
interface GetCampaignOptions {
|
|
2175
2180
|
/**
|
|
2176
2181
|
* Whether a returned campaign object should include `publishingData.statistics`.
|
|
2177
|
-
* Default: `false
|
|
2182
|
+
* Default: `false`.
|
|
2178
2183
|
*/
|
|
2179
2184
|
optionIncludeStatistics?: boolean;
|
|
2180
2185
|
}
|
|
@@ -2219,10 +2224,6 @@ interface SendTestOptions {
|
|
|
2219
2224
|
/** Recipient's email address. */
|
|
2220
2225
|
toEmailAddress: string;
|
|
2221
2226
|
}
|
|
2222
|
-
interface ListRecipientsOptions {
|
|
2223
|
-
/** Pagination options. */
|
|
2224
|
-
paging?: CursorPaging;
|
|
2225
|
-
}
|
|
2226
2227
|
|
|
2227
2228
|
declare function validateLink$1(httpClient: HttpClient): ValidateLinkSignature;
|
|
2228
2229
|
interface ValidateLinkSignature {
|
|
@@ -2241,6 +2242,43 @@ interface ValidateHtmlLinksSignature {
|
|
|
2241
2242
|
*/
|
|
2242
2243
|
(html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
|
|
2243
2244
|
}
|
|
2245
|
+
declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
|
|
2246
|
+
interface ListStatisticsSignature {
|
|
2247
|
+
/**
|
|
2248
|
+
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
2249
|
+
*
|
|
2250
|
+
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
2251
|
+
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
2252
|
+
*
|
|
2253
|
+
* Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
|
|
2254
|
+
* Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
|
|
2255
|
+
* @param - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
2256
|
+
*/
|
|
2257
|
+
(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
|
|
2258
|
+
}
|
|
2259
|
+
declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
|
|
2260
|
+
interface ListRecipientsSignature {
|
|
2261
|
+
/**
|
|
2262
|
+
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
2263
|
+
*
|
|
2264
|
+
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
2265
|
+
*
|
|
2266
|
+
* Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
|
|
2267
|
+
* Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
|
|
2268
|
+
*
|
|
2269
|
+
* If no `activity` is included, this endpoint returns an error.
|
|
2270
|
+
*
|
|
2271
|
+
* @param - Campaign ID.
|
|
2272
|
+
* @param - __Required.__ Email activity to filter for. One of:
|
|
2273
|
+
* + `'DELIVERED'`
|
|
2274
|
+
* + `'OPENED'`
|
|
2275
|
+
* + `'CLICKED'`
|
|
2276
|
+
* + `'BOUNCED'`
|
|
2277
|
+
* + `'NOT_SENT'`
|
|
2278
|
+
* @param - Options to use when getting the list of recipients.
|
|
2279
|
+
*/
|
|
2280
|
+
(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions | undefined): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
|
|
2281
|
+
}
|
|
2244
2282
|
declare function getCampaign$1(httpClient: HttpClient): GetCampaignSignature;
|
|
2245
2283
|
interface GetCampaignSignature {
|
|
2246
2284
|
/**
|
|
@@ -2334,43 +2372,6 @@ interface IdentifySenderAddressSignature {
|
|
|
2334
2372
|
*/
|
|
2335
2373
|
(emailAddress: string): Promise<IdentifySenderAddressResponse & IdentifySenderAddressResponseNonNullableFields>;
|
|
2336
2374
|
}
|
|
2337
|
-
declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
|
|
2338
|
-
interface ListStatisticsSignature {
|
|
2339
|
-
/**
|
|
2340
|
-
* Retrieves a list of statistics for up to 100 selected campaigns.
|
|
2341
|
-
*
|
|
2342
|
-
* For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
|
|
2343
|
-
* amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
|
|
2344
|
-
*
|
|
2345
|
-
* Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
|
|
2346
|
-
* Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
|
|
2347
|
-
* @param - IDs of the campaigns to retrieve (max 100 campaigns).
|
|
2348
|
-
*/
|
|
2349
|
-
(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
|
|
2350
|
-
}
|
|
2351
|
-
declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
|
|
2352
|
-
interface ListRecipientsSignature {
|
|
2353
|
-
/**
|
|
2354
|
-
* Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
|
|
2355
|
-
*
|
|
2356
|
-
* Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
|
|
2357
|
-
*
|
|
2358
|
-
* Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
|
|
2359
|
-
* Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
|
|
2360
|
-
*
|
|
2361
|
-
* If no `activity` is included, this endpoint returns an error.
|
|
2362
|
-
*
|
|
2363
|
-
* @param - Campaign ID.
|
|
2364
|
-
* @param - __Required.__ Email activity to filter for. One of:
|
|
2365
|
-
* + `'DELIVERED'`
|
|
2366
|
-
* + `'OPENED'`
|
|
2367
|
-
* + `'CLICKED'`
|
|
2368
|
-
* + `'BOUNCED'`
|
|
2369
|
-
* + `'NOT_SENT'`
|
|
2370
|
-
* @param - Options to use when getting the list of recipients.
|
|
2371
|
-
*/
|
|
2372
|
-
(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions | undefined): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
|
|
2373
|
-
}
|
|
2374
2375
|
declare const onCampaignDistributedEvent$1: EventDefinition<CampaignDistributedEnvelope, "wix.email_marketing.v1.campaign_campaign_distributed_event">;
|
|
2375
2376
|
declare const onCampaignPausedEvent$1: EventDefinition<CampaignPausedEnvelope, "wix.email_marketing.v1.campaign_campaign_paused_event">;
|
|
2376
2377
|
declare const onCampaignPublishedEvent$1: EventDefinition<CampaignPublishedEnvelope, "wix.email_marketing.v1.campaign_campaign_published_event">;
|
|
@@ -2385,6 +2386,8 @@ declare function createEventModule$1<T extends EventDefinition<any, string>>(eve
|
|
|
2385
2386
|
|
|
2386
2387
|
declare const validateLink: MaybeContext<BuildRESTFunction<typeof validateLink$1> & typeof validateLink$1>;
|
|
2387
2388
|
declare const validateHtmlLinks: MaybeContext<BuildRESTFunction<typeof validateHtmlLinks$1> & typeof validateHtmlLinks$1>;
|
|
2389
|
+
declare const listStatistics: MaybeContext<BuildRESTFunction<typeof listStatistics$1> & typeof listStatistics$1>;
|
|
2390
|
+
declare const listRecipients: MaybeContext<BuildRESTFunction<typeof listRecipients$1> & typeof listRecipients$1>;
|
|
2388
2391
|
declare const getCampaign: MaybeContext<BuildRESTFunction<typeof getCampaign$1> & typeof getCampaign$1>;
|
|
2389
2392
|
declare const listCampaigns: MaybeContext<BuildRESTFunction<typeof listCampaigns$1> & typeof listCampaigns$1>;
|
|
2390
2393
|
declare const publishCampaign: MaybeContext<BuildRESTFunction<typeof publishCampaign$1> & typeof publishCampaign$1>;
|
|
@@ -2395,8 +2398,6 @@ declare const deleteCampaign: MaybeContext<BuildRESTFunction<typeof deleteCampai
|
|
|
2395
2398
|
declare const reuseCampaign: MaybeContext<BuildRESTFunction<typeof reuseCampaign$1> & typeof reuseCampaign$1>;
|
|
2396
2399
|
declare const getAudience: MaybeContext<BuildRESTFunction<typeof getAudience$1> & typeof getAudience$1>;
|
|
2397
2400
|
declare const identifySenderAddress: MaybeContext<BuildRESTFunction<typeof identifySenderAddress$1> & typeof identifySenderAddress$1>;
|
|
2398
|
-
declare const listStatistics: MaybeContext<BuildRESTFunction<typeof listStatistics$1> & typeof listStatistics$1>;
|
|
2399
|
-
declare const listRecipients: MaybeContext<BuildRESTFunction<typeof listRecipients$1> & typeof listRecipients$1>;
|
|
2400
2401
|
|
|
2401
2402
|
type _publicOnCampaignDistributedEventType = typeof onCampaignDistributedEvent$1;
|
|
2402
2403
|
/**
|