twilio.rest.conversations.v1 package¶
Subpackages¶
- twilio.rest.conversations.v1.configuration package
- twilio.rest.conversations.v1.conversation package
- twilio.rest.conversations.v1.service package
- Subpackages
- twilio.rest.conversations.v1.service.configuration package
- twilio.rest.conversations.v1.service.conversation package
- twilio.rest.conversations.v1.service.user package
- Submodules
- twilio.rest.conversations.v1.service.binding module
- twilio.rest.conversations.v1.service.participant_conversation module
- twilio.rest.conversations.v1.service.role module
- Module contents
- Subpackages
- twilio.rest.conversations.v1.user package
Submodules¶
twilio.rest.conversations.v1.address_configuration module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.conversations.v1.address_configuration.
AddressConfigurationContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the AddressConfigurationInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the AddressConfigurationInstance
Returns: The fetched AddressConfigurationInstance Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance
-
update
(friendly_name=<object object>, auto_creation_enabled=<object object>, auto_creation_type=<object object>, auto_creation_conversation_service_sid=<object object>, auto_creation_webhook_url=<object object>, auto_creation_webhook_method=<object object>, auto_creation_webhook_filters=<object object>, auto_creation_studio_flow_sid=<object object>, auto_creation_studio_retry_count=<object object>)[source]¶ Update the AddressConfigurationInstance
Parameters: - friendly_name (unicode) – The human-readable name of this configuration.
- auto_creation_enabled (bool) – Enable/Disable auto-creating conversations for messages to this address
- auto_creation_type (AddressConfigurationInstance.AutoCreationType) – Type of Auto Creation.
- auto_creation_conversation_service_sid (unicode) – Conversation Service for the auto-created conversation.
- auto_creation_webhook_url (unicode) – For type webhook, the url for the webhook request.
- auto_creation_webhook_method (AddressConfigurationInstance.Method) – For type webhook, the HTTP method to be used when sending a webhook request.
- auto_creation_webhook_filters (list[unicode]) – The list of events, firing webhook event for this Conversation.
- auto_creation_studio_flow_sid (unicode) – For type studio, the studio flow SID where the webhook should be sent to.
- auto_creation_studio_retry_count (unicode) – For type studio, number of times to retry the webhook request
Returns: The updated AddressConfigurationInstance
Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance
-
-
class
twilio.rest.conversations.v1.address_configuration.
AddressConfigurationInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
AutoCreationType
[source]¶ Bases:
object
-
DEFAULT
= 'default'¶
-
STUDIO
= 'studio'¶
-
WEBHOOK
= 'webhook'¶
-
-
class
Type
[source]¶ Bases:
object
-
GBM
= 'gbm'¶
-
MESSENGER
= 'messenger'¶
-
SMS
= 'sms'¶
-
WHATSAPP
= 'whatsapp'¶
-
-
account_sid
¶ Returns: The unique ID of the Account the address belongs to. Return type: unicode
-
address
¶ Returns: The unique address to be configured. Return type: unicode
-
date_created
¶ Returns: The date that this resource was created. Return type: datetime
-
date_updated
¶ Returns: The date that this resource was last updated. Return type: datetime
-
delete
()[source]¶ Deletes the AddressConfigurationInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the AddressConfigurationInstance
Returns: The fetched AddressConfigurationInstance Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance
-
friendly_name
¶ Returns: The human-readable name of this configuration. Return type: unicode
-
sid
¶ Returns: A 34 character string that uniquely identifies this resource. Return type: unicode
-
type
¶ Returns: Type of Address. Return type: unicode
-
update
(friendly_name=<object object>, auto_creation_enabled=<object object>, auto_creation_type=<object object>, auto_creation_conversation_service_sid=<object object>, auto_creation_webhook_url=<object object>, auto_creation_webhook_method=<object object>, auto_creation_webhook_filters=<object object>, auto_creation_studio_flow_sid=<object object>, auto_creation_studio_retry_count=<object object>)[source]¶ Update the AddressConfigurationInstance
Parameters: - friendly_name (unicode) – The human-readable name of this configuration.
- auto_creation_enabled (bool) – Enable/Disable auto-creating conversations for messages to this address
- auto_creation_type (AddressConfigurationInstance.AutoCreationType) – Type of Auto Creation.
- auto_creation_conversation_service_sid (unicode) – Conversation Service for the auto-created conversation.
- auto_creation_webhook_url (unicode) – For type webhook, the url for the webhook request.
- auto_creation_webhook_method (AddressConfigurationInstance.Method) – For type webhook, the HTTP method to be used when sending a webhook request.
- auto_creation_webhook_filters (list[unicode]) – The list of events, firing webhook event for this Conversation.
- auto_creation_studio_flow_sid (unicode) – For type studio, the studio flow SID where the webhook should be sent to.
- auto_creation_studio_retry_count (unicode) – For type studio, number of times to retry the webhook request
Returns: The updated AddressConfigurationInstance
Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance
-
url
¶ Returns: An absolute URL for this address configuration. Return type: unicode
-
class
-
class
twilio.rest.conversations.v1.address_configuration.
AddressConfigurationList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(type, address, friendly_name=<object object>, auto_creation_enabled=<object object>, auto_creation_type=<object object>, auto_creation_conversation_service_sid=<object object>, auto_creation_webhook_url=<object object>, auto_creation_webhook_method=<object object>, auto_creation_webhook_filters=<object object>, auto_creation_studio_flow_sid=<object object>, auto_creation_studio_retry_count=<object object>)[source]¶ Create the AddressConfigurationInstance
Parameters: - type (AddressConfigurationInstance.Type) – Type of Address.
- address (unicode) – The unique address to be configured.
- friendly_name (unicode) – The human-readable name of this configuration.
- auto_creation_enabled (bool) – Enable/Disable auto-creating conversations for messages to this address
- auto_creation_type (AddressConfigurationInstance.AutoCreationType) – Type of Auto Creation.
- auto_creation_conversation_service_sid (unicode) – Conversation Service for the auto-created conversation.
- auto_creation_webhook_url (unicode) – For type webhook, the url for the webhook request.
- auto_creation_webhook_method (AddressConfigurationInstance.Method) – For type webhook, the HTTP method to be used when sending a webhook request.
- auto_creation_webhook_filters (list[unicode]) – The list of events, firing webhook event for this Conversation.
- auto_creation_studio_flow_sid (unicode) – For type studio, the studio flow SID where the webhook should be sent to.
- auto_creation_studio_retry_count (unicode) – For type studio, number of times to retry the webhook request
Returns: The created AddressConfigurationInstance
Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance
-
get
(sid)[source]¶ Constructs a AddressConfigurationContext
Parameters: sid – The SID or Address of the Configuration. Returns: twilio.rest.conversations.v1.address_configuration.AddressConfigurationContext Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of AddressConfigurationInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of AddressConfigurationInstance Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationPage
-
list
(type=<object object>, limit=None, page_size=None)[source]¶ Lists AddressConfigurationInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - type (unicode) – The type of address configuration.
- 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.conversations.v1.address_configuration.AddressConfigurationInstance]
-
page
(type=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of AddressConfigurationInstance records from the API. Request is executed immediately
Parameters: Returns: Page of AddressConfigurationInstance
Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationPage
-
stream
(type=<object object>, limit=None, page_size=None)[source]¶ Streams AddressConfigurationInstance 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: - type (unicode) – The type of address configuration.
- 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.conversations.v1.address_configuration.AddressConfigurationInstance]
-
-
class
twilio.rest.conversations.v1.address_configuration.
AddressConfigurationPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of AddressConfigurationInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationInstance
-
twilio.rest.conversations.v1.credential module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.conversations.v1.credential.
CredentialContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the CredentialInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CredentialInstance
Returns: The fetched CredentialInstance Return type: twilio.rest.conversations.v1.credential.CredentialInstance
-
update
(type=<object object>, friendly_name=<object object>, certificate=<object object>, private_key=<object object>, sandbox=<object object>, api_key=<object object>, secret=<object object>)[source]¶ Update the CredentialInstance
Parameters: - type (CredentialInstance.PushType) – The type of push-notification service the credential is for.
- friendly_name (unicode) – A string to describe the resource
- certificate (unicode) – [APN only] The URL encoded representation of the certificate.
- private_key (unicode) – [APN only] The URL encoded representation of the private key.
- sandbox (bool) – [APN only] Whether to send the credential to sandbox APNs.
- api_key (unicode) – [GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
- secret (unicode) – [FCM only] The Server key of your project from Firebase console.
Returns: The updated CredentialInstance
Return type:
-
-
class
twilio.rest.conversations.v1.credential.
CredentialInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The unique ID of the Account responsible for this credential. Return type: unicode
-
date_created
¶ Returns: The date that this resource was created. Return type: datetime
-
date_updated
¶ Returns: The date that this resource was last updated. Return type: datetime
-
delete
()[source]¶ Deletes the CredentialInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CredentialInstance
Returns: The fetched CredentialInstance Return type: twilio.rest.conversations.v1.credential.CredentialInstance
-
friendly_name
¶ Returns: The human-readable name of this credential. Return type: unicode
-
sandbox
¶ Returns: [APN only] Whether to send the credential to sandbox APNs. Return type: unicode
-
sid
¶ Returns: A 34 character string that uniquely identifies this resource. Return type: unicode
-
type
¶ Returns: The type of push-notification service the credential is for. Return type: CredentialInstance.PushType
-
update
(type=<object object>, friendly_name=<object object>, certificate=<object object>, private_key=<object object>, sandbox=<object object>, api_key=<object object>, secret=<object object>)[source]¶ Update the CredentialInstance
Parameters: - type (CredentialInstance.PushType) – The type of push-notification service the credential is for.
- friendly_name (unicode) – A string to describe the resource
- certificate (unicode) – [APN only] The URL encoded representation of the certificate.
- private_key (unicode) – [APN only] The URL encoded representation of the private key.
- sandbox (bool) – [APN only] Whether to send the credential to sandbox APNs.
- api_key (unicode) – [GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
- secret (unicode) – [FCM only] The Server key of your project from Firebase console.
Returns: The updated CredentialInstance
Return type:
-
url
¶ Returns: An absolute URL for this credential. Return type: unicode
-
-
class
twilio.rest.conversations.v1.credential.
CredentialList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(type, friendly_name=<object object>, certificate=<object object>, private_key=<object object>, sandbox=<object object>, api_key=<object object>, secret=<object object>)[source]¶ Create the CredentialInstance
Parameters: - type (CredentialInstance.PushType) – The type of push-notification service the credential is for.
- friendly_name (unicode) – A string to describe the resource
- certificate (unicode) – [APN only] The URL encoded representation of the certificate.
- private_key (unicode) – [APN only] The URL encoded representation of the private key.
- sandbox (bool) – [APN only] Whether to send the credential to sandbox APNs.
- api_key (unicode) – [GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
- secret (unicode) – [FCM only] The Server key of your project from Firebase console.
Returns: The created CredentialInstance
Return type:
-
get
(sid)[source]¶ Constructs a CredentialContext
Parameters: sid – A 34 character string that uniquely identifies this resource. Returns: twilio.rest.conversations.v1.credential.CredentialContext Return type: twilio.rest.conversations.v1.credential.CredentialContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CredentialInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CredentialInstance Return type: twilio.rest.conversations.v1.credential.CredentialPage
-
list
(limit=None, page_size=None)[source]¶ Lists CredentialInstance 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.conversations.v1.credential.CredentialInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CredentialInstance records from the API. Request is executed immediately
Parameters: Returns: Page of CredentialInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams CredentialInstance 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.conversations.v1.credential.CredentialInstance]
-
-
class
twilio.rest.conversations.v1.credential.
CredentialPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CredentialInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.conversations.v1.credential.CredentialInstance Return type: twilio.rest.conversations.v1.credential.CredentialInstance
-
twilio.rest.conversations.v1.participant_conversation module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.conversations.v1.participant_conversation.
ParticipantConversationInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The unique ID of the Account responsible for this conversation. Return type: unicode
-
chat_service_sid
¶ Returns: The unique ID of the Conversation Service this conversation belongs to. Return type: unicode
-
conversation_attributes
¶ Returns: An optional string metadata field you can use to store any data you wish. Return type: unicode
-
conversation_created_by
¶ Returns: Creator of this conversation. Return type: unicode
-
conversation_date_created
¶ Returns: The date that this conversation was created. Return type: datetime
-
conversation_date_updated
¶ Returns: The date that this conversation was last updated. Return type: datetime
-
conversation_friendly_name
¶ Returns: The human-readable name of this conversation. Return type: unicode
-
conversation_sid
¶ Returns: The unique ID of the Conversation this Participant belongs to. Return type: unicode
-
conversation_state
¶ Returns: The current state of this User Conversation Return type: ParticipantConversationInstance.State
-
conversation_unique_name
¶ Returns: An application-defined string that uniquely identifies the Conversation resource Return type: unicode
-
links
¶ Returns: Absolute URLs to access the participant and conversation of this Participant Conversation. Return type: unicode
-
participant_identity
¶ Returns: A unique string identifier for the conversation participant as Conversation User. Return type: unicode
-
participant_messaging_binding
¶ Returns: Information about how this participant exchanges messages with the conversation. Return type: dict
-
participant_sid
¶ Returns: The unique ID of the Participant. Return type: unicode
-
participant_user_sid
¶ Returns: The unique ID for the conversation participant as Conversation User. Return type: unicode
-
-
class
twilio.rest.conversations.v1.participant_conversation.
ParticipantConversationList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get_page
(target_url)[source]¶ Retrieve a specific page of ParticipantConversationInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of ParticipantConversationInstance Return type: twilio.rest.conversations.v1.participant_conversation.ParticipantConversationPage
-
list
(identity=<object object>, address=<object object>, limit=None, page_size=None)[source]¶ Lists ParticipantConversationInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - identity (unicode) – A unique string identifier for the conversation participant as Conversation User.
- address (unicode) – A unique string identifier for the conversation participant who’s not a Conversation User.
- 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.conversations.v1.participant_conversation.ParticipantConversationInstance]
-
page
(identity=<object object>, address=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of ParticipantConversationInstance records from the API. Request is executed immediately
Parameters: - identity (unicode) – A unique string identifier for the conversation participant as Conversation User.
- address (unicode) – A unique string identifier for the conversation participant who’s not a Conversation User.
- page_token (str) – PageToken provided by the API
- page_number (int) – Page Number, this value is simply for client state
- page_size (int) – Number of records to return, defaults to 50
Returns: Page of ParticipantConversationInstance
Return type: twilio.rest.conversations.v1.participant_conversation.ParticipantConversationPage
-
stream
(identity=<object object>, address=<object object>, limit=None, page_size=None)[source]¶ Streams ParticipantConversationInstance 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: - identity (unicode) – A unique string identifier for the conversation participant as Conversation User.
- address (unicode) – A unique string identifier for the conversation participant who’s not a Conversation User.
- 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.conversations.v1.participant_conversation.ParticipantConversationInstance]
-
-
class
twilio.rest.conversations.v1.participant_conversation.
ParticipantConversationPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of ParticipantConversationInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.conversations.v1.participant_conversation.ParticipantConversationInstance Return type: twilio.rest.conversations.v1.participant_conversation.ParticipantConversationInstance
-
twilio.rest.conversations.v1.role module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.conversations.v1.role.
RoleContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the RoleInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the RoleInstance
Returns: The fetched RoleInstance Return type: twilio.rest.conversations.v1.role.RoleInstance
-
update
(permission)[source]¶ Update the RoleInstance
Parameters: permission (list[unicode]) – A permission the role should have Returns: The updated RoleInstance Return type: twilio.rest.conversations.v1.role.RoleInstance
-
-
class
twilio.rest.conversations.v1.role.
RoleInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
chat_service_sid
¶ Returns: The SID of the Conversation Service that the resource is associated with 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 RoleInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the RoleInstance
Returns: The fetched RoleInstance Return type: twilio.rest.conversations.v1.role.RoleInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
permissions
¶ Returns: An array of the permissions the role has been granted Return type: list[unicode]
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
type
¶ Returns: The type of role Return type: RoleInstance.RoleType
-
update
(permission)[source]¶ Update the RoleInstance
Parameters: permission (list[unicode]) – A permission the role should have Returns: The updated RoleInstance Return type: twilio.rest.conversations.v1.role.RoleInstance
-
url
¶ Returns: An absolute URL for this user role. Return type: unicode
-
-
class
twilio.rest.conversations.v1.role.
RoleList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(friendly_name, type, permission)[source]¶ Create the RoleInstance
Parameters: - friendly_name (unicode) – A string to describe the new resource
- type (RoleInstance.RoleType) – The type of role
- permission (list[unicode]) – A permission the role should have
Returns: The created RoleInstance
Return type:
-
get
(sid)[source]¶ Constructs a RoleContext
Parameters: sid – The SID of the Role resource to fetch Returns: twilio.rest.conversations.v1.role.RoleContext Return type: twilio.rest.conversations.v1.role.RoleContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of RoleInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of RoleInstance Return type: twilio.rest.conversations.v1.role.RolePage
-
list
(limit=None, page_size=None)[source]¶ Lists RoleInstance 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 RoleInstance records from the API. Request is executed immediately
Parameters: Returns: Page of RoleInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams RoleInstance 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.conversations.v1.role.
RolePage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of RoleInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.conversations.v1.role.RoleInstance Return type: twilio.rest.conversations.v1.role.RoleInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.conversations.v1.
V1
(domain)[source]¶ Bases:
twilio.base.version.Version
-
address_configurations
¶ Return type: twilio.rest.conversations.v1.address_configuration.AddressConfigurationList
-
configuration
¶ Return type: twilio.rest.conversations.v1.configuration.ConfigurationList
-
conversations
¶ Return type: twilio.rest.conversations.v1.conversation.ConversationList
-
credentials
¶ Return type: twilio.rest.conversations.v1.credential.CredentialList
-
participant_conversations
¶ Return type: twilio.rest.conversations.v1.participant_conversation.ParticipantConversationList
-
roles
¶ Return type: twilio.rest.conversations.v1.role.RoleList
-
services
¶ Return type: twilio.rest.conversations.v1.service.ServiceList
-
users
¶ Return type: twilio.rest.conversations.v1.user.UserList
-