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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Messaging
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, 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 DomainConfigInstance(InstanceResource):
"""
:ivar domain_sid: The unique string that we created to identify the Domain resource.
:ivar config_sid: The unique string that we created to identify the Domain config (prefix ZK).
:ivar fallback_url: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
:ivar callback_url: URL to receive click events to your webhook whenever the recipients click on the shortened links.
:ivar continue_on_failure: Boolean field to set customer delivery preference when there is a failure in linkShortening service
:ivar date_created: Date this Domain Config was created.
:ivar date_updated: Date that this Domain Config was last updated.
:ivar url:
:ivar disable_https: Customer's choice to send links with/without \"https://\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
domain_sid: Optional[str] = None,
):
super().__init__(version)
self.domain_sid: Optional[str] = payload.get("domain_sid")
self.config_sid: Optional[str] = payload.get("config_sid")
self.fallback_url: Optional[str] = payload.get("fallback_url")
self.callback_url: Optional[str] = payload.get("callback_url")
self.continue_on_failure: Optional[bool] = payload.get("continue_on_failure")
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.url: Optional[str] = payload.get("url")
self.disable_https: Optional[bool] = payload.get("disable_https")
self._solution = {
"domain_sid": domain_sid or self.domain_sid,
}
self._context: Optional[DomainConfigContext] = None
@property
def _proxy(self) -> "DomainConfigContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: DomainConfigContext for this DomainConfigInstance
"""
if self._context is None:
self._context = DomainConfigContext(
self._version,
domain_sid=self._solution["domain_sid"],
)
return self._context
def fetch(self) -> "DomainConfigInstance":
"""
Fetch the DomainConfigInstance
:returns: The fetched DomainConfigInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "DomainConfigInstance":
"""
Asynchronous coroutine to fetch the DomainConfigInstance
:returns: The fetched DomainConfigInstance
"""
return await self._proxy.fetch_async()
def update(
self,
fallback_url: Union[str, object] = values.unset,
callback_url: Union[str, object] = values.unset,
continue_on_failure: Union[bool, object] = values.unset,
disable_https: Union[bool, object] = values.unset,
) -> "DomainConfigInstance":
"""
Update the DomainConfigInstance
:param fallback_url: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
:param callback_url: URL to receive click events to your webhook whenever the recipients click on the shortened links
:param continue_on_failure: Boolean field to set customer delivery preference when there is a failure in linkShortening service
:param disable_https: Customer's choice to send links with/without \\\"https://\\\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
:returns: The updated DomainConfigInstance
"""
return self._proxy.update(
fallback_url=fallback_url,
callback_url=callback_url,
continue_on_failure=continue_on_failure,
disable_https=disable_https,
)
async def update_async(
self,
fallback_url: Union[str, object] = values.unset,
callback_url: Union[str, object] = values.unset,
continue_on_failure: Union[bool, object] = values.unset,
disable_https: Union[bool, object] = values.unset,
) -> "DomainConfigInstance":
"""
Asynchronous coroutine to update the DomainConfigInstance
:param fallback_url: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
:param callback_url: URL to receive click events to your webhook whenever the recipients click on the shortened links
:param continue_on_failure: Boolean field to set customer delivery preference when there is a failure in linkShortening service
:param disable_https: Customer's choice to send links with/without \\\"https://\\\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
:returns: The updated DomainConfigInstance
"""
return await self._proxy.update_async(
fallback_url=fallback_url,
callback_url=callback_url,
continue_on_failure=continue_on_failure,
disable_https=disable_https,
)
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.Messaging.V1.DomainConfigInstance {}>".format(context)
class DomainConfigContext(InstanceContext):
def __init__(self, version: Version, domain_sid: str):
"""
Initialize the DomainConfigContext
:param version: Version that contains the resource
:param domain_sid: Unique string used to identify the domain that this config should be associated with.
"""
super().__init__(version)
# Path Solution
self._solution = {
"domain_sid": domain_sid,
}
self._uri = "/LinkShortening/Domains/{domain_sid}/Config".format(
**self._solution
)
def fetch(self) -> DomainConfigInstance:
"""
Fetch the DomainConfigInstance
:returns: The fetched DomainConfigInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return DomainConfigInstance(
self._version,
payload,
domain_sid=self._solution["domain_sid"],
)
async def fetch_async(self) -> DomainConfigInstance:
"""
Asynchronous coroutine to fetch the DomainConfigInstance
:returns: The fetched DomainConfigInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return DomainConfigInstance(
self._version,
payload,
domain_sid=self._solution["domain_sid"],
)
def update(
self,
fallback_url: Union[str, object] = values.unset,
callback_url: Union[str, object] = values.unset,
continue_on_failure: Union[bool, object] = values.unset,
disable_https: Union[bool, object] = values.unset,
) -> DomainConfigInstance:
"""
Update the DomainConfigInstance
:param fallback_url: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
:param callback_url: URL to receive click events to your webhook whenever the recipients click on the shortened links
:param continue_on_failure: Boolean field to set customer delivery preference when there is a failure in linkShortening service
:param disable_https: Customer's choice to send links with/without \\\"https://\\\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
:returns: The updated DomainConfigInstance
"""
data = values.of(
{
"FallbackUrl": fallback_url,
"CallbackUrl": callback_url,
"ContinueOnFailure": serialize.boolean_to_string(continue_on_failure),
"DisableHttps": serialize.boolean_to_string(disable_https),
}
)
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 DomainConfigInstance(
self._version, payload, domain_sid=self._solution["domain_sid"]
)
async def update_async(
self,
fallback_url: Union[str, object] = values.unset,
callback_url: Union[str, object] = values.unset,
continue_on_failure: Union[bool, object] = values.unset,
disable_https: Union[bool, object] = values.unset,
) -> DomainConfigInstance:
"""
Asynchronous coroutine to update the DomainConfigInstance
:param fallback_url: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.
:param callback_url: URL to receive click events to your webhook whenever the recipients click on the shortened links
:param continue_on_failure: Boolean field to set customer delivery preference when there is a failure in linkShortening service
:param disable_https: Customer's choice to send links with/without \\\"https://\\\" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.
:returns: The updated DomainConfigInstance
"""
data = values.of(
{
"FallbackUrl": fallback_url,
"CallbackUrl": callback_url,
"ContinueOnFailure": serialize.boolean_to_string(continue_on_failure),
"DisableHttps": serialize.boolean_to_string(disable_https),
}
)
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 DomainConfigInstance(
self._version, payload, domain_sid=self._solution["domain_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.Messaging.V1.DomainConfigContext {}>".format(context)
class DomainConfigList(ListResource):
def __init__(self, version: Version):
"""
Initialize the DomainConfigList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, domain_sid: str) -> DomainConfigContext:
"""
Constructs a DomainConfigContext
:param domain_sid: Unique string used to identify the domain that this config should be associated with.
"""
return DomainConfigContext(self._version, domain_sid=domain_sid)
def __call__(self, domain_sid: str) -> DomainConfigContext:
"""
Constructs a DomainConfigContext
:param domain_sid: Unique string used to identify the domain that this config should be associated with.
"""
return DomainConfigContext(self._version, domain_sid=domain_sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Messaging.V1.DomainConfigList>"
|
