Repository navigation
Expand file tree
/
Copy pathmessage_thread.py
More file actions
221 lines (179 loc) · 6.27 KB
/
Copy pathmessage_thread.py
File metadata and controls
221 lines (179 loc) · 6.27 KB
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
# coding=utf-8
#
# Copyright 2012 keyes.ie
#
# License: http://jkeyes.mit-license.org/
#
""" message_thread module.
>>> from intercom import Intercom
>>> Intercom.app_id = 'dummy-app-id'
>>> Intercom.api_key = 'dummy-api-key'
>>> from intercom import MessageThread
"""
from . import Intercom
from . import from_timestamp_property
class MessageThread(dict):
""" An Intercom conversation between an admin and a User. """
@classmethod
def find(cls, user_id=None, email=None, thread_id=None):
""" Finds a particular conversation for a particular user.
>>> message_thread = MessageThread.find(email="somebody@example.com")
Traceback (most recent call last):
...
ValueError: No thread_id specified
>>> message_thread = MessageThread.find(email="somebody@example.com",
... thread_id=5591)
>>> len(message_thread.messages)
3
>>> message = message_thread.messages[0]
>>> type(message)
<class 'intercom.message_thread.Message'>
"""
if thread_id is None:
raise ValueError("No thread_id specified")
resp = Intercom.get_message_threads(
user_id=user_id, email=email, thread_id=thread_id)
return MessageThread(resp)
@classmethod
def find_all(cls, user_id=None, email=None):
""" Finds all Messages for a particular user.
>>> message_threads = MessageThread.find_all(
... email="somebody@example.com")
>>> len(message_threads)
1
"""
resp = Intercom.get_message_threads(user_id=user_id, email=email)
return [MessageThread(mt) for mt in resp]
@classmethod
def create(cls, user_id=None, email=None, body=None):
""" Creates a new converstion.
>>> email = "somebody@example.com"
>>> body = "Hi everybody, I'm Doctor Nick"
>>> message_thread = MessageThread.create(email=email, body=body)
>>> message_thread.thread_id
5591
>>> len(message_thread.messages)
1
"""
resp = Intercom.create_message_thread(
user_id=user_id, email=email, body=body)
return MessageThread(resp)
@classmethod
def reply(
cls, user_id=None, email=None, thread_id=None, body=None,
read=None):
""" Reply to an existing conversation.
>>> email = "somebody@example.com"
>>> thread_id = 5591
>>> body = "Are you talking to me?"
>>> message_thread = MessageThread.reply(email=email,
... thread_id=thread_id, body=body)
>>> len(message_thread.messages)
2
>>> message_thread.messages[0].html
u'<p>Hey Intercom, What is up?</p>\n\n<p></p>'
>>> message_thread.messages[1].html
u'<p>Are you talking to me?</p>'
"""
resp = Intercom.reply_message_thread(
user_id=user_id, email=email, thread_id=thread_id,
read=read, body=body)
return MessageThread(resp)
@property
@from_timestamp_property
def updated_at(self):
""" Returns a datetime of when the last update occurred. """
return dict.get(self, 'updated_at', None)
@property
@from_timestamp_property
def created_at(self):
""" Sets a timestamp of when the last update occurred. """
return dict.get(self, 'created_at', None)
def set_body(self, value):
""" Set the body of a reply. """
self['body'] = value
body = property(None, set_body, None)
@property
def thread_id(self):
""" Returns the thread_id of this MessageThread. """
return dict.get(self, 'thread_id', None)
@thread_id.setter
def thread_id(self, value):
""" Sets the thread_id of this MessageThread. """
self['thread_id'] = value
@property
def read(self):
""" Returns whether this thread has been read or not. """
return dict.get(self, 'read', None)
@read.setter
def read(self, value):
""" Sets whether this thread has been read or not. """
self['read'] = value
@property
def messages(self):
""" Returns a list of Messages in this MessageThread. """
messages = dict.get(self, 'messages', None)
if messages:
return [Message(m) for m in messages]
class Message(dict):
""" Object representing a Message in a MessageThread.
>>> message_thread = MessageThread.find(email="somebody@example.com",
... thread_id=5591)
>>> message = message_thread.messages[0]
>>> type(message.author)
<class 'intercom.message_thread.MessageAuthor'>
>>> message.html
u'<p>Hey Intercom, What is up?</p>\n\n<p></p>'
>>> type(message.created_at)
<type 'datetime.datetime'>
"""
@property
def author(self):
""" Returns who authored the message. """
_from = self.get('from', None)
if _from:
return MessageAuthor(_from)
@property
def html(self):
""" Returns the HTML body of the Message. """
return dict.get(self, 'html', None)
@property
@from_timestamp_property
def created_at(self):
""" Returns a datetime for when this Message was created. """
return dict.get(self, 'created_at', None)
class MessageAuthor(dict):
""" Object represting the author of a Message.
>>> message_thread = MessageThread.find(email="somebody@example.com",
... thread_id=5591)
>>> author = message_thread.messages[0].author
>>> author.admin
False
>>> author.email
u'bob@example.com'
>>> author.user_id
u'456'
>>> author.avatar_path_50
>>> author.name
u'Bob'
"""
@property
def admin(self):
""" Returns whether the author is an admin. """
return dict.get(self, 'is_admin', None)
@property
def email(self):
""" Returns the email address of the author. """
return dict.get(self, 'email', None)
@property
def user_id(self):
""" Returns the user_id of the author. """
return dict.get(self, 'user_id', None)
@property
def avatar_path_50(self):
""" Returns a URL to a 50x50 avatar of the author. """
return dict.get(self, 'avatar_path_50', None)
@property
def name(self):
""" Returns the author's name. """
return dict.get(self, 'name', None)