Source code for twilio.rest.lookups.v2.phone_number

# coding=utf-8
r"""
This code was generated by
\ / _    _  _|   _  _
 | (_)\/(_)(_|\/| |(/_  v1.0.0
      /       /
"""

from twilio.base import 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.page import Page


[docs]class PhoneNumberList(ListResource): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version): """ Initialize the PhoneNumberList :param Version version: Version that contains the resource :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberList :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberList """ super(PhoneNumberList, self).__init__(version) # Path Solution self._solution = {}
[docs] def get(self, phone_number): """ Constructs a PhoneNumberContext :param phone_number: Phone number to lookup :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberContext :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberContext """ return PhoneNumberContext(self._version, phone_number=phone_number, )
def __call__(self, phone_number): """ Constructs a PhoneNumberContext :param phone_number: Phone number to lookup :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberContext :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberContext """ return PhoneNumberContext(self._version, phone_number=phone_number, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Lookups.V2.PhoneNumberList>'
[docs]class PhoneNumberPage(Page): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version, response, solution): """ Initialize the PhoneNumberPage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberPage :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberPage """ super(PhoneNumberPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of PhoneNumberInstance :param dict payload: Payload response from the API :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberInstance :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberInstance """ return PhoneNumberInstance(self._version, payload, )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Lookups.V2.PhoneNumberPage>'
[docs]class PhoneNumberContext(InstanceContext): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version, phone_number): """ Initialize the PhoneNumberContext :param Version version: Version that contains the resource :param phone_number: Phone number to lookup :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberContext :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberContext """ super(PhoneNumberContext, self).__init__(version) # Path Solution self._solution = {'phone_number': phone_number, } self._uri = '/PhoneNumbers/{phone_number}'.format(**self._solution)
[docs] def fetch(self, fields=values.unset, country_code=values.unset): """ Fetch the PhoneNumberInstance :param unicode fields: Fields to return :param unicode country_code: Country code for national phone number lookups :returns: The fetched PhoneNumberInstance :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberInstance """ data = values.of({'Fields': fields, 'CountryCode': country_code, }) payload = self._version.fetch(method='GET', uri=self._uri, params=data, ) return PhoneNumberInstance(self._version, payload, phone_number=self._solution['phone_number'], )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items()) return '<Twilio.Lookups.V2.PhoneNumberContext {}>'.format(context)
[docs]class PhoneNumberInstance(InstanceResource): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """
[docs] class Type(object): LANDLINE = "landline" MOBILE = "mobile" VOIP = "voip"
[docs] class ValidationError(object): TOO_SHORT = "TOO_SHORT" TOO_LONG = "TOO_LONG" INVALID_BUT_POSSIBLE = "INVALID_BUT_POSSIBLE" INVALID_COUNTRY_CODE = "INVALID_COUNTRY_CODE" INVALID_LENGTH = "INVALID_LENGTH" NOT_A_NUMBER = "NOT_A_NUMBER"
def __init__(self, version, payload, phone_number=None): """ Initialize the PhoneNumberInstance :returns: twilio.rest.lookups.v2.phone_number.PhoneNumberInstance :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberInstance """ super(PhoneNumberInstance, self).__init__(version) # Marshaled Properties self._properties = { 'calling_country_code': payload.get('calling_country_code'), 'country_code': payload.get('country_code'), 'phone_number': payload.get('phone_number'), 'national_format': payload.get('national_format'), 'valid': payload.get('valid'), 'validation_errors': payload.get('validation_errors'), 'caller_name': payload.get('caller_name'), 'sim_swap': payload.get('sim_swap'), 'call_forwarding': payload.get('call_forwarding'), 'live_activity': payload.get('live_activity'), 'enhanced_line_type': payload.get('enhanced_line_type'), 'line_type_intelligence': payload.get('line_type_intelligence'), 'url': payload.get('url'), } # Context self._context = None self._solution = {'phone_number': phone_number or self._properties['phone_number'], } @property def _proxy(self): """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: PhoneNumberContext for this PhoneNumberInstance :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberContext """ if self._context is None: self._context = PhoneNumberContext(self._version, phone_number=self._solution['phone_number'], ) return self._context @property def calling_country_code(self): """ :returns: International dialing prefix :rtype: unicode """ return self._properties['calling_country_code'] @property def country_code(self): """ :returns: Phone number's ISO country code :rtype: unicode """ return self._properties['country_code'] @property def phone_number(self): """ :returns: Phone number in E.164 format :rtype: unicode """ return self._properties['phone_number'] @property def national_format(self): """ :returns: Phone number in national format :rtype: unicode """ return self._properties['national_format'] @property def valid(self): """ :returns: Boolean which indicates if the phone number is valid :rtype: bool """ return self._properties['valid'] @property def validation_errors(self): """ :returns: Contains reasons why a phone number is invalid :rtype: list[PhoneNumberInstance.ValidationError] """ return self._properties['validation_errors'] @property def caller_name(self): """ :returns: An object that contains caller name information :rtype: dict """ return self._properties['caller_name'] @property def sim_swap(self): """ :returns: An object that contains SIM swap information :rtype: dict """ return self._properties['sim_swap'] @property def call_forwarding(self): """ :returns: An object that contains call forwarding status information :rtype: dict """ return self._properties['call_forwarding'] @property def live_activity(self): """ :returns: An object that contains live activity information :rtype: dict """ return self._properties['live_activity'] @property def enhanced_line_type(self): """ :returns: An object that contains line type information :rtype: dict """ return self._properties['enhanced_line_type'] @property def line_type_intelligence(self): """ :returns: An object that contains line type information :rtype: dict """ return self._properties['line_type_intelligence'] @property def url(self): """ :returns: The absolute URL of the resource :rtype: unicode """ return self._properties['url']
[docs] def fetch(self, fields=values.unset, country_code=values.unset): """ Fetch the PhoneNumberInstance :param unicode fields: Fields to return :param unicode country_code: Country code for national phone number lookups :returns: The fetched PhoneNumberInstance :rtype: twilio.rest.lookups.v2.phone_number.PhoneNumberInstance """ return self._proxy.fetch(fields=fields, country_code=country_code, )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items()) return '<Twilio.Lookups.V2.PhoneNumberInstance {}>'.format(context)