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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Conversations
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 NotificationInstance(InstanceResource):
"""
:ivar account_sid: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration.
:ivar chat_service_sid: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
:ivar new_message: The Push Notification configuration for New Messages.
:ivar added_to_conversation: The Push Notification configuration for being added to a Conversation.
:ivar removed_from_conversation: The Push Notification configuration for being removed from a Conversation.
:ivar log_enabled: Weather the notification logging is enabled.
:ivar url: An absolute API resource URL for this configuration.
"""
def __init__(
self, version: Version, payload: Dict[str, Any], chat_service_sid: str
):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.chat_service_sid: Optional[str] = payload.get("chat_service_sid")
self.new_message: Optional[Dict[str, object]] = payload.get("new_message")
self.added_to_conversation: Optional[Dict[str, object]] = payload.get(
"added_to_conversation"
)
self.removed_from_conversation: Optional[Dict[str, object]] = payload.get(
"removed_from_conversation"
)
self.log_enabled: Optional[bool] = payload.get("log_enabled")
self.url: Optional[str] = payload.get("url")
self._solution = {
"chat_service_sid": chat_service_sid,
}
self._context: Optional[NotificationContext] = None
@property
def _proxy(self) -> "NotificationContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: NotificationContext for this NotificationInstance
"""
if self._context is None:
self._context = NotificationContext(
self._version,
chat_service_sid=self._solution["chat_service_sid"],
)
return self._context
def fetch(self) -> "NotificationInstance":
"""
Fetch the NotificationInstance
:returns: The fetched NotificationInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "NotificationInstance":
"""
Asynchronous coroutine to fetch the NotificationInstance
:returns: The fetched NotificationInstance
"""
return await self._proxy.fetch_async()
def update(
self,
log_enabled: Union[bool, object] = values.unset,
new_message_enabled: Union[bool, object] = values.unset,
new_message_template: Union[str, object] = values.unset,
new_message_sound: Union[str, object] = values.unset,
new_message_badge_count_enabled: Union[bool, object] = values.unset,
added_to_conversation_enabled: Union[bool, object] = values.unset,
added_to_conversation_template: Union[str, object] = values.unset,
added_to_conversation_sound: Union[str, object] = values.unset,
removed_from_conversation_enabled: Union[bool, object] = values.unset,
removed_from_conversation_template: Union[str, object] = values.unset,
removed_from_conversation_sound: Union[str, object] = values.unset,
new_message_with_media_enabled: Union[bool, object] = values.unset,
new_message_with_media_template: Union[str, object] = values.unset,
) -> "NotificationInstance":
"""
Update the NotificationInstance
:param log_enabled: Weather the notification logging is enabled.
:param new_message_enabled: Whether to send a notification when a new message is added to a conversation. The default is `false`.
:param new_message_template: The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_sound: The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_badge_count_enabled: Whether the new message badge is enabled. The default is `false`.
:param added_to_conversation_enabled: Whether to send a notification when a participant is added to a conversation. The default is `false`.
:param added_to_conversation_template: The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param added_to_conversation_sound: The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param removed_from_conversation_enabled: Whether to send a notification to a user when they are removed from a conversation. The default is `false`.
:param removed_from_conversation_template: The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param removed_from_conversation_sound: The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param new_message_with_media_enabled: Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`.
:param new_message_with_media_template: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`.
:returns: The updated NotificationInstance
"""
return self._proxy.update(
log_enabled=log_enabled,
new_message_enabled=new_message_enabled,
new_message_template=new_message_template,
new_message_sound=new_message_sound,
new_message_badge_count_enabled=new_message_badge_count_enabled,
added_to_conversation_enabled=added_to_conversation_enabled,
added_to_conversation_template=added_to_conversation_template,
added_to_conversation_sound=added_to_conversation_sound,
removed_from_conversation_enabled=removed_from_conversation_enabled,
removed_from_conversation_template=removed_from_conversation_template,
removed_from_conversation_sound=removed_from_conversation_sound,
new_message_with_media_enabled=new_message_with_media_enabled,
new_message_with_media_template=new_message_with_media_template,
)
async def update_async(
self,
log_enabled: Union[bool, object] = values.unset,
new_message_enabled: Union[bool, object] = values.unset,
new_message_template: Union[str, object] = values.unset,
new_message_sound: Union[str, object] = values.unset,
new_message_badge_count_enabled: Union[bool, object] = values.unset,
added_to_conversation_enabled: Union[bool, object] = values.unset,
added_to_conversation_template: Union[str, object] = values.unset,
added_to_conversation_sound: Union[str, object] = values.unset,
removed_from_conversation_enabled: Union[bool, object] = values.unset,
removed_from_conversation_template: Union[str, object] = values.unset,
removed_from_conversation_sound: Union[str, object] = values.unset,
new_message_with_media_enabled: Union[bool, object] = values.unset,
new_message_with_media_template: Union[str, object] = values.unset,
) -> "NotificationInstance":
"""
Asynchronous coroutine to update the NotificationInstance
:param log_enabled: Weather the notification logging is enabled.
:param new_message_enabled: Whether to send a notification when a new message is added to a conversation. The default is `false`.
:param new_message_template: The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_sound: The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_badge_count_enabled: Whether the new message badge is enabled. The default is `false`.
:param added_to_conversation_enabled: Whether to send a notification when a participant is added to a conversation. The default is `false`.
:param added_to_conversation_template: The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param added_to_conversation_sound: The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param removed_from_conversation_enabled: Whether to send a notification to a user when they are removed from a conversation. The default is `false`.
:param removed_from_conversation_template: The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param removed_from_conversation_sound: The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param new_message_with_media_enabled: Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`.
:param new_message_with_media_template: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`.
:returns: The updated NotificationInstance
"""
return await self._proxy.update_async(
log_enabled=log_enabled,
new_message_enabled=new_message_enabled,
new_message_template=new_message_template,
new_message_sound=new_message_sound,
new_message_badge_count_enabled=new_message_badge_count_enabled,
added_to_conversation_enabled=added_to_conversation_enabled,
added_to_conversation_template=added_to_conversation_template,
added_to_conversation_sound=added_to_conversation_sound,
removed_from_conversation_enabled=removed_from_conversation_enabled,
removed_from_conversation_template=removed_from_conversation_template,
removed_from_conversation_sound=removed_from_conversation_sound,
new_message_with_media_enabled=new_message_with_media_enabled,
new_message_with_media_template=new_message_with_media_template,
)
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.Conversations.V1.NotificationInstance {}>".format(context)
class NotificationContext(InstanceContext):
def __init__(self, version: Version, chat_service_sid: str):
"""
Initialize the NotificationContext
:param version: Version that contains the resource
:param chat_service_sid: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
"""
super().__init__(version)
# Path Solution
self._solution = {
"chat_service_sid": chat_service_sid,
}
self._uri = "/Services/{chat_service_sid}/Configuration/Notifications".format(
**self._solution
)
def fetch(self) -> NotificationInstance:
"""
Fetch the NotificationInstance
:returns: The fetched NotificationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return NotificationInstance(
self._version,
payload,
chat_service_sid=self._solution["chat_service_sid"],
)
async def fetch_async(self) -> NotificationInstance:
"""
Asynchronous coroutine to fetch the NotificationInstance
:returns: The fetched NotificationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return NotificationInstance(
self._version,
payload,
chat_service_sid=self._solution["chat_service_sid"],
)
def update(
self,
log_enabled: Union[bool, object] = values.unset,
new_message_enabled: Union[bool, object] = values.unset,
new_message_template: Union[str, object] = values.unset,
new_message_sound: Union[str, object] = values.unset,
new_message_badge_count_enabled: Union[bool, object] = values.unset,
added_to_conversation_enabled: Union[bool, object] = values.unset,
added_to_conversation_template: Union[str, object] = values.unset,
added_to_conversation_sound: Union[str, object] = values.unset,
removed_from_conversation_enabled: Union[bool, object] = values.unset,
removed_from_conversation_template: Union[str, object] = values.unset,
removed_from_conversation_sound: Union[str, object] = values.unset,
new_message_with_media_enabled: Union[bool, object] = values.unset,
new_message_with_media_template: Union[str, object] = values.unset,
) -> NotificationInstance:
"""
Update the NotificationInstance
:param log_enabled: Weather the notification logging is enabled.
:param new_message_enabled: Whether to send a notification when a new message is added to a conversation. The default is `false`.
:param new_message_template: The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_sound: The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_badge_count_enabled: Whether the new message badge is enabled. The default is `false`.
:param added_to_conversation_enabled: Whether to send a notification when a participant is added to a conversation. The default is `false`.
:param added_to_conversation_template: The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param added_to_conversation_sound: The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param removed_from_conversation_enabled: Whether to send a notification to a user when they are removed from a conversation. The default is `false`.
:param removed_from_conversation_template: The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param removed_from_conversation_sound: The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param new_message_with_media_enabled: Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`.
:param new_message_with_media_template: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`.
:returns: The updated NotificationInstance
"""
data = values.of(
{
"LogEnabled": serialize.boolean_to_string(log_enabled),
"NewMessage.Enabled": serialize.boolean_to_string(new_message_enabled),
"NewMessage.Template": new_message_template,
"NewMessage.Sound": new_message_sound,
"NewMessage.BadgeCountEnabled": serialize.boolean_to_string(
new_message_badge_count_enabled
),
"AddedToConversation.Enabled": serialize.boolean_to_string(
added_to_conversation_enabled
),
"AddedToConversation.Template": added_to_conversation_template,
"AddedToConversation.Sound": added_to_conversation_sound,
"RemovedFromConversation.Enabled": serialize.boolean_to_string(
removed_from_conversation_enabled
),
"RemovedFromConversation.Template": removed_from_conversation_template,
"RemovedFromConversation.Sound": removed_from_conversation_sound,
"NewMessage.WithMedia.Enabled": serialize.boolean_to_string(
new_message_with_media_enabled
),
"NewMessage.WithMedia.Template": new_message_with_media_template,
}
)
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 NotificationInstance(
self._version, payload, chat_service_sid=self._solution["chat_service_sid"]
)
async def update_async(
self,
log_enabled: Union[bool, object] = values.unset,
new_message_enabled: Union[bool, object] = values.unset,
new_message_template: Union[str, object] = values.unset,
new_message_sound: Union[str, object] = values.unset,
new_message_badge_count_enabled: Union[bool, object] = values.unset,
added_to_conversation_enabled: Union[bool, object] = values.unset,
added_to_conversation_template: Union[str, object] = values.unset,
added_to_conversation_sound: Union[str, object] = values.unset,
removed_from_conversation_enabled: Union[bool, object] = values.unset,
removed_from_conversation_template: Union[str, object] = values.unset,
removed_from_conversation_sound: Union[str, object] = values.unset,
new_message_with_media_enabled: Union[bool, object] = values.unset,
new_message_with_media_template: Union[str, object] = values.unset,
) -> NotificationInstance:
"""
Asynchronous coroutine to update the NotificationInstance
:param log_enabled: Weather the notification logging is enabled.
:param new_message_enabled: Whether to send a notification when a new message is added to a conversation. The default is `false`.
:param new_message_template: The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_sound: The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.
:param new_message_badge_count_enabled: Whether the new message badge is enabled. The default is `false`.
:param added_to_conversation_enabled: Whether to send a notification when a participant is added to a conversation. The default is `false`.
:param added_to_conversation_template: The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param added_to_conversation_sound: The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.
:param removed_from_conversation_enabled: Whether to send a notification to a user when they are removed from a conversation. The default is `false`.
:param removed_from_conversation_template: The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param removed_from_conversation_sound: The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.
:param new_message_with_media_enabled: Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`.
:param new_message_with_media_template: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`.
:returns: The updated NotificationInstance
"""
data = values.of(
{
"LogEnabled": serialize.boolean_to_string(log_enabled),
"NewMessage.Enabled": serialize.boolean_to_string(new_message_enabled),
"NewMessage.Template": new_message_template,
"NewMessage.Sound": new_message_sound,
"NewMessage.BadgeCountEnabled": serialize.boolean_to_string(
new_message_badge_count_enabled
),
"AddedToConversation.Enabled": serialize.boolean_to_string(
added_to_conversation_enabled
),
"AddedToConversation.Template": added_to_conversation_template,
"AddedToConversation.Sound": added_to_conversation_sound,
"RemovedFromConversation.Enabled": serialize.boolean_to_string(
removed_from_conversation_enabled
),
"RemovedFromConversation.Template": removed_from_conversation_template,
"RemovedFromConversation.Sound": removed_from_conversation_sound,
"NewMessage.WithMedia.Enabled": serialize.boolean_to_string(
new_message_with_media_enabled
),
"NewMessage.WithMedia.Template": new_message_with_media_template,
}
)
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 NotificationInstance(
self._version, payload, chat_service_sid=self._solution["chat_service_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.Conversations.V1.NotificationContext {}>".format(context)
class NotificationList(ListResource):
def __init__(self, version: Version, chat_service_sid: str):
"""
Initialize the NotificationList
:param version: Version that contains the resource
:param chat_service_sid: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
"""
super().__init__(version)
# Path Solution
self._solution = {
"chat_service_sid": chat_service_sid,
}
def get(self) -> NotificationContext:
"""
Constructs a NotificationContext
"""
return NotificationContext(
self._version, chat_service_sid=self._solution["chat_service_sid"]
)
def __call__(self) -> NotificationContext:
"""
Constructs a NotificationContext
"""
return NotificationContext(
self._version, chat_service_sid=self._solution["chat_service_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Conversations.V1.NotificationList>"
|
