@wix/email-marketing 1.0.96 → 1.0.97

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/email-marketing",
3
- "version": "1.0.96",
3
+ "version": "1.0.97",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -22,7 +22,7 @@
22
22
  ],
23
23
  "dependencies": {
24
24
  "@wix/email-marketing_account-details": "1.0.32",
25
- "@wix/email-marketing_campaigns": "1.0.48",
25
+ "@wix/email-marketing_campaigns": "1.0.49",
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": "f8cad05c214cd09ada86dcc7237834fb7f9a3116009073deceadef9d"
51
+ "falconPackageHash": "786e2fe65c76eb613cf3360e557b77fcc65eedcd97890956c13acac8"
52
52
  }
@@ -865,114 +865,6 @@ 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
- }
976
868
  interface ValidateLinkRequest {
977
869
  /** web URL */
978
870
  url: string;
@@ -989,95 +881,6 @@ interface ValidateHtmlLinksResponse {
989
881
  /** array of blacklisted links */
990
882
  blacklistedLinks?: string[];
991
883
  }
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
- }
1081
884
  interface GetCampaignMappingRequest {
1082
885
  /** rule ID in automations */
1083
886
  automationRuleId?: string;
@@ -1420,6 +1223,114 @@ interface LookupCampaignMappingRequest {
1420
1223
  interface LookupCampaignMappingResponse {
1421
1224
  campaignId?: string | null;
1422
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[];
1306
+ }
1307
+ interface GetLabelsRequest {
1308
+ /** Should "inactive" contacts be excluded or not (default value "false"). */
1309
+ activeContactsOnly?: boolean;
1310
+ }
1311
+ interface GetLabelsResponse {
1312
+ /** Returned labels with contact counts. */
1313
+ labels?: Label[];
1314
+ }
1315
+ interface Label {
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;
1322
+ }
1323
+ interface SubscribeFromLandingPageRequest {
1324
+ /** Campaign ID that the subscription is happening from. */
1325
+ 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
+ }
1331
+ interface SubscribeFromLandingPageResponse {
1332
+ contactId?: string;
1333
+ }
1423
1334
  interface GetCampaignRequest {
1424
1335
  /** Campaign ID. */
1425
1336
  campaignId: string;
@@ -1980,6 +1891,95 @@ declare enum WebhookIdentityType$1 {
1980
1891
  WIX_USER = "WIX_USER",
1981
1892
  APP = "APP"
1982
1893
  }
1894
+ interface ListStatisticsRequest {
1895
+ /** IDs of the campaigns to retrieve (max 100 campaigns). */
1896
+ campaignIds: string[];
1897
+ }
1898
+ interface ListStatisticsResponse {
1899
+ /** List of statistics. */
1900
+ statistics?: CampaignStatisticsContainer[];
1901
+ }
1902
+ interface CampaignStatisticsContainer {
1903
+ /** Campaign ID. */
1904
+ campaignId?: string;
1905
+ /** Landing page statistics. */
1906
+ landingPage?: LandingPageStatistics;
1907
+ /** Email campaign statistics. */
1908
+ email?: DistributionStatistics;
1909
+ }
1910
+ interface ListRecipientsRequest {
1911
+ /** Campaign ID. */
1912
+ campaignId: string;
1913
+ /**
1914
+ * __Required.__ Email activity to filter for. One of:
1915
+ * + `'DELIVERED'`
1916
+ * + `'OPENED'`
1917
+ * + `'CLICKED'`
1918
+ * + `'BOUNCED'`
1919
+ * + `'NOT_SENT'`
1920
+ */
1921
+ activity: RecipientsActivityEnum;
1922
+ /** Pagination options. */
1923
+ paging?: CursorPaging;
1924
+ }
1925
+ declare enum RecipientsActivityEnum {
1926
+ UNKNOWN = "UNKNOWN",
1927
+ DELIVERED = "DELIVERED",
1928
+ OPENED = "OPENED",
1929
+ CLICKED = "CLICKED",
1930
+ BOUNCED = "BOUNCED",
1931
+ NOT_SENT = "NOT_SENT",
1932
+ SENT = "SENT",
1933
+ NOT_OPENED = "NOT_OPENED"
1934
+ }
1935
+ interface CursorPaging {
1936
+ /** Number of items to load. */
1937
+ limit?: number | null;
1938
+ /**
1939
+ * Pointer to the next or previous page in the list of results.
1940
+ *
1941
+ * You can get the relevant cursor token
1942
+ * from the `pagingMetadata` object in the previous call's response.
1943
+ * Not relevant for the first request.
1944
+ */
1945
+ cursor?: string | null;
1946
+ }
1947
+ interface ListRecipientsResponse {
1948
+ /** List of recipients. */
1949
+ recipients?: CampaignRecipientDetails[];
1950
+ /** Details on the paged set of returned results. */
1951
+ pagingMetadata?: PagingMetadataV2;
1952
+ }
1953
+ interface CampaignRecipientDetails {
1954
+ /** Contact ID. */
1955
+ contactId?: string;
1956
+ /** Date and time of the last activity. */
1957
+ lastActivityDate?: Date | null;
1958
+ /** Primary email address of the contact. */
1959
+ emailAddress?: string;
1960
+ /** Full name of the contact (optional). */
1961
+ fullName?: string | null;
1962
+ /** Is this contact currently deleted from the site or not. */
1963
+ contactDeleted?: boolean;
1964
+ }
1965
+ interface PagingMetadataV2 {
1966
+ /** Number of items returned in the response. */
1967
+ count?: number | null;
1968
+ /** Offset that was requested. */
1969
+ offset?: number | null;
1970
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1971
+ total?: number | null;
1972
+ /** Flag that indicates the server failed to calculate the `total` field. */
1973
+ tooManyToCount?: boolean | null;
1974
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1975
+ cursors?: Cursors;
1976
+ }
1977
+ interface Cursors {
1978
+ /** Cursor string pointing to the next page in the list of results. */
1979
+ next?: string | null;
1980
+ /** Cursor pointing to the previous page in the list of results. */
1981
+ prev?: string | null;
1982
+ }
1983
1983
  interface ValidateLinkResponseNonNullableFields {
1984
1984
  valid: boolean;
1985
1985
  }
@@ -1998,22 +1998,6 @@ interface DistributionStatisticsNonNullableFields {
1998
1998
  complained: number;
1999
1999
  notSent: number;
2000
2000
  }
2001
- interface CampaignStatisticsContainerNonNullableFields {
2002
- campaignId: string;
2003
- landingPage?: LandingPageStatisticsNonNullableFields;
2004
- email?: DistributionStatisticsNonNullableFields;
2005
- }
2006
- interface ListStatisticsResponseNonNullableFields {
2007
- statistics: CampaignStatisticsContainerNonNullableFields[];
2008
- }
2009
- interface CampaignRecipientDetailsNonNullableFields {
2010
- contactId: string;
2011
- emailAddress: string;
2012
- contactDeleted: boolean;
2013
- }
2014
- interface ListRecipientsResponseNonNullableFields {
2015
- recipients: CampaignRecipientDetailsNonNullableFields[];
2016
- }
2017
2001
  interface TotalStatisticsNonNullableFields {
2018
2002
  mailsSent: number;
2019
2003
  opened: number;
@@ -2059,6 +2043,22 @@ interface ReuseCampaignResponseNonNullableFields {
2059
2043
  interface IdentifySenderAddressResponseNonNullableFields {
2060
2044
  senderAddress: string;
2061
2045
  }
2046
+ interface CampaignStatisticsContainerNonNullableFields {
2047
+ campaignId: string;
2048
+ landingPage?: LandingPageStatisticsNonNullableFields;
2049
+ email?: DistributionStatisticsNonNullableFields;
2050
+ }
2051
+ interface ListStatisticsResponseNonNullableFields {
2052
+ statistics: CampaignStatisticsContainerNonNullableFields[];
2053
+ }
2054
+ interface CampaignRecipientDetailsNonNullableFields {
2055
+ contactId: string;
2056
+ emailAddress: string;
2057
+ contactDeleted: boolean;
2058
+ }
2059
+ interface ListRecipientsResponseNonNullableFields {
2060
+ recipients: CampaignRecipientDetailsNonNullableFields[];
2061
+ }
2062
2062
  interface BaseEventMetadata$1 {
2063
2063
  /** App instance ID. */
2064
2064
  instanceId?: string | null;
@@ -2140,10 +2140,6 @@ interface CampaignEmailActivityUpdatedEnvelope {
2140
2140
  data: EmailActivityUpdated;
2141
2141
  metadata: EventMetadata$1;
2142
2142
  }
2143
- interface ListRecipientsOptions {
2144
- /** Pagination options. */
2145
- paging?: CursorPaging;
2146
- }
2147
2143
  interface GetCampaignOptions {
2148
2144
  /**
2149
2145
  * Whether a returned campaign object should include `publishingData.statistics`.
@@ -2192,6 +2188,10 @@ interface SendTestOptions {
2192
2188
  /** Recipient's email address. */
2193
2189
  toEmailAddress: string;
2194
2190
  }
2191
+ interface ListRecipientsOptions {
2192
+ /** Pagination options. */
2193
+ paging?: CursorPaging;
2194
+ }
2195
2195
 
2196
2196
  declare function validateLink$1(httpClient: HttpClient): ValidateLinkSignature;
2197
2197
  interface ValidateLinkSignature {
@@ -2210,43 +2210,6 @@ interface ValidateHtmlLinksSignature {
2210
2210
  */
2211
2211
  (html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
2212
2212
  }
2213
- declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
2214
- interface ListStatisticsSignature {
2215
- /**
2216
- * Retrieves a list of statistics for up to 100 selected campaigns.
2217
- *
2218
- * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
2219
- * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
2220
- *
2221
- * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2222
- * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
2223
- * @param - IDs of the campaigns to retrieve (max 100 campaigns).
2224
- */
2225
- (campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
2226
- }
2227
- declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
2228
- interface ListRecipientsSignature {
2229
- /**
2230
- * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
2231
- *
2232
- * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
2233
- *
2234
- * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
2235
- * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2236
- *
2237
- * If no `activity` is included, this endpoint returns an error.
2238
- *
2239
- * @param - Campaign ID.
2240
- * @param - __Required.__ Email activity to filter for. One of:
2241
- * + `'DELIVERED'`
2242
- * + `'OPENED'`
2243
- * + `'CLICKED'`
2244
- * + `'BOUNCED'`
2245
- * + `'NOT_SENT'`
2246
- * @param - Options to use when getting the list of recipients.
2247
- */
2248
- (campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions | undefined): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
2249
- }
2250
2213
  declare function getCampaign$1(httpClient: HttpClient): GetCampaignSignature;
2251
2214
  interface GetCampaignSignature {
2252
2215
  /**
@@ -2332,6 +2295,43 @@ interface IdentifySenderAddressSignature {
2332
2295
  */
2333
2296
  (emailAddress: string): Promise<IdentifySenderAddressResponse & IdentifySenderAddressResponseNonNullableFields>;
2334
2297
  }
2298
+ declare function listStatistics$1(httpClient: HttpClient): ListStatisticsSignature;
2299
+ interface ListStatisticsSignature {
2300
+ /**
2301
+ * Retrieves a list of statistics for up to 100 selected campaigns.
2302
+ *
2303
+ * For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total
2304
+ * amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.
2305
+ *
2306
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2307
+ * Use [List Recipients](#listrecipients) to retrieve a list of recipients and their activities related to a selected campaign.
2308
+ * @param - IDs of the campaigns to retrieve (max 100 campaigns).
2309
+ */
2310
+ (campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
2311
+ }
2312
+ declare function listRecipients$1(httpClient: HttpClient): ListRecipientsSignature;
2313
+ interface ListRecipientsSignature {
2314
+ /**
2315
+ * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
2316
+ *
2317
+ * Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.
2318
+ *
2319
+ * Use [List Statistics](#liststatistics) to retrieve a list of activity for selected campaigns.
2320
+ * Use [List Campaigns](#listcampaigns) to retrieve additional information for your campaigns.
2321
+ *
2322
+ * If no `activity` is included, this endpoint returns an error.
2323
+ *
2324
+ * @param - Campaign ID.
2325
+ * @param - __Required.__ Email activity to filter for. One of:
2326
+ * + `'DELIVERED'`
2327
+ * + `'OPENED'`
2328
+ * + `'CLICKED'`
2329
+ * + `'BOUNCED'`
2330
+ * + `'NOT_SENT'`
2331
+ * @param - Options to use when getting the list of recipients.
2332
+ */
2333
+ (campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions | undefined): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
2334
+ }
2335
2335
  declare const onCampaignDistributedEvent$1: EventDefinition<CampaignDistributedEnvelope, "wix.email_marketing.v1.campaign_campaign_distributed_event">;
2336
2336
  declare const onCampaignPausedEvent$1: EventDefinition<CampaignPausedEnvelope, "wix.email_marketing.v1.campaign_campaign_paused_event">;
2337
2337
  declare const onCampaignPublishedEvent$1: EventDefinition<CampaignPublishedEnvelope, "wix.email_marketing.v1.campaign_campaign_published_event">;
@@ -2346,8 +2346,6 @@ declare function createEventModule$1<T extends EventDefinition<any, string>>(eve
2346
2346
 
2347
2347
  declare const validateLink: MaybeContext<BuildRESTFunction<typeof validateLink$1> & typeof validateLink$1>;
2348
2348
  declare const validateHtmlLinks: MaybeContext<BuildRESTFunction<typeof validateHtmlLinks$1> & typeof validateHtmlLinks$1>;
2349
- declare const listStatistics: MaybeContext<BuildRESTFunction<typeof listStatistics$1> & typeof listStatistics$1>;
2350
- declare const listRecipients: MaybeContext<BuildRESTFunction<typeof listRecipients$1> & typeof listRecipients$1>;
2351
2349
  declare const getCampaign: MaybeContext<BuildRESTFunction<typeof getCampaign$1> & typeof getCampaign$1>;
2352
2350
  declare const listCampaigns: MaybeContext<BuildRESTFunction<typeof listCampaigns$1> & typeof listCampaigns$1>;
2353
2351
  declare const publishCampaign: MaybeContext<BuildRESTFunction<typeof publishCampaign$1> & typeof publishCampaign$1>;
@@ -2357,6 +2355,8 @@ declare const reschedule: MaybeContext<BuildRESTFunction<typeof reschedule$1> &
2357
2355
  declare const deleteCampaign: MaybeContext<BuildRESTFunction<typeof deleteCampaign$1> & typeof deleteCampaign$1>;
2358
2356
  declare const reuseCampaign: MaybeContext<BuildRESTFunction<typeof reuseCampaign$1> & typeof reuseCampaign$1>;
2359
2357
  declare const identifySenderAddress: MaybeContext<BuildRESTFunction<typeof identifySenderAddress$1> & typeof identifySenderAddress$1>;
2358
+ declare const listStatistics: MaybeContext<BuildRESTFunction<typeof listStatistics$1> & typeof listStatistics$1>;
2359
+ declare const listRecipients: MaybeContext<BuildRESTFunction<typeof listRecipients$1> & typeof listRecipients$1>;
2360
2360
 
2361
2361
  type _publicOnCampaignDistributedEventType = typeof onCampaignDistributedEvent$1;
2362
2362
  /**