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 - 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 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
from twilio.rest.conversations.v1.configuration.webhook import WebhookList
class ConfigurationInstance(InstanceResource):
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration.
:ivar default_chat_service_sid: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation.
:ivar default_messaging_service_sid: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation.
:ivar default_inactive_timer: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
:ivar default_closed_timer: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
:ivar url: An absolute API resource URL for this global configuration.
:ivar links: Contains absolute API resource URLs to access the webhook and default service configurations.
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.default_chat_service_sid: Optional[str] = payload.get(
"default_chat_service_sid"
)
self.default_messaging_service_sid: Optional[str] = payload.get(
"default_messaging_service_sid"
)
self.default_inactive_timer: Optional[str] = payload.get(
"default_inactive_timer"
)
self.default_closed_timer: Optional[str] = payload.get("default_closed_timer")
self.url: Optional[str] = payload.get("url")
self.links: Optional[Dict[str, object]] = payload.get("links")
self._context: Optional[ConfigurationContext] = None
@property
def _proxy(self) -> "ConfigurationContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: ConfigurationContext for this ConfigurationInstance
"""
if self._context is None:
self._context = ConfigurationContext(
self._version,
)
return self._context
def fetch(self) -> "ConfigurationInstance":
"""
Fetch the ConfigurationInstance
:returns: The fetched ConfigurationInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "ConfigurationInstance":
"""
Asynchronous coroutine to fetch the ConfigurationInstance
:returns: The fetched ConfigurationInstance
"""
return await self._proxy.fetch_async()
def update(
self,
default_chat_service_sid: Union[str, object] = values.unset,
default_messaging_service_sid: Union[str, object] = values.unset,
default_inactive_timer: Union[str, object] = values.unset,
default_closed_timer: Union[str, object] = values.unset,
) -> "ConfigurationInstance":
"""
Update the ConfigurationInstance
:param default_chat_service_sid: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
:param default_messaging_service_sid: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
:param default_inactive_timer: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
:param default_closed_timer: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
:returns: The updated ConfigurationInstance
"""
return self._proxy.update(
default_chat_service_sid=default_chat_service_sid,
default_messaging_service_sid=default_messaging_service_sid,
default_inactive_timer=default_inactive_timer,
default_closed_timer=default_closed_timer,
)
async def update_async(
self,
default_chat_service_sid: Union[str, object] = values.unset,
default_messaging_service_sid: Union[str, object] = values.unset,
default_inactive_timer: Union[str, object] = values.unset,
default_closed_timer: Union[str, object] = values.unset,
) -> "ConfigurationInstance":
"""
Asynchronous coroutine to update the ConfigurationInstance
:param default_chat_service_sid: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
:param default_messaging_service_sid: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
:param default_inactive_timer: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
:param default_closed_timer: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
:returns: The updated ConfigurationInstance
"""
return await self._proxy.update_async(
default_chat_service_sid=default_chat_service_sid,
default_messaging_service_sid=default_messaging_service_sid,
default_inactive_timer=default_inactive_timer,
default_closed_timer=default_closed_timer,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Conversations.V1.ConfigurationInstance>"
class ConfigurationContext(InstanceContext):
def __init__(self, version: Version):
"""
Initialize the ConfigurationContext
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Configuration"
def fetch(self) -> ConfigurationInstance:
"""
Fetch the ConfigurationInstance
:returns: The fetched ConfigurationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return ConfigurationInstance(
self._version,
payload,
)
async def fetch_async(self) -> ConfigurationInstance:
"""
Asynchronous coroutine to fetch the ConfigurationInstance
:returns: The fetched ConfigurationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return ConfigurationInstance(
self._version,
payload,
)
def update(
self,
default_chat_service_sid: Union[str, object] = values.unset,
default_messaging_service_sid: Union[str, object] = values.unset,
default_inactive_timer: Union[str, object] = values.unset,
default_closed_timer: Union[str, object] = values.unset,
) -> ConfigurationInstance:
"""
Update the ConfigurationInstance
:param default_chat_service_sid: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
:param default_messaging_service_sid: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
:param default_inactive_timer: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
:param default_closed_timer: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
:returns: The updated ConfigurationInstance
"""
data = values.of(
{
"DefaultChatServiceSid": default_chat_service_sid,
"DefaultMessagingServiceSid": default_messaging_service_sid,
"DefaultInactiveTimer": default_inactive_timer,
"DefaultClosedTimer": default_closed_timer,
}
)
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 ConfigurationInstance(self._version, payload)
async def update_async(
self,
default_chat_service_sid: Union[str, object] = values.unset,
default_messaging_service_sid: Union[str, object] = values.unset,
default_inactive_timer: Union[str, object] = values.unset,
default_closed_timer: Union[str, object] = values.unset,
) -> ConfigurationInstance:
"""
Asynchronous coroutine to update the ConfigurationInstance
:param default_chat_service_sid: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
:param default_messaging_service_sid: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
:param default_inactive_timer: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
:param default_closed_timer: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
:returns: The updated ConfigurationInstance
"""
data = values.of(
{
"DefaultChatServiceSid": default_chat_service_sid,
"DefaultMessagingServiceSid": default_messaging_service_sid,
"DefaultInactiveTimer": default_inactive_timer,
"DefaultClosedTimer": default_closed_timer,
}
)
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 ConfigurationInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Conversations.V1.ConfigurationContext>"
class ConfigurationList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ConfigurationList
:param version: Version that contains the resource
"""
super().__init__(version)
self._webhooks: Optional[WebhookList] = None
@property
def webhooks(self) -> WebhookList:
"""
Access the webhooks
"""
if self._webhooks is None:
self._webhooks = WebhookList(self._version)
return self._webhooks
def get(self) -> ConfigurationContext:
"""
Constructs a ConfigurationContext
"""
return ConfigurationContext(self._version)
def __call__(self) -> ConfigurationContext:
"""
Constructs a ConfigurationContext
"""
return ConfigurationContext(self._version)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Conversations.V1.ConfigurationList>"
|
