twilio.rest.conversations.v1.service.configuration package

Submodules

twilio.rest.conversations.v1.service.configuration.notification module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.conversations.v1.service.configuration.notification.NotificationContext(version, chat_service_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the NotificationInstance

Returns:The fetched NotificationInstance
Return type:twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance
update(log_enabled=<object object>, new_message_enabled=<object object>, new_message_template=<object object>, new_message_sound=<object object>, new_message_badge_count_enabled=<object object>, added_to_conversation_enabled=<object object>, added_to_conversation_template=<object object>, added_to_conversation_sound=<object object>, removed_from_conversation_enabled=<object object>, removed_from_conversation_template=<object object>, removed_from_conversation_sound=<object object>, new_message_with_media_enabled=<object object>, new_message_with_media_template=<object object>)[source]

Update the NotificationInstance

Parameters:
  • log_enabled (bool) – Weather the notification logging is enabled.
  • new_message_enabled (bool) – Whether to send a notification when a new message is added to a conversation.
  • new_message_template (unicode) – The template to use to create the notification text displayed when a new message is added to a conversation.
  • new_message_sound (unicode) – The name of the sound to play when a new message is added to a conversation.
  • new_message_badge_count_enabled (bool) – Whether the new message badge is enabled.
  • added_to_conversation_enabled (bool) – Whether to send a notification when a participant is added to a conversation.
  • added_to_conversation_template (unicode) – The template to use to create the notification text displayed when a participant is added to a conversation.
  • added_to_conversation_sound (unicode) – The name of the sound to play when a participant is added to a conversation.
  • removed_from_conversation_enabled (bool) – Whether to send a notification to a user when they are removed from a conversation.
  • removed_from_conversation_template (unicode) – The template to use to create the notification text displayed to a user when they are removed.
  • removed_from_conversation_sound (unicode) – The name of the sound to play to a user when they are removed from a conversation.
  • new_message_with_media_enabled (bool) – Whether to send a notification when a new message with media/file attachments is added to a conversation.
  • new_message_with_media_template (unicode) – The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation.
Returns:

The updated NotificationInstance

Return type:

twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance

class twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance(version, payload, chat_service_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The unique ID of the Account responsible for this configuration.
Return type:unicode
added_to_conversation
Returns:The Push Notification configuration for being added to a Conversation.
Return type:dict
chat_service_sid
Returns:The SID of the Conversation Service that the Configuration applies to.
Return type:unicode
fetch()[source]

Fetch the NotificationInstance

Returns:The fetched NotificationInstance
Return type:twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance
log_enabled
Returns:Weather the notification logging is enabled.
Return type:bool
new_message
Returns:The Push Notification configuration for New Messages.
Return type:dict
removed_from_conversation
Returns:The Push Notification configuration for being removed from a Conversation.
Return type:dict
update(log_enabled=<object object>, new_message_enabled=<object object>, new_message_template=<object object>, new_message_sound=<object object>, new_message_badge_count_enabled=<object object>, added_to_conversation_enabled=<object object>, added_to_conversation_template=<object object>, added_to_conversation_sound=<object object>, removed_from_conversation_enabled=<object object>, removed_from_conversation_template=<object object>, removed_from_conversation_sound=<object object>, new_message_with_media_enabled=<object object>, new_message_with_media_template=<object object>)[source]

Update the NotificationInstance

Parameters:
  • log_enabled (bool) – Weather the notification logging is enabled.
  • new_message_enabled (bool) – Whether to send a notification when a new message is added to a conversation.
  • new_message_template (unicode) – The template to use to create the notification text displayed when a new message is added to a conversation.
  • new_message_sound (unicode) – The name of the sound to play when a new message is added to a conversation.
  • new_message_badge_count_enabled (bool) – Whether the new message badge is enabled.
  • added_to_conversation_enabled (bool) – Whether to send a notification when a participant is added to a conversation.
  • added_to_conversation_template (unicode) – The template to use to create the notification text displayed when a participant is added to a conversation.
  • added_to_conversation_sound (unicode) – The name of the sound to play when a participant is added to a conversation.
  • removed_from_conversation_enabled (bool) – Whether to send a notification to a user when they are removed from a conversation.
  • removed_from_conversation_template (unicode) – The template to use to create the notification text displayed to a user when they are removed.
  • removed_from_conversation_sound (unicode) – The name of the sound to play to a user when they are removed from a conversation.
  • new_message_with_media_enabled (bool) – Whether to send a notification when a new message with media/file attachments is added to a conversation.
  • new_message_with_media_template (unicode) – The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation.
Returns:

The updated NotificationInstance

Return type:

twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance

url
Returns:An absolute URL for this configuration.
Return type:unicode
class twilio.rest.conversations.v1.service.configuration.notification.NotificationList(version, chat_service_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a NotificationContext

Returns:twilio.rest.conversations.v1.service.configuration.notification.NotificationContext
Return type:twilio.rest.conversations.v1.service.configuration.notification.NotificationContext
class twilio.rest.conversations.v1.service.configuration.notification.NotificationPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of NotificationInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance
Return type:twilio.rest.conversations.v1.service.configuration.notification.NotificationInstance

twilio.rest.conversations.v1.service.configuration.webhook module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.conversations.v1.service.configuration.webhook.WebhookContext(version, chat_service_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the WebhookInstance

Returns:The fetched WebhookInstance
Return type:twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance
update(pre_webhook_url=<object object>, post_webhook_url=<object object>, filters=<object object>, method=<object object>)[source]

Update the WebhookInstance

Parameters:
  • pre_webhook_url (unicode) – The absolute url the pre-event webhook request should be sent to.
  • post_webhook_url (unicode) – The absolute url the post-event webhook request should be sent to.
  • filters (list[unicode]) – The list of webhook event triggers that are enabled for this Service.
  • method (unicode) – The HTTP method to be used when sending a webhook request
Returns:

The updated WebhookInstance

Return type:

twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance

class twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance(version, payload, chat_service_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Method[source]

Bases: object

GET = 'GET'
POST = 'POST'
account_sid
Returns:The unique ID of the Account responsible for this service.
Return type:unicode
chat_service_sid
Returns:The chat_service_sid
Return type:unicode
fetch()[source]

Fetch the WebhookInstance

Returns:The fetched WebhookInstance
Return type:twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance
filters
Returns:The list of webhook event triggers that are enabled for this Service.
Return type:list[unicode]
method
Returns:The HTTP method to be used when sending a webhook request
Return type:WebhookInstance.Method
post_webhook_url
Returns:The absolute url the post-event webhook request should be sent to.
Return type:unicode
pre_webhook_url
Returns:The absolute url the pre-event webhook request should be sent to.
Return type:unicode
update(pre_webhook_url=<object object>, post_webhook_url=<object object>, filters=<object object>, method=<object object>)[source]

Update the WebhookInstance

Parameters:
  • pre_webhook_url (unicode) – The absolute url the pre-event webhook request should be sent to.
  • post_webhook_url (unicode) – The absolute url the post-event webhook request should be sent to.
  • filters (list[unicode]) – The list of webhook event triggers that are enabled for this Service.
  • method (unicode) – The HTTP method to be used when sending a webhook request
Returns:

The updated WebhookInstance

Return type:

twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance

url
Returns:An absolute URL for this webhook.
Return type:unicode
class twilio.rest.conversations.v1.service.configuration.webhook.WebhookList(version, chat_service_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a WebhookContext

Returns:twilio.rest.conversations.v1.service.configuration.webhook.WebhookContext
Return type:twilio.rest.conversations.v1.service.configuration.webhook.WebhookContext
class twilio.rest.conversations.v1.service.configuration.webhook.WebhookPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WebhookInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance
Return type:twilio.rest.conversations.v1.service.configuration.webhook.WebhookInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.conversations.v1.service.configuration.ConfigurationContext(version, chat_service_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the ConfigurationInstance

Returns:The fetched ConfigurationInstance
Return type:twilio.rest.conversations.v1.service.configuration.ConfigurationInstance
update(default_conversation_creator_role_sid=<object object>, default_conversation_role_sid=<object object>, default_chat_service_role_sid=<object object>, reachability_enabled=<object object>)[source]

Update the ConfigurationInstance

Parameters:
  • default_conversation_creator_role_sid (unicode) – The role assigned to a conversation creator when they join a new conversation
  • default_conversation_role_sid (unicode) – The role assigned to users when they are added to a conversation
  • default_chat_service_role_sid (unicode) – The service role assigned to users when they are added to the service
  • reachability_enabled (bool) – Whether the Reachability Indicator feature is enabled for this Conversations Service
Returns:

The updated ConfigurationInstance

Return type:

twilio.rest.conversations.v1.service.configuration.ConfigurationInstance

class twilio.rest.conversations.v1.service.configuration.ConfigurationInstance(version, payload, chat_service_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

chat_service_sid
Returns:The unique string that identifies the resource
Return type:unicode
default_chat_service_role_sid
Returns:The service role assigned to users when they are added to the service
Return type:unicode
default_conversation_creator_role_sid
Returns:The role assigned to a conversation creator user when they join a new conversation
Return type:unicode
default_conversation_role_sid
Returns:The role assigned to users when they are added to a conversation
Return type:unicode
fetch()[source]

Fetch the ConfigurationInstance

Returns:The fetched ConfigurationInstance
Return type:twilio.rest.conversations.v1.service.configuration.ConfigurationInstance
Returns:Absolute URL to access the push notifications configuration of this service.
Return type:unicode
reachability_enabled
Returns:Whether the Reachability Indicator feature is enabled for this Conversations Service
Return type:bool
update(default_conversation_creator_role_sid=<object object>, default_conversation_role_sid=<object object>, default_chat_service_role_sid=<object object>, reachability_enabled=<object object>)[source]

Update the ConfigurationInstance

Parameters:
  • default_conversation_creator_role_sid (unicode) – The role assigned to a conversation creator when they join a new conversation
  • default_conversation_role_sid (unicode) – The role assigned to users when they are added to a conversation
  • default_chat_service_role_sid (unicode) – The service role assigned to users when they are added to the service
  • reachability_enabled (bool) – Whether the Reachability Indicator feature is enabled for this Conversations Service
Returns:

The updated ConfigurationInstance

Return type:

twilio.rest.conversations.v1.service.configuration.ConfigurationInstance

url
Returns:An absolute URL for this service configuration.
Return type:unicode
class twilio.rest.conversations.v1.service.configuration.ConfigurationList(version, chat_service_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a ConfigurationContext

Returns:twilio.rest.conversations.v1.service.configuration.ConfigurationContext
Return type:twilio.rest.conversations.v1.service.configuration.ConfigurationContext
notifications

Access the notifications

Returns:twilio.rest.conversations.v1.service.configuration.notification.NotificationList
Return type:twilio.rest.conversations.v1.service.configuration.notification.NotificationList
webhooks

Access the webhooks

Returns:twilio.rest.conversations.v1.service.configuration.webhook.WebhookList
Return type:twilio.rest.conversations.v1.service.configuration.webhook.WebhookList
class twilio.rest.conversations.v1.service.configuration.ConfigurationPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ConfigurationInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.conversations.v1.service.configuration.ConfigurationInstance
Return type:twilio.rest.conversations.v1.service.configuration.ConfigurationInstance