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 datetime import datetime from typing import Any, Dict, List, 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 CallSummaryInstance(InstanceResource): class AnsweredBy(object): UNKNOWN = "unknown" MACHINE_START = "machine_start" MACHINE_END_BEEP = "machine_end_beep" MACHINE_END_SILENCE = "machine_end_silence" MACHINE_END_OTHER = "machine_end_other" HUMAN = "human" FAX = "fax" class CallState(object): RINGING = "ringing" COMPLETED = "completed" BUSY = "busy" FAIL = "fail" NOANSWER = "noanswer" CANCELED = "canceled" ANSWERED = "answered" UNDIALED = "undialed" class CallType(object): CARRIER = "carrier" SIP = "sip" TRUNKING = "trunking" CLIENT = "client" class ProcessingState(object): COMPLETE = "complete" PARTIAL = "partial" """ :ivar account_sid: The unique SID identifier of the Account. :ivar call_sid: The unique SID identifier of the Call. :ivar call_type: :ivar call_state: :ivar answered_by: :ivar processing_state: :ivar created_time: The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS :ivar start_time: The time at which the Call was started, given in ISO 8601 format. :ivar end_time: The time at which the Call was ended, given in ISO 8601 format. :ivar duration: Duration between when the call was initiated and the call was ended :ivar connect_duration: Duration between when the call was answered and when it ended :ivar _from: The calling party. :ivar to: The called party. :ivar carrier_edge: Contains metrics and properties for the Twilio media gateway of a PSTN call. :ivar client_edge: Contains metrics and properties for the Twilio media gateway of a Client call. :ivar sdk_edge: Contains metrics and properties for the SDK sensor library for Client calls. :ivar sip_edge: Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call. :ivar tags: Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality. :ivar url: The URL of this resource. :ivar attributes: Attributes capturing call-flow-specific details. :ivar properties: Contains edge-agnostic call-level details. :ivar trust: Contains trusted communications details including Branded Call and verified caller ID. :ivar annotation: Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API. """ def __init__(self, version: Version, payload: Dict[str, Any], call_sid: str): super().__init__(version) self.account_sid: Optional[str] = payload.get("account_sid") self.call_sid: Optional[str] = payload.get("call_sid") self.call_type: Optional["CallSummaryInstance.CallType"] = payload.get( "call_type" ) self.call_state: Optional["CallSummaryInstance.CallState"] = payload.get( "call_state" ) self.answered_by: Optional["CallSummaryInstance.AnsweredBy"] = payload.get( "answered_by" ) self.processing_state: Optional[ "CallSummaryInstance.ProcessingState" ] = payload.get("processing_state") self.created_time: Optional[datetime] = deserialize.iso8601_datetime( payload.get("created_time") ) self.start_time: Optional[datetime] = deserialize.iso8601_datetime( payload.get("start_time") ) self.end_time: Optional[datetime] = deserialize.iso8601_datetime( payload.get("end_time") ) self.duration: Optional[int] = deserialize.integer(payload.get("duration")) self.connect_duration: Optional[int] = deserialize.integer( payload.get("connect_duration") ) self._from: Optional[Dict[str, object]] = payload.get("from") self.to: Optional[Dict[str, object]] = payload.get("to") self.carrier_edge: Optional[Dict[str, object]] = payload.get("carrier_edge") self.client_edge: Optional[Dict[str, object]] = payload.get("client_edge") self.sdk_edge: Optional[Dict[str, object]] = payload.get("sdk_edge") self.sip_edge: Optional[Dict[str, object]] = payload.get("sip_edge") self.tags: Optional[List[str]] = payload.get("tags") self.url: Optional[str] = payload.get("url") self.attributes: Optional[Dict[str, object]] = payload.get("attributes") self.properties: Optional[Dict[str, object]] = payload.get("properties") self.trust: Optional[Dict[str, object]] = payload.get("trust") self.annotation: Optional[Dict[str, object]] = payload.get("annotation") self._solution = { "call_sid": call_sid, } self._context: Optional[CallSummaryContext] = None @property def _proxy(self) -> "CallSummaryContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: CallSummaryContext for this CallSummaryInstance """ if self._context is None: self._context = CallSummaryContext( self._version, call_sid=self._solution["call_sid"], ) return self._context def fetch( self, processing_state: Union[ "CallSummaryInstance.ProcessingState", object ] = values.unset, ) -> "CallSummaryInstance": """ Fetch the CallSummaryInstance :param processing_state: The Processing State of this Call Summary. One of `complete`, `partial` or `all`. :returns: The fetched CallSummaryInstance """ return self._proxy.fetch( processing_state=processing_state, ) async def fetch_async( self, processing_state: Union[ "CallSummaryInstance.ProcessingState", object ] = values.unset, ) -> "CallSummaryInstance": """ Asynchronous coroutine to fetch the CallSummaryInstance :param processing_state: The Processing State of this Call Summary. One of `complete`, `partial` or `all`. :returns: The fetched CallSummaryInstance """ return await self._proxy.fetch_async( processing_state=processing_state, ) 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 "".format(context) class CallSummaryContext(InstanceContext): def __init__(self, version: Version, call_sid: str): """ Initialize the CallSummaryContext :param version: Version that contains the resource :param call_sid: The unique SID identifier of the Call. """ super().__init__(version) # Path Solution self._solution = { "call_sid": call_sid, } self._uri = "/Voice/{call_sid}/Summary".format(**self._solution) def fetch( self, processing_state: Union[ "CallSummaryInstance.ProcessingState", object ] = values.unset, ) -> CallSummaryInstance: """ Fetch the CallSummaryInstance :param processing_state: The Processing State of this Call Summary. One of `complete`, `partial` or `all`. :returns: The fetched CallSummaryInstance """ data = values.of( { "ProcessingState": processing_state, } ) payload = self._version.fetch(method="GET", uri=self._uri, params=data) return CallSummaryInstance( self._version, payload, call_sid=self._solution["call_sid"], ) async def fetch_async( self, processing_state: Union[ "CallSummaryInstance.ProcessingState", object ] = values.unset, ) -> CallSummaryInstance: """ Asynchronous coroutine to fetch the CallSummaryInstance :param processing_state: The Processing State of this Call Summary. One of `complete`, `partial` or `all`. :returns: The fetched CallSummaryInstance """ data = values.of( { "ProcessingState": processing_state, } ) payload = await self._version.fetch_async( method="GET", uri=self._uri, params=data ) return CallSummaryInstance( self._version, payload, call_sid=self._solution["call_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 "".format(context) class CallSummaryList(ListResource): def __init__(self, version: Version, call_sid: str): """ Initialize the CallSummaryList :param version: Version that contains the resource :param call_sid: The unique SID identifier of the Call. """ super().__init__(version) # Path Solution self._solution = { "call_sid": call_sid, } def get(self) -> CallSummaryContext: """ Constructs a CallSummaryContext """ return CallSummaryContext(self._version, call_sid=self._solution["call_sid"]) def __call__(self) -> CallSummaryContext: """ Constructs a CallSummaryContext """ return CallSummaryContext(self._version, call_sid=self._solution["call_sid"]) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""