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
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
class UserList(ListResource):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
def __init__(self, version):
"""
Initialize the UserList
:param Version version: Version that contains the resource
:returns: twilio.rest.frontline_api.v1.user.UserList
:rtype: twilio.rest.frontline_api.v1.user.UserList
"""
super(UserList, self).__init__(version)
# Path Solution
self._solution = {}
def get(self, sid):
"""
Constructs a UserContext
:param sid: The SID of the User resource to fetch
:returns: twilio.rest.frontline_api.v1.user.UserContext
:rtype: twilio.rest.frontline_api.v1.user.UserContext
"""
return UserContext(self._version, sid=sid, )
def __call__(self, sid):
"""
Constructs a UserContext
:param sid: The SID of the User resource to fetch
:returns: twilio.rest.frontline_api.v1.user.UserContext
:rtype: twilio.rest.frontline_api.v1.user.UserContext
"""
return UserContext(self._version, sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.FrontlineApi.V1.UserList>'
class UserPage(Page):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
def __init__(self, version, response, solution):
"""
Initialize the UserPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.frontline_api.v1.user.UserPage
:rtype: twilio.rest.frontline_api.v1.user.UserPage
"""
super(UserPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of UserInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.frontline_api.v1.user.UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserInstance
"""
return UserInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.FrontlineApi.V1.UserPage>'
class UserContext(InstanceContext):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
def __init__(self, version, sid):
"""
Initialize the UserContext
:param Version version: Version that contains the resource
:param sid: The SID of the User resource to fetch
:returns: twilio.rest.frontline_api.v1.user.UserContext
:rtype: twilio.rest.frontline_api.v1.user.UserContext
"""
super(UserContext, self).__init__(version)
# Path Solution
self._solution = {'sid': sid, }
self._uri = '/Users/{sid}'.format(**self._solution)
def fetch(self):
"""
Fetch the UserInstance
:returns: The fetched UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return UserInstance(self._version, payload, sid=self._solution['sid'], )
def update(self, friendly_name=values.unset, avatar=values.unset,
state=values.unset, is_available=values.unset):
"""
Update the UserInstance
:param unicode friendly_name: The string that you assigned to describe the User
:param unicode avatar: The avatar URL which will be shown in Frontline application
:param UserInstance.StateType state: Current state of this user
:param bool is_available: Whether the User is available for new conversations
:returns: The updated UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserInstance
"""
data = values.of({
'FriendlyName': friendly_name,
'Avatar': avatar,
'State': state,
'IsAvailable': is_available,
})
payload = self._version.update(method='POST', uri=self._uri, data=data, )
return UserInstance(self._version, payload, sid=self._solution['sid'], )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.FrontlineApi.V1.UserContext {}>'.format(context)
class UserInstance(InstanceResource):
""" PLEASE NOTE that this class contains beta products that are subject to
change. Use them with caution. """
class StateType(object):
ACTIVE = "active"
DEACTIVATED = "deactivated"
def __init__(self, version, payload, sid=None):
"""
Initialize the UserInstance
:returns: twilio.rest.frontline_api.v1.user.UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserInstance
"""
super(UserInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'identity': payload.get('identity'),
'friendly_name': payload.get('friendly_name'),
'avatar': payload.get('avatar'),
'state': payload.get('state'),
'is_available': payload.get('is_available'),
'url': payload.get('url'),
}
# Context
self._context = None
self._solution = {'sid': sid or self._properties['sid'], }
@property
def _proxy(self):
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: UserContext for this UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserContext
"""
if self._context is None:
self._context = UserContext(self._version, sid=self._solution['sid'], )
return self._context
@property
def sid(self):
"""
:returns: The unique string that identifies the resource
:rtype: unicode
"""
return self._properties['sid']
@property
def identity(self):
"""
:returns: The string that identifies the resource's User
:rtype: unicode
"""
return self._properties['identity']
@property
def friendly_name(self):
"""
:returns: The string that you assigned to describe the User
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def avatar(self):
"""
:returns: The avatar URL which will be shown in Frontline application
:rtype: unicode
"""
return self._properties['avatar']
@property
def state(self):
"""
:returns: Current state of this user
:rtype: UserInstance.StateType
"""
return self._properties['state']
@property
def is_available(self):
"""
:returns: Whether the User is available for new conversations
:rtype: bool
"""
return self._properties['is_available']
@property
def url(self):
"""
:returns: An absolute URL for this user.
:rtype: unicode
"""
return self._properties['url']
def fetch(self):
"""
Fetch the UserInstance
:returns: The fetched UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserInstance
"""
return self._proxy.fetch()
def update(self, friendly_name=values.unset, avatar=values.unset,
state=values.unset, is_available=values.unset):
"""
Update the UserInstance
:param unicode friendly_name: The string that you assigned to describe the User
:param unicode avatar: The avatar URL which will be shown in Frontline application
:param UserInstance.StateType state: Current state of this user
:param bool is_available: Whether the User is available for new conversations
:returns: The updated UserInstance
:rtype: twilio.rest.frontline_api.v1.user.UserInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
avatar=avatar,
state=state,
is_available=is_available,
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.FrontlineApi.V1.UserInstance {}>'.format(context)
|
