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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Flex
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 datetime import datetime
from typing import Any, Dict, List, Optional, Union
from twilio.base import deserialize, 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 FlexUserInstance(InstanceResource):
"""
:ivar account_sid: The unique SID of the account that created the resource.
:ivar instance_sid: The unique ID created by Twilio to identify a Flex instance.
:ivar user_sid: The unique SID identifier of the Twilio Unified User.
:ivar flex_user_sid: The unique SID identifier of the Flex User.
:ivar worker_sid: The unique SID identifier of the worker.
:ivar workspace_sid: The unique SID identifier of the workspace.
:ivar flex_team_sid: The unique SID identifier of the Flex Team.
:ivar first_name: First name of the User.
:ivar last_name: Last name of the User.
:ivar username: Username of the User.
:ivar email: Email of the User.
:ivar friendly_name: Friendly name of the User.
:ivar locale: The locale preference of the user.
:ivar roles: The roles of the user.
:ivar created_date: The date that this user was created, given in ISO 8601 format.
:ivar updated_date: The date that this user was updated, given in ISO 8601 format.
:ivar version: The current version of the user.
:ivar url:
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
instance_sid: Optional[str] = None,
flex_user_sid: Optional[str] = None,
):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.instance_sid: Optional[str] = payload.get("instance_sid")
self.user_sid: Optional[str] = payload.get("user_sid")
self.flex_user_sid: Optional[str] = payload.get("flex_user_sid")
self.worker_sid: Optional[str] = payload.get("worker_sid")
self.workspace_sid: Optional[str] = payload.get("workspace_sid")
self.flex_team_sid: Optional[str] = payload.get("flex_team_sid")
self.first_name: Optional[str] = payload.get("first_name")
self.last_name: Optional[str] = payload.get("last_name")
self.username: Optional[str] = payload.get("username")
self.email: Optional[str] = payload.get("email")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.locale: Optional[str] = payload.get("locale")
self.roles: Optional[List[str]] = payload.get("roles")
self.created_date: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("created_date")
)
self.updated_date: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("updated_date")
)
self.version: Optional[int] = deserialize.integer(payload.get("version"))
self.url: Optional[str] = payload.get("url")
self._solution = {
"instance_sid": instance_sid or self.instance_sid,
"flex_user_sid": flex_user_sid or self.flex_user_sid,
}
self._context: Optional[FlexUserContext] = None
@property
def _proxy(self) -> "FlexUserContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: FlexUserContext for this FlexUserInstance
"""
if self._context is None:
self._context = FlexUserContext(
self._version,
instance_sid=self._solution["instance_sid"],
flex_user_sid=self._solution["flex_user_sid"],
)
return self._context
def fetch(self) -> "FlexUserInstance":
"""
Fetch the FlexUserInstance
:returns: The fetched FlexUserInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "FlexUserInstance":
"""
Asynchronous coroutine to fetch the FlexUserInstance
:returns: The fetched FlexUserInstance
"""
return await self._proxy.fetch_async()
def update(
self,
first_name: Union[str, object] = values.unset,
last_name: Union[str, object] = values.unset,
email: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
user_sid: Union[str, object] = values.unset,
locale: Union[str, object] = values.unset,
) -> "FlexUserInstance":
"""
Update the FlexUserInstance
:param first_name: First name of the User.
:param last_name: Last name of the User.
:param email: Email of the User.
:param friendly_name: Friendly name of the User.
:param user_sid: The unique SID identifier of the Twilio Unified User.
:param locale: The locale preference of the user.
:returns: The updated FlexUserInstance
"""
return self._proxy.update(
first_name=first_name,
last_name=last_name,
email=email,
friendly_name=friendly_name,
user_sid=user_sid,
locale=locale,
)
async def update_async(
self,
first_name: Union[str, object] = values.unset,
last_name: Union[str, object] = values.unset,
email: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
user_sid: Union[str, object] = values.unset,
locale: Union[str, object] = values.unset,
) -> "FlexUserInstance":
"""
Asynchronous coroutine to update the FlexUserInstance
:param first_name: First name of the User.
:param last_name: Last name of the User.
:param email: Email of the User.
:param friendly_name: Friendly name of the User.
:param user_sid: The unique SID identifier of the Twilio Unified User.
:param locale: The locale preference of the user.
:returns: The updated FlexUserInstance
"""
return await self._proxy.update_async(
first_name=first_name,
last_name=last_name,
email=email,
friendly_name=friendly_name,
user_sid=user_sid,
locale=locale,
)
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.FlexApi.V2.FlexUserInstance {}>".format(context)
class FlexUserContext(InstanceContext):
def __init__(self, version: Version, instance_sid: str, flex_user_sid: str):
"""
Initialize the FlexUserContext
:param version: Version that contains the resource
:param instance_sid: The unique ID created by Twilio to identify a Flex instance.
:param flex_user_sid: The unique id for the flex user.
"""
super().__init__(version)
# Path Solution
self._solution = {
"instance_sid": instance_sid,
"flex_user_sid": flex_user_sid,
}
self._uri = "/Instances/{instance_sid}/Users/{flex_user_sid}".format(
**self._solution
)
def fetch(self) -> FlexUserInstance:
"""
Fetch the FlexUserInstance
:returns: The fetched FlexUserInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return FlexUserInstance(
self._version,
payload,
instance_sid=self._solution["instance_sid"],
flex_user_sid=self._solution["flex_user_sid"],
)
async def fetch_async(self) -> FlexUserInstance:
"""
Asynchronous coroutine to fetch the FlexUserInstance
:returns: The fetched FlexUserInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return FlexUserInstance(
self._version,
payload,
instance_sid=self._solution["instance_sid"],
flex_user_sid=self._solution["flex_user_sid"],
)
def update(
self,
first_name: Union[str, object] = values.unset,
last_name: Union[str, object] = values.unset,
email: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
user_sid: Union[str, object] = values.unset,
locale: Union[str, object] = values.unset,
) -> FlexUserInstance:
"""
Update the FlexUserInstance
:param first_name: First name of the User.
:param last_name: Last name of the User.
:param email: Email of the User.
:param friendly_name: Friendly name of the User.
:param user_sid: The unique SID identifier of the Twilio Unified User.
:param locale: The locale preference of the user.
:returns: The updated FlexUserInstance
"""
data = values.of(
{
"FirstName": first_name,
"LastName": last_name,
"Email": email,
"FriendlyName": friendly_name,
"UserSid": user_sid,
"Locale": locale,
}
)
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 FlexUserInstance(
self._version,
payload,
instance_sid=self._solution["instance_sid"],
flex_user_sid=self._solution["flex_user_sid"],
)
async def update_async(
self,
first_name: Union[str, object] = values.unset,
last_name: Union[str, object] = values.unset,
email: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
user_sid: Union[str, object] = values.unset,
locale: Union[str, object] = values.unset,
) -> FlexUserInstance:
"""
Asynchronous coroutine to update the FlexUserInstance
:param first_name: First name of the User.
:param last_name: Last name of the User.
:param email: Email of the User.
:param friendly_name: Friendly name of the User.
:param user_sid: The unique SID identifier of the Twilio Unified User.
:param locale: The locale preference of the user.
:returns: The updated FlexUserInstance
"""
data = values.of(
{
"FirstName": first_name,
"LastName": last_name,
"Email": email,
"FriendlyName": friendly_name,
"UserSid": user_sid,
"Locale": locale,
}
)
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 FlexUserInstance(
self._version,
payload,
instance_sid=self._solution["instance_sid"],
flex_user_sid=self._solution["flex_user_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.FlexApi.V2.FlexUserContext {}>".format(context)
class FlexUserList(ListResource):
def __init__(self, version: Version):
"""
Initialize the FlexUserList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, instance_sid: str, flex_user_sid: str) -> FlexUserContext:
"""
Constructs a FlexUserContext
:param instance_sid: The unique ID created by Twilio to identify a Flex instance.
:param flex_user_sid: The unique id for the flex user.
"""
return FlexUserContext(
self._version, instance_sid=instance_sid, flex_user_sid=flex_user_sid
)
def __call__(self, instance_sid: str, flex_user_sid: str) -> FlexUserContext:
"""
Constructs a FlexUserContext
:param instance_sid: The unique ID created by Twilio to identify a Flex instance.
:param flex_user_sid: The unique id for the flex user.
"""
return FlexUserContext(
self._version, instance_sid=instance_sid, flex_user_sid=flex_user_sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FlexApi.V2.FlexUserList>"
|
