Source code for twilio.rest.content.v1.content

# 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_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
from twilio.rest.content.v1.content.approval_fetch import ApprovalFetchList


[docs]class ContentList(ListResource): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version): """ Initialize the ContentList :param Version version: Version that contains the resource :returns: twilio.rest.content.v1.content.ContentList :rtype: twilio.rest.content.v1.content.ContentList """ super(ContentList, self).__init__(version) # Path Solution self._solution = {} self._uri = '/Content'.format(**self._solution)
[docs] def stream(self, limit=None, page_size=None): """ Streams ContentInstance 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.content.v1.content.ContentInstance] """ 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 ContentInstance 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.content.v1.content.ContentInstance] """ 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 ContentInstance 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 ContentInstance :rtype: twilio.rest.content.v1.content.ContentPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return ContentPage(self._version, response, self._solution)
[docs] def get_page(self, target_url): """ Retrieve a specific page of ContentInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of ContentInstance :rtype: twilio.rest.content.v1.content.ContentPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return ContentPage(self._version, response, self._solution)
[docs] def get(self, sid): """ Constructs a ContentContext :param sid: The unique string that identifies the resource :returns: twilio.rest.content.v1.content.ContentContext :rtype: twilio.rest.content.v1.content.ContentContext """ return ContentContext(self._version, sid=sid, )
def __call__(self, sid): """ Constructs a ContentContext :param sid: The unique string that identifies the resource :returns: twilio.rest.content.v1.content.ContentContext :rtype: twilio.rest.content.v1.content.ContentContext """ return ContentContext(self._version, sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Content.V1.ContentList>'
[docs]class ContentPage(Page): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version, response, solution): """ Initialize the ContentPage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.content.v1.content.ContentPage :rtype: twilio.rest.content.v1.content.ContentPage """ super(ContentPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of ContentInstance :param dict payload: Payload response from the API :returns: twilio.rest.content.v1.content.ContentInstance :rtype: twilio.rest.content.v1.content.ContentInstance """ return ContentInstance(self._version, payload, )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Content.V1.ContentPage>'
[docs]class ContentContext(InstanceContext): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version, sid): """ Initialize the ContentContext :param Version version: Version that contains the resource :param sid: The unique string that identifies the resource :returns: twilio.rest.content.v1.content.ContentContext :rtype: twilio.rest.content.v1.content.ContentContext """ super(ContentContext, self).__init__(version) # Path Solution self._solution = {'sid': sid, } self._uri = '/Content/{sid}'.format(**self._solution) # Dependents self._approval_fetch = None
[docs] def fetch(self): """ Fetch the ContentInstance :returns: The fetched ContentInstance :rtype: twilio.rest.content.v1.content.ContentInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return ContentInstance(self._version, payload, sid=self._solution['sid'], )
[docs] def delete(self): """ Deletes the ContentInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._version.delete(method='DELETE', uri=self._uri, )
@property def approval_fetch(self): """ Access the approval_fetch :returns: twilio.rest.content.v1.content.approval_fetch.ApprovalFetchList :rtype: twilio.rest.content.v1.content.approval_fetch.ApprovalFetchList """ if self._approval_fetch is None: self._approval_fetch = ApprovalFetchList(self._version, sid=self._solution['sid'], ) return self._approval_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.Content.V1.ContentContext {}>'.format(context)
[docs]class ContentInstance(InstanceResource): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version, payload, sid=None): """ Initialize the ContentInstance :returns: twilio.rest.content.v1.content.ContentInstance :rtype: twilio.rest.content.v1.content.ContentInstance """ super(ContentInstance, self).__init__(version) # Marshaled Properties self._properties = { 'date_created': deserialize.iso8601_datetime(payload.get('date_created')), 'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')), 'sid': payload.get('sid'), 'account_sid': payload.get('account_sid'), 'friendly_name': payload.get('friendly_name'), 'language': payload.get('language'), 'variables': payload.get('variables'), 'types': payload.get('types'), 'url': payload.get('url'), 'links': payload.get('links'), } # Context self._context = None self._solution = {'sid': sid or self._properties['sid'], } @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: ContentContext for this ContentInstance :rtype: twilio.rest.content.v1.content.ContentContext """ if self._context is None: self._context = ContentContext(self._version, sid=self._solution['sid'], ) return self._context @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 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: A string name used to describe the Content resource :rtype: unicode """ return self._properties['friendly_name'] @property def language(self): """ :returns: Two-letter language code identifying the language the Content resource is in. :rtype: unicode """ return self._properties['language'] @property def variables(self): """ :returns: Defines the default placeholder values for variables included in the Content resource :rtype: dict """ return self._properties['variables'] @property def types(self): """ :returns: The Content types (e.g. twilio/text) for this Content resource :rtype: dict """ return self._properties['types'] @property def url(self): """ :returns: The URL of the resource, relative to `https://content.twilio.com` :rtype: unicode """ return self._properties['url'] @property def links(self): """ :returns: A list of links related to the Content resource :rtype: unicode """ return self._properties['links']
[docs] def fetch(self): """ Fetch the ContentInstance :returns: The fetched ContentInstance :rtype: twilio.rest.content.v1.content.ContentInstance """ return self._proxy.fetch()
[docs] def delete(self): """ Deletes the ContentInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._proxy.delete()
@property def approval_fetch(self): """ Access the approval_fetch :returns: twilio.rest.content.v1.content.approval_fetch.ApprovalFetchList :rtype: twilio.rest.content.v1.content.approval_fetch.ApprovalFetchList """ return self._proxy.approval_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.Content.V1.ContentInstance {}>'.format(context)