Source code for twilio.rest.ip_messaging.v1.service.user.user_channel

# 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 UserChannelList(ListResource): def __init__(self, version, service_sid, user_sid): """ Initialize the UserChannelList :param Version version: Version that contains the resource :param service_sid: The service_sid :param user_sid: The sid :returns: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelList :rtype: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelList """ super(UserChannelList, self).__init__(version) # Path Solution self._solution = {'service_sid': service_sid, 'user_sid': user_sid, } self._uri = '/Services/{service_sid}/Users/{user_sid}/Channels'.format(**self._solution)
[docs] def stream(self, limit=None, page_size=None): """ Streams UserChannelInstance 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.ip_messaging.v1.service.user.user_channel.UserChannelInstance] """ 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 UserChannelInstance 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.ip_messaging.v1.service.user.user_channel.UserChannelInstance] """ 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 UserChannelInstance 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 UserChannelInstance :rtype: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return UserChannelPage(self._version, response, self._solution)
[docs] def get_page(self, target_url): """ Retrieve a specific page of UserChannelInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of UserChannelInstance :rtype: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return UserChannelPage(self._version, response, self._solution)
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.IpMessaging.V1.UserChannelList>'
[docs]class UserChannelPage(Page): def __init__(self, version, response, solution): """ Initialize the UserChannelPage :param Version version: Version that contains the resource :param Response response: Response from the API :param service_sid: The service_sid :param user_sid: The sid :returns: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelPage :rtype: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelPage """ super(UserChannelPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of UserChannelInstance :param dict payload: Payload response from the API :returns: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelInstance :rtype: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelInstance """ return UserChannelInstance( self._version, payload, service_sid=self._solution['service_sid'], user_sid=self._solution['user_sid'], )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.IpMessaging.V1.UserChannelPage>'
[docs]class UserChannelInstance(InstanceResource):
[docs] class ChannelStatus(object): JOINED = "joined" INVITED = "invited" NOT_PARTICIPATING = "not_participating"
def __init__(self, version, payload, service_sid, user_sid): """ Initialize the UserChannelInstance :returns: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelInstance :rtype: twilio.rest.ip_messaging.v1.service.user.user_channel.UserChannelInstance """ super(UserChannelInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload.get('account_sid'), 'service_sid': payload.get('service_sid'), 'channel_sid': payload.get('channel_sid'), 'member_sid': payload.get('member_sid'), 'status': payload.get('status'), 'last_consumed_message_index': deserialize.integer(payload.get('last_consumed_message_index')), 'unread_messages_count': deserialize.integer(payload.get('unread_messages_count')), 'links': payload.get('links'), } # Context self._context = None self._solution = {'service_sid': service_sid, 'user_sid': user_sid, } @property def account_sid(self): """ :returns: The account_sid :rtype: unicode """ return self._properties['account_sid'] @property def service_sid(self): """ :returns: The service_sid :rtype: unicode """ return self._properties['service_sid'] @property def channel_sid(self): """ :returns: The channel_sid :rtype: unicode """ return self._properties['channel_sid'] @property def member_sid(self): """ :returns: The member_sid :rtype: unicode """ return self._properties['member_sid'] @property def status(self): """ :returns: The status :rtype: UserChannelInstance.ChannelStatus """ return self._properties['status'] @property def last_consumed_message_index(self): """ :returns: The last_consumed_message_index :rtype: unicode """ return self._properties['last_consumed_message_index'] @property def unread_messages_count(self): """ :returns: The unread_messages_count :rtype: unicode """ return self._properties['unread_messages_count'] @property def links(self): """ :returns: The links :rtype: unicode """ return self._properties['links'] def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.IpMessaging.V1.UserChannelInstance>'