twilio.rest.flex_api.v1 package¶
Submodules¶
twilio.rest.flex_api.v1.channel module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.channel.
ChannelContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the ChannelInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the ChannelInstance
Returns: The fetched ChannelInstance Return type: twilio.rest.flex_api.v1.channel.ChannelInstance
-
-
class
twilio.rest.flex_api.v1.channel.
ChannelInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource and owns this Workflow Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the Flex chat channel was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the Flex chat channel was last updated Return type: datetime
-
delete
()[source]¶ Deletes the ChannelInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the ChannelInstance
Returns: The fetched ChannelInstance Return type: twilio.rest.flex_api.v1.channel.ChannelInstance
-
flex_flow_sid
¶ Returns: The SID of the Flex Flow Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
task_sid
¶ Returns: The SID of the TaskRouter Task Return type: unicode
-
url
¶ Returns: The absolute URL of the Flex chat channel resource Return type: unicode
-
user_sid
¶ Returns: The SID of the chat user Return type: unicode
-
-
class
twilio.rest.flex_api.v1.channel.
ChannelList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(flex_flow_sid, identity, chat_user_friendly_name, chat_friendly_name, target=<object object>, chat_unique_name=<object object>, pre_engagement_data=<object object>, task_sid=<object object>, task_attributes=<object object>, long_lived=<object object>)[source]¶ Create the ChannelInstance
Parameters: - flex_flow_sid (unicode) – The SID of the Flex Flow
- identity (unicode) – The identity value that identifies the new resource’s chat User
- chat_user_friendly_name (unicode) – The chat participant’s friendly name
- chat_friendly_name (unicode) – The chat channel’s friendly name
- target (unicode) – The Target Contact Identity
- chat_unique_name (unicode) – The chat channel’s unique name
- pre_engagement_data (unicode) – The pre-engagement data
- task_sid (unicode) – The SID of the TaskRouter Task
- task_attributes (unicode) – The Task attributes to be added for the TaskRouter Task
- long_lived (bool) – Whether to create the channel as long-lived
Returns: The created ChannelInstance
Return type:
-
get
(sid)[source]¶ Constructs a ChannelContext
Parameters: sid – The SID that identifies the Flex chat channel resource to fetch Returns: twilio.rest.flex_api.v1.channel.ChannelContext Return type: twilio.rest.flex_api.v1.channel.ChannelContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of ChannelInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of ChannelInstance Return type: twilio.rest.flex_api.v1.channel.ChannelPage
-
list
(limit=None, page_size=None)[source]¶ Lists ChannelInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – 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
Return type:
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of ChannelInstance records from the API. Request is executed immediately
Parameters: Returns: Page of ChannelInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams ChannelInstance 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.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – 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
Return type:
-
-
class
twilio.rest.flex_api.v1.channel.
ChannelPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of ChannelInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.flex_api.v1.channel.ChannelInstance Return type: twilio.rest.flex_api.v1.channel.ChannelInstance
-
twilio.rest.flex_api.v1.configuration module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.configuration.
ConfigurationContext
(version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
create
()[source]¶ Create the ConfigurationInstance
Returns: The created ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
fetch
(ui_version=<object object>)[source]¶ Fetch the ConfigurationInstance
Parameters: ui_version (unicode) – The Pinned UI version of the Configuration resource to fetch Returns: The fetched ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
update
()[source]¶ Update the ConfigurationInstance
Returns: The updated ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
-
class
twilio.rest.flex_api.v1.configuration.
ConfigurationInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Status
[source]¶ Bases:
object
-
INPROGRESS
= 'inprogress'¶
-
NOTSTARTED
= 'notstarted'¶
-
OK
= 'ok'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
call_recording_webhook_url
¶ Returns: The call recording webhook URL Return type: unicode
-
channel_configs
¶ Returns: Flex Conversations channels’ attachments configurations Return type: list[dict]
-
chat_service_instance_sid
¶ Returns: The SID of the chat service this user belongs to Return type: unicode
-
create
()[source]¶ Create the ConfigurationInstance
Returns: The created ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
crm_callback_url
¶ Returns: The CRM Callback URL Return type: unicode
-
crm_fallback_url
¶ Returns: The CRM Fallback URL Return type: unicode
-
crm_type
¶ Returns: The CRM Type Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the Configuration resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the Configuration resource was last updated Return type: datetime
-
fetch
(ui_version=<object object>)[source]¶ Fetch the ConfigurationInstance
Parameters: ui_version (unicode) – The Pinned UI version of the Configuration resource to fetch Returns: The fetched ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
flex_service_instance_sid
¶ Returns: The SID of the Flex service instance Return type: unicode
-
flex_url
¶ Returns: URL to redirect to in case drilldown is enabled. Return type: unicode
-
integrations
¶ Returns: A list of objects that contain the configurations for the Integrations supported in this configuration Return type: list[dict]
-
messaging_service_instance_sid
¶ Returns: The SID of the Messaging service instance Return type: unicode
-
runtime_domain
¶ Returns: The URL where the Flex instance is hosted Return type: unicode
-
service_version
¶ Returns: The Flex Service version Return type: unicode
-
status
¶ Returns: The status of the Flex onboarding Return type: ConfigurationInstance.Status
-
taskrouter_offline_activity_sid
¶ Returns: The TaskRouter SID of the offline activity Return type: unicode
-
taskrouter_target_taskqueue_sid
¶ Returns: The SID of the TaskRouter Target TaskQueue Return type: unicode
-
taskrouter_target_workflow_sid
¶ Returns: The SID of the TaskRouter target Workflow Return type: unicode
-
taskrouter_worker_channels
¶ Returns: The TaskRouter default channel capacities and availability for workers Return type: dict
-
taskrouter_workspace_sid
¶ Returns: The SID of the TaskRouter Workspace Return type: unicode
-
ui_attributes
¶ Returns: The object that describes Flex UI characteristics and settings Return type: dict
-
ui_dependencies
¶ Returns: The object that defines the NPM packages and versions to be used in Hosted Flex Return type: dict
-
ui_language
¶ Returns: The primary language of the Flex UI Return type: unicode
-
ui_version
¶ Returns: The Pinned UI version Return type: unicode
-
update
()[source]¶ Update the ConfigurationInstance
Returns: The updated ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
url
¶ Returns: The absolute URL of the Configuration resource Return type: unicode
-
class
-
class
twilio.rest.flex_api.v1.configuration.
ConfigurationList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a ConfigurationContext
Returns: twilio.rest.flex_api.v1.configuration.ConfigurationContext Return type: twilio.rest.flex_api.v1.configuration.ConfigurationContext
-
-
class
twilio.rest.flex_api.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.flex_api.v1.configuration.ConfigurationInstance Return type: twilio.rest.flex_api.v1.configuration.ConfigurationInstance
-
twilio.rest.flex_api.v1.flex_flow module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.flex_flow.
FlexFlowContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the FlexFlowInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FlexFlowInstance
Returns: The fetched FlexFlowInstance Return type: twilio.rest.flex_api.v1.flex_flow.FlexFlowInstance
-
update
(friendly_name=<object object>, chat_service_sid=<object object>, channel_type=<object object>, contact_identity=<object object>, enabled=<object object>, integration_type=<object object>, integration_flow_sid=<object object>, integration_url=<object object>, integration_workspace_sid=<object object>, integration_workflow_sid=<object object>, integration_channel=<object object>, integration_timeout=<object object>, integration_priority=<object object>, integration_creation_on_message=<object object>, long_lived=<object object>, janitor_enabled=<object object>, integration_retry_count=<object object>)[source]¶ Update the FlexFlowInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- chat_service_sid (unicode) – The SID of the chat service
- channel_type (FlexFlowInstance.ChannelType) – The channel type
- contact_identity (unicode) – The channel contact’s Identity
- enabled (bool) – Whether the new Flex Flow is enabled
- integration_type (FlexFlowInstance.IntegrationType) – The software that will handle inbound messages.
- integration_flow_sid (unicode) – The SID of the Studio Flow
- integration_url (unicode) – The External Webhook URL
- integration_workspace_sid (unicode) – The Workspace SID for a new Task
- integration_workflow_sid (unicode) – The Workflow SID for a new Task
- integration_channel (unicode) – The Task Channel for a new Task
- integration_timeout (unicode) – The Task timeout in seconds for a new Task
- integration_priority (unicode) – The Task priority of a new Task
- integration_creation_on_message (bool) – Whether to create a Task when the first message arrives
- long_lived (bool) – Reuse this chat channel for future interactions with a contact
- janitor_enabled (bool) – Remove active Proxy sessions if the corresponding Task is deleted
- integration_retry_count (unicode) – The number of times to retry the Studio Flow or webhook in case of failure
Returns: The updated FlexFlowInstance
Return type:
-
-
class
twilio.rest.flex_api.v1.flex_flow.
FlexFlowInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
ChannelType
[source]¶ Bases:
object
-
CUSTOM
= 'custom'¶
-
FACEBOOK
= 'facebook'¶
-
LINE
= 'line'¶
-
SMS
= 'sms'¶
-
WEB
= 'web'¶
-
WHATSAPP
= 'whatsapp'¶
-
-
class
IntegrationType
[source]¶ Bases:
object
-
EXTERNAL
= 'external'¶
-
STUDIO
= 'studio'¶
-
TASK
= 'task'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
channel_type
¶ Returns: The channel type Return type: FlexFlowInstance.ChannelType
-
chat_service_sid
¶ Returns: The SID of the chat service Return type: unicode
-
contact_identity
¶ Returns: The channel contact’s Identity Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the FlexFlowInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FlexFlowInstance
Returns: The fetched FlexFlowInstance Return type: twilio.rest.flex_api.v1.flex_flow.FlexFlowInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
integration
¶ Returns: An object that contains specific parameters for the integration Return type: dict
-
integration_type
¶ Returns: The software that will handle inbound messages. Return type: FlexFlowInstance.IntegrationType
-
janitor_enabled
¶ Returns: Remove active Proxy sessions if the corresponding Task is deleted. Return type: bool
-
long_lived
¶ Returns: Re-use this chat channel for future interactions with a contact Return type: bool
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
update
(friendly_name=<object object>, chat_service_sid=<object object>, channel_type=<object object>, contact_identity=<object object>, enabled=<object object>, integration_type=<object object>, integration_flow_sid=<object object>, integration_url=<object object>, integration_workspace_sid=<object object>, integration_workflow_sid=<object object>, integration_channel=<object object>, integration_timeout=<object object>, integration_priority=<object object>, integration_creation_on_message=<object object>, long_lived=<object object>, janitor_enabled=<object object>, integration_retry_count=<object object>)[source]¶ Update the FlexFlowInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- chat_service_sid (unicode) – The SID of the chat service
- channel_type (FlexFlowInstance.ChannelType) – The channel type
- contact_identity (unicode) – The channel contact’s Identity
- enabled (bool) – Whether the new Flex Flow is enabled
- integration_type (FlexFlowInstance.IntegrationType) – The software that will handle inbound messages.
- integration_flow_sid (unicode) – The SID of the Studio Flow
- integration_url (unicode) – The External Webhook URL
- integration_workspace_sid (unicode) – The Workspace SID for a new Task
- integration_workflow_sid (unicode) – The Workflow SID for a new Task
- integration_channel (unicode) – The Task Channel for a new Task
- integration_timeout (unicode) – The Task timeout in seconds for a new Task
- integration_priority (unicode) – The Task priority of a new Task
- integration_creation_on_message (bool) – Whether to create a Task when the first message arrives
- long_lived (bool) – Reuse this chat channel for future interactions with a contact
- janitor_enabled (bool) – Remove active Proxy sessions if the corresponding Task is deleted
- integration_retry_count (unicode) – The number of times to retry the Studio Flow or webhook in case of failure
Returns: The updated FlexFlowInstance
Return type:
-
url
¶ Returns: The absolute URL of the Flex Flow resource Return type: unicode
-
class
-
class
twilio.rest.flex_api.v1.flex_flow.
FlexFlowList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(friendly_name, chat_service_sid, channel_type, contact_identity=<object object>, enabled=<object object>, integration_type=<object object>, integration_flow_sid=<object object>, integration_url=<object object>, integration_workspace_sid=<object object>, integration_workflow_sid=<object object>, integration_channel=<object object>, integration_timeout=<object object>, integration_priority=<object object>, integration_creation_on_message=<object object>, long_lived=<object object>, janitor_enabled=<object object>, integration_retry_count=<object object>)[source]¶ Create the FlexFlowInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- chat_service_sid (unicode) – The SID of the chat service
- channel_type (FlexFlowInstance.ChannelType) – The channel type
- contact_identity (unicode) – The channel contact’s Identity
- enabled (bool) – Whether the new Flex Flow is enabled
- integration_type (FlexFlowInstance.IntegrationType) – The software that will handle inbound messages.
- integration_flow_sid (unicode) – The SID of the Studio Flow
- integration_url (unicode) – The External Webhook URL
- integration_workspace_sid (unicode) – The Workspace SID for a new Task
- integration_workflow_sid (unicode) – The Workflow SID for a new Task
- integration_channel (unicode) – The Task Channel for a new Task
- integration_timeout (unicode) – The Task timeout in seconds for a new Task
- integration_priority (unicode) – The Task priority of a new Task
- integration_creation_on_message (bool) – Whether to create a Task when the first message arrives
- long_lived (bool) – Reuse this chat channel for future interactions with a contact
- janitor_enabled (bool) – Remove active Proxy sessions if the corresponding Task is deleted
- integration_retry_count (unicode) – The number of times to retry the Studio Flow or webhook in case of failure
Returns: The created FlexFlowInstance
Return type:
-
get
(sid)[source]¶ Constructs a FlexFlowContext
Parameters: sid – The SID that identifies the resource to fetch Returns: twilio.rest.flex_api.v1.flex_flow.FlexFlowContext Return type: twilio.rest.flex_api.v1.flex_flow.FlexFlowContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of FlexFlowInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of FlexFlowInstance Return type: twilio.rest.flex_api.v1.flex_flow.FlexFlowPage
-
list
(friendly_name=<object object>, limit=None, page_size=None)[source]¶ Lists FlexFlowInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - friendly_name (unicode) – The friendly_name of the Flex Flow resources to read
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – 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
Return type:
-
page
(friendly_name=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of FlexFlowInstance records from the API. Request is executed immediately
Parameters: Returns: Page of FlexFlowInstance
Return type:
-
stream
(friendly_name=<object object>, limit=None, page_size=None)[source]¶ Streams FlexFlowInstance 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.
Parameters: - friendly_name (unicode) – The friendly_name of the Flex Flow resources to read
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – 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
Return type:
-
-
class
twilio.rest.flex_api.v1.flex_flow.
FlexFlowPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of FlexFlowInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.flex_api.v1.flex_flow.FlexFlowInstance Return type: twilio.rest.flex_api.v1.flex_flow.FlexFlowInstance
-
twilio.rest.flex_api.v1.good_data module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.good_data.
GoodDataContext
(version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
create
(token=<object object>)[source]¶ Create the GoodDataInstance
Parameters: token (unicode) – The Token HTTP request header Returns: The created GoodDataInstance Return type: twilio.rest.flex_api.v1.good_data.GoodDataInstance
-
-
class
twilio.rest.flex_api.v1.good_data.
GoodDataInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
create
(token=<object object>)[source]¶ Create the GoodDataInstance
Parameters: token (unicode) – The Token HTTP request header Returns: The created GoodDataInstance Return type: twilio.rest.flex_api.v1.good_data.GoodDataInstance
-
gd_base_url
¶ Returns: GoodData login base URL Return type: unicode
-
session_expiry
¶ Returns: The session expiry date and time Return type: unicode
-
session_id
¶ Returns: Unique session ID Return type: unicode
-
url
¶ Returns: The URL of this resource. Return type: unicode
-
workspace_id
¶ Returns: Unique workspace ID in gooddata Return type: unicode
-
-
class
twilio.rest.flex_api.v1.good_data.
GoodDataList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a GoodDataContext
Returns: twilio.rest.flex_api.v1.good_data.GoodDataContext Return type: twilio.rest.flex_api.v1.good_data.GoodDataContext
-
-
class
twilio.rest.flex_api.v1.good_data.
GoodDataPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of GoodDataInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.flex_api.v1.good_data.GoodDataInstance Return type: twilio.rest.flex_api.v1.good_data.GoodDataInstance
-
twilio.rest.flex_api.v1.user_roles module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.user_roles.
UserRolesContext
(version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
(token=<object object>)[source]¶ Fetch the UserRolesInstance
Parameters: token (unicode) – The Token HTTP request header Returns: The fetched UserRolesInstance Return type: twilio.rest.flex_api.v1.user_roles.UserRolesInstance
-
-
class
twilio.rest.flex_api.v1.user_roles.
UserRolesInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
fetch
(token=<object object>)[source]¶ Fetch the UserRolesInstance
Parameters: token (unicode) – The Token HTTP request header Returns: The fetched UserRolesInstance Return type: twilio.rest.flex_api.v1.user_roles.UserRolesInstance
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.flex_api.v1.user_roles.
UserRolesList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a UserRolesContext
Returns: twilio.rest.flex_api.v1.user_roles.UserRolesContext Return type: twilio.rest.flex_api.v1.user_roles.UserRolesContext
-
-
class
twilio.rest.flex_api.v1.user_roles.
UserRolesPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of UserRolesInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.flex_api.v1.user_roles.UserRolesInstance Return type: twilio.rest.flex_api.v1.user_roles.UserRolesInstance
-
twilio.rest.flex_api.v1.web_channel module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.web_channel.
WebChannelContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the WebChannelInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the WebChannelInstance
Returns: The fetched WebChannelInstance Return type: twilio.rest.flex_api.v1.web_channel.WebChannelInstance
-
update
(chat_status=<object object>, post_engagement_data=<object object>)[source]¶ Update the WebChannelInstance
Parameters: - chat_status (WebChannelInstance.ChatStatus) – The chat status
- post_engagement_data (unicode) – The post-engagement data
Returns: The updated WebChannelInstance
Return type:
-
-
class
twilio.rest.flex_api.v1.web_channel.
WebChannelInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource and owns this Workflow Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the WebChannelInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the WebChannelInstance
Returns: The fetched WebChannelInstance Return type: twilio.rest.flex_api.v1.web_channel.WebChannelInstance
-
flex_flow_sid
¶ Returns: The SID of the Flex Flow Return type: unicode
-
sid
¶ Returns: The unique string that identifies the WebChannel resource Return type: unicode
-
update
(chat_status=<object object>, post_engagement_data=<object object>)[source]¶ Update the WebChannelInstance
Parameters: - chat_status (WebChannelInstance.ChatStatus) – The chat status
- post_engagement_data (unicode) – The post-engagement data
Returns: The updated WebChannelInstance
Return type:
-
url
¶ Returns: The absolute URL of the WebChannel resource Return type: unicode
-
-
class
twilio.rest.flex_api.v1.web_channel.
WebChannelList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(flex_flow_sid, identity, customer_friendly_name, chat_friendly_name, chat_unique_name=<object object>, pre_engagement_data=<object object>)[source]¶ Create the WebChannelInstance
Parameters: - flex_flow_sid (unicode) – The SID of the Flex Flow
- identity (unicode) – The chat identity
- customer_friendly_name (unicode) – The chat participant’s friendly name
- chat_friendly_name (unicode) – The chat channel’s friendly name
- chat_unique_name (unicode) – The chat channel’s unique name
- pre_engagement_data (unicode) – The pre-engagement data
Returns: The created WebChannelInstance
Return type:
-
get
(sid)[source]¶ Constructs a WebChannelContext
Parameters: sid – The SID of the WebChannel resource to fetch Returns: twilio.rest.flex_api.v1.web_channel.WebChannelContext Return type: twilio.rest.flex_api.v1.web_channel.WebChannelContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of WebChannelInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of WebChannelInstance Return type: twilio.rest.flex_api.v1.web_channel.WebChannelPage
-
list
(limit=None, page_size=None)[source]¶ Lists WebChannelInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – 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
Return type: list[twilio.rest.flex_api.v1.web_channel.WebChannelInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of WebChannelInstance records from the API. Request is executed immediately
Parameters: Returns: Page of WebChannelInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams WebChannelInstance 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.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – 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
Return type: list[twilio.rest.flex_api.v1.web_channel.WebChannelInstance]
-
-
class
twilio.rest.flex_api.v1.web_channel.
WebChannelPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of WebChannelInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.flex_api.v1.web_channel.WebChannelInstance Return type: twilio.rest.flex_api.v1.web_channel.WebChannelInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.flex_api.v1.
V1
(domain)[source]¶ Bases:
twilio.base.version.Version
-
channel
¶ Return type: twilio.rest.flex_api.v1.channel.ChannelList
-
configuration
¶ Return type: twilio.rest.flex_api.v1.configuration.ConfigurationList
-
flex_flow
¶ Return type: twilio.rest.flex_api.v1.flex_flow.FlexFlowList
-
good_data
¶ Return type: twilio.rest.flex_api.v1.good_data.GoodDataList
-
interaction
¶ Return type: twilio.rest.flex_api.v1.interaction.InteractionList
-
user_roles
¶ Return type: twilio.rest.flex_api.v1.user_roles.UserRolesList
-
web_channel
¶ Return type: twilio.rest.flex_api.v1.web_channel.WebChannelList
-