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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Chat
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, 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 ChannelInstance(InstanceResource):
class ChannelType(object):
PUBLIC = "public"
PRIVATE = "private"
class WebhookEnabledType(object):
TRUE = "true"
FALSE = "false"
"""
:ivar sid: The unique string that we created to identify the Channel resource.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource.
:ivar service_sid: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel resource is associated with.
:ivar friendly_name: The string that you assigned to describe the resource.
:ivar unique_name: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
:ivar attributes: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
:ivar type:
:ivar date_created: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar date_updated: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar created_by: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.
:ivar members_count: The number of Members in the Channel.
:ivar messages_count: The number of Messages that have been passed in the Channel.
:ivar messaging_service_sid: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
:ivar url: The absolute URL of the Channel resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
service_sid: Optional[str] = None,
sid: Optional[str] = None,
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.service_sid: Optional[str] = payload.get("service_sid")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.unique_name: Optional[str] = payload.get("unique_name")
self.attributes: Optional[str] = payload.get("attributes")
self.type: Optional["ChannelInstance.ChannelType"] = payload.get("type")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_updated")
)
self.created_by: Optional[str] = payload.get("created_by")
self.members_count: Optional[int] = deserialize.integer(
payload.get("members_count")
)
self.messages_count: Optional[int] = deserialize.integer(
payload.get("messages_count")
)
self.messaging_service_sid: Optional[str] = payload.get("messaging_service_sid")
self.url: Optional[str] = payload.get("url")
self._solution = {
"service_sid": service_sid or self.service_sid,
"sid": sid or self.sid,
}
self._context: Optional[ChannelContext] = None
@property
def _proxy(self) -> "ChannelContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: ChannelContext for this ChannelInstance
"""
if self._context is None:
self._context = ChannelContext(
self._version,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
return self._context
def update(
self,
x_twilio_webhook_enabled: Union[
"ChannelInstance.WebhookEnabledType", object
] = values.unset,
type: Union["ChannelInstance.ChannelType", object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
) -> "ChannelInstance":
"""
Update the ChannelInstance
:param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:param type:
:param messaging_service_sid: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
:returns: The updated ChannelInstance
"""
return self._proxy.update(
x_twilio_webhook_enabled=x_twilio_webhook_enabled,
type=type,
messaging_service_sid=messaging_service_sid,
)
async def update_async(
self,
x_twilio_webhook_enabled: Union[
"ChannelInstance.WebhookEnabledType", object
] = values.unset,
type: Union["ChannelInstance.ChannelType", object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
) -> "ChannelInstance":
"""
Asynchronous coroutine to update the ChannelInstance
:param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:param type:
:param messaging_service_sid: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
:returns: The updated ChannelInstance
"""
return await self._proxy.update_async(
x_twilio_webhook_enabled=x_twilio_webhook_enabled,
type=type,
messaging_service_sid=messaging_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.Chat.V3.ChannelInstance {}>".format(context)
class ChannelContext(InstanceContext):
def __init__(self, version: Version, service_sid: str, sid: str):
"""
Initialize the ChannelContext
:param version: Version that contains the resource
:param service_sid: The unique SID identifier of the Service.
:param sid: A 34 character string that uniquely identifies this Channel.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"sid": sid,
}
self._uri = "/Services/{service_sid}/Channels/{sid}".format(**self._solution)
def update(
self,
x_twilio_webhook_enabled: Union[
"ChannelInstance.WebhookEnabledType", object
] = values.unset,
type: Union["ChannelInstance.ChannelType", object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
) -> ChannelInstance:
"""
Update the ChannelInstance
:param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:param type:
:param messaging_service_sid: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
:returns: The updated ChannelInstance
"""
data = values.of(
{
"Type": type,
"MessagingServiceSid": messaging_service_sid,
}
)
headers = values.of({})
if not (
x_twilio_webhook_enabled is values.unset
or (
isinstance(x_twilio_webhook_enabled, str)
and not x_twilio_webhook_enabled
)
):
headers["X-Twilio-Webhook-Enabled"] = x_twilio_webhook_enabled
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 ChannelInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
async def update_async(
self,
x_twilio_webhook_enabled: Union[
"ChannelInstance.WebhookEnabledType", object
] = values.unset,
type: Union["ChannelInstance.ChannelType", object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
) -> ChannelInstance:
"""
Asynchronous coroutine to update the ChannelInstance
:param x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:param type:
:param messaging_service_sid: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
:returns: The updated ChannelInstance
"""
data = values.of(
{
"Type": type,
"MessagingServiceSid": messaging_service_sid,
}
)
headers = values.of({})
if not (
x_twilio_webhook_enabled is values.unset
or (
isinstance(x_twilio_webhook_enabled, str)
and not x_twilio_webhook_enabled
)
):
headers["X-Twilio-Webhook-Enabled"] = x_twilio_webhook_enabled
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 ChannelInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
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.Chat.V3.ChannelContext {}>".format(context)
class ChannelList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ChannelList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, service_sid: str, sid: str) -> ChannelContext:
"""
Constructs a ChannelContext
:param service_sid: The unique SID identifier of the Service.
:param sid: A 34 character string that uniquely identifies this Channel.
"""
return ChannelContext(self._version, service_sid=service_sid, sid=sid)
def __call__(self, service_sid: str, sid: str) -> ChannelContext:
"""
Constructs a ChannelContext
:param service_sid: The unique SID identifier of the Service.
:param sid: A 34 character string that uniquely identifies this Channel.
"""
return ChannelContext(self._version, service_sid=service_sid, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Chat.V3.ChannelList>"
|
