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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Routes
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 TrunkInstance(InstanceResource):
"""
:ivar sip_trunk_domain: The absolute URL of the SIP Trunk
:ivar url: The absolute URL of the resource.
:ivar sid: A 34 character string that uniquely identifies the Inbound Processing Region assignments for this SIP Trunk.
:ivar account_sid: The unique SID identifier of the Account.
:ivar friendly_name: A human readable description of the Inbound Processing Region assignments for this SIP Trunk, up to 64 characters.
:ivar voice_region: The Inbound Processing Region used for this SIP Trunk for voice.
:ivar date_created: The date that this SIP Trunk was assigned an Inbound Processing Region, given in ISO 8601 format.
:ivar date_updated: The date that the Inbound Processing Region was updated for this SIP Trunk, given in ISO 8601 format.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
sip_trunk_domain: Optional[str] = None,
):
super().__init__(version)
self.sip_trunk_domain: Optional[str] = payload.get("sip_trunk_domain")
self.url: Optional[str] = payload.get("url")
self.sid: Optional[str] = payload.get("sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.voice_region: Optional[str] = payload.get("voice_region")
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._solution = {
"sip_trunk_domain": sip_trunk_domain or self.sip_trunk_domain,
}
self._context: Optional[TrunkContext] = None
@property
def _proxy(self) -> "TrunkContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: TrunkContext for this TrunkInstance
"""
if self._context is None:
self._context = TrunkContext(
self._version,
sip_trunk_domain=self._solution["sip_trunk_domain"],
)
return self._context
def fetch(self) -> "TrunkInstance":
"""
Fetch the TrunkInstance
:returns: The fetched TrunkInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "TrunkInstance":
"""
Asynchronous coroutine to fetch the TrunkInstance
:returns: The fetched TrunkInstance
"""
return await self._proxy.fetch_async()
def update(
self,
voice_region: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
) -> "TrunkInstance":
"""
Update the TrunkInstance
:param voice_region: The Inbound Processing Region used for this SIP Trunk for voice
:param friendly_name: A human readable description of this resource, up to 64 characters.
:returns: The updated TrunkInstance
"""
return self._proxy.update(
voice_region=voice_region,
friendly_name=friendly_name,
)
async def update_async(
self,
voice_region: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
) -> "TrunkInstance":
"""
Asynchronous coroutine to update the TrunkInstance
:param voice_region: The Inbound Processing Region used for this SIP Trunk for voice
:param friendly_name: A human readable description of this resource, up to 64 characters.
:returns: The updated TrunkInstance
"""
return await self._proxy.update_async(
voice_region=voice_region,
friendly_name=friendly_name,
)
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.Routes.V2.TrunkInstance {}>".format(context)
class TrunkContext(InstanceContext):
def __init__(self, version: Version, sip_trunk_domain: str):
"""
Initialize the TrunkContext
:param version: Version that contains the resource
:param sip_trunk_domain: The absolute URL of the SIP Trunk
"""
super().__init__(version)
# Path Solution
self._solution = {
"sip_trunk_domain": sip_trunk_domain,
}
self._uri = "/Trunks/{sip_trunk_domain}".format(**self._solution)
def fetch(self) -> TrunkInstance:
"""
Fetch the TrunkInstance
:returns: The fetched TrunkInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return TrunkInstance(
self._version,
payload,
sip_trunk_domain=self._solution["sip_trunk_domain"],
)
async def fetch_async(self) -> TrunkInstance:
"""
Asynchronous coroutine to fetch the TrunkInstance
:returns: The fetched TrunkInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return TrunkInstance(
self._version,
payload,
sip_trunk_domain=self._solution["sip_trunk_domain"],
)
def update(
self,
voice_region: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
) -> TrunkInstance:
"""
Update the TrunkInstance
:param voice_region: The Inbound Processing Region used for this SIP Trunk for voice
:param friendly_name: A human readable description of this resource, up to 64 characters.
:returns: The updated TrunkInstance
"""
data = values.of(
{
"VoiceRegion": voice_region,
"FriendlyName": friendly_name,
}
)
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 TrunkInstance(
self._version, payload, sip_trunk_domain=self._solution["sip_trunk_domain"]
)
async def update_async(
self,
voice_region: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
) -> TrunkInstance:
"""
Asynchronous coroutine to update the TrunkInstance
:param voice_region: The Inbound Processing Region used for this SIP Trunk for voice
:param friendly_name: A human readable description of this resource, up to 64 characters.
:returns: The updated TrunkInstance
"""
data = values.of(
{
"VoiceRegion": voice_region,
"FriendlyName": friendly_name,
}
)
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 TrunkInstance(
self._version, payload, sip_trunk_domain=self._solution["sip_trunk_domain"]
)
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.Routes.V2.TrunkContext {}>".format(context)
class TrunkList(ListResource):
def __init__(self, version: Version):
"""
Initialize the TrunkList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, sip_trunk_domain: str) -> TrunkContext:
"""
Constructs a TrunkContext
:param sip_trunk_domain: The absolute URL of the SIP Trunk
"""
return TrunkContext(self._version, sip_trunk_domain=sip_trunk_domain)
def __call__(self, sip_trunk_domain: str) -> TrunkContext:
"""
Constructs a TrunkContext
:param sip_trunk_domain: The absolute URL of the SIP Trunk
"""
return TrunkContext(self._version, sip_trunk_domain=sip_trunk_domain)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Routes.V2.TrunkList>"
|