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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Insights
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 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 SettingInstance(InstanceResource):
"""
:ivar account_sid: The unique SID identifier of the Account.
:ivar advanced_features: A boolean flag indicating whether Advanced Features for Voice Insights are enabled.
:ivar voice_trace: A boolean flag indicating whether Voice Trace is enabled.
:ivar url: The URL of this resource.
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.advanced_features: Optional[bool] = payload.get("advanced_features")
self.voice_trace: Optional[bool] = payload.get("voice_trace")
self.url: Optional[str] = payload.get("url")
self._context: Optional[SettingContext] = None
@property
def _proxy(self) -> "SettingContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: SettingContext for this SettingInstance
"""
if self._context is None:
self._context = SettingContext(
self._version,
)
return self._context
def fetch(
self, subaccount_sid: Union[str, object] = values.unset
) -> "SettingInstance":
"""
Fetch the SettingInstance
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The fetched SettingInstance
"""
return self._proxy.fetch(
subaccount_sid=subaccount_sid,
)
async def fetch_async(
self, subaccount_sid: Union[str, object] = values.unset
) -> "SettingInstance":
"""
Asynchronous coroutine to fetch the SettingInstance
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The fetched SettingInstance
"""
return await self._proxy.fetch_async(
subaccount_sid=subaccount_sid,
)
def update(
self,
advanced_features: Union[bool, object] = values.unset,
voice_trace: Union[bool, object] = values.unset,
subaccount_sid: Union[str, object] = values.unset,
) -> "SettingInstance":
"""
Update the SettingInstance
:param advanced_features: A boolean flag to enable Advanced Features for Voice Insights.
:param voice_trace: A boolean flag to enable Voice Trace.
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The updated SettingInstance
"""
return self._proxy.update(
advanced_features=advanced_features,
voice_trace=voice_trace,
subaccount_sid=subaccount_sid,
)
async def update_async(
self,
advanced_features: Union[bool, object] = values.unset,
voice_trace: Union[bool, object] = values.unset,
subaccount_sid: Union[str, object] = values.unset,
) -> "SettingInstance":
"""
Asynchronous coroutine to update the SettingInstance
:param advanced_features: A boolean flag to enable Advanced Features for Voice Insights.
:param voice_trace: A boolean flag to enable Voice Trace.
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The updated SettingInstance
"""
return await self._proxy.update_async(
advanced_features=advanced_features,
voice_trace=voice_trace,
subaccount_sid=subaccount_sid,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Insights.V1.SettingInstance>"
class SettingContext(InstanceContext):
def __init__(self, version: Version):
"""
Initialize the SettingContext
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Voice/Settings"
def fetch(
self, subaccount_sid: Union[str, object] = values.unset
) -> SettingInstance:
"""
Fetch the SettingInstance
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The fetched SettingInstance
"""
data = values.of(
{
"SubaccountSid": subaccount_sid,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return SettingInstance(
self._version,
payload,
)
async def fetch_async(
self, subaccount_sid: Union[str, object] = values.unset
) -> SettingInstance:
"""
Asynchronous coroutine to fetch the SettingInstance
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The fetched SettingInstance
"""
data = values.of(
{
"SubaccountSid": subaccount_sid,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return SettingInstance(
self._version,
payload,
)
def update(
self,
advanced_features: Union[bool, object] = values.unset,
voice_trace: Union[bool, object] = values.unset,
subaccount_sid: Union[str, object] = values.unset,
) -> SettingInstance:
"""
Update the SettingInstance
:param advanced_features: A boolean flag to enable Advanced Features for Voice Insights.
:param voice_trace: A boolean flag to enable Voice Trace.
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The updated SettingInstance
"""
data = values.of(
{
"AdvancedFeatures": serialize.boolean_to_string(advanced_features),
"VoiceTrace": serialize.boolean_to_string(voice_trace),
"SubaccountSid": subaccount_sid,
}
)
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 SettingInstance(self._version, payload)
async def update_async(
self,
advanced_features: Union[bool, object] = values.unset,
voice_trace: Union[bool, object] = values.unset,
subaccount_sid: Union[str, object] = values.unset,
) -> SettingInstance:
"""
Asynchronous coroutine to update the SettingInstance
:param advanced_features: A boolean flag to enable Advanced Features for Voice Insights.
:param voice_trace: A boolean flag to enable Voice Trace.
:param subaccount_sid: The unique SID identifier of the Subaccount.
:returns: The updated SettingInstance
"""
data = values.of(
{
"AdvancedFeatures": serialize.boolean_to_string(advanced_features),
"VoiceTrace": serialize.boolean_to_string(voice_trace),
"SubaccountSid": subaccount_sid,
}
)
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 SettingInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Insights.V1.SettingContext>"
class SettingList(ListResource):
def __init__(self, version: Version):
"""
Initialize the SettingList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self) -> SettingContext:
"""
Constructs a SettingContext
"""
return SettingContext(self._version)
def __call__(self) -> SettingContext:
"""
Constructs a SettingContext
"""
return SettingContext(self._version)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Insights.V1.SettingList>"
|