# 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.conversations.v1.service.user.user_conversation import UserConversationList
[docs]class UserList(ListResource):
def __init__(self, version, chat_service_sid):
"""
Initialize the UserList
:param Version version: Version that contains the resource
:param chat_service_sid: The SID of the Conversation Service that the resource is associated with
:returns: twilio.rest.conversations.v1.service.user.UserList
:rtype: twilio.rest.conversations.v1.service.user.UserList
"""
super(UserList, self).__init__(version)
# Path Solution
self._solution = {'chat_service_sid': chat_service_sid, }
self._uri = '/Services/{chat_service_sid}/Users'.format(**self._solution)
[docs] def create(self, identity, friendly_name=values.unset, attributes=values.unset,
role_sid=values.unset, x_twilio_webhook_enabled=values.unset):
"""
Create the UserInstance
:param unicode identity: The string that identifies the resource's User
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode attributes: The JSON Object string that stores application-specific data
:param unicode role_sid: The SID of a service-level Role to assign to the user
:param UserInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: The created UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
data = values.of({
'Identity': identity,
'FriendlyName': friendly_name,
'Attributes': attributes,
'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 UserInstance(self._version, payload, chat_service_sid=self._solution['chat_service_sid'], )
[docs] def stream(self, limit=None, page_size=None):
"""
Streams UserInstance 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.service.user.UserInstance]
"""
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 UserInstance 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.service.user.UserInstance]
"""
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 UserInstance 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 UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserPage
"""
data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, })
response = self._version.page(method='GET', uri=self._uri, params=data, )
return UserPage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of UserInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserPage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return UserPage(self._version, response, self._solution)
[docs] def get(self, sid):
"""
Constructs a UserContext
:param sid: The SID of the User resource to fetch
:returns: twilio.rest.conversations.v1.service.user.UserContext
:rtype: twilio.rest.conversations.v1.service.user.UserContext
"""
return UserContext(self._version, chat_service_sid=self._solution['chat_service_sid'], sid=sid, )
def __call__(self, sid):
"""
Constructs a UserContext
:param sid: The SID of the User resource to fetch
:returns: twilio.rest.conversations.v1.service.user.UserContext
:rtype: twilio.rest.conversations.v1.service.user.UserContext
"""
return UserContext(self._version, chat_service_sid=self._solution['chat_service_sid'], sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Conversations.V1.UserList>'
[docs]class UserPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the UserPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param chat_service_sid: The SID of the Conversation Service that the resource is associated with
:returns: twilio.rest.conversations.v1.service.user.UserPage
:rtype: twilio.rest.conversations.v1.service.user.UserPage
"""
super(UserPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of UserInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.conversations.v1.service.user.UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
return UserInstance(self._version, payload, chat_service_sid=self._solution['chat_service_sid'], )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Conversations.V1.UserPage>'
[docs]class UserContext(InstanceContext):
def __init__(self, version, chat_service_sid, sid):
"""
Initialize the UserContext
:param Version version: Version that contains the resource
:param chat_service_sid: The SID of the Conversation Service to fetch the resource from
:param sid: The SID of the User resource to fetch
:returns: twilio.rest.conversations.v1.service.user.UserContext
:rtype: twilio.rest.conversations.v1.service.user.UserContext
"""
super(UserContext, self).__init__(version)
# Path Solution
self._solution = {'chat_service_sid': chat_service_sid, 'sid': sid, }
self._uri = '/Services/{chat_service_sid}/Users/{sid}'.format(**self._solution)
# Dependents
self._user_conversations = None
[docs] def update(self, friendly_name=values.unset, attributes=values.unset,
role_sid=values.unset, x_twilio_webhook_enabled=values.unset):
"""
Update the UserInstance
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode attributes: The JSON Object string that stores application-specific data
:param unicode role_sid: The SID of a service-level Role to assign to the user
:param UserInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: The updated UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
data = values.of({'FriendlyName': friendly_name, 'Attributes': attributes, 'RoleSid': role_sid, })
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 UserInstance(
self._version,
payload,
chat_service_sid=self._solution['chat_service_sid'],
sid=self._solution['sid'],
)
[docs] def delete(self, x_twilio_webhook_enabled=values.unset):
"""
Deletes the UserInstance
:param UserInstance.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 UserInstance
:returns: The fetched UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return UserInstance(
self._version,
payload,
chat_service_sid=self._solution['chat_service_sid'],
sid=self._solution['sid'],
)
@property
def user_conversations(self):
"""
Access the user_conversations
:returns: twilio.rest.conversations.v1.service.user.user_conversation.UserConversationList
:rtype: twilio.rest.conversations.v1.service.user.user_conversation.UserConversationList
"""
if self._user_conversations is None:
self._user_conversations = UserConversationList(
self._version,
chat_service_sid=self._solution['chat_service_sid'],
user_sid=self._solution['sid'],
)
return self._user_conversations
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.UserContext {}>'.format(context)
[docs]class UserInstance(InstanceResource):
[docs] class WebhookEnabledType(object):
TRUE = "true"
FALSE = "false"
def __init__(self, version, payload, chat_service_sid, sid=None):
"""
Initialize the UserInstance
:returns: twilio.rest.conversations.v1.service.user.UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
super(UserInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'account_sid': payload.get('account_sid'),
'chat_service_sid': payload.get('chat_service_sid'),
'role_sid': payload.get('role_sid'),
'identity': payload.get('identity'),
'friendly_name': payload.get('friendly_name'),
'attributes': payload.get('attributes'),
'is_online': payload.get('is_online'),
'is_notifiable': payload.get('is_notifiable'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
'url': payload.get('url'),
'links': payload.get('links'),
}
# Context
self._context = None
self._solution = {'chat_service_sid': chat_service_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: UserContext for this UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserContext
"""
if self._context is None:
self._context = UserContext(
self._version,
chat_service_sid=self._solution['chat_service_sid'],
sid=self._solution['sid'],
)
return self._context
@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 chat_service_sid(self):
"""
:returns: The SID of the Conversation Service that the resource is associated with
:rtype: unicode
"""
return self._properties['chat_service_sid']
@property
def role_sid(self):
"""
:returns: The SID of a service-level Role assigned to the user
:rtype: unicode
"""
return self._properties['role_sid']
@property
def identity(self):
"""
:returns: The string that identifies the resource's User
:rtype: unicode
"""
return self._properties['identity']
@property
def friendly_name(self):
"""
:returns: The string that you assigned to describe the resource
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def attributes(self):
"""
:returns: The JSON Object string that stores application-specific data
:rtype: unicode
"""
return self._properties['attributes']
@property
def is_online(self):
"""
:returns: Whether the User is actively connected to this Conversations Service and online
:rtype: bool
"""
return self._properties['is_online']
@property
def is_notifiable(self):
"""
:returns: Whether the User has a potentially valid Push Notification registration for this Conversations Service
:rtype: bool
"""
return self._properties['is_notifiable']
@property
def date_created(self):
"""
:returns: The ISO 8601 date and time in GMT when the resource was created
:rtype: datetime
"""
return self._properties['date_created']
@property
def date_updated(self):
"""
:returns: The ISO 8601 date and time in GMT when the resource was last updated
:rtype: datetime
"""
return self._properties['date_updated']
@property
def url(self):
"""
:returns: An absolute URL for this user.
:rtype: unicode
"""
return self._properties['url']
@property
def links(self):
"""
:returns: The links
:rtype: unicode
"""
return self._properties['links']
[docs] def update(self, friendly_name=values.unset, attributes=values.unset,
role_sid=values.unset, x_twilio_webhook_enabled=values.unset):
"""
Update the UserInstance
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode attributes: The JSON Object string that stores application-specific data
:param unicode role_sid: The SID of a service-level Role to assign to the user
:param UserInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header
:returns: The updated UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
attributes=attributes,
role_sid=role_sid,
x_twilio_webhook_enabled=x_twilio_webhook_enabled,
)
[docs] def delete(self, x_twilio_webhook_enabled=values.unset):
"""
Deletes the UserInstance
:param UserInstance.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 UserInstance
:returns: The fetched UserInstance
:rtype: twilio.rest.conversations.v1.service.user.UserInstance
"""
return self._proxy.fetch()
@property
def user_conversations(self):
"""
Access the user_conversations
:returns: twilio.rest.conversations.v1.service.user.user_conversation.UserConversationList
:rtype: twilio.rest.conversations.v1.service.user.user_conversation.UserConversationList
"""
return self._proxy.user_conversations
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.UserInstance {}>'.format(context)