@wix/auto_sdk_email-marketing_campaigns 1.0.17 → 1.0.19
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.types.d.ts → email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.mts} +472 -544
- package/build/{internal/cjs/src/email-marketing-v1-campaign-campaigns.types.d.ts → email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.ts} +472 -544
- package/build/index.d.mts +186 -0
- package/build/index.d.ts +186 -0
- package/build/index.js +1206 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1152 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/email-marketing-v1-campaign-campaigns.types.d.ts → email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.mts} +472 -544
- package/build/{es/src/email-marketing-v1-campaign-campaigns.types.d.ts → internal/email-marketing-v1-campaign-campaigns.universal-DhdBwhrW.d.ts} +472 -544
- package/build/internal/index.d.mts +186 -0
- package/build/internal/index.d.ts +186 -0
- package/build/internal/index.js +1206 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1152 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +510 -0
- package/build/internal/meta.d.ts +510 -0
- package/build/internal/meta.js +713 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +675 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +510 -0
- package/build/meta.d.ts +510 -0
- package/build/meta.js +713 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +675 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js +0 -77
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js +0 -559
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +0 -294
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js +0 -171
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js +0 -148
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +0 -805
- package/build/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.js +0 -64
- package/build/es/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
- package/build/es/src/email-marketing-v1-campaign-campaigns.http.js +0 -542
- package/build/es/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
- package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js +0 -254
- package/build/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.js +0 -144
- package/build/es/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.js +0 -145
- package/build/es/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js +0 -765
- package/build/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js +0 -77
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js +0 -559
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js +0 -294
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js +0 -171
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js +0 -148
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js +0 -805
- package/build/internal/cjs/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.d.ts +0 -64
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js +0 -64
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.context.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.d.ts +0 -62
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js +0 -542
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.http.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.d.ts +0 -44
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js +0 -254
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.meta.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.d.ts +0 -155
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js +0 -144
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.public.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js +0 -145
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.types.js.map +0 -1
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts +0 -2039
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js +0 -765
- package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface Campaign {
|
|
2
2
|
/**
|
|
3
3
|
* Campaign ID.
|
|
4
4
|
* @format GUID
|
|
@@ -32,7 +32,7 @@ export interface Campaign {
|
|
|
32
32
|
*/
|
|
33
33
|
emailSubject?: string;
|
|
34
34
|
}
|
|
35
|
-
|
|
35
|
+
declare enum CampaignEditorTypeEnum {
|
|
36
36
|
/** Unknown editor. This value isn't used. */
|
|
37
37
|
UNKNOWN = "UNKNOWN",
|
|
38
38
|
/** Classic web editor. */
|
|
@@ -43,8 +43,8 @@ export declare enum CampaignEditorTypeEnum {
|
|
|
43
43
|
MJML = "MJML"
|
|
44
44
|
}
|
|
45
45
|
/** @enumType */
|
|
46
|
-
|
|
47
|
-
|
|
46
|
+
type CampaignEditorTypeEnumWithLiterals = CampaignEditorTypeEnum | 'UNKNOWN' | 'WEB' | 'MOBILE' | 'MJML';
|
|
47
|
+
declare enum CampaignStatusEnum {
|
|
48
48
|
/** Unknown campaign. This value isn't used. */
|
|
49
49
|
UNKNOWN = "UNKNOWN",
|
|
50
50
|
/** Campaign is active. */
|
|
@@ -55,8 +55,8 @@ export declare enum CampaignStatusEnum {
|
|
|
55
55
|
DELETED = "DELETED"
|
|
56
56
|
}
|
|
57
57
|
/** @enumType */
|
|
58
|
-
|
|
59
|
-
|
|
58
|
+
type CampaignStatusEnumWithLiterals = CampaignStatusEnum | 'UNKNOWN' | 'ACTIVE' | 'ARCHIVED' | 'DELETED';
|
|
59
|
+
declare enum CampaignVisibilityStatusEnum {
|
|
60
60
|
/** Unknown status. This value isn't used. */
|
|
61
61
|
UNKNOWN = "UNKNOWN",
|
|
62
62
|
/** Campaign isn't published yet. */
|
|
@@ -67,8 +67,8 @@ export declare enum CampaignVisibilityStatusEnum {
|
|
|
67
67
|
TEMPLATE = "TEMPLATE"
|
|
68
68
|
}
|
|
69
69
|
/** @enumType */
|
|
70
|
-
|
|
71
|
-
|
|
70
|
+
type CampaignVisibilityStatusEnumWithLiterals = CampaignVisibilityStatusEnum | 'UNKNOWN' | 'DRAFT' | 'PUBLISHED' | 'TEMPLATE';
|
|
71
|
+
declare enum Enum {
|
|
72
72
|
/** Unknown distribution status. */
|
|
73
73
|
UNKNOWN = "UNKNOWN",
|
|
74
74
|
/** Campaign isn't distributed to recipients yet. */
|
|
@@ -93,8 +93,8 @@ export declare enum Enum {
|
|
|
93
93
|
PAUSED = "PAUSED"
|
|
94
94
|
}
|
|
95
95
|
/** @enumType */
|
|
96
|
-
|
|
97
|
-
|
|
96
|
+
type EnumWithLiterals = Enum | 'UNKNOWN' | 'NOT_STARTED' | 'SCHEDULED' | 'IN_DETECTION' | 'IN_MODERATION' | 'SAMPLING' | 'SENDING' | 'REJECTED' | 'TERMINATED' | 'DISTRIBUTED' | 'PAUSED';
|
|
97
|
+
interface PublishingData {
|
|
98
98
|
/**
|
|
99
99
|
* Landing page URL.
|
|
100
100
|
* @format WEB_URL
|
|
@@ -105,7 +105,7 @@ export interface PublishingData {
|
|
|
105
105
|
/** Marketing campaign publish date. */
|
|
106
106
|
datePublished?: Date | null;
|
|
107
107
|
}
|
|
108
|
-
|
|
108
|
+
interface CampaignStatistics {
|
|
109
109
|
/** Landing page statistics of a marketing campaign. */
|
|
110
110
|
landingPage?: LandingPageStatistics;
|
|
111
111
|
/** Email distribution statistics of a marketing campaign. */
|
|
@@ -113,13 +113,13 @@ export interface CampaignStatistics {
|
|
|
113
113
|
/** Combined statistics of landing page and email distribution. */
|
|
114
114
|
total?: TotalStatistics;
|
|
115
115
|
}
|
|
116
|
-
|
|
116
|
+
interface LandingPageStatistics {
|
|
117
117
|
/** Number of times when a landing page was loaded or viewed. */
|
|
118
118
|
opened?: number;
|
|
119
119
|
/** Number of times a link was clicked in a landing page. */
|
|
120
120
|
clicked?: number;
|
|
121
121
|
}
|
|
122
|
-
|
|
122
|
+
interface DistributionStatistics {
|
|
123
123
|
/** Number of delivered emails. */
|
|
124
124
|
delivered?: number;
|
|
125
125
|
/**
|
|
@@ -143,7 +143,7 @@ export interface DistributionStatistics {
|
|
|
143
143
|
/** Number of emails that weren't sent due to the campaign termination. */
|
|
144
144
|
notSent?: number;
|
|
145
145
|
}
|
|
146
|
-
|
|
146
|
+
interface TotalStatistics {
|
|
147
147
|
/** Total number of emails sent. */
|
|
148
148
|
mailsSent?: number;
|
|
149
149
|
/** Number of landing page views and opened emails. */
|
|
@@ -151,10 +151,10 @@ export interface TotalStatistics {
|
|
|
151
151
|
/** Number of landing page and email link clicks. */
|
|
152
152
|
clicked?: number;
|
|
153
153
|
}
|
|
154
|
-
|
|
154
|
+
interface RejectionData {
|
|
155
155
|
rejectionReasons?: RejectionReasonEnumWithLiterals[];
|
|
156
156
|
}
|
|
157
|
-
|
|
157
|
+
declare enum RejectionReasonEnum {
|
|
158
158
|
UNKNOWN = "UNKNOWN",
|
|
159
159
|
LOW_ENGAGEMENT = "LOW_ENGAGEMENT",
|
|
160
160
|
SENDER_DETAILS = "SENDER_DETAILS",
|
|
@@ -171,8 +171,8 @@ export declare enum RejectionReasonEnum {
|
|
|
171
171
|
UNSOLICITED_CONTENT = "UNSOLICITED_CONTENT"
|
|
172
172
|
}
|
|
173
173
|
/** @enumType */
|
|
174
|
-
|
|
175
|
-
|
|
174
|
+
type RejectionReasonEnumWithLiterals = RejectionReasonEnum | 'UNKNOWN' | 'LOW_ENGAGEMENT' | 'SENDER_DETAILS' | 'SPAM_TRAPS' | 'OTHER' | 'ADULT_SEXUAL_CONTENT' | 'AFFILIATE_MARKETING' | 'BETTING_OR_GAMBLING' | 'CREDIT_REPAIR_OR_DEBT_RELIEF' | 'GET_RICH_QUICK_SCHEME' | 'ILLEGAL_SUBSTANCES_OR_WEAPONS' | 'MISLEADING_SUBJECT_LINE' | 'TRADING_OR_CRYPTOCURRENCIES' | 'UNSOLICITED_CONTENT';
|
|
175
|
+
declare enum CampaignSendingStateEnum {
|
|
176
176
|
/** Campaign not yet published. */
|
|
177
177
|
DRAFT = "DRAFT",
|
|
178
178
|
/** Campaign is being reviewed. */
|
|
@@ -195,9 +195,7 @@ export declare enum CampaignSendingStateEnum {
|
|
|
195
195
|
/** Campaign was sent. */
|
|
196
196
|
SENT = "SENT"
|
|
197
197
|
}
|
|
198
|
-
|
|
199
|
-
export type CampaignSendingStateEnumWithLiterals = CampaignSendingStateEnum | 'DRAFT' | 'REVIEW' | 'REJECTED' | 'SCHEDULED' | 'PAUSED' | 'PUBLISHED' | 'SENDING' | 'PARTIALLY_SENT' | 'SENT';
|
|
200
|
-
export declare enum CampaignTypeEnum {
|
|
198
|
+
declare enum CampaignTypeEnum {
|
|
201
199
|
UNKNOWN = "UNKNOWN",
|
|
202
200
|
/** Email marketing campaign. */
|
|
203
201
|
EMAIL_MARKETING = "EMAIL_MARKETING",
|
|
@@ -208,365 +206,7 @@ export declare enum CampaignTypeEnum {
|
|
|
208
206
|
/** Triggered email. */
|
|
209
207
|
TRIGGERED = "TRIGGERED"
|
|
210
208
|
}
|
|
211
|
-
|
|
212
|
-
export type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
|
|
213
|
-
export interface ListStatisticsRequest {
|
|
214
|
-
/**
|
|
215
|
-
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
216
|
-
* @format GUID
|
|
217
|
-
* @minSize 1
|
|
218
|
-
* @maxSize 100
|
|
219
|
-
*/
|
|
220
|
-
campaignIds: string[];
|
|
221
|
-
}
|
|
222
|
-
export interface ListStatisticsResponse {
|
|
223
|
-
/** List of statistics. */
|
|
224
|
-
statistics?: CampaignStatisticsContainer[];
|
|
225
|
-
}
|
|
226
|
-
export interface CampaignStatisticsContainer {
|
|
227
|
-
/**
|
|
228
|
-
* Campaign ID.
|
|
229
|
-
* @format GUID
|
|
230
|
-
*/
|
|
231
|
-
campaignId?: string;
|
|
232
|
-
/** Landing page statistics. */
|
|
233
|
-
landingPage?: LandingPageStatistics;
|
|
234
|
-
/** Email campaign statistics. */
|
|
235
|
-
email?: DistributionStatistics;
|
|
236
|
-
}
|
|
237
|
-
export interface ListRecipientsRequest {
|
|
238
|
-
/**
|
|
239
|
-
* Campaign ID.
|
|
240
|
-
* @format GUID
|
|
241
|
-
*/
|
|
242
|
-
campaignId: string;
|
|
243
|
-
/** Email activity to filter. */
|
|
244
|
-
activity: RecipientsActivityEnumWithLiterals;
|
|
245
|
-
/** Pagination options. */
|
|
246
|
-
paging?: CursorPaging;
|
|
247
|
-
}
|
|
248
|
-
export declare enum RecipientsActivityEnum {
|
|
249
|
-
UNKNOWN = "UNKNOWN",
|
|
250
|
-
DELIVERED = "DELIVERED",
|
|
251
|
-
OPENED = "OPENED",
|
|
252
|
-
CLICKED = "CLICKED",
|
|
253
|
-
BOUNCED = "BOUNCED",
|
|
254
|
-
NOT_SENT = "NOT_SENT",
|
|
255
|
-
SENT = "SENT",
|
|
256
|
-
NOT_OPENED = "NOT_OPENED"
|
|
257
|
-
}
|
|
258
|
-
/** @enumType */
|
|
259
|
-
export type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
260
|
-
export interface CursorPaging {
|
|
261
|
-
/**
|
|
262
|
-
* Number of items to load.
|
|
263
|
-
* @max 1000
|
|
264
|
-
*/
|
|
265
|
-
limit?: number | null;
|
|
266
|
-
/**
|
|
267
|
-
* Pointer to the next or previous page in the list of results.
|
|
268
|
-
*
|
|
269
|
-
* You can get the relevant cursor token
|
|
270
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
271
|
-
* Not relevant for the first request.
|
|
272
|
-
* @maxLength 1000
|
|
273
|
-
*/
|
|
274
|
-
cursor?: string | null;
|
|
275
|
-
}
|
|
276
|
-
export interface ListRecipientsResponse {
|
|
277
|
-
/** List of recipients. */
|
|
278
|
-
recipients?: CampaignRecipientDetails[];
|
|
279
|
-
/** Details on the paged set of returned results. */
|
|
280
|
-
pagingMetadata?: PagingMetadataV2;
|
|
281
|
-
}
|
|
282
|
-
export interface CampaignRecipientDetails {
|
|
283
|
-
/**
|
|
284
|
-
* Contact ID.
|
|
285
|
-
* @format GUID
|
|
286
|
-
*/
|
|
287
|
-
contactId?: string;
|
|
288
|
-
/** Date and time of the last activity. */
|
|
289
|
-
lastActivityDate?: Date | null;
|
|
290
|
-
/**
|
|
291
|
-
* Primary email address of the contact.
|
|
292
|
-
* @format EMAIL
|
|
293
|
-
*/
|
|
294
|
-
emailAddress?: string;
|
|
295
|
-
/**
|
|
296
|
-
* Full name of the contact (optional).
|
|
297
|
-
* @maxLength 100
|
|
298
|
-
*/
|
|
299
|
-
fullName?: string | null;
|
|
300
|
-
/** Is this contact currently deleted from the site or not. */
|
|
301
|
-
contactDeleted?: boolean;
|
|
302
|
-
}
|
|
303
|
-
export interface PagingMetadataV2 {
|
|
304
|
-
/** Number of items returned in the response. */
|
|
305
|
-
count?: number | null;
|
|
306
|
-
/** Offset that was requested. */
|
|
307
|
-
offset?: number | null;
|
|
308
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
309
|
-
total?: number | null;
|
|
310
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
311
|
-
tooManyToCount?: boolean | null;
|
|
312
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
313
|
-
cursors?: Cursors;
|
|
314
|
-
}
|
|
315
|
-
export interface Cursors {
|
|
316
|
-
/**
|
|
317
|
-
* Cursor string pointing to the next page in the list of results.
|
|
318
|
-
* @maxLength 16000
|
|
319
|
-
*/
|
|
320
|
-
next?: string | null;
|
|
321
|
-
/**
|
|
322
|
-
* Cursor pointing to the previous page in the list of results.
|
|
323
|
-
* @maxLength 16000
|
|
324
|
-
*/
|
|
325
|
-
prev?: string | null;
|
|
326
|
-
}
|
|
327
|
-
export interface GetCampaignMappingRequest {
|
|
328
|
-
/**
|
|
329
|
-
* rule ID in automations
|
|
330
|
-
* @format GUID
|
|
331
|
-
*/
|
|
332
|
-
automationRuleId?: string;
|
|
333
|
-
/**
|
|
334
|
-
* template ID configured for the automation
|
|
335
|
-
* @format GUID
|
|
336
|
-
*/
|
|
337
|
-
templateId?: string;
|
|
338
|
-
}
|
|
339
|
-
export interface GetCampaignMappingResponse {
|
|
340
|
-
/** @format GUID */
|
|
341
|
-
campaignId?: string;
|
|
342
|
-
}
|
|
343
|
-
export interface UpsertTranslationRequest {
|
|
344
|
-
/**
|
|
345
|
-
* Campaign ID.
|
|
346
|
-
* @format GUID
|
|
347
|
-
*/
|
|
348
|
-
campaignId?: string;
|
|
349
|
-
/** Composer data. */
|
|
350
|
-
composer?: Composer;
|
|
351
|
-
/**
|
|
352
|
-
* Translation language (optional, default value "EN").
|
|
353
|
-
* @format LANGUAGE
|
|
354
|
-
*/
|
|
355
|
-
language?: string | null;
|
|
356
|
-
/**
|
|
357
|
-
* For BI event [36:1031] only (optional, default value "n/a").
|
|
358
|
-
* @format GUID
|
|
359
|
-
*/
|
|
360
|
-
automationRuleId?: string | null;
|
|
361
|
-
/** Should campaign also be published or not (default value "false"). */
|
|
362
|
-
publish?: boolean;
|
|
363
|
-
/**
|
|
364
|
-
* Campaign subject (optional).
|
|
365
|
-
* @maxLength 1000
|
|
366
|
-
*/
|
|
367
|
-
emailSubject?: string | null;
|
|
368
|
-
/**
|
|
369
|
-
* Campaign preheader (optional).
|
|
370
|
-
* @maxLength 1000
|
|
371
|
-
*/
|
|
372
|
-
emailPreheader?: string | null;
|
|
373
|
-
}
|
|
374
|
-
export interface Composer {
|
|
375
|
-
/**
|
|
376
|
-
* Internal data structure for editor/viewer to render the campaign.
|
|
377
|
-
* @maxLength 10000000
|
|
378
|
-
*/
|
|
379
|
-
composerDataJson?: string;
|
|
380
|
-
/** Default values of existing placeholders. */
|
|
381
|
-
defaultValues?: DefaultValues;
|
|
382
|
-
}
|
|
383
|
-
export interface DefaultValues {
|
|
384
|
-
/** @maxSize 500 */
|
|
385
|
-
map?: Record<string, string>;
|
|
386
|
-
}
|
|
387
|
-
export interface UpsertTranslationResponse {
|
|
388
|
-
}
|
|
389
|
-
export interface GetUsedPlaceholderKeysRequest {
|
|
390
|
-
/**
|
|
391
|
-
* Campaign ID.
|
|
392
|
-
* @format GUID
|
|
393
|
-
*/
|
|
394
|
-
campaignId?: string;
|
|
395
|
-
}
|
|
396
|
-
export interface GetUsedPlaceholderKeysResponse {
|
|
397
|
-
/**
|
|
398
|
-
* Keys of placeholders used in the automation.
|
|
399
|
-
* @maxLength 200
|
|
400
|
-
* @maxSize 300
|
|
401
|
-
*/
|
|
402
|
-
placeholderKeys?: string[];
|
|
403
|
-
}
|
|
404
|
-
export interface LookupCampaignMappingRequest {
|
|
405
|
-
/**
|
|
406
|
-
* rule ID in automations
|
|
407
|
-
* @format GUID
|
|
408
|
-
*/
|
|
409
|
-
automationRuleId?: string;
|
|
410
|
-
/**
|
|
411
|
-
* template ID configured for the automation
|
|
412
|
-
* @format GUID
|
|
413
|
-
*/
|
|
414
|
-
templateId?: string;
|
|
415
|
-
}
|
|
416
|
-
export interface LookupCampaignMappingResponse {
|
|
417
|
-
/** @format GUID */
|
|
418
|
-
campaignId?: string | null;
|
|
419
|
-
}
|
|
420
|
-
export interface UpsertAutomationTranslatorContentRequest {
|
|
421
|
-
/**
|
|
422
|
-
* Campaign ID that the content belongs to
|
|
423
|
-
* @format GUID
|
|
424
|
-
*/
|
|
425
|
-
campaignId?: string;
|
|
426
|
-
/** Automation translator content */
|
|
427
|
-
automationTranslatorContent?: AutomationTranslatorContent;
|
|
428
|
-
}
|
|
429
|
-
/** Automation Translator Content */
|
|
430
|
-
export interface AutomationTranslatorContent {
|
|
431
|
-
/**
|
|
432
|
-
* AutomationTranslatorContent ID
|
|
433
|
-
* @minLength 1
|
|
434
|
-
* @maxLength 256
|
|
435
|
-
* @immutable
|
|
436
|
-
*/
|
|
437
|
-
id?: string;
|
|
438
|
-
/**
|
|
439
|
-
* Content that can contain multiple strings. It represents a json file, that is stored on Smartling
|
|
440
|
-
* @minLength 1
|
|
441
|
-
* @maxLength 800000
|
|
442
|
-
*/
|
|
443
|
-
json?: string;
|
|
444
|
-
}
|
|
445
|
-
export interface UpsertAutomationTranslatorContentResponse {
|
|
446
|
-
}
|
|
447
|
-
export interface GetAutomationTranslatorContentRequest {
|
|
448
|
-
/**
|
|
449
|
-
* Campaign ID
|
|
450
|
-
* @format GUID
|
|
451
|
-
*/
|
|
452
|
-
campaignId?: string;
|
|
453
|
-
}
|
|
454
|
-
export interface GetAutomationTranslatorContentResponse {
|
|
455
|
-
/** Automation translator content */
|
|
456
|
-
automationTranslatorContent?: AutomationTranslatorContent;
|
|
457
|
-
}
|
|
458
|
-
export interface SendTestBulkRequest {
|
|
459
|
-
/**
|
|
460
|
-
* Campaign ID
|
|
461
|
-
* @format GUID
|
|
462
|
-
*/
|
|
463
|
-
campaignId?: string;
|
|
464
|
-
/**
|
|
465
|
-
* Recipient email address
|
|
466
|
-
* @format EMAIL
|
|
467
|
-
*/
|
|
468
|
-
toEmailAddress?: string;
|
|
469
|
-
/** Values to replace campaign placeholders with (unique for each campaign) */
|
|
470
|
-
placeholders?: Record<string, PlaceholderContent>;
|
|
471
|
-
/**
|
|
472
|
-
* Sender from name
|
|
473
|
-
* @maxLength 100
|
|
474
|
-
*/
|
|
475
|
-
fromName?: string | null;
|
|
476
|
-
/**
|
|
477
|
-
* Reply-to email address
|
|
478
|
-
* @format EMAIL
|
|
479
|
-
*/
|
|
480
|
-
replyToEmailAddress?: string | null;
|
|
481
|
-
/**
|
|
482
|
-
* Preferred language for campaign content (optional). If not provided, a test email for each campaign language is sent
|
|
483
|
-
* @format LANGUAGE
|
|
484
|
-
*/
|
|
485
|
-
language?: string | null;
|
|
486
|
-
}
|
|
487
|
-
export interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
488
|
-
text?: PlainText;
|
|
489
|
-
html?: Html;
|
|
490
|
-
money?: Money;
|
|
491
|
-
dateTime?: DateTime;
|
|
492
|
-
map?: Map;
|
|
493
|
-
array?: _Array;
|
|
494
|
-
enum?: PlaceholderContentEnum;
|
|
495
|
-
attachment?: Attachment;
|
|
496
|
-
integer?: Integer;
|
|
497
|
-
decimal?: Decimal;
|
|
498
|
-
}
|
|
499
|
-
/** @oneof */
|
|
500
|
-
export interface PlaceholderContentValueOneOf {
|
|
501
|
-
text?: PlainText;
|
|
502
|
-
html?: Html;
|
|
503
|
-
money?: Money;
|
|
504
|
-
dateTime?: DateTime;
|
|
505
|
-
map?: Map;
|
|
506
|
-
array?: _Array;
|
|
507
|
-
enum?: PlaceholderContentEnum;
|
|
508
|
-
attachment?: Attachment;
|
|
509
|
-
integer?: Integer;
|
|
510
|
-
decimal?: Decimal;
|
|
511
|
-
}
|
|
512
|
-
export interface PlainText {
|
|
513
|
-
text?: string;
|
|
514
|
-
}
|
|
515
|
-
export interface Html {
|
|
516
|
-
html?: string;
|
|
517
|
-
}
|
|
518
|
-
/**
|
|
519
|
-
* Money.
|
|
520
|
-
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
521
|
-
*/
|
|
522
|
-
export interface Money {
|
|
523
|
-
/**
|
|
524
|
-
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
|
|
525
|
-
* @format DECIMAL_VALUE
|
|
526
|
-
*/
|
|
527
|
-
value?: string;
|
|
528
|
-
/**
|
|
529
|
-
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
530
|
-
* @format CURRENCY
|
|
531
|
-
*/
|
|
532
|
-
currency?: string;
|
|
533
|
-
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
534
|
-
formattedValue?: string | null;
|
|
535
|
-
}
|
|
536
|
-
export interface DateTime {
|
|
537
|
-
timestamp?: Date | null;
|
|
538
|
-
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
539
|
-
timeZone?: string | null;
|
|
540
|
-
}
|
|
541
|
-
export interface Map {
|
|
542
|
-
variables?: Record<string, PlaceholderContent>;
|
|
543
|
-
}
|
|
544
|
-
export interface _Array {
|
|
545
|
-
items?: PlaceholderContent[];
|
|
546
|
-
}
|
|
547
|
-
export interface PlaceholderContentEnum {
|
|
548
|
-
value?: string;
|
|
549
|
-
translation?: string;
|
|
550
|
-
}
|
|
551
|
-
export interface Attachment {
|
|
552
|
-
fileName?: string;
|
|
553
|
-
downloadUrl?: string;
|
|
554
|
-
}
|
|
555
|
-
export interface Integer {
|
|
556
|
-
/** min value: -2147483648, max value: 2147483647 */
|
|
557
|
-
value?: number;
|
|
558
|
-
}
|
|
559
|
-
export interface Decimal {
|
|
560
|
-
/**
|
|
561
|
-
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
562
|
-
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
563
|
-
* @format DECIMAL_VALUE
|
|
564
|
-
*/
|
|
565
|
-
value?: string;
|
|
566
|
-
}
|
|
567
|
-
export interface SendTestBulkResponse {
|
|
568
|
-
}
|
|
569
|
-
export interface GetCampaignRequest {
|
|
209
|
+
interface GetCampaignRequest {
|
|
570
210
|
/**
|
|
571
211
|
* Campaign ID.
|
|
572
212
|
* @format GUID
|
|
@@ -579,11 +219,11 @@ export interface GetCampaignRequest {
|
|
|
579
219
|
*/
|
|
580
220
|
optionIncludeStatistics?: boolean;
|
|
581
221
|
}
|
|
582
|
-
|
|
222
|
+
interface GetCampaignResponse {
|
|
583
223
|
/** Campaign information. */
|
|
584
224
|
campaign?: Campaign;
|
|
585
225
|
}
|
|
586
|
-
|
|
226
|
+
interface ListCampaignsRequest {
|
|
587
227
|
/** Paging parameters. */
|
|
588
228
|
paging?: Paging;
|
|
589
229
|
/**
|
|
@@ -597,23 +237,23 @@ export interface ListCampaignsRequest {
|
|
|
597
237
|
/** Visibility status. */
|
|
598
238
|
visibilityStatuses?: CampaignVisibilityStatusEnumWithLiterals[];
|
|
599
239
|
}
|
|
600
|
-
|
|
240
|
+
interface Paging {
|
|
601
241
|
/** Number of items to load. */
|
|
602
242
|
limit?: number | null;
|
|
603
243
|
/** Number of items to skip in the current sort order. */
|
|
604
244
|
offset?: number | null;
|
|
605
245
|
}
|
|
606
|
-
|
|
246
|
+
interface ListCampaignsResponse {
|
|
607
247
|
/** Paging parameters. */
|
|
608
248
|
paging?: Paging;
|
|
609
249
|
/** List of campaigns. */
|
|
610
250
|
campaigns?: Campaign[];
|
|
611
251
|
}
|
|
612
|
-
|
|
252
|
+
interface CountCampaignsRequest {
|
|
613
253
|
/** Since when should we start counting (optional, default value "1970-01-01T00:00:00.000Z") */
|
|
614
254
|
dateFrom?: Date | null;
|
|
615
255
|
}
|
|
616
|
-
|
|
256
|
+
interface CountCampaignsResponse {
|
|
617
257
|
/** "drafts" + "scheduled" + "published" (excluding "archived"). */
|
|
618
258
|
total?: number;
|
|
619
259
|
/** Non published (draft) campaigns. */
|
|
@@ -625,7 +265,7 @@ export interface CountCampaignsResponse {
|
|
|
625
265
|
/** Campaigns moved to archive (regardless of the status). */
|
|
626
266
|
archived?: number;
|
|
627
267
|
}
|
|
628
|
-
|
|
268
|
+
interface CreateFromTemplateRequest {
|
|
629
269
|
/**
|
|
630
270
|
* ID of the template to fork.
|
|
631
271
|
* @format GUID
|
|
@@ -636,11 +276,11 @@ export interface CreateFromTemplateRequest {
|
|
|
636
276
|
/** Campaign editor type. */
|
|
637
277
|
campaignEditorType?: CampaignEditorTypeEnumWithLiterals;
|
|
638
278
|
}
|
|
639
|
-
|
|
279
|
+
interface CreateFromTemplateResponse {
|
|
640
280
|
/** Campaign information. */
|
|
641
281
|
campaign?: Campaign;
|
|
642
282
|
}
|
|
643
|
-
|
|
283
|
+
interface CreateUserTemplateRequest {
|
|
644
284
|
/**
|
|
645
285
|
* ID of campaign to create template from.
|
|
646
286
|
* @format GUID
|
|
@@ -652,22 +292,22 @@ export interface CreateUserTemplateRequest {
|
|
|
652
292
|
*/
|
|
653
293
|
title?: string | null;
|
|
654
294
|
}
|
|
655
|
-
|
|
295
|
+
interface CreateUserTemplateResponse {
|
|
656
296
|
/** Created user template information. */
|
|
657
297
|
campaign?: Campaign;
|
|
658
298
|
}
|
|
659
|
-
|
|
299
|
+
interface CreateFromUserTemplateRequest {
|
|
660
300
|
/**
|
|
661
301
|
* ID of the user template campaign to use.
|
|
662
302
|
* @format GUID
|
|
663
303
|
*/
|
|
664
304
|
campaignId?: string;
|
|
665
305
|
}
|
|
666
|
-
|
|
306
|
+
interface CreateFromUserTemplateResponse {
|
|
667
307
|
/** Campaign created from user template. */
|
|
668
308
|
campaign?: Campaign;
|
|
669
309
|
}
|
|
670
|
-
|
|
310
|
+
interface PublishCampaignRequest {
|
|
671
311
|
/**
|
|
672
312
|
* Campaign ID
|
|
673
313
|
* @format GUID
|
|
@@ -676,7 +316,7 @@ export interface PublishCampaignRequest {
|
|
|
676
316
|
/** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
|
|
677
317
|
emailDistributionOptions?: EmailDistributionOptions;
|
|
678
318
|
}
|
|
679
|
-
|
|
319
|
+
interface EmailDistributionOptions {
|
|
680
320
|
/**
|
|
681
321
|
* The subject line for the email campaign, which appears in recipients’ inboxes.
|
|
682
322
|
* @maxLength 1000
|
|
@@ -700,18 +340,18 @@ export interface EmailDistributionOptions {
|
|
|
700
340
|
/** Campaign scheduling. You can schedule the campaign no less than 30 minutes until the sending time. [Upgrade your plan](https://support.wix.com/en/article/email-marketing-upgrading-your-email-marketing-plan) to schedule the campaign. */
|
|
701
341
|
sendAt?: Date | null;
|
|
702
342
|
}
|
|
703
|
-
|
|
343
|
+
interface PublishCampaignResponse {
|
|
704
344
|
/** Publishing info. */
|
|
705
345
|
publishingData?: PublishingData;
|
|
706
346
|
}
|
|
707
|
-
|
|
347
|
+
interface Rejected {
|
|
708
348
|
/**
|
|
709
349
|
* ID of the campaign that was rejected.
|
|
710
350
|
* @format GUID
|
|
711
351
|
*/
|
|
712
352
|
campaignId?: string;
|
|
713
353
|
}
|
|
714
|
-
|
|
354
|
+
interface Published {
|
|
715
355
|
/**
|
|
716
356
|
* ID of the campaign that was published.
|
|
717
357
|
* @format GUID
|
|
@@ -726,21 +366,21 @@ export interface Published {
|
|
|
726
366
|
/** Estimation of recipient list size (optional). */
|
|
727
367
|
mailingListSizeEstimate?: number | null;
|
|
728
368
|
}
|
|
729
|
-
|
|
369
|
+
interface Terminated {
|
|
730
370
|
/**
|
|
731
371
|
* ID of the campaign that was terminated.
|
|
732
372
|
* @format GUID
|
|
733
373
|
*/
|
|
734
374
|
campaignId?: string;
|
|
735
375
|
}
|
|
736
|
-
|
|
376
|
+
interface Distributed {
|
|
737
377
|
/**
|
|
738
378
|
* ID of the campaign that was distributed.
|
|
739
379
|
* @format GUID
|
|
740
380
|
*/
|
|
741
381
|
campaignId?: string;
|
|
742
382
|
}
|
|
743
|
-
|
|
383
|
+
interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf {
|
|
744
384
|
/** Recipient clicked on an email. */
|
|
745
385
|
click?: Click;
|
|
746
386
|
/** Recipient opened an email. */
|
|
@@ -783,7 +423,7 @@ export interface EmailActivityUpdated extends EmailActivityUpdatedEventTypeOneOf
|
|
|
783
423
|
metadata?: Record<string, string>;
|
|
784
424
|
}
|
|
785
425
|
/** @oneof */
|
|
786
|
-
|
|
426
|
+
interface EmailActivityUpdatedEventTypeOneOf {
|
|
787
427
|
/** Recipient clicked on an email. */
|
|
788
428
|
click?: Click;
|
|
789
429
|
/** Recipient opened an email. */
|
|
@@ -803,7 +443,7 @@ export interface EmailActivityUpdatedEventTypeOneOf {
|
|
|
803
443
|
hardBounce?: HardBounce;
|
|
804
444
|
}
|
|
805
445
|
/** The type of email activity that triggered the webhook. */
|
|
806
|
-
|
|
446
|
+
declare enum ActivityType {
|
|
807
447
|
/** Triggered when an email is delivered to the recipient. */
|
|
808
448
|
DELIVERY = "DELIVERY",
|
|
809
449
|
/** Triggered when the recipient clicks on a URL inside of the email. */
|
|
@@ -816,72 +456,152 @@ export declare enum ActivityType {
|
|
|
816
456
|
HARD_BOUNCED = "HARD_BOUNCED"
|
|
817
457
|
}
|
|
818
458
|
/** @enumType */
|
|
819
|
-
|
|
820
|
-
|
|
459
|
+
type ActivityTypeWithLiterals = ActivityType | 'DELIVERY' | 'CLICK' | 'OPEN' | 'SOFT_BOUNCE' | 'HARD_BOUNCED';
|
|
460
|
+
interface Click {
|
|
821
461
|
/** URL that was clicked. */
|
|
822
462
|
url?: string;
|
|
823
463
|
/** Browser user agent of the recipient. */
|
|
824
464
|
userAgent?: string;
|
|
825
465
|
}
|
|
826
|
-
|
|
466
|
+
interface Open {
|
|
827
467
|
/** Browser user agent of the recipient. */
|
|
828
468
|
userAgent?: string;
|
|
829
469
|
}
|
|
830
|
-
|
|
831
|
-
/** Reason the email soft bounced. */
|
|
832
|
-
reason?: string;
|
|
470
|
+
interface SoftBounce {
|
|
471
|
+
/** Reason the email soft bounced. */
|
|
472
|
+
reason?: string;
|
|
473
|
+
}
|
|
474
|
+
interface HardBounce {
|
|
475
|
+
/** Reason the email hard bounced. */
|
|
476
|
+
reason?: string;
|
|
477
|
+
}
|
|
478
|
+
interface Scheduled {
|
|
479
|
+
/**
|
|
480
|
+
* ID of the campaign that was scheduled.
|
|
481
|
+
* @format GUID
|
|
482
|
+
*/
|
|
483
|
+
campaignId?: string;
|
|
484
|
+
/** The timestamp campaign is scheduled for. */
|
|
485
|
+
sendAt?: Date | null;
|
|
486
|
+
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
487
|
+
rescheduled?: boolean;
|
|
488
|
+
}
|
|
489
|
+
interface SendTestRequest {
|
|
490
|
+
/**
|
|
491
|
+
* Campaign ID.
|
|
492
|
+
* @format GUID
|
|
493
|
+
*/
|
|
494
|
+
campaignId: string;
|
|
495
|
+
/**
|
|
496
|
+
* Email subject.
|
|
497
|
+
* @maxLength 1000
|
|
498
|
+
*/
|
|
499
|
+
emailSubject?: string | null;
|
|
500
|
+
/**
|
|
501
|
+
* Recipient email address.
|
|
502
|
+
* @format EMAIL
|
|
503
|
+
*/
|
|
504
|
+
toEmailAddress: string;
|
|
505
|
+
}
|
|
506
|
+
interface PlaceholderContent extends PlaceholderContentValueOneOf {
|
|
507
|
+
text?: PlainText;
|
|
508
|
+
html?: Html;
|
|
509
|
+
money?: Money;
|
|
510
|
+
dateTime?: DateTime;
|
|
511
|
+
map?: Map;
|
|
512
|
+
array?: _Array;
|
|
513
|
+
enum?: PlaceholderContentEnum;
|
|
514
|
+
attachment?: Attachment;
|
|
515
|
+
integer?: Integer;
|
|
516
|
+
decimal?: Decimal;
|
|
517
|
+
}
|
|
518
|
+
/** @oneof */
|
|
519
|
+
interface PlaceholderContentValueOneOf {
|
|
520
|
+
text?: PlainText;
|
|
521
|
+
html?: Html;
|
|
522
|
+
money?: Money;
|
|
523
|
+
dateTime?: DateTime;
|
|
524
|
+
map?: Map;
|
|
525
|
+
array?: _Array;
|
|
526
|
+
enum?: PlaceholderContentEnum;
|
|
527
|
+
attachment?: Attachment;
|
|
528
|
+
integer?: Integer;
|
|
529
|
+
decimal?: Decimal;
|
|
530
|
+
}
|
|
531
|
+
interface PlainText {
|
|
532
|
+
text?: string;
|
|
533
|
+
}
|
|
534
|
+
interface Html {
|
|
535
|
+
html?: string;
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
* Money.
|
|
539
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
540
|
+
*/
|
|
541
|
+
interface Money {
|
|
542
|
+
/**
|
|
543
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
|
|
544
|
+
* @format DECIMAL_VALUE
|
|
545
|
+
*/
|
|
546
|
+
value?: string;
|
|
547
|
+
/**
|
|
548
|
+
* Currency code. Must be valid ISO 4217 currency code (e.g., USD).
|
|
549
|
+
* @format CURRENCY
|
|
550
|
+
*/
|
|
551
|
+
currency?: string;
|
|
552
|
+
/** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
|
|
553
|
+
formattedValue?: string | null;
|
|
554
|
+
}
|
|
555
|
+
interface DateTime {
|
|
556
|
+
timestamp?: Date | null;
|
|
557
|
+
/** optional time zone is the full name. example: "Asia/Jerusalem" */
|
|
558
|
+
timeZone?: string | null;
|
|
559
|
+
}
|
|
560
|
+
interface Map {
|
|
561
|
+
variables?: Record<string, PlaceholderContent>;
|
|
562
|
+
}
|
|
563
|
+
interface _Array {
|
|
564
|
+
items?: PlaceholderContent[];
|
|
565
|
+
}
|
|
566
|
+
interface PlaceholderContentEnum {
|
|
567
|
+
value?: string;
|
|
568
|
+
translation?: string;
|
|
833
569
|
}
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
570
|
+
interface Attachment {
|
|
571
|
+
fileName?: string;
|
|
572
|
+
downloadUrl?: string;
|
|
837
573
|
}
|
|
838
|
-
|
|
839
|
-
/**
|
|
840
|
-
|
|
841
|
-
* @format GUID
|
|
842
|
-
*/
|
|
843
|
-
campaignId?: string;
|
|
844
|
-
/** The timestamp campaign is scheduled for. */
|
|
845
|
-
sendAt?: Date | null;
|
|
846
|
-
/** Shows if this is a rescheduling of previously scheduled campaign. */
|
|
847
|
-
rescheduled?: boolean;
|
|
574
|
+
interface Integer {
|
|
575
|
+
/** min value: -2147483648, max value: 2147483647 */
|
|
576
|
+
value?: number;
|
|
848
577
|
}
|
|
849
|
-
|
|
850
|
-
/**
|
|
851
|
-
* Campaign ID.
|
|
852
|
-
* @format GUID
|
|
853
|
-
*/
|
|
854
|
-
campaignId: string;
|
|
855
|
-
/**
|
|
856
|
-
* Email subject.
|
|
857
|
-
* @maxLength 1000
|
|
858
|
-
*/
|
|
859
|
-
emailSubject?: string | null;
|
|
578
|
+
interface Decimal {
|
|
860
579
|
/**
|
|
861
|
-
*
|
|
862
|
-
*
|
|
580
|
+
* when converted from Double, has a limitation of max 16 digits (including fractional part)
|
|
581
|
+
* highest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)
|
|
582
|
+
* @format DECIMAL_VALUE
|
|
863
583
|
*/
|
|
864
|
-
|
|
584
|
+
value?: string;
|
|
865
585
|
}
|
|
866
|
-
|
|
586
|
+
interface SendTestResponse {
|
|
867
587
|
}
|
|
868
|
-
|
|
588
|
+
interface PauseSchedulingRequest {
|
|
869
589
|
/**
|
|
870
590
|
* Campaign ID.
|
|
871
591
|
* @format GUID
|
|
872
592
|
*/
|
|
873
593
|
campaignId: string;
|
|
874
594
|
}
|
|
875
|
-
|
|
595
|
+
interface PauseSchedulingResponse {
|
|
876
596
|
}
|
|
877
|
-
|
|
597
|
+
interface Paused {
|
|
878
598
|
/**
|
|
879
599
|
* ID of the campaign that was paused.
|
|
880
600
|
* @format GUID
|
|
881
601
|
*/
|
|
882
602
|
campaignId?: string;
|
|
883
603
|
}
|
|
884
|
-
|
|
604
|
+
interface RescheduleRequest {
|
|
885
605
|
/**
|
|
886
606
|
* ID of the campaign to reschedule.
|
|
887
607
|
* @format GUID
|
|
@@ -890,43 +610,43 @@ export interface RescheduleRequest {
|
|
|
890
610
|
/** New time for sending out the campaign. */
|
|
891
611
|
sendAt: Date | null;
|
|
892
612
|
}
|
|
893
|
-
|
|
613
|
+
interface RescheduleResponse {
|
|
894
614
|
}
|
|
895
|
-
|
|
615
|
+
interface ArchiveCampaignRequest {
|
|
896
616
|
/**
|
|
897
617
|
* ID of the campaign to archive.
|
|
898
618
|
* @format GUID
|
|
899
619
|
*/
|
|
900
620
|
campaignId?: string;
|
|
901
621
|
}
|
|
902
|
-
|
|
622
|
+
interface ArchiveCampaignResponse {
|
|
903
623
|
}
|
|
904
624
|
/** Sent when status of the campaign is changed from "Active" to "Archived" */
|
|
905
|
-
|
|
625
|
+
interface Archived {
|
|
906
626
|
/**
|
|
907
627
|
* ID of the campaign that was archived.
|
|
908
628
|
* @format GUID
|
|
909
629
|
*/
|
|
910
630
|
campaignId?: string;
|
|
911
631
|
}
|
|
912
|
-
|
|
632
|
+
interface UnarchiveCampaignRequest {
|
|
913
633
|
/**
|
|
914
634
|
* ID of the campaign to unarchive.
|
|
915
635
|
* @format GUID
|
|
916
636
|
*/
|
|
917
637
|
campaignId?: string;
|
|
918
638
|
}
|
|
919
|
-
|
|
639
|
+
interface UnarchiveCampaignResponse {
|
|
920
640
|
}
|
|
921
641
|
/** Sent when status of the campaign is changed from "Archived" to "Active" */
|
|
922
|
-
|
|
642
|
+
interface Unarchived {
|
|
923
643
|
/**
|
|
924
644
|
* ID of the campaign whose status was changed to active.
|
|
925
645
|
* @format GUID
|
|
926
646
|
*/
|
|
927
647
|
campaignId?: string;
|
|
928
648
|
}
|
|
929
|
-
|
|
649
|
+
interface UpdateTitleRequest {
|
|
930
650
|
/**
|
|
931
651
|
* ID of the campaign to change title of.
|
|
932
652
|
* @format GUID
|
|
@@ -938,29 +658,29 @@ export interface UpdateTitleRequest {
|
|
|
938
658
|
*/
|
|
939
659
|
title?: string;
|
|
940
660
|
}
|
|
941
|
-
|
|
661
|
+
interface UpdateTitleResponse {
|
|
942
662
|
}
|
|
943
|
-
|
|
663
|
+
interface DeleteCampaignRequest {
|
|
944
664
|
/**
|
|
945
665
|
* Campaign ID.
|
|
946
666
|
* @format GUID
|
|
947
667
|
*/
|
|
948
668
|
campaignId: string;
|
|
949
669
|
}
|
|
950
|
-
|
|
670
|
+
interface DeleteCampaignResponse {
|
|
951
671
|
}
|
|
952
|
-
|
|
672
|
+
interface ReuseCampaignRequest {
|
|
953
673
|
/**
|
|
954
674
|
* ID of the message to be duplicated.
|
|
955
675
|
* @format GUID
|
|
956
676
|
*/
|
|
957
677
|
campaignId: string;
|
|
958
678
|
}
|
|
959
|
-
|
|
679
|
+
interface ReuseCampaignResponse {
|
|
960
680
|
/** Campaign information. */
|
|
961
681
|
campaign?: Campaign;
|
|
962
682
|
}
|
|
963
|
-
|
|
683
|
+
interface PreviewCampaignRequest {
|
|
964
684
|
/**
|
|
965
685
|
* ID of the campaign to preview.
|
|
966
686
|
* @format GUID
|
|
@@ -976,11 +696,11 @@ export interface PreviewCampaignRequest {
|
|
|
976
696
|
/** Whether to hide the ad (default value "false"). */
|
|
977
697
|
forceHideAd?: boolean;
|
|
978
698
|
}
|
|
979
|
-
|
|
699
|
+
interface PreviewCampaignResponse {
|
|
980
700
|
/** Preview HTML. */
|
|
981
701
|
html?: string;
|
|
982
702
|
}
|
|
983
|
-
|
|
703
|
+
interface GetComposerRequest {
|
|
984
704
|
/**
|
|
985
705
|
* Campaign ID.
|
|
986
706
|
* @format GUID
|
|
@@ -992,7 +712,7 @@ export interface GetComposerRequest {
|
|
|
992
712
|
*/
|
|
993
713
|
language?: string | null;
|
|
994
714
|
}
|
|
995
|
-
|
|
715
|
+
interface GetComposerResponse {
|
|
996
716
|
/** Composer. */
|
|
997
717
|
composer?: Composer;
|
|
998
718
|
/**
|
|
@@ -1006,7 +726,20 @@ export interface GetComposerResponse {
|
|
|
1006
726
|
*/
|
|
1007
727
|
emailPreheader?: string | null;
|
|
1008
728
|
}
|
|
1009
|
-
|
|
729
|
+
interface Composer {
|
|
730
|
+
/**
|
|
731
|
+
* Internal data structure for editor/viewer to render the campaign.
|
|
732
|
+
* @maxLength 10000000
|
|
733
|
+
*/
|
|
734
|
+
composerDataJson?: string;
|
|
735
|
+
/** Default values of existing placeholders. */
|
|
736
|
+
defaultValues?: DefaultValues;
|
|
737
|
+
}
|
|
738
|
+
interface DefaultValues {
|
|
739
|
+
/** @maxSize 500 */
|
|
740
|
+
map?: Record<string, string>;
|
|
741
|
+
}
|
|
742
|
+
interface UpdateComposerRequest {
|
|
1010
743
|
/**
|
|
1011
744
|
* Campaign ID.
|
|
1012
745
|
* @format GUID
|
|
@@ -1028,12 +761,12 @@ export interface UpdateComposerRequest {
|
|
|
1028
761
|
emailPreheader?: string | null;
|
|
1029
762
|
}
|
|
1030
763
|
/** Editor type. */
|
|
1031
|
-
|
|
764
|
+
interface CampaignEditorType {
|
|
1032
765
|
value?: CampaignEditorTypeEnumWithLiterals;
|
|
1033
766
|
}
|
|
1034
|
-
|
|
767
|
+
interface UpdateComposerResponse {
|
|
1035
768
|
}
|
|
1036
|
-
|
|
769
|
+
interface CreateCampaignRequest {
|
|
1037
770
|
/** Campaign composer. */
|
|
1038
771
|
composer?: Composer;
|
|
1039
772
|
/** Campaign editor type (optional, default "WEB"). */
|
|
@@ -1049,11 +782,11 @@ export interface CreateCampaignRequest {
|
|
|
1049
782
|
*/
|
|
1050
783
|
emailPreheader?: string | null;
|
|
1051
784
|
}
|
|
1052
|
-
|
|
785
|
+
interface CreateCampaignResponse {
|
|
1053
786
|
/** Campaign information. */
|
|
1054
787
|
campaign?: Campaign;
|
|
1055
788
|
}
|
|
1056
|
-
|
|
789
|
+
interface ResendToNonOpenersRequest {
|
|
1057
790
|
/**
|
|
1058
791
|
* ID of the campaign to resend.
|
|
1059
792
|
* @format GUID
|
|
@@ -1065,25 +798,25 @@ export interface ResendToNonOpenersRequest {
|
|
|
1065
798
|
*/
|
|
1066
799
|
emailSubject?: string | null;
|
|
1067
800
|
}
|
|
1068
|
-
|
|
801
|
+
interface ResendToNonOpenersResponse {
|
|
1069
802
|
/**
|
|
1070
803
|
* ID of the newly created and resent campaign.
|
|
1071
804
|
* @format GUID
|
|
1072
805
|
*/
|
|
1073
806
|
campaignId?: string;
|
|
1074
807
|
}
|
|
1075
|
-
|
|
808
|
+
interface GetAudienceRequest {
|
|
1076
809
|
/**
|
|
1077
810
|
* Campaign ID.
|
|
1078
811
|
* @format GUID
|
|
1079
812
|
*/
|
|
1080
813
|
campaignId: string;
|
|
1081
814
|
}
|
|
1082
|
-
|
|
815
|
+
interface GetAudienceResponse {
|
|
1083
816
|
/** Campaign audience. */
|
|
1084
817
|
audience?: CampaignAudience;
|
|
1085
818
|
}
|
|
1086
|
-
|
|
819
|
+
interface CampaignAudience {
|
|
1087
820
|
/**
|
|
1088
821
|
* IDs of contacts to whom to send the campaign.
|
|
1089
822
|
* @format GUID
|
|
@@ -1113,7 +846,7 @@ export interface CampaignAudience {
|
|
|
1113
846
|
/** Should "inactive" contacts be excluded or not. */
|
|
1114
847
|
activeContactsOnly?: boolean;
|
|
1115
848
|
}
|
|
1116
|
-
|
|
849
|
+
interface IdentifySenderAddressRequest {
|
|
1117
850
|
/**
|
|
1118
851
|
* Email address to verify.
|
|
1119
852
|
* @format EMAIL
|
|
@@ -1122,7 +855,7 @@ export interface IdentifySenderAddressRequest {
|
|
|
1122
855
|
*/
|
|
1123
856
|
emailAddress: string;
|
|
1124
857
|
}
|
|
1125
|
-
|
|
858
|
+
interface IdentifySenderAddressResponse {
|
|
1126
859
|
/**
|
|
1127
860
|
* Actual "from" address that will be used for sending emails.
|
|
1128
861
|
* @format EMAIL
|
|
@@ -1131,13 +864,13 @@ export interface IdentifySenderAddressResponse {
|
|
|
1131
864
|
*/
|
|
1132
865
|
senderAddress?: string;
|
|
1133
866
|
}
|
|
1134
|
-
|
|
867
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1135
868
|
createdEvent?: EntityCreatedEvent;
|
|
1136
869
|
updatedEvent?: EntityUpdatedEvent;
|
|
1137
870
|
deletedEvent?: EntityDeletedEvent;
|
|
1138
871
|
actionEvent?: ActionEvent;
|
|
1139
872
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1140
|
-
|
|
873
|
+
_id?: string;
|
|
1141
874
|
/**
|
|
1142
875
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1143
876
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -1166,36 +899,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1166
899
|
entityEventSequence?: string | null;
|
|
1167
900
|
}
|
|
1168
901
|
/** @oneof */
|
|
1169
|
-
|
|
902
|
+
interface DomainEventBodyOneOf {
|
|
1170
903
|
createdEvent?: EntityCreatedEvent;
|
|
1171
904
|
updatedEvent?: EntityUpdatedEvent;
|
|
1172
905
|
deletedEvent?: EntityDeletedEvent;
|
|
1173
906
|
actionEvent?: ActionEvent;
|
|
1174
907
|
}
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1178
|
-
restoreInfo?: RestoreInfo;
|
|
908
|
+
interface EntityCreatedEvent {
|
|
909
|
+
entity?: string;
|
|
1179
910
|
}
|
|
1180
|
-
|
|
911
|
+
interface RestoreInfo {
|
|
1181
912
|
deletedDate?: Date | null;
|
|
1182
913
|
}
|
|
1183
|
-
|
|
914
|
+
interface EntityUpdatedEvent {
|
|
1184
915
|
/**
|
|
1185
916
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1186
917
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1187
918
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1188
919
|
*/
|
|
1189
|
-
|
|
920
|
+
currentEntity?: string;
|
|
1190
921
|
}
|
|
1191
|
-
|
|
922
|
+
interface EntityDeletedEvent {
|
|
1192
923
|
/** Entity that was deleted. */
|
|
1193
|
-
|
|
924
|
+
deletedEntity?: string | null;
|
|
1194
925
|
}
|
|
1195
|
-
|
|
1196
|
-
|
|
926
|
+
interface ActionEvent {
|
|
927
|
+
body?: string;
|
|
1197
928
|
}
|
|
1198
|
-
|
|
929
|
+
interface MessageEnvelope {
|
|
1199
930
|
/**
|
|
1200
931
|
* App instance ID.
|
|
1201
932
|
* @format GUID
|
|
@@ -1211,7 +942,7 @@ export interface MessageEnvelope {
|
|
|
1211
942
|
/** Stringify payload. */
|
|
1212
943
|
data?: string;
|
|
1213
944
|
}
|
|
1214
|
-
|
|
945
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1215
946
|
/**
|
|
1216
947
|
* ID of a site visitor that has not logged in to the site.
|
|
1217
948
|
* @format GUID
|
|
@@ -1236,7 +967,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1236
967
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1237
968
|
}
|
|
1238
969
|
/** @oneof */
|
|
1239
|
-
|
|
970
|
+
interface IdentificationDataIdOneOf {
|
|
1240
971
|
/**
|
|
1241
972
|
* ID of a site visitor that has not logged in to the site.
|
|
1242
973
|
* @format GUID
|
|
@@ -1258,7 +989,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1258
989
|
*/
|
|
1259
990
|
appId?: string;
|
|
1260
991
|
}
|
|
1261
|
-
|
|
992
|
+
declare enum WebhookIdentityType {
|
|
1262
993
|
UNKNOWN = "UNKNOWN",
|
|
1263
994
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1264
995
|
MEMBER = "MEMBER",
|
|
@@ -1266,48 +997,8 @@ export declare enum WebhookIdentityType {
|
|
|
1266
997
|
APP = "APP"
|
|
1267
998
|
}
|
|
1268
999
|
/** @enumType */
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
/**
|
|
1272
|
-
* Campaign ID.
|
|
1273
|
-
* @format GUID
|
|
1274
|
-
*/
|
|
1275
|
-
campaignId?: string;
|
|
1276
|
-
}
|
|
1277
|
-
export interface GetPlaceholderKeysResponse {
|
|
1278
|
-
/** Keys of placeholders used in the campaign. */
|
|
1279
|
-
placeholderKeys?: string[];
|
|
1280
|
-
}
|
|
1281
|
-
export interface GetDefaultComponentsRequest {
|
|
1282
|
-
}
|
|
1283
|
-
export interface GetDefaultComponentsResponse {
|
|
1284
|
-
footer?: Record<string, any> | null;
|
|
1285
|
-
logo?: Record<string, any> | null;
|
|
1286
|
-
follow?: Record<string, any> | null;
|
|
1287
|
-
}
|
|
1288
|
-
export interface ValidateLinkRequest {
|
|
1289
|
-
/**
|
|
1290
|
-
* URL to validate.
|
|
1291
|
-
* @minLength 1
|
|
1292
|
-
*/
|
|
1293
|
-
url: string;
|
|
1294
|
-
}
|
|
1295
|
-
export interface ValidateLinkResponse {
|
|
1296
|
-
/** Whether the link is valid. */
|
|
1297
|
-
valid?: boolean;
|
|
1298
|
-
}
|
|
1299
|
-
export interface ValidateHtmlLinksRequest {
|
|
1300
|
-
/**
|
|
1301
|
-
* HTML string with links.
|
|
1302
|
-
* @maxLength 1000000
|
|
1303
|
-
*/
|
|
1304
|
-
html: string;
|
|
1305
|
-
}
|
|
1306
|
-
export interface ValidateHtmlLinksResponse {
|
|
1307
|
-
/** Non-valid links. */
|
|
1308
|
-
blacklistedLinks?: string[];
|
|
1309
|
-
}
|
|
1310
|
-
export interface EstimateFilterSizeRequest {
|
|
1000
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1001
|
+
interface EstimateFilterSizeRequest {
|
|
1311
1002
|
/** Contacts filter expression. */
|
|
1312
1003
|
filter?: Record<string, any> | null;
|
|
1313
1004
|
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
@@ -1319,11 +1010,11 @@ export interface EstimateFilterSizeRequest {
|
|
|
1319
1010
|
*/
|
|
1320
1011
|
search?: string | null;
|
|
1321
1012
|
}
|
|
1322
|
-
|
|
1013
|
+
interface EstimateFilterSizeResponse {
|
|
1323
1014
|
/** Mailing list size estimation. */
|
|
1324
1015
|
estimation?: number;
|
|
1325
1016
|
}
|
|
1326
|
-
|
|
1017
|
+
interface EstimateAudienceSizeRequest {
|
|
1327
1018
|
/**
|
|
1328
1019
|
* Contact IDs of a campaign audience.
|
|
1329
1020
|
* @format GUID
|
|
@@ -1354,29 +1045,29 @@ export interface EstimateAudienceSizeRequest {
|
|
|
1354
1045
|
/** Should total number of contacts in provided audience be returned or not (default value "false"). */
|
|
1355
1046
|
withTotal?: boolean;
|
|
1356
1047
|
}
|
|
1357
|
-
|
|
1048
|
+
interface EstimateAudienceSizeResponse {
|
|
1358
1049
|
/** Audience size (estimated number of emails to be sent). */
|
|
1359
1050
|
estimation?: number;
|
|
1360
1051
|
/** Total number of contacts in provided audience (optional). */
|
|
1361
1052
|
total?: number | null;
|
|
1362
1053
|
}
|
|
1363
|
-
|
|
1054
|
+
interface ReconcileContactRequest {
|
|
1364
1055
|
/**
|
|
1365
1056
|
* Email address of the contact.
|
|
1366
1057
|
* @format EMAIL
|
|
1367
1058
|
*/
|
|
1368
1059
|
emailAddress?: string;
|
|
1369
1060
|
}
|
|
1370
|
-
|
|
1061
|
+
interface ReconcileContactResponse {
|
|
1371
1062
|
/** Created or retrieved contact. */
|
|
1372
1063
|
contact?: Contact;
|
|
1373
1064
|
}
|
|
1374
|
-
|
|
1065
|
+
interface Contact {
|
|
1375
1066
|
/**
|
|
1376
1067
|
* Unique ID of the contact entity.
|
|
1377
1068
|
* @format GUID
|
|
1378
1069
|
*/
|
|
1379
|
-
|
|
1070
|
+
_id?: string;
|
|
1380
1071
|
/**
|
|
1381
1072
|
* Primary email address of the contact.
|
|
1382
1073
|
* @format EMAIL
|
|
@@ -1394,7 +1085,7 @@ export interface Contact {
|
|
|
1394
1085
|
*/
|
|
1395
1086
|
pictureUrl?: string | null;
|
|
1396
1087
|
}
|
|
1397
|
-
|
|
1088
|
+
interface SearchContactsRequest {
|
|
1398
1089
|
/**
|
|
1399
1090
|
* Text to search contacts by - can search by name or email address.
|
|
1400
1091
|
* @maxLength 100
|
|
@@ -1408,24 +1099,24 @@ export interface SearchContactsRequest {
|
|
|
1408
1099
|
*/
|
|
1409
1100
|
pageSize?: number | null;
|
|
1410
1101
|
}
|
|
1411
|
-
|
|
1102
|
+
interface SearchContactsResponse {
|
|
1412
1103
|
/** Search results. */
|
|
1413
1104
|
contacts?: Contact[];
|
|
1414
1105
|
}
|
|
1415
|
-
|
|
1106
|
+
interface GetLabelsRequest {
|
|
1416
1107
|
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
1417
1108
|
activeContactsOnly?: boolean;
|
|
1418
1109
|
}
|
|
1419
|
-
|
|
1110
|
+
interface GetLabelsResponse {
|
|
1420
1111
|
/** Returned labels with contact counts. */
|
|
1421
1112
|
labels?: Label[];
|
|
1422
1113
|
}
|
|
1423
|
-
|
|
1114
|
+
interface Label {
|
|
1424
1115
|
/**
|
|
1425
1116
|
* Unique ID of the label entity.
|
|
1426
1117
|
* @maxLength 100
|
|
1427
1118
|
*/
|
|
1428
|
-
|
|
1119
|
+
_id?: string;
|
|
1429
1120
|
/**
|
|
1430
1121
|
* Name of the label.
|
|
1431
1122
|
* @maxLength 100
|
|
@@ -1434,7 +1125,7 @@ export interface Label {
|
|
|
1434
1125
|
/** Amount of contacts assigned to the label. */
|
|
1435
1126
|
contactsCount?: number;
|
|
1436
1127
|
}
|
|
1437
|
-
|
|
1128
|
+
interface SubscribeFromLandingPageRequest {
|
|
1438
1129
|
/**
|
|
1439
1130
|
* Campaign ID that the subscription is happening from.
|
|
1440
1131
|
* @format GUID
|
|
@@ -1448,7 +1139,244 @@ export interface SubscribeFromLandingPageRequest {
|
|
|
1448
1139
|
/** Did UoU explicitly consent to terms of use or not (optional, default value "false") */
|
|
1449
1140
|
consent?: boolean;
|
|
1450
1141
|
}
|
|
1451
|
-
|
|
1142
|
+
interface SubscribeFromLandingPageResponse {
|
|
1452
1143
|
/** @format GUID */
|
|
1453
1144
|
contactId?: string;
|
|
1454
1145
|
}
|
|
1146
|
+
interface ListStatisticsRequest {
|
|
1147
|
+
/**
|
|
1148
|
+
* IDs of the campaigns to retrieve (max 100 campaigns).
|
|
1149
|
+
* @format GUID
|
|
1150
|
+
* @minSize 1
|
|
1151
|
+
* @maxSize 100
|
|
1152
|
+
*/
|
|
1153
|
+
campaignIds: string[];
|
|
1154
|
+
}
|
|
1155
|
+
interface ListStatisticsResponse {
|
|
1156
|
+
/** List of statistics. */
|
|
1157
|
+
statistics?: CampaignStatisticsContainer[];
|
|
1158
|
+
}
|
|
1159
|
+
interface CampaignStatisticsContainer {
|
|
1160
|
+
/**
|
|
1161
|
+
* Campaign ID.
|
|
1162
|
+
* @format GUID
|
|
1163
|
+
*/
|
|
1164
|
+
campaignId?: string;
|
|
1165
|
+
/** Landing page statistics. */
|
|
1166
|
+
landingPage?: LandingPageStatistics;
|
|
1167
|
+
/** Email campaign statistics. */
|
|
1168
|
+
email?: DistributionStatistics;
|
|
1169
|
+
}
|
|
1170
|
+
interface ListRecipientsRequest {
|
|
1171
|
+
/**
|
|
1172
|
+
* Campaign ID.
|
|
1173
|
+
* @format GUID
|
|
1174
|
+
*/
|
|
1175
|
+
campaignId: string;
|
|
1176
|
+
/** Email activity to filter. */
|
|
1177
|
+
activity: RecipientsActivityEnumWithLiterals;
|
|
1178
|
+
/** Pagination options. */
|
|
1179
|
+
paging?: CursorPaging;
|
|
1180
|
+
}
|
|
1181
|
+
declare enum RecipientsActivityEnum {
|
|
1182
|
+
UNKNOWN = "UNKNOWN",
|
|
1183
|
+
DELIVERED = "DELIVERED",
|
|
1184
|
+
OPENED = "OPENED",
|
|
1185
|
+
CLICKED = "CLICKED",
|
|
1186
|
+
BOUNCED = "BOUNCED",
|
|
1187
|
+
NOT_SENT = "NOT_SENT",
|
|
1188
|
+
SENT = "SENT",
|
|
1189
|
+
NOT_OPENED = "NOT_OPENED"
|
|
1190
|
+
}
|
|
1191
|
+
/** @enumType */
|
|
1192
|
+
type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
|
|
1193
|
+
interface CursorPaging {
|
|
1194
|
+
/**
|
|
1195
|
+
* Number of items to load.
|
|
1196
|
+
* @max 1000
|
|
1197
|
+
*/
|
|
1198
|
+
limit?: number | null;
|
|
1199
|
+
/**
|
|
1200
|
+
* Pointer to the next or previous page in the list of results.
|
|
1201
|
+
*
|
|
1202
|
+
* You can get the relevant cursor token
|
|
1203
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1204
|
+
* Not relevant for the first request.
|
|
1205
|
+
* @maxLength 1000
|
|
1206
|
+
*/
|
|
1207
|
+
cursor?: string | null;
|
|
1208
|
+
}
|
|
1209
|
+
interface ListRecipientsResponse {
|
|
1210
|
+
/** List of recipients. */
|
|
1211
|
+
recipients?: CampaignRecipientDetails[];
|
|
1212
|
+
/** Details on the paged set of returned results. */
|
|
1213
|
+
pagingMetadata?: PagingMetadataV2;
|
|
1214
|
+
}
|
|
1215
|
+
interface CampaignRecipientDetails {
|
|
1216
|
+
/**
|
|
1217
|
+
* Contact ID.
|
|
1218
|
+
* @format GUID
|
|
1219
|
+
*/
|
|
1220
|
+
contactId?: string;
|
|
1221
|
+
/** Date and time of the last activity. */
|
|
1222
|
+
lastActivityDate?: Date | null;
|
|
1223
|
+
/**
|
|
1224
|
+
* Primary email address of the contact.
|
|
1225
|
+
* @format EMAIL
|
|
1226
|
+
*/
|
|
1227
|
+
emailAddress?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* Full name of the contact (optional).
|
|
1230
|
+
* @maxLength 100
|
|
1231
|
+
*/
|
|
1232
|
+
fullName?: string | null;
|
|
1233
|
+
/** Is this contact currently deleted from the site or not. */
|
|
1234
|
+
contactDeleted?: boolean;
|
|
1235
|
+
}
|
|
1236
|
+
interface PagingMetadataV2 {
|
|
1237
|
+
/** Number of items returned in the response. */
|
|
1238
|
+
count?: number | null;
|
|
1239
|
+
/** Offset that was requested. */
|
|
1240
|
+
offset?: number | null;
|
|
1241
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1242
|
+
total?: number | null;
|
|
1243
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1244
|
+
tooManyToCount?: boolean | null;
|
|
1245
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1246
|
+
cursors?: Cursors;
|
|
1247
|
+
}
|
|
1248
|
+
interface Cursors {
|
|
1249
|
+
/**
|
|
1250
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1251
|
+
* @maxLength 16000
|
|
1252
|
+
*/
|
|
1253
|
+
next?: string | null;
|
|
1254
|
+
/**
|
|
1255
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1256
|
+
* @maxLength 16000
|
|
1257
|
+
*/
|
|
1258
|
+
prev?: string | null;
|
|
1259
|
+
}
|
|
1260
|
+
interface BaseEventMetadata {
|
|
1261
|
+
/**
|
|
1262
|
+
* App instance ID.
|
|
1263
|
+
* @format GUID
|
|
1264
|
+
*/
|
|
1265
|
+
instanceId?: string | null;
|
|
1266
|
+
/**
|
|
1267
|
+
* Event type.
|
|
1268
|
+
* @maxLength 150
|
|
1269
|
+
*/
|
|
1270
|
+
eventType?: string;
|
|
1271
|
+
/** The identification type and identity data. */
|
|
1272
|
+
identity?: IdentificationData;
|
|
1273
|
+
}
|
|
1274
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1275
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1276
|
+
_id?: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1279
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1280
|
+
*/
|
|
1281
|
+
entityFqdn?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1284
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1285
|
+
*/
|
|
1286
|
+
slug?: string;
|
|
1287
|
+
/** ID of the entity associated with the event. */
|
|
1288
|
+
entityId?: string;
|
|
1289
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1290
|
+
eventTime?: Date | null;
|
|
1291
|
+
/**
|
|
1292
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1293
|
+
* (for example, GDPR).
|
|
1294
|
+
*/
|
|
1295
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1296
|
+
/** If present, indicates the action that triggered the event. */
|
|
1297
|
+
originatedFrom?: string | null;
|
|
1298
|
+
/**
|
|
1299
|
+
* 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.
|
|
1300
|
+
* 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.
|
|
1301
|
+
*/
|
|
1302
|
+
entityEventSequence?: string | null;
|
|
1303
|
+
}
|
|
1304
|
+
interface CampaignDistributedEnvelope {
|
|
1305
|
+
data: Distributed;
|
|
1306
|
+
metadata: EventMetadata;
|
|
1307
|
+
}
|
|
1308
|
+
interface CampaignPausedEnvelope {
|
|
1309
|
+
data: Paused;
|
|
1310
|
+
metadata: EventMetadata;
|
|
1311
|
+
}
|
|
1312
|
+
interface CampaignPublishedEnvelope {
|
|
1313
|
+
data: Published;
|
|
1314
|
+
metadata: EventMetadata;
|
|
1315
|
+
}
|
|
1316
|
+
interface CampaignRejectedEnvelope {
|
|
1317
|
+
data: Rejected;
|
|
1318
|
+
metadata: EventMetadata;
|
|
1319
|
+
}
|
|
1320
|
+
interface CampaignScheduledEnvelope {
|
|
1321
|
+
data: Scheduled;
|
|
1322
|
+
metadata: EventMetadata;
|
|
1323
|
+
}
|
|
1324
|
+
interface CampaignTerminatedEnvelope {
|
|
1325
|
+
data: Terminated;
|
|
1326
|
+
metadata: EventMetadata;
|
|
1327
|
+
}
|
|
1328
|
+
interface CampaignCreatedEnvelope {
|
|
1329
|
+
entity: Campaign;
|
|
1330
|
+
metadata: EventMetadata;
|
|
1331
|
+
}
|
|
1332
|
+
interface CampaignDeletedEnvelope {
|
|
1333
|
+
metadata: EventMetadata;
|
|
1334
|
+
}
|
|
1335
|
+
interface CampaignEmailActivityUpdatedEnvelope {
|
|
1336
|
+
data: EmailActivityUpdated;
|
|
1337
|
+
metadata: EventMetadata;
|
|
1338
|
+
}
|
|
1339
|
+
interface GetCampaignOptions {
|
|
1340
|
+
/**
|
|
1341
|
+
* Whether a returned campaign should include `publishingData.statistics`.
|
|
1342
|
+
*
|
|
1343
|
+
* Default: `false`.
|
|
1344
|
+
*/
|
|
1345
|
+
optionIncludeStatistics?: boolean;
|
|
1346
|
+
}
|
|
1347
|
+
interface ListCampaignsOptions {
|
|
1348
|
+
/** Paging parameters. */
|
|
1349
|
+
paging?: Paging;
|
|
1350
|
+
/**
|
|
1351
|
+
* Whether to include `publishingData.statistics` in the returned campaign object.
|
|
1352
|
+
*
|
|
1353
|
+
* Default: `false`.
|
|
1354
|
+
*/
|
|
1355
|
+
optionIncludeStatistics?: boolean;
|
|
1356
|
+
/** Campaign status. */
|
|
1357
|
+
statuses?: CampaignStatusEnumWithLiterals[];
|
|
1358
|
+
/** Visibility status. */
|
|
1359
|
+
visibilityStatuses?: CampaignVisibilityStatusEnumWithLiterals[];
|
|
1360
|
+
}
|
|
1361
|
+
interface PublishCampaignOptions {
|
|
1362
|
+
/** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
|
|
1363
|
+
emailDistributionOptions?: EmailDistributionOptions;
|
|
1364
|
+
}
|
|
1365
|
+
interface SendTestOptions {
|
|
1366
|
+
/**
|
|
1367
|
+
* Email subject.
|
|
1368
|
+
* @maxLength 1000
|
|
1369
|
+
*/
|
|
1370
|
+
emailSubject?: string | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* Recipient email address.
|
|
1373
|
+
* @format EMAIL
|
|
1374
|
+
*/
|
|
1375
|
+
toEmailAddress: string;
|
|
1376
|
+
}
|
|
1377
|
+
interface ListRecipientsOptions {
|
|
1378
|
+
/** Pagination options. */
|
|
1379
|
+
paging?: CursorPaging;
|
|
1380
|
+
}
|
|
1381
|
+
|
|
1382
|
+
export { type Rejected as $, ActivityType as A, type RejectionData as B, type Campaign as C, type DistributionStatistics as D, Enum as E, type GetCampaignRequest as F, type GetCampaignOptions as G, type GetCampaignResponse as H, type IdentifySenderAddressResponse as I, type ListCampaignsRequest as J, type Paging as K, type ListCampaignsOptions as L, type CountCampaignsRequest as M, type CountCampaignsResponse as N, type CreateFromTemplateRequest as O, type PublishCampaignOptions as P, type CreateFromTemplateResponse as Q, type ReuseCampaignResponse as R, type SendTestOptions as S, type TotalStatistics as T, type CreateUserTemplateRequest as U, type CreateUserTemplateResponse as V, WebhookIdentityType as W, type CreateFromUserTemplateRequest as X, type CreateFromUserTemplateResponse as Y, type PublishCampaignRequest as Z, type EmailDistributionOptions as _, type ListCampaignsResponse as a, type MessageEnvelope as a$, type Published as a0, type Terminated as a1, type Distributed as a2, type EmailActivityUpdated as a3, type EmailActivityUpdatedEventTypeOneOf as a4, type Click as a5, type Open as a6, type SoftBounce as a7, type HardBounce as a8, type Scheduled as a9, type UpdateTitleResponse as aA, type DeleteCampaignRequest as aB, type DeleteCampaignResponse as aC, type ReuseCampaignRequest as aD, type PreviewCampaignRequest as aE, type PreviewCampaignResponse as aF, type GetComposerRequest as aG, type GetComposerResponse as aH, type Composer as aI, type DefaultValues as aJ, type UpdateComposerRequest as aK, type CampaignEditorType as aL, type UpdateComposerResponse as aM, type CreateCampaignRequest as aN, type CreateCampaignResponse as aO, type ResendToNonOpenersRequest as aP, type ResendToNonOpenersResponse as aQ, type GetAudienceRequest as aR, type CampaignAudience as aS, type IdentifySenderAddressRequest as aT, type DomainEvent as aU, type DomainEventBodyOneOf as aV, type EntityCreatedEvent as aW, type RestoreInfo as aX, type EntityUpdatedEvent as aY, type EntityDeletedEvent as aZ, type ActionEvent as a_, type SendTestRequest as aa, type PlaceholderContent as ab, type PlaceholderContentValueOneOf as ac, type PlainText as ad, type Html as ae, type Money as af, type DateTime as ag, type Map as ah, type _Array as ai, type PlaceholderContentEnum as aj, type Attachment as ak, type Integer as al, type Decimal as am, type SendTestResponse as an, type PauseSchedulingRequest as ao, type PauseSchedulingResponse as ap, type Paused as aq, type RescheduleRequest as ar, type RescheduleResponse as as, type ArchiveCampaignRequest as at, type ArchiveCampaignResponse as au, type Archived as av, type UnarchiveCampaignRequest as aw, type UnarchiveCampaignResponse as ax, type Unarchived as ay, type UpdateTitleRequest as az, type PublishCampaignResponse as b, type IdentificationData as b0, type IdentificationDataIdOneOf as b1, type EstimateFilterSizeRequest as b2, type EstimateFilterSizeResponse as b3, type EstimateAudienceSizeRequest as b4, type EstimateAudienceSizeResponse as b5, type ReconcileContactRequest as b6, type ReconcileContactResponse as b7, type Contact as b8, type SearchContactsRequest as b9, type SearchContactsResponse as ba, type GetLabelsRequest as bb, type GetLabelsResponse as bc, type Label as bd, type SubscribeFromLandingPageRequest as be, type SubscribeFromLandingPageResponse as bf, type ListStatisticsRequest as bg, type CampaignStatisticsContainer as bh, type ListRecipientsRequest as bi, type CursorPaging as bj, type CampaignRecipientDetails as bk, type PagingMetadataV2 as bl, type Cursors as bm, type BaseEventMetadata as bn, type EventMetadata as bo, type GetAudienceResponse as c, type ListStatisticsResponse as d, type RecipientsActivityEnumWithLiterals as e, type ListRecipientsOptions as f, type ListRecipientsResponse as g, type CampaignDistributedEnvelope as h, type CampaignPausedEnvelope as i, type CampaignPublishedEnvelope as j, type CampaignRejectedEnvelope as k, type CampaignScheduledEnvelope as l, type CampaignTerminatedEnvelope as m, type CampaignCreatedEnvelope as n, type CampaignDeletedEnvelope as o, type CampaignEmailActivityUpdatedEnvelope as p, CampaignEditorTypeEnum as q, CampaignStatusEnum as r, CampaignVisibilityStatusEnum as s, RejectionReasonEnum as t, CampaignSendingStateEnum as u, CampaignTypeEnum as v, RecipientsActivityEnum as w, type PublishingData as x, type CampaignStatistics as y, type LandingPageStatistics as z };
|