@wix/email-subscriptions 1.0.22 → 1.0.23

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.
@@ -10,60 +10,48 @@ interface EmailSubscription$1 {
10
10
  * Indicates the recipient's opt-in or opt-out status
11
11
  * for marketing emails.
12
12
  *
13
- * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
14
- * - `PENDING`: Subscription confirmation was requested,
15
- * but recipient hasn't confirmed yet.
16
- * - `SUBSCRIBED`: Recipient has opted in to marketing emails.
17
- * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.
18
- *
19
- * Defaults to `NOT_SET`.
13
+ * Default: `NOT_SET`.
20
14
  */
21
15
  subscriptionStatus?: SubscriptionEnumStatus$1;
22
16
  /**
23
17
  * Indicates last reported status of sent emails.
24
18
  *
25
- * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
26
- * - `VALID`: Emails to this email address are being delivered successfully.
27
- * - `BOUNCED`: The last email to the recipient bounced or was rejected.
28
- * - `SPAM_COMPLAINT`: The recipient registered a spam complaint
29
- * with their email provider.
30
- * - `INACTIVE`: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.)
31
- * This status might impact subsequent emails sent to this address.
32
- *
33
- * Defaults to `NOT_SET`.
19
+ * Default: `NOT_SET`.
34
20
  */
35
21
  deliverabilityStatus?: Status$1;
36
22
  /**
37
23
  * Date and time the email subscription was created.
38
24
  * @readonly
39
25
  */
40
- createdDate?: Date;
26
+ createdDate?: Date | null;
41
27
  /**
42
28
  * Date and time the email subscription was last updated.
43
29
  * @readonly
44
30
  */
45
- updatedDate?: Date;
31
+ updatedDate?: Date | null;
46
32
  }
47
33
  declare enum SubscriptionEnumStatus$1 {
34
+ /** Undefined status. */
48
35
  UNKNOWN = "UNKNOWN",
49
- /** No Subscription exists */
36
+ /** No status specified. This is the default, initial value before any info about the email address is known. */
50
37
  NOT_SET = "NOT_SET",
51
- /** Pending Subscription */
38
+ /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
52
39
  PENDING = "PENDING",
53
- /** Subscribed */
40
+ /** Recipient has opted in to marketing emails. */
54
41
  SUBSCRIBED = "SUBSCRIBED",
55
- /** UnSubscribed */
42
+ /** Recipient has opted out of marketing emails. */
56
43
  UNSUBSCRIBED = "UNSUBSCRIBED"
57
44
  }
58
45
  declare enum Status$1 {
46
+ /** No status specified. This is the initial default value before any info about the email address is known. */
59
47
  NOT_SET = "NOT_SET",
60
- /** valid/deferral */
48
+ /** Emails to this email address are being delivered successfully. */
61
49
  VALID = "VALID",
62
- /** bounced/rejected/invalid */
50
+ /** The last email to the recipient bounced or was rejected. */
63
51
  BOUNCED = "BOUNCED",
64
- /** spam/complaint */
52
+ /** The recipient registered a spam complaint with their email provider. */
65
53
  SPAM_COMPLAINT = "SPAM_COMPLAINT",
66
- /** valid, but no activity reported */
54
+ /** Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.) This status might impact subsequent emails sent to this address. */
67
55
  INACTIVE = "INACTIVE"
68
56
  }
69
57
  interface QueryEmailSubscriptionsRequest$1 {
@@ -198,60 +186,48 @@ interface EmailSubscription {
198
186
  * Indicates the recipient's opt-in or opt-out status
199
187
  * for marketing emails.
200
188
  *
201
- * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
202
- * - `PENDING`: Subscription confirmation was requested,
203
- * but recipient hasn't confirmed yet.
204
- * - `SUBSCRIBED`: Recipient has opted in to marketing emails.
205
- * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.
206
- *
207
- * Defaults to `NOT_SET`.
189
+ * Default: `NOT_SET`.
208
190
  */
209
191
  subscriptionStatus?: SubscriptionEnumStatus;
210
192
  /**
211
193
  * Indicates last reported status of sent emails.
212
194
  *
213
- * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
214
- * - `VALID`: Emails to this email address are being delivered successfully.
215
- * - `BOUNCED`: The last email to the recipient bounced or was rejected.
216
- * - `SPAM_COMPLAINT`: The recipient registered a spam complaint
217
- * with their email provider.
218
- * - `INACTIVE`: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.)
219
- * This status might impact subsequent emails sent to this address.
220
- *
221
- * Defaults to `NOT_SET`.
195
+ * Default: `NOT_SET`.
222
196
  */
223
197
  deliverabilityStatus?: Status;
224
198
  /**
225
199
  * Date and time the email subscription was created.
226
200
  * @readonly
227
201
  */
228
- _createdDate?: Date;
202
+ _createdDate?: Date | null;
229
203
  /**
230
204
  * Date and time the email subscription was last updated.
231
205
  * @readonly
232
206
  */
233
- _updatedDate?: Date;
207
+ _updatedDate?: Date | null;
234
208
  }
235
209
  declare enum SubscriptionEnumStatus {
210
+ /** Undefined status. */
236
211
  UNKNOWN = "UNKNOWN",
237
- /** No Subscription exists */
212
+ /** No status specified. This is the default, initial value before any info about the email address is known. */
238
213
  NOT_SET = "NOT_SET",
239
- /** Pending Subscription */
214
+ /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
240
215
  PENDING = "PENDING",
241
- /** Subscribed */
216
+ /** Recipient has opted in to marketing emails. */
242
217
  SUBSCRIBED = "SUBSCRIBED",
243
- /** UnSubscribed */
218
+ /** Recipient has opted out of marketing emails. */
244
219
  UNSUBSCRIBED = "UNSUBSCRIBED"
245
220
  }
246
221
  declare enum Status {
222
+ /** No status specified. This is the initial default value before any info about the email address is known. */
247
223
  NOT_SET = "NOT_SET",
248
- /** valid/deferral */
224
+ /** Emails to this email address are being delivered successfully. */
249
225
  VALID = "VALID",
250
- /** bounced/rejected/invalid */
226
+ /** The last email to the recipient bounced or was rejected. */
251
227
  BOUNCED = "BOUNCED",
252
- /** spam/complaint */
228
+ /** The recipient registered a spam complaint with their email provider. */
253
229
  SPAM_COMPLAINT = "SPAM_COMPLAINT",
254
- /** valid, but no activity reported */
230
+ /** Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.) This status might impact subsequent emails sent to this address. */
255
231
  INACTIVE = "INACTIVE"
256
232
  }
257
233
  interface QueryEmailSubscriptionsRequest {