File: C:/Users/fred/anaconda3/Lib/site-packages/twilio/rest/intelligence/v2/transcript/media.py
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Intelligence
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 MediaInstance(InstanceResource):
"""
:ivar account_sid: The unique SID identifier of the Account.
:ivar media_url: Downloadable URL for media, if stored in Twilio AI.
:ivar service_sid: The unique SID identifier of the Service.
:ivar sid: The unique SID identifier of the Transcript.
:ivar url: The URL of this resource.
"""
def __init__(self, version: Version, payload: Dict[str, Any], sid: str):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.media_url: Optional[str] = payload.get("media_url")
self.service_sid: Optional[str] = payload.get("service_sid")
self.sid: Optional[str] = payload.get("sid")
self.url: Optional[str] = payload.get("url")
self._solution = {
"sid": sid,
}
self._context: Optional[MediaContext] = None
@property
def _proxy(self) -> "MediaContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: MediaContext for this MediaInstance
"""
if self._context is None:
self._context = MediaContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def fetch(self, redacted: Union[bool, object] = values.unset) -> "MediaInstance":
"""
Fetch the MediaInstance
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
:returns: The fetched MediaInstance
"""
return self._proxy.fetch(
redacted=redacted,
)
async def fetch_async(
self, redacted: Union[bool, object] = values.unset
) -> "MediaInstance":
"""
Asynchronous coroutine to fetch the MediaInstance
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
:returns: The fetched MediaInstance
"""
return await self._proxy.fetch_async(
redacted=redacted,
)
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.Intelligence.V2.MediaInstance {}>".format(context)
class MediaContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the MediaContext
:param version: Version that contains the resource
:param sid: The unique SID identifier of the Transcript.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/Transcripts/{sid}/Media".format(**self._solution)
def fetch(self, redacted: Union[bool, object] = values.unset) -> MediaInstance:
"""
Fetch the MediaInstance
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
:returns: The fetched MediaInstance
"""
data = values.of(
{
"Redacted": serialize.boolean_to_string(redacted),
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return MediaInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(
self, redacted: Union[bool, object] = values.unset
) -> MediaInstance:
"""
Asynchronous coroutine to fetch the MediaInstance
:param redacted: Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.
:returns: The fetched MediaInstance
"""
data = values.of(
{
"Redacted": serialize.boolean_to_string(redacted),
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return MediaInstance(
self._version,
payload,
sid=self._solution["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.Intelligence.V2.MediaContext {}>".format(context)
class MediaList(ListResource):
def __init__(self, version: Version, sid: str):
"""
Initialize the MediaList
:param version: Version that contains the resource
:param sid: The unique SID identifier of the Transcript.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
def get(self) -> MediaContext:
"""
Constructs a MediaContext
"""
return MediaContext(self._version, sid=self._solution["sid"])
def __call__(self) -> MediaContext:
"""
Constructs a MediaContext
"""
return MediaContext(self._version, sid=self._solution["sid"])
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Intelligence.V2.MediaList>"