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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Frontline
This is the public Twilio REST API.
NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.
"""
from typing import Any, Dict, Optional, Union
from twilio.base import serialize, 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.version import Version
class UserInstance(InstanceResource):
class StateType(object):
ACTIVE = "active"
DEACTIVATED = "deactivated"
"""
:ivar sid: The unique string that we created to identify the User resource.
:ivar identity: The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive.
:ivar friendly_name: The string that you assigned to describe the User.
:ivar avatar: The avatar URL which will be shown in Frontline application.
:ivar state:
:ivar is_available: Whether the User is available for new conversations. Defaults to `false` for new users.
:ivar url: An absolute API resource URL for this user.
"""
def __init__(
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.identity: Optional[str] = payload.get("identity")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.avatar: Optional[str] = payload.get("avatar")
self.state: Optional["UserInstance.StateType"] = payload.get("state")
self.is_available: Optional[bool] = payload.get("is_available")
self.url: Optional[str] = payload.get("url")
self._solution = {
"sid": sid or self.sid,
}
self._context: Optional[UserContext] = None
@property
def _proxy(self) -> "UserContext":
"""
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
"""
if self._context is None:
self._context = UserContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def fetch(self) -> "UserInstance":
"""
Fetch the UserInstance
:returns: The fetched UserInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "UserInstance":
"""
Asynchronous coroutine to fetch the UserInstance
:returns: The fetched UserInstance
"""
return await self._proxy.fetch_async()
def update(
self,
friendly_name: Union[str, object] = values.unset,
avatar: Union[str, object] = values.unset,
state: Union["UserInstance.StateType", object] = values.unset,
is_available: Union[bool, object] = values.unset,
) -> "UserInstance":
"""
Update the UserInstance
:param friendly_name: The string that you assigned to describe the User.
:param avatar: The avatar URL which will be shown in Frontline application.
:param state:
:param is_available: Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
:returns: The updated UserInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
avatar=avatar,
state=state,
is_available=is_available,
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
avatar: Union[str, object] = values.unset,
state: Union["UserInstance.StateType", object] = values.unset,
is_available: Union[bool, object] = values.unset,
) -> "UserInstance":
"""
Asynchronous coroutine to update the UserInstance
:param friendly_name: The string that you assigned to describe the User.
:param avatar: The avatar URL which will be shown in Frontline application.
:param state:
:param is_available: Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
:returns: The updated UserInstance
"""
return await self._proxy.update_async(
friendly_name=friendly_name,
avatar=avatar,
state=state,
is_available=is_available,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.FrontlineApi.V1.UserInstance {}>".format(context)
class UserContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the UserContext
:param version: Version that contains the resource
:param sid: The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/Users/{sid}".format(**self._solution)
def fetch(self) -> UserInstance:
"""
Fetch the UserInstance
:returns: The fetched UserInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return UserInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(self) -> UserInstance:
"""
Asynchronous coroutine to fetch the UserInstance
:returns: The fetched UserInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return UserInstance(
self._version,
payload,
sid=self._solution["sid"],
)
def update(
self,
friendly_name: Union[str, object] = values.unset,
avatar: Union[str, object] = values.unset,
state: Union["UserInstance.StateType", object] = values.unset,
is_available: Union[bool, object] = values.unset,
) -> UserInstance:
"""
Update the UserInstance
:param friendly_name: The string that you assigned to describe the User.
:param avatar: The avatar URL which will be shown in Frontline application.
:param state:
:param is_available: Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
:returns: The updated UserInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Avatar": avatar,
"State": state,
"IsAvailable": serialize.boolean_to_string(is_available),
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return UserInstance(self._version, payload, sid=self._solution["sid"])
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
avatar: Union[str, object] = values.unset,
state: Union["UserInstance.StateType", object] = values.unset,
is_available: Union[bool, object] = values.unset,
) -> UserInstance:
"""
Asynchronous coroutine to update the UserInstance
:param friendly_name: The string that you assigned to describe the User.
:param avatar: The avatar URL which will be shown in Frontline application.
:param state:
:param is_available: Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
:returns: The updated UserInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Avatar": avatar,
"State": state,
"IsAvailable": serialize.boolean_to_string(is_available),
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return UserInstance(self._version, payload, sid=self._solution["sid"])
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.FrontlineApi.V1.UserContext {}>".format(context)
class UserList(ListResource):
def __init__(self, version: Version):
"""
Initialize the UserList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, sid: str) -> UserContext:
"""
Constructs a UserContext
:param sid: The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
"""
return UserContext(self._version, sid=sid)
def __call__(self, sid: str) -> UserContext:
"""
Constructs a UserContext
:param sid: The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
"""
return UserContext(self._version, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FrontlineApi.V1.UserList>"
|
