twilio.rest.ip_messaging.v2.service package¶
Subpackages¶
Submodules¶
twilio.rest.ip_messaging.v2.service.binding module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.ip_messaging.v2.service.binding.
BindingContext
(version, service_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the BindingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the BindingInstance
Returns: The fetched BindingInstance Return type: twilio.rest.ip_messaging.v2.service.binding.BindingInstance
-
-
class
twilio.rest.ip_messaging.v2.service.binding.
BindingInstance
(version, payload, service_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The account_sid Return type: unicode
-
binding_type
¶ Returns: The binding_type Return type: BindingInstance.BindingType
-
credential_sid
¶ Returns: The credential_sid Return type: unicode
-
date_created
¶ Returns: The date_created Return type: datetime
-
date_updated
¶ Returns: The date_updated Return type: datetime
-
delete
()[source]¶ Deletes the BindingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
endpoint
¶ Returns: The endpoint Return type: unicode
-
fetch
()[source]¶ Fetch the BindingInstance
Returns: The fetched BindingInstance Return type: twilio.rest.ip_messaging.v2.service.binding.BindingInstance
-
identity
¶ Returns: The identity Return type: unicode
-
links
¶ Returns: The links Return type: unicode
-
service_sid
¶ Returns: The service_sid Return type: unicode
-
sid
¶ Returns: The sid Return type: unicode
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.ip_messaging.v2.service.binding.
BindingList
(version, service_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
(sid)[source]¶ Constructs a BindingContext
Parameters: sid – The sid Returns: twilio.rest.ip_messaging.v2.service.binding.BindingContext Return type: twilio.rest.ip_messaging.v2.service.binding.BindingContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of BindingInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of BindingInstance Return type: twilio.rest.ip_messaging.v2.service.binding.BindingPage
-
list
(binding_type=<object object>, identity=<object object>, limit=None, page_size=None)[source]¶ Lists BindingInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - binding_type (list[BindingInstance.BindingType]) – The binding_type
- identity (list[unicode]) – The identity
- 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.ip_messaging.v2.service.binding.BindingInstance]
-
page
(binding_type=<object object>, identity=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of BindingInstance records from the API. Request is executed immediately
Parameters: Returns: Page of BindingInstance
Return type:
-
stream
(binding_type=<object object>, identity=<object object>, limit=None, page_size=None)[source]¶ Streams BindingInstance 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: - binding_type (list[BindingInstance.BindingType]) – The binding_type
- identity (list[unicode]) – The identity
- 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.ip_messaging.v2.service.binding.BindingInstance]
-
-
class
twilio.rest.ip_messaging.v2.service.binding.
BindingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of BindingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.ip_messaging.v2.service.binding.BindingInstance Return type: twilio.rest.ip_messaging.v2.service.binding.BindingInstance
-
twilio.rest.ip_messaging.v2.service.role module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.ip_messaging.v2.service.role.
RoleContext
(version, service_sid, 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.ip_messaging.v2.service.role.RoleInstance
-
update
(permission)[source]¶ Update the RoleInstance
Parameters: permission (list[unicode]) – The permission Returns: The updated RoleInstance Return type: twilio.rest.ip_messaging.v2.service.role.RoleInstance
-
-
class
twilio.rest.ip_messaging.v2.service.role.
RoleInstance
(version, payload, service_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The account_sid Return type: unicode
-
date_created
¶ Returns: The date_created Return type: datetime
-
date_updated
¶ Returns: The date_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.ip_messaging.v2.service.role.RoleInstance
-
friendly_name
¶ Returns: The friendly_name Return type: unicode
-
service_sid
¶ Returns: The service_sid Return type: unicode
-
sid
¶ Returns: The sid Return type: unicode
-
type
¶ Returns: The type Return type: RoleInstance.RoleType
-
update
(permission)[source]¶ Update the RoleInstance
Parameters: permission (list[unicode]) – The permission Returns: The updated RoleInstance Return type: twilio.rest.ip_messaging.v2.service.role.RoleInstance
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.ip_messaging.v2.service.role.
RoleList
(version, service_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(friendly_name, type, permission)[source]¶ Create the RoleInstance
Parameters: - friendly_name (unicode) – The friendly_name
- type (RoleInstance.RoleType) – The type
- permission (list[unicode]) – The permission
Returns: The created RoleInstance
Return type:
-
get
(sid)[source]¶ Constructs a RoleContext
Parameters: sid – The sid Returns: twilio.rest.ip_messaging.v2.service.role.RoleContext Return type: twilio.rest.ip_messaging.v2.service.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.ip_messaging.v2.service.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.ip_messaging.v2.service.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.ip_messaging.v2.service.role.RoleInstance Return type: twilio.rest.ip_messaging.v2.service.role.RoleInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.ip_messaging.v2.service.
ServiceContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
bindings
¶ Access the bindings
Returns: twilio.rest.ip_messaging.v2.service.binding.BindingList Return type: twilio.rest.ip_messaging.v2.service.binding.BindingList
-
channels
¶ Access the channels
Returns: twilio.rest.ip_messaging.v2.service.channel.ChannelList Return type: twilio.rest.ip_messaging.v2.service.channel.ChannelList
-
delete
()[source]¶ Deletes the ServiceInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the ServiceInstance
Returns: The fetched ServiceInstance Return type: twilio.rest.ip_messaging.v2.service.ServiceInstance
-
roles
¶ Access the roles
Returns: twilio.rest.ip_messaging.v2.service.role.RoleList Return type: twilio.rest.ip_messaging.v2.service.role.RoleList
-
update
(friendly_name=<object object>, default_service_role_sid=<object object>, default_channel_role_sid=<object object>, default_channel_creator_role_sid=<object object>, read_status_enabled=<object object>, reachability_enabled=<object object>, typing_indicator_timeout=<object object>, consumption_report_interval=<object object>, notifications_new_message_enabled=<object object>, notifications_new_message_template=<object object>, notifications_new_message_sound=<object object>, notifications_new_message_badge_count_enabled=<object object>, notifications_added_to_channel_enabled=<object object>, notifications_added_to_channel_template=<object object>, notifications_added_to_channel_sound=<object object>, notifications_removed_from_channel_enabled=<object object>, notifications_removed_from_channel_template=<object object>, notifications_removed_from_channel_sound=<object object>, notifications_invited_to_channel_enabled=<object object>, notifications_invited_to_channel_template=<object object>, notifications_invited_to_channel_sound=<object object>, pre_webhook_url=<object object>, post_webhook_url=<object object>, webhook_method=<object object>, webhook_filters=<object object>, limits_channel_members=<object object>, limits_user_channels=<object object>, media_compatibility_message=<object object>, pre_webhook_retry_count=<object object>, post_webhook_retry_count=<object object>, notifications_log_enabled=<object object>)[source]¶ Update the ServiceInstance
Parameters: - friendly_name (unicode) – The friendly_name
- default_service_role_sid (unicode) – The default_service_role_sid
- default_channel_role_sid (unicode) – The default_channel_role_sid
- default_channel_creator_role_sid (unicode) – The default_channel_creator_role_sid
- read_status_enabled (bool) – The read_status_enabled
- reachability_enabled (bool) – The reachability_enabled
- typing_indicator_timeout (unicode) – The typing_indicator_timeout
- consumption_report_interval (unicode) – The consumption_report_interval
- notifications_new_message_enabled (bool) – The notifications.new_message.enabled
- notifications_new_message_template (unicode) – The notifications.new_message.template
- notifications_new_message_sound (unicode) – The notifications.new_message.sound
- notifications_new_message_badge_count_enabled (bool) – The notifications.new_message.badge_count_enabled
- notifications_added_to_channel_enabled (bool) – The notifications.added_to_channel.enabled
- notifications_added_to_channel_template (unicode) – The notifications.added_to_channel.template
- notifications_added_to_channel_sound (unicode) – The notifications.added_to_channel.sound
- notifications_removed_from_channel_enabled (bool) – The notifications.removed_from_channel.enabled
- notifications_removed_from_channel_template (unicode) – The notifications.removed_from_channel.template
- notifications_removed_from_channel_sound (unicode) – The notifications.removed_from_channel.sound
- notifications_invited_to_channel_enabled (bool) – The notifications.invited_to_channel.enabled
- notifications_invited_to_channel_template (unicode) – The notifications.invited_to_channel.template
- notifications_invited_to_channel_sound (unicode) – The notifications.invited_to_channel.sound
- pre_webhook_url (unicode) – The pre_webhook_url
- post_webhook_url (unicode) – The post_webhook_url
- webhook_method (unicode) – The webhook_method
- webhook_filters (list[unicode]) – The webhook_filters
- limits_channel_members (unicode) – The limits.channel_members
- limits_user_channels (unicode) – The limits.user_channels
- media_compatibility_message (unicode) – The media.compatibility_message
- pre_webhook_retry_count (unicode) – The pre_webhook_retry_count
- post_webhook_retry_count (unicode) – The post_webhook_retry_count
- notifications_log_enabled (bool) – The notifications.log_enabled
Returns: The updated ServiceInstance
Return type:
-
users
¶ Access the users
Returns: twilio.rest.ip_messaging.v2.service.user.UserList Return type: twilio.rest.ip_messaging.v2.service.user.UserList
-
-
class
twilio.rest.ip_messaging.v2.service.
ServiceInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The account_sid Return type: unicode
-
bindings
¶ Access the bindings
Returns: twilio.rest.ip_messaging.v2.service.binding.BindingList Return type: twilio.rest.ip_messaging.v2.service.binding.BindingList
-
channels
¶ Access the channels
Returns: twilio.rest.ip_messaging.v2.service.channel.ChannelList Return type: twilio.rest.ip_messaging.v2.service.channel.ChannelList
-
consumption_report_interval
¶ Returns: The consumption_report_interval Return type: unicode
-
date_created
¶ Returns: The date_created Return type: datetime
-
date_updated
¶ Returns: The date_updated Return type: datetime
-
default_channel_creator_role_sid
¶ Returns: The default_channel_creator_role_sid Return type: unicode
-
default_channel_role_sid
¶ Returns: The default_channel_role_sid Return type: unicode
-
default_service_role_sid
¶ Returns: The default_service_role_sid Return type: unicode
-
delete
()[source]¶ Deletes the ServiceInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the ServiceInstance
Returns: The fetched ServiceInstance Return type: twilio.rest.ip_messaging.v2.service.ServiceInstance
-
friendly_name
¶ Returns: The friendly_name Return type: unicode
-
links
¶ Returns: The links Return type: unicode
-
post_webhook_retry_count
¶ Returns: The post_webhook_retry_count Return type: unicode
-
post_webhook_url
¶ Returns: The post_webhook_url Return type: unicode
-
pre_webhook_retry_count
¶ Returns: The pre_webhook_retry_count Return type: unicode
-
pre_webhook_url
¶ Returns: The pre_webhook_url Return type: unicode
-
roles
¶ Access the roles
Returns: twilio.rest.ip_messaging.v2.service.role.RoleList Return type: twilio.rest.ip_messaging.v2.service.role.RoleList
-
sid
¶ Returns: The sid Return type: unicode
-
typing_indicator_timeout
¶ Returns: The typing_indicator_timeout Return type: unicode
-
update
(friendly_name=<object object>, default_service_role_sid=<object object>, default_channel_role_sid=<object object>, default_channel_creator_role_sid=<object object>, read_status_enabled=<object object>, reachability_enabled=<object object>, typing_indicator_timeout=<object object>, consumption_report_interval=<object object>, notifications_new_message_enabled=<object object>, notifications_new_message_template=<object object>, notifications_new_message_sound=<object object>, notifications_new_message_badge_count_enabled=<object object>, notifications_added_to_channel_enabled=<object object>, notifications_added_to_channel_template=<object object>, notifications_added_to_channel_sound=<object object>, notifications_removed_from_channel_enabled=<object object>, notifications_removed_from_channel_template=<object object>, notifications_removed_from_channel_sound=<object object>, notifications_invited_to_channel_enabled=<object object>, notifications_invited_to_channel_template=<object object>, notifications_invited_to_channel_sound=<object object>, pre_webhook_url=<object object>, post_webhook_url=<object object>, webhook_method=<object object>, webhook_filters=<object object>, limits_channel_members=<object object>, limits_user_channels=<object object>, media_compatibility_message=<object object>, pre_webhook_retry_count=<object object>, post_webhook_retry_count=<object object>, notifications_log_enabled=<object object>)[source]¶ Update the ServiceInstance
Parameters: - friendly_name (unicode) – The friendly_name
- default_service_role_sid (unicode) – The default_service_role_sid
- default_channel_role_sid (unicode) – The default_channel_role_sid
- default_channel_creator_role_sid (unicode) – The default_channel_creator_role_sid
- read_status_enabled (bool) – The read_status_enabled
- reachability_enabled (bool) – The reachability_enabled
- typing_indicator_timeout (unicode) – The typing_indicator_timeout
- consumption_report_interval (unicode) – The consumption_report_interval
- notifications_new_message_enabled (bool) – The notifications.new_message.enabled
- notifications_new_message_template (unicode) – The notifications.new_message.template
- notifications_new_message_sound (unicode) – The notifications.new_message.sound
- notifications_new_message_badge_count_enabled (bool) – The notifications.new_message.badge_count_enabled
- notifications_added_to_channel_enabled (bool) – The notifications.added_to_channel.enabled
- notifications_added_to_channel_template (unicode) – The notifications.added_to_channel.template
- notifications_added_to_channel_sound (unicode) – The notifications.added_to_channel.sound
- notifications_removed_from_channel_enabled (bool) – The notifications.removed_from_channel.enabled
- notifications_removed_from_channel_template (unicode) – The notifications.removed_from_channel.template
- notifications_removed_from_channel_sound (unicode) – The notifications.removed_from_channel.sound
- notifications_invited_to_channel_enabled (bool) – The notifications.invited_to_channel.enabled
- notifications_invited_to_channel_template (unicode) – The notifications.invited_to_channel.template
- notifications_invited_to_channel_sound (unicode) – The notifications.invited_to_channel.sound
- pre_webhook_url (unicode) – The pre_webhook_url
- post_webhook_url (unicode) – The post_webhook_url
- webhook_method (unicode) – The webhook_method
- webhook_filters (list[unicode]) – The webhook_filters
- limits_channel_members (unicode) – The limits.channel_members
- limits_user_channels (unicode) – The limits.user_channels
- media_compatibility_message (unicode) – The media.compatibility_message
- pre_webhook_retry_count (unicode) – The pre_webhook_retry_count
- post_webhook_retry_count (unicode) – The post_webhook_retry_count
- notifications_log_enabled (bool) – The notifications.log_enabled
Returns: The updated ServiceInstance
Return type:
-
url
¶ Returns: The url Return type: unicode
-
users
¶ Access the users
Returns: twilio.rest.ip_messaging.v2.service.user.UserList Return type: twilio.rest.ip_messaging.v2.service.user.UserList
-
webhook_method
¶ Returns: The webhook_method Return type: unicode
-
-
class
twilio.rest.ip_messaging.v2.service.
ServiceList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(friendly_name)[source]¶ Create the ServiceInstance
Parameters: friendly_name (unicode) – The friendly_name Returns: The created ServiceInstance Return type: twilio.rest.ip_messaging.v2.service.ServiceInstance
-
get
(sid)[source]¶ Constructs a ServiceContext
Parameters: sid – The sid Returns: twilio.rest.ip_messaging.v2.service.ServiceContext Return type: twilio.rest.ip_messaging.v2.service.ServiceContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of ServiceInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of ServiceInstance Return type: twilio.rest.ip_messaging.v2.service.ServicePage
-
list
(limit=None, page_size=None)[source]¶ Lists ServiceInstance 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 ServiceInstance records from the API. Request is executed immediately
Parameters: Returns: Page of ServiceInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams ServiceInstance 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.ip_messaging.v2.service.
ServicePage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of ServiceInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.ip_messaging.v2.service.ServiceInstance Return type: twilio.rest.ip_messaging.v2.service.ServiceInstance
-