Source code for twilio.rest.events.v1.event_type

# 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


[docs]class EventTypeList(ListResource): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version): """ Initialize the EventTypeList :param Version version: Version that contains the resource :returns: twilio.rest.events.v1.event_type.EventTypeList :rtype: twilio.rest.events.v1.event_type.EventTypeList """ super(EventTypeList, self).__init__(version) # Path Solution self._solution = {} self._uri = '/Types'.format(**self._solution)
[docs] def stream(self, schema_id=values.unset, limit=None, page_size=None): """ Streams EventTypeInstance 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 unicode schema_id: A string to filter Event Types by schema. :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.events.v1.event_type.EventTypeInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(schema_id=schema_id, page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'])
[docs] def list(self, schema_id=values.unset, limit=None, page_size=None): """ Lists EventTypeInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param unicode schema_id: A string to filter Event Types by schema. :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.events.v1.event_type.EventTypeInstance] """ return list(self.stream(schema_id=schema_id, limit=limit, page_size=page_size, ))
[docs] def page(self, schema_id=values.unset, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of EventTypeInstance records from the API. Request is executed immediately :param unicode schema_id: A string to filter Event Types by schema. :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 EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypePage """ data = values.of({ 'SchemaId': schema_id, 'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return EventTypePage(self._version, response, self._solution)
[docs] def get_page(self, target_url): """ Retrieve a specific page of EventTypeInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypePage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return EventTypePage(self._version, response, self._solution)
[docs] def get(self, type): """ Constructs a EventTypeContext :param type: A string that uniquely identifies this Event Type. :returns: twilio.rest.events.v1.event_type.EventTypeContext :rtype: twilio.rest.events.v1.event_type.EventTypeContext """ return EventTypeContext(self._version, type=type, )
def __call__(self, type): """ Constructs a EventTypeContext :param type: A string that uniquely identifies this Event Type. :returns: twilio.rest.events.v1.event_type.EventTypeContext :rtype: twilio.rest.events.v1.event_type.EventTypeContext """ return EventTypeContext(self._version, type=type, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Events.V1.EventTypeList>'
[docs]class EventTypePage(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 EventTypePage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.events.v1.event_type.EventTypePage :rtype: twilio.rest.events.v1.event_type.EventTypePage """ super(EventTypePage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of EventTypeInstance :param dict payload: Payload response from the API :returns: twilio.rest.events.v1.event_type.EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypeInstance """ return EventTypeInstance(self._version, payload, )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Events.V1.EventTypePage>'
[docs]class EventTypeContext(InstanceContext): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version, type): """ Initialize the EventTypeContext :param Version version: Version that contains the resource :param type: A string that uniquely identifies this Event Type. :returns: twilio.rest.events.v1.event_type.EventTypeContext :rtype: twilio.rest.events.v1.event_type.EventTypeContext """ super(EventTypeContext, self).__init__(version) # Path Solution self._solution = {'type': type, } self._uri = '/Types/{type}'.format(**self._solution)
[docs] def fetch(self): """ Fetch the EventTypeInstance :returns: The fetched EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypeInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return EventTypeInstance(self._version, payload, type=self._solution['type'], )
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.Events.V1.EventTypeContext {}>'.format(context)
[docs]class EventTypeInstance(InstanceResource): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version, payload, type=None): """ Initialize the EventTypeInstance :returns: twilio.rest.events.v1.event_type.EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypeInstance """ super(EventTypeInstance, self).__init__(version) # Marshaled Properties self._properties = { 'type': payload.get('type'), 'schema_id': payload.get('schema_id'), 'date_created': deserialize.iso8601_datetime(payload.get('date_created')), 'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')), 'description': payload.get('description'), 'url': payload.get('url'), 'links': payload.get('links'), } # Context self._context = None self._solution = {'type': type or self._properties['type'], } @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: EventTypeContext for this EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypeContext """ if self._context is None: self._context = EventTypeContext(self._version, type=self._solution['type'], ) return self._context @property def type(self): """ :returns: The Event Type identifier. :rtype: unicode """ return self._properties['type'] @property def schema_id(self): """ :returns: The Schema identifier for this Event Type. :rtype: unicode """ return self._properties['schema_id'] @property def date_created(self): """ :returns: The date this Event Type was created. :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The date this Event Type was updated. :rtype: datetime """ return self._properties['date_updated'] @property def description(self): """ :returns: Event Type description. :rtype: unicode """ return self._properties['description'] @property def url(self): """ :returns: The URL of this resource. :rtype: unicode """ return self._properties['url'] @property def links(self): """ :returns: The links :rtype: unicode """ return self._properties['links']
[docs] def fetch(self): """ Fetch the EventTypeInstance :returns: The fetched EventTypeInstance :rtype: twilio.rest.events.v1.event_type.EventTypeInstance """ 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.Events.V1.EventTypeInstance {}>'.format(context)