forked from intercom/intercom-go
/
user.go
148 lines (125 loc) · 5.77 KB
/
user.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
package intercom
import "fmt"
// UserService handles interactions with the API through a UserRepository.
type UserService struct {
Repository UserRepository
}
// UserList holds a list of Users and paging information
type UserList struct {
Pages PageParams
Users []User
}
// User represents a User within Intercom.
// Not all of the fields are writeable to the API, non-writeable fields are
// stripped out from the request. Please see the API documentation for details.
type User struct {
ID string `json:"id,omitempty"`
Email string `json:"email,omitempty"`
UserID string `json:"user_id,omitempty"`
Anonymous *bool `json:"anonymous,omitempty"`
Name string `json:"name,omitempty"`
Pseudonym string `json:"pseudonym,omitempty"`
Avatar *UserAvatar `json:"avatar,omitempty"`
LocationData *LocationData `json:"location_data,omitempty"`
SignedUpAt int32 `json:"signed_up_at,omitempty"`
RemoteCreatedAt int32 `json:"remote_created_at,omitempty"`
LastRequestAt int32 `json:"last_request_at,omitempty"`
CreatedAt int32 `json:"created_at,omitempty"`
UpdatedAt int32 `json:"updated_at,omitempty"`
SessionCount int32 `json:"session_count,omitempty"`
LastSeenIP string `json:"last_seen_ip,omitempty"`
SocialProfiles *SocialProfileList `json:"social_profiles,omitempty"`
UnsubscribedFromEmails *bool `json:"unsubscribed_from_emails,omitempty"`
UserAgentData string `json:"user_agent_data,omitempty"`
Tags *TagList `json:"tags,omitempty"`
Segments *SegmentList `json:"segments,omitempty"`
Companies *CompanyList `json:"companies,omitempty"`
CustomAttributes map[string]interface{} `json:"custom_attributes,omitempty"`
UpdateLastRequestAt *bool `json:"update_last_request_at,omitempty"`
NewSession *bool `json:"new_session,omitempty"`
LastSeenUserAgent string `json:"last_seen_user_agent,omitempty"`
}
// LocationData represents the location for a User.
type LocationData struct {
CityName string `json:"city_name,omitempty"`
ContinentCode string `json:"continent_code,omitempty"`
CountryName string `json:"country_name,omitempty"`
Latitude float64 `json:"latitude,omitempty"`
Longitude float64 `json:"longitude,omitempty"`
PostalCode string `json:"postal_code,omitempty"`
RegionName string `json:"region_name,omitempty"`
Timezone string `json:"timezone,omitempty"`
CountryCode string `json:"country_code,omitempty"`
}
// SocialProfile list is a list of SocialProfiles for a User.
type SocialProfileList struct {
SocialProfiles []SocialProfile `json:"social_profiles,omitempty"`
}
// SocialProfile represents a social account for a User.
type SocialProfile struct {
Name string `json:"name,omitempty"`
ID string `json:"id,omitempty"`
Username string `json:"username,omitempty"`
URL string `json:"url,omitempty"`
}
// UserIdentifiers are used to identify Users in Intercom.
type UserIdentifiers struct {
ID string `url:"-"`
UserID string `url:"user_id,omitempty"`
Email string `url:"email,omitempty"`
}
// UserAvatar represents an avatar for a User.
type UserAvatar struct {
ImageURL string `json:"image_url,omitempty"`
}
type userListParams struct {
PageParams
SegmentID string `url:"segment_id,omitempty"`
TagID string `url:"tag_id,omitempty"`
}
// FindByID looks up a User by their Intercom ID.
func (u *UserService) FindByID(id string) (User, error) {
return u.findWithIdentifiers(UserIdentifiers{ID: id})
}
// FindByUserID looks up a User by their UserID (customer supplied).
func (u *UserService) FindByUserID(userID string) (User, error) {
return u.findWithIdentifiers(UserIdentifiers{UserID: userID})
}
// FindByEmail looks up a User by their Email.
func (u *UserService) FindByEmail(email string) (User, error) {
return u.findWithIdentifiers(UserIdentifiers{Email: email})
}
func (u *UserService) findWithIdentifiers(identifiers UserIdentifiers) (User, error) {
return u.Repository.find(identifiers)
}
// List all Users for App.
func (u *UserService) List(params PageParams) (UserList, error) {
return u.Repository.list(userListParams{PageParams: params})
}
// List Users by Segment.
func (u *UserService) ListBySegment(segmentID string, params PageParams) (UserList, error) {
return u.Repository.list(userListParams{PageParams: params, SegmentID: segmentID})
}
// List Users By Tag.
func (u *UserService) ListByTag(tagID string, params PageParams) (UserList, error) {
return u.Repository.list(userListParams{PageParams: params, TagID: tagID})
}
// Save a User, creating or updating them.
func (u *UserService) Save(user *User) (User, error) {
return u.Repository.save(user)
}
func (u *UserService) Delete(id string) (User, error) {
return u.Repository.delete(id)
}
func (u User) String() string {
return fmt.Sprintf("[intercom] user { id: %s name: %s, user_id: %s, email: %s }", u.ID, u.Name, u.UserID, u.Email)
}
func (l LocationData) String() string {
return fmt.Sprintf("[intercom] location_data { city_name: %s country_name: %s }", l.CityName, l.CountryName)
}
func (s SocialProfile) String() string {
return fmt.Sprintf("[intercom] social_profile { name: %s id: %s, username: %s }", s.Name, s.ID, s.Username)
}
func (a UserAvatar) String() string {
return fmt.Sprintf("[intercom] user_avatar { image_url: %s }", a.ImageURL)
}