Source code for twilio.rest.api.v2010.account.address.dependent_phone_number

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

from twilio.base import deserialize
from twilio.base import values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page


[docs]class DependentPhoneNumberList(ListResource): def __init__(self, version, account_sid, address_sid): """ Initialize the DependentPhoneNumberList :param Version version: Version that contains the resource :param account_sid: The SID of the Account that created the resource :param address_sid: The unique string that identifies the resource :returns: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberList :rtype: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberList """ super(DependentPhoneNumberList, self).__init__(version) # Path Solution self._solution = {'account_sid': account_sid, 'address_sid': address_sid, } self._uri = '/Accounts/{account_sid}/Addresses/{address_sid}/DependentPhoneNumbers.json'.format(**self._solution)
[docs] def stream(self, limit=None, page_size=None): """ Streams DependentPhoneNumberInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient. :param int limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param int page_size: Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000) :returns: Generator that will yield up to limit results :rtype: list[twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'])
[docs] def list(self, limit=None, page_size=None): """ Lists DependentPhoneNumberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param int limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param int page_size: Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000) :returns: Generator that will yield up to limit results :rtype: list[twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberInstance] """ return list(self.stream(limit=limit, page_size=page_size, ))
[docs] def page(self, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of DependentPhoneNumberInstance records from the API. Request is executed immediately :param str page_token: PageToken provided by the API :param int page_number: Page Number, this value is simply for client state :param int page_size: Number of records to return, defaults to 50 :returns: Page of DependentPhoneNumberInstance :rtype: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return DependentPhoneNumberPage(self._version, response, self._solution)
[docs] def get_page(self, target_url): """ Retrieve a specific page of DependentPhoneNumberInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of DependentPhoneNumberInstance :rtype: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return DependentPhoneNumberPage(self._version, response, self._solution)
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Api.V2010.DependentPhoneNumberList>'
[docs]class DependentPhoneNumberPage(Page): def __init__(self, version, response, solution): """ Initialize the DependentPhoneNumberPage :param Version version: Version that contains the resource :param Response response: Response from the API :param account_sid: The SID of the Account that created the resource :param address_sid: The unique string that identifies the resource :returns: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberPage :rtype: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberPage """ super(DependentPhoneNumberPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of DependentPhoneNumberInstance :param dict payload: Payload response from the API :returns: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberInstance :rtype: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberInstance """ return DependentPhoneNumberInstance( self._version, payload, account_sid=self._solution['account_sid'], address_sid=self._solution['address_sid'], )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Api.V2010.DependentPhoneNumberPage>'
[docs]class DependentPhoneNumberInstance(InstanceResource):
[docs] class AddressRequirement(object): NONE = "none" ANY = "any" LOCAL = "local" FOREIGN = "foreign"
[docs] class EmergencyStatus(object): ACTIVE = "Active" INACTIVE = "Inactive"
def __init__(self, version, payload, account_sid, address_sid): """ Initialize the DependentPhoneNumberInstance :returns: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberInstance :rtype: twilio.rest.api.v2010.account.address.dependent_phone_number.DependentPhoneNumberInstance """ super(DependentPhoneNumberInstance, self).__init__(version) # Marshaled Properties self._properties = { 'sid': payload.get('sid'), 'account_sid': payload.get('account_sid'), 'friendly_name': payload.get('friendly_name'), 'phone_number': payload.get('phone_number'), 'voice_url': payload.get('voice_url'), 'voice_method': payload.get('voice_method'), 'voice_fallback_method': payload.get('voice_fallback_method'), 'voice_fallback_url': payload.get('voice_fallback_url'), 'voice_caller_id_lookup': payload.get('voice_caller_id_lookup'), 'date_created': deserialize.rfc2822_datetime(payload.get('date_created')), 'date_updated': deserialize.rfc2822_datetime(payload.get('date_updated')), 'sms_fallback_method': payload.get('sms_fallback_method'), 'sms_fallback_url': payload.get('sms_fallback_url'), 'sms_method': payload.get('sms_method'), 'sms_url': payload.get('sms_url'), 'address_requirements': payload.get('address_requirements'), 'capabilities': payload.get('capabilities'), 'status_callback': payload.get('status_callback'), 'status_callback_method': payload.get('status_callback_method'), 'api_version': payload.get('api_version'), 'sms_application_sid': payload.get('sms_application_sid'), 'voice_application_sid': payload.get('voice_application_sid'), 'trunk_sid': payload.get('trunk_sid'), 'emergency_status': payload.get('emergency_status'), 'emergency_address_sid': payload.get('emergency_address_sid'), 'uri': payload.get('uri'), } # Context self._context = None self._solution = {'account_sid': account_sid, 'address_sid': address_sid, } @property def sid(self): """ :returns: The unique string that identifies the resource :rtype: unicode """ return self._properties['sid'] @property def account_sid(self): """ :returns: The SID of the Account that created the resource :rtype: unicode """ return self._properties['account_sid'] @property def friendly_name(self): """ :returns: The string that you assigned to describe the resource :rtype: unicode """ return self._properties['friendly_name'] @property def phone_number(self): """ :returns: The phone number in E.164 format :rtype: unicode """ return self._properties['phone_number'] @property def voice_url(self): """ :returns: The URL we call when the phone number receives a call :rtype: unicode """ return self._properties['voice_url'] @property def voice_method(self): """ :returns: The HTTP method used with the voice_url :rtype: unicode """ return self._properties['voice_method'] @property def voice_fallback_method(self): """ :returns: The HTTP method used with voice_fallback_url :rtype: unicode """ return self._properties['voice_fallback_method'] @property def voice_fallback_url(self): """ :returns: The URL we call when an error occurs in TwiML :rtype: unicode """ return self._properties['voice_fallback_url'] @property def voice_caller_id_lookup(self): """ :returns: Whether to lookup the caller's name :rtype: bool """ return self._properties['voice_caller_id_lookup'] @property def date_created(self): """ :returns: The RFC 2822 date and time in GMT that the resource was created :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The RFC 2822 date and time in GMT that the resource was last updated :rtype: datetime """ return self._properties['date_updated'] @property def sms_fallback_method(self): """ :returns: The HTTP method used with sms_fallback_url :rtype: unicode """ return self._properties['sms_fallback_method'] @property def sms_fallback_url(self): """ :returns: The URL that we call when an error occurs while retrieving or executing the TwiML :rtype: unicode """ return self._properties['sms_fallback_url'] @property def sms_method(self): """ :returns: The HTTP method to use with sms_url :rtype: unicode """ return self._properties['sms_method'] @property def sms_url(self): """ :returns: The URL we call when the phone number receives an incoming SMS message :rtype: unicode """ return self._properties['sms_url'] @property def address_requirements(self): """ :returns: Whether the phone number requires an Address registered with Twilio :rtype: DependentPhoneNumberInstance.AddressRequirement """ return self._properties['address_requirements'] @property def capabilities(self): """ :returns: Indicate if a phone can receive calls or messages :rtype: dict """ return self._properties['capabilities'] @property def status_callback(self): """ :returns: The URL to send status information to your application :rtype: unicode """ return self._properties['status_callback'] @property def status_callback_method(self): """ :returns: The HTTP method we use to call status_callback :rtype: unicode """ return self._properties['status_callback_method'] @property def api_version(self): """ :returns: The API version used to start a new TwiML session :rtype: unicode """ return self._properties['api_version'] @property def sms_application_sid(self): """ :returns: The SID of the application that handles SMS messages sent to the phone number :rtype: unicode """ return self._properties['sms_application_sid'] @property def voice_application_sid(self): """ :returns: The SID of the application that handles calls to the phone number :rtype: unicode """ return self._properties['voice_application_sid'] @property def trunk_sid(self): """ :returns: The SID of the Trunk that handles calls to the phone number :rtype: unicode """ return self._properties['trunk_sid'] @property def emergency_status(self): """ :returns: Whether the phone number is enabled for emergency calling :rtype: DependentPhoneNumberInstance.EmergencyStatus """ return self._properties['emergency_status'] @property def emergency_address_sid(self): """ :returns: The emergency address configuration to use for emergency calling :rtype: unicode """ return self._properties['emergency_address_sid'] @property def uri(self): """ :returns: The URI of the resource, relative to `https://api.twilio.com` :rtype: unicode """ return self._properties['uri'] def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Api.V2010.DependentPhoneNumberInstance>'