Source code for twilio.rest.conversations.v1.service.configuration

# coding=utf-8
r"""
This code was generated by
\ / _    _  _|   _  _
 | (_)\/(_)(_|\/| |(/_  v1.0.0
      /       /
"""

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.configuration.notification import NotificationList
from twilio.rest.conversations.v1.service.configuration.webhook import WebhookList


[docs]class ConfigurationList(ListResource): def __init__(self, version, chat_service_sid): """ Initialize the ConfigurationList :param Version version: Version that contains the resource :param chat_service_sid: The unique string that identifies the resource :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationList :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationList """ super(ConfigurationList, self).__init__(version) # Path Solution self._solution = {'chat_service_sid': chat_service_sid, } # Components self._notifications = None self._webhooks = None @property def notifications(self): """ Access the notifications :returns: twilio.rest.conversations.v1.service.configuration.notification.NotificationList :rtype: twilio.rest.conversations.v1.service.configuration.notification.NotificationList """ if self._notifications is None: self._notifications = NotificationList( self._version, chat_service_sid=self._solution['chat_service_sid'], ) return self._notifications @property def webhooks(self): """ Access the webhooks :returns: twilio.rest.conversations.v1.service.configuration.webhook.WebhookList :rtype: twilio.rest.conversations.v1.service.configuration.webhook.WebhookList """ if self._webhooks is None: self._webhooks = WebhookList(self._version, chat_service_sid=self._solution['chat_service_sid'], ) return self._webhooks
[docs] def get(self): """ Constructs a ConfigurationContext :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationContext :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationContext """ return ConfigurationContext(self._version, chat_service_sid=self._solution['chat_service_sid'], )
def __call__(self): """ Constructs a ConfigurationContext :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationContext :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationContext """ return ConfigurationContext(self._version, 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.ConfigurationList>'
[docs]class ConfigurationPage(Page): def __init__(self, version, response, solution): """ Initialize the ConfigurationPage :param Version version: Version that contains the resource :param Response response: Response from the API :param chat_service_sid: The unique string that identifies the resource :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationPage :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationPage """ super(ConfigurationPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of ConfigurationInstance :param dict payload: Payload response from the API :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance """ return ConfigurationInstance( 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.ConfigurationPage>'
[docs]class ConfigurationContext(InstanceContext): def __init__(self, version, chat_service_sid): """ Initialize the ConfigurationContext :param Version version: Version that contains the resource :param chat_service_sid: The SID of the Service configuration resource to fetch :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationContext :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationContext """ super(ConfigurationContext, self).__init__(version) # Path Solution self._solution = {'chat_service_sid': chat_service_sid, } self._uri = '/Services/{chat_service_sid}/Configuration'.format(**self._solution)
[docs] def fetch(self): """ Fetch the ConfigurationInstance :returns: The fetched ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return ConfigurationInstance( self._version, payload, chat_service_sid=self._solution['chat_service_sid'], )
[docs] def update(self, default_conversation_creator_role_sid=values.unset, default_conversation_role_sid=values.unset, default_chat_service_role_sid=values.unset, reachability_enabled=values.unset): """ Update the ConfigurationInstance :param unicode default_conversation_creator_role_sid: The role assigned to a conversation creator when they join a new conversation :param unicode default_conversation_role_sid: The role assigned to users when they are added to a conversation :param unicode default_chat_service_role_sid: The service role assigned to users when they are added to the service :param bool reachability_enabled: Whether the Reachability Indicator feature is enabled for this Conversations Service :returns: The updated ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance """ data = values.of({ 'DefaultConversationCreatorRoleSid': default_conversation_creator_role_sid, 'DefaultConversationRoleSid': default_conversation_role_sid, 'DefaultChatServiceRoleSid': default_chat_service_role_sid, 'ReachabilityEnabled': reachability_enabled, }) payload = self._version.update(method='POST', uri=self._uri, data=data, ) return ConfigurationInstance( self._version, payload, chat_service_sid=self._solution['chat_service_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.ConfigurationContext {}>'.format(context)
[docs]class ConfigurationInstance(InstanceResource): def __init__(self, version, payload, chat_service_sid): """ Initialize the ConfigurationInstance :returns: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance """ super(ConfigurationInstance, self).__init__(version) # Marshaled Properties self._properties = { 'chat_service_sid': payload.get('chat_service_sid'), 'default_conversation_creator_role_sid': payload.get('default_conversation_creator_role_sid'), 'default_conversation_role_sid': payload.get('default_conversation_role_sid'), 'default_chat_service_role_sid': payload.get('default_chat_service_role_sid'), 'url': payload.get('url'), 'links': payload.get('links'), 'reachability_enabled': payload.get('reachability_enabled'), } # Context self._context = None self._solution = {'chat_service_sid': chat_service_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: ConfigurationContext for this ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationContext """ if self._context is None: self._context = ConfigurationContext( self._version, chat_service_sid=self._solution['chat_service_sid'], ) return self._context @property def chat_service_sid(self): """ :returns: The unique string that identifies the resource :rtype: unicode """ return self._properties['chat_service_sid'] @property def default_conversation_creator_role_sid(self): """ :returns: The role assigned to a conversation creator user when they join a new conversation :rtype: unicode """ return self._properties['default_conversation_creator_role_sid'] @property def default_conversation_role_sid(self): """ :returns: The role assigned to users when they are added to a conversation :rtype: unicode """ return self._properties['default_conversation_role_sid'] @property def default_chat_service_role_sid(self): """ :returns: The service role assigned to users when they are added to the service :rtype: unicode """ return self._properties['default_chat_service_role_sid'] @property def url(self): """ :returns: An absolute URL for this service configuration. :rtype: unicode """ return self._properties['url'] @property def links(self): """ :returns: Absolute URL to access the push notifications configuration of this service. :rtype: unicode """ return self._properties['links'] @property def reachability_enabled(self): """ :returns: Whether the Reachability Indicator feature is enabled for this Conversations Service :rtype: bool """ return self._properties['reachability_enabled']
[docs] def fetch(self): """ Fetch the ConfigurationInstance :returns: The fetched ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance """ return self._proxy.fetch()
[docs] def update(self, default_conversation_creator_role_sid=values.unset, default_conversation_role_sid=values.unset, default_chat_service_role_sid=values.unset, reachability_enabled=values.unset): """ Update the ConfigurationInstance :param unicode default_conversation_creator_role_sid: The role assigned to a conversation creator when they join a new conversation :param unicode default_conversation_role_sid: The role assigned to users when they are added to a conversation :param unicode default_chat_service_role_sid: The service role assigned to users when they are added to the service :param bool reachability_enabled: Whether the Reachability Indicator feature is enabled for this Conversations Service :returns: The updated ConfigurationInstance :rtype: twilio.rest.conversations.v1.service.configuration.ConfigurationInstance """ return self._proxy.update( default_conversation_creator_role_sid=default_conversation_creator_role_sid, default_conversation_role_sid=default_conversation_role_sid, default_chat_service_role_sid=default_chat_service_role_sid, reachability_enabled=reachability_enabled, )
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.ConfigurationInstance {}>'.format(context)