Source code for twilio.rest.pricing.v1.voice.country

# 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 CountryList(ListResource): def __init__(self, version): """ Initialize the CountryList :param Version version: Version that contains the resource :returns: twilio.rest.pricing.v1.voice.country.CountryList :rtype: twilio.rest.pricing.v1.voice.country.CountryList """ super(CountryList, self).__init__(version) # Path Solution self._solution = {} self._uri = '/Voice/Countries'.format(**self._solution)
[docs] def stream(self, limit=None, page_size=None): """ Streams CountryInstance 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.pricing.v1.voice.country.CountryInstance] """ 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 CountryInstance 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.pricing.v1.voice.country.CountryInstance] """ 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 CountryInstance 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 CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return CountryPage(self._version, response, self._solution)
[docs] def get_page(self, target_url): """ Retrieve a specific page of CountryInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return CountryPage(self._version, response, self._solution)
[docs] def get(self, iso_country): """ Constructs a CountryContext :param iso_country: The ISO country code :returns: twilio.rest.pricing.v1.voice.country.CountryContext :rtype: twilio.rest.pricing.v1.voice.country.CountryContext """ return CountryContext(self._version, iso_country=iso_country, )
def __call__(self, iso_country): """ Constructs a CountryContext :param iso_country: The ISO country code :returns: twilio.rest.pricing.v1.voice.country.CountryContext :rtype: twilio.rest.pricing.v1.voice.country.CountryContext """ return CountryContext(self._version, iso_country=iso_country, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Pricing.V1.CountryList>'
[docs]class CountryPage(Page): def __init__(self, version, response, solution): """ Initialize the CountryPage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.pricing.v1.voice.country.CountryPage :rtype: twilio.rest.pricing.v1.voice.country.CountryPage """ super(CountryPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of CountryInstance :param dict payload: Payload response from the API :returns: twilio.rest.pricing.v1.voice.country.CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryInstance """ return CountryInstance(self._version, payload, )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Pricing.V1.CountryPage>'
[docs]class CountryContext(InstanceContext): def __init__(self, version, iso_country): """ Initialize the CountryContext :param Version version: Version that contains the resource :param iso_country: The ISO country code :returns: twilio.rest.pricing.v1.voice.country.CountryContext :rtype: twilio.rest.pricing.v1.voice.country.CountryContext """ super(CountryContext, self).__init__(version) # Path Solution self._solution = {'iso_country': iso_country, } self._uri = '/Voice/Countries/{iso_country}'.format(**self._solution)
[docs] def fetch(self): """ Fetch the CountryInstance :returns: The fetched CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return CountryInstance(self._version, payload, iso_country=self._solution['iso_country'], )
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.Pricing.V1.CountryContext {}>'.format(context)
[docs]class CountryInstance(InstanceResource): def __init__(self, version, payload, iso_country=None): """ Initialize the CountryInstance :returns: twilio.rest.pricing.v1.voice.country.CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryInstance """ super(CountryInstance, self).__init__(version) # Marshaled Properties self._properties = { 'country': payload.get('country'), 'iso_country': payload.get('iso_country'), 'outbound_prefix_prices': payload.get('outbound_prefix_prices'), 'inbound_call_prices': payload.get('inbound_call_prices'), 'price_unit': payload.get('price_unit'), 'url': payload.get('url'), } # Context self._context = None self._solution = {'iso_country': iso_country or self._properties['iso_country'], } @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: CountryContext for this CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryContext """ if self._context is None: self._context = CountryContext(self._version, iso_country=self._solution['iso_country'], ) return self._context @property def country(self): """ :returns: The name of the country :rtype: unicode """ return self._properties['country'] @property def iso_country(self): """ :returns: The ISO country code :rtype: unicode """ return self._properties['iso_country'] @property def outbound_prefix_prices(self): """ :returns: The list of OutboundPrefixPrice records :rtype: list[unicode] """ return self._properties['outbound_prefix_prices'] @property def inbound_call_prices(self): """ :returns: The list of InboundCallPrice records :rtype: list[unicode] """ return self._properties['inbound_call_prices'] @property def price_unit(self): """ :returns: The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy) :rtype: unicode """ return self._properties['price_unit'] @property def url(self): """ :returns: The absolute URL of the resource :rtype: unicode """ return self._properties['url']
[docs] def fetch(self): """ Fetch the CountryInstance :returns: The fetched CountryInstance :rtype: twilio.rest.pricing.v1.voice.country.CountryInstance """ return self._proxy.fetch()
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.Pricing.V1.CountryInstance {}>'.format(context)