r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Numbers 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 date 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 PortingPortInInstance(InstanceResource): """ :ivar port_in_request_sid: The SID of the Port In request. This is a unique identifier of the port in request. :ivar url: The URL of this Port In request :ivar account_sid: The Account SID that the numbers will be added to after they are ported into Twilio. :ivar notification_emails: List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails. :ivar target_port_in_date: Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation. :ivar target_port_in_time_range_start: Minimum hour in the future needs to be established with the Ops team for validation. :ivar target_port_in_time_range_end: Maximum hour in the future needs to be established with the Ops team for validation. :ivar port_in_request_status: The status of the port in request. The possible values are: In progress, Completed, Expired, In review, Waiting for Signature, Action Required, and Canceled. :ivar losing_carrier_information: The information for the losing carrier. :ivar phone_numbers: The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212). :ivar documents: The list of documents SID referencing a utility bills :ivar date_created: """ def __init__( self, version: Version, payload: Dict[str, Any], port_in_request_sid: Optional[str] = None, ): super().__init__(version) self.port_in_request_sid: Optional[str] = payload.get("port_in_request_sid") self.url: Optional[str] = payload.get("url") self.account_sid: Optional[str] = payload.get("account_sid") self.notification_emails: Optional[List[str]] = payload.get( "notification_emails" ) self.target_port_in_date: Optional[date] = deserialize.iso8601_date( payload.get("target_port_in_date") ) self.target_port_in_time_range_start: Optional[str] = payload.get( "target_port_in_time_range_start" ) self.target_port_in_time_range_end: Optional[str] = payload.get( "target_port_in_time_range_end" ) self.port_in_request_status: Optional[str] = payload.get( "port_in_request_status" ) self.losing_carrier_information: Optional[Dict[str, object]] = payload.get( "losing_carrier_information" ) self.phone_numbers: Optional[List[Dict[str, object]]] = payload.get( "phone_numbers" ) self.documents: Optional[List[str]] = payload.get("documents") self.date_created: Optional[date] = deserialize.iso8601_date( payload.get("date_created") ) self._solution = { "port_in_request_sid": port_in_request_sid or self.port_in_request_sid, } self._context: Optional[PortingPortInContext] = None @property def _proxy(self) -> "PortingPortInContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: PortingPortInContext for this PortingPortInInstance """ if self._context is None: self._context = PortingPortInContext( self._version, port_in_request_sid=self._solution["port_in_request_sid"], ) return self._context def delete(self) -> bool: """ Deletes the PortingPortInInstance :returns: True if delete succeeds, False otherwise """ return self._proxy.delete() async def delete_async(self) -> bool: """ Asynchronous coroutine that deletes the PortingPortInInstance :returns: True if delete succeeds, False otherwise """ return await self._proxy.delete_async() def fetch(self) -> "PortingPortInInstance": """ Fetch the PortingPortInInstance :returns: The fetched PortingPortInInstance """ return self._proxy.fetch() async def fetch_async(self) -> "PortingPortInInstance": """ Asynchronous coroutine to fetch the PortingPortInInstance :returns: The fetched PortingPortInInstance """ 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 "".format(context) class PortingPortInContext(InstanceContext): def __init__(self, version: Version, port_in_request_sid: str): """ Initialize the PortingPortInContext :param version: Version that contains the resource :param port_in_request_sid: The SID of the Port In request. This is a unique identifier of the port in request. """ super().__init__(version) # Path Solution self._solution = { "port_in_request_sid": port_in_request_sid, } self._uri = "/Porting/PortIn/{port_in_request_sid}".format(**self._solution) def delete(self) -> bool: """ Deletes the PortingPortInInstance :returns: True if delete succeeds, False otherwise """ return self._version.delete( method="DELETE", uri=self._uri, ) async def delete_async(self) -> bool: """ Asynchronous coroutine that deletes the PortingPortInInstance :returns: True if delete succeeds, False otherwise """ return await self._version.delete_async( method="DELETE", uri=self._uri, ) def fetch(self) -> PortingPortInInstance: """ Fetch the PortingPortInInstance :returns: The fetched PortingPortInInstance """ payload = self._version.fetch( method="GET", uri=self._uri, ) return PortingPortInInstance( self._version, payload, port_in_request_sid=self._solution["port_in_request_sid"], ) async def fetch_async(self) -> PortingPortInInstance: """ Asynchronous coroutine to fetch the PortingPortInInstance :returns: The fetched PortingPortInInstance """ payload = await self._version.fetch_async( method="GET", uri=self._uri, ) return PortingPortInInstance( self._version, payload, port_in_request_sid=self._solution["port_in_request_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 PortingPortInList(ListResource): def __init__(self, version: Version): """ Initialize the PortingPortInList :param version: Version that contains the resource """ super().__init__(version) self._uri = "/Porting/PortIn" def create( self, body: Union[object, object] = values.unset ) -> PortingPortInInstance: """ Create the PortingPortInInstance :param body: :returns: The created PortingPortInInstance """ data = body.to_dict() headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) headers["Content-Type"] = "application/json" payload = self._version.create( method="POST", uri=self._uri, data=data, headers=headers ) return PortingPortInInstance(self._version, payload) async def create_async( self, body: Union[object, object] = values.unset ) -> PortingPortInInstance: """ Asynchronously create the PortingPortInInstance :param body: :returns: The created PortingPortInInstance """ data = body.to_dict() headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) headers["Content-Type"] = "application/json" payload = await self._version.create_async( method="POST", uri=self._uri, data=data, headers=headers ) return PortingPortInInstance(self._version, payload) def get(self, port_in_request_sid: str) -> PortingPortInContext: """ Constructs a PortingPortInContext :param port_in_request_sid: The SID of the Port In request. This is a unique identifier of the port in request. """ return PortingPortInContext( self._version, port_in_request_sid=port_in_request_sid ) def __call__(self, port_in_request_sid: str) -> PortingPortInContext: """ Constructs a PortingPortInContext :param port_in_request_sid: The SID of the Port In request. This is a unique identifier of the port in request. """ return PortingPortInContext( self._version, port_in_request_sid=port_in_request_sid ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""