-
Notifications
You must be signed in to change notification settings - Fork 0
/
enums.json
222 lines (222 loc) · 7.31 KB
/
enums.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
{
"ExportCollection": {
"subscribers": {
"variant": "info",
"name": "Subscribers"
},
"emails": {
"variant": "info",
"name": "Emails"
},
"scheduled_emails": {
"variant": "info",
"name": "Scheduled emails"
},
"drafts": {
"variant": "info",
"name": "Drafts"
},
"unsubscribers": {
"variant": "info",
"name": "Unsubscribers"
},
"events": {
"variant": "info",
"name": "Events"
},
"referrals": {
"variant": "info",
"name": "Referrals"
}
},
"ExportStatus": {
"not_started": {
"variant": "info",
"name": "Not started",
"description": "The export has not yet started"
},
"in_progress": {
"variant": "info",
"name": "In progress",
"description": "The export is currently being processed"
},
"ready": {
"variant": "success",
"description": "The export has completed"
},
"error": {
"variant": "error",
"description": "The export was unable to be completed. Buttondown is looking into it."
}
},
"EventType": {
"subscriber.created": {
"name": "subscriber.created",
"description": "Whenever a new subscriber is created"
},
"subscriber.unsubscribed": {
"name": "subscriber.unsubscribed",
"description": "When a subscriber has manually unsubscribed from your newsletter"
},
"subscriber.confirmed": {
"name": "subscriber.confirmed",
"description": "When a subscriber has confirmed that they are enrolled in your newsletter. (For newsletters without double opt-in, this event is created immediately after `subscriber.created`.)"
},
"subscriber.trial_started": {
"name": "subscriber.trial_started",
"description": "When the trial has started for a subscriber. (For newsletters with automatic free trials, this will be created immediately after `subscriber.confirmed`.)"
},
"subscriber.trial_ended": {
"name": "subscriber.trial_ended",
"description": "When the trial has ended for a subscriber."
},
"subscriber.paid": {
"name": "subscriber.paid",
"description": "When a subscriber has enrolled in your newsletter's paid offering"
},
"subscriber.churned": {
"name": "subscriber.churned",
"description": "When a subscriber has unenrolled from your newsletter's paid offering"
},
"subscriber.updated": {
"name": "subscriber.updated",
"description": "When a subscriber's notes or metadata has changed"
},
"email.created": {
"name": "email.created",
"description": "Whenever a new email is created and begins delivery. Note that event happens immediately before the emails themselves are sent."
},
"email.sent": {
"name": "email.sent",
"description": "Whenever an email has finished its delivery. Note that event happens immediately after all emails have been sent, but some email events may not have finished processing."
}
},
"BulkActionStatus": {
"not_started": {
"variant": "info",
"name": "Not started",
"description": "The bulk action has not yet started"
},
"in_progress": {
"variant": "info",
"name": "In progress",
"description": "The bulk action is currently being processed"
},
"processed": {
"variant": "success",
"description": "The bulk action has completed"
},
"failed": {
"variant": "error",
"description": "The bulk action was unable to be completed. Buttondown is looking into it."
}
},
"BulkActionType": {
"apply_tags": {
"variant": "info",
"name": "Apply tags",
"description": "This action requires two additional parameters within `metadata`: `tag_id` (the ID of the tag which you'd like to either add or remove to the list of subscribers) and `action` (which can be either `add` or `remove`)."
},
"apply_metadata": {
"variant": "info",
"name": "Apply metadata (to subscribers)",
"description": "This action requires two additional parameters within `metadata`: `action` (which can be either `add`, `set`, or `remove`), and `metadata` (the value of the metadata which you'd like to either add or remove to the list of subscribers)."
},
"ban_subscribers": {
"variant": "info",
"name": "Ban subscribers"
},
"delete_emails": {
"variant": "info",
"name": "Delete emails"
},
"delete_subscribers": {
"variant": "info",
"name": "Delete subscribers"
},
"delete_tags": {
"variant": "info",
"name": "Delete tags"
},
"reactivate_subscribers": {
"variant": "info",
"name": "Reactivate subscribers"
},
"replay_events": {
"variant": "info",
"name": "Replay events"
},
"resubscribe_subscribers": {
"variant": "info",
"name": "Resubscribe subscribers"
},
"send_emails": {
"variant": "info",
"name": "Send emails",
"description": "This action requires one additional parameter within `metadata`: `email_id` (the ID of the email which you'd like to send)."
},
"send_reminders": {
"variant": "info",
"name": "Send reminders"
},
"update_email_types": {
"variant": "info",
"name": "Update email types"
},
"unsubscribe_subscribers": {
"variant": "info",
"name": "Unsubscribe subscribers"
}
},
"SubscriberType": {
"regular": {
"variant": "success",
"description": "normal subscribers who have not unsubscribed or deactivated in any way"
},
"premium": {
"variant": "success",
"description": "subscribers with active premium subscriptions"
},
"trialed": {
"variant": "info",
"description": "subscribers that are temporarily receiving a premium subscription to your newsletter"
},
"unpaid": {
"variant": "info",
"description": "subscribers who have not yet purchased a subscription to your newsletter"
},
"gifted": {
"variant": "info",
"description": "subscribers that have been gifted free premium subscriptions"
},
"churning": {
"variant": "warning",
"description": "subscribers who have elected to not renew their subscription to your newsletter and will become unpaid subscribers at the end of their current billing period"
},
"unactivated": {
"variant": "warning",
"description": "subscribers who have not yet confirmed their email or opted in"
},
"paused": {
"variant": "warning",
"description": "subscribers that are on a temporary hold from their premium subscription, but are still subscribed to your newsletter"
},
"unsubscribed": {
"variant": "error",
"description": "subscribers that have voluntarily unsubscribed from your newsletter"
},
"spammy": {
"variant": "error",
"description": "subscribers that have been deemed spammy by Buttondown's automated systems"
},
"removed": {
"variant": "error",
"description": "subscribers who have been explicitly removed by the newsletter (notably, this does not mean unsubscribers: use /v1/unsubscribers for that!)"
},
"past_due": {
"variant": "error",
"name": "Past due",
"description": "subscribers who technically have active paid subscriptions, but have not paid their invoices in time"
}
}
}