# coding=utf-8
r"""
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
[docs]class ParticipantList(ListResource):
def __init__(self, version, conversation_sid):
"""
Initialize the ParticipantList
:param Version version: Version that contains the resource
:param conversation_sid: The unique ID of the Conversation for this participant.
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantList
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantList
"""
super(ParticipantList, self).__init__(version)
# Path Solution
self._solution = {'conversation_sid': conversation_sid, }
self._uri = '/Conversations/{conversation_sid}/Participants'.format(**self._solution)
[docs] def create(self, identity=values.unset, messaging_binding_address=values.unset,
messaging_binding_proxy_address=values.unset,
date_created=values.unset, date_updated=values.unset,
attributes=values.unset,
messaging_binding_projected_address=values.unset,
role_sid=values.unset, x_twilio_webhook_enabled=values.unset):
"""
Create the ParticipantInstance
:param unicode identity: A unique string identifier for the conversation participant as Conversation User.
:param unicode messaging_binding_address: The address of the participant's device.
:param unicode messaging_binding_proxy_address: The address of the Twilio phone number that the participant is in contact with.
:param datetime date_created: The date that this resource was created.
:param datetime date_updated: The date that this resource was last updated.
:param unicode attributes: An optional string metadata field you can use to store any data you wish.
:param unicode messaging_binding_projected_address: The address of the Twilio phone number that is used in Group MMS.
:param unicode role_sid: The SID of a conversation-level Role to assign to the participant
:param ParticipantInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: The created ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
data = values.of({
'Identity': identity,
'MessagingBinding.Address': messaging_binding_address,
'MessagingBinding.ProxyAddress': messaging_binding_proxy_address,
'DateCreated': serialize.iso8601_datetime(date_created),
'DateUpdated': serialize.iso8601_datetime(date_updated),
'Attributes': attributes,
'MessagingBinding.ProjectedAddress': messaging_binding_projected_address,
'RoleSid': role_sid,
})
headers = values.of({'X-Twilio-Webhook-Enabled': x_twilio_webhook_enabled, })
payload = self._version.create(method='POST', uri=self._uri, data=data, headers=headers, )
return ParticipantInstance(
self._version,
payload,
conversation_sid=self._solution['conversation_sid'],
)
[docs] def stream(self, limit=None, page_size=None):
"""
Streams ParticipantInstance 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.conversations.v1.conversation.participant.ParticipantInstance]
"""
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 ParticipantInstance 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.conversations.v1.conversation.participant.ParticipantInstance]
"""
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 ParticipantInstance 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 ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantPage
"""
data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, })
response = self._version.page(method='GET', uri=self._uri, params=data, )
return ParticipantPage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of ParticipantInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return ParticipantPage(self._version, response, self._solution)
[docs] def get(self, sid):
"""
Constructs a ParticipantContext
:param sid: A 34 character string that uniquely identifies this resource.
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
"""
return ParticipantContext(
self._version,
conversation_sid=self._solution['conversation_sid'],
sid=sid,
)
def __call__(self, sid):
"""
Constructs a ParticipantContext
:param sid: A 34 character string that uniquely identifies this resource.
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
"""
return ParticipantContext(
self._version,
conversation_sid=self._solution['conversation_sid'],
sid=sid,
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Conversations.V1.ParticipantList>'
[docs]class ParticipantPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the ParticipantPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param conversation_sid: The unique ID of the Conversation for this participant.
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantPage
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantPage
"""
super(ParticipantPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of ParticipantInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
return ParticipantInstance(
self._version,
payload,
conversation_sid=self._solution['conversation_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Conversations.V1.ParticipantPage>'
[docs]class ParticipantContext(InstanceContext):
def __init__(self, version, conversation_sid, sid):
"""
Initialize the ParticipantContext
:param Version version: Version that contains the resource
:param conversation_sid: The unique ID of the Conversation for this participant.
:param sid: A 34 character string that uniquely identifies this resource.
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
"""
super(ParticipantContext, self).__init__(version)
# Path Solution
self._solution = {'conversation_sid': conversation_sid, 'sid': sid, }
self._uri = '/Conversations/{conversation_sid}/Participants/{sid}'.format(**self._solution)
[docs] def update(self, date_created=values.unset, date_updated=values.unset,
attributes=values.unset, role_sid=values.unset,
messaging_binding_proxy_address=values.unset,
messaging_binding_projected_address=values.unset,
identity=values.unset, last_read_message_index=values.unset,
last_read_timestamp=values.unset,
x_twilio_webhook_enabled=values.unset):
"""
Update the ParticipantInstance
:param datetime date_created: The date that this resource was created.
:param datetime date_updated: The date that this resource was last updated.
:param unicode attributes: An optional string metadata field you can use to store any data you wish.
:param unicode role_sid: The SID of a conversation-level Role to assign to the participant
:param unicode messaging_binding_proxy_address: The address of the Twilio phone number that the participant is in contact with.
:param unicode messaging_binding_projected_address: The address of the Twilio phone number that is used in Group MMS.
:param unicode identity: A unique string identifier for the conversation participant as Conversation User.
:param unicode last_read_message_index: Index of last “read” message in the Conversation for the Participant.
:param unicode last_read_timestamp: Timestamp of last “read” message in the Conversation for the Participant.
:param ParticipantInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: The updated ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
data = values.of({
'DateCreated': serialize.iso8601_datetime(date_created),
'DateUpdated': serialize.iso8601_datetime(date_updated),
'Attributes': attributes,
'RoleSid': role_sid,
'MessagingBinding.ProxyAddress': messaging_binding_proxy_address,
'MessagingBinding.ProjectedAddress': messaging_binding_projected_address,
'Identity': identity,
'LastReadMessageIndex': last_read_message_index,
'LastReadTimestamp': last_read_timestamp,
})
headers = values.of({'X-Twilio-Webhook-Enabled': x_twilio_webhook_enabled, })
payload = self._version.update(method='POST', uri=self._uri, data=data, headers=headers, )
return ParticipantInstance(
self._version,
payload,
conversation_sid=self._solution['conversation_sid'],
sid=self._solution['sid'],
)
[docs] def delete(self, x_twilio_webhook_enabled=values.unset):
"""
Deletes the ParticipantInstance
:param ParticipantInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
headers = values.of({'X-Twilio-Webhook-Enabled': x_twilio_webhook_enabled, })
return self._version.delete(method='DELETE', uri=self._uri, headers=headers, )
[docs] def fetch(self):
"""
Fetch the ParticipantInstance
:returns: The fetched ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return ParticipantInstance(
self._version,
payload,
conversation_sid=self._solution['conversation_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 '<Twilio.Conversations.V1.ParticipantContext {}>'.format(context)
[docs]class ParticipantInstance(InstanceResource):
[docs] class WebhookEnabledType(object):
TRUE = "true"
FALSE = "false"
def __init__(self, version, payload, conversation_sid, sid=None):
"""
Initialize the ParticipantInstance
:returns: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
super(ParticipantInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'conversation_sid': payload.get('conversation_sid'),
'sid': payload.get('sid'),
'identity': payload.get('identity'),
'attributes': payload.get('attributes'),
'messaging_binding': payload.get('messaging_binding'),
'role_sid': payload.get('role_sid'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
'url': payload.get('url'),
'last_read_message_index': deserialize.integer(payload.get('last_read_message_index')),
'last_read_timestamp': payload.get('last_read_timestamp'),
}
# Context
self._context = None
self._solution = {'conversation_sid': conversation_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: ParticipantContext for this ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantContext
"""
if self._context is None:
self._context = ParticipantContext(
self._version,
conversation_sid=self._solution['conversation_sid'],
sid=self._solution['sid'],
)
return self._context
@property
def account_sid(self):
"""
:returns: The unique ID of the Account responsible for this participant.
:rtype: unicode
"""
return self._properties['account_sid']
@property
def conversation_sid(self):
"""
:returns: The unique ID of the Conversation for this participant.
:rtype: unicode
"""
return self._properties['conversation_sid']
@property
def sid(self):
"""
:returns: A 34 character string that uniquely identifies this resource.
:rtype: unicode
"""
return self._properties['sid']
@property
def identity(self):
"""
:returns: A unique string identifier for the conversation participant as Conversation User.
:rtype: unicode
"""
return self._properties['identity']
@property
def attributes(self):
"""
:returns: An optional string metadata field you can use to store any data you wish.
:rtype: unicode
"""
return self._properties['attributes']
@property
def messaging_binding(self):
"""
:returns: Information about how this participant exchanges messages with the conversation.
:rtype: dict
"""
return self._properties['messaging_binding']
@property
def role_sid(self):
"""
:returns: The SID of a conversation-level Role to assign to the participant
:rtype: unicode
"""
return self._properties['role_sid']
@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 url(self):
"""
:returns: An absolute URL for this participant.
:rtype: unicode
"""
return self._properties['url']
@property
def last_read_message_index(self):
"""
:returns: Index of last “read” message in the Conversation for the Participant.
:rtype: unicode
"""
return self._properties['last_read_message_index']
@property
def last_read_timestamp(self):
"""
:returns: Timestamp of last “read” message in the Conversation for the Participant.
:rtype: unicode
"""
return self._properties['last_read_timestamp']
[docs] def update(self, date_created=values.unset, date_updated=values.unset,
attributes=values.unset, role_sid=values.unset,
messaging_binding_proxy_address=values.unset,
messaging_binding_projected_address=values.unset,
identity=values.unset, last_read_message_index=values.unset,
last_read_timestamp=values.unset,
x_twilio_webhook_enabled=values.unset):
"""
Update the ParticipantInstance
:param datetime date_created: The date that this resource was created.
:param datetime date_updated: The date that this resource was last updated.
:param unicode attributes: An optional string metadata field you can use to store any data you wish.
:param unicode role_sid: The SID of a conversation-level Role to assign to the participant
:param unicode messaging_binding_proxy_address: The address of the Twilio phone number that the participant is in contact with.
:param unicode messaging_binding_projected_address: The address of the Twilio phone number that is used in Group MMS.
:param unicode identity: A unique string identifier for the conversation participant as Conversation User.
:param unicode last_read_message_index: Index of last “read” message in the Conversation for the Participant.
:param unicode last_read_timestamp: Timestamp of last “read” message in the Conversation for the Participant.
:param ParticipantInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: The updated ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
return self._proxy.update(
date_created=date_created,
date_updated=date_updated,
attributes=attributes,
role_sid=role_sid,
messaging_binding_proxy_address=messaging_binding_proxy_address,
messaging_binding_projected_address=messaging_binding_projected_address,
identity=identity,
last_read_message_index=last_read_message_index,
last_read_timestamp=last_read_timestamp,
x_twilio_webhook_enabled=x_twilio_webhook_enabled,
)
[docs] def delete(self, x_twilio_webhook_enabled=values.unset):
"""
Deletes the ParticipantInstance
:param ParticipantInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete(x_twilio_webhook_enabled=x_twilio_webhook_enabled, )
[docs] def fetch(self):
"""
Fetch the ParticipantInstance
:returns: The fetched ParticipantInstance
:rtype: twilio.rest.conversations.v1.conversation.participant.ParticipantInstance
"""
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.Conversations.V1.ParticipantInstance {}>'.format(context)