-
Notifications
You must be signed in to change notification settings - Fork 79
/
members.go
435 lines (341 loc) Β· 12.5 KB
/
members.go
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
package gochimp3
import (
"crypto/md5"
"errors"
"fmt"
"io"
)
const (
members_path = "/lists/%s/members"
single_member_path = members_path + "/%s"
member_activity_path = single_member_path + "/activity"
member_goals_path = single_member_path + "/goals"
member_notes_path = single_member_path + "/notes"
single_member_note_path = member_notes_path + "/%s"
member_tags_path = single_member_path + "/tags"
single_member_tag_path = member_tags_path + "/%s"
delete_permanent_path = single_member_path + "/actions/delete-permanent"
)
type ListOfMembers struct {
baseList
ListID string `json:"list_id"`
Members []Member `json:"members"`
}
type MemberResponse struct {
EmailAddress string `json:"email_address"`
EmailType string `json:"email_type,omitempty"`
Status string `json:"status"`
StatusIfNew string `json:"status_if_new,omitempty"`
MergeFields map[string]interface{} `json:"merge_fields,omitempty"`
Interests map[string]bool `json:"interests,omitempty"`
Language string `json:"language"`
VIP bool `json:"vip"`
Location *MemberLocation `json:"location,omitempty"`
IPOpt string `json:"ip_opt,omitempty"`
IPSignup string `json:"ip_signup,omitempty"`
Tags []MemberTag `json:"tags,omitempty"`
TimestampSignup string `json:"timestamp_signup,omitempty"`
TimestampOpt string `json:"timestamp_opt,omitempty"`
}
type MemberRequest struct {
EmailAddress string `json:"email_address"`
EmailType string `json:"email_type,omitempty"`
Status string `json:"status"`
StatusIfNew string `json:"status_if_new,omitempty"`
MergeFields map[string]interface{} `json:"merge_fields,omitempty"`
Interests map[string]bool `json:"interests,omitempty"`
Language string `json:"language"`
VIP bool `json:"vip"`
Location *MemberLocation `json:"location,omitempty"`
MarketingPermissions *MarketingPermissions `json:"marketing_permissions,omitempty"`
IPOpt string `json:"ip_opt,omitempty"`
IPSignup string `json:"ip_signup,omitempty"`
Tags []string `json:"tags,omitempty"`
TimestampSignup string `json:"timestamp_signup,omitempty"`
TimestampOpt string `json:"timestamp_opt,omitempty"`
}
type Member struct {
MemberResponse
ID string `json:"id"`
ListID string `json:"list_id"`
UniqueEmailID string `json:"unique_email_id"`
EmailType string `json:"email_type"`
Stats MemberStats `json:"stats"`
MemberRating int `json:"member_rating"`
LastChanged string `json:"last_changed"`
EmailClient string `json:"email_client"`
LastNote MemberNoteShort `json:"last_note"`
api *API
}
func (mem *Member) CanMakeRequest() error {
if mem.ListID == "" {
return errors.New("No ListID provided")
}
if mem.ID == "" {
return errors.New("No ID provided")
}
return nil
}
func (mem *Member) WithApi(api *API) *Member {
mem.api = api
return mem
}
func (mem *Member) SetIdByMail(email string) *Member {
h := md5.New()
_, err := io.WriteString(h, email)
if err != nil {
panic(err)
}
mem.ID = fmt.Sprintf("%x", h.Sum(nil))
return mem
}
// The Member struct returned by this should be all you need to start calling APIs for this member,
// meaning it should pass CanMakeRequest.
func (api *API) MemberForApiCalls(listId, email string) *Member {
return (&Member{ListID: listId}).WithApi(api).SetIdByMail(email)
}
type MemberStats struct {
AvgOpenRate float64 `json:"avg_open_rate"`
AvgClickRate float64 `json:"avg_click_rate"`
}
type MemberLocation struct {
Latitude float64 `json:"latitude"`
Longitude float64 `json:"longitude"`
GMTOffset int `json:"gmtoff"`
DSTOffset int `json:"dstoff"`
CountryCode string `json:"country_code"`
Timezone string `json:"timezone"`
}
type MarketingPermissions []MarketingPermission
type MarketingPermission struct {
MarketingPermissionID string `json:"marketing_permission_id"`
Text string `json:"text"`
Enabled bool `json:"enabled"`
}
type MemberNoteShort struct {
ID int `json:"note_id"`
CreatedAt string `json:"created_at"`
CreatedBy string `json:"created_by"`
Note string `json:"note"`
}
type MemberTag struct {
ID int `json:"id"`
Name string `json:"name"`
}
func (list *ListResponse) GetMembers(params *InterestCategoriesQueryParams) (*ListOfMembers, error) {
if err := list.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(members_path, list.ID)
response := new(ListOfMembers)
err := list.api.Request("GET", endpoint, params, nil, response)
if err != nil {
return nil, err
}
for _, m := range response.Members {
m.api = list.api
}
return response, nil
}
func (list *ListResponse) GetMember(id string, params *BasicQueryParams) (*Member, error) {
if err := list.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(single_member_path, list.ID, id)
response := new(Member)
response.api = list.api
return response, list.api.Request("GET", endpoint, params, nil, response)
}
func (list *ListResponse) CreateMember(body *MemberRequest) (*Member, error) {
if err := list.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(members_path, list.ID)
response := new(Member)
response.api = list.api
return response, list.api.Request("POST", endpoint, nil, body, response)
}
func (list *ListResponse) UpdateMember(id string, body *MemberRequest) (*Member, error) {
if err := list.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(single_member_path, list.ID, id)
response := new(Member)
response.api = list.api
return response, list.api.Request("PATCH", endpoint, nil, body, response)
}
func (list *ListResponse) AddOrUpdateMember(id string, body *MemberRequest) (*Member, error) {
if err := list.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(single_member_path, list.ID, id)
response := new(Member)
response.api = list.api
return response, list.api.Request("PUT", endpoint, nil, body, response)
}
func (list *ListResponse) DeleteMember(id string) (bool, error) {
if err := list.CanMakeRequest(); err != nil {
return false, err
}
endpoint := fmt.Sprintf(single_member_path, list.ID, id)
return list.api.RequestOk("DELETE", endpoint)
}
func (list *ListResponse) DeleteMemberPermanent(id string) (bool, error) {
if err := list.CanMakeRequest(); err != nil {
return false, err
}
endpoint := fmt.Sprintf(delete_permanent_path, list.ID, id)
return list.api.RequestOk("POST", endpoint)
}
// ------------------------------------------------------------------------------------------------
// Activity
// ------------------------------------------------------------------------------------------------
type ListOfMemberActivity struct {
baseList
EmailID string `json:"email_id"`
ListID string `json:"list_id"`
Activity []Activity `json:"activity"`
}
type MemberActivity struct {
Action string `json:"action"`
Timestamp string `json:"timestamp"`
URL string `json:"url"`
Type string `json:"type"`
CampaignID string `json:"campaign_id"`
Title string `json:"title"`
ParentCampaign string `json:"parent_campaign"`
}
func (mem *Member) GetActivity(params *BasicQueryParams) (*ListOfMemberActivity, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(member_activity_path, mem.ListID, mem.ID)
response := new(ListOfMemberActivity)
return response, mem.api.Request("GET", endpoint, params, nil, response)
}
// ------------------------------------------------------------------------------------------------
// Goals
// ------------------------------------------------------------------------------------------------
type ListOfMemberGoals struct {
baseList
EmailID string `json:"email_id"`
ListID string `json:"list_id"`
Goals []MemberGoal `json:"goals"`
}
type MemberGoal struct {
ID int `json:"goal_id"`
Event string `json:"event"`
LastVisitedAt string `json:"last_visited_at"`
Data string `json:"data"`
}
func (mem *Member) GetGoals(params *BasicQueryParams) (*ListOfMemberGoals, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(member_goals_path, mem.ListID, mem.ID)
response := new(ListOfMemberGoals)
return response, mem.api.Request("GET", endpoint, params, nil, response)
}
// ------------------------------------------------------------------------------------------------
// NOTES
// ------------------------------------------------------------------------------------------------
type ListOfMemberNotes struct {
baseList
EmailID string `json:"email_id"`
ListID string `json:"list_id"`
Notes []MemberNoteLong `json:"notes"`
}
type MemberNoteLong struct {
ID int `json:"id"`
CreatedAt string `json:"created_at"`
CreatedBy string `json:"created_by"`
UpdatedAt string `json:"updated_at"`
Note string `json:"note"`
ListID string `json:"list_id"`
EmailID string `json:"email_id"`
withLinks
}
func (mem *Member) GetNotes(params *ExtendedQueryParams) (*ListOfMemberNotes, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(member_notes_path, mem.ListID, mem.ID)
response := new(ListOfMemberNotes)
return response, mem.api.Request("GET", endpoint, params, nil, response)
}
func (mem *Member) CreateNote(msg string) (*MemberNoteLong, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(member_notes_path, mem.ListID, mem.ID)
response := new(MemberNoteLong)
body := struct{ Note string }{
Note: msg,
}
return response, mem.api.Request("POST", endpoint, nil, &body, response)
}
func (mem *Member) UpdateNote(id, msg string) (*MemberNoteLong, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(single_member_note_path, mem.ListID, mem.ID, id)
response := new(MemberNoteLong)
body := struct{ Note string }{
Note: msg,
}
return response, mem.api.Request("PATCH", endpoint, nil, &body, response)
}
func (mem *Member) GetNote(id string, params *BasicQueryParams) (*MemberNoteLong, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(single_member_note_path, mem.ListID, mem.ID, id)
response := new(MemberNoteLong)
return response, mem.api.Request("GET", endpoint, params, nil, response)
}
func (mem *Member) DeleteNote(id string) (bool, error) {
if err := mem.CanMakeRequest(); err != nil {
return false, err
}
endpoint := fmt.Sprintf(single_member_note_path, mem.ListID, mem.ID, id)
return mem.api.RequestOk("DELETE", endpoint)
}
// ------------------------------------------------------------------------------------------------
// TAGS
// ------------------------------------------------------------------------------------------------
type ListOfMemberTags struct {
baseList
Tags []MemberTagLong `json:"tags"`
}
type UpdateMemberTag struct {
Name string `json:"name"`
Status string `json:"status"`
}
type MemberTagLong struct {
ID int `json:"id"`
Name string `json:"name"`
DataAdded *string `json:"date_added,omitempty"`
Status string `json:"status,omitempty"`
withLinks
}
func (mem *Member) GetTags(params *ExtendedQueryParams) (*ListOfMemberTags, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(member_tags_path, mem.ListID, mem.ID)
response := new(ListOfMemberTags)
return response, mem.api.Request("GET", endpoint, params, nil, response)
}
func (mem *Member) UpdateTags(tags []UpdateMemberTag) (*ListOfMemberTags, error) {
if err := mem.CanMakeRequest(); err != nil {
return nil, err
}
endpoint := fmt.Sprintf(member_tags_path, mem.ListID, mem.ID)
response := new(ListOfMemberTags)
body := struct {
Tags []UpdateMemberTag `json:"tags,omitempty"`
}{
Tags: tags,
}
return response, mem.api.Request("POST", endpoint, nil, &body, response)
}