twilio.rest.conversations.v1.configuration package

Submodules

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

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/conversations/v1/configuration/webhook.py:docstring of twilio.rest.conversations.v1.configuration.webhook, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.conversations.v1.configuration.webhook.WebhookContext(version)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the WebhookInstance

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

Update the WebhookInstance

Parameters:
  • method (unicode) – The HTTP method to be used when sending a webhook request.
  • filters (list[unicode]) – The list of webhook event triggers that are enabled for this Service.
  • 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.
  • target (WebhookInstance.Target) – The routing target of the webhook.
Returns:

The updated WebhookInstance

Return type:

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

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

Bases: twilio.base.instance_resource.InstanceResource

class Method[source]

Bases: object

GET = 'GET'
POST = 'POST'
class Target[source]

Bases: object

FLEX = 'flex'
WEBHOOK = 'webhook'
account_sid
Returns:The unique ID of the Account responsible for this conversation.
Return type:unicode
fetch()[source]

Fetch the WebhookInstance

Returns:The fetched WebhookInstance
Return type:twilio.rest.conversations.v1.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
target
Returns:The routing target of the webhook.
Return type:WebhookInstance.Target
update(method=<object object>, filters=<object object>, pre_webhook_url=<object object>, post_webhook_url=<object object>, target=<object object>)[source]

Update the WebhookInstance

Parameters:
  • method (unicode) – The HTTP method to be used when sending a webhook request.
  • filters (list[unicode]) – The list of webhook event triggers that are enabled for this Service.
  • 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.
  • target (WebhookInstance.Target) – The routing target of the webhook.
Returns:

The updated WebhookInstance

Return type:

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

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

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a WebhookContext

Returns:twilio.rest.conversations.v1.configuration.webhook.WebhookContext
Return type:twilio.rest.conversations.v1.configuration.webhook.WebhookContext
class twilio.rest.conversations.v1.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.configuration.webhook.WebhookInstance
Return type:twilio.rest.conversations.v1.configuration.webhook.WebhookInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/conversations/v1/configuration/__init__.py:docstring of twilio.rest.conversations.v1.configuration, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.conversations.v1.configuration.ConfigurationContext(version)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the ConfigurationInstance

Returns:The fetched ConfigurationInstance
Return type:twilio.rest.conversations.v1.configuration.ConfigurationInstance
update(default_chat_service_sid=<object object>, default_messaging_service_sid=<object object>, default_inactive_timer=<object object>, default_closed_timer=<object object>)[source]

Update the ConfigurationInstance

Parameters:
  • default_chat_service_sid (unicode) – The SID of the default Conversation Service that every new conversation will be associated with.
  • default_messaging_service_sid (unicode) – The SID of the default Messaging Service that every new conversation will be associated with.
  • default_inactive_timer (unicode) – Default ISO8601 duration when conversation will be switched to inactive state.
  • default_closed_timer (unicode) – Default ISO8601 duration when conversation will be switched to closed state.
Returns:

The updated ConfigurationInstance

Return type:

twilio.rest.conversations.v1.configuration.ConfigurationInstance

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

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account responsible for this configuration.
Return type:unicode
default_chat_service_sid
Returns:The SID of the default Conversation Service that every new conversation is associated with.
Return type:unicode
default_closed_timer
Returns:Default ISO8601 duration when conversation will be switched to closed state.
Return type:unicode
default_inactive_timer
Returns:Default ISO8601 duration when conversation will be switched to inactive state.
Return type:unicode
default_messaging_service_sid
Returns:The SID of the default Messaging Service that every new conversation is associated with.
Return type:unicode
fetch()[source]

Fetch the ConfigurationInstance

Returns:The fetched ConfigurationInstance
Return type:twilio.rest.conversations.v1.configuration.ConfigurationInstance
Returns:Absolute URLs to access the webhook and default service configurations.
Return type:unicode
update(default_chat_service_sid=<object object>, default_messaging_service_sid=<object object>, default_inactive_timer=<object object>, default_closed_timer=<object object>)[source]

Update the ConfigurationInstance

Parameters:
  • default_chat_service_sid (unicode) – The SID of the default Conversation Service that every new conversation will be associated with.
  • default_messaging_service_sid (unicode) – The SID of the default Messaging Service that every new conversation will be associated with.
  • default_inactive_timer (unicode) – Default ISO8601 duration when conversation will be switched to inactive state.
  • default_closed_timer (unicode) – Default ISO8601 duration when conversation will be switched to closed state.
Returns:

The updated ConfigurationInstance

Return type:

twilio.rest.conversations.v1.configuration.ConfigurationInstance

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

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a ConfigurationContext

Returns:twilio.rest.conversations.v1.configuration.ConfigurationContext
Return type:twilio.rest.conversations.v1.configuration.ConfigurationContext
webhooks

Access the webhooks

Returns:twilio.rest.conversations.v1.configuration.webhook.WebhookList
Return type:twilio.rest.conversations.v1.configuration.webhook.WebhookList
class twilio.rest.conversations.v1.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.configuration.ConfigurationInstance
Return type:twilio.rest.conversations.v1.configuration.ConfigurationInstance