# coding=utf-8 """ This code was generated by \ / _ _ _| _ _ | (_)\/(_)(_|\/| |(/_ v1.0.0 / / """ from twilio.base import deserialize from twilio.base import serialize 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 class MemberList(ListResource): """ """ def __init__(self, version, service_sid, channel_sid): """ Initialize the MemberList :param Version version: Version that contains the resource :param service_sid: The unique id of the Service this member belongs to. :param channel_sid: The unique id of the Channel for this member. :returns: twilio.rest.chat.v2.service.channel.member.MemberList :rtype: twilio.rest.chat.v2.service.channel.member.MemberList """ super(MemberList, self).__init__(version) # Path Solution self._solution = {'service_sid': service_sid, 'channel_sid': channel_sid, } self._uri = '/Services/{service_sid}/Channels/{channel_sid}/Members'.format(**self._solution) def create(self, identity, role_sid=values.unset, last_consumed_message_index=values.unset, last_consumption_timestamp=values.unset, date_created=values.unset, date_updated=values.unset): """ Create a new MemberInstance :param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. :param unicode role_sid: The role to be assigned to this member. Defaults to the roles specified on the Service. :param unicode last_consumed_message_index: Field used to specify the last consumed Message index for the Channel for this Member. Should only be used when recreating a Member from a backup/separate source. :param datetime last_consumption_timestamp: ISO8601 time indicating the last datetime the Member consumed a Message in the Channel. Should only be used when recreating a Member from a backup/separate source :param datetime date_created: The ISO8601 time specifying the datetime the Members should be set as being created. Will be set to the current time by the Chat service if not specified. Note that this should only be used in cases where a Member is being recreated from a backup/separate source :param datetime date_updated: The ISO8601 time specifying the datetime the Member should be set as having been last updated. Will be set to the null by the Chat service if not specified. Note that this should only be used in cases where a Member is being recreated from a backup/separate source and where a Member was previously updated. :returns: Newly created MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ data = values.of({ 'Identity': identity, 'RoleSid': role_sid, 'LastConsumedMessageIndex': last_consumed_message_index, 'LastConsumptionTimestamp': serialize.iso8601_datetime(last_consumption_timestamp), 'DateCreated': serialize.iso8601_datetime(date_created), 'DateUpdated': serialize.iso8601_datetime(date_updated), }) payload = self._version.create( 'POST', self._uri, data=data, ) return MemberInstance( self._version, payload, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], ) def stream(self, identity=values.unset, limit=None, page_size=None): """ Streams MemberInstance 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 identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. :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.chat.v2.service.channel.member.MemberInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(identity=identity, page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'], limits['page_limit']) def list(self, identity=values.unset, limit=None, page_size=None): """ Lists MemberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. :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.chat.v2.service.channel.member.MemberInstance] """ return list(self.stream(identity=identity, limit=limit, page_size=page_size, )) def page(self, identity=values.unset, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of MemberInstance records from the API. Request is executed immediately :param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. :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 MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberPage """ params = values.of({ 'Identity': serialize.map(identity, lambda e: e), 'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page( 'GET', self._uri, params=params, ) return MemberPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of MemberInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return MemberPage(self._version, response, self._solution) def get(self, sid): """ Constructs a MemberContext :param sid: Key that uniquely defines the member to fetch. :returns: twilio.rest.chat.v2.service.channel.member.MemberContext :rtype: twilio.rest.chat.v2.service.channel.member.MemberContext """ return MemberContext( self._version, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], sid=sid, ) def __call__(self, sid): """ Constructs a MemberContext :param sid: Key that uniquely defines the member to fetch. :returns: twilio.rest.chat.v2.service.channel.member.MemberContext :rtype: twilio.rest.chat.v2.service.channel.member.MemberContext """ return MemberContext( self._version, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class MemberPage(Page): """ """ def __init__(self, version, response, solution): """ Initialize the MemberPage :param Version version: Version that contains the resource :param Response response: Response from the API :param service_sid: The unique id of the Service this member belongs to. :param channel_sid: The unique id of the Channel for this member. :returns: twilio.rest.chat.v2.service.channel.member.MemberPage :rtype: twilio.rest.chat.v2.service.channel.member.MemberPage """ super(MemberPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of MemberInstance :param dict payload: Payload response from the API :returns: twilio.rest.chat.v2.service.channel.member.MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ return MemberInstance( self._version, payload, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class MemberContext(InstanceContext): """ """ def __init__(self, version, service_sid, channel_sid, sid): """ Initialize the MemberContext :param Version version: Version that contains the resource :param service_sid: Sid of the Service this member belongs to. :param channel_sid: Key that uniquely defines the channel this member belongs to. :param sid: Key that uniquely defines the member to fetch. :returns: twilio.rest.chat.v2.service.channel.member.MemberContext :rtype: twilio.rest.chat.v2.service.channel.member.MemberContext """ super(MemberContext, self).__init__(version) # Path Solution self._solution = {'service_sid': service_sid, 'channel_sid': channel_sid, 'sid': sid, } self._uri = '/Services/{service_sid}/Channels/{channel_sid}/Members/{sid}'.format(**self._solution) def fetch(self): """ Fetch a MemberInstance :returns: Fetched MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ params = values.of({}) payload = self._version.fetch( 'GET', self._uri, params=params, ) return MemberInstance( self._version, payload, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], sid=self._solution['sid'], ) def delete(self): """ Deletes the MemberInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._version.delete('delete', self._uri) def update(self, role_sid=values.unset, last_consumed_message_index=values.unset, last_consumption_timestamp=values.unset, date_created=values.unset, date_updated=values.unset): """ Update the MemberInstance :param unicode role_sid: The role to be assigned to this member. :param unicode last_consumed_message_index: Field used to specify the last consumed Message index for the Channel for this Member. :param datetime last_consumption_timestamp: ISO8601 time indicating the last datetime the Member consumed a Message in the Channel. :param datetime date_created: The ISO8601 time specifying the datetime the Members should be set as being created. :param datetime date_updated: The ISO8601 time specifying the datetime the Member should be set as having been last updated. :returns: Updated MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ data = values.of({ 'RoleSid': role_sid, 'LastConsumedMessageIndex': last_consumed_message_index, 'LastConsumptionTimestamp': serialize.iso8601_datetime(last_consumption_timestamp), 'DateCreated': serialize.iso8601_datetime(date_created), 'DateUpdated': serialize.iso8601_datetime(date_updated), }) payload = self._version.update( 'POST', self._uri, data=data, ) return MemberInstance( self._version, payload, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], sid=self._solution['sid'], ) 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 ''.format(context) class MemberInstance(InstanceResource): """ """ class WebhookEnabledType(object): TRUE = "true" FALSE = "false" def __init__(self, version, payload, service_sid, channel_sid, sid=None): """ Initialize the MemberInstance :returns: twilio.rest.chat.v2.service.channel.member.MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ super(MemberInstance, self).__init__(version) # Marshaled Properties self._properties = { 'sid': payload['sid'], 'account_sid': payload['account_sid'], 'channel_sid': payload['channel_sid'], 'service_sid': payload['service_sid'], 'identity': payload['identity'], 'date_created': deserialize.iso8601_datetime(payload['date_created']), 'date_updated': deserialize.iso8601_datetime(payload['date_updated']), 'role_sid': payload['role_sid'], 'last_consumed_message_index': deserialize.integer(payload['last_consumed_message_index']), 'last_consumption_timestamp': deserialize.iso8601_datetime(payload['last_consumption_timestamp']), 'url': payload['url'], } # Context self._context = None self._solution = { 'service_sid': service_sid, 'channel_sid': channel_sid, '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: MemberContext for this MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberContext """ if self._context is None: self._context = MemberContext( self._version, service_sid=self._solution['service_sid'], channel_sid=self._solution['channel_sid'], sid=self._solution['sid'], ) return self._context @property def sid(self): """ :returns: A 34 character string that uniquely identifies this resource. :rtype: unicode """ return self._properties['sid'] @property def account_sid(self): """ :returns: The unique id of the Account responsible for this member. :rtype: unicode """ return self._properties['account_sid'] @property def channel_sid(self): """ :returns: The unique id of the Channel for this member. :rtype: unicode """ return self._properties['channel_sid'] @property def service_sid(self): """ :returns: The unique id of the Service this member belongs to. :rtype: unicode """ return self._properties['service_sid'] @property def identity(self): """ :returns: A unique string identifier for this User in this Service. :rtype: unicode """ return self._properties['identity'] @property def date_created(self): """ :returns: The date that this resource was created. :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The date that this resource was last updated. :rtype: datetime """ return self._properties['date_updated'] @property def role_sid(self): """ :returns: The Role assigned to this member. :rtype: unicode """ return self._properties['role_sid'] @property def last_consumed_message_index(self): """ :returns: An Integer representing index of the last Message this Member has read within this Channel :rtype: unicode """ return self._properties['last_consumed_message_index'] @property def last_consumption_timestamp(self): """ :returns: An ISO8601 based timestamp string representing the datetime of the last Message read event for this Member within this Channel :rtype: datetime """ return self._properties['last_consumption_timestamp'] @property def url(self): """ :returns: An absolute URL for this member. :rtype: unicode """ return self._properties['url'] def fetch(self): """ Fetch a MemberInstance :returns: Fetched MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ return self._proxy.fetch() def delete(self): """ Deletes the MemberInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._proxy.delete() def update(self, role_sid=values.unset, last_consumed_message_index=values.unset, last_consumption_timestamp=values.unset, date_created=values.unset, date_updated=values.unset): """ Update the MemberInstance :param unicode role_sid: The role to be assigned to this member. :param unicode last_consumed_message_index: Field used to specify the last consumed Message index for the Channel for this Member. :param datetime last_consumption_timestamp: ISO8601 time indicating the last datetime the Member consumed a Message in the Channel. :param datetime date_created: The ISO8601 time specifying the datetime the Members should be set as being created. :param datetime date_updated: The ISO8601 time specifying the datetime the Member should be set as having been last updated. :returns: Updated MemberInstance :rtype: twilio.rest.chat.v2.service.channel.member.MemberInstance """ return self._proxy.update( role_sid=role_sid, last_consumed_message_index=last_consumed_message_index, last_consumption_timestamp=last_consumption_timestamp, date_created=date_created, date_updated=date_updated, ) 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 ''.format(context)