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
|
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
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 DomainConfigMessagingServiceInstance(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 messaging_service_sid: The unique string that identifies the messaging service
: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:
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
messaging_service_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.messaging_service_sid: Optional[str] = payload.get("messaging_service_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._solution = {
"messaging_service_sid": messaging_service_sid
or self.messaging_service_sid,
}
self._context: Optional[DomainConfigMessagingServiceContext] = None
@property
def _proxy(self) -> "DomainConfigMessagingServiceContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: DomainConfigMessagingServiceContext for this DomainConfigMessagingServiceInstance
"""
if self._context is None:
self._context = DomainConfigMessagingServiceContext(
self._version,
messaging_service_sid=self._solution["messaging_service_sid"],
)
return self._context
def fetch(self) -> "DomainConfigMessagingServiceInstance":
"""
Fetch the DomainConfigMessagingServiceInstance
:returns: The fetched DomainConfigMessagingServiceInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "DomainConfigMessagingServiceInstance":
"""
Asynchronous coroutine to fetch the DomainConfigMessagingServiceInstance
:returns: The fetched DomainConfigMessagingServiceInstance
"""
return await self._proxy.fetch_async()
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.DomainConfigMessagingServiceInstance {}>".format(
context
)
class DomainConfigMessagingServiceContext(InstanceContext):
def __init__(self, version: Version, messaging_service_sid: str):
"""
Initialize the DomainConfigMessagingServiceContext
:param version: Version that contains the resource
:param messaging_service_sid: Unique string used to identify the Messaging service that this domain should be associated with.
"""
super().__init__(version)
# Path Solution
self._solution = {
"messaging_service_sid": messaging_service_sid,
}
self._uri = "/LinkShortening/MessagingService/{messaging_service_sid}/DomainConfig".format(
**self._solution
)
def fetch(self) -> DomainConfigMessagingServiceInstance:
"""
Fetch the DomainConfigMessagingServiceInstance
:returns: The fetched DomainConfigMessagingServiceInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return DomainConfigMessagingServiceInstance(
self._version,
payload,
messaging_service_sid=self._solution["messaging_service_sid"],
)
async def fetch_async(self) -> DomainConfigMessagingServiceInstance:
"""
Asynchronous coroutine to fetch the DomainConfigMessagingServiceInstance
:returns: The fetched DomainConfigMessagingServiceInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return DomainConfigMessagingServiceInstance(
self._version,
payload,
messaging_service_sid=self._solution["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.Messaging.V1.DomainConfigMessagingServiceContext {}>".format(
context
)
class DomainConfigMessagingServiceList(ListResource):
def __init__(self, version: Version):
"""
Initialize the DomainConfigMessagingServiceList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, messaging_service_sid: str) -> DomainConfigMessagingServiceContext:
"""
Constructs a DomainConfigMessagingServiceContext
:param messaging_service_sid: Unique string used to identify the Messaging service that this domain should be associated with.
"""
return DomainConfigMessagingServiceContext(
self._version, messaging_service_sid=messaging_service_sid
)
def __call__(
self, messaging_service_sid: str
) -> DomainConfigMessagingServiceContext:
"""
Constructs a DomainConfigMessagingServiceContext
:param messaging_service_sid: Unique string used to identify the Messaging service that this domain should be associated with.
"""
return DomainConfigMessagingServiceContext(
self._version, messaging_service_sid=messaging_service_sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Messaging.V1.DomainConfigMessagingServiceList>"
|
